Vanilla.PDF  1.5.2
Cross-platform toolkit for creating and modifying PDF documents
List of all members
PageObjectHandle Class Reference

The leaves of the page tree are page objects, each of which is a dictionary specifying the attributes of a single page of the document. More...

Inheritance diagram for PageObjectHandle:
IUnknownHandle
error_type PageObject_CreateFromDocument (DocumentHandle *handle, PageObjectHandle **result)
 Creates a new instance. More...
 
error_type PageObject_CreateFromObject (DictionaryObjectHandle *handle, PageObjectHandle **result)
 Creates a new instance. More...
 
error_type PageObject_GetContents (PageObjectHandle *handle, PageContentsHandle **result)
 A content stream (see 7.8.2, "Content Streams") that shall describe the contents of this page. If this entry is absent, the page shall be empty.
 
error_type PageObject_GetParent (PageObjectHandle *handle, PageTreeHandle **result)
 The page tree node that is the immediate parent of this page object.
 
error_type PageObject_GetResources (PageObjectHandle *handle, ResourceDictionaryHandle **result)
 A dictionary containing any resources required by the page (see 7.8.3, "Resource Dictionaries"). More...
 
error_type PageObject_GetAnnotations (PageObjectHandle *handle, PageAnnotationsHandle **result)
 An array of annotation dictionaries that shall contain indirect references to all annotations associated with the page (see 12.5, "Annotations").
 
error_type PageObject_GetMediaBox (PageObjectHandle *handle, RectangleHandle **result)
 A rectangle expressed in default user space units, that shall define the boundaries of the physical medium on which the page shall be displayed or printed (see 14.11.2, "Page Boundaries").
 
error_type PageObject_ToUnknown (PageObjectHandle *handle, IUnknownHandle **result)
 Reinterpret current object as IUnknownHandle.
 
error_type PageObject_FromUnknown (IUnknownHandle *handle, PageObjectHandle **result)
 Convert IUnknownHandle to PageObjectHandle.
 
error_type PageObject_Release (PageObjectHandle *handle)
 Decrement the internal reference counter. More...
 

Additional Inherited Members

- Public Member Functions inherited from IUnknownHandle
error_type IUnknown_AddRef (IUnknownHandle *handle)
 Increment the internal reference counter.
 

Detailed Description

The leaves of the page tree are page objects, each of which is a dictionary specifying the attributes of a single page of the document.

See also
PageTreeHandle
Examples:
extract.c.

Member Function Documentation

◆ PageObject_CreateFromDocument()

error_type PageObject_CreateFromDocument ( DocumentHandle handle,
PageObjectHandle **  result 
)

Creates a new instance.

Function creates a new indirect dictionary with it's type set to "Page".

This new entry has to be manually added to document catalog's page tree.

See also
PageTreeHandle

Friends And Related Function Documentation

◆ PageObject_CreateFromObject()

error_type PageObject_CreateFromObject ( DictionaryObjectHandle handle,
PageObjectHandle **  result 
)
related

Creates a new instance.

Function creates a new indirect dictionary with it's type set to "Page".

This new entry has to be manually added to document catalog's page tree.

See also
PageTreeHandle

◆ PageObject_GetResources()

error_type PageObject_GetResources ( PageObjectHandle handle,
ResourceDictionaryHandle **  result 
)
related

A dictionary containing any resources required by the page (see 7.8.3, "Resource Dictionaries").

If the page requires no resources, the value of this entry shall be an empty dictionary. Omitting the entry entirely indicates that the resources shall be inherited from an ancestor node in the page tree.

◆ PageObject_Release()

error_type PageObject_Release ( PageObjectHandle handle)
related

Decrement the internal reference counter.

When the internal counter reaches zero the object is deleted. Releasing already disposed object causes undefined behavior.

See also
IUnknown_Release
Examples:
extract.c.

The documentation for this class was generated from the following file: