X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/12f5e1e78fe906050ff2fee9529476db332633f0..5c14ec264057d86fe60b2bacc09965492652cc0f:/interface/wx/validate.h diff --git a/interface/wx/validate.h b/interface/wx/validate.h index 98bfc9c26a..13aa8c1288 100644 --- a/interface/wx/validate.h +++ b/interface/wx/validate.h @@ -3,7 +3,7 @@ // Purpose: interface of wxValidator // Author: wxWidgets team // RCS-ID: $Id$ -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// /** @@ -26,19 +26,14 @@ 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 { @@ -51,7 +46,7 @@ public: /** Destructor. */ - ~wxValidator(); + virtual ~wxValidator(); /** All validator classes must implement the Clone() function, which @@ -74,11 +69,28 @@ public: /** 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); @@ -102,6 +114,9 @@ public: 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. */ @@ -111,5 +126,5 @@ public: /** An empty, "null" wxValidator instance. */ -wxValidator wxDefaultValidator; +const wxValidator wxDefaultValidator;