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

The pages of a document are accessed through a structure known as the page tree, which defines the ordering of pages in the document. More...

Inheritance diagram for PageTreeHandle:
IUnknownHandle
error_type PageTree_GetPageCount (PageTreeHandle *handle, size_type *result)
 Get total number of pages in current document.
 
error_type PageTree_GetPage (PageTreeHandle *handle, size_type at, PageObjectHandle **result)
 Get page at index at.
 
error_type PageTree_InsertPage (PageTreeHandle *handle, size_type at, PageObjectHandle *page)
 Insert new page at index at. More...
 
error_type PageTree_AppendPage (PageTreeHandle *handle, PageObjectHandle *page)
 Adds a new page at the end of the page tree, after its current last element.
 
error_type PageTree_RemovePage (PageTreeHandle *handle, size_type at)
 Removed a page at index at. More...
 
error_type PageTree_ToUnknown (PageTreeHandle *handle, IUnknownHandle **result)
 Reinterpret current object as IUnknownHandle.
 
error_type PageTree_FromUnknown (IUnknownHandle *handle, PageTreeHandle **result)
 Convert IUnknownHandle to PageTreeHandle.
 
error_type PageTree_Release (PageTreeHandle *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 pages of a document are accessed through a structure known as the page tree, which defines the ordering of pages in the document.

See also
CatalogHandle
Examples:
extract.c.

Friends And Related Function Documentation

◆ PageTree_InsertPage()

error_type PageTree_InsertPage ( PageTreeHandle handle,
size_type  at,
PageObjectHandle page 
)
related

Insert new page at index at.

The page tree is extended by inserting new element before the element at the specified position, effectively increasing the container by one.

◆ PageTree_RemovePage()

error_type PageTree_RemovePage ( PageTreeHandle handle,
size_type  at 
)
related

Removed a page at index at.

This effectively reduces the container size by one.

◆ PageTree_Release()

error_type PageTree_Release ( PageTreeHandle 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: