X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/3f7f284d555df50912037296c5d74a2911975bce..15f7c30516facfb272fc116aec4d3f9c3a9de085:/docs/latex/wx/srchctrl.tex diff --git a/docs/latex/wx/srchctrl.tex b/docs/latex/wx/srchctrl.tex index 06ce285e8d..a43e76a982 100644 --- a/docs/latex/wx/srchctrl.tex +++ b/docs/latex/wx/srchctrl.tex @@ -7,7 +7,7 @@ control, and a cancel button. \wxheading{Derived from} -\helpref{wxTextCtrl}{wxsearchctrl}\\ +\helpref{wxTextCtrl}{wxtextctrl}\\ streambuf\\ \helpref{wxControl}{wxcontrol}\\ \helpref{wxWindow}{wxwindow}\\ @@ -18,6 +18,10 @@ streambuf\\ +\wxheading{Library} + +\helpref{wxCore}{librarieslist} + \wxheading{Window styles} \twocolwidtha{5cm} @@ -44,13 +48,14 @@ See also \helpref{window styles overview}{windowstyles} and \helpref{wxSearchCtr \wxheading{Event handling} To process input from a search control, use these event handler macros to direct input to member -functions that take a \helpref{wxCommandEvent}{wxcommandevent} argument. +functions that take a \helpref{wxCommandEvent}{wxcommandevent} argument. To retrieve actual search +queries, use EVT\_TEXT and EVT\_TEXT\_ENTER events, just as you would with \helpref{wxTextCtrl}{wxtextctrl}. \twocolwidtha{9cm}% \begin{twocollist}\itemsep=0pt -\twocolitem{{\bf EVT\_SEARCHCTRL\_SEARCH(id, func)}}{Respond to a wxEVT\_SEARCHCTRL\_SEARCH event, -generated when the search button is clicked.} -\twocolitem{{\bf EVT\_SEARCHCTRL\_CANCEL(id, func)}}{Respond to a wxEVT\_SEARCHCTRL\_CANCEL event, +\twocolitem{{\bf 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.} +\twocolitem{{\bf EVT\_SEARCHCTRL\_CANCEL\_BTN(id, func)}}{Respond to a wxEVT\_SEARCHCTRL\_CANCEL\_BTN event, generated when the cancel button is clicked.} \end{twocollist}% @@ -120,9 +125,9 @@ Returns a pointer to the search control's menu object or NULL if there is no menu attached. -\membersection{wxSearchCtrl::SetSearchButtonVisible}\label{wxsearchctrlsetsearchbuttonvisible} +\membersection{wxSearchCtrl::ShowSearchButton}\label{wxsearchctrlshowsearchbutton} -\func{virtual void}{SetSearchButtonVisible}{\param{bool }{ show}} +\func{virtual void}{ShowSearchButton}{\param{bool }{ show}} 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 @@ -131,9 +136,9 @@ button visibility value. This has no effect in Mac OS X v10.3 -\membersection{wxSearchCtrl::GetSearchButtonVisible}\label{wxsearchctrlgetsearchbuttonvisible} +\membersection{wxSearchCtrl::IsSearchButtonVisible}\label{wxsearchctrlissearchbuttonvisible} -\func{virtual bool}{GetSearchButtonVisible}{\void} +\func{virtual bool}{IsSearchButtonVisible}{\void} Returns the search button visibility value. If there is a menu attached, the search button will be visible regardless of the search @@ -142,15 +147,15 @@ button visibility value. This always returns false in Mac OS X v10.3 -\membersection{wxSearchCtrl::SetCancelButtonVisible}\label{wxsearchctrlsetcancelbuttonvisible} +\membersection{wxSearchCtrl::ShowCancelButton}\label{wxsearchctrlshowcancelbutton} -\func{virtual void}{SetCancelButtonVisible}{\param{bool }{ show}} +\func{virtual void}{ShowCancelButton}{\param{bool }{ show}} Shows or hides the cancel button. -\membersection{wxSearchCtrl::GetCancelButtonVisible}\label{wxsearchctrlgetcancelbuttonvisible} +\membersection{wxSearchCtrl::IsCancelButtonVisible}\label{wxsearchctrliscancelbuttonvisible} -\func{virtual bool}{GetCancelButtonVisible}{\void} +\func{virtual bool}{IsCancelButtonVisible}{\void} Indicates whether the cancel button is visible.