// Name: valgen.h
// Purpose: interface of wxGenericValidator
// Author: wxWidgets team
-// RCS-ID: $Id$
-// Licence: wxWindows license
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
/**
@class wxGenericValidator
wxGenericValidator performs data transfer (but not validation or filtering)
- for the following basic controls: wxButton, wxCheckBox, wxListBox,
- wxStaticText, wxRadioButton, wxRadioBox, wxChoice, wxComboBox, wxGauge,
- wxSlider, wxScrollBar, wxSpinButton, wxTextCtrl, wxCheckListBox.
+ for many type of controls.
- It checks the type of the window and uses an appropriate type for that
- window. For example, wxButton and wxTextCtrl transfer data to and from a
- wxString variable; wxListBox uses a wxArrayInt; wxCheckBox uses a bool.
+ 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
+ @see @ref overview_validator, wxValidator, wxTextValidator,
+ wxIntegerValidator, wxFloatingPointValidator
*/
class wxGenericValidator : public wxValidator
{
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.