made wxChoice and wxComboBox::GetSelection() return only completed selection in wxMSW...
[wxWidgets.git] / src / msw / choice.cpp
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: choice.cpp
3 // Purpose: wxChoice
4 // Author: Julian Smart
5 // Modified by: Vadim Zeitlin to derive from wxChoiceBase
6 // Created: 04/01/98
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 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
21 #pragma implementation "choice.h"
22 #endif
23
24 // For compilers that support precompilation, includes "wx.h".
25 #include "wx/wxprec.h"
26
27 #ifdef __BORLANDC__
28 #pragma hdrstop
29 #endif
30
31 #if wxUSE_CHOICE && !(defined(__SMARTPHONE__) && defined(__WXWINCE__))
32
33 #ifndef WX_PRECOMP
34 #include "wx/choice.h"
35 #include "wx/utils.h"
36 #include "wx/log.h"
37 #include "wx/brush.h"
38 #include "wx/settings.h"
39 #endif
40
41 #include "wx/msw/private.h"
42
43 #if wxUSE_EXTENDED_RTTI
44 WX_DEFINE_FLAGS( wxChoiceStyle )
45
46 wxBEGIN_FLAGS( wxChoiceStyle )
47 // new style border flags, we put them first to
48 // use them for streaming out
49 wxFLAGS_MEMBER(wxBORDER_SIMPLE)
50 wxFLAGS_MEMBER(wxBORDER_SUNKEN)
51 wxFLAGS_MEMBER(wxBORDER_DOUBLE)
52 wxFLAGS_MEMBER(wxBORDER_RAISED)
53 wxFLAGS_MEMBER(wxBORDER_STATIC)
54 wxFLAGS_MEMBER(wxBORDER_NONE)
55
56 // old style border flags
57 wxFLAGS_MEMBER(wxSIMPLE_BORDER)
58 wxFLAGS_MEMBER(wxSUNKEN_BORDER)
59 wxFLAGS_MEMBER(wxDOUBLE_BORDER)
60 wxFLAGS_MEMBER(wxRAISED_BORDER)
61 wxFLAGS_MEMBER(wxSTATIC_BORDER)
62 wxFLAGS_MEMBER(wxBORDER)
63
64 // standard window styles
65 wxFLAGS_MEMBER(wxTAB_TRAVERSAL)
66 wxFLAGS_MEMBER(wxCLIP_CHILDREN)
67 wxFLAGS_MEMBER(wxTRANSPARENT_WINDOW)
68 wxFLAGS_MEMBER(wxWANTS_CHARS)
69 wxFLAGS_MEMBER(wxFULL_REPAINT_ON_RESIZE)
70 wxFLAGS_MEMBER(wxALWAYS_SHOW_SB )
71 wxFLAGS_MEMBER(wxVSCROLL)
72 wxFLAGS_MEMBER(wxHSCROLL)
73
74 wxEND_FLAGS( wxChoiceStyle )
75
76 IMPLEMENT_DYNAMIC_CLASS_XTI(wxChoice, wxControl,"wx/choice.h")
77
78 wxBEGIN_PROPERTIES_TABLE(wxChoice)
79 wxEVENT_PROPERTY( Select , wxEVT_COMMAND_CHOICE_SELECTED , wxCommandEvent )
80
81 wxPROPERTY( Font , wxFont , SetFont , GetFont , EMPTY_MACROVALUE , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
82 wxPROPERTY_COLLECTION( Choices , wxArrayString , wxString , AppendString , GetStrings , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
83 wxPROPERTY( Selection ,int, SetSelection, GetSelection, EMPTY_MACROVALUE , 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
84 wxPROPERTY_FLAGS( WindowStyle , wxChoiceStyle , long , SetWindowStyleFlag , GetWindowStyleFlag , EMPTY_MACROVALUE , 0 /*flags*/ , wxT("Helpstring") , wxT("group")) // style
85 wxEND_PROPERTIES_TABLE()
86
87 wxBEGIN_HANDLERS_TABLE(wxChoice)
88 wxEND_HANDLERS_TABLE()
89
90 wxCONSTRUCTOR_4( wxChoice , wxWindow* , Parent , wxWindowID , Id , wxPoint , Position , wxSize , Size )
91 #else
92 IMPLEMENT_DYNAMIC_CLASS(wxChoice, wxControl)
93 #endif
94 /*
95 TODO PROPERTIES
96 selection (long)
97 content (list)
98 item
99 */
100
101 // ============================================================================
102 // implementation
103 // ============================================================================
104
105 // ----------------------------------------------------------------------------
106 // creation
107 // ----------------------------------------------------------------------------
108
109 bool wxChoice::Create(wxWindow *parent,
110 wxWindowID id,
111 const wxPoint& pos,
112 const wxSize& size,
113 int n, const wxString choices[],
114 long style,
115 const wxValidator& validator,
116 const wxString& name)
117 {
118 // Experience shows that wxChoice vs. wxComboBox distinction confuses
119 // quite a few people - try to help them
120 wxASSERT_MSG( !(style & wxCB_DROPDOWN) &&
121 !(style & wxCB_READONLY) &&
122 !(style & wxCB_SIMPLE),
123 _T("this style flag is ignored by wxChoice, you ")
124 _T("probably want to use a wxComboBox") );
125
126 return CreateAndInit(parent, id, pos, size, n, choices, style,
127 validator, name);
128 }
129
130 bool wxChoice::CreateAndInit(wxWindow *parent,
131 wxWindowID id,
132 const wxPoint& pos,
133 const wxSize& size,
134 int n, const wxString choices[],
135 long style,
136 const wxValidator& validator,
137 const wxString& name)
138 {
139 // initialize wxControl
140 if ( !CreateControl(parent, id, pos, size, style, validator, name) )
141 return false;
142
143 // now create the real HWND
144 if ( !MSWCreateControl(wxT("COMBOBOX"), wxEmptyString, pos, size) )
145 return false;
146
147
148 // choice/combobox normally has "white" (depends on colour scheme, of
149 // course) background rather than inheriting the parent's background
150 SetBackgroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOW));
151
152 // initialize the controls contents
153 for ( int i = 0; i < n; i++ )
154 {
155 Append(choices[i]);
156 }
157
158 // and now we may finally size the control properly (if needed)
159 SetBestSize(size);
160
161 return true;
162 }
163
164 bool wxChoice::Create(wxWindow *parent,
165 wxWindowID id,
166 const wxPoint& pos,
167 const wxSize& size,
168 const wxArrayString& choices,
169 long style,
170 const wxValidator& validator,
171 const wxString& name)
172 {
173 wxCArrayString chs(choices);
174 return Create(parent, id, pos, size, chs.GetCount(), chs.GetStrings(),
175 style, validator, name);
176 }
177
178 bool wxChoice::MSWShouldPreProcessMessage(WXMSG *pMsg)
179 {
180 MSG *msg = (MSG *) pMsg;
181
182 // if the dropdown list is visible, don't preprocess certain keys
183 if ( msg->message == WM_KEYDOWN
184 && (msg->wParam == VK_ESCAPE || msg->wParam == VK_RETURN) )
185 {
186 if (::SendMessage(GetHwndOf(this), CB_GETDROPPEDSTATE, 0, 0))
187 {
188 return false;
189 }
190 }
191
192 return wxControl::MSWShouldPreProcessMessage(pMsg);
193 }
194
195 WXDWORD wxChoice::MSWGetStyle(long style, WXDWORD *exstyle) const
196 {
197 // we never have an external border
198 WXDWORD msStyle = wxControl::MSWGetStyle
199 (
200 (style & ~wxBORDER_MASK) | wxBORDER_NONE, exstyle
201 );
202
203 // WS_CLIPSIBLINGS is useful with wxChoice and doesn't seem to result in
204 // any problems
205 msStyle |= WS_CLIPSIBLINGS;
206
207 // wxChoice-specific styles
208 msStyle |= CBS_DROPDOWNLIST | WS_HSCROLL | WS_VSCROLL;
209 if ( style & wxCB_SORT )
210 msStyle |= CBS_SORT;
211
212 return msStyle;
213 }
214
215 wxChoice::~wxChoice()
216 {
217 Free();
218 }
219
220 // ----------------------------------------------------------------------------
221 // adding/deleting items to/from the list
222 // ----------------------------------------------------------------------------
223
224 int wxChoice::DoAppend(const wxString& item)
225 {
226 int n = (int)SendMessage(GetHwnd(), CB_ADDSTRING, 0, (LPARAM)item.c_str());
227 if ( n == CB_ERR )
228 {
229 wxLogLastError(wxT("SendMessage(CB_ADDSTRING)"));
230 }
231 else // ok
232 {
233 // we need to refresh our size in order to have enough space for the
234 // newly added items
235 if ( !IsFrozen() )
236 UpdateVisibleHeight();
237 }
238
239 InvalidateBestSize();
240 return n;
241 }
242
243 int wxChoice::DoInsert(const wxString& item, int pos)
244 {
245 wxCHECK_MSG(!(GetWindowStyle() & wxCB_SORT), -1, wxT("can't insert into sorted list"));
246 wxCHECK_MSG((pos>=0) && (pos<=GetCount()), -1, wxT("invalid index"));
247
248 int n = (int)SendMessage(GetHwnd(), CB_INSERTSTRING, pos, (LPARAM)item.c_str());
249 if ( n == CB_ERR )
250 {
251 wxLogLastError(wxT("SendMessage(CB_INSERTSTRING)"));
252 }
253 else // ok
254 {
255 if ( !IsFrozen() )
256 UpdateVisibleHeight();
257 }
258
259 InvalidateBestSize();
260 return n;
261 }
262
263 void wxChoice::Delete(int n)
264 {
265 wxCHECK_RET( n < GetCount(), wxT("invalid item index in wxChoice::Delete") );
266
267 if ( HasClientObjectData() )
268 {
269 delete GetClientObject(n);
270 }
271
272 SendMessage(GetHwnd(), CB_DELETESTRING, n, 0);
273
274 if ( !IsFrozen() )
275 UpdateVisibleHeight();
276
277 InvalidateBestSize();
278 }
279
280 void wxChoice::Clear()
281 {
282 Free();
283
284 SendMessage(GetHwnd(), CB_RESETCONTENT, 0, 0);
285
286 if ( !IsFrozen() )
287 UpdateVisibleHeight();
288
289 InvalidateBestSize();
290 }
291
292 void wxChoice::Free()
293 {
294 if ( HasClientObjectData() )
295 {
296 size_t count = GetCount();
297 for ( size_t n = 0; n < count; n++ )
298 {
299 delete GetClientObject(n);
300 }
301 }
302 }
303
304 // ----------------------------------------------------------------------------
305 // selection
306 // ----------------------------------------------------------------------------
307
308 int wxChoice::GetSelection() const
309 {
310 // if m_lastAcceptedSelection is set, it means that the dropdown is
311 // currently shown and that we want to use the last "permanent" selection
312 // instead of whatever is under the mouse pointer currently
313 //
314 // otherwise, get the selection from the control
315 return m_lastAcceptedSelection == wxID_NONE ? GetCurrentSelection()
316 : m_lastAcceptedSelection;
317 }
318
319 int wxChoice::GetCurrentSelection() const
320 {
321 return (int)SendMessage(GetHwnd(), CB_GETCURSEL, 0, 0);
322 }
323
324 void wxChoice::SetSelection(int n)
325 {
326 SendMessage(GetHwnd(), CB_SETCURSEL, n, 0);
327 }
328
329 // ----------------------------------------------------------------------------
330 // string list functions
331 // ----------------------------------------------------------------------------
332
333 int wxChoice::GetCount() const
334 {
335 return (int)SendMessage(GetHwnd(), CB_GETCOUNT, 0, 0);
336 }
337
338 int wxChoice::FindString(const wxString& s) const
339 {
340 #if defined(__WATCOMC__) && defined(__WIN386__)
341 // For some reason, Watcom in WIN386 mode crashes in the CB_FINDSTRINGEXACT message.
342 // wxChoice::Do it the long way instead.
343 int count = GetCount();
344 for ( int i = 0; i < count; i++ )
345 {
346 // as CB_FINDSTRINGEXACT is case insensitive, be case insensitive too
347 if ( GetString(i).IsSameAs(s, false) )
348 return i;
349 }
350
351 return wxNOT_FOUND;
352 #else // !Watcom
353 //TODO: Evidently some MSW versions (all?) don't like empty strings
354 //passed to SendMessage, so we have to do it ourselves in that case
355 if ( s.empty() )
356 {
357 int count = GetCount();
358 for ( int i = 0; i < count; i++ )
359 {
360 if ( GetString(i).empty() )
361 return i;
362 }
363
364 return wxNOT_FOUND;
365 }
366 else
367 {
368 int pos = (int)SendMessage(GetHwnd(), CB_FINDSTRINGEXACT,
369 (WPARAM)-1, (LPARAM)s.c_str());
370
371 return pos == LB_ERR ? wxNOT_FOUND : pos;
372 }
373 #endif // Watcom/!Watcom
374 }
375
376 void wxChoice::SetString(int n, const wxString& s)
377 {
378 wxCHECK_RET( n >= 0 && n < GetCount(),
379 wxT("invalid item index in wxChoice::SetString") );
380
381 // we have to delete and add back the string as there is no way to change a
382 // string in place
383
384 // we need to preserve the client data
385 void *data;
386 if ( m_clientDataItemsType != wxClientData_None )
387 {
388 data = DoGetItemClientData(n);
389 }
390 else // no client data
391 {
392 data = NULL;
393 }
394
395 ::SendMessage(GetHwnd(), CB_DELETESTRING, n, 0);
396 ::SendMessage(GetHwnd(), CB_INSERTSTRING, n, (LPARAM)s.c_str() );
397
398 if ( data )
399 {
400 DoSetItemClientData(n, data);
401 }
402 //else: it's already NULL by default
403
404 InvalidateBestSize();
405 }
406
407 wxString wxChoice::GetString(int n) const
408 {
409 int len = (int)::SendMessage(GetHwnd(), CB_GETLBTEXTLEN, n, 0);
410
411 wxString str;
412 if ( len != CB_ERR && len > 0 )
413 {
414 if ( ::SendMessage
415 (
416 GetHwnd(),
417 CB_GETLBTEXT,
418 n,
419 (LPARAM)(wxChar *)wxStringBuffer(str, len)
420 ) == CB_ERR )
421 {
422 wxLogLastError(wxT("SendMessage(CB_GETLBTEXT)"));
423 }
424 }
425
426 return str;
427 }
428
429 // ----------------------------------------------------------------------------
430 // client data
431 // ----------------------------------------------------------------------------
432
433 void wxChoice::DoSetItemClientData( int n, void* clientData )
434 {
435 if ( ::SendMessage(GetHwnd(), CB_SETITEMDATA,
436 n, (LPARAM)clientData) == CB_ERR )
437 {
438 wxLogLastError(wxT("CB_SETITEMDATA"));
439 }
440 }
441
442 void* wxChoice::DoGetItemClientData( int n ) const
443 {
444 LPARAM rc = SendMessage(GetHwnd(), CB_GETITEMDATA, n, 0);
445 if ( rc == CB_ERR )
446 {
447 wxLogLastError(wxT("CB_GETITEMDATA"));
448
449 // unfortunately, there is no way to return an error code to the user
450 rc = (LPARAM) NULL;
451 }
452
453 return (void *)rc;
454 }
455
456 void wxChoice::DoSetItemClientObject( int n, wxClientData* clientData )
457 {
458 DoSetItemClientData(n, clientData);
459 }
460
461 wxClientData* wxChoice::DoGetItemClientObject( int n ) const
462 {
463 return (wxClientData *)DoGetItemClientData(n);
464 }
465
466 // ----------------------------------------------------------------------------
467 // wxMSW specific helpers
468 // ----------------------------------------------------------------------------
469
470 void wxChoice::UpdateVisibleHeight()
471 {
472 // be careful to not change the width here
473 DoSetSize(wxDefaultCoord, wxDefaultCoord, wxDefaultCoord, GetSize().y, wxSIZE_USE_EXISTING);
474 }
475
476 void wxChoice::DoMoveWindow(int x, int y, int width, int height)
477 {
478 // here is why this is necessary: if the width is negative, the combobox
479 // window proc makes the window of the size width*height instead of
480 // interpreting height in the usual manner (meaning the height of the drop
481 // down list - usually the height specified in the call to MoveWindow()
482 // will not change the height of combo box per se)
483 //
484 // this behaviour is not documented anywhere, but this is just how it is
485 // here (NT 4.4) and, anyhow, the check shouldn't hurt - however without
486 // the check, constraints/sizers using combos may break the height
487 // constraint will have not at all the same value as expected
488 if ( width < 0 )
489 return;
490
491 wxControl::DoMoveWindow(x, y, width, height);
492 }
493
494 void wxChoice::DoGetSize(int *w, int *h) const
495 {
496 // this is weird: sometimes, the height returned by Windows is clearly the
497 // total height of the control including the drop down list -- but only
498 // sometimes, and normally it isn't... I have no idea about what to do with
499 // this
500 wxControl::DoGetSize(w, h);
501 }
502
503 void wxChoice::DoSetSize(int x, int y,
504 int width, int height,
505 int sizeFlags)
506 {
507 int heightOrig = height;
508
509 // the height which we must pass to Windows should be the total height of
510 // the control including the drop down list while the height given to us
511 // is, of course, just the height of the permanently visible part of it
512 if ( height != wxDefaultCoord )
513 {
514 // don't make the drop down list too tall, arbitrarily limit it to 40
515 // items max and also don't leave it empty
516 size_t nItems = GetCount();
517 if ( !nItems )
518 nItems = 9;
519 else if ( nItems > 24 )
520 nItems = 24;
521
522 // add space for the drop down list
523 const int hItem = SendMessage(GetHwnd(), CB_GETITEMHEIGHT, 0, 0);
524 height += hItem*(nItems + 1);
525 }
526 else
527 {
528 // We cannot pass wxDefaultCoord as height to wxControl. wxControl uses
529 // wxGetWindowRect() to determine the current height of the combobox,
530 // and then again sets the combobox's height to that value. Unfortunately,
531 // wxGetWindowRect doesn't include the dropdown list's height (at least
532 // on Win2K), so this would result in a combobox with dropdown height of
533 // 1 pixel. We have to determine the default height ourselves and call
534 // wxControl with that value instead.
535 int w, h;
536 RECT r;
537 DoGetSize(&w, &h);
538 if (::SendMessage(GetHwnd(), CB_GETDROPPEDCONTROLRECT, 0, (LPARAM) &r) != 0)
539 {
540 height = h + r.bottom - r.top;
541 }
542 }
543
544 wxControl::DoSetSize(x, y, width, height, sizeFlags);
545
546 // I'm commenting this out since the code appears to make choices
547 // and comboxes too high when they have associated sizers. I'm sure this
548 // is not the end of the story, which is why I'm leaving it #if'ed out for
549 // now. JACS.
550 #if 0
551 // if the height specified for the visible part of the control is
552 // different from the current one, we need to change it separately
553 // as it is not affected by normal WM_SETSIZE
554 if ( height != wxDefaultCoord )
555 {
556 const int delta = heightOrig - GetSize().y;
557 if ( delta )
558 {
559 int h = ::SendMessage(GetHwnd(), CB_GETITEMHEIGHT, (WPARAM)-1, 0);
560 SendMessage(GetHwnd(), CB_SETITEMHEIGHT, (WPARAM)-1, h + delta);
561 }
562 }
563 #else
564 wxUnusedVar(heightOrig);
565 #endif
566 }
567
568 wxSize wxChoice::DoGetBestSize() const
569 {
570 // find the widest string
571 int wChoice = 0;
572 const size_t nItems = GetCount();
573 for ( size_t i = 0; i < nItems; i++ )
574 {
575 int wLine;
576 GetTextExtent(GetString(i), &wLine, NULL);
577 if ( wLine > wChoice )
578 wChoice = wLine;
579 }
580
581 // give it some reasonable default value if there are no strings in the
582 // list
583 if ( wChoice == 0 )
584 wChoice = 100;
585
586 // the combobox should be slightly larger than the widest string
587 wChoice += 5*GetCharWidth();
588
589 wxSize best(wChoice, EDIT_HEIGHT_FROM_CHAR_HEIGHT(GetCharHeight()));
590 CacheBestSize(best);
591 return best;
592 }
593
594 WXLRESULT wxChoice::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam)
595 {
596 switch ( nMsg )
597 {
598 case WM_LBUTTONUP:
599 {
600 int x = (int)LOWORD(lParam);
601 int y = (int)HIWORD(lParam);
602
603 // Ok, this is truly weird, but if a panel with a wxChoice
604 // loses the focus, then you get a *fake* WM_LBUTTONUP message
605 // with x = 65535 and y = 65535. Filter out this nonsense.
606 //
607 // VZ: I'd like to know how to reproduce this please...
608 if ( x == 65535 && y == 65535 )
609 return 0;
610 }
611 break;
612
613 // we have to handle both: one for the normal case and the other
614 // for readonly
615 case WM_CTLCOLOREDIT:
616 case WM_CTLCOLORLISTBOX:
617 case WM_CTLCOLORSTATIC:
618 {
619 WXHDC hdc;
620 WXHWND hwnd;
621 UnpackCtlColor(wParam, lParam, &hdc, &hwnd);
622
623 WXHBRUSH hbr = MSWControlColor((WXHDC)hdc, hwnd);
624 if ( hbr )
625 return (WXLRESULT)hbr;
626 //else: fall through to default window proc
627 }
628 }
629
630 return wxWindow::MSWWindowProc(nMsg, wParam, lParam);
631 }
632
633 bool wxChoice::MSWCommand(WXUINT param, WXWORD WXUNUSED(id))
634 {
635 switch ( param )
636 {
637 case CBN_DROPDOWN:
638 // we don't want to track selection using CB_GETCURSEL while the
639 // dropdown is opened
640 m_lastAcceptedSelection = GetCurrentSelection();
641 break;
642
643 case CBN_CLOSEUP:
644 // it should be safe to use CB_GETCURSEL again
645 m_lastAcceptedSelection = wxID_NONE;
646 break;
647
648 case CBN_SELCHANGE:
649 {
650 const int n = GetSelection();
651
652 wxCommandEvent event(wxEVT_COMMAND_CHOICE_SELECTED, m_windowId);
653 event.SetInt(n);
654 event.SetEventObject(this);
655
656 if ( n > -1 )
657 {
658 event.SetString(GetStringSelection());
659 if ( HasClientObjectData() )
660 event.SetClientObject( GetClientObject(n) );
661 else if ( HasClientUntypedData() )
662 event.SetClientData( GetClientData(n) );
663 }
664
665 ProcessCommand(event);
666 }
667 return true;
668 }
669
670 return false;
671 }
672
673 WXHBRUSH wxChoice::MSWControlColor(WXHDC hDC, WXHWND hWnd)
674 {
675 if ( !IsEnabled() )
676 return MSWControlColorDisabled(hDC);
677
678 return wxChoiceBase::MSWControlColor(hDC, hWnd);
679 }
680
681 #endif // wxUSE_CHOICE && !(__SMARTPHONE__ && __WXWINCE__)
682