Okular::FormFieldChoice Class Reference

#include <form.h>

Inheritance diagram for Okular::FormFieldChoice:

Public Types
enum	ChoiceType { ComboBox, ListBox }
Public Types inherited from Okular::FormField
enum	FieldType { FormButton, FormText, FormChoice, FormSignature }

Public Member Functions
virtual	~FormFieldChoice ()
virtual bool	canBeSpellChecked () const
virtual QStringList	choices () const =0
virtual ChoiceType	choiceType () const =0
virtual QList< int >	currentChoices () const =0
virtual QString	editChoice () const
virtual bool	isEditable () const
virtual bool	multiSelect () const
virtual void	setCurrentChoices (const QList< int > &choices)
virtual void	setEditChoice (const QString &text)
virtual Qt::Alignment	textAlignment () const
Public Member Functions inherited from Okular::FormField
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
	FormFieldChoice ()
Protected Member Functions inherited from Okular::FormField
void	setActivationAction (Action *action)

Detailed Description

Interface of a choice form field.

This is the base interface to reimplement to represent a choice field, ie a field where the user can select one (of more) element(s) among a set of choices.

Definition at line 258 of file form.h.

Member Enumeration Documentation

enum Okular::FormFieldChoice::ChoiceType

The types of choice field.

Enumerator
ComboBox	A combo box choice field.
ListBox	A list box choice field.

Definition at line 264 of file form.h.

Constructor & Destructor Documentation

FormFieldChoice::~FormFieldChoice ( )

virtual

Definition at line 224 of file form.cpp.

FormFieldChoice::FormFieldChoice ( )

protected

Definition at line 219 of file form.cpp.

Member Function Documentation

bool FormFieldChoice::canBeSpellChecked ( ) const

virtual

Whether the text inserted manually in the field (where possible) can be spell-checked.

Note

meaningful only if the field is editable.

Definition at line 256 of file form.cpp.

virtual QStringList Okular::FormFieldChoice::choices ( ) const

pure virtual

The possible choices of the choice field.

virtual ChoiceType Okular::FormFieldChoice::choiceType ( ) const

pure virtual

The particular type of the choice field.

virtual QList< int > Okular::FormFieldChoice::currentChoices ( ) const

pure virtual

The currently selected choices.

Always one element in the list in case of single choice elements.

QString FormFieldChoice::editChoice ( ) const

virtual

The text entered into an editable combo box choice field.

Since

0.16 (KDE 4.10)

Definition at line 242 of file form.cpp.

bool FormFieldChoice::isEditable ( ) const

virtual

Whether this ComboBox is editable, ie the user can type in a custom value.

Always false for the other types of choices.

Definition at line 228 of file form.cpp.

bool FormFieldChoice::multiSelect ( ) const

virtual

Whether more than one choice of this ListBox can be selected at the same time.

Always false for the other types of choices.

Definition at line 233 of file form.cpp.

void FormFieldChoice::setCurrentChoices ( const QList< int > &  choices )

virtual

Sets the selected choices to choices .

Definition at line 238 of file form.cpp.

void FormFieldChoice::setEditChoice ( const QString &  text )

virtual

Sets the text entered into an editable combo box choice field.

Since

0.16 (KDE 4.10)

Definition at line 247 of file form.cpp.

Qt::Alignment FormFieldChoice::textAlignment ( ) const

virtual

The alignment of the text within the field.

Definition at line 251 of file form.cpp.

---

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

• form.h
• form.cpp