Foxit PDF SDK
|
Public Types | |
enum | ElementInfoType { e_ElementInfoTypeTitle = 0, e_ElementInfoTypeLanguage = 1, e_ElementInfoTypeAltDescription = 2, e_ElementInfoTypeExpandedForm = 3, e_ElementInfoTypeActualText = 4 } |
Enumeration for structure element info type. More... | |
![]() | |
enum | StructTreeEntityType { e_UnknownType = -1, e_StructTreeEntityTypeElement = 0, e_StructTreeEntityTypeMarkedContent = 1, e_StructTreeEntityTypeObjectContent = 2 } |
Enumeration for structure tree entity type. More... | |
Public Member Functions | |
StructElement () | |
Constructor. | |
StructElement (const StructElement &other) | |
Constructor, with another structure element object. More... | |
StructElement (const StructTreeEntity &other) | |
Constructor, with another structure element object. More... | |
~StructElement () | |
Destructor. | |
StructTreeEntity | GetChild (int index) |
Get a child structure tree entity by index. More... | |
int | GetChildCount () const |
Get the count of child structure tree entities in the current structure element. More... | |
WString | GetElementInfo (ElementInfoType type) const |
Get the structure element information. More... | |
StructElement | GetParentElement () |
Get the parent structure element. More... | |
String | GetStructureTypeName () const |
Get structure type name. More... | |
bool | HasElementInfo (ElementInfoType type) const |
Check whether the structure element information of a specific type exist. More... | |
![]() | |
StructTreeEntity () | |
Constructor. | |
StructTreeEntity (const StructTreeEntity &other) | |
Constructor, with another structure element entity object. More... | |
~StructTreeEntity () | |
Destructor. | |
PDFPage | GetPage () const |
Get the related PDF page. More... | |
StructTreeEntityType | GetType () const |
Get structure tree entity type. More... | |
bool | IsEmpty () const |
Check whether current object is empty or not. More... | |
bool | operator!= (const StructTreeEntity &other) const |
Not equal operator. More... | |
StructTreeEntity & | operator= (const StructTreeEntity &other) |
Assign operator. More... | |
bool | operator== (const StructTreeEntity &other) const |
Equal operator. More... | |
![]() | |
FS_HANDLE | Handle () const |
Get the handle of current object. More... | |
This class represents structure element.
Enumeration for structure element info type.
Values of this enumeration should be used alone.
foxit::pdf::objects::StructElement::StructElement | ( | const StructElement & | other | ) |
Constructor, with another structure element object.
[in] | other | Another structure element object. |
foxit::pdf::objects::StructElement::StructElement | ( | const StructTreeEntity & | other | ) |
Constructor, with another structure element object.
[in] | other | Another structure element object. |
StructTreeEntity foxit::pdf::objects::StructElement::GetChild | ( | int | index | ) |
Get a child structure tree entity by index.
[in] | index | Index of a child structure tree entity to be retrieved. Valid range: from 0 to (count-1). count is returned by function StructElement::GetChildCount. |
int foxit::pdf::objects::StructElement::GetChildCount | ( | ) | const |
Get the count of child structure tree entities in the current structure element.
WString foxit::pdf::objects::StructElement::GetElementInfo | ( | ElementInfoType | type | ) | const |
Get the structure element information.
Before get structure element information, ensure that the function StructElement::HasElementInfo has been called and returned true (using the corresponding type).
[in] | type | Structure element information type. Please refer to values starting from StructElement::e_ElementInfoTypeTitle and this would be one of these values. |
StructElement foxit::pdf::objects::StructElement::GetParentElement | ( | ) |
Get the parent structure element.
String foxit::pdf::objects::StructElement::GetStructureTypeName | ( | ) | const |
Get structure type name.
Every structure element shall have a structure type, a name object that identifies the nature of the structure element and its role within the document (such as a chapter, paragraph, or footnote). Please refer to the description of "Standard Structure Types" in Section 10.7.3 of <PDF Reference 1.7> or the description of "Standard structure types" in Section 14.8.4 of <PDF Reference 2.0> for more details.
bool foxit::pdf::objects::StructElement::HasElementInfo | ( | ElementInfoType | type | ) | const |
Check whether the structure element information of a specific type exist.
[in] | type | Structure element information type. Please refer to values starting from StructElement::e_ElementInfoTypeTitle and this would be one of these values. |