]>
Commit | Line | Data |
---|---|---|
23324ae1 FM |
1 | ///////////////////////////////////////////////////////////////////////////// |
2 | // Name: srchctrl.h | |
e54c96f1 | 3 | // Purpose: interface of wxSearchCtrl |
23324ae1 FM |
4 | // Author: wxWidgets team |
5 | // RCS-ID: $Id$ | |
6 | // Licence: wxWindows license | |
7 | ///////////////////////////////////////////////////////////////////////////// | |
8 | ||
9 | /** | |
10 | @class wxSearchCtrl | |
11 | @wxheader{srchctrl.h} | |
7c913512 FM |
12 | |
13 | A search control is a composite control with a search button, a text | |
23324ae1 | 14 | control, and a cancel button. |
7c913512 | 15 | |
23324ae1 FM |
16 | @beginStyleTable |
17 | @style{wxTE_PROCESS_ENTER}: | |
18 | The control will generate the event wxEVT_COMMAND_TEXT_ENTER | |
19 | (otherwise pressing Enter key is either processed internally by the | |
20 | control or used for navigation between dialog controls). | |
21 | @style{wxTE_PROCESS_TAB}: | |
22 | The control will receive wxEVT_CHAR events for TAB pressed - | |
23 | normally, TAB is used for passing to the next control in a dialog | |
24 | instead. For the control created with this style, you can still use | |
25 | Ctrl-Enter to pass to the next control from the keyboard. | |
26 | @style{wxTE_NOHIDESEL}: | |
27 | By default, the Windows text control doesn't show the selection | |
28 | when it doesn't have focus - use this style to force it to always | |
29 | show it. It doesn't do anything under other platforms. | |
30 | @style{wxTE_LEFT}: | |
31 | The text in the control will be left-justified (default). | |
32 | @style{wxTE_CENTRE}: | |
33 | The text in the control will be centered (currently wxMSW and | |
34 | wxGTK2 only). | |
35 | @style{wxTE_RIGHT}: | |
36 | The text in the control will be right-justified (currently wxMSW | |
37 | and wxGTK2 only). | |
38 | @style{wxTE_CAPITALIZE}: | |
39 | On PocketPC and Smartphone, causes the first letter to be | |
40 | capitalized. | |
41 | @endStyleTable | |
7c913512 | 42 | |
23324ae1 FM |
43 | @library{wxcore} |
44 | @category{FIXME} | |
7c913512 | 45 | |
e54c96f1 | 46 | @see wxTextCtrl::Create, wxValidator |
23324ae1 FM |
47 | */ |
48 | class wxSearchCtrl : public wxTextCtrl | |
49 | { | |
50 | public: | |
51 | //@{ | |
52 | /** | |
53 | Constructor, creating and showing a text control. | |
3c4f71cc | 54 | |
7c913512 | 55 | @param parent |
4cc4bfaf | 56 | Parent window. Should not be @NULL. |
7c913512 | 57 | @param id |
4cc4bfaf | 58 | Control identifier. A value of -1 denotes a default value. |
7c913512 | 59 | @param value |
4cc4bfaf | 60 | Default text value. |
7c913512 | 61 | @param pos |
4cc4bfaf | 62 | Text control position. |
7c913512 | 63 | @param size |
4cc4bfaf | 64 | Text control size. |
7c913512 | 65 | @param style |
4cc4bfaf | 66 | Window style. See wxSearchCtrl. |
7c913512 | 67 | @param validator |
4cc4bfaf | 68 | Window validator. |
7c913512 | 69 | @param name |
4cc4bfaf | 70 | Window name. |
3c4f71cc | 71 | |
4cc4bfaf | 72 | @see wxTextCtrl::Create, wxValidator |
23324ae1 FM |
73 | */ |
74 | wxSearchCtrl(); | |
7c913512 FM |
75 | wxSearchCtrl(wxWindow* parent, wxWindowID id, |
76 | const wxString& value = "", | |
77 | const wxPoint& pos = wxDefaultPosition, | |
78 | const wxSize& size = wxDefaultSize, | |
79 | long style = 0, | |
80 | const wxValidator& validator = wxDefaultValidator, | |
81 | const wxString& name = wxSearchCtrlNameStr); | |
23324ae1 FM |
82 | //@} |
83 | ||
84 | /** | |
85 | Destructor, destroying the search control. | |
86 | */ | |
87 | ~wxSearchCtrl(); | |
88 | ||
89 | /** | |
7c913512 | 90 | Returns a pointer to the search control's menu object or @NULL if there is no |
23324ae1 FM |
91 | menu attached. |
92 | */ | |
93 | virtual wxMenu* GetMenu(); | |
94 | ||
95 | /** | |
7c913512 | 96 | Returns the search button visibility value. |
23324ae1 FM |
97 | If there is a menu attached, the search button will be visible regardless of |
98 | the search | |
7c913512 | 99 | button visibility value. |
23324ae1 FM |
100 | This always returns @false in Mac OS X v10.3 |
101 | */ | |
102 | virtual bool IsSearchButtonVisible(); | |
103 | ||
104 | /** | |
105 | Sets the search control's menu object. If there is already a menu associated | |
106 | with | |
107 | the search control it is deleted. | |
3c4f71cc | 108 | |
7c913512 | 109 | @param menu |
4cc4bfaf | 110 | Menu to attach to the search control. |
23324ae1 FM |
111 | */ |
112 | virtual void SetMenu(wxMenu* menu); | |
113 | ||
114 | /** | |
115 | Shows or hides the cancel button. | |
116 | */ | |
117 | virtual void ShowCancelButton(bool show); | |
118 | ||
119 | /** | |
7c913512 | 120 | Sets the search button visibility value on the search control. |
23324ae1 FM |
121 | If there is a menu attached, the search button will be visible regardless of |
122 | the search | |
7c913512 | 123 | button visibility value. |
23324ae1 FM |
124 | This has no effect in Mac OS X v10.3 |
125 | */ | |
126 | virtual void ShowSearchButton(bool show); | |
127 | }; | |
e54c96f1 | 128 |