1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/msw/choice.cpp
4 // Author: Julian Smart
5 // Modified by: Vadim Zeitlin to derive from wxChoiceBase
8 // Copyright: (c) Julian Smart
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
12 // ============================================================================
14 // ============================================================================
16 // ----------------------------------------------------------------------------
18 // ----------------------------------------------------------------------------
20 // For compilers that support precompilation, includes "wx.h".
21 #include "wx/wxprec.h"
27 #if wxUSE_CHOICE && !(defined(__SMARTPHONE__) && defined(__WXWINCE__))
30 #include "wx/choice.h"
34 #include "wx/settings.h"
37 #include "wx/msw/private.h"
39 #if wxUSE_EXTENDED_RTTI
40 WX_DEFINE_FLAGS( wxChoiceStyle
)
42 wxBEGIN_FLAGS( wxChoiceStyle
)
43 // new style border flags, we put them first to
44 // use them for streaming out
45 wxFLAGS_MEMBER(wxBORDER_SIMPLE
)
46 wxFLAGS_MEMBER(wxBORDER_SUNKEN
)
47 wxFLAGS_MEMBER(wxBORDER_DOUBLE
)
48 wxFLAGS_MEMBER(wxBORDER_RAISED
)
49 wxFLAGS_MEMBER(wxBORDER_STATIC
)
50 wxFLAGS_MEMBER(wxBORDER_NONE
)
52 // old style border flags
53 wxFLAGS_MEMBER(wxSIMPLE_BORDER
)
54 wxFLAGS_MEMBER(wxSUNKEN_BORDER
)
55 wxFLAGS_MEMBER(wxDOUBLE_BORDER
)
56 wxFLAGS_MEMBER(wxRAISED_BORDER
)
57 wxFLAGS_MEMBER(wxSTATIC_BORDER
)
58 wxFLAGS_MEMBER(wxBORDER
)
60 // standard window styles
61 wxFLAGS_MEMBER(wxTAB_TRAVERSAL
)
62 wxFLAGS_MEMBER(wxCLIP_CHILDREN
)
63 wxFLAGS_MEMBER(wxTRANSPARENT_WINDOW
)
64 wxFLAGS_MEMBER(wxWANTS_CHARS
)
65 wxFLAGS_MEMBER(wxFULL_REPAINT_ON_RESIZE
)
66 wxFLAGS_MEMBER(wxALWAYS_SHOW_SB
)
67 wxFLAGS_MEMBER(wxVSCROLL
)
68 wxFLAGS_MEMBER(wxHSCROLL
)
70 wxEND_FLAGS( wxChoiceStyle
)
72 IMPLEMENT_DYNAMIC_CLASS_XTI(wxChoice
, wxControl
,"wx/choice.h")
74 wxBEGIN_PROPERTIES_TABLE(wxChoice
)
75 wxEVENT_PROPERTY( Select
, wxEVT_COMMAND_CHOICE_SELECTED
, wxCommandEvent
)
77 wxPROPERTY( Font
, wxFont
, SetFont
, GetFont
, EMPTY_MACROVALUE
, 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
78 wxPROPERTY_COLLECTION( Choices
, wxArrayString
, wxString
, AppendString
, GetStrings
, 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
79 wxPROPERTY( Selection
,int, SetSelection
, GetSelection
, EMPTY_MACROVALUE
, 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
80 wxPROPERTY_FLAGS( WindowStyle
, wxChoiceStyle
, long , SetWindowStyleFlag
, GetWindowStyleFlag
, EMPTY_MACROVALUE
, 0 /*flags*/ , wxT("Helpstring") , wxT("group")) // style
81 wxEND_PROPERTIES_TABLE()
83 wxBEGIN_HANDLERS_TABLE(wxChoice
)
84 wxEND_HANDLERS_TABLE()
86 wxCONSTRUCTOR_4( wxChoice
, wxWindow
* , Parent
, wxWindowID
, Id
, wxPoint
, Position
, wxSize
, Size
)
88 IMPLEMENT_DYNAMIC_CLASS(wxChoice
, wxControl
)
97 // ============================================================================
99 // ============================================================================
101 // ----------------------------------------------------------------------------
103 // ----------------------------------------------------------------------------
105 bool wxChoice::Create(wxWindow
*parent
,
109 int n
, const wxString choices
[],
111 const wxValidator
& validator
,
112 const wxString
& name
)
114 // Experience shows that wxChoice vs. wxComboBox distinction confuses
115 // quite a few people - try to help them
116 wxASSERT_MSG( !(style
& wxCB_DROPDOWN
) &&
117 !(style
& wxCB_READONLY
) &&
118 !(style
& wxCB_SIMPLE
),
119 _T("this style flag is ignored by wxChoice, you ")
120 _T("probably want to use a wxComboBox") );
122 return CreateAndInit(parent
, id
, pos
, size
, n
, choices
, style
,
126 bool wxChoice::CreateAndInit(wxWindow
*parent
,
130 int n
, const wxString choices
[],
132 const wxValidator
& validator
,
133 const wxString
& name
)
135 // initialize wxControl
136 if ( !CreateControl(parent
, id
, pos
, size
, style
, validator
, name
) )
139 // now create the real HWND
140 if ( !MSWCreateControl(wxT("COMBOBOX"), wxEmptyString
, pos
, size
) )
144 // choice/combobox normally has "white" (depends on colour scheme, of
145 // course) background rather than inheriting the parent's background
146 SetBackgroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOW
));
148 // initialize the controls contents
149 for ( int i
= 0; i
< n
; i
++ )
154 // and now we may finally size the control properly (if needed)
160 bool wxChoice::Create(wxWindow
*parent
,
164 const wxArrayString
& choices
,
166 const wxValidator
& validator
,
167 const wxString
& name
)
169 wxCArrayString
chs(choices
);
170 return Create(parent
, id
, pos
, size
, chs
.GetCount(), chs
.GetStrings(),
171 style
, validator
, name
);
174 bool wxChoice::MSWShouldPreProcessMessage(WXMSG
*pMsg
)
176 MSG
*msg
= (MSG
*) pMsg
;
178 // if the dropdown list is visible, don't preprocess certain keys
179 if ( msg
->message
== WM_KEYDOWN
180 && (msg
->wParam
== VK_ESCAPE
|| msg
->wParam
== VK_RETURN
) )
182 if (::SendMessage(GetHwndOf(this), CB_GETDROPPEDSTATE
, 0, 0))
188 return wxControl::MSWShouldPreProcessMessage(pMsg
);
191 WXDWORD
wxChoice::MSWGetStyle(long style
, WXDWORD
*exstyle
) const
193 // we never have an external border
194 WXDWORD msStyle
= wxControl::MSWGetStyle
196 (style
& ~wxBORDER_MASK
) | wxBORDER_NONE
, exstyle
199 // WS_CLIPSIBLINGS is useful with wxChoice and doesn't seem to result in
201 msStyle
|= WS_CLIPSIBLINGS
;
203 // wxChoice-specific styles
204 msStyle
|= CBS_DROPDOWNLIST
| WS_HSCROLL
| WS_VSCROLL
;
205 if ( style
& wxCB_SORT
)
211 wxChoice::~wxChoice()
216 // ----------------------------------------------------------------------------
217 // adding/deleting items to/from the list
218 // ----------------------------------------------------------------------------
220 int wxChoice::DoAppend(const wxString
& item
)
222 int n
= (int)SendMessage(GetHwnd(), CB_ADDSTRING
, 0, (LPARAM
)item
.c_str());
225 wxLogLastError(wxT("SendMessage(CB_ADDSTRING)"));
229 // we need to refresh our size in order to have enough space for the
232 UpdateVisibleHeight();
235 InvalidateBestSize();
239 int wxChoice::DoInsert(const wxString
& item
, unsigned int pos
)
241 wxCHECK_MSG(!(GetWindowStyle() & wxCB_SORT
), -1, wxT("can't insert into sorted list"));
242 wxCHECK_MSG(IsValidInsert(pos
), -1, wxT("invalid index"));
244 int n
= (int)SendMessage(GetHwnd(), CB_INSERTSTRING
, pos
, (LPARAM
)item
.c_str());
247 wxLogLastError(wxT("SendMessage(CB_INSERTSTRING)"));
252 UpdateVisibleHeight();
255 InvalidateBestSize();
259 void wxChoice::Delete(unsigned int n
)
261 wxCHECK_RET( IsValid(n
), wxT("invalid item index in wxChoice::Delete") );
263 if ( HasClientObjectData() )
265 delete GetClientObject(n
);
268 SendMessage(GetHwnd(), CB_DELETESTRING
, n
, 0);
271 UpdateVisibleHeight();
273 InvalidateBestSize();
276 void wxChoice::Clear()
280 SendMessage(GetHwnd(), CB_RESETCONTENT
, 0, 0);
283 UpdateVisibleHeight();
285 InvalidateBestSize();
288 void wxChoice::Free()
290 if ( HasClientObjectData() )
292 unsigned int count
= GetCount();
293 for ( unsigned int n
= 0; n
< count
; n
++ )
295 delete GetClientObject(n
);
300 // ----------------------------------------------------------------------------
302 // ----------------------------------------------------------------------------
304 int wxChoice::GetSelection() const
306 // if m_lastAcceptedSelection is set, it means that the dropdown is
307 // currently shown and that we want to use the last "permanent" selection
308 // instead of whatever is under the mouse pointer currently
310 // otherwise, get the selection from the control
311 return m_lastAcceptedSelection
== wxID_NONE
? GetCurrentSelection()
312 : m_lastAcceptedSelection
;
315 int wxChoice::GetCurrentSelection() const
317 return (int)SendMessage(GetHwnd(), CB_GETCURSEL
, 0, 0);
320 void wxChoice::SetSelection(int n
)
322 SendMessage(GetHwnd(), CB_SETCURSEL
, n
, 0);
325 // ----------------------------------------------------------------------------
326 // string list functions
327 // ----------------------------------------------------------------------------
329 unsigned int wxChoice::GetCount() const
331 return (unsigned int)SendMessage(GetHwnd(), CB_GETCOUNT
, 0, 0);
334 int wxChoice::FindString(const wxString
& s
, bool bCase
) const
336 #if defined(__WATCOMC__) && defined(__WIN386__)
337 // For some reason, Watcom in WIN386 mode crashes in the CB_FINDSTRINGEXACT message.
338 // wxChoice::Do it the long way instead.
339 unsigned int count
= GetCount();
340 for ( unsigned int i
= 0; i
< count
; i
++ )
342 // as CB_FINDSTRINGEXACT is case insensitive, be case insensitive too
343 if (GetString(i
).IsSameAs(s
, bCase
))
349 //TODO: Evidently some MSW versions (all?) don't like empty strings
350 //passed to SendMessage, so we have to do it ourselves in that case
353 unsigned int count
= GetCount();
354 for ( unsigned int i
= 0; i
< count
; i
++ )
356 if (GetString(i
).empty())
364 // back to base class search for not native search type
365 return wxItemContainerImmutable::FindString( s
, bCase
);
369 int pos
= (int)SendMessage(GetHwnd(), CB_FINDSTRINGEXACT
,
370 (WPARAM
)-1, (LPARAM
)s
.c_str());
372 return pos
== LB_ERR
? wxNOT_FOUND
: pos
;
374 #endif // Watcom/!Watcom
377 void wxChoice::SetString(unsigned int n
, const wxString
& s
)
379 wxCHECK_RET( IsValid(n
), wxT("invalid item index in wxChoice::SetString") );
381 // we have to delete and add back the string as there is no way to change a
384 // we need to preserve the client data
386 if ( m_clientDataItemsType
!= wxClientData_None
)
388 data
= DoGetItemClientData(n
);
390 else // no client data
395 ::SendMessage(GetHwnd(), CB_DELETESTRING
, n
, 0);
396 ::SendMessage(GetHwnd(), CB_INSERTSTRING
, n
, (LPARAM
)s
.c_str() );
400 DoSetItemClientData(n
, data
);
402 //else: it's already NULL by default
404 InvalidateBestSize();
407 wxString
wxChoice::GetString(unsigned int n
) const
409 int len
= (int)::SendMessage(GetHwnd(), CB_GETLBTEXTLEN
, n
, 0);
412 if ( len
!= CB_ERR
&& len
> 0 )
419 (LPARAM
)(wxChar
*)wxStringBuffer(str
, len
)
422 wxLogLastError(wxT("SendMessage(CB_GETLBTEXT)"));
429 // ----------------------------------------------------------------------------
431 // ----------------------------------------------------------------------------
433 void wxChoice::DoSetItemClientData(unsigned int n
, void* clientData
)
435 if ( ::SendMessage(GetHwnd(), CB_SETITEMDATA
,
436 n
, (LPARAM
)clientData
) == CB_ERR
)
438 wxLogLastError(wxT("CB_SETITEMDATA"));
442 void* wxChoice::DoGetItemClientData(unsigned int n
) const
444 LPARAM rc
= SendMessage(GetHwnd(), CB_GETITEMDATA
, n
, 0);
447 wxLogLastError(wxT("CB_GETITEMDATA"));
449 // unfortunately, there is no way to return an error code to the user
456 void wxChoice::DoSetItemClientObject(unsigned int n
, wxClientData
* clientData
)
458 DoSetItemClientData(n
, clientData
);
461 wxClientData
* wxChoice::DoGetItemClientObject(unsigned int n
) const
463 return (wxClientData
*)DoGetItemClientData(n
);
466 // ----------------------------------------------------------------------------
467 // wxMSW specific helpers
468 // ----------------------------------------------------------------------------
470 void wxChoice::UpdateVisibleHeight()
472 // be careful to not change the width here
473 DoSetSize(wxDefaultCoord
, wxDefaultCoord
, wxDefaultCoord
, GetSize().y
, wxSIZE_USE_EXISTING
);
476 void wxChoice::DoMoveWindow(int x
, int y
, int width
, int height
)
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)
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
491 wxControl::DoMoveWindow(x
, y
, width
, height
);
494 void wxChoice::DoGetSize(int *w
, int *h
) const
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
500 wxControl::DoGetSize(w
, h
);
503 void wxChoice::DoSetSize(int x
, int y
,
504 int width
, int height
,
507 // the height which we must pass to Windows should be the total height of
508 // the control including the drop down list while the height given to us
509 // is, of course, just the height of the permanently visible part of it
510 if ( height
!= wxDefaultCoord
)
512 // don't make the drop down list too tall, arbitrarily limit it to 40
513 // items max and also don't leave it empty
514 size_t nItems
= GetCount();
517 else if ( nItems
> 24 )
520 // add space for the drop down list
521 const int hItem
= SendMessage(GetHwnd(), CB_GETITEMHEIGHT
, 0, 0);
522 height
+= hItem
*(nItems
+ 1);
526 // We cannot pass wxDefaultCoord as height to wxControl. wxControl uses
527 // wxGetWindowRect() to determine the current height of the combobox,
528 // and then again sets the combobox's height to that value. Unfortunately,
529 // wxGetWindowRect doesn't include the dropdown list's height (at least
530 // on Win2K), so this would result in a combobox with dropdown height of
531 // 1 pixel. We have to determine the default height ourselves and call
532 // wxControl with that value instead.
536 if (::SendMessage(GetHwnd(), CB_GETDROPPEDCONTROLRECT
, 0, (LPARAM
) &r
) != 0)
538 height
= h
+ r
.bottom
- r
.top
;
542 wxControl::DoSetSize(x
, y
, width
, height
, sizeFlags
);
544 // This solution works on XP, but causes choice/combobox lists to be
545 // too short on W2K and earlier.
547 int widthCurrent
, heightCurrent
;
548 DoGetSize(&widthCurrent
, &heightCurrent
);
550 // the height which we must pass to Windows should be the total height of
551 // the control including the drop down list while the height given to us
552 // is, of course, just the height of the permanently visible part of it
553 if ( height
!= wxDefaultCoord
&& height
!= heightCurrent
)
555 // don't make the drop down list too tall, arbitrarily limit it to 40
556 // items max and also don't leave it empty
557 unsigned int nItems
= GetCount();
560 else if ( nItems
> 24 )
563 // add space for the drop down list
564 const int hItem
= SendMessage(GetHwnd(), CB_GETITEMHEIGHT
, 0, 0);
565 height
+= hItem
*(nItems
+ 1);
567 else // keep the same height as now
569 // normally wxWindow::DoSetSize() checks if we set the same size as the
570 // window already has and does nothing in this case, but for us the
571 // check fails as the size we pass to it includes the dropdown while
572 // the size returned by our GetSize() does not, so test if the size
573 // didn't really change ourselves here
574 if ( width
== wxDefaultCoord
|| width
== widthCurrent
)
576 // size doesn't change, what about position?
577 int xCurrent
, yCurrent
;
578 DoGetPosition(&xCurrent
, &yCurrent
);
579 const bool defMeansUnchanged
= !(sizeFlags
& wxSIZE_ALLOW_MINUS_ONE
);
580 if ( ((x
== wxDefaultCoord
&& defMeansUnchanged
) || x
== xCurrent
)
582 ((y
== wxDefaultCoord
&& defMeansUnchanged
) || y
== yCurrent
) )
584 // nothing changes, nothing to do
589 // We cannot pass wxDefaultCoord as height to wxControl. wxControl uses
590 // wxGetWindowRect() to determine the current height of the combobox,
591 // and then again sets the combobox's height to that value. Unfortunately,
592 // wxGetWindowRect doesn't include the dropdown list's height (at least
593 // on Win2K), so this would result in a combobox with dropdown height of
594 // 1 pixel. We have to determine the default height ourselves and call
595 // wxControl with that value instead.
597 // Also notice that sometimes CB_GETDROPPEDCONTROLRECT seems to return
598 // wildly incorrect values (~32000) which looks like a bug in it, just
599 // ignore them in this case
601 if ( ::SendMessage(GetHwnd(), CB_GETDROPPEDCONTROLRECT
, 0, (LPARAM
) &r
)
602 && r
.bottom
< 30000 )
604 height
= heightCurrent
+ r
.bottom
- r
.top
;
608 wxControl::DoSetSize(x
, y
, width
, height
, sizeFlags
);
612 wxSize
wxChoice::DoGetBestSize() const
614 // find the widest string
616 const unsigned int nItems
= GetCount();
617 for ( unsigned int i
= 0; i
< nItems
; i
++ )
620 GetTextExtent(GetString(i
), &wLine
, NULL
);
621 if ( wLine
> wChoice
)
625 // give it some reasonable default value if there are no strings in the
630 // the combobox should be slightly larger than the widest string
631 wChoice
+= 5*GetCharWidth();
633 wxSize
best(wChoice
, EDIT_HEIGHT_FROM_CHAR_HEIGHT(GetCharHeight()));
638 WXLRESULT
wxChoice::MSWWindowProc(WXUINT nMsg
, WXWPARAM wParam
, WXLPARAM lParam
)
644 int x
= (int)LOWORD(lParam
);
645 int y
= (int)HIWORD(lParam
);
647 // Ok, this is truly weird, but if a panel with a wxChoice
648 // loses the focus, then you get a *fake* WM_LBUTTONUP message
649 // with x = 65535 and y = 65535. Filter out this nonsense.
651 // VZ: I'd like to know how to reproduce this please...
652 if ( x
== 65535 && y
== 65535 )
657 // we have to handle both: one for the normal case and the other
659 case WM_CTLCOLOREDIT
:
660 case WM_CTLCOLORLISTBOX
:
661 case WM_CTLCOLORSTATIC
:
665 UnpackCtlColor(wParam
, lParam
, &hdc
, &hwnd
);
667 WXHBRUSH hbr
= MSWControlColor((WXHDC
)hdc
, hwnd
);
669 return (WXLRESULT
)hbr
;
670 //else: fall through to default window proc
674 return wxWindow::MSWWindowProc(nMsg
, wParam
, lParam
);
677 bool wxChoice::MSWCommand(WXUINT param
, WXWORD
WXUNUSED(id
))
680 The native control provides a great variety in the events it sends in
681 the different selection scenarios (undoubtedly for greater amusement of
682 the programmers using it). For the reference, here are the cases when
683 the final selection is accepted (things are quite interesting when it
686 A. Selecting with just the arrows without opening the dropdown:
690 B. Opening dropdown with F4 and selecting with arrows:
692 2. many CBN_SELCHANGE while changing selection in the list
696 C. Selecting with the mouse:
698 -- no intermediate CBN_SELCHANGEs --
703 Admire the different order of messages in all of those cases, it must
704 surely have taken a lot of effort to Microsoft developers to achieve
710 // we use this value both because we don't want to track selection
711 // using CB_GETCURSEL while the dropdown is opened and because we
712 // need to reset the selection back to it if it's eventually
714 m_lastAcceptedSelection
= GetCurrentSelection();
718 // if the selection was accepted by the user, it should have been
719 // reset to wxID_NONE by CBN_SELENDOK, otherwise the selection was
720 // cancelled and we must restore the old one
721 if ( m_lastAcceptedSelection
!= wxID_NONE
)
723 SetSelection(m_lastAcceptedSelection
);
724 m_lastAcceptedSelection
= wxID_NONE
;
729 // reset it to prevent CBN_CLOSEUP from undoing the selection (it's
730 // ok to reset it now as GetCurrentSelection() will now return the
731 // same thing anyhow)
732 m_lastAcceptedSelection
= wxID_NONE
;
735 const int n
= GetSelection();
737 wxCommandEvent
event(wxEVT_COMMAND_CHOICE_SELECTED
, m_windowId
);
739 event
.SetEventObject(this);
743 event
.SetString(GetStringSelection());
744 InitCommandEventWithItems(event
, n
);
747 ProcessCommand(event
);
751 // don't handle CBN_SELENDCANCEL: just leave m_lastAcceptedSelection
752 // valid and the selection will be undone in CBN_CLOSEUP above
754 // don't handle CBN_SELCHANGE neither, we don't want to generate events
755 // while the dropdown is opened -- but do add it if we ever need this
764 WXHBRUSH
wxChoice::MSWControlColor(WXHDC hDC
, WXHWND hWnd
)
767 return MSWControlColorDisabled(hDC
);
769 return wxChoiceBase::MSWControlColor(hDC
, hWnd
);
772 #endif // wxUSE_CHOICE && !(__SMARTPHONE__ && __WXWINCE__)