Wt  3.3.9
Public Member Functions | List of all members
Wt::WIntValidator Class Reference

A validator that validates integer user input. More...

#include <Wt/WIntValidator>

Inheritance diagram for Wt::WIntValidator:
Inheritance graph
[legend]

Public Member Functions

 WIntValidator (WObject *parent=0)
 Creates a new integer validator that accepts any integer. More...
 
 WIntValidator (int minimum, int maximum, WObject *parent=0)
 Creates a new integer validator that accepts integer input within the given range. More...
 
int bottom () const
 Returns the bottom of the valid integer range.
 
void setBottom (int bottom)
 Sets the bottom of the valid integer range. More...
 
int top () const
 Returns the top of the valid integer range.
 
void setTop (int top)
 Sets the top of the valid integer range. More...
 
virtual void setRange (int bottom, int top)
 Sets the range of valid integers.
 
virtual Result validate (const WString &input) const
 Validates the given input. More...
 
virtual void createExtConfig (std::ostream &config) const
 Provides Ext-compatible config options for client-side validation.
 
void setInvalidNotANumberText (const WString &text)
 Sets the message to display when the input is not a number. More...
 
WString invalidNotANumberText () const
 Returns the message displayed when the input is not a number. More...
 
void setInvalidTooSmallText (const WString &text)
 Sets the message to display when the number is too small. More...
 
WString invalidTooSmallText () const
 Returns the message displayed when the number is too small. More...
 
void setInvalidTooLargeText (const WString &text)
 Sets the message to display when the number is too large. More...
 
WString invalidTooLargeText () const
 Returns the message displayed when the number is too large. More...
 
void setIgnoreTrailingSpaces (bool b)
 If true the validator will ignore trailing spaces. More...
 
bool ignoreTrailingSpaces ()
 Indicates whether the validator should ignore the trailing spaces. More...
 
virtual std::string javaScriptValidate () const
 Creates a Javascript object that validates the input. More...
 
virtual std::string inputFilter () const
 Returns a regular expression that filters input. More...
 
- Public Member Functions inherited from Wt::WValidator
 WValidator (WObject *parent=0)
 Creates a new validator.
 
 WValidator (bool mandatory, WObject *parent=0)
 Creates a new validator. More...
 
 ~WValidator ()
 Destructor. More...
 
void setMandatory (bool how)
 Sets if input is mandatory. More...
 
bool isMandatory () const
 Returns if input is mandatory.
 
void setInvalidBlankText (const WString &text)
 Sets the message to display when a mandatory field is left blank. More...
 
WString invalidBlankText () const
 Returns the message displayed when a mandatory field is left blank. More...
 
virtual WString format () const
 Returns the validator format. More...
 
- Public Member Functions inherited from Wt::WObject
 WObject (WObject *parent=0)
 Create a WObject with a given parent object. More...
 
virtual ~WObject ()
 Destructor. More...
 
virtual const std::string id () const
 Returns the (unique) identifier for this object. More...
 
virtual void setObjectName (const std::string &name)
 Sets an object name. More...
 
virtual std::string objectName () const
 Returns the object name. More...
 
void resetLearnedSlots ()
 Resets learned stateless slot implementations. More...
 
template<class T >
void resetLearnedSlot (void(T::*method)())
 Resets a learned stateless slot implementation. More...
 
template<class T >
WStatelessSlot * implementStateless (void(T::*method)())
 Declares a slot to be stateless and learn client-side behaviour on first invocation. More...
 
template<class T >
WStatelessSlot * implementStateless (void(T::*method)(), void(T::*undoMethod)())
 Declares a slot to be stateless and learn client-side behaviour in advance. More...
 
void isNotStateless ()
 Marks the current function as not stateless. More...
 
template<class T >
WStatelessSlot * implementJavaScript (void(T::*method)(), const std::string &jsCode)
 Provides a JavaScript implementation for a method. More...
 
void addChild (WObject *child)
 Adds a child object. More...
 
virtual void removeChild (WObject *child)
 Removes a child object. More...
 
const std::vector< WObject * > & children () const
 Returns the children.
 
WObjectparent () const
 Returns the parent object.
 

Additional Inherited Members

- Public Types inherited from Wt::WValidator
- Public Types inherited from Wt::WObject
typedef void(WObject::* Method) ()
 Typedef for a WObject method without arguments.
 
- Protected Member Functions inherited from Wt::WObject
virtual WStatelessSlot * getStateless (Method method)
 On-demand stateless slot implementation. More...
 
- Static Protected Member Functions inherited from Wt::WObject
static WObjectsender ()
 Returns the sender of the current slot call. More...
 

Detailed Description

A validator that validates integer user input.

This validator checks whether user input is an integer number in a pre-defined range.

Usage example:

Wt::WLineEdit *lineEdit = new Wt::WLineEdit(this);
Wt::WIntValidator *validator = new Wt::WIntValidator(0, 100);
lineEdit->setValidator(validator);
lineEdit->setText("50");

i18n

The strings used in this class can be translated by overriding the default values for the following localization keys:

Constructor & Destructor Documentation

Wt::WIntValidator::WIntValidator ( WObject parent = 0)

Creates a new integer validator that accepts any integer.

The validator will accept numbers using the current locale's format.

See also
WLocale::currentLocale()
Wt::WIntValidator::WIntValidator ( int  minimum,
int  maximum,
WObject parent = 0 
)

Creates a new integer validator that accepts integer input within the given range.

See also
WLocale::currentLocale()

Member Function Documentation

bool Wt::WIntValidator::ignoreTrailingSpaces ( )

Indicates whether the validator should ignore the trailing spaces.

See also
setIgnoreTrailingSpaces()
std::string Wt::WIntValidator::inputFilter ( ) const
virtual

Returns a regular expression that filters input.

The returned regular expression is used to filter keys presses. The regular expression should accept valid single characters.

For details on valid regular expressions, see WRegExpValidator. As an example, "[0-9]" would only accept numbers as valid input.

The default implementation returns an empty string, which does not filter any input.

See also
javaScriptValidate()

Reimplemented from Wt::WValidator.

WString Wt::WIntValidator::invalidNotANumberText ( ) const

Returns the message displayed when the input is not a number.

See also
setInvalidNotANumberText(const WString&)
WString Wt::WIntValidator::invalidTooLargeText ( ) const

Returns the message displayed when the number is too large.

See also
setInvalidTooLargeText(const WString&)
WString Wt::WIntValidator::invalidTooSmallText ( ) const

Returns the message displayed when the number is too small.

See also
setInvalidTooSmallText(const WString&)
std::string Wt::WIntValidator::javaScriptValidate ( ) const
virtual

Creates a Javascript object that validates the input.

The JavaScript expression should evaluate to an object which contains a validate(text) function, which returns an object that contains the following two fields:

  • fields: a boolean valid,
  • a message that indicates the problem if not valid.

Returns an empty string if the validator does not provide a client-side validation implementationq.

Note
The signature and contract changed changed in Wt 3.1.9.
See also
inputFilter()

Reimplemented from Wt::WValidator.

void Wt::WIntValidator::setBottom ( int  bottom)

Sets the bottom of the valid integer range.

The default value is the minimum integer value.

void Wt::WIntValidator::setIgnoreTrailingSpaces ( bool  b)

If true the validator will ignore trailing spaces.

See also
ignoreTrailingSpaces()
void Wt::WIntValidator::setInvalidNotANumberText ( const WString text)

Sets the message to display when the input is not a number.

The default value is "Must be an integer number."

void Wt::WIntValidator::setInvalidTooLargeText ( const WString text)

Sets the message to display when the number is too large.

Depending on whether bottom() and top() are real bounds, the default message is "The number must be between {1} and {2}" or "The number must be smaller than {2}".

void Wt::WIntValidator::setInvalidTooSmallText ( const WString text)

Sets the message to display when the number is too small.

Depending on whether bottom() and top() are real bounds, the default message is "The number must be between {1} and {2}" or "The number must be larger than {1}".

void Wt::WIntValidator::setTop ( int  top)

Sets the top of the valid integer range.

The default value is the maximum integer value.

WValidator::Result Wt::WIntValidator::validate ( const WString input) const
virtual

Validates the given input.

The input is considered valid only when it is blank for a non-mandatory field, or represents an integer within the valid range.

Reimplemented from Wt::WValidator.


Generated on Tue Nov 21 2017 for the C++ Web Toolkit (Wt) by doxygen 1.8.11