wxValidator

wxValidator is the base class for a family of validator classes that mediate between a class of control, and application data.

A validator has three major roles:

1. to transfer data from a C++ variable or own storage to and from a control;
2. to validate data in a control, and show an appropriate error message;
3. to filter events (such as keystrokes), thereby changing the behaviour of the associated control.

Validators can be plugged into controls dynamically.

To specify a default, 'null' validator, use the symbol wxDefaultValidator.

For more information, please see Validator overview.

wxPython note: If you wish to create a validator class in wxPython you should derive the class from wxPyValidator in order to get Python-aware capabilities for the various virtual methods.

Derived from

wxEvtHandler
wxObject

Include files

<wx/validate.h>

See also

Validator overview, wxTextValidator, wxGenericValidator,

Members

wxValidator::wxValidator
wxValidator::~wxValidator
wxValidator::Clone
wxValidator::GetWindow
wxValidator::SetBellOnError
wxValidator::SetWindow
wxValidator::TransferFromWindow
wxValidator::TransferToWindow
wxValidator::Validate

wxValidator::wxValidator

wxValidator()

Constructor.

wxValidator::~wxValidator

~wxValidator()

Destructor.

wxValidator::Clone

virtual wxObject* Clone() const

All validator classes must implement the Clone function, which returns an identical copy of itself. This is because validators are passed to control constructors as references which must be copied. Unlike objects such as pens and brushes, it does not make sense to have a reference counting scheme to do this cloning, because all validators should have separate data.

This base function returns NULL.

wxValidator::GetWindow

wxWindow* GetWindow() const

Returns the window associated with the validator.

wxValidator::SetBellOnError

void SetBellOnError(bool doIt = true)

This functions switches on or turns off the error sound produced by the validators if an invalid key is pressed.

wxValidator::SetWindow

void SetWindow(wxWindow* window)

Associates a window with the validator.

wxValidator::TransferFromWindow

virtual bool TransferToWindow()

This overridable function is called when the value in the window must be transferred to the validator. Return false if there is a problem.

wxValidator::TransferToWindow

virtual bool TransferToWindow()

This overridable function is called when the value associated with the validator must be transferred to the window. Return false if there is a problem.

wxValidator::Validate

virtual bool Validate(wxWindow* parent)

This overridable function is called when the value in the associated window must be validated. Return false if the value in the window is not valid; you may pop up an error dialog.