Class representing bookmarks for defining the document's outline. (For internal use only)
More...
#include <pdfbookmark.h>
Class representing bookmarks for defining the document's outline. (For internal use only)
◆ wxPdfBookmark()
wxPdfBookmark::wxPdfBookmark |
( |
const wxString & |
txt, |
|
|
int |
level, |
|
|
double |
y, |
|
|
int |
page |
|
) |
| |
Constructor.
- Parameters
-
txt | text associated with the bookmark |
level | hierarchical level |
y | offset on the referenced page |
page | number of the referenced page |
◆ ~wxPdfBookmark()
virtual wxPdfBookmark::~wxPdfBookmark |
( |
| ) |
|
|
virtual |
◆ GetFirst()
int wxPdfBookmark::GetFirst |
( |
| ) |
|
|
inline |
Get first bookmark.
- Returns
- the number of the first bookmark on the same level in the hierarchy
◆ GetLast()
int wxPdfBookmark::GetLast |
( |
| ) |
|
|
inline |
Get last bookmark.
- Returns
- the number of the last bookmark on the same level in the hierarchy
◆ GetLevel()
int wxPdfBookmark::GetLevel |
( |
| ) |
|
|
inline |
Get the associated level.
- Returns
- the level associated with the bookmark
◆ GetNext()
int wxPdfBookmark::GetNext |
( |
| ) |
|
|
inline |
Get next bookmark.
- Returns
- the number of the successor of the bookmark on the same level in the hierarchy
◆ GetPage()
int wxPdfBookmark::GetPage |
( |
| ) |
|
|
inline |
Get the page number of the bookmark.
- Returns
- the number of the page referenced by the bookmark
◆ GetParent()
int wxPdfBookmark::GetParent |
( |
| ) |
|
|
inline |
Get the parent of the bookmark.
- Returns
- the number of the parent of the bookmark in the hierarchy
◆ GetPrev()
int wxPdfBookmark::GetPrev |
( |
| ) |
|
|
inline |
Get previous bookmark.
- Returns
- the number of the predecessor of the bookmark on the same level in the hierarchy
◆ GetText()
wxString wxPdfBookmark::GetText |
( |
| ) |
|
|
inline |
Get the bookmark text.
- Returns
- the text associated with the bookmark
◆ GetY()
double wxPdfBookmark::GetY |
( |
| ) |
|
|
inline |
Get the Y offset of the bookmark.
- Returns
- the page offset of the bookmark
◆ SetFirst()
void wxPdfBookmark::SetFirst |
( |
int |
first | ) |
|
|
inline |
Set first bookmark.
- Parameters
-
first | the number of the first bookmark on the same level in the hierarchy |
◆ SetLast()
void wxPdfBookmark::SetLast |
( |
int |
last | ) |
|
|
inline |
Set last bookmark.
- Parameters
-
last | the number of the last bookmark on the same level in the hierarchy |
◆ SetNext()
void wxPdfBookmark::SetNext |
( |
int |
next | ) |
|
|
inline |
Set next bookmark.
- Parameters
-
next | the number of the successor on the same level in the bookmark hierarchy |
◆ SetParent()
void wxPdfBookmark::SetParent |
( |
int |
parent | ) |
|
|
inline |
Set the parent of the bookmark.
- Parameters
-
parent | the number of the parent in the bookmark hierarchy |
◆ SetPrev()
void wxPdfBookmark::SetPrev |
( |
int |
prev | ) |
|
|
inline |
Set previous bookmark.
- Parameters
-
prev | the number of the predecessor on the same level in the bookmark hierarchy |
The documentation for this class was generated from the following file: