wxValidator Class Reference

#include <wx/validate.h>

Inheritance diagram for wxValidator:

Detailed Description

wxValidator is the base class for a family of validator classes that mediate between a class of control, and application data.

A validator has three major roles:

1. To transfer data from a C++ variable or own storage to and from a control.
2. To validate data in a control, and show an appropriate error message.
3. To filter events (such as keystrokes), thereby changing the behaviour of the associated control.

Validators can be plugged into controls dynamically.

To specify a default, "null" validator, use wxDefaultValidator.

For more information, please see wxValidator Overview.

Library:  wxCore

Category:  Validators

Predefined objects/pointers: wxDefaultValidator

See Also

wxValidator Overview, wxTextValidator, wxGenericValidator, wxIntegerValidator, wxFloatingPointValidator

Public Member Functions
	wxValidator ()
	Constructor.
virtual	~wxValidator ()
	Destructor.
virtual wxObject *	Clone () const
	All validator classes must implement the Clone() function, which returns an identical copy of itself.
wxWindow *	GetWindow () const
	Returns the window associated with the validator.
void	SetWindow (wxWindow *window)
	Associates a window with the validator.
virtual bool	TransferFromWindow ()
	This overridable function is called when the value in the window must be transferred to the validator.
virtual bool	TransferToWindow ()
	This overridable function is called when the value associated with the validator must be transferred to the window.
virtual bool	Validate (wxWindow *parent)
	This overridable function is called when the value in the associated window must be validated.
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.

Static Public Member Functions
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.
Static Public Member Functions inherited from wxEvtHandler
static void	AddFilter (wxEventFilter *filter)
	Add an event filter whose FilterEvent() method will be called for each and every event processed by wxWidgets.
static void	RemoveFilter (wxEventFilter *filter)
	Remove a filter previously installed with AddFilter().

Additional Inherited Members
Protected Member Functions inherited from wxEvtHandler
virtual bool	TryBefore (wxEvent &event)
	Method called by ProcessEvent() before examining this object event tables.
virtual bool	TryAfter (wxEvent &event)
	Method called by ProcessEvent() as last resort.
Protected Attributes inherited from wxObject
wxObjectRefData *	m_refData
	Pointer to an object which is the object's reference-counted data.

Constructor & Destructor Documentation

wxValidator::wxValidator

(

)

Constructor.

virtual wxValidator::~wxValidator ( )

virtual

Destructor.

Member Function Documentation

virtual wxObject* wxValidator::Clone ( ) const

virtual

All validator classes must implement the Clone() function, which returns an identical copy of itself.

This is because validators are passed to control constructors as references which must be copied. Unlike objects such as pens and brushes, it does not make sense to have a reference counting scheme to do this cloning because all validators should have separate data.

Returns

This base function returns NULL.

Reimplemented in wxGenericValidator, and wxTextValidator.

wxWindow* wxValidator::GetWindow

(

)

const

Returns the window associated with the validator.

static bool wxValidator::IsSilent ( )

static

Returns if the error sound is currently disabled.

void wxValidator::SetWindow

(

wxWindow *

window

)

Associates a window with the validator.

This function is automatically called by wxWidgets when creating a wxWindow-derived class instance which takes a wxValidator reference.

E.g.

new wxTextCtrl(this, wxID_ANY, wxEmptyString, wxDefaultPosition, wxDefaultSize, 0,
               wxTextValidator(wxFILTER_ALPHA, &g_data.m_string));

will automatically link the wxTextValidator instance with the wxTextCtrl instance.

static void wxValidator::SuppressBellOnError ( bool  suppress = true )

static

This functions switches on or turns off the error sound produced by the validators if an invalid key is pressed.

Since

2.9.1

Parameters

suppress

If true, error sound is not played when a validator detects an error. If false, error sound is enabled.

virtual bool wxValidator::TransferFromWindow ( )

virtual

This overridable function is called when the value in the window must be transferred to the validator.

Returns

false if there is a problem.

Reimplemented in wxTextValidator, wxGenericValidator, and wxNumValidator< T >.

virtual bool wxValidator::TransferToWindow ( )

virtual

This overridable function is called when the value associated with the validator must be transferred to the window.

Returns

false if there is a problem.

Reimplemented in wxTextValidator, wxGenericValidator, and wxNumValidator< T >.

virtual bool wxValidator::Validate ( wxWindow *  parent )

virtual

This overridable function is called when the value in the associated window must be validated.

Parameters

parent

The parent of the window associated with the validator.

Returns

false if the value in the window is not valid; you may pop up an error dialog.

Reimplemented in wxTextValidator.