Fixed wxPropertyGridInterface::SetPropertyValues() documentation

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

diff --git a/include/wx/valtext.h b/include/wx/valtext.h
index f7ee50eec4ee5cde04063376040b4a13d3835c3c..34efdbea5a2874113133c2c709c0b275980290d3 100644 (file)
--- a/include/wx/valtext.h
+++ b/include/wx/valtext.h
@@ -2,76 +2,108 @@
 // Name:        valtext.h
 // 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 license
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
-#ifndef __VALTEXTH__
-#define __VALTEXTH__
+#ifndef _WX_VALTEXT_H_
+#define _WX_VALTEXT_H_
 
-#ifdef __GNUG__
-#pragma interface "valtext.h"
-#endif
+#include "wx/defs.h"
+
+#if wxUSE_VALIDATORS && (wxUSE_TEXTCTRL || wxUSE_COMBOBOX)
+
+class WXDLLIMPEXP_FWD_CORE wxTextEntry;
 
 #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
+enum wxTextValidatorStyle
+{
+    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
+};
 
-class WXDLLEXPORT wxTextValidator: public wxValidator
+class WXDLLIMPEXP_CORE wxTextValidator: public wxValidator
 {
-DECLARE_DYNAMIC_CLASS(wxTextValidator)
 public:
-  wxTextValidator(const long style = wxFILTER_NONE, wxString *val = NULL);
-  wxTextValidator(const wxTextValidator& val);
+    wxTextValidator(long style = wxFILTER_NONE, wxString *val = NULL);
+    wxTextValidator(const wxTextValidator& val);
+
+    virtual ~wxTextValidator(){}
 
-  ~wxTextValidator();
+    // Make a clone of this validator (or return NULL) - currently necessary
+    // if you're passing a reference to a validator.
+    // Another possibility is to always pass a pointer to a new validator
+    // (so the calling code can use a copy constructor of the relevant class).
+    virtual wxObject *Clone() const { return new wxTextValidator(*this); }
+    bool Copy(const wxTextValidator& val);
 
-  // Make a clone of this validator (or return NULL) - currently necessary
-  // if you're passing a reference to a validator.
-  // Another possibility is to always pass a pointer to a new validator
-  // (so the calling code can use a copy constructor of the relevant class).
-  virtual wxValidator *Clone(void) const { return new wxTextValidator(*this); }
-  bool Copy(const wxTextValidator& val);
+    // Called when the value in the window must be validated.
+    // This function can pop up an error message.
+    virtual bool Validate(wxWindow *parent);
 
-  // Called when the value in the window must be validated.
-  // This function can pop up an error message.
-  virtual bool Validate(wxWindow *parent);
+    // Called to transfer data to the window
+    virtual bool TransferToWindow();
 
-  // Called to transfer data to the window
-  virtual bool TransferToWindow(void);
+    // Called to transfer data from the window
+    virtual bool TransferFromWindow();
 
-  // Called to transfer data to the window
-  virtual bool TransferFromWindow(void);
+    // Filter keystrokes
+    void OnChar(wxKeyEvent& event);
 
-  // ACCESSORS
-  inline long GetStyle(void) const { return m_validatorStyle; }
-  inline void SetStyle(const long style) { m_validatorStyle = style; }
+    // ACCESSORS
+    inline long GetStyle() const { return m_validatorStyle; }
+    void SetStyle(long style);
 
-  void SetIncludeList(const wxStringList& list);
-  inline wxStringList& GetIncludeList(void) { return m_includeList; }
+    wxTextEntry *GetTextEntry();
 
-  void SetExcludeList(const wxStringList& list);
-  inline wxStringList& GetExcludeList(void) { return m_excludeList; }
+    void SetCharIncludes(const wxString& chars);
+    void SetIncludes(const wxArrayString& includes) { m_includes = includes; }
+    inline wxArrayString& GetIncludes() { return m_includes; }
 
-  // Filter keystrokes
-  void OnChar(wxKeyEvent& event);
+    void SetCharExcludes(const wxString& chars);
+    void SetExcludes(const wxArrayString& excludes) { m_excludes = excludes; }
+    inline wxArrayString& GetExcludes() { return m_excludes; }
 
-DECLARE_EVENT_TABLE()
+    bool HasFlag(wxTextValidatorStyle style) const
+        { return (m_validatorStyle & style) != 0; }
 
 protected:
-    long            m_validatorStyle;
-    wxString *      m_stringValue;
-    wxStringList    m_includeList;
-    wxStringList    m_excludeList;
+
+    // returns true if all characters of the given string are present in m_includes
+    bool ContainsOnlyIncludedCharacters(const wxString& val) const;
+
+    // returns true if at least one character of the given string is present in m_excludes
+    bool ContainsExcludedCharacters(const wxString& val) const;
+
+    // returns the error message if the contents of 'val' are invalid
+    virtual wxString IsValid(const wxString& val) const;
+
+protected:
+    long                 m_validatorStyle;
+    wxString*            m_stringValue;
+    wxArrayString        m_includes;
+    wxArrayString        m_excludes;
+
+private:
+    wxDECLARE_NO_ASSIGN_CLASS(wxTextValidator);
+    DECLARE_DYNAMIC_CLASS(wxTextValidator)
+    DECLARE_EVENT_TABLE()
 };
 
 #endif
+  // wxUSE_VALIDATORS && (wxUSE_TEXTCTRL || wxUSE_COMBOBOX)
+
+#endif // _WX_VALTEXT_H_