don't save the initial selection if it's invalid in CBN_DROPDOWN (refixes #8474 witho...
[wxWidgets.git] / src / msw / combobox.cpp
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/msw/combobox.cpp
3 // Purpose: wxComboBox class
4 // Author: Julian Smart
5 // Modified by:
6 // Created: 01/02/97
7 // RCS-ID: $Id$
8 // Copyright: (c) Julian Smart
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
11
12 // ============================================================================
13 // declarations
14 // ============================================================================
15
16 // ----------------------------------------------------------------------------
17 // headers
18 // ----------------------------------------------------------------------------
19
20 // For compilers that support precompilation, includes "wx.h".
21 #include "wx/wxprec.h"
22
23 #ifdef __BORLANDC__
24 #pragma hdrstop
25 #endif
26
27 #if wxUSE_COMBOBOX
28
29 #include "wx/combobox.h"
30
31 #ifndef WX_PRECOMP
32 #include "wx/msw/wrapcctl.h" // include <commctrl.h> "properly"
33 #include "wx/settings.h"
34 #include "wx/log.h"
35 // for wxEVT_COMMAND_TEXT_ENTER
36 #include "wx/textctrl.h"
37 #include "wx/app.h"
38 #include "wx/brush.h"
39 #endif
40
41 #include "wx/clipbrd.h"
42 #include "wx/msw/private.h"
43
44 #if wxUSE_TOOLTIPS
45 #include "wx/tooltip.h"
46 #endif // wxUSE_TOOLTIPS
47
48 // ----------------------------------------------------------------------------
49 // wxWin macros
50 // ----------------------------------------------------------------------------
51
52 #if wxUSE_EXTENDED_RTTI
53 WX_DEFINE_FLAGS( wxComboBoxStyle )
54
55 wxBEGIN_FLAGS( wxComboBoxStyle )
56 // new style border flags, we put them first to
57 // use them for streaming out
58 wxFLAGS_MEMBER(wxBORDER_SIMPLE)
59 wxFLAGS_MEMBER(wxBORDER_SUNKEN)
60 wxFLAGS_MEMBER(wxBORDER_DOUBLE)
61 wxFLAGS_MEMBER(wxBORDER_RAISED)
62 wxFLAGS_MEMBER(wxBORDER_STATIC)
63 wxFLAGS_MEMBER(wxBORDER_NONE)
64
65 // old style border flags
66 wxFLAGS_MEMBER(wxSIMPLE_BORDER)
67 wxFLAGS_MEMBER(wxSUNKEN_BORDER)
68 wxFLAGS_MEMBER(wxDOUBLE_BORDER)
69 wxFLAGS_MEMBER(wxRAISED_BORDER)
70 wxFLAGS_MEMBER(wxSTATIC_BORDER)
71 wxFLAGS_MEMBER(wxBORDER)
72
73 // standard window styles
74 wxFLAGS_MEMBER(wxTAB_TRAVERSAL)
75 wxFLAGS_MEMBER(wxCLIP_CHILDREN)
76 wxFLAGS_MEMBER(wxTRANSPARENT_WINDOW)
77 wxFLAGS_MEMBER(wxWANTS_CHARS)
78 wxFLAGS_MEMBER(wxFULL_REPAINT_ON_RESIZE)
79 wxFLAGS_MEMBER(wxALWAYS_SHOW_SB )
80 wxFLAGS_MEMBER(wxVSCROLL)
81 wxFLAGS_MEMBER(wxHSCROLL)
82
83 wxFLAGS_MEMBER(wxCB_SIMPLE)
84 wxFLAGS_MEMBER(wxCB_SORT)
85 wxFLAGS_MEMBER(wxCB_READONLY)
86 wxFLAGS_MEMBER(wxCB_DROPDOWN)
87
88 wxEND_FLAGS( wxComboBoxStyle )
89
90 IMPLEMENT_DYNAMIC_CLASS_XTI(wxComboBox, wxChoice,"wx/combobox.h")
91
92 wxBEGIN_PROPERTIES_TABLE(wxComboBox)
93 wxEVENT_PROPERTY( Select , wxEVT_COMMAND_COMBOBOX_SELECTED , wxCommandEvent )
94 wxEVENT_PROPERTY( TextEnter , wxEVT_COMMAND_TEXT_ENTER , wxCommandEvent )
95
96 // TODO DELEGATES
97 wxPROPERTY( Font , wxFont , SetFont , GetFont , EMPTY_MACROVALUE , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
98 wxPROPERTY_COLLECTION( Choices , wxArrayString , wxString , AppendString , GetStrings , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
99 wxPROPERTY( Value ,wxString, SetValue, GetValue, EMPTY_MACROVALUE , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
100 wxPROPERTY( Selection ,int, SetSelection, GetSelection, EMPTY_MACROVALUE , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
101 wxPROPERTY_FLAGS( WindowStyle , wxComboBoxStyle , long , SetWindowStyleFlag , GetWindowStyleFlag , EMPTY_MACROVALUE , 0 /*flags*/ , wxT("Helpstring") , wxT("group")) // style
102 wxEND_PROPERTIES_TABLE()
103
104 wxBEGIN_HANDLERS_TABLE(wxComboBox)
105 wxEND_HANDLERS_TABLE()
106
107 wxCONSTRUCTOR_5( wxComboBox , wxWindow* , Parent , wxWindowID , Id , wxString , Value , wxPoint , Position , wxSize , Size )
108
109 #else
110
111 IMPLEMENT_DYNAMIC_CLASS(wxComboBox, wxChoice)
112
113 #endif
114
115 BEGIN_EVENT_TABLE(wxComboBox, wxControl)
116 EVT_MENU(wxID_CUT, wxComboBox::OnCut)
117 EVT_MENU(wxID_COPY, wxComboBox::OnCopy)
118 EVT_MENU(wxID_PASTE, wxComboBox::OnPaste)
119 EVT_MENU(wxID_UNDO, wxComboBox::OnUndo)
120 EVT_MENU(wxID_REDO, wxComboBox::OnRedo)
121 EVT_MENU(wxID_CLEAR, wxComboBox::OnDelete)
122 EVT_MENU(wxID_SELECTALL, wxComboBox::OnSelectAll)
123
124 EVT_UPDATE_UI(wxID_CUT, wxComboBox::OnUpdateCut)
125 EVT_UPDATE_UI(wxID_COPY, wxComboBox::OnUpdateCopy)
126 EVT_UPDATE_UI(wxID_PASTE, wxComboBox::OnUpdatePaste)
127 EVT_UPDATE_UI(wxID_UNDO, wxComboBox::OnUpdateUndo)
128 EVT_UPDATE_UI(wxID_REDO, wxComboBox::OnUpdateRedo)
129 EVT_UPDATE_UI(wxID_CLEAR, wxComboBox::OnUpdateDelete)
130 EVT_UPDATE_UI(wxID_SELECTALL, wxComboBox::OnUpdateSelectAll)
131 END_EVENT_TABLE()
132
133 // ----------------------------------------------------------------------------
134 // function prototypes
135 // ----------------------------------------------------------------------------
136
137 LRESULT APIENTRY _EXPORT wxComboEditWndProc(HWND hWnd,
138 UINT message,
139 WPARAM wParam,
140 LPARAM lParam);
141
142 // ---------------------------------------------------------------------------
143 // global vars
144 // ---------------------------------------------------------------------------
145
146 // the pointer to standard radio button wnd proc
147 static WNDPROC gs_wndprocEdit = (WNDPROC)NULL;
148
149 // ============================================================================
150 // implementation
151 // ============================================================================
152
153 // ----------------------------------------------------------------------------
154 // wnd proc for subclassed edit control
155 // ----------------------------------------------------------------------------
156
157 LRESULT APIENTRY _EXPORT wxComboEditWndProc(HWND hWnd,
158 UINT message,
159 WPARAM wParam,
160 LPARAM lParam)
161 {
162 HWND hwndCombo = ::GetParent(hWnd);
163 wxWindow *win = wxFindWinFromHandle((WXHWND)hwndCombo);
164
165 switch ( message )
166 {
167 // forward some messages to the combobox to generate the appropriate
168 // wxEvents from them
169 case WM_KEYUP:
170 case WM_KEYDOWN:
171 case WM_CHAR:
172 case WM_SYSCHAR:
173 case WM_SYSKEYDOWN:
174 case WM_SYSKEYUP:
175 case WM_SETFOCUS:
176 case WM_KILLFOCUS:
177 {
178 wxComboBox *combo = wxDynamicCast(win, wxComboBox);
179 if ( !combo )
180 {
181 // we can get WM_KILLFOCUS while our parent is already half
182 // destroyed and hence doesn't look like a combobx any
183 // longer, check for it to avoid bogus assert failures
184 if ( !win->IsBeingDeleted() )
185 {
186 wxFAIL_MSG( _T("should have combo as parent") );
187 }
188 }
189 else if ( combo->MSWProcessEditMsg(message, wParam, lParam) )
190 {
191 // handled by parent
192 return 0;
193 }
194 }
195 break;
196
197 case WM_GETDLGCODE:
198 {
199 wxCHECK_MSG( win, 0, _T("should have a parent") );
200
201 if ( win->GetWindowStyle() & wxTE_PROCESS_ENTER )
202 {
203 // need to return a custom dlg code or we'll never get it
204 return DLGC_WANTMESSAGE;
205 }
206 }
207 break;
208 }
209
210 return ::CallWindowProc(CASTWNDPROC gs_wndprocEdit, hWnd, message, wParam, lParam);
211 }
212
213 // ----------------------------------------------------------------------------
214 // wxComboBox callbacks
215 // ----------------------------------------------------------------------------
216
217 WXLRESULT wxComboBox::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam)
218 {
219 // TODO: handle WM_CTLCOLOR messages from our EDIT control to be able to
220 // set its colour correctly (to be the same as our own one)
221
222 switch ( nMsg )
223 {
224 case WM_SIZE:
225 // wxStaticBox can generate this message, when modifying the control's style.
226 // This causes the content of the combobox to be selected, for some reason.
227 case WM_STYLECHANGED:
228 {
229 // combobox selection sometimes spontaneously changes when its
230 // size changes, restore it to the old value if necessary
231 if ( !GetEditHWNDIfAvailable() )
232 break;
233
234 long fromOld, toOld;
235 GetSelection(&fromOld, &toOld);
236 WXLRESULT result = wxChoice::MSWWindowProc(nMsg, wParam, lParam);
237
238 long fromNew, toNew;
239 GetSelection(&fromNew, &toNew);
240
241 if ( fromOld != fromNew || toOld != toNew )
242 {
243 SetSelection(fromOld, toOld);
244 }
245
246 return result;
247 }
248 }
249
250 return wxChoice::MSWWindowProc(nMsg, wParam, lParam);
251 }
252
253 bool wxComboBox::MSWProcessEditMsg(WXUINT msg, WXWPARAM wParam, WXLPARAM lParam)
254 {
255 switch ( msg )
256 {
257 case WM_CHAR:
258 // for compatibility with wxTextCtrl, generate a special message
259 // when Enter is pressed
260 if ( wParam == VK_RETURN )
261 {
262 if (SendMessage(GetHwnd(), CB_GETDROPPEDSTATE, 0, 0))
263 return false;
264
265 wxCommandEvent event(wxEVT_COMMAND_TEXT_ENTER, m_windowId);
266
267 const int sel = GetSelection();
268 event.SetInt(sel);
269 event.SetString(GetValue());
270 InitCommandEventWithItems(event, sel);
271
272 if ( ProcessCommand(event) )
273 {
274 // don't let the event through to the native control
275 // because it doesn't need it and may generate an annoying
276 // beep if it gets it
277 return true;
278 }
279 }
280 // fall through
281
282 case WM_SYSCHAR:
283 return HandleChar(wParam, lParam, true /* isASCII */);
284
285 case WM_SYSKEYDOWN:
286 case WM_KEYDOWN:
287 return HandleKeyDown(wParam, lParam);
288
289 case WM_SYSKEYUP:
290 case WM_KEYUP:
291 return HandleKeyUp(wParam, lParam);
292
293 case WM_SETFOCUS:
294 return HandleSetFocus((WXHWND)wParam);
295
296 case WM_KILLFOCUS:
297 return HandleKillFocus((WXHWND)wParam);
298
299 case WM_CUT:
300 case WM_COPY:
301 case WM_PASTE:
302 return HandleClipboardEvent(msg);
303 }
304
305 return false;
306 }
307
308 bool wxComboBox::MSWCommand(WXUINT param, WXWORD id)
309 {
310 int sel = -1;
311 wxString value;
312
313 switch ( param )
314 {
315 case CBN_DROPDOWN:
316 // remember the last selection, just as wxChoice does
317 m_lastAcceptedSelection = GetCurrentSelection();
318 if ( m_lastAcceptedSelection == -1 )
319 {
320 // but unlike with wxChoice we may have no selection but still
321 // have some text and we should avoid erasing it if the drop
322 // down is cancelled (see #8474)
323 m_lastAcceptedSelection = wxID_NONE;
324 }
325 break;
326
327 case CBN_SELENDOK:
328 #ifndef __SMARTPHONE__
329 // we need to reset this to prevent the selection from being undone
330 // by wxChoice, see wxChoice::MSWCommand() and comments there
331 m_lastAcceptedSelection = wxID_NONE;
332 #endif
333
334 // set these variables so that they could be also fixed in
335 // CBN_EDITCHANGE below
336 sel = GetSelection();
337 value = GetStringSelection();
338
339 // this string is going to become the new combobox value soon but
340 // we need it to be done right now, otherwise the event handler
341 // could get a wrong value when it calls our GetValue()
342 ::SetWindowText(GetHwnd(), value.wx_str());
343
344 {
345 wxCommandEvent event(wxEVT_COMMAND_COMBOBOX_SELECTED, GetId());
346 event.SetInt(sel);
347 event.SetString(value);
348 InitCommandEventWithItems(event, sel);
349
350 ProcessCommand(event);
351 }
352
353 // fall through: for compability with wxGTK, also send the text
354 // update event when the selection changes (this also seems more
355 // logical as the text does change)
356
357 case CBN_EDITCHANGE:
358 if ( m_allowTextEvents )
359 {
360 wxCommandEvent event(wxEVT_COMMAND_TEXT_UPDATED, GetId());
361
362 // if sel != -1, value was already initialized above
363 if ( sel == -1 )
364 {
365 value = wxGetWindowText(GetHwnd());
366 }
367
368 event.SetString(value);
369 InitCommandEventWithItems(event, sel);
370
371 ProcessCommand(event);
372 }
373 break;
374
375 default:
376 return wxChoice::MSWCommand(param, id);
377 }
378
379 // skip wxChoice version as it would generate its own events for
380 // CBN_SELENDOK and also interfere with our handling of CBN_DROPDOWN
381 return true;
382 }
383
384 bool wxComboBox::MSWShouldPreProcessMessage(WXMSG *pMsg)
385 {
386 // prevent command accelerators from stealing editing
387 // hotkeys when we have the focus
388 if (wxIsCtrlDown())
389 {
390 WPARAM vkey = pMsg->wParam;
391
392 switch (vkey)
393 {
394 case 'C':
395 case 'V':
396 case 'X':
397 case VK_INSERT:
398 case VK_DELETE:
399 case VK_HOME:
400 case VK_END:
401 return false;
402 }
403 }
404
405 return wxChoice::MSWShouldPreProcessMessage(pMsg);
406 }
407
408 WXHWND wxComboBox::GetEditHWNDIfAvailable() const
409 {
410 // notice that a slightly safer alternative could be to use FindWindowEx()
411 // but it's not available under WinCE so just take the first child for now
412 // to keep one version of the code for all platforms and fix it later if
413 // problems are discovered
414
415 // we assume that the only child of the combobox is the edit window
416 return (WXHWND)::GetWindow(GetHwnd(), GW_CHILD);
417 }
418
419 WXHWND wxComboBox::GetEditHWND() const
420 {
421 // this function should not be called for wxCB_READONLY controls, it is
422 // the callers responsibility to check this
423 wxASSERT_MSG( !HasFlag(wxCB_READONLY),
424 _T("read-only combobox doesn't have any edit control") );
425
426 WXHWND hWndEdit = GetEditHWNDIfAvailable();
427 wxASSERT_MSG( hWndEdit, _T("combobox without edit control?") );
428
429 return hWndEdit;
430 }
431
432 // ----------------------------------------------------------------------------
433 // wxComboBox creation
434 // ----------------------------------------------------------------------------
435
436 bool wxComboBox::Create(wxWindow *parent, wxWindowID id,
437 const wxString& value,
438 const wxPoint& pos,
439 const wxSize& size,
440 int n, const wxString choices[],
441 long style,
442 const wxValidator& validator,
443 const wxString& name)
444 {
445 // pretend that wxComboBox is hidden while it is positioned and resized and
446 // show it only right before leaving this method because otherwise there is
447 // some noticeable flicker while the control rearranges itself
448 m_isShown = false;
449
450 if ( !CreateAndInit(parent, id, pos, size, n, choices, style,
451 validator, name) )
452 return false;
453
454 // we shouldn't call SetValue() for an empty string because this would
455 // (correctly) result in an assert with a read only combobox and is useless
456 // for the other ones anyhow
457 if ( !value.empty() )
458 SetValue(value);
459
460 // a (not read only) combobox is, in fact, 2 controls: the combobox itself
461 // and an edit control inside it and if we want to catch events from this
462 // edit control, we must subclass it as well
463 if ( !(style & wxCB_READONLY) )
464 {
465 gs_wndprocEdit = wxSetWindowProc((HWND)GetEditHWND(), wxComboEditWndProc);
466 }
467
468 // and finally, show the control
469 Show(true);
470
471 return true;
472 }
473
474 bool wxComboBox::Create(wxWindow *parent, wxWindowID id,
475 const wxString& value,
476 const wxPoint& pos,
477 const wxSize& size,
478 const wxArrayString& choices,
479 long style,
480 const wxValidator& validator,
481 const wxString& name)
482 {
483 wxCArrayString chs(choices);
484 return Create(parent, id, value, pos, size, chs.GetCount(),
485 chs.GetStrings(), style, validator, name);
486 }
487
488 WXDWORD wxComboBox::MSWGetStyle(long style, WXDWORD *exstyle) const
489 {
490 // we never have an external border
491 WXDWORD msStyle = wxChoice::MSWGetStyle
492 (
493 (style & ~wxBORDER_MASK) | wxBORDER_NONE, exstyle
494 );
495
496 // usually WS_TABSTOP is added by wxControl::MSWGetStyle() but as we're
497 // created hidden (see Create() above), it is not done for us but we still
498 // want to have this style
499 msStyle |= WS_TABSTOP;
500
501 // remove the style always added by wxChoice
502 msStyle &= ~CBS_DROPDOWNLIST;
503
504 if ( style & wxCB_READONLY )
505 msStyle |= CBS_DROPDOWNLIST;
506 #ifndef __WXWINCE__
507 else if ( style & wxCB_SIMPLE )
508 msStyle |= CBS_SIMPLE; // A list (shown always) and edit control
509 #endif
510 else
511 msStyle |= CBS_DROPDOWN;
512
513 // there is no reason to not always use CBS_AUTOHSCROLL, so do use it
514 msStyle |= CBS_AUTOHSCROLL;
515
516 // NB: we used to also add CBS_NOINTEGRALHEIGHT here but why?
517
518 return msStyle;
519 }
520
521 // ----------------------------------------------------------------------------
522 // wxComboBox text control-like methods
523 // ----------------------------------------------------------------------------
524
525 wxString wxComboBox::GetValue() const
526 {
527 return HasFlag(wxCB_READONLY) ? GetStringSelection()
528 : wxTextEntry::GetValue();
529 }
530
531 void wxComboBox::SetValue(const wxString& value)
532 {
533 if ( HasFlag(wxCB_READONLY) )
534 SetStringSelection(value);
535 else
536 wxTextEntry::SetValue(value);
537 }
538
539 void wxComboBox::Clear()
540 {
541 wxChoice::Clear();
542 if ( !HasFlag(wxCB_READONLY) )
543 wxTextEntry::Clear();
544 }
545
546 void wxComboBox::GetSelection(long *from, long *to) const
547 {
548 if ( !HasFlag(wxCB_READONLY) )
549 {
550 wxTextEntry::GetSelection(from, to);
551 }
552 else // text selection doesn't make sense for read only comboboxes
553 {
554 if ( from )
555 *from = -1;
556 if ( to )
557 *to = -1;
558 }
559 }
560
561 bool wxComboBox::IsEditable() const
562 {
563 return !HasFlag(wxCB_READONLY) && wxTextEntry::IsEditable();
564 }
565
566 // ----------------------------------------------------------------------------
567 // standard event handling
568 // ----------------------------------------------------------------------------
569
570 void wxComboBox::OnCut(wxCommandEvent& WXUNUSED(event))
571 {
572 Cut();
573 }
574
575 void wxComboBox::OnCopy(wxCommandEvent& WXUNUSED(event))
576 {
577 Copy();
578 }
579
580 void wxComboBox::OnPaste(wxCommandEvent& WXUNUSED(event))
581 {
582 Paste();
583 }
584
585 void wxComboBox::OnUndo(wxCommandEvent& WXUNUSED(event))
586 {
587 Undo();
588 }
589
590 void wxComboBox::OnRedo(wxCommandEvent& WXUNUSED(event))
591 {
592 Redo();
593 }
594
595 void wxComboBox::OnDelete(wxCommandEvent& WXUNUSED(event))
596 {
597 RemoveSelection();
598 }
599
600 void wxComboBox::OnSelectAll(wxCommandEvent& WXUNUSED(event))
601 {
602 SelectAll();
603 }
604
605 void wxComboBox::OnUpdateCut(wxUpdateUIEvent& event)
606 {
607 event.Enable( CanCut() );
608 }
609
610 void wxComboBox::OnUpdateCopy(wxUpdateUIEvent& event)
611 {
612 event.Enable( CanCopy() );
613 }
614
615 void wxComboBox::OnUpdatePaste(wxUpdateUIEvent& event)
616 {
617 event.Enable( CanPaste() );
618 }
619
620 void wxComboBox::OnUpdateUndo(wxUpdateUIEvent& event)
621 {
622 event.Enable( IsEditable() && CanUndo() );
623 }
624
625 void wxComboBox::OnUpdateRedo(wxUpdateUIEvent& event)
626 {
627 event.Enable( IsEditable() && CanRedo() );
628 }
629
630 void wxComboBox::OnUpdateDelete(wxUpdateUIEvent& event)
631 {
632 event.Enable(IsEditable() && HasSelection());
633 }
634
635 void wxComboBox::OnUpdateSelectAll(wxUpdateUIEvent& event)
636 {
637 event.Enable(IsEditable() && !wxTextEntry::IsEmpty());
638 }
639
640 #if wxUSE_TOOLTIPS
641
642 void wxComboBox::DoSetToolTip(wxToolTip *tip)
643 {
644 wxChoice::DoSetToolTip(tip);
645
646 if ( tip && !HasFlag(wxCB_READONLY) )
647 tip->Add(GetEditHWND());
648 }
649
650 #endif // wxUSE_TOOLTIPS
651
652 #endif // wxUSE_COMBOBOX