X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/adaaa68635b4c8a4d8c5284add40366ea3eefb07..920b92a3fd568f012a8f7814d56640cb729ba993:/interface/wx/srchctrl.h diff --git a/interface/wx/srchctrl.h b/interface/wx/srchctrl.h index a1211f8b93..eec053b845 100644 --- a/interface/wx/srchctrl.h +++ b/interface/wx/srchctrl.h @@ -39,8 +39,20 @@ capitalized. @endStyleTable + @beginEventTable{wxCommandEvent} + To retrieve actual search queries, use EVT_TEXT and EVT_TEXT_ENTER events, + just as you would with wxTextCtrl. + @event{EVT_SEARCHCTRL_SEARCH_BTN(id, func)} + Respond to a wxEVT_SEARCHCTRL_SEARCH_BTN event, generated when the + search button is clicked. Note that this does not initiate a search. + @event{EVT_SEARCHCTRL_CANCEL_BTN(id, func)} + Respond to a wxEVT_SEARCHCTRL_CANCEL_BTN event, generated when the + cancel button is clicked. + @endEventTable + @library{wxcore} - @category{FIXME} + @category{ctrl} + @appearance{searchctrl.png} @see wxTextCtrl::Create, wxValidator */ @@ -51,7 +63,7 @@ public: Default constructor */ wxSearchCtrl(); - + /** Constructor, creating and showing a text control. @@ -75,7 +87,7 @@ public: @see wxTextCtrl::Create, wxValidator */ wxSearchCtrl(wxWindow* parent, wxWindowID id, - const wxString& value = "", + const wxString& value = wxEmptyString, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, long style = 0, @@ -96,16 +108,15 @@ public: /** Returns the search button visibility value. If there is a menu attached, the search button will be visible regardless of - the search - button visibility value. + the search button visibility value. + This always returns @false in Mac OS X v10.3 */ virtual bool IsSearchButtonVisible() const; /** - Sets the search control's menu object. If there is already a menu associated - with - the search control it is deleted. + Sets the search control's menu object. + If there is already a menu associated with the search control it is deleted. @param menu Menu to attach to the search control. @@ -120,8 +131,8 @@ public: /** Sets the search button visibility value on the search control. If there is a menu attached, the search button will be visible regardless of - the search - button visibility value. + the search button visibility value. + This has no effect in Mac OS X v10.3 */ virtual void ShowSearchButton(bool show);