1\section{\class{wxValidator}}\label{wxvalidator}
2
3wxValidator is the base class for a family of validator classes that mediate
4between a class of control, and application data.
5
6A validator has three major roles:
7
8\begin{enumerate}\itemsep=0pt
9\item to transfer data from a C++ variable or own storage to and from a control;
10\item to validate data in a control, and show an appropriate error message;
11\item to filter events (such as keystrokes), thereby changing the behaviour of the
12associated control.
13\end{enumerate}
14
15Validators can be plugged into controls dynamically.
16
17To specify a default, `null' validator, use the symbol {\bf wxDefaultValidator}.
18
19For more information, please see \helpref{Validator overview}{validatoroverview}.
20
21\pythonnote{If you wish to create a validator class in wxPython you should
22derive the class from {\tt wxPyValidator} in order to get Python-aware
23capabilities for the various virtual methods.}
24
25\wxheading{Derived from}
26
27\helpref{wxEvtHandler}{wxevthandler}\\
28\helpref{wxObject}{wxobject}
29
30\wxheading{Include files}
31
32<wx/validate.h>
33
34\wxheading{See also}
35
36\helpref{Validator overview}{validatoroverview}, 
37\helpref{wxTextValidator}{wxtextvalidator}, 
38\helpref{wxGenericValidator}{wxgenericvalidator},
39
40\latexignore{\rtfignore{\wxheading{Members}}}
41
42\membersection{wxValidator::wxValidator}\label{wxvalidatorctor}
43
44\func{}{wxValidator}{\void}
45
46Constructor.
47
48\membersection{wxValidator::\destruct{wxValidator}}\label{wxvalidatordtor}
49
50\func{}{\destruct{wxValidator}}{\void}
51
52Destructor.
53
54\membersection{wxValidator::Clone}\label{wxvalidatorclone}
55
56\constfunc{virtual wxObject*}{Clone}{\void}
57
58All validator classes must implement the {\bf Clone} function, which returns
59an identical copy of itself. This is because validators are passed to control
60constructors as references which must be copied. Unlike objects such as pens
61and brushes, it does not make sense to have a reference counting scheme
62to do this cloning, because all validators should have separate
63data.
64
65This base function returns NULL.
66
67\membersection{wxValidator::GetWindow}\label{wxvalidatorgetwindow}
68
69\constfunc{wxWindow*}{GetWindow}{\void}
70
71Returns the window associated with the validator.
72
73\membersection{wxValidator::SetBellOnError}\label{wxvalidatorsetbellonerror}
74
75\func{void}{SetBellOnError}{\param{bool}{ doIt = true}}
76
77This functions switches on or turns off the error sound produced by the
78validators if an invalid key is pressed.
79
80\membersection{wxValidator::SetWindow}\label{wxvalidatorsetwindow}
81
82\func{void}{SetWindow}{\param{wxWindow*}{ window}}
83
84Associates a window with the validator.
85
86\membersection{wxValidator::TransferFromWindow}\label{wxvalidatortransferfromwindow}
87
88\func{virtual bool}{TransferToWindow}{}
89
90This overridable function is called when the value in the window must be
91transferred to the validator. Return false if there is a problem.
92
93\membersection{wxValidator::TransferToWindow}\label{wxvalidatortransfertowindow}
94
95\func{virtual bool}{TransferToWindow}{}
96
97This overridable function is called when the value associated with the validator must be
98transferred to the window. Return false if there is a problem.
99
100\membersection{wxValidator::Validate}\label{wxvalidatorvalidate}
101
102\func{virtual bool}{Validate}{\param{wxWindow*}{ parent}}
103
104This overridable function is called when the value in the associated window must be validated.
105Return false if the value in the window is not valid; you may pop up an error dialog.
106
107