removing old files

[wxWidgets.git] / interface / validate.h

diff --git a/interface/validate.h b/interface/validate.h
index 9ca2e96cbc9fbe9c7abb0bd65c1edc0db8468848..76f4abd83589089c768c81f351d23f6ae4039b4e 100644 (file)
--- a/interface/validate.h
+++ b/interface/validate.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        validate.h
-// Purpose:     documentation for wxValidator class
+// Purpose:     interface of wxValidator
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -10,33 +10,36 @@
     @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.
+    wxValidator is the base class for a family of validator classes that
+    mediate between a class of control, and application data.
 
     A validator has three major roles:
 
-     to transfer data from a C++ variable or own storage to and from a control;
-     to validate data in a control, and show an appropriate error message;
-     to filter events (such as keystrokes), thereby changing the behaviour of the
-    associated control.
+    -#  To transfer data from a C++ variable or own storage to and from a
+        control.
+    -#  To validate data in a control, and show an appropriate error message.
+    -#  To filter events (such as keystrokes), thereby changing the behaviour
+        of the associated control.
 
     Validators can be plugged into controls dynamically.
 
-    To specify a default, 'null' validator, use the symbol @b wxDefaultValidator.
+    To specify a default, "null" validator, use ::wxDefaultValidator.
 
-    For more information, please see @ref overview_validatoroverview "Validator
-    overview".
+    For more information, please see @ref overview_validator.
 
-    @b wxPython note: 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.
+    @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}
 
-    @seealso
-    @ref overview_validatoroverview "Validator overview", wxTextValidator,
-    wxGenericValidator,
+    @stdobjects
+    ::wxDefaultValidator
+
+    @see @ref overview_validator, wxTextValidator, wxGenericValidator
 */
 class wxValidator : public wxEvtHandler
 {
@@ -52,27 +55,28 @@ public:
     ~wxValidator();
 
     /**
-        All validator classes must implement the @b Clone function, which returns
-        an identical copy of itself. This is because validators are passed to control
-        constructors as references which must be copied. Unlike objects such as pens
-        and brushes, it does not make sense to have a reference counting scheme
-        to do this cloning, because all validators should have separate
-        data.
-        
-        This base function returns @NULL.
+        All validator classes must implement the Clone() function, which
+        returns an identical copy of itself.
+
+        This is because validators are passed to control constructors as
+        references which must be copied. Unlike objects such as pens and
+        brushes, it does not make sense to have a reference counting scheme to
+        do this cloning because all validators should have separate data.
+
+        @return This base function returns @NULL.
     */
-    virtual wxObject* Clone();
+    virtual wxObject* Clone() const;
 
     /**
         Returns the window associated with the validator.
     */
-    wxWindow* GetWindow();
+    wxWindow* GetWindow() const;
 
     /**
         This functions switches on or turns off the error sound produced by the
         validators if an invalid key is pressed.
     */
-    void SetBellOnError(bool doIt = @true);
+    void SetBellOnError(bool doIt = true);
 
     /**
         Associates a window with the validator.
@@ -80,23 +84,33 @@ public:
     void SetWindow(wxWindow* window);
 
     /**
-        This overridable function is called when the value in the window must be
-        transferred to the validator. Return @false if there is a problem.
+        This overridable function is called when the value in the window must
+        be transferred to the validator.
+
+        @return @false if there is a problem.
     */
-    virtual bool TransferToWindow();
+    virtual bool TransferFromWindow();
 
     /**
         This overridable function is called when the value associated with the
-        validator must be
-        transferred to the window. Return @false if there is a problem.
+        validator must be transferred to the window.
+
+        @return @false if there is a problem.
     */
     virtual bool TransferToWindow();
 
     /**
-        This overridable function is called when the value in the associated window
-        must be validated.
-        Return @false if the value in the window is not valid; you may pop up an error
-        dialog.
+        This overridable function is called when the value in the associated
+        window must be validated.
+
+        @return @false if the value in the window is not valid; you may pop up
+                an error dialog.
     */
     virtual bool Validate(wxWindow* parent);
 };
+
+/**
+    An empty, "null" wxValidator instance.
+*/
+wxValidator wxDefaultValidator;
+