1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: wxTextValidator class
4 // Author: Julian Smart
8 // Copyright: (c) 1998 Julian Smart
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
12 #ifndef _WX_VALTEXT_H_
13 #define _WX_VALTEXT_H_
17 #if wxUSE_VALIDATORS && (wxUSE_TEXTCTRL || wxUSE_COMBOBOX)
19 class WXDLLIMPEXP_FWD_CORE wxTextEntry
;
21 #include "wx/validate.h"
23 enum wxTextValidatorStyle
28 wxFILTER_ALPHANUMERIC
,
30 wxFILTER_INCLUDE_LIST
,
31 wxFILTER_EXCLUDE_LIST
,
32 wxFILTER_INCLUDE_CHAR_LIST
,
33 wxFILTER_EXCLUDE_CHAR_LIST
36 class WXDLLIMPEXP_CORE wxTextValidator
: public wxValidator
39 wxTextValidator(wxTextValidatorStyle style
= wxFILTER_NONE
, wxString
*val
= NULL
);
40 #if WXWIN_COMPATIBILITY_2_8
41 wxDEPRECATED_CONSTRUCTOR( wxTextValidator(long style
, wxString
*val
) );
43 wxTextValidator(const wxTextValidator
& val
);
45 virtual ~wxTextValidator(){}
47 // Make a clone of this validator (or return NULL) - currently necessary
48 // if you're passing a reference to a validator.
49 // Another possibility is to always pass a pointer to a new validator
50 // (so the calling code can use a copy constructor of the relevant class).
51 virtual wxObject
*Clone() const { return new wxTextValidator(*this); }
52 bool Copy(const wxTextValidator
& val
);
54 // Called when the value in the window must be validated.
55 // This function can pop up an error message.
56 virtual bool Validate(wxWindow
*parent
);
58 // Called to transfer data to the window
59 virtual bool TransferToWindow();
61 // Called to transfer data from the window
62 virtual bool TransferFromWindow();
65 inline wxTextValidatorStyle
GetStyle() const { return m_validatorStyle
; }
66 inline void SetStyle(wxTextValidatorStyle style
) { m_validatorStyle
= style
; }
67 #if WXWIN_COMPATIBILITY_2_8
68 wxDEPRECATED( void SetStyle(long style
) );
71 wxTextEntry
*GetTextEntry();
73 void SetIncludes(const wxArrayString
& includes
) { m_includes
= includes
; }
74 inline wxArrayString
& GetIncludes() { return m_includes
; }
76 void SetExcludes(const wxArrayString
& excludes
) { m_excludes
= excludes
; }
77 inline wxArrayString
& GetExcludes() { return m_excludes
; }
79 bool IsInCharIncludes(const wxString
& val
);
80 bool IsNotInCharExcludes(const wxString
& val
);
83 void OnChar(wxKeyEvent
& event
);
86 wxTextValidatorStyle m_validatorStyle
;
87 wxString
* m_stringValue
;
88 wxArrayString m_includes
;
89 wxArrayString m_excludes
;
93 // DECLARE_NO_COPY_CLASS(wxTextValidator)
94 // because copy constructor is explicitly declared above;
95 // but no copy assignment operator is defined, so declare
96 // it private to prevent the compiler from defining it:
97 wxTextValidator
& operator=(const wxTextValidator
&);
99 DECLARE_DYNAMIC_CLASS(wxTextValidator
)
100 DECLARE_EVENT_TABLE()
104 // wxUSE_VALIDATORS && (wxUSE_TEXTCTRL || wxUSE_COMBOBOX)
106 #endif // _WX_VALTEXT_H_