]> git.saurik.com Git - wxWidgets.git/blame_incremental - docs/latex/wx/valgen.tex
Fixed a couple spelling typos
[wxWidgets.git] / docs / latex / wx / valgen.tex
... / ...
CommitLineData
1\section{\class{wxGenericValidator}}\label{wxgenericvalidator}
2
3wxGenericValidator performs data transfer (but not validation or filtering) for the following
4basic controls: wxButton, wxCheckBox, wxListBox, wxStaticText, wxRadioButton, wxRadioBox,
5wxChoice, wxComboBox, wxGauge, wxSlider, wxScrollBar, wxSpinButton, wxTextCtrl, wxCheckListBox.
6
7It checks the type of the window and uses an appropriate type for that window. For example,
8wxButton and wxTextCtrl transfer data to and from a wxString variable; wxListBox uses a
9wxArrayInt; wxCheckBox uses a bool.
10
11For more information, please see \helpref{Validator overview}{validatoroverview}.
12
13\wxheading{Derived from}
14
15\helpref{wxValidator}{wxvalidator}\\
16\helpref{wxEvtHandler}{wxevthandler}\\
17\helpref{wxObject}{wxobject}
18
19\wxheading{Include files}
20
21<wx/valgen.h>
22
23\wxheading{See also}
24
25\helpref{Validator overview}{validatoroverview}, \helpref{wxValidator}{wxvalidator},
26\helpref{wxTextValidator}{wxtextvalidator}
27
28\latexignore{\rtfignore{\wxheading{Members}}}
29
30\membersection{wxGenericValidator::wxGenericValidator}\label{wxgenericvalidatorconstr}
31
32\func{}{wxGenericValidator}{\param{const wxGenericValidator\&}{ validator}}
33
34Copy constructor.
35
36\func{}{wxGenericValidator}{\param{bool*}{ valPtr}}
37
38Constructor taking a bool pointer. This will be used for wxCheckBox and wxRadioButton.
39
40\func{}{wxGenericValidator}{\param{wxString*}{ valPtr}}
41
42Constructor taking a wxString pointer. This will be used for wxButton, wxComboBox, wxStaticText,
43wxTextCtrl.
44
45\func{}{wxGenericValidator}{\param{int*}{ valPtr}}
46
47Constructor taking an integer pointer. This will be used for wxGauge, wxScrollBar, wxRadioBox, wxSpinButton,
48wxChoice.
49
50\func{}{wxGenericValidator}{\param{wxArrayInt*}{ valPtr}}
51
52Constructor taking a wxArrayInt pointer. This will be used for wxListBox, wxCheckListBox.
53
54\wxheading{Parameters}
55
56\docparam{validator}{Validator to copy.}
57
58\docparam{valPtr}{A pointer to a variable that contains the value. This variable
59should have a lifetime equal to or longer than the validator lifetime (which is usually
60determined by the lifetime of the window).}
61
62\membersection{wxGenericValidator::\destruct{wxGenericValidator}}
63
64\func{}{\destruct{wxGenericValidator}}{\void}
65
66Destructor.
67
68\membersection{wxGenericValidator::Clone}\label{wxgenericvalidatorclone}
69
70\constfunc{virtual wxValidator*}{Clone}{\void}
71
72Clones the generic validator using the copy constructor.
73
74\membersection{wxGenericValidator::TransferFromWindow}\label{wxgenericvalidatortransferfromwindow}
75
76\func{virtual bool}{TransferToWindow}{}
77
78Transfers the value to the window.
79
80\membersection{wxGenericValidator::TransferToWindow}\label{wxgenericvalidatortransfertowindow}
81
82\func{virtual bool}{TransferToWindow}{}
83
84Transfers the window value to the appropriate data type.
85