]>
Commit | Line | Data |
---|---|---|
89c684ef JS |
1 | \section{\class{wxGenericValidator}}\label{wxgenericvalidator} |
2 | ||
3 | wxGenericValidator performs data transfer (but not validation or filtering) for the following | |
4 | basic controls: wxButton, wxCheckBox, wxListBox, wxStaticText, wxRadioButton, wxRadioBox, | |
5 | wxChoice, wxComboBox, wxGauge, wxSlider, wxScrollBar, wxSpinButton, wxTextCtrl, wxCheckListBox. | |
6 | ||
7 | It checks the type of the window and uses an appropriate type for that window. For example, | |
8 | wxButton and wxTextCtrl transfer data to and from a wxString variable; wxListBox uses a | |
9 | wxArrayInt; wxCheckBox uses a bool. | |
10 | ||
11 | For 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{See also} | |
20 | ||
21 | \helpref{Validator overview}{validatoroverview}, \helpref{wxValidator}{wxvalidator}, | |
22 | \helpref{wxTextValidator}{wxTextvalidator} | |
23 | ||
24 | \latexignore{\rtfignore{\wxheading{Members}}} | |
25 | ||
26 | \membersection{wxGenericValidator::wxGenericValidator}\label{wxgenericvalidatorconstr} | |
27 | ||
28 | \func{}{wxGenericValidator}{\param{const wxGenericValidator\&}{ validator}} | |
29 | ||
30 | Copy constructor. | |
31 | ||
32 | \func{}{wxGenericValidator}{\param{bool*}{ valPtr}} | |
33 | ||
34 | Constructor taking a bool pointer. This will be used for wxCheckBox and wxRadioButton. | |
35 | ||
36 | \func{}{wxGenericValidator}{\param{wxString*}{ valPtr}} | |
37 | ||
38 | Constructor taking a wxString pointer. This will be used for wxButton, wxComboBox, wxStaticText, | |
39 | wxTextCtrl. | |
40 | ||
41 | \func{}{wxGenericValidator}{\param{int*}{ valPtr}} | |
42 | ||
43 | Constructor taking an integer pointer. This will be used for wxGauge, wxScrollBar, wxRadioBox, wxSpinButton, | |
44 | wxChoice. | |
45 | ||
46 | \func{}{wxGenericValidator}{\param{wxArrayInt*}{ valPtr}} | |
47 | ||
48 | Constructor taking a wxArrayInt pointer. This will be used for wxListBox, wxCheckListBox. | |
49 | ||
50 | \wxheading{Parameters} | |
51 | ||
52 | \docparam{validator}{Validator to copy.} | |
53 | ||
54 | \docparam{valPtr}{A pointer to a variable that contains the value. This variable | |
55 | should have a lifetime equal to or longer than the validator lifetime (which is usually | |
56 | determined by the lifetime of the window).} | |
57 | ||
58 | \membersection{wxGenericValidator::\destruct{wxGenericValidator}} | |
59 | ||
60 | \func{}{\destruct{wxGenericValidator}}{\void} | |
61 | ||
62 | Destructor. | |
63 | ||
64 | \membersection{wxGenericValidator::Clone}\label{wxgenericvalidatorclone} | |
65 | ||
66 | \constfunc{virtual wxValidator*}{Clone}{\void} | |
67 | ||
68 | Clones the generic validator using the copy constructor. | |
69 | ||
70 | \membersection{wxGenericValidator::TransferFromWindow}\label{wxgenericvalidatortransferfromwindow} | |
71 | ||
72 | \func{virtual bool}{TransferToWindow}{\param{wxWindow*}{ parent}} | |
73 | ||
74 | Transfers the value to the window. | |
75 | ||
76 | \membersection{wxGenericValidator::TransferToWindow}\label{wxgenericvalidatortransfertowindow} | |
77 | ||
78 | \func{virtual bool}{TransferToWindow}{\param{wxWindow*}{ parent}} | |
79 | ||
80 | Transfers the window value to the appropriate data type. | |
81 |