1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: interface of wxValidator
4 // Author: wxWidgets team
6 // Licence: wxWindows license
7 /////////////////////////////////////////////////////////////////////////////
13 wxValidator is the base class for a family of validator classes that
14 mediate between a class of control, and application data.
16 A validator has three major roles:
18 -# To transfer data from a C++ variable or own storage to and from a
20 -# To validate data in a control, and show an appropriate error message.
21 -# To filter events (such as keystrokes), thereby changing the behaviour
22 of the associated control.
24 Validators can be plugged into controls dynamically.
26 To specify a default, "null" validator, use ::wxDefaultValidator.
28 For more information, please see @ref overview_validator.
31 If you wish to create a validator class in wxPython you should derive the
32 class from @c wxPyValidator in order to get Python-aware capabilities for
33 the various virtual methods.
42 @see @ref overview_validator, wxTextValidator, wxGenericValidator
44 class wxValidator
: public wxEvtHandler
58 All validator classes must implement the Clone() function, which
59 returns an identical copy of itself.
61 This is because validators are passed to control constructors as
62 references which must be copied. Unlike objects such as pens and
63 brushes, it does not make sense to have a reference counting scheme to
64 do this cloning because all validators should have separate data.
66 @returns This base function returns @NULL.
68 virtual wxObject
* Clone() const;
71 Returns the window associated with the validator.
73 wxWindow
* GetWindow() const;
76 This functions switches on or turns off the error sound produced by the
77 validators if an invalid key is pressed.
79 void SetBellOnError(bool doIt
= true);
82 Associates a window with the validator.
84 void SetWindow(wxWindow
* window
);
87 This overridable function is called when the value in the window must
88 be transferred to the validator.
90 @return @false if there is a problem.
92 virtual bool TransferFromWindow();
95 This overridable function is called when the value associated with the
96 validator must be transferred to the window.
98 @return @false if there is a problem.
100 virtual bool TransferToWindow();
103 This overridable function is called when the value in the associated
104 window must be validated.
106 @return @false if the value in the window is not valid; you may pop up
109 virtual bool Validate(wxWindow
* parent
);
113 An empty, "null" wxValidator instance.
115 wxValidator wxDefaultValidator
;