Foxit PDF SDK

fs_bookmark.h
浏览该文件的文档.
1
15 #ifndef FS_BOOKMARK_H_
16 #define FS_BOOKMARK_H_
17
18 #include "common/fs_common.h"
19 #include "pdf/actions/fs_action.h"
20 #include "pdf/objects/fs_pdfobject.h"
21
27 namespace foxit {
31 namespace pdf {
57 class Bookmark FS_FINAL : public Base{
58 public:
64 typedef enum _Style {
66 e_StyleNormal = 0x00,
68 e_StyleItalic = 0x01,
70 e_StyleBold = 0x02
71 } Style;
72
79 typedef enum _Position {
81 e_PosFirstChild = 0,
83 e_PosLastChild = 1,
85 e_PosPrevSibling = 2,
87 e_PosNextSibling = 3,
89 e_PosFirstSibling = 4,
91 e_PosLastSibling = 5
92 } Position;
93
94
102 Bookmark(const PDFDoc& pdf_doc, objects::PDFDictionary* bookmark_dict);
108 Bookmark(const Bookmark& other);
116 Bookmark& operator = (const Bookmark& other);
117
125 bool operator == (const Bookmark& other) const;
133 bool operator != (const Bookmark& other) const;
134
142 bool IsEmpty() const;
143
145 ~Bookmark();
146
157 Bookmark GetParent();
158
165 bool HasChild();
166
172 Bookmark GetFirstChild();
173
184 Bookmark GetNextSibling();
185
200 Destination GetDestination();
201
215 void SetDestination(const Destination& destination);
216
226 WString GetTitle() const;
227
239 void SetTitle(const WString& title);
240
250 uint32 GetColor();
251
263 void SetColor(uint32 color);
264
276 uint32 GetStyle();
277
291 void SetStyle(uint32 style);
292
308 Bookmark Insert(const WString& title, Position position);
309
324 bool MoveTo(const Bookmark& dest_bookmark, Position position);
325
336 actions::Action GetAction();
337
350 void SetAction(const actions::Action& action);
351
362 bool RemoveAction();
363
375 bool IsRoot();
376
383 bool IsFirstChild();
384
391 bool IsLastChild();
392
398 objects::PDFDictionary* GetDict() const;
399
400 // 强烈建议用户不要使用此方法；否则可能会出现未知情况。
401 explicit Bookmark(FS_HANDLE handle = NULL);
402
403 };
404 } // namespace pdf
405 } // namespace foxit
406 #endif // FS_BOOKMARK_H_
foxit::pdf::Bookmark::GetDict
objects::PDFDictionary * GetDict() const
获取当前书签的PDF字典。
foxit::pdf::Bookmark::e_StyleItalic
将书签标题显示为斜体文本。
Definition: fs_bookmark.h:68
foxit::pdf::Bookmark::GetNextSibling
Bookmark GetNextSibling()
获取下一个兄弟书签。
foxit::pdf::Bookmark::Position
Position
书签位置的枚举。
Definition: fs_bookmark.h:79
foxit::pdf::Bookmark::IsEmpty
bool IsEmpty() const
检查当前对象是否为空。
foxit::pdf::Bookmark::e_PosLastChild
书签是另一个指定书签的最后一个子书签。
Definition: fs_bookmark.h:83
foxit::pdf::Bookmark::e_PosPrevSibling
书签是另一个指定书签的前一个兄弟书签。
Definition: fs_bookmark.h:85
foxit::pdf::Bookmark::e_StyleBold
将书签标题显示为粗体文本。
Definition: fs_bookmark.h:70
CFX_WideString
宽字符串类
Definition: fx_string.h:1457
foxit::pdf::Bookmark::e_PosLastSibling
书签是另一个指定书签的最后一个兄弟书签。
Definition: fs_bookmark.h:91
foxit::pdf::Destination
Definition: fs_action.h:65
foxit::pdf::Bookmark::GetColor
uint32 GetColor()
获取用于显示标题的颜色。
foxit::pdf::PDFDoc
Definition: fs_pdfdoc.h:768
foxit::pdf::Bookmark::SetAction
void SetAction(const actions::Action &action)
设置动作。
foxit::pdf::Bookmark::IsRoot
bool IsRoot()
检查当前书签是否为根书签。
foxit::pdf::Bookmark::SetStyle
void SetStyle(uint32 style)
设置用于显示标题的样式。
foxit::pdf::Bookmark::operator !=
bool operator !=(const Bookmark &other) const
不相等操作符。
foxit::pdf::Bookmark::GetTitle
WString GetTitle() const
获取标题。
foxit::pdf::Bookmark::IsFirstChild
bool IsFirstChild()
检查当前书签是否为其父书签的第一个子书签。
foxit::pdf::Bookmark::e_PosNextSibling
书签是另一个指定书签的后一个兄弟书签。
Definition: fs_bookmark.h:87
foxit::pdf::Bookmark::Insert
Bookmark Insert(const WString &title, Position position)
根据与当前书签的关系位置插入新书签。
foxit::pdf::Bookmark::SetTitle
void SetTitle(const WString &title)
设置标题。
foxit::pdf::Bookmark::MoveTo
bool MoveTo(const Bookmark &dest_bookmark, Position position)
将当前书签移动为另一个书签的子书签或兄弟书签。
foxit::pdf::Bookmark::e_PosFirstChild
书签是另一个指定书签的第一个子书签。
Definition: fs_bookmark.h:81
foxit::uint32
FX_UINT32 uint32
无符号 32 位整数。
Definition: fs_basictypes.h:195
foxit::FS_HANDLE
void * FS_HANDLE
句柄类型。
Definition: fs_basictypes.h:213
fs_common.h
通用定义和类的头文件。
foxit::pdf::Bookmark::RemoveAction
bool RemoveAction()
删除动作。
foxit::pdf::Bookmark::GetDestination
Destination GetDestination()
获取目标。
foxit::pdf::Bookmark::operator==
bool operator==(const Bookmark &other) const
相等操作符。
fs_pdfobject.h
PDF对象相关定义和类的头文件。
foxit::Base
Definition: fs_basictypes.h:465
foxit::pdf::Bookmark::e_StyleNormal
将书签标题显示为普通文本。
Definition: fs_bookmark.h:66
foxit::pdf::Bookmark::~Bookmark
~Bookmark()
析构函数。
foxit::pdf::objects::PDFDictionary
Definition: fs_pdfobject.h:848
foxit::pdf::Bookmark::IsLastChild
bool IsLastChild()
检查当前书签是否为其父书签的最后一个子书签。
foxit::pdf::Bookmark::GetFirstChild
Bookmark GetFirstChild()
获取第一个子书签。
foxit
Foxit命名空间。
Definition: fs_taggedpdf.h:27
foxit::pdf::actions::Action
Definition: fs_action.h:411
foxit::pdf::Bookmark::SetColor
void SetColor(uint32 color)
设置用于显示标题的颜色。
foxit::pdf::Bookmark::operator=
Bookmark & operator=(const Bookmark &other)
赋值操作符。
foxit::pdf::Bookmark::e_PosFirstSibling
书签是另一个指定书签的第一个兄弟书签。
Definition: fs_bookmark.h:89
foxit::pdf::Bookmark::GetStyle
uint32 GetStyle()
获取用于显示标题的样式。
foxit::pdf::Bookmark::SetDestination
void SetDestination(const Destination &destination)
设置目标。
foxit::pdf::Bookmark::Style
Style
书签样式类型的枚举。
Definition: fs_bookmark.h:64
foxit::pdf::Bookmark::Bookmark
Bookmark(const PDFDoc &pdf_doc, objects::PDFDictionary *bookmark_dict)
构造函数，带参数。
NULL
#define NULL
空指针值。
Definition: fx_system.h:792
foxit::pdf::Bookmark::GetAction
actions::Action GetAction()
获取动作。
fs_action.h
目标和动作相关定义和类的头文件。
foxit::pdf::Bookmark::GetParent
Bookmark GetParent()
获取父书签。
foxit::pdf::Bookmark
Definition: fs_bookmark.h:57
foxit::pdf::Bookmark::HasChild
bool HasChild()
检查当前书签是否有子书签。