From 180d62d808a1d23bbd1915fd5c6c07031f54323d Mon Sep 17 00:00:00 2001 From: Francesco Montorsi Date: Sat, 31 Jan 2009 21:28:24 +0000 Subject: [PATCH] better docs for wxValidator::SetWindow and Validate git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@58570 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- interface/wx/validate.h | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/interface/wx/validate.h b/interface/wx/validate.h index 5ef578fb58..bb2077bcaa 100644 --- a/interface/wx/validate.h +++ b/interface/wx/validate.h @@ -79,6 +79,17 @@ public: /** 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 +113,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. */