Search for usage in LXR

Okular::FormFieldButton Class Referenceabstract

#include <form.h>

Inheritance diagram for Okular::FormFieldButton:

Public Types

enum  ButtonType { Push , CheckBox , Radio }
- Public Types inherited from Okular::FormField
enum  AdditionalActionType { FieldModified , FormatField , ValidateField , CalculateField }
enum  FieldType { FormButton , FormText , FormChoice , FormSignature }

Public Member Functions

virtual ButtonType buttonType () const =0
virtual QString caption () const =0
virtual void setIcon (Okular::FormField *field)
virtual void setState (bool state)
virtual QList< int > siblings () const =0
virtual bool state () const =0
- Public Member Functions inherited from Okular::FormField
ActionactivationAction () const
ActionadditionalAction (AdditionalActionType type) const
ActionadditionalAction (Annotation::AdditionalActionType type) const
QList< Action * > additionalActions () 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
Pagepage () const
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

Additional Inherited Members

- 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

Interface of a button form field.

This is the base interface to reimplement to represent a button field, like a push button, a check box or a radio button.

0.7 (KDE 4.1)

Definition at line 197 of file form.h.

Member Enumeration Documentation

◆ ButtonType

The types of button field.


A simple push button.


A check box.


A radio button.

Definition at line 203 of file form.h.

Constructor & Destructor Documentation

◆ ~FormFieldButton()

FormFieldButton::~FormFieldButton ( )

Definition at line 160 of file form.cpp.

◆ FormFieldButton()

FormFieldButton::FormFieldButton ( )

Definition at line 155 of file form.cpp.

Member Function Documentation

◆ buttonType()

virtual ButtonType Okular::FormFieldButton::buttonType ( ) const
pure virtual

The particular type of the button field.

◆ caption()

virtual QString Okular::FormFieldButton::caption ( ) const
pure virtual

The caption to be used for the button.

◆ setIcon()

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

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


Definition at line 168 of file form.cpp.

◆ setState()

void FormFieldButton::setState ( bool state)

Sets the state of the button to the new state .

Definition at line 164 of file form.cpp.

◆ siblings()

virtual QList< int > Okular::FormFieldButton::siblings ( ) const
pure virtual

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.

◆ state()

virtual bool Okular::FormFieldButton::state ( ) const
pure virtual

The state of the button.

The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri May 17 2024 11:54:29 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.