• Skip to content
  • Skip to link menu
KDE 4.0 API Reference
  • KDE API Reference
  • kdegraphics
  • Sitemap
  • Contact Us
 

okular

Okular::FormFieldText

Okular::FormFieldText Class Reference

#include <form.h>

Inheritance diagram for Okular::FormFieldText:

Inheritance graph
[legend]

List of all members.


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 110 of file form.h.


Public Types

enum  TextType { Normal, Multiline, FileSelect }

Public Member Functions

virtual ~FormFieldText ()
virtual TextType textType () const =0
virtual QString text () const =0
virtual void setText (const QString &text)
virtual bool isPassword () const
virtual bool isRichText () const
virtual int maximumLength () const
virtual Qt::Alignment textAlignment () const
virtual bool canBeSpellChecked () const

Protected Member Functions

 FormFieldText ()

Member Enumeration Documentation

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 116 of file form.h.


Constructor & Destructor Documentation

FormFieldText::~FormFieldText (  )  [virtual]

Definition at line 90 of file form.cpp.

FormFieldText::FormFieldText (  )  [protected]

Definition at line 85 of file form.cpp.


Member Function Documentation

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

The particular type of the text field.

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

The text of text field.

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

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

bool FormFieldText::isRichText (  )  const [virtual]

Whether this text field should allow rich text.

Definition at line 103 of file form.cpp.

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

Qt::Alignment FormFieldText::textAlignment (  )  const [virtual]

The alignment of the text within the field.

Definition at line 113 of file form.cpp.

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


The documentation for this class was generated from the following files:
  • form.h
  • form.cpp

okular

Skip menu "okular"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdegraphics

Skip menu "kdegraphics"
  • okular
Generated for kdegraphics by doxygen 1.5.4
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal