This documentation is deprecated and will no longer be updated. Please use the official documentation at vanillapdf.readthedocs.io.
Vanilla.PDF  2.3.0
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
9extern "C"
10{
11#endif
12
49 typedef enum {
50 ContentObjectType_Undefined = 0,
55 ContentObjectType_Text,
56
61 ContentObjectType_InlineImage
62 } ContentObjectType;
63
72 VANILLAPDF_API error_type CALLING_CONVENTION ContentObject_GetObjectType(ContentObjectHandle* handle, ContentObjectType* result);
73
78 VANILLAPDF_DEPRECATED VANILLAPDF_API error_type CALLING_CONVENTION ContentObject_ToInlineImage(ContentObjectHandle* handle, ContentObjectInlineImageHandle** result);
79
83 VANILLAPDF_API error_type CALLING_CONVENTION ContentObject_ToInstruction(ContentObjectHandle* handle, ContentInstructionHandle** result);
84
88 VANILLAPDF_API error_type CALLING_CONVENTION ContentObject_FromInstruction(ContentInstructionHandle* handle, ContentObjectHandle** result);
89
94 VANILLAPDF_API error_type CALLING_CONVENTION ContentObject_Release(ContentObjectHandle* handle);
95
106 VANILLAPDF_API error_type CALLING_CONVENTION ContentObjectText_GetOperationsSize(ContentObjectTextHandle* handle, size_type* result);
107
111 VANILLAPDF_API error_type CALLING_CONVENTION ContentObjectText_GetOperationAt(ContentObjectTextHandle* handle, size_type at, ContentOperationHandle** result);
112
116 VANILLAPDF_API error_type CALLING_CONVENTION ContentObjectText_ToContentObject(ContentObjectTextHandle* handle, ContentObjectHandle** result);
117
121 VANILLAPDF_API error_type CALLING_CONVENTION ContentObjectText_FromContentObject(ContentObjectHandle* handle, ContentObjectTextHandle** result);
122
127 VANILLAPDF_API error_type CALLING_CONVENTION ContentObjectText_Release(ContentObjectTextHandle* handle);
128
139 VANILLAPDF_API error_type CALLING_CONVENTION ContentObjectInlineImage_GetDictionary(ContentObjectInlineImageHandle* handle, DictionaryObjectHandle** result);
140
144 VANILLAPDF_API error_type CALLING_CONVENTION ContentObjectInlineImage_GetData(ContentObjectInlineImageHandle* handle, BufferHandle** result);
145
149 VANILLAPDF_API error_type CALLING_CONVENTION ContentObjectInlineImage_ToContentObject(ContentObjectInlineImageHandle* handle, ContentObjectHandle** result);
150
154 VANILLAPDF_API error_type CALLING_CONVENTION ContentObjectInlineImage_FromContentObject(ContentObjectHandle* handle, ContentObjectInlineImageHandle** result);
155
160 VANILLAPDF_API error_type CALLING_CONVENTION ContentObjectInlineImage_Release(ContentObjectInlineImageHandle* handle);
161
165#ifdef __cplusplus
166};
167#endif
168
169#endif /* _C_CONTENT_OBJECT_H */
c_export.h
This file contains macro declarations for importing and exporting symbols from library boundaries.
c_handles.h
This file contains all type forward declarations returned by the library API.
c_values.h
This file contains types and constants used as parameters or return values.
BufferHandle
Represents memory stored data.
ContentInstructionHandle
Base class for all content objects and operations.
ContentObjectHandle
A sequence of content instructions grouped within a single object.
ContentObjectHandle::ContentObject_GetObjectType
error_type CALLING_CONVENTION ContentObject_GetObjectType(ContentObjectHandle *handle, ContentObjectType *result)
Get derived type of current object.
ContentObjectHandle::ContentObject_ToInlineImage
VANILLAPDF_DEPRECATED error_type CALLING_CONVENTION ContentObject_ToInlineImage(ContentObjectHandle *handle, ContentObjectInlineImageHandle **result)
Reinterpret current object as ContentObjectInlineImageHandle.
ContentObjectHandle::ContentObject_FromInstruction
error_type CALLING_CONVENTION ContentObject_FromInstruction(ContentInstructionHandle *handle, ContentObjectHandle **result)
Convert ContentInstructionHandle to ContentObjectHandle.
ContentObjectHandle::ContentObject_Release
error_type CALLING_CONVENTION ContentObject_Release(ContentObjectHandle *handle)
Decrement the internal reference counter.
ContentObjectHandle::ContentObject_ToInstruction
error_type CALLING_CONVENTION ContentObject_ToInstruction(ContentObjectHandle *handle, ContentInstructionHandle **result)
Reinterpret current object as ContentInstructionHandle.
ContentObjectInlineImageHandle
As an alternative to the image XObjects described in section 8.9.5 - Image Dictionaries,...
ContentObjectInlineImageHandle::ContentObjectInlineImage_FromContentObject
error_type CALLING_CONVENTION ContentObjectInlineImage_FromContentObject(ContentObjectHandle *handle, ContentObjectInlineImageHandle **result)
Convert ContentObjectHandle to ContentObjectInlineImageHandle.
ContentObjectInlineImageHandle::ContentObjectInlineImage_Release
error_type CALLING_CONVENTION ContentObjectInlineImage_Release(ContentObjectInlineImageHandle *handle)
Decrement the internal reference counter.
ContentObjectInlineImageHandle::ContentObjectInlineImage_GetDictionary
error_type CALLING_CONVENTION ContentObjectInlineImage_GetDictionary(ContentObjectInlineImageHandle *handle, DictionaryObjectHandle **result)
Get meta-data dictionary for inline image.
ContentObjectInlineImageHandle::ContentObjectInlineImage_GetData
error_type CALLING_CONVENTION ContentObjectInlineImage_GetData(ContentObjectInlineImageHandle *handle, BufferHandle **result)
Get raw image data.
ContentObjectInlineImageHandle::ContentObjectInlineImage_ToContentObject
error_type CALLING_CONVENTION ContentObjectInlineImage_ToContentObject(ContentObjectInlineImageHandle *handle, ContentObjectHandle **result)
Reinterpret current object as ContentObjectHandle.
ContentObjectTextHandle
A PDF text object consists of operators that may show text strings, move the text position,...
ContentObjectTextHandle::ContentObjectText_ToContentObject
error_type CALLING_CONVENTION ContentObjectText_ToContentObject(ContentObjectTextHandle *handle, ContentObjectHandle **result)
Reinterpret current object as ContentObjectHandle.
ContentObjectTextHandle::ContentObjectText_Release
error_type CALLING_CONVENTION ContentObjectText_Release(ContentObjectTextHandle *handle)
Decrement the internal reference counter.
ContentObjectTextHandle::ContentObjectText_GetOperationsSize
error_type CALLING_CONVENTION ContentObjectText_GetOperationsSize(ContentObjectTextHandle *handle, size_type *result)
Get number of operations within current text object.
ContentObjectTextHandle::ContentObjectText_GetOperationAt
error_type CALLING_CONVENTION ContentObjectText_GetOperationAt(ContentObjectTextHandle *handle, size_type at, ContentOperationHandle **result)
Get operation at location at.
ContentObjectTextHandle::ContentObjectText_FromContentObject
error_type CALLING_CONVENTION ContentObjectText_FromContentObject(ContentObjectHandle *handle, ContentObjectTextHandle **result)
Convert ContentObjectTextHandle to ContentObjectHandle.
ContentOperationHandle
Atomic operation modifying graphics state parameters.
DictionaryObjectHandle
A dictionary object is an associative table containing pairs of objects.
ContentObjectType
ContentObjectType
Derived types of ContentObjectHandle.
Definition c_content_object.h:49
ContentObjectType_Text
@ ContentObjectType_Text
A PDF text object consists of operators that may show text strings, move the text position,...
Definition c_content_object.h:55
ContentObjectType_InlineImage
@ ContentObjectType_InlineImage
As an alternative to the image XObjects described in section 8.9.5 - Image Dictionaries,...
Definition c_content_object.h:61
error_type
uint32_t error_type
This is return value type of all API functions.
Definition c_types.h:25
size_type
uint32_t size_type
Size type defined in standard library.
Definition c_types.h:62