added interface headers with latest discussed changes

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52381 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

interface/validate.h

@@ -0,0 +1,102 @@
+/////////////////////////////////////////////////////////////////////////////
+// Name:        validate.h
+// Purpose:     documentation for wxValidator class
+// Author:      wxWidgets team
+// RCS-ID:      $Id$
+// Licence:     wxWindows license
+/////////////////////////////////////////////////////////////////////////////
+
+/**
+    @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.
+    
+    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.
+    
+    Validators can be plugged into controls dynamically.
+    
+    To specify a default, 'null' validator, use the symbol @b wxDefaultValidator.
+    
+    For more information, please see @ref overview_validatoroverview "Validator
+    overview".
+    
+    @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.
+    
+    @library{wxcore}
+    @category{validator}
+    
+    @seealso
+    @ref overview_validatoroverview "Validator overview", wxTextValidator,
+    wxGenericValidator,
+*/
+class wxValidator : public wxEvtHandler
+{
+public:
+    /**
+        Constructor.
+    */
+    wxValidator();
+
+    /**
+        Destructor.
+    */
+    ~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.
+    */
+    virtual wxObject* Clone();
+
+    /**
+        Returns the window associated with the validator.
+    */
+    wxWindow* GetWindow();
+
+    /**
+        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);
+
+    /**
+        Associates a window with the validator.
+    */
+    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.
+    */
+    virtual bool TransferToWindow();
+
+    /**
+        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.
+    */
+    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.
+    */
+    virtual bool Validate(wxWindow* parent);
+};