Vanilla.PDF  1.4.1
Cross-platform toolkit for creating and modifying PDF documents
c_page_object.h
Go to the documentation of this file.
1 #ifndef _C_PAGE_OBJECT_H
2 #define _C_PAGE_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 
42  VANILLAPDF_API error_type CALLING_CONVENTION PageObject_CreateFromDocument(DocumentHandle* handle, PageObjectHandle** result);
43 
47  VANILLAPDF_API error_type CALLING_CONVENTION PageObject_CreateFromObject(DictionaryObjectHandle* handle, PageObjectHandle** result);
48 
55  VANILLAPDF_API error_type CALLING_CONVENTION PageObject_GetContents(PageObjectHandle* handle, ContentsHandle** result);
56 
61  VANILLAPDF_API error_type CALLING_CONVENTION PageObject_GetParent(PageObjectHandle* handle, PageTreeHandle** result);
62 
73  VANILLAPDF_API error_type CALLING_CONVENTION PageObject_GetResources(PageObjectHandle* handle, ResourceDictionaryHandle** result);
74 
81  VANILLAPDF_API error_type CALLING_CONVENTION PageObject_GetAnnotations(PageObjectHandle* handle, PageAnnotationsHandle** result);
82 
90  VANILLAPDF_API error_type CALLING_CONVENTION PageObject_GetMediaBox(PageObjectHandle* handle, RectangleHandle** result);
91 
96  VANILLAPDF_API error_type CALLING_CONVENTION PageObject_Release(PageObjectHandle* handle);
97 
100 #ifdef __cplusplus
101 };
102 #endif
103 
104 #endif /* _C_PAGE_OBJECT_H */
RectangleHandle
Represents rectangle in 2D space.
PageObjectHandle
The leaves of the page tree are page objects, each of which is a dictionary specifying the attributes...
PageObjectHandle::PageObject_GetContents
error_type PageObject_GetContents(PageObjectHandle *handle, ContentsHandle **result)
A content stream (see 7.8.2, "Content Streams") that shall describe the contents of this page...
PageObjectHandle::PageObject_Release
error_type PageObject_Release(PageObjectHandle *handle)
Decrement the internal reference counter.
PageTreeHandle
The pages of a document are accessed through a structure known as the page tree, which defines the or...
c_handles.h
This file contains all type forward declarations returned by the library API.
ContentsHandle
A content stream is a PDF stream object whose data consists of a sequence of instructions describing ...
ResourceDictionaryHandle
A content stream's named resources shall be defined by a resource dictionary, which shall enumerate t...
PageObjectHandle::PageObject_GetResources
error_type PageObject_GetResources(PageObjectHandle *handle, ResourceDictionaryHandle **result)
A dictionary containing any resources required by the page (see 7.8.3, "Resource Dictionaries").
PageObjectHandle::PageObject_CreateFromDocument
error_type PageObject_CreateFromDocument(DocumentHandle *handle, PageObjectHandle **result)
Creates a new instance.
DictionaryObjectHandle
Represents key-value map.
PageObjectHandle::PageObject_GetParent
error_type PageObject_GetParent(PageObjectHandle *handle, PageTreeHandle **result)
The page tree node that is the immediate parent of this page object.
PageAnnotationsHandle
An array of annotation dictionaries that shall contain indirect references to all AnnotationHandle as...
error_type
uint32_t error_type
This is return value type of all API functions.
Definition: c_types.h:25
DocumentHandle
Represents high-level file access handle.
c_export.h
This file contains macro declarations for importing and exporting symbols from library boundaries...
PageObjectHandle::PageObject_CreateFromObject
error_type PageObject_CreateFromObject(DictionaryObjectHandle *handle, PageObjectHandle **result)
Creates a new instance.
c_values.h
This file contains types and constants used as parameters or return values.
PageObjectHandle::PageObject_GetAnnotations
error_type PageObject_GetAnnotations(PageObjectHandle *handle, PageAnnotationsHandle **result)
An array of annotation dictionaries that shall contain indirect references to all annotations associa...
PageObjectHandle::PageObject_GetMediaBox
error_type PageObject_GetMediaBox(PageObjectHandle *handle, RectangleHandle **result)
A rectangle expressed in default user space units, that shall define the boundaries of the physical m...