]>
Commit | Line | Data |
---|---|---|
23324ae1 FM |
1 | ///////////////////////////////////////////////////////////////////////////// |
2 | // Name: combo.h | |
968f15e2 | 3 | // Purpose: interface of wxComboCtrl and wxComboPopup |
23324ae1 FM |
4 | // Author: wxWidgets team |
5 | // RCS-ID: $Id$ | |
6 | // Licence: wxWindows license | |
7 | ///////////////////////////////////////////////////////////////////////////// | |
8 | ||
9 | /** | |
10 | @class wxComboPopup | |
7c913512 | 11 | |
968f15e2 BP |
12 | In order to use a custom popup with wxComboCtrl, an interface class must be |
13 | derived from wxComboPopup. | |
1f1d2182 | 14 | |
968f15e2 | 15 | For more information on how to use it, see @ref comboctrl_custompopup. |
7c913512 | 16 | |
23324ae1 | 17 | @library{wxcore} |
968f15e2 | 18 | @category{ctrl} |
7c913512 | 19 | |
e54c96f1 | 20 | @see wxComboCtrl |
23324ae1 | 21 | */ |
7c913512 | 22 | class wxComboPopup |
23324ae1 FM |
23 | { |
24 | public: | |
25 | /** | |
968f15e2 BP |
26 | Default constructor. It is recommended that internal variables are |
27 | prepared in Init() instead (because m_combo is not valid in | |
28 | constructor). | |
23324ae1 FM |
29 | */ |
30 | wxComboPopup(); | |
31 | ||
32 | /** | |
33 | The derived class must implement this to create the popup control. | |
3c4f71cc | 34 | |
d29a9a8a | 35 | @return @true if the call succeeded, @false otherwise. |
23324ae1 | 36 | */ |
b91c4601 | 37 | virtual bool Create(wxWindow* parent) = 0; |
23324ae1 FM |
38 | |
39 | /** | |
40 | Utility function that hides the popup. | |
41 | */ | |
42 | void Dismiss(); | |
43 | ||
44 | /** | |
968f15e2 BP |
45 | The derived class may implement this to return adjusted size for the |
46 | popup control, according to the variables given. | |
3c4f71cc | 47 | |
7c913512 | 48 | @param minWidth |
4cc4bfaf | 49 | Preferred minimum width. |
7c913512 | 50 | @param prefHeight |
968f15e2 | 51 | Preferred height. May be -1 to indicate no preference. |
45a591fa | 52 | @param maxHeight |
968f15e2 | 53 | Max height for window, as limited by screen size. |
3c4f71cc | 54 | |
968f15e2 | 55 | @remarks This function is called each time popup is about to be shown. |
23324ae1 | 56 | */ |
968f15e2 | 57 | virtual wxSize GetAdjustedSize(int minWidth, int prefHeight, int maxHeight); |
23324ae1 FM |
58 | |
59 | /** | |
968f15e2 BP |
60 | The derived class must implement this to return pointer to the |
61 | associated control created in Create(). | |
23324ae1 | 62 | */ |
b91c4601 | 63 | virtual wxWindow* GetControl() = 0; |
23324ae1 FM |
64 | |
65 | /** | |
968f15e2 BP |
66 | The derived class must implement this to return string representation |
67 | of the value. | |
23324ae1 | 68 | */ |
b91c4601 | 69 | virtual wxString GetStringValue() const = 0; |
23324ae1 FM |
70 | |
71 | /** | |
968f15e2 BP |
72 | The derived class must implement this to initialize its internal |
73 | variables. This method is called immediately after construction | |
74 | finishes. m_combo member variable has been initialized before the call. | |
23324ae1 | 75 | */ |
968f15e2 | 76 | virtual void Init(); |
23324ae1 FM |
77 | |
78 | /** | |
79 | Utility method that returns @true if Create has been called. | |
968f15e2 | 80 | |
23324ae1 FM |
81 | Useful in conjunction with LazyCreate(). |
82 | */ | |
328f5751 | 83 | bool IsCreated() const; |
23324ae1 FM |
84 | |
85 | /** | |
968f15e2 BP |
86 | The derived class may implement this to return @true if it wants to |
87 | delay call to Create() until the popup is shown for the first time. It | |
88 | is more efficient, but on the other hand it is often more convenient to | |
89 | have the control created immediately. | |
3c4f71cc | 90 | |
23324ae1 FM |
91 | @remarks Base implementation returns @false. |
92 | */ | |
968f15e2 | 93 | virtual bool LazyCreate(); |
23324ae1 FM |
94 | |
95 | /** | |
968f15e2 BP |
96 | The derived class may implement this to do something when the parent |
97 | wxComboCtrl gets double-clicked. | |
23324ae1 | 98 | */ |
968f15e2 | 99 | virtual void OnComboDoubleClick(); |
23324ae1 FM |
100 | |
101 | /** | |
968f15e2 BP |
102 | The derived class may implement this to receive key events from the |
103 | parent wxComboCtrl. | |
104 | ||
23324ae1 FM |
105 | Events not handled should be skipped, as usual. |
106 | */ | |
968f15e2 | 107 | virtual void OnComboKeyEvent(wxKeyEvent& event); |
23324ae1 FM |
108 | |
109 | /** | |
968f15e2 BP |
110 | The derived class may implement this to do special processing when |
111 | popup is hidden. | |
23324ae1 | 112 | */ |
968f15e2 | 113 | virtual void OnDismiss(); |
23324ae1 FM |
114 | |
115 | /** | |
968f15e2 BP |
116 | The derived class may implement this to do special processing when |
117 | popup is shown. | |
23324ae1 | 118 | */ |
968f15e2 | 119 | virtual void OnPopup(); |
23324ae1 FM |
120 | |
121 | /** | |
968f15e2 BP |
122 | The derived class may implement this to paint the parent wxComboCtrl. |
123 | ||
23324ae1 FM |
124 | Default implementation draws value as string. |
125 | */ | |
968f15e2 | 126 | virtual void PaintComboControl(wxDC& dc, const wxRect& rect); |
23324ae1 FM |
127 | |
128 | /** | |
968f15e2 BP |
129 | The derived class must implement this to receive string value changes |
130 | from wxComboCtrl. | |
23324ae1 | 131 | */ |
968f15e2 | 132 | virtual void SetStringValue(const wxString& value); |
23324ae1 FM |
133 | |
134 | /** | |
968f15e2 BP |
135 | Parent wxComboCtrl. This is parameter has been prepared before Init() |
136 | is called. | |
23324ae1 | 137 | */ |
968f15e2 | 138 | wxComboCtrl m_combo; |
23324ae1 FM |
139 | }; |
140 | ||
141 | ||
e54c96f1 | 142 | |
968f15e2 BP |
143 | /** |
144 | Features enabled for wxComboCtrl. | |
145 | ||
146 | @see wxComboCtrl::GetFeatures() | |
147 | */ | |
148 | struct wxComboCtrlFeatures | |
149 | { | |
150 | enum | |
151 | { | |
152 | MovableButton = 0x0001, ///< Button can be on either side of control. | |
153 | BitmapButton = 0x0002, ///< Button may be replaced with bitmap. | |
154 | ButtonSpacing = 0x0004, ///< Button can have spacing from the edge | |
155 | ///< of the control. | |
156 | TextIndent = 0x0008, ///< wxComboCtrl::SetTextIndent() can be used. | |
157 | PaintControl = 0x0010, ///< Combo control itself can be custom painted. | |
158 | PaintWritable = 0x0020, ///< A variable-width area in front of writable | |
159 | ///< combo control's textctrl can be custom | |
160 | ///< painted. | |
161 | Borderless = 0x0040, ///< wxNO_BORDER window style works. | |
162 | ||
163 | All = MovableButton | BitmapButton | ButtonSpacing | | |
164 | TextIndent | PaintControl | PaintWritable | | |
165 | Borderless ///< All features. | |
166 | }; | |
167 | }; | |
168 | ||
169 | ||
23324ae1 FM |
170 | /** |
171 | @class wxComboCtrl | |
7c913512 | 172 | |
968f15e2 BP |
173 | A combo control is a generic combobox that allows totally custom popup. In |
174 | addition it has other customization features. For instance, position and | |
175 | size of the dropdown button can be changed. | |
1f1d2182 | 176 | |
968f15e2 | 177 | @section comboctrl_custompopup Setting Custom Popup for wxComboCtrl |
1f1d2182 FM |
178 | |
179 | wxComboCtrl needs to be told somehow which control to use and this is done | |
968f15e2 BP |
180 | by SetPopupControl(). However, we need something more than just a wxControl |
181 | in this method as, for example, we need to call | |
182 | SetStringValue("initial text value") and wxControl doesn't have such | |
183 | method. So we also need a wxComboPopup which is an interface which must be | |
184 | implemented by a control to be usable as a popup. | |
1f1d2182 FM |
185 | |
186 | We couldn't derive wxComboPopup from wxControl as this would make it | |
187 | impossible to have a class deriving from a wxWidgets control and from it, | |
188 | so instead it is just a mix-in. | |
189 | ||
190 | Here's a minimal sample of wxListView popup: | |
191 | ||
192 | @code | |
193 | #include <wx/combo.h> | |
194 | #include <wx/listctrl.h> | |
195 | ||
968f15e2 | 196 | class wxListViewComboPopup : public wxListView, public wxComboPopup |
1f1d2182 FM |
197 | { |
198 | public: | |
1f1d2182 FM |
199 | // Initialize member variables |
200 | virtual void Init() | |
201 | { | |
202 | m_value = -1; | |
203 | } | |
204 | ||
205 | // Create popup control | |
206 | virtual bool Create(wxWindow* parent) | |
207 | { | |
208 | return wxListView::Create(parent,1,wxPoint(0,0),wxDefaultSize); | |
209 | } | |
210 | ||
211 | // Return pointer to the created control | |
212 | virtual wxWindow *GetControl() { return this; } | |
213 | ||
214 | // Translate string into a list selection | |
215 | virtual void SetStringValue(const wxString& s) | |
216 | { | |
217 | int n = wxListView::FindItem(-1,s); | |
218 | if ( n >= 0 && n < wxListView::GetItemCount() ) | |
219 | wxListView::Select(n); | |
220 | } | |
221 | ||
222 | // Get list selection as a string | |
223 | virtual wxString GetStringValue() const | |
224 | { | |
225 | if ( m_value >= 0 ) | |
968f15e2 | 226 | return wxListView::GetItemText(m_value); |
1f1d2182 FM |
227 | return wxEmptyString; |
228 | } | |
229 | ||
230 | // Do mouse hot-tracking (which is typical in list popups) | |
231 | void OnMouseMove(wxMouseEvent& event) | |
232 | { | |
233 | // TODO: Move selection to cursor | |
234 | } | |
235 | ||
236 | // On mouse left up, set the value and close the popup | |
237 | void OnMouseClick(wxMouseEvent& WXUNUSED(event)) | |
238 | { | |
239 | m_value = wxListView::GetFirstSelected(); | |
240 | ||
241 | // TODO: Send event as well | |
242 | ||
243 | Dismiss(); | |
244 | } | |
245 | ||
246 | protected: | |
968f15e2 BP |
247 | |
248 | int m_value; // current item index | |
1f1d2182 FM |
249 | |
250 | private: | |
251 | DECLARE_EVENT_TABLE() | |
252 | }; | |
253 | ||
254 | BEGIN_EVENT_TABLE(wxListViewComboPopup, wxListView) | |
255 | EVT_MOTION(wxListViewComboPopup::OnMouseMove) | |
256 | EVT_LEFT_UP(wxListViewComboPopup::OnMouseClick) | |
257 | END_EVENT_TABLE() | |
258 | @endcode | |
259 | ||
260 | Here's how you would create and populate it in a dialog constructor: | |
261 | ||
262 | @code | |
968f15e2 | 263 | wxComboCtrl* comboCtrl = new wxComboCtrl(this, wxID_ANY, wxEmptyString); |
1f1d2182 FM |
264 | |
265 | wxListViewComboPopup* popupCtrl = new wxListViewComboPopup(); | |
266 | ||
5bc244b8 | 267 | // It is important to call SetPopupControl() as soon as possible |
1f1d2182 FM |
268 | comboCtrl->SetPopupControl(popupCtrl); |
269 | ||
270 | // Populate using wxListView methods | |
968f15e2 BP |
271 | popupCtrl->InsertItem(popupCtrl->GetItemCount(), "First Item"); |
272 | popupCtrl->InsertItem(popupCtrl->GetItemCount(), "Second Item"); | |
273 | popupCtrl->InsertItem(popupCtrl->GetItemCount(), "Third Item"); | |
1f1d2182 | 274 | @endcode |
7c913512 | 275 | |
23324ae1 | 276 | @beginStyleTable |
8c6791e4 | 277 | @style{wxCB_READONLY} |
23324ae1 | 278 | Text will not be editable. |
8c6791e4 | 279 | @style{wxCB_SORT} |
23324ae1 | 280 | Sorts the entries in the list alphabetically. |
8c6791e4 | 281 | @style{wxTE_PROCESS_ENTER} |
23324ae1 FM |
282 | The control will generate the event wxEVT_COMMAND_TEXT_ENTER |
283 | (otherwise pressing Enter key is either processed internally by the | |
284 | control or used for navigation between dialog controls). Windows | |
285 | only. | |
8c6791e4 | 286 | @style{wxCC_SPECIAL_DCLICK} |
23324ae1 FM |
287 | Double-clicking triggers a call to popup's OnComboDoubleClick. |
288 | Actual behaviour is defined by a derived class. For instance, | |
289 | wxOwnerDrawnComboBox will cycle an item. This style only applies if | |
290 | wxCB_READONLY is used as well. | |
8c6791e4 | 291 | @style{wxCC_STD_BUTTON} |
23324ae1 FM |
292 | Drop button will behave more like a standard push button. |
293 | @endStyleTable | |
7c913512 | 294 | |
3051a44a | 295 | @beginEventEmissionTable{wxCommandEvent} |
8c6791e4 | 296 | @event{EVT_TEXT(id, func)} |
23324ae1 | 297 | Process a wxEVT_COMMAND_TEXT_UPDATED event, when the text changes. |
8c6791e4 | 298 | @event{EVT_TEXT_ENTER(id, func)} |
23324ae1 FM |
299 | Process a wxEVT_COMMAND_TEXT_ENTER event, when RETURN is pressed in |
300 | the combo control. | |
301 | @endEventTable | |
7c913512 | 302 | |
23324ae1 FM |
303 | @library{wxbase} |
304 | @category{ctrl} | |
7e59b885 | 305 | @appearance{comboctrl.png} |
7c913512 | 306 | |
968f15e2 BP |
307 | @see wxComboBox, wxChoice, wxOwnerDrawnComboBox, wxComboPopup, |
308 | wxCommandEvent | |
23324ae1 FM |
309 | */ |
310 | class wxComboCtrl : public wxControl | |
311 | { | |
312 | public: | |
968f15e2 BP |
313 | /** |
314 | Default constructor. | |
315 | */ | |
316 | wxComboCtrl(); | |
317 | ||
23324ae1 FM |
318 | /** |
319 | Constructor, creating and showing a combo control. | |
3c4f71cc | 320 | |
7c913512 | 321 | @param parent |
4cc4bfaf | 322 | Parent window. Must not be @NULL. |
7c913512 | 323 | @param id |
4cc4bfaf | 324 | Window identifier. The value wxID_ANY indicates a default value. |
7c913512 | 325 | @param value |
4cc4bfaf | 326 | Initial selection string. An empty string indicates no selection. |
7c913512 | 327 | @param pos |
4cc4bfaf | 328 | Window position. |
7c913512 | 329 | @param size |
968f15e2 | 330 | Window size. If wxDefaultSize is specified then the window is sized |
4cc4bfaf | 331 | appropriately. |
7c913512 | 332 | @param style |
4cc4bfaf | 333 | Window style. See wxComboCtrl. |
7c913512 | 334 | @param validator |
4cc4bfaf | 335 | Window validator. |
7c913512 | 336 | @param name |
4cc4bfaf | 337 | Window name. |
3c4f71cc | 338 | |
4cc4bfaf | 339 | @see Create(), wxValidator |
23324ae1 | 340 | */ |
4707b84c FM |
341 | wxComboCtrl(wxWindow* parent, wxWindowID id = wxID_ANY, |
342 | const wxString& value = wxEmptyString, | |
7c913512 FM |
343 | const wxPoint& pos = wxDefaultPosition, |
344 | const wxSize& size = wxDefaultSize, | |
345 | long style = 0, | |
346 | const wxValidator& validator = wxDefaultValidator, | |
9d9c1c24 | 347 | const wxString& name = wxComboBoxNameStr); |
23324ae1 FM |
348 | |
349 | /** | |
350 | Destructor, destroying the combo control. | |
351 | */ | |
968f15e2 | 352 | virtual ~wxComboCtrl(); |
23324ae1 | 353 | |
23324ae1 FM |
354 | /** |
355 | Copies the selected text to the clipboard. | |
356 | */ | |
968f15e2 | 357 | virtual void Copy(); |
23324ae1 FM |
358 | |
359 | /** | |
360 | Creates the combo control for two-step construction. Derived classes | |
968f15e2 BP |
361 | should call or replace this function. See wxComboCtrl() for further |
362 | details. | |
23324ae1 | 363 | */ |
4707b84c FM |
364 | bool Create(wxWindow* parent, wxWindowID id = wxID_ANY, |
365 | const wxString& value = wxEmptyString, | |
23324ae1 FM |
366 | const wxPoint& pos = wxDefaultPosition, |
367 | const wxSize& size = wxDefaultSize, | |
368 | long style = 0, | |
369 | const wxValidator& validator = wxDefaultValidator, | |
9d9c1c24 | 370 | const wxString& name = wxComboBoxNameStr); |
23324ae1 FM |
371 | |
372 | /** | |
373 | Copies the selected text to the clipboard and removes the selection. | |
374 | */ | |
968f15e2 | 375 | virtual void Cut(); |
23324ae1 | 376 | |
23324ae1 FM |
377 | /** |
378 | Enables or disables popup animation, if any, depending on the value of | |
379 | the argument. | |
380 | */ | |
4cc4bfaf | 381 | void EnablePopupAnimation(bool enable = true); |
23324ae1 FM |
382 | |
383 | /** | |
384 | Returns disabled button bitmap that has been set with | |
385 | SetButtonBitmaps(). | |
3c4f71cc | 386 | |
d29a9a8a | 387 | @return A reference to the disabled state bitmap. |
23324ae1 | 388 | */ |
4707b84c | 389 | const wxBitmap& GetBitmapDisabled() const; |
23324ae1 FM |
390 | |
391 | /** | |
392 | Returns button mouse hover bitmap that has been set with | |
393 | SetButtonBitmaps(). | |
3c4f71cc | 394 | |
d29a9a8a | 395 | @return A reference to the mouse hover state bitmap. |
23324ae1 | 396 | */ |
4707b84c | 397 | const wxBitmap& GetBitmapHover() const; |
23324ae1 FM |
398 | |
399 | /** | |
400 | Returns default button bitmap that has been set with | |
401 | SetButtonBitmaps(). | |
3c4f71cc | 402 | |
d29a9a8a | 403 | @return A reference to the normal state bitmap. |
23324ae1 | 404 | */ |
4707b84c | 405 | const wxBitmap& GetBitmapNormal() const; |
23324ae1 FM |
406 | |
407 | /** | |
408 | Returns depressed button bitmap that has been set with | |
409 | SetButtonBitmaps(). | |
3c4f71cc | 410 | |
d29a9a8a | 411 | @return A reference to the depressed state bitmap. |
23324ae1 | 412 | */ |
4707b84c | 413 | const wxBitmap& GetBitmapPressed() const; |
23324ae1 FM |
414 | |
415 | /** | |
416 | Returns current size of the dropdown button. | |
417 | */ | |
418 | wxSize GetButtonSize(); | |
419 | ||
420 | /** | |
421 | Returns custom painted area in control. | |
3c4f71cc | 422 | |
4cc4bfaf | 423 | @see SetCustomPaintWidth(). |
23324ae1 | 424 | */ |
328f5751 | 425 | int GetCustomPaintWidth() const; |
23324ae1 FM |
426 | |
427 | /** | |
968f15e2 BP |
428 | Returns features supported by wxComboCtrl. If needed feature is |
429 | missing, you need to instead use wxGenericComboCtrl, which however may | |
430 | lack a native look and feel (but otherwise sports identical API). | |
3c4f71cc | 431 | |
d29a9a8a BP |
432 | @return Value returned is a combination of the flags defined in |
433 | wxComboCtrlFeatures. | |
23324ae1 FM |
434 | */ |
435 | static int GetFeatures(); | |
436 | ||
437 | /** | |
438 | Returns the insertion point for the combo control's text field. | |
968f15e2 BP |
439 | |
440 | @note Under Windows, this function always returns 0 if the combo | |
441 | control doesn't have the focus. | |
23324ae1 | 442 | */ |
968f15e2 | 443 | virtual long GetInsertionPoint() const; |
23324ae1 FM |
444 | |
445 | /** | |
446 | Returns the last position in the combo control text field. | |
447 | */ | |
968f15e2 | 448 | virtual long GetLastPosition() const; |
23324ae1 FM |
449 | |
450 | /** | |
968f15e2 BP |
451 | Returns current popup interface that has been set with |
452 | SetPopupControl(). | |
23324ae1 FM |
453 | */ |
454 | wxComboPopup* GetPopupControl(); | |
455 | ||
456 | /** | |
457 | Returns popup window containing the popup control. | |
458 | */ | |
328f5751 | 459 | wxWindow* GetPopupWindow() const; |
23324ae1 FM |
460 | |
461 | /** | |
462 | Get the text control which is part of the combo control. | |
463 | */ | |
328f5751 | 464 | wxTextCtrl* GetTextCtrl() const; |
23324ae1 FM |
465 | |
466 | /** | |
467 | Returns actual indentation in pixels. | |
468 | */ | |
328f5751 | 469 | wxCoord GetTextIndent() const; |
23324ae1 FM |
470 | |
471 | /** | |
472 | Returns area covered by the text field (includes everything except | |
473 | borders and the dropdown button). | |
474 | */ | |
4707b84c | 475 | const wxRect& GetTextRect() const; |
23324ae1 FM |
476 | |
477 | /** | |
968f15e2 BP |
478 | Returns text representation of the current value. For writable combo |
479 | control it always returns the value in the text field. | |
23324ae1 | 480 | */ |
968f15e2 | 481 | virtual wxString GetValue() const; |
23324ae1 FM |
482 | |
483 | /** | |
484 | Dismisses the popup window. | |
485 | */ | |
968f15e2 | 486 | virtual void HidePopup(); |
23324ae1 FM |
487 | |
488 | /** | |
489 | Returns @true if the popup is currently shown | |
490 | */ | |
328f5751 | 491 | bool IsPopupShown() const; |
23324ae1 FM |
492 | |
493 | /** | |
968f15e2 BP |
494 | Returns @true if the popup window is in the given state. Possible |
495 | values are: | |
3c4f71cc | 496 | |
968f15e2 BP |
497 | @beginTable |
498 | @row2col{wxComboCtrl::Hidden, Popup window is hidden.} | |
499 | @row2col{wxComboCtrl::Animating, Popup window is being shown, but the | |
500 | popup animation has not yet finished.} | |
501 | @row2col{wxComboCtrl::Visible, Popup window is fully visible.} | |
502 | @endTable | |
23324ae1 | 503 | */ |
328f5751 | 504 | bool IsPopupWindowState(int state) const; |
23324ae1 FM |
505 | |
506 | /** | |
968f15e2 BP |
507 | Implement in a derived class to define what happens on dropdown button |
508 | click. Default action is to show the popup. | |
509 | ||
510 | @note If you implement this to do something else than show the popup, | |
511 | you must then also implement DoSetPopupControl() to always return | |
512 | @NULL. | |
23324ae1 | 513 | */ |
968f15e2 | 514 | virtual void OnButtonClick(); |
23324ae1 FM |
515 | |
516 | /** | |
517 | Pastes text from the clipboard to the text field. | |
518 | */ | |
968f15e2 | 519 | virtual void Paste(); |
23324ae1 FM |
520 | |
521 | /** | |
968f15e2 BP |
522 | Removes the text between the two positions in the combo control text |
523 | field. | |
3c4f71cc | 524 | |
7c913512 | 525 | @param from |
4cc4bfaf | 526 | The first position. |
7c913512 | 527 | @param to |
4cc4bfaf | 528 | The last position. |
23324ae1 | 529 | */ |
968f15e2 | 530 | virtual void Remove(long from, long to); |
23324ae1 FM |
531 | |
532 | /** | |
968f15e2 BP |
533 | Replaces the text between two positions with the given text, in the |
534 | combo control text field. | |
3c4f71cc | 535 | |
7c913512 | 536 | @param from |
4cc4bfaf | 537 | The first position. |
7c913512 | 538 | @param to |
4cc4bfaf | 539 | The second position. |
7c913512 | 540 | @param text |
4cc4bfaf | 541 | The text to insert. |
23324ae1 | 542 | */ |
45a591fa | 543 | virtual void Replace(long from, long to, const wxString& text); |
23324ae1 FM |
544 | |
545 | /** | |
546 | Sets custom dropdown button graphics. | |
3c4f71cc | 547 | |
7c913512 | 548 | @param bmpNormal |
4cc4bfaf | 549 | Default button image. |
7c913512 | 550 | @param pushButtonBg |
968f15e2 | 551 | If @true, blank push button background is painted below the image. |
7c913512 | 552 | @param bmpPressed |
4cc4bfaf | 553 | Depressed button image. |
7c913512 | 554 | @param bmpHover |
968f15e2 BP |
555 | Button image when mouse hovers above it. This should be ignored on |
556 | platforms and themes that do not generally draw different kind of | |
557 | button on mouse hover. | |
7c913512 | 558 | @param bmpDisabled |
4cc4bfaf | 559 | Disabled button image. |
23324ae1 FM |
560 | */ |
561 | void SetButtonBitmaps(const wxBitmap& bmpNormal, | |
4cc4bfaf | 562 | bool pushButtonBg = false, |
23324ae1 FM |
563 | const wxBitmap& bmpPressed = wxNullBitmap, |
564 | const wxBitmap& bmpHover = wxNullBitmap, | |
565 | const wxBitmap& bmpDisabled = wxNullBitmap); | |
566 | ||
567 | /** | |
568 | Sets size and position of dropdown button. | |
3c4f71cc | 569 | |
7c913512 | 570 | @param width |
4cc4bfaf | 571 | Button width. Value = 0 specifies default. |
7c913512 | 572 | @param height |
4cc4bfaf | 573 | Button height. Value = 0 specifies default. |
7c913512 | 574 | @param side |
968f15e2 BP |
575 | Indicates which side the button will be placed. Value can be wxLEFT |
576 | or wxRIGHT. | |
7c913512 | 577 | @param spacingX |
4cc4bfaf | 578 | Horizontal spacing around the button. Default is 0. |
23324ae1 FM |
579 | */ |
580 | void SetButtonPosition(int width = -1, int height = -1, | |
968f15e2 | 581 | int side = wxRIGHT, int spacingX = 0); |
23324ae1 FM |
582 | |
583 | /** | |
968f15e2 BP |
584 | Set width, in pixels, of custom painted area in control without |
585 | @c wxCB_READONLY style. In read-only wxOwnerDrawnComboBox, this is used | |
23324ae1 FM |
586 | to indicate area that is not covered by the focus rectangle. |
587 | */ | |
588 | void SetCustomPaintWidth(int width); | |
589 | ||
590 | /** | |
591 | Sets the insertion point in the text field. | |
3c4f71cc | 592 | |
7c913512 | 593 | @param pos |
4cc4bfaf | 594 | The new insertion point. |
23324ae1 | 595 | */ |
968f15e2 | 596 | virtual void SetInsertionPoint(long pos); |
23324ae1 FM |
597 | |
598 | /** | |
599 | Sets the insertion point at the end of the combo control text field. | |
600 | */ | |
968f15e2 | 601 | virtual void SetInsertionPointEnd(); |
23324ae1 FM |
602 | |
603 | /** | |
968f15e2 BP |
604 | Set side of the control to which the popup will align itself. Valid |
605 | values are @c wxLEFT, @c wxRIGHT and 0. The default value 0 means that | |
606 | the most appropriate side is used (which, currently, is always | |
607 | @c wxLEFT). | |
23324ae1 FM |
608 | */ |
609 | void SetPopupAnchor(int anchorSide); | |
610 | ||
611 | /** | |
968f15e2 BP |
612 | Set popup interface class derived from wxComboPopup. This method should |
613 | be called as soon as possible after the control has been created, | |
614 | unless OnButtonClick() has been overridden. | |
23324ae1 FM |
615 | */ |
616 | void SetPopupControl(wxComboPopup* popup); | |
617 | ||
618 | /** | |
968f15e2 BP |
619 | Extends popup size horizontally, relative to the edges of the combo |
620 | control. | |
3c4f71cc | 621 | |
7c913512 | 622 | @param extLeft |
968f15e2 BP |
623 | How many pixel to extend beyond the left edge of the control. |
624 | Default is 0. | |
7c913512 | 625 | @param extRight |
968f15e2 BP |
626 | How many pixel to extend beyond the right edge of the control. |
627 | Default is 0. | |
3c4f71cc | 628 | |
968f15e2 BP |
629 | @remarks Popup minimum width may override arguments. It is up to the |
630 | popup to fully take this into account. | |
23324ae1 FM |
631 | */ |
632 | void SetPopupExtents(int extLeft, int extRight); | |
633 | ||
634 | /** | |
635 | Sets preferred maximum height of the popup. | |
3c4f71cc | 636 | |
23324ae1 FM |
637 | @remarks Value -1 indicates the default. |
638 | */ | |
639 | void SetPopupMaxHeight(int height); | |
640 | ||
641 | /** | |
968f15e2 BP |
642 | Sets minimum width of the popup. If wider than combo control, it will |
643 | extend to the left. | |
3c4f71cc | 644 | |
968f15e2 BP |
645 | @remarks Value -1 indicates the default. Also, popup implementation may |
646 | choose to ignore this. | |
23324ae1 FM |
647 | */ |
648 | void SetPopupMinWidth(int width); | |
649 | ||
650 | /** | |
968f15e2 BP |
651 | Selects the text between the two positions, in the combo control text |
652 | field. | |
3c4f71cc | 653 | |
7c913512 | 654 | @param from |
4cc4bfaf | 655 | The first position. |
7c913512 | 656 | @param to |
4cc4bfaf | 657 | The second position. |
23324ae1 | 658 | */ |
968f15e2 | 659 | virtual void SetSelection(long from, long to); |
23324ae1 FM |
660 | |
661 | /** | |
968f15e2 BP |
662 | Sets the text for the text field without affecting the popup. Thus, |
663 | unlike SetValue(), it works equally well with combo control using | |
664 | @c wxCB_READONLY style. | |
23324ae1 FM |
665 | */ |
666 | void SetText(const wxString& value); | |
667 | ||
668 | /** | |
968f15e2 BP |
669 | This will set the space in pixels between left edge of the control and |
670 | the text, regardless whether control is read-only or not. Value -1 can | |
671 | be given to indicate platform default. | |
23324ae1 FM |
672 | */ |
673 | void SetTextIndent(int indent); | |
674 | ||
675 | /** | |
676 | Sets the text for the combo control text field. | |
968f15e2 BP |
677 | |
678 | @note For a combo control with @c wxCB_READONLY style the string must | |
679 | be accepted by the popup (for instance, exist in the dropdown | |
680 | list), otherwise the call to SetValue() is ignored. | |
23324ae1 | 681 | */ |
968f15e2 | 682 | virtual void SetValue(const wxString& value); |
23324ae1 FM |
683 | |
684 | /** | |
968f15e2 BP |
685 | Same as SetValue(), but also sends wxCommandEvent of type |
686 | wxEVT_COMMAND_TEXT_UPDATED if @a withEvent is @true. | |
23324ae1 | 687 | */ |
968f15e2 | 688 | void SetValueWithEvent(const wxString& value, bool withEvent = true); |
23324ae1 FM |
689 | |
690 | /** | |
691 | Show the popup. | |
692 | */ | |
968f15e2 | 693 | virtual void ShowPopup(); |
23324ae1 FM |
694 | |
695 | /** | |
696 | Undoes the last edit in the text field. Windows only. | |
697 | */ | |
968f15e2 | 698 | virtual void Undo(); |
23324ae1 FM |
699 | |
700 | /** | |
968f15e2 BP |
701 | Enable or disable usage of an alternative popup window, which |
702 | guarantees ability to focus the popup control, and allows common native | |
703 | controls to function normally. This alternative popup window is usually | |
704 | a wxDialog, and as such, when it is shown, its parent top-level window | |
705 | will appear as if the focus has been lost from it. | |
23324ae1 | 706 | */ |
4cc4bfaf | 707 | void UseAltPopupWindow(bool enable = true); |
b91c4601 FM |
708 | |
709 | protected: | |
710 | ||
711 | /** | |
712 | This member function is not normally called in application code. | |
713 | Instead, it can be implemented in a derived class to create a custom | |
714 | popup animation. | |
715 | ||
716 | The parameters are the same as those for DoShowPopup(). | |
717 | ||
718 | @return @true if animation finishes before the function returns, | |
719 | @false otherwise. In the latter case you need to manually call | |
720 | DoShowPopup() after the animation ends. | |
721 | */ | |
722 | virtual bool AnimateShow(const wxRect& rect, int flags); | |
723 | ||
724 | /** | |
725 | This member function is not normally called in application code. | |
726 | Instead, it can be implemented in a derived class to return default | |
727 | wxComboPopup, incase @a popup is @NULL. | |
728 | ||
729 | @note If you have implemented OnButtonClick() to do something else than | |
730 | show the popup, then DoSetPopupControl() must always set @a popup | |
731 | to @NULL. | |
732 | */ | |
733 | virtual void DoSetPopupControl(wxComboPopup* popup); | |
734 | ||
735 | /** | |
736 | This member function is not normally called in application code. | |
737 | Instead, it must be called in a derived class to make sure popup is | |
738 | properly shown after a popup animation has finished (but only if | |
739 | AnimateShow() did not finish the animation within its function scope). | |
740 | ||
741 | @param rect | |
742 | Position to show the popup window at, in screen coordinates. | |
743 | @param flags | |
744 | Combination of any of the following: | |
745 | @beginTable | |
746 | @row2col{wxComboCtrl::ShowAbove, | |
747 | Popup is shown above the control instead of below.} | |
748 | @row2col{wxComboCtrl::CanDeferShow, | |
749 | Showing the popup can be deferred to happen sometime after | |
750 | ShowPopup() has finished. In this case, AnimateShow() must | |
751 | return false.} | |
752 | @endTable | |
753 | */ | |
754 | virtual void DoShowPopup(const wxRect& rect, int flags); | |
23324ae1 | 755 | }; |
e54c96f1 | 756 |