Make storing non-trivial data in wxThreadSpecificInfo possible.

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

diff --git a/interface/wx/validate.h b/interface/wx/validate.h
index 5ef578fb587f62dd3bd345568085203e3506539e..5a1c4e81d9773e470537bf65c4c9fe22db3301af 100644 (file)
--- a/interface/wx/validate.h
+++ b/interface/wx/validate.h
@@ -2,8 +2,7 @@
 // Name:        validate.h
 // Purpose:     interface of wxValidator
 // Author:      wxWidgets team
 // Name:        validate.h
 // Purpose:     interface of wxValidator
 // Author:      wxWidgets team

-// RCS-ID:      $Id$
-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /**
 /////////////////////////////////////////////////////////////////////////////
 
 /**


@@ -26,19 +25,14 @@
 
     For more information, please see @ref overview_validator.
 
 
     For more information, please see @ref overview_validator.
 

-    @beginWxPythonOnly
-    If you wish to create a validator class in wxPython you should derive the
-    class from @c wxPyValidator in order to get Python-aware capabilities for
-    the various virtual methods.
-    @endWxPythonOnly
-

     @library{wxcore}
     @category{validator}
 
     @stdobjects
     ::wxDefaultValidator
 
     @library{wxcore}
     @category{validator}
 
     @stdobjects
     ::wxDefaultValidator
 

-    @see @ref overview_validator, wxTextValidator, wxGenericValidator
+    @see @ref overview_validator, wxTextValidator, wxGenericValidator,
+        wxIntegerValidator, wxFloatingPointValidator

 */
 class wxValidator : public wxEvtHandler
 {
 */
 class wxValidator : public wxEvtHandler
 {


@@ -74,11 +68,33 @@ public:
     /**
         This functions switches on or turns off the error sound produced by the
         validators if an invalid key is pressed.
     /**
         This functions switches on or turns off the error sound produced by the
         validators if an invalid key is pressed.

+
+        @since 2.9.1
+
+        @param suppress
+            If @true, error sound is not played when a validator detects an
+            error. If @false, error sound is enabled.

     */
     */

-    static void SetBellOnError(bool doIt = true);
+    static void SuppressBellOnError(bool suppress = true);

 
 

+    /**
+       Returns if the error sound is currently disabled.
+    */
+    static bool IsSilent();
+    

     /**
         Associates a window with the validator.
     /**
         Associates a window with the validator.

+
+        This function is automatically called by wxWidgets when creating a wxWindow-derived
+        class instance which takes a wxValidator reference.
+
+        E.g.
+        @code
+        new wxTextCtrl(this, wxID_ANY, wxEmptyString, wxDefaultPosition, wxDefaultSize, 0,
+                       wxTextValidator(wxFILTER_ALPHA, &g_data.m_string));
+        @endcode
+        will automatically link the wxTextValidator instance with the wxTextCtrl
+        instance.

     */
     void SetWindow(wxWindow* window);
 
     */
     void SetWindow(wxWindow* window);
 


@@ -102,6 +118,9 @@ public:
         This overridable function is called when the value in the associated
         window must be validated.
 
         This overridable function is called when the value in the associated
         window must be validated.
 

+        @param parent
+            The parent of the window associated with the validator.
+

         @return @false if the value in the window is not valid; you may pop up
                 an error dialog.
     */
         @return @false if the value in the window is not valid; you may pop up
                 an error dialog.
     */


@@ -111,5 +130,5 @@ public:
 /**
     An empty, "null" wxValidator instance.
 */
 /**
     An empty, "null" wxValidator instance.
 */

-wxValidator wxDefaultValidator;
+const wxValidator wxDefaultValidator;