Okular::FormField
#include <form.h>
Public Types | |
enum | AdditionalActionType { FieldModified , FormatField , ValidateField , CalculateField } |
enum | FieldType { FormButton , FormText , FormChoice , FormSignature } |
Public Member Functions | |
Action * | activationAction () const |
Action * | additionalAction (AdditionalActionType type) const |
Action * | additionalAction (Annotation::AdditionalActionType type) const |
QList< Action * > | additionalActions () const |
void | commitFormattedValue (const QString &value) |
QString | committedFormattedValue () const |
QString | committedValue () const |
void | commitValue (const QString &value) |
virtual QString | fullyQualifiedName () const =0 |
virtual int | id () const =0 |
virtual bool | isPrintable () const |
virtual bool | isReadOnly () const |
virtual bool | isVisible () const |
virtual QString | name () const =0 |
Page * | page () const |
virtual NormalizedRect | rect () const =0 |
virtual void | setAppearanceValue (const QVariant &value) |
virtual void | setPrintable (bool value) |
virtual void | setReadOnly (bool value) |
virtual void | setValue (const QVariant &value) |
virtual void | setVisible (bool value) |
FieldType | type () const |
virtual QString | uiName () const =0 |
virtual QVariant | value () const |
Protected Member Functions | |
void | setActivationAction (Action *action) |
void | setAdditionalAction (AdditionalActionType type, Action *action) |
void | setAdditionalAction (Annotation::AdditionalActionType type, Action *action) |
Detailed Description
The base interface of a form field.
This is the very basic interface to represent a field in a form.
This is not meant to be used as a direct base for the form fields in a document, but its abstract subclasses are.
Member Enumeration Documentation
◆ AdditionalActionType
Describes the type of form additional action.
- Since
- 1.1
◆ FieldType
The types of form field.
Enumerator | |
---|---|
FormButton | A "button". See FormFieldButton::ButtonType. |
FormText | A field of variable text. See FormFieldText::TextType. |
FormChoice | A choice field. See FormFieldChoice::ChoiceType. |
FormSignature | A signature. |
Constructor & Destructor Documentation
◆ ~FormField()
Member Function Documentation
◆ activationAction()
◆ additionalAction() [1/2]
Action * FormField::additionalAction | ( | AdditionalActionType | type | ) | const |
◆ additionalAction() [2/2]
Action * FormField::additionalAction | ( | Annotation::AdditionalActionType | type | ) | const |
◆ additionalActions()
◆ commitFormattedValue()
void FormField::commitFormattedValue | ( | const QString & | value | ) |
◆ committedFormattedValue()
QString FormField::committedFormattedValue | ( | ) | const |
◆ committedValue()
QString FormField::committedValue | ( | ) | const |
◆ commitValue()
void FormField::commitValue | ( | const QString & | value | ) |
◆ fullyQualifiedName()
|
pure virtual |
The fully qualified name of the field, is used in the JavaScript scripts.
- Since
- 1.9
◆ id()
|
pure virtual |
The ID of the field.
◆ isPrintable()
|
virtual |
◆ isReadOnly()
|
virtual |
◆ isVisible()
|
virtual |
◆ name()
|
pure virtual |
The internal name of the field, to be used when referring to the field in eg scripts.
◆ page()
Page * FormField::page | ( | ) | const |
◆ rect()
|
pure virtual |
The bounding rect of the field, in normalized coordinates.
◆ setActivationAction()
|
protected |
◆ setAdditionalAction() [1/2]
|
protected |
◆ setAdditionalAction() [2/2]
|
protected |
◆ setAppearanceValue()
|
virtual |
Sets the appearance value
associated with the form field.
- Since
- 24.08
Reimplemented in Okular::FormFieldChoice, and Okular::FormFieldText.
◆ setPrintable()
|
virtual |
◆ setReadOnly()
|
virtual |
◆ setValue()
|
virtual |
Sets the value
associated with the form field.
- Since
- 24.08
Reimplemented in Okular::FormFieldChoice, and Okular::FormFieldText.
◆ setVisible()
|
virtual |
◆ type()
FormField::FieldType FormField::type | ( | ) | const |
◆ uiName()
|
pure virtual |
The visible name of the field, to be used in the user interface (eg in error messages, etc).
◆ value()
|
virtual |
Returns the value associated wit the form field.
- Since
- 24.08
Reimplemented in Okular::FormFieldChoice, and Okular::FormFieldText.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Mon Nov 18 2024 12:14:50 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.