Foxit PDF SDK

fs_pdfpagelabel.h
浏览该文件的文档.
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 {
52 class PageLabels FS_FINAL : public Base {
53 public:
59 typedef enum _Style {
64 e_None = 0,
66 e_DecimalNums = 1,
68 e_UpperRomanNums = 2,
70 e_LowerRomanNums = 3,
76 e_UpperLetters = 4,
82 e_LowerLetters = 5
83 } Style;
84
95 explicit PageLabels(const PDFDoc& document);
97 ~PageLabels();
98 // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
99 explicit PageLabels(FS_HANDLE handle);
105 PageLabels(const PageLabels& other);
113 PageLabels& operator= (const PageLabels& other);
121 bool operator == (const PageLabels& other) const;
129 bool operator != (const PageLabels& other) const;
130
138 bool IsEmpty() const;
139
153 WString GetPageLabelTitle(int page_index) const;
154
166 bool HasPageLabel(int page_index);
167
184 Style GetPageLabelStyle(int page_index) const;
201 WString GetPageLabelPrefix(int page_index) const;
221 int GetPageLabelStart(int page_index) const;
222
256 void SetPageLabel(int page_index, Style label_style, int first_label_number, const WString& prefix_string = WString());
257
274 void RemovePageLabel(int page_index);
275
281 void RemoveAll();
282
288 objects::PDFNumberTree GetNumberTree();
289
290 };
291 } // namespace pdf
292 } // namespace foxit
293 #endif // FS_PDFPAGELABEL_H_
294
foxit::pdf::PageLabels::operator=
PageLabels & operator=(const PageLabels &other)
赋值操作符。
foxit::FS_HANDLE
void * FS_HANDLE
句柄类型。
Definition: fs_basictypes.h:214
foxit::pdf::PageLabels
Definition: fs_pdfpagelabel.h:52
fs_pdfnumbertree.h
PDF数字树相关定义和类的头文件。
foxit::pdf::PageLabels::GetNumberTree
objects::PDFNumberTree GetNumberTree()
获取页面标签数字树。
foxit::pdf::PageLabels::RemovePageLabel
void RemovePageLabel(int page_index)
移除用指定页面索引定义的页面标签（作为编号格式）。
fs_common.h
通用定义和类的头文件。
foxit::pdf::PageLabels::SetPageLabel
void SetPageLabel(int page_index, Style label_style, int first_label_number, const WString &prefix_string=WString())
设置由页面索引定义的页面标签（作为编号格式），该页面索引是范围的起始页面索引。
foxit::pdf::PageLabels::~PageLabels
~PageLabels()
析构函数。
foxit::pdf::PageLabels::e_None
页面标签样式：无编号样式。
Definition: fs_pdfpagelabel.h:64
foxit::pdf::PageLabels::GetPageLabelTitle
WString GetPageLabelTitle(int page_index) const
获取由页面索引指定的页面的完整页面标签标题。
foxit::pdf::PageLabels::GetPageLabelPrefix
WString GetPageLabelPrefix(int page_index) const
获取指定页面索引的页面标签（作为编号格式）中的标签前缀字符串。
foxit::pdf::PageLabels::RemoveAll
void RemoveAll()
移除所有页面标签。
foxit::pdf::PageLabels::PageLabels
PageLabels(const PDFDoc &document)
构造函数，从PDF文档对象构造。
foxit::pdf::PageLabels::GetPageLabelStart
int GetPageLabelStart(int page_index) const
获取指定页面索引的页面标签（作为编号格式）中第一个页面标签的数字部分值。
foxit::pdf::PageLabels::Style
Style
页面标签样式枚举。
Definition: fs_pdfpagelabel.h:59
fs_pdfobject.h
PDF对象相关定义和类的头文件。
foxit::WString
CFX_WideString WString
宽字符串。
Definition: fs_basictypes.h:223
foxit
Foxit命名空间。
Definition: fs_taggedpdf.h:27
foxit::pdf::PageLabels::e_DecimalNums
页面标签样式：十进制阿拉伯数字。
Definition: fs_pdfpagelabel.h:66
foxit::pdf::PageLabels::e_UpperLetters
页面标签样式：大写字母。
Definition: fs_pdfpagelabel.h:76
foxit::pdf::PageLabels::HasPageLabel
bool HasPageLabel(int page_index)
检查是否为指定页面索引定义了页面标签（作为编号格式）。
fs_pdfdoc.h
PDF文档相关定义和类的头文件。
foxit::pdf::PDFDoc
Definition: fs_pdfdoc.h:771
foxit::pdf::PageLabels::e_LowerRomanNums
页面标签样式：小写罗马数字。
Definition: fs_pdfpagelabel.h:70
foxit::pdf::objects::PDFNumberTree
Definition: fs_pdfnumbertree.h:57
foxit::pdf::PageLabels::e_LowerLetters
页面标签样式：小写字母。
Definition: fs_pdfpagelabel.h:82
foxit::pdf::PageLabels::operator==
bool operator==(const PageLabels &other) const
相等操作符。
foxit::pdf::PageLabels::IsEmpty
bool IsEmpty() const
检查当前对象是否为空。
CFX_WideString
宽字符串类
Definition: fx_string.h:1457
foxit::pdf::PageLabels::operator!=
bool operator!=(const PageLabels &other) const
不相等操作符。
foxit::Base
Definition: fs_basictypes.h:449
foxit::pdf::PageLabels::e_UpperRomanNums
页面标签样式：大写罗马数字。
Definition: fs_pdfpagelabel.h:68
foxit::pdf::PageLabels::GetPageLabelStyle
Style GetPageLabelStyle(int page_index) const
获取指定页面索引的页面标签（作为编号格式）中数字部分使用的编号样式。