]>
git.saurik.com Git - wxWidgets.git/blob - interface/wx/srchctrl.h
1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: interface of wxSearchCtrl
4 // Author: wxWidgets team
6 // Licence: wxWindows license
7 /////////////////////////////////////////////////////////////////////////////
12 A search control is a composite control with a search button, a text
13 control, and a cancel button.
16 @style{wxTE_PROCESS_ENTER}
17 The control will generate the event wxEVT_COMMAND_TEXT_ENTER
18 (otherwise pressing Enter key is either processed internally by the
19 control or used for navigation between dialog controls).
20 @style{wxTE_PROCESS_TAB}
21 The control will receive wxEVT_CHAR events for TAB pressed -
22 normally, TAB is used for passing to the next control in a dialog
23 instead. For the control created with this style, you can still use
24 Ctrl-Enter to pass to the next control from the keyboard.
25 @style{wxTE_NOHIDESEL}
26 By default, the Windows text control doesn't show the selection
27 when it doesn't have focus - use this style to force it to always
28 show it. It doesn't do anything under other platforms.
30 The text in the control will be left-justified (default).
32 The text in the control will be centered (currently wxMSW and
35 The text in the control will be right-justified (currently wxMSW
37 @style{wxTE_CAPITALIZE}
38 On PocketPC and Smartphone, causes the first letter to be
42 @beginEventTable{wxCommandEvent}
43 To retrieve actual search queries, use EVT_TEXT and EVT_TEXT_ENTER events,
44 just as you would with wxTextCtrl.
45 @event{EVT_SEARCHCTRL_SEARCH_BTN(id, func)}
46 Respond to a wxEVT_SEARCHCTRL_SEARCH_BTN event, generated when the
47 search button is clicked. Note that this does not initiate a search.
48 @event{EVT_SEARCHCTRL_CANCEL_BTN(id, func)}
49 Respond to a wxEVT_SEARCHCTRL_CANCEL_BTN event, generated when the
50 cancel button is clicked.
55 @appearance{searchctrl.png}
57 @see wxTextCtrl::Create, wxValidator
59 class wxSearchCtrl
: public wxTextCtrl
68 Constructor, creating and showing a text control.
71 Parent window. Should not be @NULL.
73 Control identifier. A value of -1 denotes a default value.
77 Text control position.
81 Window style. See wxSearchCtrl.
87 @see wxTextCtrl::Create, wxValidator
89 wxSearchCtrl(wxWindow
* parent
, wxWindowID id
,
90 const wxString
& value
= "",
91 const wxPoint
& pos
= wxDefaultPosition
,
92 const wxSize
& size
= wxDefaultSize
,
94 const wxValidator
& validator
= wxDefaultValidator
,
95 const wxString
& name
= wxSearchCtrlNameStr
);
98 Destructor, destroying the search control.
100 virtual ~wxSearchCtrl();
103 Returns a pointer to the search control's menu object or @NULL if there is no
106 virtual wxMenu
* GetMenu();
109 Returns the search button visibility value.
110 If there is a menu attached, the search button will be visible regardless of
111 the search button visibility value.
113 This always returns @false in Mac OS X v10.3
115 virtual bool IsSearchButtonVisible() const;
118 Sets the search control's menu object.
119 If there is already a menu associated with the search control it is deleted.
122 Menu to attach to the search control.
124 virtual void SetMenu(wxMenu
* menu
);
127 Shows or hides the cancel button.
129 virtual void ShowCancelButton(bool show
);
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
134 the search button visibility value.
136 This has no effect in Mac OS X v10.3
138 virtual void ShowSearchButton(bool show
);