Poppler Qt5 24.05.0
Public Types | Public Member Functions | List of all members
Poppler::FormFieldButton Class Reference

#include <poppler-form.h>

Inheritance diagram for Poppler::FormFieldButton:
Inheritance graph
Collaboration diagram for Poppler::FormFieldButton:
Collaboration graph

Public Types

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

Public Member Functions

ButtonType buttonType () const
QString caption () const
FormFieldIcon icon () const
void setIcon (const FormFieldIcon &icon)
void setState (bool state)
QList< int > siblings () const
bool state () const
FormType type () const override
- Public Member Functions inherited from Poppler::FormField
LinkactivationAction () const
LinkadditionalAction (AdditionalActionType type) const
LinkadditionalAction (Annotation::AdditionalActionType type) const
QString fullyQualifiedName () const
int id () const
bool isPrintable () const
bool isReadOnly () const
bool isVisible () const
QString name () const
QRectF rect () const
void setName (const QString &name) const
void setPrintable (bool value)
void setReadOnly (bool value)
void setVisible (bool value)
QString uiName () const

Detailed Description

A form field that represents a "button".


Member Enumeration Documentation

◆ ButtonType

The types of button field.


A simple push button.


A check box.


A radio button.

Member Function Documentation

◆ icon()

FormFieldIcon Poppler::FormFieldButton::icon ( ) const

Gets the icon used by the button.


◆ setIcon()

void Poppler::FormFieldButton::setIcon ( const FormFieldIcon icon)

Sets a new icon for the button, it has to be a icon returned by FormFieldButton::icon.


◆ siblings()

QList< int > Poppler::FormFieldButton::siblings ( ) const

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.

◆ type()

FormType Poppler::FormFieldButton::type ( ) const

The type of the field.

Implements Poppler::FormField.

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