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