Vanilla.PDF  1.4.1
Cross-platform toolkit for creating and modifying PDF documents
c_content_object.h
Go to the documentation of this file.
1 #ifndef _C_CONTENT_OBJECT_H
2 #define _C_CONTENT_OBJECT_H
3 
4 #include "vanillapdf/c_export.h"
5 #include "vanillapdf/c_handles.h"
6 #include "vanillapdf/c_values.h"
7 
8 #ifdef __cplusplus
9 extern "C"
10 {
11 #endif
12 
49  typedef enum {
54  ContentObjectType_Text,
55 
60  ContentObjectType_InlineImage
61  } ContentObjectType;
62 
71  VANILLAPDF_API error_type CALLING_CONVENTION ContentObject_GetType(ContentObjectHandle* handle, ContentObjectType* result);
72 
76  VANILLAPDF_API error_type CALLING_CONVENTION ContentObject_ToText(ContentObjectHandle* handle, ContentObjectTextHandle** result);
77 
81  VANILLAPDF_API error_type CALLING_CONVENTION ContentObject_ToInlineImage(ContentObjectHandle* handle, ContentObjectInlineImageHandle** result);
82 
87  VANILLAPDF_API error_type CALLING_CONVENTION ContentObject_Release(ContentObjectHandle* handle);
88 
99  VANILLAPDF_API error_type CALLING_CONVENTION ContentObjectText_GetOperationsSize(ContentObjectTextHandle* handle, size_type* result);
100 
104  VANILLAPDF_API error_type CALLING_CONVENTION ContentObjectText_GetOperationAt(ContentObjectTextHandle* handle, size_type at, ContentOperationHandle** result);
105 
110  VANILLAPDF_API error_type CALLING_CONVENTION ContentObjectText_Release(ContentObjectTextHandle* handle);
111 
122  VANILLAPDF_API error_type CALLING_CONVENTION ContentObjectInlineImage_GetDictionary(ContentObjectInlineImageHandle* handle, DictionaryObjectHandle** result);
123 
127  VANILLAPDF_API error_type CALLING_CONVENTION ContentObjectInlineImage_GetData(ContentObjectInlineImageHandle* handle, BufferHandle** result);
128 
133  VANILLAPDF_API error_type CALLING_CONVENTION ContentObjectInlineImage_Release(ContentObjectInlineImageHandle* handle);
134 
138 #ifdef __cplusplus
139 };
140 #endif
141 
142 #endif /* _C_CONTENT_OBJECT_H */
ContentObjectHandle
Composed non-atomic content object.
ContentObjectHandle::ContentObject_ToText
error_type ContentObject_ToText(ContentObjectHandle *handle, ContentObjectTextHandle **result)
Reinterpret current object as ContentObjectTextHandle.
ContentObjectType_InlineImage
As an alternative to the image XObjects described in section 8.9.5 - Image Dictionaries, a sampled image may be specified in the form of an inline image.
Definition: c_content_object.h:60
ContentObjectHandle::ContentObject_ToInlineImage
error_type ContentObject_ToInlineImage(ContentObjectHandle *handle, ContentObjectInlineImageHandle **result)
Reinterpret current object as ContentObjectInlineImageHandle.
c_handles.h
This file contains all type forward declarations returned by the library API.
ContentObjectType
ContentObjectType
Available content object types.
Definition: c_content_object.h:49
ContentObjectTextHandle::ContentObjectText_GetOperationAt
error_type ContentObjectText_GetOperationAt(ContentObjectTextHandle *handle, size_type at, ContentOperationHandle **result)
Get operation at location at.
size_type
uint32_t size_type
Size type defined in standard library.
Definition: c_types.h:62
ContentObjectHandle::ContentObject_Release
error_type ContentObject_Release(ContentObjectHandle *handle)
Decrement the internal reference counter.
DictionaryObjectHandle
Represents key-value map.
ContentObjectInlineImageHandle::ContentObjectInlineImage_GetData
error_type ContentObjectInlineImage_GetData(ContentObjectInlineImageHandle *handle, BufferHandle **result)
Get raw image data.
ContentObjectInlineImageHandle::ContentObjectInlineImage_GetDictionary
error_type ContentObjectInlineImage_GetDictionary(ContentObjectInlineImageHandle *handle, DictionaryObjectHandle **result)
Get meta-data dictionary for inline image.
ContentObjectTextHandle::ContentObjectText_GetOperationsSize
error_type ContentObjectText_GetOperationsSize(ContentObjectTextHandle *handle, size_type *result)
Return size of a collection.
ContentObjectInlineImageHandle
As an alternative to the image XObjects described in section 8.9.5 - Image Dictionaries, a sampled image may be specified in the form of an inline image.
error_type
uint32_t error_type
This is return value type of all API functions.
Definition: c_types.h:25
c_export.h
This file contains macro declarations for importing and exporting symbols from library boundaries...
ContentOperationHandle
Atomic content operation.
ContentObjectTextHandle
A PDF text object consists of operators that may show text strings, move the text position...
ContentObjectInlineImageHandle::ContentObjectInlineImage_Release
error_type ContentObjectInlineImage_Release(ContentObjectInlineImageHandle *handle)
Decrement the internal reference counter.
c_values.h
This file contains types and constants used as parameters or return values.
ContentObjectHandle::ContentObject_GetType
error_type ContentObject_GetType(ContentObjectHandle *handle, ContentObjectType *result)
Get derived type of current object.
BufferHandle
Represents memory stored data.
ContentObjectTextHandle::ContentObjectText_Release
error_type ContentObjectText_Release(ContentObjectTextHandle *handle)
Decrement the internal reference counter.
ContentObjectType_Text
A PDF text object consists of operators that may show text strings, move the text position...
Definition: c_content_object.h:54