// Purpose: interface of wxValidator
// Author: wxWidgets team
// RCS-ID: $Id$
-// Licence: wxWindows license
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
/**
For more information, please see @ref overview_validator.
- @beginWxPythonOnly
- 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.
- @endWxPythonOnly
-
@library{wxcore}
@category{validator}
@stdobjects
::wxDefaultValidator
- @see @ref overview_validator, wxTextValidator, wxGenericValidator
+ @see @ref overview_validator, wxTextValidator, wxGenericValidator,
+ wxIntegerValidator, wxFloatingPointValidator
*/
class wxValidator : public wxEvtHandler
{
/**
Destructor.
*/
- ~wxValidator();
+ virtual ~wxValidator();
/**
All validator classes must implement the Clone() function, which
/**
This functions switches on or turns off the error sound produced by the
validators if an invalid key is pressed.
+
+ @since 2.9.1
+
+ @param suppress
+ If @true, error sound is not played when a validator detects an
+ error. If @false, error sound is enabled.
*/
- void SetBellOnError(bool doIt = true);
+ static void SuppressBellOnError(bool suppress = true);
/**
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.
+ @code
+ new wxTextCtrl(this, wxID_ANY, wxEmptyString, wxDefaultPosition, wxDefaultSize, 0,
+ wxTextValidator(wxFILTER_ALPHA, &g_data.m_string));
+ @endcode
+ will automatically link the wxTextValidator instance with the wxTextCtrl
+ instance.
*/
void SetWindow(wxWindow* window);
This overridable function is called when the value in the associated
window must be validated.
+ @param parent
+ The parent of the window associated with the validator.
+
@return @false if the value in the window is not valid; you may pop up
an error dialog.
*/
/**
An empty, "null" wxValidator instance.
*/
-wxValidator wxDefaultValidator;
+const wxValidator wxDefaultValidator;