Search for usage in LXR

Okular::FormFieldText Class Referenceabstract

#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
virtual void setText (const QString &text)
virtual QString text () const =0
virtual Qt::Alignment textAlignment () const
virtual TextType textType () 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 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 260 of file form.h.

Member Enumeration Documentation

◆ TextType

The types of text field.


A simple singleline text field.


A multiline text field.


An input field to select the path of a file on disk.

Definition at line 266 of file form.h.

Member Function Documentation

◆ canBeSpellChecked()

bool FormFieldText::canBeSpellChecked ( ) const

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

meaningful only if the field is editable.

Definition at line 228 of file form.cpp.

◆ isPassword()

bool FormFieldText::isPassword ( ) const

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 208 of file form.cpp.

◆ isRichText()

bool FormFieldText::isRichText ( ) const

Whether this text field should allow rich text.

Definition at line 213 of file form.cpp.

◆ maximumLength()

int FormFieldText::maximumLength ( ) const

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

Definition at line 218 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.


◆ setText()

void FormFieldText::setText ( const QString text)

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 204 of file form.cpp.

◆ text()

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

The text of text field.

◆ textAlignment()

Qt::Alignment FormFieldText::textAlignment ( ) const

The alignment of the text within the field.

Definition at line 223 of file form.cpp.

◆ textType()

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

The particular type of the text field.

The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2023 The KDE developers.
Generated on Sat Dec 2 2023 03:57:30 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.