wxTextValidator Class Reference

#include <wx/valtext.h>

Inheritance diagram for wxTextValidator:

Detailed Description

wxTextValidator validates text controls, providing a variety of filtering behaviours.

For more information, please see wxValidator Overview.

Library:  wxCore

Category:  Validators

See Also

wxValidator Overview, wxValidator, wxGenericValidator, wxIntegerValidator, wxFloatingPointValidator

Public Member Functions
	wxTextValidator (const wxTextValidator &validator)
	Default constructor.
	wxTextValidator (long style=wxFILTER_NONE, wxString *valPtr=NULL)
	Constructor taking a style and optional pointer to a wxString variable.
virtual wxObject *	Clone () const
	Clones the text validator using the copy constructor.
wxArrayString &	GetExcludes ()
	Returns a reference to the exclude list (the list of invalid values).
wxArrayString &	GetIncludes ()
	Returns a reference to the include list (the list of valid values).
long	GetStyle () const
	Returns the validator style.
bool	HasFlag (wxTextValidatorStyle style) const
	Returns true if the given style bit is set in the current style.
void	OnChar (wxKeyEvent &event)
	Receives character input from the window and filters it according to the current validator style.
void	SetExcludes (const wxArrayString &stringList)
	Sets the exclude list (invalid values for the user input).
void	SetCharExcludes (const wxString &chars)
	Breaks the given chars strings in single characters and sets the internal wxArrayString used to store the "excluded" characters (see SetExcludes()).
void	SetIncludes (const wxArrayString &stringList)
	Sets the include list (valid values for the user input).
void	SetCharIncludes (const wxString &chars)
	Breaks the given chars strings in single characters and sets the internal wxArrayString used to store the "included" characters (see SetIncludes()).
void	SetStyle (long style)
	Sets the validator style which must be a combination of one or more of the wxTextValidatorStyle values.
virtual bool	TransferFromWindow ()
	Transfers the value in the text control to the string.
virtual bool	TransferToWindow ()
	Transfers the string value to the text control.
virtual bool	Validate (wxWindow *parent)
	Validates the window contents against the include or exclude lists, depending on the validator style.
Public Member Functions inherited from wxValidator
	wxValidator ()
	Constructor.
virtual	~wxValidator ()
	Destructor.
wxWindow *	GetWindow () const
	Returns the window associated with the validator.
void	SetWindow (wxWindow *window)
	Associates a window with the validator.
Public Member Functions inherited from wxEvtHandler
	wxEvtHandler ()
	Constructor.
virtual	~wxEvtHandler ()
	Destructor.
virtual void	QueueEvent (wxEvent *event)
	Queue event for a later processing.
virtual void	AddPendingEvent (const wxEvent &event)
	Post an event to be processed later.
template<typename T , typename T1 , ... >
void	CallAfter (void(T::*method)(T1,...), T1 x1,...)
	Asynchronously call the given method.
template<typename T >
void	CallAfter (const T &functor)
	Asynchronously call the given functor.
virtual bool	ProcessEvent (wxEvent &event)
	Processes an event, searching event tables and calling zero or more suitable event handler function(s).
bool	ProcessEventLocally (wxEvent &event)
	Try to process the event in this handler and all those chained to it.
bool	SafelyProcessEvent (wxEvent &event)
	Processes an event by calling ProcessEvent() and handles any exceptions that occur in the process.
void	ProcessPendingEvents ()
	Processes the pending events previously queued using QueueEvent() or AddPendingEvent(); you must call this function only if you are sure there are pending events for this handler, otherwise a wxCHECK will fail.
void	DeletePendingEvents ()
	Deletes all events queued on this event handler using QueueEvent() or AddPendingEvent().
virtual bool	SearchEventTable (wxEventTable &table, wxEvent &event)
	Searches the event table, executing an event handler function if an appropriate one is found.
void	Connect (int id, int lastId, wxEventType eventType, wxObjectEventFunction function, wxObject *userData=NULL, wxEvtHandler *eventSink=NULL)
	Connects the given function dynamically with the event handler, id and event type.
void	Connect (int id, wxEventType eventType, wxObjectEventFunction function, wxObject *userData=NULL, wxEvtHandler *eventSink=NULL)
	See the Connect(int, int, wxEventType, wxObjectEventFunction, wxObject*, wxEvtHandler*) overload for more info.
void	Connect (wxEventType eventType, wxObjectEventFunction function, wxObject *userData=NULL, wxEvtHandler *eventSink=NULL)
	See the Connect(int, int, wxEventType, wxObjectEventFunction, wxObject*, wxEvtHandler*) overload for more info.
bool	Disconnect (wxEventType eventType, wxObjectEventFunction function, wxObject *userData=NULL, wxEvtHandler *eventSink=NULL)
	Disconnects the given function dynamically from the event handler, using the specified parameters as search criteria and returning true if a matching function has been found and removed.
bool	Disconnect (int id=wxID_ANY, wxEventType eventType=wxEVT_NULL, wxObjectEventFunction function=NULL, wxObject *userData=NULL, wxEvtHandler *eventSink=NULL)
	See the Disconnect(wxEventType, wxObjectEventFunction, wxObject*, wxEvtHandler*) overload for more info.
bool	Disconnect (int id, int lastId, wxEventType eventType, wxObjectEventFunction function=NULL, wxObject *userData=NULL, wxEvtHandler *eventSink=NULL)
	See the Disconnect(wxEventType, wxObjectEventFunction, wxObject*, wxEvtHandler*) overload for more info.
template<typename EventTag , typename Functor >
void	Bind (const EventTag &eventType, Functor functor, int id=wxID_ANY, int lastId=wxID_ANY, wxObject *userData=NULL)
	Binds the given function, functor or method dynamically with the event.
template<typename EventTag , typename Class , typename EventArg , typename EventHandler >
void	Bind (const EventTag &eventType, void(Class::*method)(EventArg &), EventHandler *handler, int id=wxID_ANY, int lastId=wxID_ANY, wxObject *userData=NULL)
	See the Bind<>(const EventTag&, Functor, int, int, wxObject*) overload for more info.
template<typename EventTag , typename Functor >
bool	Unbind (const EventTag &eventType, Functor functor, int id=wxID_ANY, int lastId=wxID_ANY, wxObject *userData=NULL)
	Unbinds the given function, functor or method dynamically from the event handler, using the specified parameters as search criteria and returning true if a matching function has been found and removed.
template<typename EventTag , typename Class , typename EventArg , typename EventHandler >
bool	Unbind (const EventTag &eventType, void(Class::*method)(EventArg &), EventHandler *handler, int id=wxID_ANY, int lastId=wxID_ANY, wxObject *userData=NULL)
	See the Unbind<>(const EventTag&, Functor, int, int, wxObject*) overload for more info.
void *	GetClientData () const
	Returns user-supplied client data.
wxClientData *	GetClientObject () const
	Returns a pointer to the user-supplied client data object.
void	SetClientData (void *data)
	Sets user-supplied client data.
void	SetClientObject (wxClientData *data)
	Set the client data object.
bool	GetEvtHandlerEnabled () const
	Returns true if the event handler is enabled, false otherwise.
wxEvtHandler *	GetNextHandler () const
	Returns the pointer to the next handler in the chain.
wxEvtHandler *	GetPreviousHandler () const
	Returns the pointer to the previous handler in the chain.
void	SetEvtHandlerEnabled (bool enabled)
	Enables or disables the event handler.
virtual void	SetNextHandler (wxEvtHandler *handler)
	Sets the pointer to the next handler.
virtual void	SetPreviousHandler (wxEvtHandler *handler)
	Sets the pointer to the previous handler.
void	Unlink ()
	Unlinks this event handler from the chain it's part of (if any); then links the "previous" event handler to the "next" one (so that the chain won't be interrupted).
bool	IsUnlinked () const
	Returns true if the next and the previous handler pointers of this event handler instance are NULL.
Public Member Functions inherited from wxObject
	wxObject ()
	Default ctor; initializes to NULL the internal reference data.
	wxObject (const wxObject &other)
	Copy ctor.
virtual	~wxObject ()
	Destructor.
virtual wxClassInfo *	GetClassInfo () const
	This virtual function is redefined for every class that requires run-time type information, when using the wxDECLARE_CLASS macro (or similar).
wxObjectRefData *	GetRefData () const
	Returns the wxObject::m_refData pointer, i.e. the data referenced by this object.
bool	IsKindOf (const wxClassInfo *info) const
	Determines whether this class is a subclass of (or the same class as) the given class.
bool	IsSameAs (const wxObject &obj) const
	Returns true if this object has the same data pointer as obj.
void	Ref (const wxObject &clone)
	Makes this object refer to the data in clone.
void	SetRefData (wxObjectRefData *data)
	Sets the wxObject::m_refData pointer.
void	UnRef ()
	Decrements the reference count in the associated data, and if it is zero, deletes the data.
void	UnShare ()
	This is the same of AllocExclusive() but this method is public.
void	operator delete (void *buf)
	The delete operator is defined for debugging versions of the library only, when the identifier WXDEBUG is defined.
void *	operator new (size_t size, const wxString &filename=NULL, int lineNum=0)
	The new operator is defined for debugging versions of the library only, when the identifier WXDEBUG is defined.

Protected Member Functions
bool	ContainsOnlyIncludedCharacters (const wxString &val) const
	Returns true if all the characters of the given val string are present in the include list (set by SetIncludes() or SetCharIncludes()).
bool	ContainsExcludedCharacters (const wxString &val) const
	Returns true if at least one character of the given val string is present in the exclude list (set by SetExcludes() or SetCharExcludes()).
virtual wxString	IsValid (const wxString &val) const
	Returns the error message if the contents of val are invalid or the empty string if val is valid.

Additional Inherited Members
Static Public Member Functions inherited from wxValidator
static void	SuppressBellOnError (bool suppress=true)
	This functions switches on or turns off the error sound produced by the validators if an invalid key is pressed.
static bool	IsSilent ()
	Returns if the error sound is currently disabled.
Protected Attributes inherited from wxObject
wxObjectRefData *	m_refData
	Pointer to an object which is the object's reference-counted data.

Constructor & Destructor Documentation

wxTextValidator::wxTextValidator

(

const wxTextValidator &

validator

)

Default constructor.

wxTextValidator::wxTextValidator	(	long	style = wxFILTER_NONE,
		wxString *	valPtr = NULL
	)

Constructor taking a style and optional pointer to a wxString variable.

Parameters

style	One or more of the wxTextValidatorStyle styles. See SetStyle().
valPtr	A pointer to a wxString variable that contains the value. This variable should have a lifetime equal to or longer than the validator lifetime (which is usually determined by the lifetime of the window).

Member Function Documentation

virtual wxObject* wxTextValidator::Clone ( ) const

virtual

Clones the text validator using the copy constructor.

Reimplemented from wxValidator.

bool wxTextValidator::ContainsExcludedCharacters ( const wxString &  val ) const

protected

Returns true if at least one character of the given val string is present in the exclude list (set by SetExcludes() or SetCharExcludes()).

bool wxTextValidator::ContainsOnlyIncludedCharacters ( const wxString &  val ) const

protected

Returns true if all the characters of the given val string are present in the include list (set by SetIncludes() or SetCharIncludes()).

wxArrayString& wxTextValidator::GetExcludes

(

)

Returns a reference to the exclude list (the list of invalid values).

wxArrayString& wxTextValidator::GetIncludes

(

)

Returns a reference to the include list (the list of valid values).

long wxTextValidator::GetStyle

(

)

const

Returns the validator style.

See Also

HasFlag()

bool wxTextValidator::HasFlag

(

wxTextValidatorStyle

style

)

const

Returns true if the given style bit is set in the current style.

virtual wxString wxTextValidator::IsValid ( const wxString &  val ) const

protectedvirtual

Returns the error message if the contents of val are invalid or the empty string if val is valid.

void wxTextValidator::OnChar

(

wxKeyEvent &

event

)

Receives character input from the window and filters it according to the current validator style.

void wxTextValidator::SetCharExcludes

(

const wxString &

chars

)

Breaks the given chars strings in single characters and sets the internal wxArrayString used to store the "excluded" characters (see SetExcludes()).

This function is mostly useful when wxFILTER_EXCLUDE_CHAR_LIST was used.

void wxTextValidator::SetCharIncludes

(

const wxString &

chars

)

Breaks the given chars strings in single characters and sets the internal wxArrayString used to store the "included" characters (see SetIncludes()).

This function is mostly useful when wxFILTER_INCLUDE_CHAR_LIST was used.

void wxTextValidator::SetExcludes

(

const wxArrayString &

stringList

)

Sets the exclude list (invalid values for the user input).

void wxTextValidator::SetIncludes

(

const wxArrayString &

stringList

)

Sets the include list (valid values for the user input).

void wxTextValidator::SetStyle

(

long

style

)

Sets the validator style which must be a combination of one or more of the wxTextValidatorStyle values.

Note that not all possible combinations make sense! Also note that the order in which the checks are performed is important, in case you specify more than a single style. wxTextValidator will perform the checks in the same definition order used in the wxTextValidatorStyle enumeration.

virtual bool wxTextValidator::TransferFromWindow ( )

virtual

Transfers the value in the text control to the string.

Reimplemented from wxValidator.

virtual bool wxTextValidator::TransferToWindow ( )

virtual

Transfers the string value to the text control.

Reimplemented from wxValidator.

virtual bool wxTextValidator::Validate ( wxWindow *  parent )

virtual

Validates the window contents against the include or exclude lists, depending on the validator style.

Reimplemented from wxValidator.