docs/latex/wx/srchctrl.tex

   1 %%%%%%%%%%%%%%%%%%%%%%%%%%%% wxSearchCtrl %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   2
   3 \section{\class{wxSearchCtrl}}\label{wxsearchctrl}
   4
   5 A search control is a composite control with a search button, a text
   6 control, and a cancel button.
   7
   8 \wxheading{Derived from}
   9
  10 \helpref{wxTextCtrl}{wxtextctrl}\\
  11 streambuf\\
  12 \helpref{wxControl}{wxcontrol}\\
  13 \helpref{wxWindow}{wxwindow}\\
  14 \helpref{wxEvtHandler}{wxevthandler}\\
  15 \helpref{wxObject}{wxobject}
  16
  17 \wxheading{Include files}
  18
  19 <wx/srchctrl.h>
  20
  21 \wxheading{Library}
  22
  23 \helpref{wxCore}{librarieslist}
  24
  25 \wxheading{Window styles}
  26
  27 \twocolwidtha{5cm}
  28 \begin{twocollist}\itemsep=0pt
  29 \twocolitem{\windowstyle{wxTE\_PROCESS\_ENTER}}{The control will generate
  30 the event wxEVT\_COMMAND\_TEXT\_ENTER (otherwise pressing Enter key
  31 is either processed internally by the control or used for navigation between
  32 dialog controls).}
  33 \twocolitem{\windowstyle{wxTE\_PROCESS\_TAB}}{The control will receive
  34 wxEVT\_CHAR events for TAB pressed - normally, TAB is used for passing to the
  35 next control in a dialog instead. For the control created with this style,
  36 you can still use Ctrl-Enter to pass to the next control from the keyboard.}
  37 \twocolitem{\windowstyle{wxTE\_NOHIDESEL}}{By default, the Windows text control
  38 doesn't show the selection when it doesn't have focus - use this style to force
  39 it to always show it. It doesn't do anything under other platforms.}
  40 \twocolitem{\windowstyle{wxTE\_LEFT}}{The text in the control will be left-justified (default).}
  41 \twocolitem{\windowstyle{wxTE\_CENTRE}}{The text in the control will be centered (currently wxMSW and wxGTK2 only).}
  42 \twocolitem{\windowstyle{wxTE\_RIGHT}}{The text in the control will be right-justified (currently wxMSW and wxGTK2 only).}
  43 \twocolitem{\windowstyle{wxTE\_CAPITALIZE}}{On PocketPC and Smartphone, causes the first letter to be capitalized.}
  44 \end{twocollist}
  45
  46 See also \helpref{window styles overview}{windowstyles} and \helpref{wxSearchCtrl::wxSearchCtrl}{wxsearchctrlctor}.
  47
  48 \wxheading{Event handling}
  49
  50 To process input from a search control, use these event handler macros to direct input to member
  51 functions that take a \helpref{wxCommandEvent}{wxcommandevent} argument. To retrieve actual search
  52 queries, use EVT\_TEXT and EVT\_TEXT\_ENTER events, just as you would with \helpref{wxTextCtrl}{wxtextctrl}.
  53
  54 \twocolwidtha{9cm}%
  55 \begin{twocollist}\itemsep=0pt
  56 \twocolitem{{\bf EVT\_SEARCHCTRL\_SEARCH\_BTN(id, func)}}{Respond to a wxEVT\_SEARCHCTRL\_SEARCH\_BTN event,
  57 generated when the search button is clicked. Note that this does not initiate a search.}
  58 \twocolitem{{\bf EVT\_SEARCHCTRL\_CANCEL\_BTN(id, func)}}{Respond to a wxEVT\_SEARCHCTRL\_CANCEL\_BTN event,
  59 generated when the cancel button is clicked.}
  60 \end{twocollist}%
  61
  62
  63 \latexignore{\rtfignore{\wxheading{Members}}}
  64
  65
  66 \membersection{wxSearchCtrl::wxSearchCtrl}\label{wxsearchctrlctor}
  67
  68 \func{}{wxSearchCtrl}{\void}
  69
  70 Default constructor.
  71
  72 \func{}{wxSearchCtrl}{\param{wxWindow* }{parent}, \param{wxWindowID}{ id},\rtfsp
  73 \param{const wxString\& }{value = ``"}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
  74 \param{long}{ style = 0}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = wxSearchCtrlNameStr}}
  75
  76 Constructor, creating and showing a text control.
  77
  78 \wxheading{Parameters}
  79
  80 \docparam{parent}{Parent window. Should not be NULL.}
  81
  82 \docparam{id}{Control identifier. A value of -1 denotes a default value.}
  83
  84 \docparam{value}{Default text value.}
  85
  86 \docparam{pos}{Text control position.}
  87
  88 \docparam{size}{Text control size.}
  89
  90 \docparam{style}{Window style. See \helpref{wxSearchCtrl}{wxsearchctrl}.}
  91
  92 \docparam{validator}{Window validator.}
  93
  94 \docparam{name}{Window name.}
  95
  96 \wxheading{See also}
  97
  98 \helpref{wxTextCtrl::Create}{wxtextctrlcreate}, \helpref{wxValidator}{wxvalidator}
  99
 100
 101 \membersection{wxSearchCtrl::\destruct{wxSearchCtrl}}\label{wxsearchctrldtor}
 102
 103 \func{}{\destruct{wxSearchCtrl}}{\void}
 104
 105 Destructor, destroying the search control.
 106
 107
 108 \membersection{wxSearchCtrl::SetMenu}\label{wxsearchctrlsetmenu}
 109
 110 \func{virtual void}{SetMenu}{\param{wxMenu* }{ menu}}
 111
 112 Sets the search control's menu object.  If there is already a menu associated with
 113 the search control it is deleted.
 114
 115
 116 \wxheading{Parameters}
 117
 118 \docparam{menu}{Menu to attach to the search control.}
 119
 120 \membersection{wxSearchCtrl::GetMenu}\label{wxsearchctrlgetmenu}
 121
 122 \func{virtual wxMenu*}{GetMenu}{\void}
 123
 124 Returns a pointer to the search control's menu object or NULL if there is no
 125 menu attached.
 126
 127
 128 \membersection{wxSearchCtrl::ShowSearchButton}\label{wxsearchctrlshowsearchbutton}
 129
 130 \func{virtual void}{ShowSearchButton}{\param{bool }{ show}}
 131
 132 Sets the search button visibility value on the search control.
 133 If there is a menu attached, the search button will be visible regardless of the search
 134 button visibility value.
 135
 136 This has no effect in Mac OS X v10.3
 137
 138
 139 \membersection{wxSearchCtrl::IsSearchButtonVisible}\label{wxsearchctrlissearchbuttonvisible}
 140
 141 \func{virtual bool}{IsSearchButtonVisible}{\void}
 142
 143 Returns the search button visibility value.
 144 If there is a menu attached, the search button will be visible regardless of the search
 145 button visibility value.
 146
 147 This always returns false in Mac OS X v10.3
 148
 149
 150 \membersection{wxSearchCtrl::ShowCancelButton}\label{wxsearchctrlshowcancelbutton}
 151
 152 \func{virtual void}{ShowCancelButton}{\param{bool }{ show}}
 153
 154 Shows or hides the cancel button.
 155
 156
 157 \membersection{wxSearchCtrl::IsCancelButtonVisible}\label{wxsearchctrliscancelbuttonvisible}
 158
 159 \func{virtual bool}{IsCancelButtonVisible}{\void}
 160
 161 Indicates whether the cancel button is visible.