PoDoFo
0.9.6
|
#include <PdfField.h>
Inherits PoDoFo::PdfField.
Public Member Functions | |
PdfTextField (PdfAnnotation *pWidget, PdfAcroForm *pParent) | |
PdfTextField (PdfPage *pPage, const PdfRect &rRect, PdfAcroForm *pParent) | |
PdfTextField (PdfPage *pPage, const PdfRect &rRect, PdfDocument *pDoc) | |
PdfTextField (PdfPage *pPage, const PdfRect &rRect, PdfStreamedDocument *pDoc) | |
PdfTextField (const PdfField &rhs) | |
void | SetText (const PdfString &rsText) |
PdfString | GetText () const |
void | SetMaxLen (pdf_long nMaxLen) |
pdf_long | GetMaxLen () const |
void | SetMultiLine (bool bMultiLine) |
bool | IsMultiLine () const |
void | SetPasswordField (bool bPassword) |
bool | IsPasswordField () const |
void | SetFileField (bool bFile) |
bool | IsFileField () const |
void | SetSpellcheckingEnabled (bool bSpellcheck) |
bool | IsSpellcheckingEnabled () const |
void | SetScrollBarsEnabled (bool bScroll) |
bool | IsScrollBarsEnabled () const |
void | SetCombs (bool bCombs) |
bool | IsCombs () const |
void | SetRichText (bool bRichText) |
bool | IsRichText () const |
A textfield in a PDF file.
Users can enter text into a text field. Single and multi line text is possible, as well as richtext. The text can be interpreted as path to a file which is going to be submitted.
PoDoFo::PdfTextField::PdfTextField | ( | PdfAnnotation * | pWidget, |
PdfAcroForm * | pParent | ||
) |
Create a new PdfTextField
PoDoFo::PdfTextField::PdfTextField | ( | PdfPage * | pPage, |
const PdfRect & | rRect, | ||
PdfAcroForm * | pParent | ||
) |
Create a new PdfTextField
PoDoFo::PdfTextField::PdfTextField | ( | PdfPage * | pPage, |
const PdfRect & | rRect, | ||
PdfDocument * | pDoc | ||
) |
Create a new PdfTextField
PoDoFo::PdfTextField::PdfTextField | ( | PdfPage * | pPage, |
const PdfRect & | rRect, | ||
PdfStreamedDocument * | pDoc | ||
) |
Create a new PdfTextField
PoDoFo::PdfTextField::PdfTextField | ( | const PdfField & | rhs | ) |
Create a PdfTextField from a PdfField
rhs | a PdfField that is a PdfTextField |
Raises an error if PdfField::GetType() != ePdfField_TextField
pdf_long PoDoFo::PdfTextField::GetMaxLen | ( | ) | const |
PdfString PoDoFo::PdfTextField::GetText | ( | ) | const |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
Divide the text field into max-len equal combs.
bCombs | if true enable division into combs |
By default combs are disabled. Requires the max-len property to be set.
|
inline |
Create a file selection field. The entered contents are treated as filename to a file whose contents are submitted as the value of the field.
bFile | if true the contents are treated as a pathname to a file to submit |
void PoDoFo::PdfTextField::SetMaxLen | ( | pdf_long | nMaxLen | ) |
Sets the max length in characters of this textfield
nMaxLen | the max length of this textfields in characters |
|
inline |
Create a multi-line text field that can contains multiple lines of text.
bMultiLine | if true a multi line field is generated, otherwise the text field can contain only a single line of text. |
The default is to create a single line text field.
|
inline |
Create a password text field that should not echo entered characters visibly to the screen.
bPassword | if true a password field is created |
The default is to create no password field
|
inline |
Creates a richtext field.
bRichText | if true creates a richtext field |
By default richtext is disabled.
|
inline |
Enable/disable scrollbars for this text field
bScroll | if true scrollbars will be enabled |
Text fields have scrollbars by default
|
inline |
Enable/disable spellchecking for this text field
bSpellcheck | if true spellchecking will be enabled |
Text fields are spellchecked by default
void PoDoFo::PdfTextField::SetText | ( | const PdfString & | rsText | ) |
Sets the text contents of this text field.
rsText | the text of this field |