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__))
29 #include "wx/choice.h"
36 #include "wx/settings.h"
39 #include "wx/msw/private.h"
41 #if wxUSE_EXTENDED_RTTI
42 WX_DEFINE_FLAGS( wxChoiceStyle
)
44 wxBEGIN_FLAGS( wxChoiceStyle
)
45 // new style border flags, we put them first to
46 // use them for streaming out
47 wxFLAGS_MEMBER(wxBORDER_SIMPLE
)
48 wxFLAGS_MEMBER(wxBORDER_SUNKEN
)
49 wxFLAGS_MEMBER(wxBORDER_DOUBLE
)
50 wxFLAGS_MEMBER(wxBORDER_RAISED
)
51 wxFLAGS_MEMBER(wxBORDER_STATIC
)
52 wxFLAGS_MEMBER(wxBORDER_NONE
)
54 // old style border flags
55 wxFLAGS_MEMBER(wxSIMPLE_BORDER
)
56 wxFLAGS_MEMBER(wxSUNKEN_BORDER
)
57 wxFLAGS_MEMBER(wxDOUBLE_BORDER
)
58 wxFLAGS_MEMBER(wxRAISED_BORDER
)
59 wxFLAGS_MEMBER(wxSTATIC_BORDER
)
60 wxFLAGS_MEMBER(wxBORDER
)
62 // standard window styles
63 wxFLAGS_MEMBER(wxTAB_TRAVERSAL
)
64 wxFLAGS_MEMBER(wxCLIP_CHILDREN
)
65 wxFLAGS_MEMBER(wxTRANSPARENT_WINDOW
)
66 wxFLAGS_MEMBER(wxWANTS_CHARS
)
67 wxFLAGS_MEMBER(wxFULL_REPAINT_ON_RESIZE
)
68 wxFLAGS_MEMBER(wxALWAYS_SHOW_SB
)
69 wxFLAGS_MEMBER(wxVSCROLL
)
70 wxFLAGS_MEMBER(wxHSCROLL
)
72 wxEND_FLAGS( wxChoiceStyle
)
74 IMPLEMENT_DYNAMIC_CLASS_XTI(wxChoice
, wxControlWithItems
,"wx/choice.h")
76 wxBEGIN_PROPERTIES_TABLE(wxChoice
)
77 wxEVENT_PROPERTY( Select
, wxEVT_COMMAND_CHOICE_SELECTED
, wxCommandEvent
)
79 wxPROPERTY( Font
, wxFont
, SetFont
, GetFont
, EMPTY_MACROVALUE
, 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
80 wxPROPERTY_COLLECTION( Choices
, wxArrayString
, wxString
, AppendString
, GetStrings
, 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
81 wxPROPERTY( Selection
,int, SetSelection
, GetSelection
, EMPTY_MACROVALUE
, 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
82 wxPROPERTY_FLAGS( WindowStyle
, wxChoiceStyle
, long , SetWindowStyleFlag
, GetWindowStyleFlag
, EMPTY_MACROVALUE
, 0 /*flags*/ , wxT("Helpstring") , wxT("group")) // style
83 wxEND_PROPERTIES_TABLE()
85 wxBEGIN_HANDLERS_TABLE(wxChoice
)
86 wxEND_HANDLERS_TABLE()
88 wxCONSTRUCTOR_4( wxChoice
, wxWindow
* , Parent
, wxWindowID
, Id
, wxPoint
, Position
, wxSize
, Size
)
90 IMPLEMENT_DYNAMIC_CLASS(wxChoice
, wxControlWithItems
)
99 // ============================================================================
101 // ============================================================================
103 // ----------------------------------------------------------------------------
105 // ----------------------------------------------------------------------------
107 bool wxChoice::Create(wxWindow
*parent
,
111 int n
, const wxString choices
[],
113 const wxValidator
& validator
,
114 const wxString
& name
)
116 // Experience shows that wxChoice vs. wxComboBox distinction confuses
117 // quite a few people - try to help them
118 wxASSERT_MSG( !(style
& wxCB_DROPDOWN
) &&
119 !(style
& wxCB_READONLY
) &&
120 !(style
& wxCB_SIMPLE
),
121 wxT("this style flag is ignored by wxChoice, you ")
122 wxT("probably want to use a wxComboBox") );
124 return CreateAndInit(parent
, id
, pos
, size
, n
, choices
, style
,
128 bool wxChoice::CreateAndInit(wxWindow
*parent
,
132 int n
, const wxString choices
[],
134 const wxValidator
& validator
,
135 const wxString
& name
)
137 // initialize wxControl
138 if ( !CreateControl(parent
, id
, pos
, size
, style
, validator
, name
) )
141 // now create the real HWND
142 if ( !MSWCreateControl(wxT("COMBOBOX"), wxEmptyString
, pos
, size
) )
146 // initialize the controls contents
147 for ( int i
= 0; i
< n
; i
++ )
152 // and now we may finally size the control properly (if needed)
153 SetInitialSize(size
);
158 void wxChoice::SetLabel(const wxString
& label
)
160 if ( FindString(label
) == wxNOT_FOUND
)
162 // unless we explicitly do this here, CB_GETCURSEL will continue to
163 // return the index of the previously selected item which will result
164 // in wrongly replacing the value being set now with the previously
165 // value if the user simply opens and closes (without selecting
166 // anything) the combobox popup
170 wxChoiceBase::SetLabel(label
);
173 bool wxChoice::Create(wxWindow
*parent
,
177 const wxArrayString
& choices
,
179 const wxValidator
& validator
,
180 const wxString
& name
)
182 wxCArrayString
chs(choices
);
183 return Create(parent
, id
, pos
, size
, chs
.GetCount(), chs
.GetStrings(),
184 style
, validator
, name
);
187 bool wxChoice::MSWShouldPreProcessMessage(WXMSG
*pMsg
)
189 MSG
*msg
= (MSG
*) pMsg
;
191 // if the dropdown list is visible, don't preprocess certain keys
192 if ( msg
->message
== WM_KEYDOWN
193 && (msg
->wParam
== VK_ESCAPE
|| msg
->wParam
== VK_RETURN
) )
195 if (::SendMessage(GetHwndOf(this), CB_GETDROPPEDSTATE
, 0, 0))
201 return wxControl::MSWShouldPreProcessMessage(pMsg
);
204 WXDWORD
wxChoice::MSWGetStyle(long style
, WXDWORD
*exstyle
) const
206 // we never have an external border
207 WXDWORD msStyle
= wxControl::MSWGetStyle
209 (style
& ~wxBORDER_MASK
) | wxBORDER_NONE
, exstyle
212 // WS_CLIPSIBLINGS is useful with wxChoice and doesn't seem to result in
214 msStyle
|= WS_CLIPSIBLINGS
;
216 // wxChoice-specific styles
217 msStyle
|= CBS_DROPDOWNLIST
| WS_HSCROLL
| WS_VSCROLL
;
218 if ( style
& wxCB_SORT
)
225 #define EP_EDITTEXT 1
230 wxChoice::GetClassDefaultAttributes(wxWindowVariant
WXUNUSED(variant
))
232 // it is important to return valid values for all attributes from here,
233 // GetXXX() below rely on this
234 wxVisualAttributes attrs
;
236 // FIXME: Use better dummy window?
237 wxWindow
* wnd
= wxTheApp
->GetTopWindow();
241 attrs
.font
= wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT
);
243 // there doesn't seem to be any way to get the text colour using themes
244 // API: TMT_TEXTCOLOR doesn't work neither for EDIT nor COMBOBOX
245 attrs
.colFg
= wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOWTEXT
);
247 // NB: use EDIT, not COMBOBOX (the latter works in XP but not Vista)
248 attrs
.colBg
= wnd
->MSWGetThemeColour(L
"EDIT",
251 ThemeColourBackground
,
252 wxSYS_COLOUR_WINDOW
);
257 wxChoice::~wxChoice()
262 // ----------------------------------------------------------------------------
263 // adding/deleting items to/from the list
264 // ----------------------------------------------------------------------------
266 int wxChoice::DoInsertItems(const wxArrayStringsAdapter
& items
,
268 void **clientData
, wxClientDataType type
)
270 MSWAllocStorage(items
, CB_INITSTORAGE
);
272 const bool append
= pos
== GetCount();
274 // use CB_ADDSTRING when appending at the end to make sure the control is
275 // resorted if it has wxCB_SORT style
276 const unsigned msg
= append
? CB_ADDSTRING
: CB_INSERTSTRING
;
282 const unsigned numItems
= items
.GetCount();
283 for ( unsigned i
= 0; i
< numItems
; ++i
)
285 n
= MSWInsertOrAppendItem(pos
, items
[i
], msg
);
286 if ( n
== wxNOT_FOUND
)
292 AssignNewItemClientData(n
, clientData
, i
, type
);
295 // we need to refresh our size in order to have enough space for the
298 MSWUpdateDropDownHeight();
300 InvalidateBestSize();
305 void wxChoice::DoDeleteOneItem(unsigned int n
)
307 wxCHECK_RET( IsValid(n
), wxT("invalid item index in wxChoice::Delete") );
309 SendMessage(GetHwnd(), CB_DELETESTRING
, n
, 0);
312 MSWUpdateDropDownHeight();
314 InvalidateBestSize();
317 void wxChoice::DoClear()
319 SendMessage(GetHwnd(), CB_RESETCONTENT
, 0, 0);
322 MSWUpdateDropDownHeight();
324 InvalidateBestSize();
327 // ----------------------------------------------------------------------------
329 // ----------------------------------------------------------------------------
331 int wxChoice::GetSelection() const
333 // if m_lastAcceptedSelection is set, it means that the dropdown is
334 // currently shown and that we want to use the last "permanent" selection
335 // instead of whatever is under the mouse pointer currently
337 // otherwise, get the selection from the control
338 return m_lastAcceptedSelection
== wxID_NONE
? GetCurrentSelection()
339 : m_lastAcceptedSelection
;
342 int wxChoice::GetCurrentSelection() const
344 return (int)SendMessage(GetHwnd(), CB_GETCURSEL
, 0, 0);
347 void wxChoice::SetSelection(int n
)
349 SendMessage(GetHwnd(), CB_SETCURSEL
, n
, 0);
352 // ----------------------------------------------------------------------------
353 // string list functions
354 // ----------------------------------------------------------------------------
356 unsigned int wxChoice::GetCount() const
358 return (unsigned int)SendMessage(GetHwnd(), CB_GETCOUNT
, 0, 0);
361 int wxChoice::FindString(const wxString
& s
, bool bCase
) const
363 #if defined(__WATCOMC__) && defined(__WIN386__)
364 // For some reason, Watcom in WIN386 mode crashes in the CB_FINDSTRINGEXACT message.
365 // wxChoice::Do it the long way instead.
366 unsigned int count
= GetCount();
367 for ( unsigned int i
= 0; i
< count
; i
++ )
369 // as CB_FINDSTRINGEXACT is case insensitive, be case insensitive too
370 if (GetString(i
).IsSameAs(s
, bCase
))
376 //TODO: Evidently some MSW versions (all?) don't like empty strings
377 //passed to SendMessage, so we have to do it ourselves in that case
380 unsigned int count
= GetCount();
381 for ( unsigned int i
= 0; i
< count
; i
++ )
383 if (GetString(i
).empty())
391 // back to base class search for not native search type
392 return wxItemContainerImmutable::FindString( s
, bCase
);
396 int pos
= (int)SendMessage(GetHwnd(), CB_FINDSTRINGEXACT
,
397 (WPARAM
)-1, (LPARAM
)s
.wx_str());
399 return pos
== LB_ERR
? wxNOT_FOUND
: pos
;
401 #endif // Watcom/!Watcom
404 void wxChoice::SetString(unsigned int n
, const wxString
& s
)
406 wxCHECK_RET( IsValid(n
), wxT("invalid item index in wxChoice::SetString") );
408 // we have to delete and add back the string as there is no way to change a
411 // we need to preserve the client data manually
412 void *oldData
= NULL
;
413 wxClientData
*oldObjData
= NULL
;
414 if ( HasClientUntypedData() )
415 oldData
= GetClientData(n
);
416 else if ( HasClientObjectData() )
417 oldObjData
= GetClientObject(n
);
419 ::SendMessage(GetHwnd(), CB_DELETESTRING
, n
, 0);
420 ::SendMessage(GetHwnd(), CB_INSERTSTRING
, n
, (LPARAM
)s
.wx_str() );
422 // restore the client data
424 SetClientData(n
, oldData
);
425 else if ( oldObjData
)
426 SetClientObject(n
, oldObjData
);
428 InvalidateBestSize();
431 wxString
wxChoice::GetString(unsigned int n
) const
433 int len
= (int)::SendMessage(GetHwnd(), CB_GETLBTEXTLEN
, n
, 0);
436 if ( len
!= CB_ERR
&& len
> 0 )
443 (LPARAM
)(wxChar
*)wxStringBuffer(str
, len
)
446 wxLogLastError(wxT("SendMessage(CB_GETLBTEXT)"));
453 // ----------------------------------------------------------------------------
455 // ----------------------------------------------------------------------------
457 void wxChoice::DoSetItemClientData(unsigned int n
, void* clientData
)
459 if ( ::SendMessage(GetHwnd(), CB_SETITEMDATA
,
460 n
, (LPARAM
)clientData
) == CB_ERR
)
462 wxLogLastError(wxT("CB_SETITEMDATA"));
466 void* wxChoice::DoGetItemClientData(unsigned int n
) const
468 LPARAM rc
= SendMessage(GetHwnd(), CB_GETITEMDATA
, n
, 0);
471 wxLogLastError(wxT("CB_GETITEMDATA"));
473 // unfortunately, there is no way to return an error code to the user
480 // ----------------------------------------------------------------------------
481 // wxMSW-specific geometry management
482 // ----------------------------------------------------------------------------
487 // there is a difference between the height passed to CB_SETITEMHEIGHT and the
488 // real height of the combobox; it is probably not constant for all Windows
489 // versions/settings but right now I don't know how to find what it is so it is
490 // temporarily hardcoded to its value under XP systems with normal fonts sizes
491 const int COMBO_HEIGHT_ADJ
= 6;
493 } // anonymous namespace
495 void wxChoice::MSWUpdateVisibleHeight()
497 if ( m_heightOwn
!= wxDefaultCoord
)
499 ::SendMessage(GetHwnd(), CB_SETITEMHEIGHT
,
500 (WPARAM
)-1, m_heightOwn
- COMBO_HEIGHT_ADJ
);
504 #if wxUSE_DEFERRED_SIZING
505 void wxChoice::MSWEndDeferWindowPos()
507 // we can only set the height of the choice itself now as it is reset to
508 // default every time the control is resized
509 MSWUpdateVisibleHeight();
511 wxChoiceBase::MSWEndDeferWindowPos();
513 #endif // wxUSE_DEFERRED_SIZING
515 void wxChoice::MSWUpdateDropDownHeight()
517 // be careful to not change the width here
518 DoSetSize(wxDefaultCoord
, wxDefaultCoord
, wxDefaultCoord
, GetSize().y
,
519 wxSIZE_USE_EXISTING
);
522 void wxChoice::DoMoveWindow(int x
, int y
, int width
, int height
)
524 // here is why this is necessary: if the width is negative, the combobox
525 // window proc makes the window of the size width*height instead of
526 // interpreting height in the usual manner (meaning the height of the drop
527 // down list - usually the height specified in the call to MoveWindow()
528 // will not change the height of combo box per se)
530 // this behaviour is not documented anywhere, but this is just how it is
531 // here (NT 4.4) and, anyhow, the check shouldn't hurt - however without
532 // the check, constraints/sizers using combos may break the height
533 // constraint will have not at all the same value as expected
537 wxControl::DoMoveWindow(x
, y
, width
, height
);
540 void wxChoice::DoGetSize(int *w
, int *h
) const
542 wxControl::DoGetSize(w
, h
);
544 // this is weird: sometimes, the height returned by Windows is clearly the
545 // total height of the control including the drop down list -- but only
546 // sometimes, and sometimes it isn't so work around this here by using our
547 // own stored value if we have it
548 if ( h
&& m_heightOwn
!= wxDefaultCoord
)
552 void wxChoice::DoSetSize(int x
, int y
,
553 int width
, int height
,
556 const int heightBest
= GetBestSize().y
;
558 // we need the real height below so get the current one if it's not given
559 if ( height
== wxDefaultCoord
)
561 // height not specified, use the same as before
562 DoGetSize(NULL
, &height
);
564 else if ( height
== heightBest
)
566 // we don't need to manually manage our height, let the system use the
568 m_heightOwn
= wxDefaultCoord
;
570 else // non-default height specified
572 // set our new own height but be careful not to make it too big: the
573 // native control apparently stores it as a single byte and so setting
574 // own height to 256 pixels results in default height being used (255
576 m_heightOwn
= height
;
578 if ( m_heightOwn
> UCHAR_MAX
)
579 m_heightOwn
= UCHAR_MAX
;
580 // nor too small: see MSWUpdateVisibleHeight()
581 else if ( m_heightOwn
< COMBO_HEIGHT_ADJ
)
582 m_heightOwn
= COMBO_HEIGHT_ADJ
;
586 // the height which we must pass to Windows should be the total height of
587 // the control including the drop down list while the height given to us
588 // is, of course, just the height of the permanently visible part of it so
589 // add the drop down height to it
591 // don't make the drop down list too tall, arbitrarily limit it to 30
592 // items max and also don't make it too small if it's currently empty
593 size_t nItems
= GetCount();
594 if (!HasFlag(wxCB_SIMPLE
))
598 else if ( nItems
> 30 )
602 const int hItem
= SendMessage(GetHwnd(), CB_GETITEMHEIGHT
, 0, 0);
603 int heightWithItems
= 0;
604 if (!HasFlag(wxCB_SIMPLE
))
605 heightWithItems
= height
+ hItem
*nItems
;
607 heightWithItems
= SetHeightSimpleComboBox(nItems
);
610 // do resize the native control
611 wxControl::DoSetSize(x
, y
, width
, heightWithItems
, sizeFlags
);
614 // make the control itself of the requested height: notice that this
615 // must be done after changing its size or it has no effect (apparently
616 // the height is reset to default during the control layout) and that it's
617 // useless to to do it when using the deferred sizing -- in this case it
618 // will be done from MSWEndDeferWindowPos()
619 #if wxUSE_DEFERRED_SIZING
620 if ( m_pendingSize
== wxDefaultSize
)
622 // not using deferred sizing, update it immediately
623 MSWUpdateVisibleHeight();
625 else // in the middle of deferred sizing
627 // we need to report the size of the visible part of the control back
628 // in GetSize() and not height stored by DoSetSize() in m_pendingSize
629 m_pendingSize
= wxSize(width
, height
);
631 #else // !wxUSE_DEFERRED_SIZING
632 // always update the visible height immediately
633 MSWUpdateVisibleHeight();
634 #endif // wxUSE_DEFERRED_SIZING
637 wxSize
wxChoice::DoGetBestSize() const
639 // find the widest string
642 const unsigned int nItems
= GetCount();
643 for ( unsigned int i
= 0; i
< nItems
; i
++ )
646 GetTextExtent(GetString(i
), &wLine
, NULL
);
647 if ( wLine
> wChoice
)
651 // give it some reasonable default value if there are no strings in the
656 // the combobox should be slightly larger than the widest string
657 wChoice
+= 5*GetCharWidth();
658 if( HasFlag( wxCB_SIMPLE
) )
660 hChoice
= SetHeightSimpleComboBox( nItems
);
663 hChoice
= EDIT_HEIGHT_FROM_CHAR_HEIGHT(GetCharHeight());
665 wxSize
best(wChoice
, hChoice
);
670 int wxChoice::SetHeightSimpleComboBox(int nItems
) const
673 wxGetCharSize( GetHWND(), &cx
, &cy
, GetFont() );
674 int hItem
= SendMessage(GetHwnd(), CB_GETITEMHEIGHT
, (WPARAM
)-1, 0);
675 return EDIT_HEIGHT_FROM_CHAR_HEIGHT( cy
) * wxMin( wxMax( nItems
, 3 ), 6 ) + hItem
- 1;
678 // ----------------------------------------------------------------------------
679 // MSW message handlers
680 // ----------------------------------------------------------------------------
682 WXLRESULT
wxChoice::MSWWindowProc(WXUINT nMsg
, WXWPARAM wParam
, WXLPARAM lParam
)
688 int x
= (int)LOWORD(lParam
);
689 int y
= (int)HIWORD(lParam
);
691 // Ok, this is truly weird, but if a panel with a wxChoice
692 // loses the focus, then you get a *fake* WM_LBUTTONUP message
693 // with x = 65535 and y = 65535. Filter out this nonsense.
695 // VZ: I'd like to know how to reproduce this please...
696 if ( x
== 65535 && y
== 65535 )
701 // we have to handle both: one for the normal case and the other
703 case WM_CTLCOLOREDIT
:
704 case WM_CTLCOLORLISTBOX
:
705 case WM_CTLCOLORSTATIC
:
709 UnpackCtlColor(wParam
, lParam
, &hdc
, &hwnd
);
711 WXHBRUSH hbr
= MSWControlColor((WXHDC
)hdc
, hwnd
);
713 return (WXLRESULT
)hbr
;
714 //else: fall through to default window proc
718 return wxWindow::MSWWindowProc(nMsg
, wParam
, lParam
);
721 bool wxChoice::MSWCommand(WXUINT param
, WXWORD
WXUNUSED(id
))
724 The native control provides a great variety in the events it sends in
725 the different selection scenarios (undoubtedly for greater amusement of
726 the programmers using it). For the reference, here are the cases when
727 the final selection is accepted (things are quite interesting when it
730 A. Selecting with just the arrows without opening the dropdown:
734 B. Opening dropdown with F4 and selecting with arrows:
736 2. many CBN_SELCHANGE while changing selection in the list
740 C. Selecting with the mouse:
742 -- no intermediate CBN_SELCHANGEs --
747 Admire the different order of messages in all of those cases, it must
748 surely have taken a lot of effort to Microsoft developers to achieve
754 // we use this value both because we don't want to track selection
755 // using CB_GETCURSEL while the dropdown is opened and because we
756 // need to reset the selection back to it if it's eventually
758 m_lastAcceptedSelection
= GetCurrentSelection();
762 // if the selection was accepted by the user, it should have been
763 // reset to wxID_NONE by CBN_SELENDOK, otherwise the selection was
764 // cancelled and we must restore the old one
765 if ( m_lastAcceptedSelection
!= wxID_NONE
)
767 SetSelection(m_lastAcceptedSelection
);
768 m_lastAcceptedSelection
= wxID_NONE
;
773 // reset it to prevent CBN_CLOSEUP from undoing the selection (it's
774 // ok to reset it now as GetCurrentSelection() will now return the
775 // same thing anyhow)
776 m_lastAcceptedSelection
= wxID_NONE
;
779 const int n
= GetSelection();
781 wxCommandEvent
event(wxEVT_COMMAND_CHOICE_SELECTED
, m_windowId
);
783 event
.SetEventObject(this);
787 event
.SetString(GetStringSelection());
788 InitCommandEventWithItems(event
, n
);
791 ProcessCommand(event
);
795 // don't handle CBN_SELENDCANCEL: just leave m_lastAcceptedSelection
796 // valid and the selection will be undone in CBN_CLOSEUP above
798 // don't handle CBN_SELCHANGE neither, we don't want to generate events
799 // while the dropdown is opened -- but do add it if we ever need this
808 WXHBRUSH
wxChoice::MSWControlColor(WXHDC hDC
, WXHWND hWnd
)
811 return MSWControlColorDisabled(hDC
);
813 return wxChoiceBase::MSWControlColor(hDC
, hWnd
);
816 #endif // wxUSE_CHOICE && !(__SMARTPHONE__ && __WXWINCE__)