Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
Loading...
Searching...
No Matches
QIntValidator Class Reference

The QIntValidator class provides a validator that ensures a string contains a valid integer within a specified range. More...

#include <qvalidator.h>

+ Inheritance diagram for QIntValidator:
+ Collaboration diagram for QIntValidator:

Signals

void bottomChanged (int bottom)
 This signal is emitted after the bottom property changed.
 
void topChanged (int top)
 This signal is emitted after the top property changed.
 
- Signals inherited from QValidator
void changed ()
 This signal is emitted when any property that may affect the validity of a string has changed.
 
- Signals inherited from QObject
void destroyed (QObject *=nullptr)
 This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.
 
void objectNameChanged (const QString &objectName, QPrivateSignal)
 This signal is emitted after the object's name has been changed.
 

Public Member Functions

 QIntValidator (QObject *parent=nullptr)
 Constructs a validator with a parent object that accepts all integers.
 
 QIntValidator (int bottom, int top, QObject *parent=nullptr)
 Constructs a validator with a parent, that accepts integers from minimum to maximum inclusive.
 
 ~QIntValidator ()
 Destroys the validator.
 
QValidator::State validate (QString &, int &) const override
 Returns \l Acceptable if the input is an integer within the valid range.
 
void fixup (QString &input) const override
 \reimp
 
void setBottom (int)
 
void setTop (int)
 
void setRange (int bottom, int top)
 Sets the range of the validator to only accept integers between bottom and top inclusive.
 
int bottom () const
 
int top () const
 
- Public Member Functions inherited from QValidator
 QValidator (QObject *parent=nullptr)
 Sets up the validator.
 
 ~QValidator ()
 Destroys the validator, freeing any storage and other resources used.
 
void setLocale (const QLocale &locale)
 Sets the locale that will be used for the validator.
 
QLocale locale () const
 Returns the locale for the validator.
 
- Public Member Functions inherited from QObject
Q_INVOKABLE QObject (QObject *parent=nullptr)
 Constructs an object with parent object parent.
 
virtual ~QObject ()
 Destroys the object, deleting all its child objects.
 
virtual bool event (QEvent *event)
 This virtual function receives events to an object and should return true if the event e was recognized and processed.
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 Filters events if this object has been installed as an event filter for the watched object.
 
QString objectName () const
 
Q_WEAK_OVERLOAD void setObjectName (const QString &name)
 Sets the object's name to name.
 
void setObjectName (QAnyStringView name)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
QBindable< QStringbindableObjectName ()
 
bool isWidgetType () const
 Returns true if the object is a widget; otherwise returns false.
 
bool isWindowType () const
 Returns true if the object is a window; otherwise returns false.
 
bool isQuickItemType () const
 Returns true if the object is a QQuickItem; otherwise returns false.
 
bool signalsBlocked () const noexcept
 Returns true if signals are blocked; otherwise returns false.
 
bool blockSignals (bool b) noexcept
 If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).
 
QThreadthread () const
 Returns the thread in which the object lives.
 
bool moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
 Changes the thread affinity for this object and its children and returns true on success.
 
int startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
 This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.
 
int startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)
 
void killTimer (int id)
 Kills the timer with timer identifier, id.
 
void killTimer (Qt::TimerId id)
 
template<typename T >
findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.
 
template<typename T >
QList< T > findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.
 
template<typename T >
findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
template<typename T >
QList< T > findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
const QObjectListchildren () const
 Returns a list of child objects.
 
void setParent (QObject *parent)
 Makes the object a child of parent.
 
void installEventFilter (QObject *filterObj)
 Installs an event filter filterObj on this object.
 
void removeEventFilter (QObject *obj)
 Removes an event filter object obj from this object.
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const
 
bool disconnect (const char *signal=nullptr, const QObject *receiver=nullptr, const char *member=nullptr) const
 
bool disconnect (const QObject *receiver, const char *member=nullptr) const
 
void dumpObjectTree () const
 Dumps a tree of children to the debug output.
 
void dumpObjectInfo () const
 Dumps information about signal connections, etc.
 
bool setProperty (const char *name, const QVariant &value)
 Sets the value of the object's name property to value.
 
bool setProperty (const char *name, QVariant &&value)
 
QVariant property (const char *name) const
 Returns the value of the object's name property.
 
QList< QByteArraydynamicPropertyNames () const
 
QBindingStoragebindingStorage ()
 
const QBindingStoragebindingStorage () const
 
QObjectparent () const
 Returns a pointer to the parent object.
 
bool inherits (const char *classname) const
 Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false.
 

Properties

int bottom
 the validator's lowest acceptable value
 
int top
 the validator's highest acceptable value
 
- Properties inherited from QObject
QString objectName
 the name of this object
 

Additional Inherited Members

- Public Types inherited from QValidator
enum  State { Invalid , Intermediate , Acceptable }
 This enum type defines the states in which a validated string can exist. More...
 
- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 
- Static Public Member Functions inherited from QObject
static QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType=Qt::AutoConnection)
 \threadsafe
 
static QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)
 
template<typename Func1 , typename Func2 >
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType *context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)
 
template<typename Func1 , typename Func2 >
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)
 
static bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member)
 \threadsafe
 
static bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member)
 
static bool disconnect (const QMetaObject::Connection &)
 Disconnect a connection.
 
template<typename Func1 , typename Func2 >
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object *receiver, Func2 slot)
 
template<typename Func1 >
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const QObject *receiver, void **zero)
 
- Protected Member Functions inherited from QValidator
 QValidator (QObjectPrivate &d, QObject *parent)
 
 QValidator (QValidatorPrivate &d, QObject *parent)
 
- Protected Member Functions inherited from QObject
QObjectsender () const
 Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.
 
int senderSignalIndex () const
 
int receivers (const char *signal) const
 Returns the number of receivers connected to the signal.
 
bool isSignalConnected (const QMetaMethod &signal) const
 
virtual void timerEvent (QTimerEvent *event)
 This event handler can be reimplemented in a subclass to receive timer events for the object.
 
virtual void childEvent (QChildEvent *event)
 This event handler can be reimplemented in a subclass to receive child events.
 
virtual void customEvent (QEvent *event)
 This event handler can be reimplemented in a subclass to receive custom events.
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
 QObject (QObjectPrivate &dd, QObject *parent=nullptr)
 
- Protected Attributes inherited from QObject
QScopedPointer< QObjectDatad_ptr
 

Detailed Description

The QIntValidator class provides a validator that ensures a string contains a valid integer within a specified range.

\inmodule QtGui

Example of use:

QValidator *validator = new QIntValidator(100, 999, this);
QLineEdit *edit = new QLineEdit(this);
// the edit lineedit will only accept integers between 100 and 999
edit->setValidator(validator);

Below we present some examples of validators. In practice they would normally be associated with a widget as in the example above.

int pos = 0;
QIntValidator v(100, 900, this);
str = "1";
v.validate(str, pos); // returns Intermediate
str = "012";
v.validate(str, pos); // returns Intermediate
str = "123";
v.validate(str, pos); // returns Acceptable
str = "678";
v.validate(str, pos); // returns Acceptable
str = "999";
v.validate(str, pos); // returns Intermediate
str = "1234";
v.validate(str, pos); // returns Invalid
str = "-123";
v.validate(str, pos); // returns Invalid
str = "abc";
v.validate(str, pos); // returns Invalid
str = "12cm";
v.validate(str, pos); // returns Invalid

Notice that the value 999 returns Intermediate. Values consisting of a number of digits equal to or less than the max value are considered intermediate. This is intended because the digit that prevents a number from being in range is not necessarily the last digit typed. This also means that an intermediate number can have leading zeros.

The minimum and maximum values are set in one call with setRange(), or individually with setBottom() and setTop().

QIntValidator uses its locale() to interpret the number. For example, in Arabic locales, QIntValidator will accept Arabic digits.

Note
The QLocale::NumberOptions set on the locale() also affect the way the number is interpreted. For example, since QLocale::RejectGroupSeparator is not set by default, the validator will accept group separators. It is thus recommended to use QLocale::toInt() to obtain the numeric value.
See also
QDoubleValidator, QRegularExpressionValidator, QLocale::toInt(), {Line Edits Example}

Definition at line 55 of file qvalidator.h.

Constructor & Destructor Documentation

◆ QIntValidator() [1/2]

QIntValidator::QIntValidator ( QObject * parent = nullptr)
explicit

Constructs a validator with a parent object that accepts all integers.

Definition at line 296 of file qvalidator.cpp.

◆ QIntValidator() [2/2]

QIntValidator::QIntValidator ( int bottom,
int top,
QObject * parent = nullptr )

Constructs a validator with a parent, that accepts integers from minimum to maximum inclusive.

Definition at line 307 of file qvalidator.cpp.

◆ ~QIntValidator()

QIntValidator::~QIntValidator ( )

Destroys the validator.

Definition at line 320 of file qvalidator.cpp.

Member Function Documentation

◆ bottom()

int QIntValidator::bottom ( ) const
inline

Definition at line 73 of file qvalidator.h.

◆ bottomChanged

void QIntValidator::bottomChanged ( int bottom)
signal

This signal is emitted after the bottom property changed.

See also
QIntValidator::top(), QIntValidator::setTop(), QIntValidator::bottom(), QIntValidator::setBottom()

Referenced by setRange().

+ Here is the caller graph for this function:

◆ fixup()

void QIntValidator::fixup ( QString & input) const
overridevirtual

\reimp

Reimplemented from QValidator.

Definition at line 426 of file qvalidator.cpp.

References QLocaleData::bytearrayToLongLong(), QLocaleData::IntegerMode, ParsingResult::Invalid, QValidator::locale(), QLocalePrivate::m_data, QLocale::toString(), and QLocaleData::validateChars().

+ Here is the call graph for this function:

◆ setBottom()

void QIntValidator::setBottom ( int bottom)

Definition at line 473 of file qvalidator.cpp.

References setRange(), and top.

+ Here is the call graph for this function:

◆ setRange()

void QIntValidator::setRange ( int bottom,
int top )

Sets the range of the validator to only accept integers between bottom and top inclusive.

Definition at line 444 of file qvalidator.cpp.

References bottom, bottomChanged(), QValidator::changed(), emit, top, and topChanged().

Referenced by setBottom(), and setTop().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setTop()

void QIntValidator::setTop ( int top)

Definition at line 487 of file qvalidator.cpp.

References bottom, and setRange().

+ Here is the call graph for this function:

◆ top()

int QIntValidator::top ( ) const
inline

Definition at line 74 of file qvalidator.h.

◆ topChanged

void QIntValidator::topChanged ( int top)
signal

This signal is emitted after the top property changed.

See also
QIntValidator::top(), QIntValidator::setTop(), QIntValidator::bottom(), QIntValidator::setBottom()

Referenced by setRange().

+ Here is the caller graph for this function:

◆ validate()

QValidator::State QIntValidator::validate ( QString & input,
int & pos ) const
overridevirtual

Returns \l Acceptable if the input is an integer within the valid range.

If input has at most as many digits as the top of the range, or is a prefix of an integer in the valid range, returns \l Intermediate. Otherwise, returns \l Invalid.

If the valid range consists of just positive integers (e.g., 32 to 100) and input is a negative integer, then Invalid is returned. (On the other hand, if the range consists of negative integers (e.g., -100 to -32) and input is a positive integer without leading plus sign, then Intermediate is returned, because the user might be just about to type the minus (especially for right-to-left languages).

Similarly, if the valid range is between 46 and 53, then 41 and 59 will be evaluated as \l Intermediate, as otherwise the user wouldn't be able to change a value from 49 to 51.

int pos = 0;
s = "abc";
v.validate(s, pos); // returns Invalid
s = "5";
v.validate(s, pos); // returns Intermediate
s = "50";
v.validate(s, pos); // returns Acceptable

By default, the pos parameter is not used by this validator.

Implements QValidator.

Definition at line 386 of file qvalidator.cpp.

References QValidator::Acceptable, QLocaleData::bytearrayToLongLong(), initialResultCheck(), QLocaleData::IntegerMode, QValidator::Intermediate, QValidator::Invalid, QValidator::locale(), QLocalePrivate::m_data, ok, opt, qAbs(), QVLABaseBase::size(), QLocale::toInt(), and QLocaleData::validateChars().

+ Here is the call graph for this function:

Property Documentation

◆ bottom

QIntValidator::bottom
readwrite

the validator's lowest acceptable value

By default, this property's value is derived from the lowest signed integer available (-2147483648).

See also
setRange()

Definition at line 58 of file qvalidator.h.

Referenced by setRange(), and setTop().

◆ top

QIntValidator::top
readwrite

the validator's highest acceptable value

By default, this property's value is derived from the highest signed integer available (2147483647).

See also
setRange()

Definition at line 59 of file qvalidator.h.

Referenced by setBottom(), and setRange().


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