Okular::FormFieldText Class Reference

#include <form.h>

Inheritance diagram for Okular::FormFieldText:

Public Types
enum	TextType { Normal , Multiline , FileSelect }
Public Types inherited from Okular::FormField
enum	AdditionalActionType { FieldModified , FormatField , ValidateField , CalculateField }
enum	FieldType { FormButton , FormText , FormChoice , FormSignature }

Public Member Functions
virtual bool	canBeSpellChecked () const
virtual bool	isPassword () const
virtual bool	isRichText () const
virtual int	maximumLength () const
virtual void	setAppearanceText (const QString &text)=0
void	setAppearanceValue (const QVariant &value) override
virtual void	setText (const QString &text)
void	setValue (const QVariant &value) override
virtual QString	text () const =0
virtual Qt::Alignment	textAlignment () const
virtual TextType	textType () const =0
QVariant	value () const override
Public Member Functions inherited from Okular::FormField
Action *	activationAction () const
Action *	additionalAction (AdditionalActionType type) const
Action *	additionalAction (Annotation::AdditionalActionType type) const
QList< Action * >	additionalActions () const
void	commitFormattedValue (const QString &value)
QString	committedFormattedValue () const
QString	committedValue () const
void	commitValue (const QString &value)
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
Page *	page () 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 text form field.

This is the base interface to reimplement to represent a text field, ie a field where the user insert text.

Definition at line 309 of file form.h.

Member Enumeration Documentation

TextType

enum Okular::FormFieldText::TextType

The types of text field.

Enumerator
Normal	A simple singleline text field.
Multiline	A multiline text field.
FileSelect	An input field to select the path of a file on disk.

Definition at line 315 of file form.h.

Constructor & Destructor Documentation

~FormFieldText()

FormFieldText::~FormFieldText ( )

override

Definition at line 237 of file form.cpp.

FormFieldText()

FormFieldText::FormFieldText ( )

protected

Definition at line 232 of file form.cpp.

Member Function Documentation

canBeSpellChecked()

bool FormFieldText::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 265 of file form.cpp.

isPassword()

bool FormFieldText::isPassword ( ) const

virtual

Whether this text field is a password input, eg its text must be replaced with asterisks.

Always false for FileSelect text fields.

Definition at line 245 of file form.cpp.

isRichText()

bool FormFieldText::isRichText ( ) const

virtual

Whether this text field should allow rich text.

Definition at line 250 of file form.cpp.

maximumLength()

int FormFieldText::maximumLength ( ) const

virtual

The maximum length allowed for the text of text field, or -1 if there is no limitation for the text.

Definition at line 255 of file form.cpp.

setAppearanceText()

virtual void Okular::FormFieldText::setAppearanceText ( const QString & text )

pure virtual

Set the text which should be rendered by the PDF.

Since

1.9

setAppearanceValue()

void FormFieldText::setAppearanceValue ( const QVariant & value )

overridevirtual

Sets the appearance value associated with the text form field.

Internally calls setAppearanceText(const QString &text) method.

Since

24.08

Reimplemented from Okular::FormField.

Definition at line 275 of file form.cpp.

setText()

void FormFieldText::setText ( const QString & text )

virtual

Sets the new text in the text field.

The default implementation does nothing.

Reimplemented only if the setting of new text is supported.

Definition at line 241 of file form.cpp.

setValue()

void FormFieldText::setValue ( const QVariant & value )

overridevirtual

Sets the value associated with the text form field.

The value is of type string and this function internally setText(const QString &text)

Since

24.08

Reimplemented from Okular::FormField.

Definition at line 270 of file form.cpp.

text()

virtual QString Okular::FormFieldText::text ( ) const

pure virtual

The text of text field.

textAlignment()

Qt::Alignment FormFieldText::textAlignment ( ) const

virtual

The alignment of the text within the field.

Definition at line 260 of file form.cpp.

textType()

virtual TextType Okular::FormFieldText::textType ( ) const

pure virtual

The particular type of the text field.

value()

QVariant FormFieldText::value ( ) const

overridevirtual

Returns the value associated with the text form field.

Internally calls text() method.

Since

24.08

Reimplemented from Okular::FormField.

Definition at line 280 of file form.cpp.

---

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

• form.h
• form.cpp