Remove wrong const from wxMenu::GetMenuItems() documentation.

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

diff --git a/interface/wx/validate.h b/interface/wx/validate.h
index 76f4abd83589089c768c81f351d23f6ae4039b4e..fcaa6a76cb8cc83144436e5f21429f87a11e3acd 100644 (file)
--- a/interface/wx/validate.h
+++ b/interface/wx/validate.h
@@ -3,12 +3,11 @@
 // Purpose:     interface of wxValidator
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 /**
     @class wxValidator
-    @wxheader{validate.h}
 
     wxValidator is the base class for a family of validator classes that
     mediate between a class of control, and application data.
@@ -39,7 +38,8 @@
     @stdobjects
     ::wxDefaultValidator
 
-    @see @ref overview_validator, wxTextValidator, wxGenericValidator
+    @see @ref overview_validator, wxTextValidator, wxGenericValidator,
+        wxIntegerValidator, wxFloatingPointValidator
 */
 class wxValidator : public wxEvtHandler
 {
@@ -52,7 +52,7 @@ public:
     /**
         Destructor.
     */
-    ~wxValidator();
+    virtual ~wxValidator();
 
     /**
         All validator classes must implement the Clone() function, which
@@ -75,11 +75,28 @@ public:
     /**
         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.
     */
-    void SetBellOnError(bool doIt = true);
+    static void SuppressBellOnError(bool suppress = true);
 
     /**
         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);
 
@@ -103,6 +120,9 @@ public:
         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.
     */
@@ -112,5 +132,5 @@ public:
 /**
     An empty, "null" wxValidator instance.
 */
-wxValidator wxDefaultValidator;
+const wxValidator wxDefaultValidator;