1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155
|
/////////////////////////////////////////////////////////////////////////////
// Name: valgen.h
// Purpose: interface of wxGenericValidator
// Author: wxWidgets team
// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
/**
@class wxGenericValidator
wxGenericValidator performs data transfer (but not validation or filtering)
for many type of controls.
wxGenericValidator supports:
- wxButton, wxRadioButton, wxToggleButton, wxBitmapToggleButton, wxSpinButton
- wxCheckBox, wxRadioBox, wxComboBox, wxListBox, wxCheckListBox
- wxGauge, wxSlider, wxScrollBar, wxChoice, wxStaticText
- wxSpinCtrl, wxTextCtrl
It checks the type of the window and uses an appropriate type for it.
For example, wxButton and wxTextCtrl transfer data to and from a
wxString variable; wxListBox uses a wxArrayInt; wxCheckBox uses a boolean.
For more information, please see @ref overview_validator.
@library{wxcore}
@category{validator}
@see @ref overview_validator, wxValidator, wxTextValidator,
wxIntegerValidator, wxFloatingPointValidator
*/
class wxGenericValidator : public wxValidator
{
public:
/**
Copy constructor.
@param validator
Validator to copy.
*/
wxGenericValidator(const wxGenericValidator& validator);
/**
Constructor taking a bool pointer. This will be used for wxCheckBox,
wxRadioButton, wxToggleButton and wxBitmapToggleButton.
@param valPtr
A pointer to a variable that contains the value. This variable
should have a lifetime equal to or longer than the validator
lifetime (which is usually determined by the lifetime of the
window).
*/
wxGenericValidator(bool* valPtr);
/**
Constructor taking a wxString pointer. This will be used for wxButton,
wxComboBox, wxStaticText, wxTextCtrl.
@param valPtr
A pointer to a variable that contains the value. This variable
should have a lifetime equal to or longer than the validator
lifetime (which is usually determined by the lifetime of the
window).
*/
wxGenericValidator(wxString* valPtr);
/**
Constructor taking an integer pointer. This will be used for wxChoice,
wxGauge, wxScrollBar, wxRadioBox, wxSlider, wxSpinButton and
wxSpinCtrl.
@param valPtr
A pointer to a variable that contains the value. This variable
should have a lifetime equal to or longer than the validator
lifetime (which is usually determined by the lifetime of the
window).
*/
wxGenericValidator(int* valPtr);
/**
Constructor taking a wxArrayInt pointer. This will be used for
wxListBox, wxCheckListBox.
@param valPtr
A pointer to a variable that contains the value. This variable
should have a lifetime equal to or longer than the validator
lifetime (which is usually determined by the lifetime of the
window).
*/
wxGenericValidator(wxArrayInt* valPtr);
/**
Constructor taking a wxDateTime pointer. This will be used for
wxDatePickerCtrl.
@param valPtr
A pointer to a variable that contains the value. This variable
should have a lifetime equal to or longer than the validator
lifetime (which is usually determined by the lifetime of the
window).
*/
wxGenericValidator(wxDateTime* valPtr);
/**
Constructor taking a wxFileName pointer. This will be used for
wxTextCtrl.
@param valPtr
A pointer to a variable that contains the value. This variable
should have a lifetime equal to or longer than the validator
lifetime (which is usually determined by the lifetime of the
window).
@since 2.9.3
*/
wxGenericValidator(wxFileName* valPtr);
/**
Constructor taking a float pointer. This will be used for
wxTextCtrl.
@param valPtr
A pointer to a variable that contains the value. This variable
should have a lifetime equal to or longer than the validator
lifetime (which is usually determined by the lifetime of the
window).
@since 2.9.3
*/
wxGenericValidator(float* valPtr);
/**
Constructor taking a double pointer. This will be used for
wxTextCtrl.
@param valPtr
A pointer to a variable that contains the value. This variable
should have a lifetime equal to or longer than the validator
lifetime (which is usually determined by the lifetime of the
window).
@since 2.9.3
*/
wxGenericValidator(double* valPtr);
/**
Destructor.
*/
virtual ~wxGenericValidator();
/**
Clones the generic validator using the copy constructor.
*/
virtual wxObject* Clone() const;
/**
Transfers the value from the window to the appropriate data type.
*/
virtual bool TransferFromWindow();
/**
Transfers the value to the window.
*/
virtual bool TransferToWindow();
};
|