]>
git.saurik.com Git - wxWidgets.git/blob - interface/wx/valgen.h
1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: interface of wxGenericValidator
4 // Author: wxWidgets team
6 // Licence: wxWindows licence
7 /////////////////////////////////////////////////////////////////////////////
10 @class wxGenericValidator
12 wxGenericValidator performs data transfer (but not validation or filtering)
13 for many type of controls.
15 wxGenericValidator supports:
16 - wxButton, wxRadioButton, wxToggleButton, wxBitmapToggleButton, wxSpinButton
17 - wxCheckBox, wxRadioBox, wxComboBox, wxListBox, wxCheckListBox
18 - wxGauge, wxSlider, wxScrollBar, wxChoice, wxStaticText
19 - wxSpinCtrl, wxTextCtrl
21 It checks the type of the window and uses an appropriate type for it.
22 For example, wxButton and wxTextCtrl transfer data to and from a
23 wxString variable; wxListBox uses a wxArrayInt; wxCheckBox uses a boolean.
25 For more information, please see @ref overview_validator.
30 @see @ref overview_validator, wxValidator, wxTextValidator
32 class wxGenericValidator
: public wxValidator
41 wxGenericValidator(const wxGenericValidator
& validator
);
43 Constructor taking a bool pointer. This will be used for wxCheckBox,
44 wxRadioButton, wxToggleButton and wxBitmapToggleButton.
47 A pointer to a variable that contains the value. This variable
48 should have a lifetime equal to or longer than the validator
49 lifetime (which is usually determined by the lifetime of the
52 wxGenericValidator(bool* valPtr
);
54 Constructor taking a wxString pointer. This will be used for wxButton,
55 wxComboBox, wxStaticText, wxTextCtrl.
58 A pointer to a variable that contains the value. This variable
59 should have a lifetime equal to or longer than the validator
60 lifetime (which is usually determined by the lifetime of the
63 wxGenericValidator(wxString
* valPtr
);
65 Constructor taking an integer pointer. This will be used for wxChoice,
66 wxGauge, wxScrollBar, wxRadioBox, wxSlider, wxSpinButton and
70 A pointer to a variable that contains the value. This variable
71 should have a lifetime equal to or longer than the validator
72 lifetime (which is usually determined by the lifetime of the
75 wxGenericValidator(int* valPtr
);
77 Constructor taking a wxArrayInt pointer. This will be used for
78 wxListBox, wxCheckListBox.
81 A pointer to a variable that contains the value. This variable
82 should have a lifetime equal to or longer than the validator
83 lifetime (which is usually determined by the lifetime of the
86 wxGenericValidator(wxArrayInt
* valPtr
);
88 Constructor taking a wxDateTime pointer. This will be used for
92 A pointer to a variable that contains the value. This variable
93 should have a lifetime equal to or longer than the validator
94 lifetime (which is usually determined by the lifetime of the
97 wxGenericValidator(wxDateTime
* valPtr
);
102 virtual ~wxGenericValidator();
105 Clones the generic validator using the copy constructor.
107 virtual wxObject
* Clone() const;
110 Transfers the value from the window to the appropriate data type.
112 virtual bool TransferFromWindow();
115 Transfers the value to the window.
117 virtual bool TransferToWindow();