Foxit PDF SDK
fs_readingbookmark.h
Go to the documentation of this file.
1 
15 #ifndef FS_READINGBOOKMARK_H_
16 #define FS_READINGBOOKMARK_H_
17 
18 #include "common/fs_common.h"
19 
25 namespace foxit {
29 namespace pdf {
43 class ReadingBookmark FS_FINAL : public Base {
44  public:
50  ReadingBookmark(const ReadingBookmark& other);
59 
62 
70  bool operator == (const ReadingBookmark& other) const;
78  bool operator != (const ReadingBookmark& other) const;
79 
87  bool IsEmpty() const;
88 
94  WString GetTitle() const;
95 
103  void SetTitle(const WString& title);
104 
110  int GetPageIndex() const;
111 
121  void SetPageIndex(int index);
122 
132  DateTime GetDateTime(bool is_creation_date) const;
133 
144  void SetDateTime(const DateTime& date_time, bool is_creation_date);
145 
146  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
147  explicit ReadingBookmark(FS_HANDLE handle = NULL);
148 };
149 } // namespace pdf
150 } // namespace foxit
151 #endif // FS_READINGBOOKMARK_H_
152 
foxit::pdf::ReadingBookmark::ReadingBookmark
ReadingBookmark(const ReadingBookmark &other)
Constructor, with another reading bookmark object.
foxit::FS_HANDLE
void * FS_HANDLE
Handle type.
Definition: fs_basictypes.h:214
foxit::pdf::ReadingBookmark::SetPageIndex
void SetPageIndex(int index)
Set the index of the destination page.
foxit::DateTime
Definition: fs_basictypes.h:460
foxit::pdf::ReadingBookmark::IsEmpty
bool IsEmpty() const
Check whether current object is empty or not.
foxit::pdf::ReadingBookmark::operator==
bool operator==(const ReadingBookmark &other) const
Equal operator.
fs_common.h
Header file for common definitions and classes.
foxit::pdf::ReadingBookmark::GetDateTime
DateTime GetDateTime(bool is_creation_date) const
Get date time information.
foxit::pdf::ReadingBookmark::GetPageIndex
int GetPageIndex() const
Get the index of the destination page.
foxit::pdf::ReadingBookmark::operator!=
bool operator!=(const ReadingBookmark &other) const
Not equal operator.
foxit::pdf::ReadingBookmark::operator=
ReadingBookmark & operator=(const ReadingBookmark &other)
Assign operator.
foxit
Foxit namespace.
Definition: fs_taggedpdf.h:27
foxit::pdf::ReadingBookmark
Definition: fs_readingbookmark.h:43
foxit::pdf::ReadingBookmark::SetTitle
void SetTitle(const WString &title)
Set the title.
foxit::pdf::ReadingBookmark::~ReadingBookmark
~ReadingBookmark()
Destructor.
NULL
#define NULL
The null-pointer value.
Definition: fx_system.h:780
foxit::pdf::ReadingBookmark::GetTitle
WString GetTitle() const
Get the title.
foxit::pdf::ReadingBookmark::SetDateTime
void SetDateTime(const DateTime &date_time, bool is_creation_date)
Set date time information.
CFX_WideString
WIDE STRING CLASS.
Definition: fx_string.h:1452
foxit::Base
Definition: fs_basictypes.h:427