Foxit PDF SDK

fs_pdfnumbertree.h
Go to the documentation of this file.
1
15 #ifndef FS_PDFNUMBERTREE_H_
16 #define FS_PDFNUMBERTREE_H_
17
18 #include "common/fs_common.h"
19 #include "pdf/objects/fs_pdfobject.h"
20
26 namespace foxit {
30 namespace pdf {
34 namespace objects {
57 class PDFNumberTree FS_FINAL : public Base {
58 public:
64 typedef enum _Type {
66 e_PageLabels = 1
67 } Type;
68
81 PDFNumberTree(const PDFDoc& document, Type type);
82
84 PDFNumberTree();
85
87 ~PDFNumberTree();
88
94 PDFNumberTree(const PDFNumberTree& other);
95
103 PDFNumberTree& operator = (const PDFNumberTree& other);
104
112 bool operator == (const PDFNumberTree& other) const;
113
121 bool operator != (const PDFNumberTree& other) const;
122
130 bool IsEmpty() const;
131
138 Type GetType();
139
148 bool HasNumber(int number);
149
159 objects::PDFObject* GetObj(int number);
160
174 bool SetObj(int number, objects::PDFObject* pdf_object);
175
186 bool RemoveObj(int number);
187
193 bool RemoveAllObjs();
194
195 // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
196 explicit PDFNumberTree(FS_HANDLE handle);
197
198 };
199
200 } // namespace objects
201 } // namespace pdf
202 } // namespace foxit
203 #endif // FS_PDFNUMBERTREE_H_
204
foxit::pdf::objects::PDFNumberTree::IsEmpty
bool IsEmpty() const
Check whether current object is empty or not.
foxit::pdf::objects::PDFNumberTree::Type
Type
Enumeration for number tree type.
Definition: fs_pdfnumbertree.h:64
foxit::pdf::objects::PDFNumberTree::~PDFNumberTree
~PDFNumberTree()
Destructor.
foxit::pdf::objects::PDFNumberTree::GetType
Type GetType()
Get the type of current number tree.
foxit::FS_HANDLE
void * FS_HANDLE
Handle type.
Definition: fs_basictypes.h:213
foxit::pdf::objects::PDFNumberTree::RemoveAllObjs
bool RemoveAllObjs()
Remove all key integers from current number tree, along with theirs value (as PDF object).
foxit::pdf::objects::PDFNumberTree::operator!=
bool operator!=(const PDFNumberTree &other) const
Not equal operator.
foxit::pdf::objects::PDFNumberTree::HasNumber
bool HasNumber(int number)
Check if the specified key integer exists in current number tree.
fs_common.h
Header file for common definitions and classes.
foxit::pdf::objects::PDFObject
Definition: fs_pdfobject.h:55
fs_pdfobject.h
Header file for PDF object related definitions and classes.
foxit
Foxit namespace.
Definition: fs_taggedpdf.h:27
foxit::pdf::objects::PDFNumberTree::PDFNumberTree
PDFNumberTree()
Constructor.
foxit::pdf::objects::PDFNumberTree::operator==
bool operator==(const PDFNumberTree &other) const
Equal operator.
foxit::pdf::objects::PDFNumberTree::SetObj
bool SetObj(int number, objects::PDFObject *pdf_object)
Set the value (as PDF object) of a specified key integer. If the key integer does not exist,...
foxit::pdf::objects::PDFNumberTree::RemoveObj
bool RemoveObj(int number)
Remove a key integer from current number tree, along with its value (as PDF object).
foxit::pdf::objects::PDFNumberTree::GetObj
objects::PDFObject * GetObj(int number)
Get the value (as PDF object) of a specified key integer.
foxit::pdf::PDFDoc
Definition: fs_pdfdoc.h:776
foxit::pdf::objects::PDFNumberTree
Definition: fs_pdfnumbertree.h:57
foxit::pdf::objects::PDFNumberTree::operator=
PDFNumberTree & operator=(const PDFNumberTree &other)
Assign operator.
foxit::Base
Definition: fs_basictypes.h:451
foxit::pdf::objects::PDFNumberTree::e_PageLabels
"PageLabels" number tree.
Definition: fs_pdfnumbertree.h:66