Foxit PDF SDK

fs_pdfpagelabel.h
Go to the documentation of this file.
1
15 #ifndef FS_PDFPAGELABEL_H_
16 #define FS_PDFPAGELABEL_H_
17
18 #include "common/fs_common.h"
19 #include "pdf/fs_pdfdoc.h"
20 #include "pdf/objects/fs_pdfobject.h"
21 #include "pdf/objects/fs_pdfnumbertree.h"
22
28 namespace foxit {
32 namespace pdf {
53 class PageLabels FS_FINAL : public Base {
54 public:
60 typedef enum _Style {
65 e_None = 0,
67 e_DecimalNums = 1,
69 e_UpperRomanNums = 2,
71 e_LowerRomanNums = 3,
77 e_UpperLetters = 4,
83 e_LowerLetters = 5
84 } Style;
85
96 explicit PageLabels(const PDFDoc& document);
98 ~PageLabels();
99 // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
100 explicit PageLabels(FS_HANDLE handle);
106 PageLabels(const PageLabels& other);
114 PageLabels& operator= (const PageLabels& other);
122 bool operator == (const PageLabels& other) const;
130 bool operator != (const PageLabels& other) const;
131
139 bool IsEmpty() const;
140
154 WString GetPageLabelTitle(int page_index) const;
155
168 bool HasPageLabel(int page_index);
169
187 Style GetPageLabelStyle(int page_index) const;
204 WString GetPageLabelPrefix(int page_index) const;
225 int GetPageLabelStart(int page_index) const;
226
262 void SetPageLabel(int page_index, Style label_style, int first_label_number, const WString& prefix_string = WString());
263
280 void RemovePageLabel(int page_index);
281
287 void RemoveAll();
288
294 objects::PDFNumberTree GetNumberTree();
295
296 };
297 } // namespace pdf
298 } // namespace foxit
299 #endif // FS_PDFPAGELABEL_H_
300
foxit::pdf::PageLabels::Style
Style
Enumeration for page label style.
Definition: fs_pdfpagelabel.h:60
foxit::pdf::PageLabels::GetPageLabelStart
int GetPageLabelStart(int page_index) const
Get the value of the numeric portion for the first page label in the page label (as numbering format)...
foxit::pdf::PageLabels::e_LowerRomanNums
Page label style: lowercase roman numerals.
Definition: fs_pdfpagelabel.h:71
foxit::pdf::PageLabels::e_LowerLetters
Page label style: lowercase letters.
Definition: fs_pdfpagelabel.h:83
fs_pdfdoc.h
Header file for PDF document related definitions and classes.
foxit::pdf::PageLabels::HasPageLabel
bool HasPageLabel(int page_index)
Check if there is a page label (as numbering format) defined with specified page index.
CFX_WideString
WIDE STRING CLASS.
Definition: fx_string.h:1461
foxit::WString
CFX_WideString WString
Wide string.
Definition: fs_basictypes.h:222
fs_pdfnumbertree.h
Header file for PDF number tree related definitions and classes.
foxit::pdf::PDFDoc
Definition: fs_pdfdoc.h:776
foxit::pdf::PageLabels::IsEmpty
bool IsEmpty() const
Check whether current object is empty or not.
foxit::pdf::PageLabels::operator==
bool operator==(const PageLabels &other) const
Equal operator.
foxit::pdf::PageLabels::GetPageLabelStyle
Style GetPageLabelStyle(int page_index) const
Get the numbering style to be used for the numeric portion in the page label (as numbering format) of...
foxit::pdf::PageLabels::operator=
PageLabels & operator=(const PageLabels &other)
Assign operator.
foxit::pdf::PageLabels
Definition: fs_pdfpagelabel.h:53
foxit::FS_HANDLE
void * FS_HANDLE
Handle type.
Definition: fs_basictypes.h:213
fs_common.h
Header file for common definitions and classes.
foxit::pdf::PageLabels::GetNumberTree
objects::PDFNumberTree GetNumberTree()
Get the page labels number tree.
fs_pdfobject.h
Header file for PDF object related definitions and classes.
foxit::Base
Definition: fs_basictypes.h:451
foxit::pdf::PageLabels::SetPageLabel
void SetPageLabel(int page_index, Style label_style, int first_label_number, const WString &prefix_string=WString())
Set a page label (as numbering format) defined with a page index which is the starting page index of ...
foxit::pdf::PageLabels::RemovePageLabel
void RemovePageLabel(int page_index)
Remove a page label (as numbering format) defined with a specified page index.
foxit::pdf::PageLabels::operator !=
bool operator !=(const PageLabels &other) const
Not equal operator.
foxit
Foxit namespace.
Definition: fs_pdf3d.h:26
foxit::pdf::PageLabels::GetPageLabelPrefix
WString GetPageLabelPrefix(int page_index) const
Get the label prefix string in the page label (as numbering format) of a specified page index.
foxit::pdf::PageLabels::~PageLabels
~PageLabels()
Destructor.
foxit::pdf::PageLabels::GetPageLabelTitle
WString GetPageLabelTitle(int page_index) const
Get the full page label title for a page specified by page index.
foxit::pdf::PageLabels::e_UpperRomanNums
Page label style: uppercase roman numerals.
Definition: fs_pdfpagelabel.h:69
foxit::pdf::PageLabels::PageLabels
PageLabels(const PDFDoc &document)
Constructor, from a PDF document object.
foxit::pdf::PageLabels::e_DecimalNums
Page label style: decimal Arabic numerals.
Definition: fs_pdfpagelabel.h:67
foxit::pdf::PageLabels::RemoveAll
void RemoveAll()
Remove all page labels.
foxit::pdf::objects::PDFNumberTree
Definition: fs_pdfnumbertree.h:57
foxit::pdf::PageLabels::e_UpperLetters
Page label style: uppercase letters.
Definition: fs_pdfpagelabel.h:77
foxit::pdf::PageLabels::e_None
Page label style: no numbering style.
Definition: fs_pdfpagelabel.h:65