]> git.saurik.com Git - wxWidgets.git/blob - include/wx/valtext.h
cleanup
[wxWidgets.git] / include / wx / valtext.h
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: valtext.h
3 // Purpose: wxTextValidator class
4 // Author: Julian Smart
5 // Modified by:
6 // Created: 29/01/98
7 // RCS-ID: $Id$
8 // Copyright: (c) 1998 Julian Smart
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
11
12 #ifndef _WX_VALTEXT_H_
13 #define _WX_VALTEXT_H_
14
15 #include "wx/defs.h"
16
17 #if wxUSE_VALIDATORS && (wxUSE_TEXTCTRL || wxUSE_COMBOBOX)
18
19 class WXDLLIMPEXP_FWD_CORE wxTextEntry;
20
21 #include "wx/validate.h"
22
23 #define wxFILTER_NONE 0x0000
24 #define wxFILTER_ASCII 0x0001
25 #define wxFILTER_ALPHA 0x0002
26 #define wxFILTER_ALPHANUMERIC 0x0004
27 #define wxFILTER_NUMERIC 0x0008
28 #define wxFILTER_INCLUDE_LIST 0x0010
29 #define wxFILTER_EXCLUDE_LIST 0x0020
30 #define wxFILTER_INCLUDE_CHAR_LIST 0x0040
31 #define wxFILTER_EXCLUDE_CHAR_LIST 0x0080
32
33 class WXDLLEXPORT wxTextValidator: public wxValidator
34 {
35 DECLARE_DYNAMIC_CLASS(wxTextValidator)
36 public:
37
38 wxTextValidator(long style = wxFILTER_NONE, wxString *val = 0);
39 wxTextValidator(const wxTextValidator& val);
40
41 virtual ~wxTextValidator(){}
42
43 // Make a clone of this validator (or return NULL) - currently necessary
44 // if you're passing a reference to a validator.
45 // Another possibility is to always pass a pointer to a new validator
46 // (so the calling code can use a copy constructor of the relevant class).
47 virtual wxObject *Clone() const { return new wxTextValidator(*this); }
48 bool Copy(const wxTextValidator& val);
49
50 // Called when the value in the window must be validated.
51 // This function can pop up an error message.
52 virtual bool Validate(wxWindow *parent);
53
54 // Called to transfer data to the window
55 virtual bool TransferToWindow();
56
57 // Called to transfer data from the window
58 virtual bool TransferFromWindow();
59
60 // ACCESSORS
61 inline long GetStyle() const { return m_validatorStyle; }
62 inline void SetStyle(long style) { m_validatorStyle = style; }
63
64 wxTextEntry *GetTextEntry();
65
66 void SetIncludes(const wxArrayString& includes) { m_includes = includes; }
67 inline wxArrayString& GetIncludes() { return m_includes; }
68
69 void SetExcludes(const wxArrayString& excludes) { m_excludes = excludes; }
70 inline wxArrayString& GetExcludes() { return m_excludes; }
71
72 bool IsInCharIncludes(const wxString& val);
73 bool IsNotInCharExcludes(const wxString& val);
74
75 // Filter keystrokes
76 void OnChar(wxKeyEvent& event);
77
78 DECLARE_EVENT_TABLE()
79
80 protected:
81 long m_validatorStyle;
82 wxString * m_stringValue;
83 wxArrayString m_includes;
84 wxArrayString m_excludes;
85
86 private:
87 // Cannot use
88 // DECLARE_NO_COPY_CLASS(wxTextValidator)
89 // because copy constructor is explicitly declared above;
90 // but no copy assignment operator is defined, so declare
91 // it private to prevent the compiler from defining it:
92 wxTextValidator& operator=(const wxTextValidator&);
93 };
94
95 #endif
96 // wxUSE_VALIDATORS && (wxUSE_TEXTCTRL || wxUSE_COMBOBOX)
97
98 #endif // _WX_VALTEXT_H_