projects / wxWidgets.git / blame
| 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 | ||
| 954b8ae6 JS |
19 | \wxheading{Include files} |
| 20 | ||
| 21 | <wx/valgen.h> | |
| 22 | ||
| 89c684ef JS |
23 | \wxheading{See also} |
| 24 | ||
| 76e1c2de | 25 | \helpref{Validator overview}{validatoroverview}, \helpref{wxValidator}{wxvalidator}, |
| 8bb8ab39 | 26 | \helpref{wxTextValidator}{wxtextvalidator} |
| 89c684ef JS |
27 | |
| 28 | \latexignore{\rtfignore{\wxheading{Members}}} | |
| 29 | ||
| f0e8a2d0 | 30 | \membersection{wxGenericValidator::wxGenericValidator}\label{wxgenericvalidatorctor} |
| 89c684ef JS |
31 | |
| 32 | \func{}{wxGenericValidator}{\param{const wxGenericValidator\&}{ validator}} | |
| 33 | ||
| 34 | Copy constructor. | |
| 35 | ||
| 36 | \func{}{wxGenericValidator}{\param{bool*}{ valPtr}} | |
| 37 | ||
| 38 | Constructor taking a bool pointer. This will be used for wxCheckBox and wxRadioButton. | |
| 39 | ||
| 40 | \func{}{wxGenericValidator}{\param{wxString*}{ valPtr}} | |
| 41 | ||
| 42 | Constructor taking a wxString pointer. This will be used for wxButton, wxComboBox, wxStaticText, | |
| 43 | wxTextCtrl. | |
| 44 | ||
| 45 | \func{}{wxGenericValidator}{\param{int*}{ valPtr}} | |
| 46 | ||
| 47 | Constructor taking an integer pointer. This will be used for wxGauge, wxScrollBar, wxRadioBox, wxSpinButton, | |
| 48 | wxChoice. | |
| 49 | ||
| 50 | \func{}{wxGenericValidator}{\param{wxArrayInt*}{ valPtr}} | |
| 51 | ||
| 52 | Constructor 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 | |
| 59 | should have a lifetime equal to or longer than the validator lifetime (which is usually | |
| 60 | determined by the lifetime of the window).} | |
| 61 | ||
| f0e8a2d0 | 62 | \membersection{wxGenericValidator::\destruct{wxGenericValidator}}\label{wxgenericvalidatordtor} |
| 89c684ef JS |
63 | |
| 64 | \func{}{\destruct{wxGenericValidator}}{\void} | |
| 65 | ||
| 66 | Destructor. | |
| 67 | ||
| 68 | \membersection{wxGenericValidator::Clone}\label{wxgenericvalidatorclone} | |
| 69 | ||
| 70 | \constfunc{virtual wxValidator*}{Clone}{\void} | |
| 71 | ||
| 72 | Clones the generic validator using the copy constructor. | |
| 73 | ||
| 74 | \membersection{wxGenericValidator::TransferFromWindow}\label{wxgenericvalidatortransferfromwindow} | |
| 75 | ||
| 384c9653 | 76 | \func{virtual bool}{TransferFromWindow}{} |
| 89c684ef | 77 | |
| 384c9653 | 78 | Transfers the value from the window to the appropriate data type. |
| 89c684ef JS |
79 | |
| 80 | \membersection{wxGenericValidator::TransferToWindow}\label{wxgenericvalidatortransfertowindow} | |
| 81 | ||
| 76e1c2de | 82 | \func{virtual bool}{TransferToWindow}{} |
| 89c684ef | 83 | |
| 384c9653 | 84 | Transfers the value to the window. |
| 89c684ef | 85 |