Go to the documentation of this file.
15 #ifndef FS_PDFSSTRUCTTREE_H_
16 #define FS_PDFSSTRUCTTREE_H_
48 typedef enum _StructTreeEntityType {
147 typedef enum _ElementInfoType {
329 typedef enum _StructObjectType {
488 #endif // FS_PDFSTRUCTTREE_H_
bool HasElementInfo(ElementInfoType type) const
Check whether the structure element information of a specific type exist.
Structure tree entity type: MarkedContent, which represents a marked-content item.
Definition: fs_pdfstructtree.h:60
PDFStructTree(const PDFDoc &document)
Constructor, with parameters.
Structure tree entity type: unknown.
Definition: fs_pdfstructtree.h:52
Definition: fs_pdfstructtree.h:140
~PDFStructTree()
Destructor.
void * FS_HANDLE
Handle type.
Definition: fs_basictypes.h:214
Definition: fs_pdfstructtree.h:260
StructTreeEntityType
Enumeration for structure tree entity type.
Definition: fs_pdfstructtree.h:48
StructElement GetParentElement()
Get the parent structure element.
ElementInfoType
Enumeration for structure element info type.
Definition: fs_pdfstructtree.h:147
~StructMarkedContent()
Destructor.
Definition: fs_pdfstructtree.h:283
Structure element info type: Expanded Form, which means the expanded form of structure element.
Definition: fs_pdfstructtree.h:164
int GetChildCount() const
Get count of structure elements in current PDF structure tree.
~StructTreeEntity()
Destructor.
Header file for common definitions and classes.
StructElement GetParentElement()
Get the parent structure element.
bool operator!=(const StructTreeEntity &other) const
Not equal operator.
PDFPage GetPage() const
Get the related PDF page.
Structure element info type: Actual Text, which means the actual text of structure element.
Definition: fs_pdfstructtree.h:168
StructTreeEntity()
Constructor.
Definition: fs_pdfstructtree.h:70
bool operator==(const StructTreeEntity &other) const
Equal operator.
Definition: fs_pdfstructtree.h:322
Image object.
Definition: fs_pdfstructtree.h:335
Definition: fs_pdfstructtree.h:41
uint32 GetMCID() const
Get marked-content identifier(MCID).
BYTE STRING CLASS.
Definition: fx_string.h:317
StructObjectContent()
Constructor.
Definition: fs_pdfstructtree.h:344
~StructObjectContent()
Destructor.
Definition: fs_pdfstructtree.h:364
StructTreeEntity GetChild(int index)
Get a child structure tree entity by index.
Structure element info type: Title, which means the title of the structure element....
Definition: fs_pdfstructtree.h:151
Definition: fs_pdfstructtree.h:408
StructTreeEntityType GetType() const
Get structure tree entity type.
bool operator==(const PDFStructTree &other) const
Equal operator.
Header file for PDF object related definitions and classes.
Unknown Type.
Definition: fs_pdfstructtree.h:331
StructElement GetChild(int index) const
Get the structure element by index.
bool IsEmpty() const
Check whether current object is empty or not.
Foxit namespace.
Definition: fs_taggedpdf.h:27
Definition: fs_pdfobject.h:809
Structure tree entity type: ObjectContent, which represents a PDF object content item,...
Definition: fs_pdfstructtree.h:65
int GetChildCount() const
Get the count of child structure tree entities in the current structure element.
~StructElement()
Destructor.
Definition: fs_pdfstructtree.h:193
Form object.
Definition: fs_pdfstructtree.h:337
Definition: fs_pdfdoc.h:610
StructElement()
Constructor.
Definition: fs_pdfstructtree.h:173
Structure tree entity type: Element, which represents a structure element.
Definition: fs_pdfstructtree.h:56
StructObjectType GetObjectType() const
Get related object type.
Definition: fs_pdfpage.h:412
Annot object.
Definition: fs_pdfstructtree.h:339
bool operator!=(const PDFStructTree &other) const
Not equal operator.
Structure element info type: Alternative Description, which means the alternative description of stru...
Definition: fs_pdfstructtree.h:160
StructObjectType
Enumeration for object type.
Definition: fs_pdfstructtree.h:329
WString GetElementInfo(ElementInfoType type) const
Get the structure element information.
PDFStructTree & operator=(const PDFStructTree &other)
Assign operator.
Invaild object.
Definition: fs_pdfstructtree.h:333
WIDE STRING CLASS.
Definition: fx_string.h:1452
pdf::objects::PDFDictionary * GetDict() const
Get PDF dictionary of related object.
pdf::objects::PDFDictionary * GetStmDict() const
Get PDF dictionary of the content stream that contains the marked-content sequence.
pdf::objects::PDFDictionary * GetStmOwnerDict() const
Get PDF dictionary of content stream owner.
Structure element info type: Language, which means the natural language for all text in the structure...
Definition: fs_pdfstructtree.h:156
FX_UINT32 uint32
32-bit unsigned integer.
Definition: fs_basictypes.h:196
String GetStructureTypeName() const
Get structure type name.
StructMarkedContent()
Constructor.
Definition: fs_pdfstructtree.h:263
Definition: fs_basictypes.h:427
StructElement GetParentElement()
Get the parent structure element.
StructTreeEntity & operator=(const StructTreeEntity &other)
Assign operator.
bool IsEmpty() const
Check whether current object is empty or not.
@2024 Foxit Software Incorporated. All rights reserved.