wxValidator Class Reference
[Validators]
#include <wx/validate.h>
Detailed Description
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:
- To transfer data from a C++ variable or own storage to and from a control.
- To validate data in a control, and show an appropriate error message.
- 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 wxDefaultValidator.
For more information, please see wxValidator 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.
Predefined objects/pointers: wxDefaultValidator
Public Member Functions | |
| wxValidator () | |
| virtual | ~wxValidator () |
| virtual wxObject * | Clone () const |
| wxWindow * | GetWindow () const |
| void | SetWindow (wxWindow *window) |
| virtual bool | TransferFromWindow () |
| virtual bool | TransferToWindow () |
| virtual bool | Validate (wxWindow *parent) |
Static Public Member Functions | |
| static void | SetBellOnError (bool doIt=true) |
Constructor & Destructor Documentation
| wxValidator::wxValidator | ( | ) |
Constructor.
| virtual wxValidator::~wxValidator | ( | ) | [virtual] |
Destructor.
Member Function Documentation
| virtual wxObject* wxValidator::Clone | ( | ) | const [virtual] |
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.
- Returns:
- This base function returns NULL.
Reimplemented in wxGenericValidator, and wxTextValidator.
| wxWindow* wxValidator::GetWindow | ( | ) | const |
Returns the window associated with the validator.
| static void wxValidator::SetBellOnError | ( | bool | doIt = true |
) | [static] |
This functions switches on or turns off the error sound produced by the validators if an invalid key is pressed.
| void wxValidator::SetWindow | ( | wxWindow * | window | ) |
Associates a window with the validator.
| virtual bool wxValidator::TransferFromWindow | ( | ) | [virtual] |
This overridable function is called when the value in the window must be transferred to the validator.
- Returns:
- false if there is a problem.
Reimplemented in wxGenericValidator, and wxTextValidator.
| virtual bool wxValidator::TransferToWindow | ( | ) | [virtual] |
This overridable function is called when the value associated with the validator must be transferred to the window.
- Returns:
- false if there is a problem.
Reimplemented in wxGenericValidator, and wxTextValidator.
| virtual bool wxValidator::Validate | ( | wxWindow * | parent | ) | [virtual] |
This overridable function is called when the value in the associated window must be validated.
- Returns:
- false if the value in the window is not valid; you may pop up an error dialog.
Reimplemented in wxTextValidator.
