wxTextValidator

wxTextValidator validates text controls, providing a variety of filtering behaviours.

For more information, please see Validator overview.

Derived from

wxValidator
wxEvtHandler
wxObject

Include files

<wx/valtext.h>

See also

Validator overview, wxValidator, wxGenericValidator



wxTextValidator::wxTextValidator



wxTextValidator(const wxTextValidator& validator)

Copy constructor.



wxTextValidator(long style = wxFILTER_NONE, wxString* valPtr = NULL)

Constructor, taking a style and optional pointer to a wxString variable.

Parameters

style
A bitlist of flags, which can be:

wxFILTER_NONE No filtering takes place.
wxFILTER_ASCII Non-ASCII characters are filtered out.
wxFILTER_ALPHA Non-alpha characters are filtered out.
wxFILTER_ALPHANUMERIC Non-alphanumeric characters are filtered out.
wxFILTER_NUMERIC Non-numeric characters are filtered out.
wxFILTER_INCLUDE_LIST Use an include list. The validator checks if the user input is on the list, complaining if not. See wxTextValidator::SetIncludes.
wxFILTER_EXCLUDE_LIST Use an exclude list. The validator checks if the user input is on the list, complaining if it is. See wxTextValidator::SetExcludes.
wxFILTER_INCLUDE_CHAR_LIST Use an include list. The validator checks if each input character is in the list (one character per list element), complaining if not. See wxTextValidator::SetIncludes.
wxFILTER_EXCLUDE_CHAR_LIST Use an include list. The validator checks if each input character is in the list (one character per list element), complaining if it is. See wxTextValidator::SetExcludes.

valPtr
A pointer to a wxString variable that contains the value. This variable should have a lifetime equal to or longer than the validator lifetime (which is usually determined by the lifetime of the window).



wxTextValidator::Clone

virtual wxValidator* Clone(void) const

Clones the text validator using the copy constructor.



wxTextValidator::GetExcludes

wxArrayString& GetExcludes(void) const

Returns a reference to the exclude list (the list of invalid values).



wxTextValidator::GetIncludes

wxArrayString& GetIncludes(void) const

Returns a reference to the include list (the list of valid values).



wxTextValidator::GetStyle

long GetStyle(void) const

Returns the validator style.



wxTextValidator::OnChar



void OnChar(wxKeyEvent& event)

Receives character input from the window and filters it according to the current validator style.



wxTextValidator::SetExcludes



void SetExcludes(const wxArrayString& stringList)

Sets the exclude list (invalid values for the user input).



wxTextValidator::SetIncludes



void SetIncludes(const wxArrayString& stringList)

Sets the include list (valid values for the user input).



wxTextValidator::SetStyle



void SetStyle(long style)

Sets the validator style.



wxTextValidator::TransferFromWindow



virtual bool TransferFromWindow()

Transfers the value in the text control to the string.



wxTextValidator::TransferToWindow



virtual bool TransferToWindow()

Transfers the string value to the text control.



wxTextValidator::Validate



virtual bool Validate(wxWindow* parent)

Validates the window contents against the include or exclude lists, depending on the validator style.

ymasuda 平成17年11月19日