• Skip to content
  • Skip to link menu
KDE 4.3 API Reference
  • KDE API Reference
  • kdelibs
  • Sitemap
  • Contact Us
 

KDEUI

KStringListValidator Class Reference

A QValidator to (dis)allow certain strings. More...

#include <kstringvalidator.h>

Inheritance diagram for KStringListValidator:
QValidator

List of all members.

Public Member Functions

virtual void fixup (QString &input) const
bool isFixupEnabled () const
bool isRejecting () const
 KStringListValidator (const QStringList &list=QStringList(), bool rejecting=true, bool fixupEnabled=false, QObject *parent=0)
void setFixupEnabled (bool fixupEnabled)
void setRejecting (bool rejecting)
void setStringList (const QStringList &list)
QStringList stringList () const
virtual State validate (QString &input, int &pos) const
 ~KStringListValidator ()

Properties

bool fixupEnabled
bool rejecting
QStringList stringList

Detailed Description

A QValidator to (dis)allow certain strings.

This validator allows you to accept only certain or to accept all but certain strings.

When used in rejecting mode, accepts only strings not in the stringlist. This mode is the default and comes in handy when asking the user for a name of some listed entity. Set the list of already used names to prevent the user from entering duplicate names.

When used in non-rejecting mode, accepts only strings that appear in the stringlist. Use with care! From a user's point of view this mode is hard to grasp.

This validator can also fix strings. In rejecting mode, a number will be appended to the string until it is Acceptable. E.g. if "foo" and "foo 1" are in the stringlist, then fixup will change "foo" to "foo 2", provided "foo 2" isn't in the list of forbidden strings.

In accepting mode, when the input starts with an Acceptable substring, truncates to the longest Acceptable string. When the input is the start of an Acceptable string, completes to the shortest Acceptable string.

NOTE: fixup isn't yet implemented.

Author:
Marc Mutz <mutz@kde.org>

Definition at line 60 of file kstringvalidator.h.


Constructor & Destructor Documentation

KStringListValidator::KStringListValidator ( const QStringList &  list = QStringList(),
bool  rejecting = true,
bool  fixupEnabled = false,
QObject *  parent = 0 
) [explicit]

Creates a new string validator.

Parameters:
list The list of strings to (dis)allow.
rejecting Selects the validator's mode (rejecting: true; accepting: false)
fixupEnabled Selects whether to fix strings or not.
parent Passed to lower level constructor.

Definition at line 35 of file kstringvalidator.cpp.

KStringListValidator::~KStringListValidator (  ) 

Destroys the string validator.

Definition at line 45 of file kstringvalidator.cpp.


Member Function Documentation

void KStringListValidator::fixup ( QString &  input  )  const [virtual]

Reimplemented from.

See also:
QValidator.

Definition at line 71 of file kstringvalidator.cpp.

bool KStringListValidator::isFixupEnabled (  )  const

Returns whether the fixup flag is set.

Definition at line 99 of file kstringvalidator.cpp.

bool KStringListValidator::isRejecting (  )  const

Returns whether the string validator is in rejecting mode.

Definition at line 89 of file kstringvalidator.cpp.

void KStringListValidator::setFixupEnabled ( bool  fixupEnabled  ) 

Sets the fixup flag.

If enabled, wrong input is corrected automatically.

Definition at line 94 of file kstringvalidator.cpp.

void KStringListValidator::setRejecting ( bool  rejecting  ) 

Sets whether the string validator is in rejecting mode or not.

If in rejecting mode, the strings from

See also:
stringList are not allowed to appear in the validation string.

Definition at line 84 of file kstringvalidator.cpp.

void KStringListValidator::setStringList ( const QStringList &  list  ) 

Sets the.

Parameters:
list of string which is used as black or white list, depending on the rejecting mode (
See also:
isRejecting()).

Definition at line 104 of file kstringvalidator.cpp.

QStringList KStringListValidator::stringList (  )  const

Returns the string list of the validator.

QValidator::State KStringListValidator::validate ( QString &  input,
int &  pos 
) const [virtual]

Reimplemented from.

See also:
QValidator.

Definition at line 50 of file kstringvalidator.cpp.


Property Documentation

bool KStringListValidator::fixupEnabled [read, write]

Definition at line 65 of file kstringvalidator.h.

bool KStringListValidator::rejecting [read, write]

Definition at line 64 of file kstringvalidator.h.

QStringList KStringListValidator::stringList [read, write]

Definition at line 63 of file kstringvalidator.h.


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

KDEUI

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

kdelibs

Skip menu "kdelibs"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • Kate
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.6.1
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