Okular::FormField

#include <form.h>

Inheritance diagram for Okular::FormField:

Public Types

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

Public Member Functions

ActionactivationAction () const
 
ActionadditionalAction (AdditionalActionType type) const
 
ActionadditionalAction (Annotation::AdditionalActionType type) const
 
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
 
virtual NormalizedRect rect () const =0
 
virtual void setPrintable (bool value)
 
virtual void setReadOnly (bool value)
 
virtual void setVisible (bool value)
 
FieldType type () const
 
virtual QString uiName () const =0
 

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.

Definition at line 41 of file form.h.

Member Enumeration Documentation

Describes the type of form additional action.

Since
1.1
Enumerator
FieldModified 

An action to be performed when the user modifies the field.

FormatField 

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

ValidateField 

An action to be performed when the field value changes.

CalculateField 

An action to be performed when the field needs to be recalculated.

Definition at line 141 of file form.h.

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.

Definition at line 52 of file form.h.

Member Function Documentation

Action * FormField::additionalAction ( AdditionalActionType  type) const

Returns the additional action of the given type or nullptr if no action has been defined.

Since
1.1

Definition at line 95 of file form.cpp.

virtual QString Okular::FormField::fullyQualifiedName ( ) const
pure virtual

The fully qualified name of the field, is used in the JavaScript scripts.

Since
1.9
virtual int Okular::FormField::id ( ) const
pure virtual

The ID of the field.

bool FormField::isPrintable ( ) const
virtual

Whether this field is printable.

Since
1.9

Definition at line 73 of file form.cpp.

bool FormField::isReadOnly ( ) const
virtual

Whether the field is read-only.

Definition at line 55 of file form.cpp.

bool FormField::isVisible ( ) const
virtual

Whether this form field is visible.

Definition at line 64 of file form.cpp.

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 bounding rect of the field, in normalized coordinates.

void FormField::setPrintable ( bool  value)
virtual

Set this field printable.

Since
1.9

Definition at line 78 of file form.cpp.

void FormField::setReadOnly ( bool  value)
virtual

Whether the field is read-only.

Since
1.4

Definition at line 60 of file form.cpp.

void FormField::setVisible ( bool  value)
virtual

Whether the field is visible.

Since
1.5

Definition at line 69 of file form.cpp.

FormField::FieldType FormField::type ( ) const

The type of the field.

Definition at line 49 of file form.cpp.

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:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Fri Nov 27 2020 22:37:30 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.