]> git.saurik.com Git - wxWidgets.git/blob - src/msw/combobox.cpp
adaptions for latest dc changes
[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 case WM_CUT:
210 case WM_COPY:
211 case WM_PASTE:
212 if( win->HandleClipboardEvent( message ) )
213 return 0;
214 break;
215 }
216
217 return ::CallWindowProc(CASTWNDPROC gs_wndprocEdit, hWnd, message, wParam, lParam);
218 }
219
220 // ----------------------------------------------------------------------------
221 // wxComboBox callbacks
222 // ----------------------------------------------------------------------------
223
224 WXLRESULT wxComboBox::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam)
225 {
226 // TODO: handle WM_CTLCOLOR messages from our EDIT control to be able to
227 // set its colour correctly (to be the same as our own one)
228
229 switch ( nMsg )
230 {
231 case WM_SIZE:
232 // wxStaticBox can generate this message, when modifying the control's style.
233 // This causes the content of the combobox to be selected, for some reason.
234 case WM_STYLECHANGED:
235 {
236 // combobox selection sometimes spontaneously changes when its
237 // size changes, restore it to the old value if necessary
238 if ( !GetEditHWNDIfAvailable() )
239 break;
240
241 long fromOld, toOld;
242 GetSelection(&fromOld, &toOld);
243 WXLRESULT result = wxChoice::MSWWindowProc(nMsg, wParam, lParam);
244
245 long fromNew, toNew;
246 GetSelection(&fromNew, &toNew);
247
248 if ( fromOld != fromNew || toOld != toNew )
249 {
250 SetSelection(fromOld, toOld);
251 }
252
253 return result;
254 }
255 }
256
257 return wxChoice::MSWWindowProc(nMsg, wParam, lParam);
258 }
259
260 bool wxComboBox::MSWProcessEditMsg(WXUINT msg, WXWPARAM wParam, WXLPARAM lParam)
261 {
262 switch ( msg )
263 {
264 case WM_CHAR:
265 // for compatibility with wxTextCtrl, generate a special message
266 // when Enter is pressed
267 if ( wParam == VK_RETURN )
268 {
269 if (SendMessage(GetHwnd(), CB_GETDROPPEDSTATE, 0, 0))
270 return false;
271
272 wxCommandEvent event(wxEVT_COMMAND_TEXT_ENTER, m_windowId);
273
274 const int sel = GetSelection();
275 event.SetInt(sel);
276 event.SetString(GetValue());
277 InitCommandEventWithItems(event, sel);
278
279 if ( ProcessCommand(event) )
280 {
281 // don't let the event through to the native control
282 // because it doesn't need it and may generate an annoying
283 // beep if it gets it
284 return true;
285 }
286 }
287 // fall through
288
289 case WM_SYSCHAR:
290 return HandleChar(wParam, lParam, true /* isASCII */);
291
292 case WM_SYSKEYDOWN:
293 case WM_KEYDOWN:
294 return HandleKeyDown(wParam, lParam);
295
296 case WM_SYSKEYUP:
297 case WM_KEYUP:
298 return HandleKeyUp(wParam, lParam);
299
300 case WM_SETFOCUS:
301 return HandleSetFocus((WXHWND)wParam);
302
303 case WM_KILLFOCUS:
304 return HandleKillFocus((WXHWND)wParam);
305 }
306
307 return false;
308 }
309
310 bool wxComboBox::MSWCommand(WXUINT param, WXWORD id)
311 {
312 int sel = -1;
313 wxString value;
314
315 switch ( param )
316 {
317 case CBN_SELENDOK:
318 #ifndef __SMARTPHONE__
319 // we need to reset this to prevent the selection from being undone
320 // by wxChoice, see wxChoice::MSWCommand() and comments there
321 m_lastAcceptedSelection = wxID_NONE;
322 #endif
323
324 // set these variables so that they could be also fixed in
325 // CBN_EDITCHANGE below
326 sel = GetSelection();
327 value = GetStringSelection();
328
329 // this string is going to become the new combobox value soon but
330 // we need it to be done right now, otherwise the event handler
331 // could get a wrong value when it calls our GetValue()
332 ::SetWindowText(GetHwnd(), value.wx_str());
333
334 {
335 wxCommandEvent event(wxEVT_COMMAND_COMBOBOX_SELECTED, GetId());
336 event.SetInt(sel);
337 event.SetString(value);
338 InitCommandEventWithItems(event, sel);
339
340 ProcessCommand(event);
341 }
342
343 // fall through: for compability with wxGTK, also send the text
344 // update event when the selection changes (this also seems more
345 // logical as the text does change)
346
347 case CBN_EDITCHANGE:
348 {
349 wxCommandEvent event(wxEVT_COMMAND_TEXT_UPDATED, GetId());
350
351 // if sel != -1, value was already initialized above
352 if ( sel == -1 )
353 {
354 value = wxGetWindowText(GetHwnd());
355 }
356
357 event.SetString(value);
358 InitCommandEventWithItems(event, sel);
359
360 ProcessCommand(event);
361 }
362 break;
363
364 default:
365 return wxChoice::MSWCommand(param, id);
366 }
367
368 // skip wxChoice version as it would generate its own events for
369 // CBN_SELENDOK
370 return true;
371 }
372
373 bool wxComboBox::MSWShouldPreProcessMessage(WXMSG *pMsg)
374 {
375 // prevent command accelerators from stealing editing
376 // hotkeys when we have the focus
377 if (wxIsCtrlDown())
378 {
379 WPARAM vkey = pMsg->wParam;
380
381 switch (vkey)
382 {
383 case 'C':
384 case 'V':
385 case 'X':
386 case VK_INSERT:
387 case VK_DELETE:
388 case VK_HOME:
389 case VK_END:
390 return false;
391 }
392 }
393
394 return wxChoice::MSWShouldPreProcessMessage(pMsg);
395 }
396
397 WXHWND wxComboBox::GetEditHWNDIfAvailable() const
398 {
399 // we assume that the only child of the combobox is the edit window so it's
400 // unnecessary to pass "EDIT" as class name parameter
401 return (WXHWND)::FindWindowEx(GetHwnd(), NULL, NULL, NULL);
402 }
403
404 WXHWND wxComboBox::GetEditHWND() const
405 {
406 // this function should not be called for wxCB_READONLY controls, it is
407 // the callers responsibility to check this
408 wxASSERT_MSG( !HasFlag(wxCB_READONLY),
409 _T("read-only combobox doesn't have any edit control") );
410
411 WXHWND hWndEdit = GetEditHWNDIfAvailable();
412 wxASSERT_MSG( hWndEdit, _T("combobox without edit control?") );
413
414 return hWndEdit;
415 }
416
417 // ----------------------------------------------------------------------------
418 // wxComboBox creation
419 // ----------------------------------------------------------------------------
420
421 bool wxComboBox::Create(wxWindow *parent, wxWindowID id,
422 const wxString& value,
423 const wxPoint& pos,
424 const wxSize& size,
425 int n, const wxString choices[],
426 long style,
427 const wxValidator& validator,
428 const wxString& name)
429 {
430 // pretend that wxComboBox is hidden while it is positioned and resized and
431 // show it only right before leaving this method because otherwise there is
432 // some noticeable flicker while the control rearranges itself
433 m_isShown = false;
434
435 if ( !CreateAndInit(parent, id, pos, size, n, choices, style,
436 validator, name) )
437 return false;
438
439 // we shouldn't call SetValue() for an empty string because this would
440 // (correctly) result in an assert with a read only combobox and is useless
441 // for the other ones anyhow
442 if ( !value.empty() )
443 SetValue(value);
444
445 // a (not read only) combobox is, in fact, 2 controls: the combobox itself
446 // and an edit control inside it and if we want to catch events from this
447 // edit control, we must subclass it as well
448 if ( !(style & wxCB_READONLY) )
449 {
450 gs_wndprocEdit = wxSetWindowProc((HWND)GetEditHWND(), wxComboEditWndProc);
451 }
452
453 // and finally, show the control
454 Show(true);
455
456 return true;
457 }
458
459 bool wxComboBox::Create(wxWindow *parent, wxWindowID id,
460 const wxString& value,
461 const wxPoint& pos,
462 const wxSize& size,
463 const wxArrayString& choices,
464 long style,
465 const wxValidator& validator,
466 const wxString& name)
467 {
468 wxCArrayString chs(choices);
469 return Create(parent, id, value, pos, size, chs.GetCount(),
470 chs.GetStrings(), style, validator, name);
471 }
472
473 WXDWORD wxComboBox::MSWGetStyle(long style, WXDWORD *exstyle) const
474 {
475 // we never have an external border
476 WXDWORD msStyle = wxChoice::MSWGetStyle
477 (
478 (style & ~wxBORDER_MASK) | wxBORDER_NONE, exstyle
479 );
480
481 // usually WS_TABSTOP is added by wxControl::MSWGetStyle() but as we're
482 // created hidden (see Create() above), it is not done for us but we still
483 // want to have this style
484 msStyle |= WS_TABSTOP;
485
486 // remove the style always added by wxChoice
487 msStyle &= ~CBS_DROPDOWNLIST;
488
489 if ( style & wxCB_READONLY )
490 msStyle |= CBS_DROPDOWNLIST;
491 #ifndef __WXWINCE__
492 else if ( style & wxCB_SIMPLE )
493 msStyle |= CBS_SIMPLE; // A list (shown always) and edit control
494 #endif
495 else
496 msStyle |= CBS_DROPDOWN;
497
498 // there is no reason to not always use CBS_AUTOHSCROLL, so do use it
499 msStyle |= CBS_AUTOHSCROLL;
500
501 // NB: we used to also add CBS_NOINTEGRALHEIGHT here but why?
502
503 return msStyle;
504 }
505
506 // ----------------------------------------------------------------------------
507 // wxComboBox text control-like methods
508 // ----------------------------------------------------------------------------
509
510 wxString wxComboBox::GetValue() const
511 {
512 return HasFlag(wxCB_READONLY) ? GetStringSelection()
513 : wxTextEntry::GetValue();
514 }
515
516 void wxComboBox::SetValue(const wxString& value)
517 {
518 if ( HasFlag(wxCB_READONLY) )
519 SetStringSelection(value);
520 else
521 wxTextEntry::SetValue(value);
522 }
523
524 void wxComboBox::Clear()
525 {
526 wxChoice::Clear();
527 if ( !HasFlag(wxCB_READONLY) )
528 wxTextEntry::Clear();
529 }
530
531 void wxComboBox::GetSelection(long *from, long *to) const
532 {
533 if ( !HasFlag(wxCB_READONLY) )
534 {
535 wxTextEntry::GetSelection(from, to);
536 }
537 else // text selection doesn't make sense for read only comboboxes
538 {
539 if ( from )
540 *from = -1;
541 if ( to )
542 *to = -1;
543 }
544 }
545
546 bool wxComboBox::IsEditable() const
547 {
548 return !HasFlag(wxCB_READONLY) && wxTextEntry::IsEditable();
549 }
550
551 // ----------------------------------------------------------------------------
552 // standard event handling
553 // ----------------------------------------------------------------------------
554
555 void wxComboBox::OnCut(wxCommandEvent& WXUNUSED(event))
556 {
557 Cut();
558 }
559
560 void wxComboBox::OnCopy(wxCommandEvent& WXUNUSED(event))
561 {
562 Copy();
563 }
564
565 void wxComboBox::OnPaste(wxCommandEvent& WXUNUSED(event))
566 {
567 Paste();
568 }
569
570 void wxComboBox::OnUndo(wxCommandEvent& WXUNUSED(event))
571 {
572 Undo();
573 }
574
575 void wxComboBox::OnRedo(wxCommandEvent& WXUNUSED(event))
576 {
577 Redo();
578 }
579
580 void wxComboBox::OnDelete(wxCommandEvent& WXUNUSED(event))
581 {
582 long from, to;
583 GetSelection(& from, & to);
584 if (from != -1 && to != -1)
585 Remove(from, to);
586 }
587
588 void wxComboBox::OnSelectAll(wxCommandEvent& WXUNUSED(event))
589 {
590 SetSelection(-1, -1);
591 }
592
593 void wxComboBox::OnUpdateCut(wxUpdateUIEvent& event)
594 {
595 event.Enable( CanCut() );
596 }
597
598 void wxComboBox::OnUpdateCopy(wxUpdateUIEvent& event)
599 {
600 event.Enable( CanCopy() );
601 }
602
603 void wxComboBox::OnUpdatePaste(wxUpdateUIEvent& event)
604 {
605 event.Enable( CanPaste() );
606 }
607
608 void wxComboBox::OnUpdateUndo(wxUpdateUIEvent& event)
609 {
610 event.Enable( IsEditable() && CanUndo() );
611 }
612
613 void wxComboBox::OnUpdateRedo(wxUpdateUIEvent& event)
614 {
615 event.Enable( IsEditable() && CanRedo() );
616 }
617
618 void wxComboBox::OnUpdateDelete(wxUpdateUIEvent& event)
619 {
620 event.Enable(IsEditable() && HasSelection());
621 }
622
623 void wxComboBox::OnUpdateSelectAll(wxUpdateUIEvent& event)
624 {
625 event.Enable(IsEditable() && GetLastPosition() > 0);
626 }
627
628 #if wxUSE_TOOLTIPS
629
630 void wxComboBox::DoSetToolTip(wxToolTip *tip)
631 {
632 wxChoice::DoSetToolTip(tip);
633
634 if ( tip && !HasFlag(wxCB_READONLY) )
635 tip->Add(GetEditHWND());
636 }
637
638 #endif // wxUSE_TOOLTIPS
639
640 #endif // wxUSE_COMBOBOX