1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
|
/////////////////////////////////////////////////////////////////////////////
// Name: srchctrl.h
// Purpose: interface of wxSearchCtrl
// Author: wxWidgets team
// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
/**
@class wxSearchCtrl
A search control is a composite control with a search button, a text
control, and a cancel button.
This control is implemented natively under macOS and GTK 3.6 or later and
generically for all the other platforms.
Please note that this class provides many wxTextCtrl-like methods, but does
_not_ necessarily derive from wxTextCtrl in all ports (although it does in
the generic version). Only the methods defined in wxTextEntry interface
class are guaranteed to be available under all platforms.
@beginStyleTable
@style{wxTE_PROCESS_TAB}
The control will receive @c wxEVT_CHAR events for TAB pressed -
normally, TAB is used for passing to the next control in a dialog
instead. For the control created with this style, you can still use
Ctrl-Enter to pass to the next control from the keyboard.
@style{wxTE_NOHIDESEL}
By default, the Windows text control doesn't show the selection
when it doesn't have focus - use this style to force it to always
show it. It doesn't do anything under other platforms.
@style{wxTE_LEFT}
The text in the control will be left-justified (default).
@style{wxTE_CENTRE}
The text in the control will be centered (currently wxMSW and
wxGTK2 only).
@style{wxTE_RIGHT}
The text in the control will be right-justified (currently wxMSW
and wxGTK2 only).
@style{wxTE_CAPITALIZE}
On PocketPC and Smartphone, causes the first letter to be
capitalized.
@endStyleTable
@beginEventEmissionTable{wxCommandEvent}
To react to the changes in the control contents, use wxEVT_TEXT event, just
as you would do with wxTextCtrl. However it is recommended to use
wxEVT_SEARCH to actually start searching to avoid doing it too soon, while
the user is still typing (note that wxEVT_SEARCH is also triggered by
pressing Enter in the control).
@event{EVT_SEARCH(id, func)}
Respond to a @c wxEVT_SEARCH event, generated when the
search button is clicked. Note that this does not initiate a search on
its own, you need to perform the appropriate action in your event
handler. You may use @code event.GetString() @endcode to retrieve the
string to search for in the event handler code.
@event{EVT_SEARCH_CANCEL(id, func)}
Respond to a @c wxEVT_SEARCH_CANCEL event, generated when the
cancel button is clicked.
@endEventTable
@library{wxcore}
@category{ctrl}
@appearance{searchctrl}
@see wxTextCtrl
*/
class wxSearchCtrl : public wxControl, public wxTextEntry
{
public:
/**
Default constructor
*/
wxSearchCtrl();
/**
Constructor, creating and showing a text control.
@param parent
Parent window. Should not be @NULL.
@param id
Control identifier. A value of -1 denotes a default value.
@param value
Default text value.
@param pos
Text control position.
@param size
Text control size.
@param style
Window style. See wxSearchCtrl.
@param validator
Window validator.
@param name
Window name.
@see wxTextCtrl::Create, wxValidator
*/
wxSearchCtrl(wxWindow* parent, wxWindowID id,
const wxString& value = wxEmptyString,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = 0,
const wxValidator& validator = wxDefaultValidator,
const wxString& name = wxSearchCtrlNameStr);
/**
Destructor, destroying the search control.
*/
virtual ~wxSearchCtrl();
bool Create(wxWindow* parent, wxWindowID id,
const wxString& value = wxEmptyString,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = 0,
const wxValidator& validator = wxDefaultValidator,
const wxString& name = wxSearchCtrlNameStr);
/**
Returns a pointer to the search control's menu object or @NULL if there is no
menu attached.
*/
virtual wxMenu* GetMenu();
/**
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.
*/
virtual bool IsSearchButtonVisible() const;
/**
Returns the cancel button's visibility state.
*/
virtual bool IsCancelButtonVisible() const;
/**
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.
*/
virtual void SetMenu(wxMenu* menu);
/**
Shows or hides the cancel button.
Note that this function does nothing in the native GTK version of the
control: "Cancel" button is always shown automatically if the control
is not empty and hidden if it is empty.
*/
virtual void ShowCancelButton(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 button visibility value.
Note that this function does nothing in the native GTK version of the
control: "Search" button is always shown there.
*/
virtual void ShowSearchButton(bool show);
/**
Set the text to be displayed in the search control when the user has
not yet typed anything in it.
*/
void SetDescriptiveText(const wxString& text);
/**
Return the text displayed when there is not yet any user input.
*/
wxString GetDescriptiveText() const;
};
wxEventType wxEVT_SEARCH_CANCEL;
wxEventType wxEVT_SEARCH;
|
