Foxit PDF SDK
|
Public Member Functions | |
PDFStructTree (const PDFDoc &document) | |
Constructor, with parameters. More... | |
PDFStructTree (const PDFStructTree &other) | |
Constructor, with another PDF structure tree object. More... | |
~PDFStructTree () | |
Destructor. | |
StructElement | GetChild (int index) const |
Get the structure element by index. More... | |
int | GetChildCount () const |
Get count of structure elements in current PDF structure tree. More... | |
bool | IsEmpty () const |
Check whether current object is empty or not. More... | |
bool | operator!= (const PDFStructTree &other) const |
Not equal operator. More... | |
PDFStructTree & | operator= (const PDFStructTree &other) |
Assign operator. More... | |
bool | operator== (const PDFStructTree &other) const |
Equal operator. More... | |
![]() | |
FS_HANDLE | Handle () const |
Get the handle of current object. More... | |
PDF structure tree is a kind of common data structure in tagged PDF documents. A structure tree is used in PDF files to represent the organization and hierarchy of the document's content. PDF structure tree has following characteristics:
Class PDFStructTree is used to be associated with an existing PDF structure tree. It offers functions to get structure elements in the PDF structure tree.
foxit::pdf::objects::PDFStructTree::PDFStructTree | ( | const PDFDoc & | document | ) |
Constructor, with parameters.
If there exists PDF structure tree in the PDF document, this function is just to construct a PDF structure tree object to be associated with the structure tree.
[in] | document | A valid PDF document object. |
foxit::pdf::objects::PDFStructTree::PDFStructTree | ( | const PDFStructTree & | other | ) |
Constructor, with another PDF structure tree object.
[in] | other | Another PDF structure tree object. |
StructElement foxit::pdf::objects::PDFStructTree::GetChild | ( | int | index | ) | const |
Get the structure element by index.
[in] | index | Index of the structure element to be retrieved. Valid range: from 0 to (count-1). count is returned by function PDFStructTree::GetChildCount. |
int foxit::pdf::objects::PDFStructTree::GetChildCount | ( | ) | const |
Get count of structure elements in current PDF structure tree.
bool foxit::pdf::objects::PDFStructTree::IsEmpty | ( | ) | const |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
bool foxit::pdf::objects::PDFStructTree::operator!= | ( | const PDFStructTree & | other | ) | const |
Not equal operator.
[in] | other | Another PDF structure tree object. This function will check if current object is not equal to this one. |
PDFStructTree& foxit::pdf::objects::PDFStructTree::operator= | ( | const PDFStructTree & | other | ) |
Assign operator.
[in] | other | Another PDF structure tree object, whose value would be assigned to current object. |
bool foxit::pdf::objects::PDFStructTree::operator== | ( | const PDFStructTree & | other | ) | const |
Equal operator.
[in] | other | Another PDF structure tree object. This function will check if current object is equal to this one. |