adding comment

[wxWidgets.git] / include / wx / valtext.h

diff --git a/include/wx/valtext.h b/include/wx/valtext.h
index 0a047e199a9a364e975979530a3e34f9cc172f17..4b9be083ae3ce1583404db53942fd49331273fcd 100644 (file)
--- a/include/wx/valtext.h
+++ b/include/wx/valtext.h
@@ -1,47 +1,47 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        valtext.h
+// Name:        wx/valtext.h

 // Purpose:     wxTextValidator class
 // Author:      Julian Smart
 // Purpose:     wxTextValidator class
 // Author:      Julian Smart

-// Modified by:
+// Modified by: Francesco Montorsi

 // Created:     29/01/98
 // RCS-ID:      $Id$
 // Copyright:   (c) 1998 Julian Smart
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 // Created:     29/01/98
 // RCS-ID:      $Id$
 // Copyright:   (c) 1998 Julian Smart
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 

-#ifndef _WX_VALTEXTH__
-#define _WX_VALTEXTH__
-
-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-#pragma interface "valtext.h"
-#endif
+#ifndef _WX_VALTEXT_H_
+#define _WX_VALTEXT_H_

 
 #include "wx/defs.h"
 
 
 #include "wx/defs.h"
 

-#if wxUSE_VALIDATORS && wxUSE_TEXTCTRL
+#if wxUSE_VALIDATORS && (wxUSE_TEXTCTRL || wxUSE_COMBOBOX)
+
+class WXDLLIMPEXP_FWD_CORE wxTextEntry;

 
 

-#include "wx/textctrl.h"

 #include "wx/validate.h"
 
 #include "wx/validate.h"
 

-#define wxFILTER_NONE           0x0000
-#define wxFILTER_ASCII          0x0001
-#define wxFILTER_ALPHA          0x0002
-#define wxFILTER_ALPHANUMERIC   0x0004
-#define wxFILTER_NUMERIC        0x0008
-#define wxFILTER_INCLUDE_LIST   0x0010
-#define wxFILTER_EXCLUDE_LIST   0x0020
-#define wxFILTER_INCLUDE_CHAR_LIST 0x0040
-#define wxFILTER_EXCLUDE_CHAR_LIST 0x0080
-
-class WXDLLEXPORT wxTextValidator: public wxValidator
+enum wxTextValidatorStyle

 {
 {

-DECLARE_DYNAMIC_CLASS(wxTextValidator)
-public:
+    wxFILTER_NONE = 0x0,
+    wxFILTER_EMPTY = 0x1,
+    wxFILTER_ASCII = 0x2,
+    wxFILTER_ALPHA = 0x4,
+    wxFILTER_ALPHANUMERIC = 0x8,
+    wxFILTER_DIGITS = 0x10,
+    wxFILTER_NUMERIC = 0x20,
+    wxFILTER_INCLUDE_LIST = 0x40,
+    wxFILTER_INCLUDE_CHAR_LIST = 0x80,
+    wxFILTER_EXCLUDE_LIST = 0x100,
+    wxFILTER_EXCLUDE_CHAR_LIST = 0x200
+};

 
 

-    wxTextValidator(long style = wxFILTER_NONE, wxString *val = 0);
+class WXDLLIMPEXP_CORE wxTextValidator: public wxValidator
+{
+public:
+    wxTextValidator(long style = wxFILTER_NONE, wxString *val = NULL);

     wxTextValidator(const wxTextValidator& val);
 
     wxTextValidator(const wxTextValidator& val);
 

-    ~wxTextValidator(){}
+    virtual ~wxTextValidator(){}

 
     // Make a clone of this validator (or return NULL) - currently necessary
     // if you're passing a reference to a validator.
 
     // Make a clone of this validator (or return NULL) - currently necessary
     // if you're passing a reference to a validator.


@@ -57,72 +57,53 @@ public:
     // Called to transfer data to the window
     virtual bool TransferToWindow();
 
     // Called to transfer data to the window
     virtual bool TransferToWindow();
 

-    // Called to transfer data to the window
+    // Called to transfer data from the window

     virtual bool TransferFromWindow();
 
     virtual bool TransferFromWindow();
 

+    // Filter keystrokes
+    void OnChar(wxKeyEvent& event);
+

     // ACCESSORS
     inline long GetStyle() const { return m_validatorStyle; }
     // ACCESSORS
     inline long GetStyle() const { return m_validatorStyle; }

-    inline void SetStyle(long style) { m_validatorStyle = style; }
+    void SetStyle(long style);

 
 

-#if WXWIN_COMPATIBILITY_2_4
-    wxDEPRECATED( void SetIncludeList(const wxStringList& list) );
-    wxDEPRECATED( inline wxStringList& GetIncludeList() );
-
-    wxDEPRECATED( void SetExcludeList(const wxStringList& list) );
-    wxDEPRECATED( inline wxStringList& GetExcludeList() );
-
-    wxDEPRECATED( bool IsInCharIncludeList(const wxString& val) );
-    wxDEPRECATED( bool IsNotInCharExcludeList(const wxString& val) );
-#endif
+    wxTextEntry *GetTextEntry();

 
 

+    void SetCharIncludes(const wxString& chars);

     void SetIncludes(const wxArrayString& includes) { m_includes = includes; }
     inline wxArrayString& GetIncludes() { return m_includes; }
 
     void SetIncludes(const wxArrayString& includes) { m_includes = includes; }
     inline wxArrayString& GetIncludes() { return m_includes; }
 

+    void SetCharExcludes(const wxString& chars);

     void SetExcludes(const wxArrayString& excludes) { m_excludes = excludes; }
     inline wxArrayString& GetExcludes() { return m_excludes; }
 
     void SetExcludes(const wxArrayString& excludes) { m_excludes = excludes; }
     inline wxArrayString& GetExcludes() { return m_excludes; }
 

-    bool IsInCharIncludes(const wxString& val);
-    bool IsNotInCharExcludes(const wxString& val);
-
-    // Filter keystrokes
-    void OnChar(wxKeyEvent& event);
+    bool HasFlag(wxTextValidatorStyle style) const
+        { return (m_validatorStyle & style) != 0; }

 
 

+protected:

 
 

-DECLARE_EVENT_TABLE()
+    // returns true if all characters of the given string are present in m_includes
+    bool ContainsOnlyIncludedCharacters(const wxString& val) const;

 
 

-protected:
-    long            m_validatorStyle;
-    wxString *      m_stringValue;
-#if WXWIN_COMPATIBILITY_2_4
-    wxStringList    m_includeList;
-    wxStringList    m_excludeList;
-#endif
-    wxArrayString   m_includes;
-    wxArrayString   m_excludes;
+    // returns true if at least one character of the given string is present in m_excludes
+    bool ContainsExcludedCharacters(const wxString& val) const;

 
 

-    bool CheckValidator() const
-    {
-        wxCHECK_MSG( m_validatorWindow, false,
-                     _T("No window associated with validator") );
-        wxCHECK_MSG( m_validatorWindow->IsKindOf(CLASSINFO(wxTextCtrl)), false,
-                     _T("wxTextValidator is only for wxTextCtrl's") );
-        wxCHECK_MSG( m_stringValue, false,
-                     _T("No variable storage for validator") );
+    // returns the error message if the contents of 'val' are invalid
+    virtual wxString IsValid(const wxString& val) const;

 
 

-        return true;
-    }
+protected:
+    long                 m_validatorStyle;
+    wxString*            m_stringValue;
+    wxArrayString        m_includes;
+    wxArrayString        m_excludes;

 
 private:
 
 private:

-// Cannot use
-//  DECLARE_NO_COPY_CLASS(wxTextValidator)
-// because copy constructor is explicitly declared above;
-// but no copy assignment operator is defined, so declare
-// it private to prevent the compiler from defining it:
-    wxTextValidator& operator=(const wxTextValidator&);
+    wxDECLARE_NO_ASSIGN_CLASS(wxTextValidator);
+    DECLARE_DYNAMIC_CLASS(wxTextValidator)
+    DECLARE_EVENT_TABLE()

 };
 
 #endif
 };
 
 #endif

-  // wxUSE_VALIDATORS && wxUSE_TEXTCTRL
+  // wxUSE_VALIDATORS && (wxUSE_TEXTCTRL || wxUSE_COMBOBOX)

 
 

-#endif
-  // _WX_VALTEXTH__
+#endif // _WX_VALTEXT_H_