Wt  4.0.2
Public Member Functions | List of all members
Wt::WLengthValidator Class Reference

A validator that checks the string length of user input. More...

#include <Wt/WLengthValidator.h>

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

Public Member Functions

 WLengthValidator ()
 Creates a length validator that accepts input of any length.
 
 WLengthValidator (int minLength, int maxLength)
 Creates a length validator that accepts input within a length range.
 
void setMinimumLength (int minimum)
 Sets the minimum length. More...
 
int minimumLength () const
 Returns the minimum length. More...
 
void setMaximumLength (int maximum)
 Sets the maximum length. More...
 
int maximumLength () const
 Returns the maximum length. More...
 
virtual Result validate (const WString &input) const override
 Validates the given input. More...
 
void setInvalidTooShortText (const WString &text)
 Sets the message to display when the input is too short. More...
 
WString invalidTooShortText () const
 Returns the message displayed when the input is too short. More...
 
void setInvalidTooLongText (const WString &text)
 Sets the message to display when the input is too long. More...
 
WString invalidTooLongText () const
 Returns the message displayed when the input is too long. More...
 
virtual std::string javaScriptValidate () const override
 Creates a Javascript object that validates the input. More...
 
- Public Member Functions inherited from Wt::WValidator
 WValidator (bool mandatory=false)
 Creates a new validator. More...
 
virtual ~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...
 
virtual std::string inputFilter () const
 Returns a regular expression that filters input. More...
 

Additional Inherited Members

- Public Types inherited from Wt::WValidator
typedef ValidationState State
 Typedef for enum Wt::ValidationState.
 

Detailed Description

A validator that checks the string length of user input.

This validator checks whether user input is within the specified range of accepted string lengths.

If you only want to limit the length on a line edit, you may also use WLineEdit::setMaxLength().

Usage example:

Wt::WLineEdit *lineEdit = addWidget(std::make_unique<Wt::WLineEdit>());
auto validator = std::make_shared<Wt::WLengthValidator>(5, 15);
lineEdit->setValidator(validator);
lineEdit->setText("abcdef");

i18n

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

Member Function Documentation

WString Wt::WLengthValidator::invalidTooLongText ( ) const

Returns the message displayed when the input is too long.

See also
setInvalidTooLongText(const WString&)
WString Wt::WLengthValidator::invalidTooShortText ( ) const

Returns the message displayed when the input is too short.

See also
setInvalidTooShortText(const WString&)
std::string Wt::WLengthValidator::javaScriptValidate ( ) const
overridevirtual

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.

int Wt::WLengthValidator::maximumLength ( ) const

Returns the maximum length.

See also
setMaximumLength(int)
int Wt::WLengthValidator::minimumLength ( ) const

Returns the minimum length.

See also
setMinimumLength(int)
void Wt::WLengthValidator::setInvalidTooLongText ( const WString text)

Sets the message to display when the input is too long.

Depending on whether minimumLength() is different from zero, the default message is "The input must have a length between {1} and {2} characters" or " "The input must be no more than {2} characters".

void Wt::WLengthValidator::setInvalidTooShortText ( const WString text)

Sets the message to display when the input is too short.

Depending on whether maximumLength() is a real bound, the default message is "The input must have a length between {1} and {2} characters" or " "The input must be at least {1} characters".

void Wt::WLengthValidator::setMaximumLength ( int  maximum)

Sets the maximum length.

The default value is the maximum integer value.

void Wt::WLengthValidator::setMinimumLength ( int  minimum)

Sets the minimum length.

The default value is 0.

WValidator::Result Wt::WLengthValidator::validate ( const WString input) const
overridevirtual

Validates the given input.

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

Reimplemented from Wt::WValidator.


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