wxPdfLink Class Reference

Class representing internal or external links. More...

#include <pdflinks.h>

Inheritance diagram for wxPdfLink:

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() [1/3]

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() [2/3]

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() [3/3]

wxPdfLink::wxPdfLink

(

const wxPdfLink &

pdfLink

)

Copy constructor.

~wxPdfLink()

virtual wxPdfLink::~wxPdfLink ( )

virtual

Destructor.

Member Function Documentation

GetLinkRef()

int wxPdfLink::GetLinkRef ( ) const

inline

Get the internal link reference.

GetLinkURL()

const wxString wxPdfLink::GetLinkURL ( ) const

inline

Get the external link reference.

GetPage()

int wxPdfLink::GetPage ( )

inline

Get the page this link refers to.

GetPosition()

double wxPdfLink::GetPosition ( )

inline

Get the page position this link refers to.

IsLinkRef()

bool wxPdfLink::IsLinkRef ( ) const

inline

Check whether this instance is an internal reference.

IsValid()

bool wxPdfLink::IsValid ( ) const

inline

Check whether this instance is a valid link reference.

SetLink()

void wxPdfLink::SetLink ( int page, double ypos )

inline

Set page number and position on page.

---

The documentation for this class was generated from the following file:

• pdflinks.h