/////////////////////////////////////////////////////////////////////////////
// Name: validate.h
-// Purpose: documentation for wxValidator class
+// Purpose: interface of wxValidator
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
/**
@class wxValidator
@wxheader{validate.h}
-
+
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:
-
+
to transfer data from a C++ variable or own storage to and from a control;
to validate data in a control, and show an appropriate error message;
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 the symbol @b wxDefaultValidator.
-
+
For more information, please see @ref overview_validatoroverview "Validator
overview".
-
+
@b wxPython note: If you wish to create a validator class in wxPython you should
derive the class from @c wxPyValidator in order to get Python-aware
capabilities for the various virtual methods.
-
+
@library{wxcore}
@category{validator}
-
- @seealso
- @ref overview_validatoroverview "Validator overview", wxTextValidator,
+
+ @see @ref overview_validatoroverview "Validator overview", wxTextValidator,
wxGenericValidator,
*/
class wxValidator : public wxEvtHandler
and brushes, it does not make sense to have a reference counting scheme
to do this cloning, because all validators should have separate
data.
-
This base function returns @NULL.
*/
- virtual wxObject* Clone();
+ virtual wxObject* Clone() const;
/**
Returns the window associated with the validator.
*/
- wxWindow* GetWindow();
+ wxWindow* GetWindow() const;
/**
This functions switches on or turns off the error sound produced by the
validators if an invalid key is pressed.
*/
- void SetBellOnError(bool doIt = @true);
+ void SetBellOnError(bool doIt = true);
/**
Associates a window with the validator.
*/
virtual bool Validate(wxWindow* parent);
};
+