wxPdfLink Class Reference

Class representing internal or external links. More...

#include <pdfproperties.h>

Inheritance diagram for wxPdfLink:

wxPdfPageLink List of all members.

Public Member Functions

 wxPdfLink (int linkRef)
 Constructor for internal link.
 wxPdfLink (const wxString &linkURL)
 Constructor for external link.
 wxPdfLink (const wxPdfLink &pdfLink)
 Copy constructor.
virtual ~wxPdfLink ()
 Destructor.
bool IsValid () const
 Check whether this instance is a valid link reference.
bool IsLinkRef () const
 Check whether this instance is an internal reference.
int GetLinkRef () const
 Get the internal link reference.
const wxString GetLinkURL () const
 Get the external link reference.
void SetLink (int page, double ypos)
 Set page number and position on page.
int GetPage ()
 Get the page this link refers to.
double GetPosition ()
 Get the page position this link refers to.

Detailed Description

Class representing internal or external links.


Constructor & Destructor Documentation

wxPdfLink::wxPdfLink ( int  linkRef  ) 

Constructor for internal link.

Use this constructor to create an internal link reference.

See also:
wxPdfDocument::Link(), wxPdfDocument::Write(), wxPdfDocument::Cell(), wxPdfDocument::ClippedCell(), wxPdfDocument::Image(), wxPdfDocument::RotatedImage()

wxPdfLink::wxPdfLink ( const wxString &  linkURL  ) 

Constructor for external link.

Use this constructor to create an external link reference.

See also:
wxPdfDocument::Link(), wxPdfDocument::Write(), wxPdfDocument::Cell(), wxPdfDocument::ClippedCell(), wxPdfDocument::Image(), wxPdfDocument::RotatedImage()

wxPdfLink::wxPdfLink ( const wxPdfLink pdfLink  ) 

Copy constructor.

wxPdfLink::~wxPdfLink (  )  [virtual]

Destructor.


Member Function Documentation

bool wxPdfLink::IsValid (  )  const [inline]

Check whether this instance is a valid link reference.

bool wxPdfLink::IsLinkRef (  )  const [inline]

Check whether this instance is an internal reference.

int wxPdfLink::GetLinkRef (  )  const [inline]

Get the internal link reference.

const wxString wxPdfLink::GetLinkURL (  )  const [inline]

Get the external link reference.

void wxPdfLink::SetLink ( int  page,
double  ypos 
) [inline]

Set page number and position on page.

int wxPdfLink::GetPage (  )  [inline]

Get the page this link refers to.

double wxPdfLink::GetPosition (  )  [inline]

Get the page position this link refers to.


The documentation for this class was generated from the following files:
Generated on Fri Dec 15 21:30:38 2006 for wxPdfDocument by  doxygen 1.5.1-p1