PopplerFormFieldButton Class Reference

#include <formfields.h>

Inheritance diagram for PopplerFormFieldButton:

Public Member Functions
	PopplerFormFieldButton (std::unique_ptr< Poppler::FormFieldButton > field)
ButtonType	buttonType () const override
QString	caption () const override
QString	fullyQualifiedName () const override
int	id () const override
bool	isPrintable () const override
bool	isReadOnly () const override
bool	isVisible () const override
QString	name () const override
Okular::NormalizedRect	rect () const override
void	setIcon (Okular::FormField *field) override
void	setPrintable (bool value) override
void	setReadOnly (bool value) override
void	setState (bool state) override
void	setVisible (bool value) override
QList< int >	siblings () const override
bool	state () const override
QString	uiName () const override
Public Member Functions inherited from Okular::FormFieldButton
	~FormFieldButton () override
Public Member Functions inherited from Okular::FormField
virtual	~FormField ()
Action *	activationAction () const
Action *	additionalAction (AdditionalActionType type) const
Action *	additionalAction (Annotation::AdditionalActionType type) const
FieldType	type () const

Additional Inherited Members
Public Types inherited from Okular::FormFieldButton
enum	ButtonType { Push, CheckBox, Radio }
Public Types inherited from Okular::FormField
enum	AdditionalActionType { FieldModified, FormatField, ValidateField, CalculateField }
enum	FieldType { FormButton, FormText, FormChoice, FormSignature }
Protected Member Functions inherited from Okular::FormFieldButton
	FormFieldButton ()
Protected Member Functions inherited from Okular::FormField
void	setActivationAction (Action *action)
void	setAdditionalAction (AdditionalActionType type, Action *action)
void	setAdditionalAction (Annotation::AdditionalActionType type, Action *action)

Detailed Description

Definition at line 18 of file formfields.h.

Constructor & Destructor Documentation

PopplerFormFieldButton::PopplerFormFieldButton ( std::unique_ptr< Poppler::FormFieldButton >  field )

explicit

Definition at line 43 of file formfields.cpp.

Member Function Documentation

Okular::FormFieldButton::ButtonType PopplerFormFieldButton::buttonType ( ) const

overridevirtual

The particular type of the button field.

Implements Okular::FormFieldButton.

Definition at line 122 of file formfields.cpp.

QString PopplerFormFieldButton::caption ( ) const

overridevirtual

The caption to be used for the button.

Implements Okular::FormFieldButton.

Definition at line 136 of file formfields.cpp.

QString PopplerFormFieldButton::fullyQualifiedName ( ) const

overridevirtual

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

Since

1.9

Implements Okular::FormField.

Definition at line 71 of file formfields.cpp.

int PopplerFormFieldButton::id ( ) const

overridevirtual

The ID of the field.

Implements Okular::FormField.

Definition at line 56 of file formfields.cpp.

bool PopplerFormFieldButton::isPrintable ( ) const

overridevirtual

Whether this field is printable.

Since

1.9

Reimplemented from Okular::FormField.

Definition at line 104 of file formfields.cpp.

bool PopplerFormFieldButton::isReadOnly ( ) const

overridevirtual

Whether the field is read-only.

Reimplemented from Okular::FormField.

Definition at line 76 of file formfields.cpp.

bool PopplerFormFieldButton::isVisible ( ) const

overridevirtual

Whether this form field is visible.

Reimplemented from Okular::FormField.

Definition at line 90 of file formfields.cpp.

QString PopplerFormFieldButton::name ( ) const

overridevirtual

The internal name of the field, to be used when referring to the field in eg scripts.

Implements Okular::FormField.

Definition at line 61 of file formfields.cpp.

Okular::NormalizedRect PopplerFormFieldButton::rect ( ) const

overridevirtual

The bounding rect of the field, in normalized coordinates.

Implements Okular::FormField.

Definition at line 51 of file formfields.cpp.

void PopplerFormFieldButton::setIcon ( Okular::FormField *  field )

overridevirtual

Sets the icon of the Button to the Icon of the field parameter.

Since

1.9

Reimplemented from Okular::FormFieldButton.

Definition at line 163 of file formfields.cpp.

void PopplerFormFieldButton::setPrintable ( bool  value )

overridevirtual

Set this field printable.

Since

1.9

Reimplemented from Okular::FormField.

Definition at line 113 of file formfields.cpp.

void PopplerFormFieldButton::setReadOnly ( bool  value )

overridevirtual

Whether the field is read-only.

Since

1.4

Reimplemented from Okular::FormField.

Definition at line 81 of file formfields.cpp.

void PopplerFormFieldButton::setState ( bool  state )

overridevirtual

Sets the state of the button to the new state .

Reimplemented from Okular::FormFieldButton.

Definition at line 146 of file formfields.cpp.

void PopplerFormFieldButton::setVisible ( bool  value )

overridevirtual

Whether the field is visible.

Since

1.5

Reimplemented from Okular::FormField.

Definition at line 95 of file formfields.cpp.

QList< int > PopplerFormFieldButton::siblings ( ) const

overridevirtual

The list with the IDs of siblings (ie, buttons belonging to the same group as the current one.

Valid only for Radio buttons, an empty list otherwise.

Implements Okular::FormFieldButton.

Definition at line 151 of file formfields.cpp.

bool PopplerFormFieldButton::state ( ) const

overridevirtual

The state of the button.

Implements Okular::FormFieldButton.

Definition at line 141 of file formfields.cpp.

QString PopplerFormFieldButton::uiName ( ) const

overridevirtual

The visible name of the field, to be used in the user interface (eg in error messages, etc).

Implements Okular::FormField.

Definition at line 66 of file formfields.cpp.

---

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

• formfields.h
• formfields.cpp