wxPdfAnnotationWidget Class Reference

#include <pdfform.h>

Inheritance diagram for wxPdfAnnotationWidget:

Public Member Functions
	wxPdfAnnotationWidget (int objectId, int generationId=0)
	Constructor.
virtual	~wxPdfAnnotationWidget ()
	Destructor.
void	SetName (const wxString &name)
	Set form field name.
wxString	GetName ()
	Get form field name.
void	SetBorderColour (const wxString &borderColour)
	Set border colour representation of form field.
wxString	GetBorderColour ()
	Get border colour representation of form field.
void	SetBackgroundColour (const wxString &backgroundColour)
	Set background colour representation of form field.
wxString	GetBackgroundColour ()
	Get background colour representation of form field.
void	SetTextColour (const wxString &textColour)
	Set text colour representation of form field.
wxString	GetTextColour ()
	Get text colour representation of form field.
void	SetBorderStyle (const wxString &borderStyle)
	Set border style of form field.
wxString	GetBorderStyle ()
	Get border style of form field.
void	SetBorderWidth (double borderWidth)
	Set border width of form field.
double	GetBorderWidth ()
	Get border width of form field.
Public Member Functions inherited from wxPdfAnnotationObject
	wxPdfAnnotationObject (int objectId, int generationId)
	Constructor.
	~wxPdfAnnotationObject ()
	Destructor.
void	SetRectangle (double x, double y, double width, double height)
	Set the associated rectangular area.
double	GetX ()
	Get the X offset.
double	GetY ()
	Get the Y offset.
double	GetWidth ()
	Get the width.
double	GetHeight ()
	Get the height.
Public Member Functions inherited from wxPdfIndirectObject
	wxPdfIndirectObject (int objectId, int generationId)
	Constructor.
virtual	~wxPdfIndirectObject ()
	Destructor.
wxPdfObjectType	GetType ()
	Get type of this object.
void	SetType (wxPdfObjectType type)
	Set type of object.
int	GetObjectId ()
	Get identifier of this object.
int	GetGenerationId ()
	Get generation identifier of this object.

Detailed Description

Base class for PDF form fields (for internal use only)

Constructor & Destructor Documentation

wxPdfAnnotationWidget()

wxPdfAnnotationWidget::wxPdfAnnotationWidget	(	int	objectId,
		int	generationId = 0 )

Constructor.

Parameters

objectId	the object number
generationId	the generation number

~wxPdfAnnotationWidget()

virtual wxPdfAnnotationWidget::~wxPdfAnnotationWidget ( )

virtual

Destructor.

Member Function Documentation

GetBackgroundColour()

wxString wxPdfAnnotationWidget::GetBackgroundColour ( )

inline

Get background colour representation of form field.

Returns

Colour representation string

GetBorderColour()

wxString wxPdfAnnotationWidget::GetBorderColour ( )

inline

Get border colour representation of form field.

Returns

Colour representation string

GetBorderStyle()

wxString wxPdfAnnotationWidget::GetBorderStyle ( )

inline

Get border style of form field.

Returns

Border style string

GetBorderWidth()

double wxPdfAnnotationWidget::GetBorderWidth ( )

inline

Get border width of form field.

Returns

Border width in points

GetName()

wxString wxPdfAnnotationWidget::GetName ( )

inline

Get form field name.

Returns

The name of the form field

GetTextColour()

wxString wxPdfAnnotationWidget::GetTextColour ( )

inline

Get text colour representation of form field.

Returns

Colour representation string

SetBackgroundColour()

void wxPdfAnnotationWidget::SetBackgroundColour ( const wxString & backgroundColour )

inline

Set background colour representation of form field.

Parameters

backgroundColour

Colour representation string

SetBorderColour()

void wxPdfAnnotationWidget::SetBorderColour ( const wxString & borderColour )

inline

Set border colour representation of form field.

Parameters

borderColour

Colour representation string

SetBorderStyle()

void wxPdfAnnotationWidget::SetBorderStyle ( const wxString & borderStyle )

inline

Set border style of form field.

Parameters

borderStyle

Border style string

SetBorderWidth()

void wxPdfAnnotationWidget::SetBorderWidth ( double borderWidth )

inline

Set border width of form field.

Parameters

borderWidth

Border width in points

SetName()

void wxPdfAnnotationWidget::SetName ( const wxString & name )

inline

Set form field name.

Parameters

name	The name of the form field

SetTextColour()

void wxPdfAnnotationWidget::SetTextColour ( const wxString & textColour )

inline

Set text colour representation of form field.

Parameters

textColour

Colour representation string

---

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

• E:/github/wxpdfdoc-current/include/wx/pdfform.h