kdeui Library API Documentation

KStringListValidator Class Reference

This validator allows you to accept only certain or to accept all but certain strings. A QValidator to (dis)allow certain strings. More...

#include <kstringvalidator.h>

Inheritance diagram for KStringListValidator:

QValidator List of all members.

Public Methods

 KStringListValidator (const QStringList &list=QStringList(), bool rejecting=true, bool fixupEnabled=false, QObject *parent=0, const char *name=0)
 Construct a new validator.

virtual State validate (QString &input, int &pos) const
virtual void fixup (QString &input) const

Detailed Description

This validator allows you to accept only certain or to accept all but certain strings. A QValidator to (dis)allow 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 57 of file kstringvalidator.h.


Constructor & Destructor Documentation

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

Construct a new 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.

Definition at line 70 of file kstringvalidator.h.


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kdelibs Version 3.1.0.
Documentation copyright © 1996-2002 the KDE developers.
Generated on Wed Oct 8 12:21:07 2003 by doxygen 1.2.18 written by Dimitri van Heesch, © 1997-2001