First attempt to document raw bitmap access

[wxWidgets.git] / interface / valtext.h

diff --git a/interface/valtext.h b/interface/valtext.h
index 7e9db73762490a3d390c7600990eebec92b80fa7..29e9e283d2fe8f698c1b97a6ebd3c962b2530d89 100644 (file)
--- a/interface/valtext.h
+++ b/interface/valtext.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        valtext.h
-// Purpose:     documentation for wxTextValidator class
+// Purpose:     interface of wxTextValidator
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -19,8 +19,7 @@
     @library{wxcore}
     @category{validator}
 
-    @seealso
-    @ref overview_validatoroverview "Validator overview", wxValidator,
+    @see @ref overview_validatoroverview "Validator overview", wxValidator,
     wxGenericValidator
 */
 class wxTextValidator : public wxValidator
@@ -29,116 +28,116 @@ public:
     //@{
     /**
         Constructor, taking a style and optional pointer to a wxString variable.
-        
+
         @param style
             A bitlist of flags, which can be:
-        
-        
-        
-        
-        
-        
-        
+
+
+
+
+
+
+
             wxFILTER_NONE
-        
-        
-        
-        
+
+
+
+
             No filtering takes place.
-        
-        
-        
-        
-        
+
+
+
+
+
             wxFILTER_ASCII
-        
-        
-        
-        
+
+
+
+
             Non-ASCII characters are filtered out.
-        
-        
-        
-        
-        
+
+
+
+
+
             wxFILTER_ALPHA
-        
-        
-        
-        
+
+
+
+
             Non-alpha characters are filtered out.
-        
-        
-        
-        
-        
+
+
+
+
+
             wxFILTER_ALPHANUMERIC
-        
-        
-        
-        
+
+
+
+
             Non-alphanumeric characters are filtered out.
-        
-        
-        
-        
-        
+
+
+
+
+
             wxFILTER_NUMERIC
-        
-        
-        
-        
+
+
+
+
             Non-numeric characters are filtered out.
-        
-        
-        
-        
-        
+
+
+
+
+
             wxFILTER_INCLUDE_LIST
-        
-        
-        
-        
+
+
+
+
             Use an include list. The validator
             checks if the user input is on the list, complaining if not. See
             SetIncludes().
-        
-        
-        
-        
-        
+
+
+
+
+
             wxFILTER_EXCLUDE_LIST
-        
-        
-        
-        
+
+
+
+
             Use an exclude list. The validator
             checks if the user input is on the list, complaining if it is. See
             SetExcludes().
-        
-        
-        
-        
-        
+
+
+
+
+
             wxFILTER_INCLUDE_CHAR_LIST
-        
-        
-        
-        
+
+
+
+
             Use an include list. The validator
             checks if each input character is in the list (one character per list
         element), complaining if not.
             See SetIncludes().
-        
-        
-        
-        
-        
+
+
+
+
+
             wxFILTER_EXCLUDE_CHAR_LIST
-        
-        
-        
-        
+
+
+
+
             Use an include list. The validator
             checks if each input character is in the list (one character per list
         element), complaining if it is.
@@ -157,22 +156,22 @@ public:
     /**
         Clones the text validator using the copy constructor.
     */
-    virtual wxValidator* Clone();
+    virtual wxValidator* Clone() const;
 
     /**
         Returns a reference to the exclude list (the list of invalid values).
     */
-    wxArrayString GetExcludes();
+    wxArrayString GetExcludes() const;
 
     /**
         Returns a reference to the include list (the list of valid values).
     */
-    wxArrayString GetIncludes();
+    wxArrayString GetIncludes() const;
 
     /**
         Returns the validator style.
     */
-    long GetStyle();
+    long GetStyle() const;
 
     /**
         Receives character input from the window and filters it according to the
@@ -211,3 +210,4 @@ public:
     */
     virtual bool Validate(wxWindow* parent);
 };
+