wxPdfDocument 1.2.0
Public Member Functions | List of all members
wxPdfTextField Class Reference

Class representing text form fields (For internal use only) More...

#include <pdfform.h>

Inheritance diagram for wxPdfTextField:
wxPdfAnnotationWidget wxPdfAnnotationObject wxPdfIndirectObject

Public Member Functions

 wxPdfTextField (int objectId, int fontindex, double fontsize, const wxString &value, int generation_id=0)
 Constructor.
 
virtual ~wxPdfTextField ()
 Destructor.
 
void SetValue (const wxString &value)
 Set default value of the text field.
 
wxString GetValue ()
 Get default value of the text field.
 
void SetMultiLine (bool multiline)
 Set multi line property of the text field.
 
bool GetMultiLine ()
 Get multi line property of the text field.
 
int GetFontIndex ()
 Get object index of font used for displaying the value list.
 
double GetFontSize ()
 Get size of font used for displaying the value list.
 
- Public Member Functions inherited from wxPdfAnnotationWidget
 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

Class representing text form fields (For internal use only)

Constructor & Destructor Documentation

◆ wxPdfTextField()

wxPdfTextField::wxPdfTextField ( int objectId,
int fontindex,
double fontsize,
const wxString & value,
int generation_id = 0 )

Constructor.

◆ ~wxPdfTextField()

virtual wxPdfTextField::~wxPdfTextField ( )
virtual

Destructor.

Member Function Documentation

◆ GetFontIndex()

int wxPdfTextField::GetFontIndex ( )
inline

Get object index of font used for displaying the value list.

◆ GetFontSize()

double wxPdfTextField::GetFontSize ( )
inline

Get size of font used for displaying the value list.

◆ GetMultiLine()

bool wxPdfTextField::GetMultiLine ( )
inline

Get multi line property of the text field.

◆ GetValue()

wxString wxPdfTextField::GetValue ( )
inline

Get default value of the text field.

◆ SetMultiLine()

void wxPdfTextField::SetMultiLine ( bool multiline)
inline

Set multi line property of the text field.

◆ SetValue()

void wxPdfTextField::SetValue ( const wxString & value)
inline

Set default value of the text field.


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