]> git.saurik.com Git - wxWidgets.git/blame_incremental - docs/latex/wx/valgen.tex
fixed doc wrong position of \wxheading{Library}
[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{Library}
24
25\helpref{wxCore}{librarieslist}
26
27\wxheading{See also}
28
29\helpref{Validator overview}{validatoroverview}, \helpref{wxValidator}{wxvalidator},
30\helpref{wxTextValidator}{wxtextvalidator}
31
32\latexignore{\rtfignore{\wxheading{Members}}}
33
34\membersection{wxGenericValidator::wxGenericValidator}\label{wxgenericvalidatorctor}
35
36\func{}{wxGenericValidator}{\param{const wxGenericValidator\&}{ validator}}
37
38Copy constructor.
39
40\func{}{wxGenericValidator}{\param{bool*}{ valPtr}}
41
42Constructor taking a bool pointer. This will be used for wxCheckBox and wxRadioButton.
43
44\func{}{wxGenericValidator}{\param{wxString*}{ valPtr}}
45
46Constructor taking a wxString pointer. This will be used for wxButton, wxComboBox, wxStaticText,
47wxTextCtrl.
48
49\func{}{wxGenericValidator}{\param{int*}{ valPtr}}
50
51Constructor taking an integer pointer. This will be used for wxGauge, wxScrollBar, wxRadioBox, wxSpinButton,
52wxChoice.
53
54\func{}{wxGenericValidator}{\param{wxArrayInt*}{ valPtr}}
55
56Constructor taking a wxArrayInt pointer. This will be used for wxListBox, wxCheckListBox.
57
58\wxheading{Parameters}
59
60\docparam{validator}{Validator to copy.}
61
62\docparam{valPtr}{A pointer to a variable that contains the value. This variable
63should have a lifetime equal to or longer than the validator lifetime (which is usually
64determined by the lifetime of the window).}
65
66\membersection{wxGenericValidator::\destruct{wxGenericValidator}}\label{wxgenericvalidatordtor}
67
68\func{}{\destruct{wxGenericValidator}}{\void}
69
70Destructor.
71
72\membersection{wxGenericValidator::Clone}\label{wxgenericvalidatorclone}
73
74\constfunc{virtual wxValidator*}{Clone}{\void}
75
76Clones the generic validator using the copy constructor.
77
78\membersection{wxGenericValidator::TransferFromWindow}\label{wxgenericvalidatortransferfromwindow}
79
80\func{virtual bool}{TransferFromWindow}{}
81
82Transfers the value from the window to the appropriate data type.
83
84\membersection{wxGenericValidator::TransferToWindow}\label{wxgenericvalidatortransfertowindow}
85
86\func{virtual bool}{TransferToWindow}{}
87
88Transfers the value to the window.
89