Poppler Qt5  0.81.0
Public Types | Public Member Functions | List of all members
Poppler::FormField Class Referenceabstract

#include <poppler-form.h>

Inheritance diagram for Poppler::FormField:
Inheritance graph
[legend]

Public Types

enum  AdditionalActionType { FieldModified, FormatField, ValidateField, CalculateField }
 
enum  FormType { FormButton, FormText, FormChoice, FormSignature }
 

Public Member Functions

LinkactivationAction () const
 
LinkadditionalAction (AdditionalActionType type) const
 
LinkadditionalAction (Annotation::AdditionalActionType type) const
 
QString fullyQualifiedName () const
 
int id () const
 
bool isPrintable () const
 
bool isReadOnly () const
 
bool isVisible () const
 
QString name () const
 
QRectF rect () const
 
void setName (const QString &name) const
 
void setPrintable (bool value)
 
void setReadOnly (bool value)
 
void setVisible (bool value)
 
virtual FormType type () const =0
 
QString uiName () const
 

Detailed Description

The base class representing a form field.

Since
0.6

Member Enumeration Documentation

◆ AdditionalActionType

Describes the flags from the form 'AA' dictionary.

Since
0.53
Enumerator
FieldModified 

A JavaScript action to be performed when the user modifies the field.

FormatField 

A JavaScript action to be performed before the field is formatted to display its value.

ValidateField 

A JavaScript action to be performed when the field value changes.

CalculateField 

A JavaScript action to be performed when the field needs to be recalculated.

◆ FormType

The different types of form field.

Enumerator
FormButton 

A button field. See ButtonType.

FormText 

A text field. See TextType.

FormChoice 

A single choice field. See ChoiceType.

FormSignature 

A signature field.

Member Function Documentation

◆ activationAction()

Link* Poppler::FormField::activationAction ( ) const

The activation action of this form field.

Note
It may be null.

◆ additionalAction() [1/2]

Link* Poppler::FormField::additionalAction ( AdditionalActionType  type) const

Returns a given form additional action.

Since
0.53

◆ additionalAction() [2/2]

Link* Poppler::FormField::additionalAction ( Annotation::AdditionalActionType  type) const

Returns a given widget annotation additional action.

Since
0.65

◆ fullyQualifiedName()

QString Poppler::FormField::fullyQualifiedName ( ) const

The internal fully qualified name of the field.

Since
0.18

◆ isPrintable()

bool Poppler::FormField::isPrintable ( ) const

Whether this field is printable.

Since
0.79

◆ rect()

QRectF Poppler::FormField::rect ( ) const
Returns
The size of the field, in normalized coordinates, i.e. [0..1] with regard to the dimensions (cropbox) of the page

◆ setName()

void Poppler::FormField::setName ( const QString &  name) const

Sets the internal name (T) of the field.

Since
0.51

◆ setPrintable()

void Poppler::FormField::setPrintable ( bool  value)

Set whether this field is printable.

Since
0.79

◆ setReadOnly()

void Poppler::FormField::setReadOnly ( bool  value)

Set whether this form field is read-only.

Since
0.64

◆ setVisible()

void Poppler::FormField::setVisible ( bool  value)

Set whether this form field is visible.

Since
0.64

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