KDE 4.2 API Reference okular
Okular::FormField Class Reference
#include <form.h>
Inheritance diagram for Okular::FormField:
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.
Definition at line 36 of file form.h.
Public Types | |
| enum | FieldType { FormButton, FormText, FormChoice, FormSignature } |
Public Member Functions | |
| Action * | activationAction () const |
| virtual int | id () const =0 |
| virtual bool | isReadOnly () const |
| virtual bool | isVisible () const |
| virtual QString | name () const =0 |
| virtual NormalizedRect | rect () const =0 |
| FieldType | type () const |
| virtual QString | uiName () const =0 |
| virtual | ~FormField () |
Protected Member Functions | |
| void | setActivationAction (Action *action) |
Member Enumeration Documentation
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
Member Function Documentation
| virtual int Okular::FormField::id | ( | ) | const [pure virtual] |
The ID of the field.
| bool FormField::isReadOnly | ( | ) | const [virtual] |
| bool FormField::isVisible | ( | ) | const [virtual] |
| virtual QString Okular::FormField::name | ( | ) | const [pure virtual] |
The internal name of the field, to be used when referring to the field in eg scripts.
| virtual NormalizedRect Okular::FormField::rect | ( | ) | const [pure virtual] |
The bouding rect of the field, in normalized coordinates.
| void FormField::setActivationAction | ( | Action * | action | ) | [protected] |
| FormField::FieldType FormField::type | ( | ) | const |
| virtual QString Okular::FormField::uiName | ( | ) | const [pure virtual] |
The visible name of the field, to be used in the user interface (eg in error messages, etc).
The documentation for this class was generated from the following files:
