Document wxBK_HITTEST_XXX values.

[wxWidgets.git] / interface / wx / valgen.h

diff --git a/interface/wx/valgen.h b/interface/wx/valgen.h
index 00ebc56fd421e8219501ccd5decd88a213969aa1..2a5f025d7748762b0326bad67f062d7ee5e3ff2c 100644 (file)
--- a/interface/wx/valgen.h
+++ b/interface/wx/valgen.h
@@ -3,28 +3,32 @@
 // Purpose:     interface of wxGenericValidator
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 /**
     @class wxGenericValidator
-    @wxheader{valgen.h}
 
     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
 {
@@ -92,16 +96,52 @@ public:
             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.
     */
-    ~wxGenericValidator();
+    virtual ~wxGenericValidator();
 
     /**
         Clones the generic validator using the copy constructor.
     */
-    virtual wxValidator* Clone() const;
+    virtual wxObject* Clone() const;
 
     /**
         Transfers the value from the window to the appropriate data type.