wxPdfBookmark Class Reference

Class representing bookmarks for defining the document's outline. (For internal use only). More...

#include <pdfbookmark.h>

List of all members.

Public Member Functions

 wxPdfBookmark (const wxString &txt, int level, double y, int page)
 Constructor.
virtual ~wxPdfBookmark ()
 Destructor.
wxString GetText ()
 Get the bookmark text.
int GetLevel ()
 Get the associated level.
double GetY ()
 Get the Y offset of the bookmark.
int GetPage ()
 Get the page number of the bookmark.
void SetParent (int parent)
 Set the parent of the bookmark.
int GetParent ()
 Get the parent of the bookmark.
void SetPrev (int prev)
 Set previous bookmark.
int GetPrev ()
 Get previous bookmark.
void SetNext (int next)
 Set next bookmark.
int GetNext ()
 Get next bookmark.
void SetFirst (int first)
 Set first bookmark.
int GetFirst ()
 Get first bookmark.
void SetLast (int last)
 Set last bookmark.
int GetLast ()
 Get last bookmark.

Detailed Description

Class representing bookmarks for defining the document's outline. (For internal use only).


Constructor & Destructor Documentation

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
virtual wxPdfBookmark::~wxPdfBookmark (  )  [virtual]

Destructor.


Member Function Documentation

int wxPdfBookmark::GetFirst (  )  [inline]

Get first bookmark.

Returns:
the number of the first bookmark on the same level in the hierarchy
int wxPdfBookmark::GetLast (  )  [inline]

Get last bookmark.

Returns:
the number of the last bookmark on the same level in the hierarchy
int wxPdfBookmark::GetLevel (  )  [inline]

Get the associated level.

Returns:
the level associated with the bookmark
int wxPdfBookmark::GetNext (  )  [inline]

Get next bookmark.

Returns:
the number of the successor of the bookmark on the same level in the hierarchy
int wxPdfBookmark::GetPage (  )  [inline]

Get the page number of the bookmark.

Returns:
the number of the page referenced by the bookmark
int wxPdfBookmark::GetParent (  )  [inline]

Get the parent of the bookmark.

Returns:
the number of the parent of the bookmark in the hierarchy
int wxPdfBookmark::GetPrev (  )  [inline]

Get previous bookmark.

Returns:
the number of the predecessor of the bookmark on the same level in the hierarchy
wxString wxPdfBookmark::GetText (  )  [inline]

Get the bookmark text.

Returns:
the text associated with the bookmark
double wxPdfBookmark::GetY (  )  [inline]

Get the Y offset of the bookmark.

Returns:
the page offset of the bookmark
void wxPdfBookmark::SetFirst ( int  first  )  [inline]

Set first bookmark.

Parameters:
first the number of the first bookmark on the same level in the hierarchy
void wxPdfBookmark::SetLast ( int  last  )  [inline]

Set last bookmark.

Parameters:
last the number of the last bookmark on the same level in the hierarchy
void wxPdfBookmark::SetNext ( int  next  )  [inline]

Set next bookmark.

Parameters:
next the number of the successor on the same level in the bookmark hierarchy
void wxPdfBookmark::SetParent ( int  parent  )  [inline]

Set the parent of the bookmark.

Parameters:
parent the number of the parent in the bookmark hierarchy
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:

Generated on Mon Oct 12 22:02:41 2009 for wxPdfDocument by  doxygen 1.6.1