Okular::FormField Class Reference

#include <form.h>

Inheritance diagram for Okular::FormField:

Public Types
enum	FieldType { FormButton, FormText, FormChoice, FormSignature }

Public Member Functions
virtual	~FormField ()
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

Protected Member Functions
void	setActivationAction (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 36 of file form.h.

Member Enumeration Documentation

enum Okular::FormField::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.

Definition at line 47 of file form.h.

Constructor & Destructor Documentation

FormField::~FormField ( )

virtual

Definition at line 42 of file form.cpp.

Member Function Documentation

Action * FormField::activationAction

(

)

const

Definition at line 63 of file form.cpp.

virtual int Okular::FormField::id ( ) const

pure virtual

The ID of the field.

bool FormField::isReadOnly ( ) const

virtual

Whether the field is read-only.

Definition at line 53 of file form.cpp.

bool FormField::isVisible ( ) const

virtual

Whether this form field is visible.

Definition at line 58 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 bouding rect of the field, in normalized coordinates.

void FormField::setActivationAction ( Action *  action )

protected

Definition at line 69 of file form.cpp.

FormField::FieldType FormField::type

(

)

const

The type of the field.

Definition at line 47 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:

• form.h
• form.cpp