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"
35 #include "wx/settings.h"
38 #include "wx/msw/private.h"
40 #if wxUSE_EXTENDED_RTTI
41 WX_DEFINE_FLAGS( wxChoiceStyle
)
43 wxBEGIN_FLAGS( wxChoiceStyle
)
44 // new style border flags, we put them first to
45 // use them for streaming out
46 wxFLAGS_MEMBER(wxBORDER_SIMPLE
)
47 wxFLAGS_MEMBER(wxBORDER_SUNKEN
)
48 wxFLAGS_MEMBER(wxBORDER_DOUBLE
)
49 wxFLAGS_MEMBER(wxBORDER_RAISED
)
50 wxFLAGS_MEMBER(wxBORDER_STATIC
)
51 wxFLAGS_MEMBER(wxBORDER_NONE
)
53 // old style border flags
54 wxFLAGS_MEMBER(wxSIMPLE_BORDER
)
55 wxFLAGS_MEMBER(wxSUNKEN_BORDER
)
56 wxFLAGS_MEMBER(wxDOUBLE_BORDER
)
57 wxFLAGS_MEMBER(wxRAISED_BORDER
)
58 wxFLAGS_MEMBER(wxSTATIC_BORDER
)
59 wxFLAGS_MEMBER(wxBORDER
)
61 // standard window styles
62 wxFLAGS_MEMBER(wxTAB_TRAVERSAL
)
63 wxFLAGS_MEMBER(wxCLIP_CHILDREN
)
64 wxFLAGS_MEMBER(wxTRANSPARENT_WINDOW
)
65 wxFLAGS_MEMBER(wxWANTS_CHARS
)
66 wxFLAGS_MEMBER(wxFULL_REPAINT_ON_RESIZE
)
67 wxFLAGS_MEMBER(wxALWAYS_SHOW_SB
)
68 wxFLAGS_MEMBER(wxVSCROLL
)
69 wxFLAGS_MEMBER(wxHSCROLL
)
71 wxEND_FLAGS( wxChoiceStyle
)
73 IMPLEMENT_DYNAMIC_CLASS_XTI(wxChoice
, wxControlWithItems
,"wx/choice.h")
75 wxBEGIN_PROPERTIES_TABLE(wxChoice
)
76 wxEVENT_PROPERTY( Select
, wxEVT_COMMAND_CHOICE_SELECTED
, wxCommandEvent
)
78 wxPROPERTY( Font
, wxFont
, SetFont
, GetFont
, EMPTY_MACROVALUE
, 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
79 wxPROPERTY_COLLECTION( Choices
, wxArrayString
, wxString
, AppendString
, GetStrings
, 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
80 wxPROPERTY( Selection
,int, SetSelection
, GetSelection
, EMPTY_MACROVALUE
, 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
81 wxPROPERTY_FLAGS( WindowStyle
, wxChoiceStyle
, long , SetWindowStyleFlag
, GetWindowStyleFlag
, EMPTY_MACROVALUE
, 0 /*flags*/ , wxT("Helpstring") , wxT("group")) // style
82 wxEND_PROPERTIES_TABLE()
84 wxBEGIN_HANDLERS_TABLE(wxChoice
)
85 wxEND_HANDLERS_TABLE()
87 wxCONSTRUCTOR_4( wxChoice
, wxWindow
* , Parent
, wxWindowID
, Id
, wxPoint
, Position
, wxSize
, Size
)
89 IMPLEMENT_DYNAMIC_CLASS(wxChoice
, wxControlWithItems
)
98 // ============================================================================
100 // ============================================================================
102 // ----------------------------------------------------------------------------
104 // ----------------------------------------------------------------------------
106 bool wxChoice::Create(wxWindow
*parent
,
110 int n
, const wxString choices
[],
112 const wxValidator
& validator
,
113 const wxString
& name
)
115 // Experience shows that wxChoice vs. wxComboBox distinction confuses
116 // quite a few people - try to help them
117 wxASSERT_MSG( !(style
& wxCB_DROPDOWN
) &&
118 !(style
& wxCB_READONLY
) &&
119 !(style
& wxCB_SIMPLE
),
120 _T("this style flag is ignored by wxChoice, you ")
121 _T("probably want to use a wxComboBox") );
123 return CreateAndInit(parent
, id
, pos
, size
, n
, choices
, style
,
127 bool wxChoice::CreateAndInit(wxWindow
*parent
,
131 int n
, const wxString choices
[],
133 const wxValidator
& validator
,
134 const wxString
& name
)
136 // initialize wxControl
137 if ( !CreateControl(parent
, id
, pos
, size
, style
, validator
, name
) )
140 // now create the real HWND
141 if ( !MSWCreateControl(wxT("COMBOBOX"), wxEmptyString
, pos
, size
) )
145 // choice/combobox normally has "white" (depends on colour scheme, of
146 // course) background rather than inheriting the parent's background
147 SetBackgroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOW
));
149 // initialize the controls contents
150 for ( int i
= 0; i
< n
; i
++ )
155 // and now we may finally size the control properly (if needed)
156 SetInitialSize(size
);
161 bool wxChoice::Create(wxWindow
*parent
,
165 const wxArrayString
& choices
,
167 const wxValidator
& validator
,
168 const wxString
& name
)
170 wxCArrayString
chs(choices
);
171 return Create(parent
, id
, pos
, size
, chs
.GetCount(), chs
.GetStrings(),
172 style
, validator
, name
);
175 bool wxChoice::MSWShouldPreProcessMessage(WXMSG
*pMsg
)
177 MSG
*msg
= (MSG
*) pMsg
;
179 // if the dropdown list is visible, don't preprocess certain keys
180 if ( msg
->message
== WM_KEYDOWN
181 && (msg
->wParam
== VK_ESCAPE
|| msg
->wParam
== VK_RETURN
) )
183 if (::SendMessage(GetHwndOf(this), CB_GETDROPPEDSTATE
, 0, 0))
189 return wxControl::MSWShouldPreProcessMessage(pMsg
);
192 WXDWORD
wxChoice::MSWGetStyle(long style
, WXDWORD
*exstyle
) const
194 // we never have an external border
195 WXDWORD msStyle
= wxControl::MSWGetStyle
197 (style
& ~wxBORDER_MASK
) | wxBORDER_NONE
, exstyle
200 // WS_CLIPSIBLINGS is useful with wxChoice and doesn't seem to result in
202 msStyle
|= WS_CLIPSIBLINGS
;
204 // wxChoice-specific styles
205 msStyle
|= CBS_DROPDOWNLIST
| WS_HSCROLL
| WS_VSCROLL
;
206 if ( style
& wxCB_SORT
)
212 wxChoice::~wxChoice()
217 // ----------------------------------------------------------------------------
218 // adding/deleting items to/from the list
219 // ----------------------------------------------------------------------------
221 int wxChoice::DoInsertItems(const wxArrayStringsAdapter
& items
,
223 void **clientData
, wxClientDataType type
)
225 MSWAllocStorage(items
, CB_INITSTORAGE
);
227 const bool append
= pos
== GetCount();
229 // use CB_ADDSTRING when appending at the end to make sure the control is
230 // resorted if it has wxCB_SORT style
231 const unsigned msg
= append
? CB_ADDSTRING
: CB_INSERTSTRING
;
237 const unsigned numItems
= items
.GetCount();
238 for ( unsigned i
= 0; i
< numItems
; ++i
)
240 n
= MSWInsertOrAppendItem(pos
, items
[i
], msg
);
241 if ( n
== wxNOT_FOUND
)
247 AssignNewItemClientData(n
, clientData
, i
, type
);
250 // we need to refresh our size in order to have enough space for the
253 UpdateVisibleHeight();
255 InvalidateBestSize();
260 void wxChoice::DoDeleteOneItem(unsigned int n
)
262 wxCHECK_RET( IsValid(n
), wxT("invalid item index in wxChoice::Delete") );
264 SendMessage(GetHwnd(), CB_DELETESTRING
, n
, 0);
267 UpdateVisibleHeight();
269 InvalidateBestSize();
272 void wxChoice::DoClear()
274 SendMessage(GetHwnd(), CB_RESETCONTENT
, 0, 0);
277 UpdateVisibleHeight();
279 InvalidateBestSize();
282 // ----------------------------------------------------------------------------
284 // ----------------------------------------------------------------------------
286 int wxChoice::GetSelection() const
288 // if m_lastAcceptedSelection is set, it means that the dropdown is
289 // currently shown and that we want to use the last "permanent" selection
290 // instead of whatever is under the mouse pointer currently
292 // otherwise, get the selection from the control
293 return m_lastAcceptedSelection
== wxID_NONE
? GetCurrentSelection()
294 : m_lastAcceptedSelection
;
297 int wxChoice::GetCurrentSelection() const
299 return (int)SendMessage(GetHwnd(), CB_GETCURSEL
, 0, 0);
302 void wxChoice::SetSelection(int n
)
304 SendMessage(GetHwnd(), CB_SETCURSEL
, n
, 0);
307 // ----------------------------------------------------------------------------
308 // string list functions
309 // ----------------------------------------------------------------------------
311 unsigned int wxChoice::GetCount() const
313 return (unsigned int)SendMessage(GetHwnd(), CB_GETCOUNT
, 0, 0);
316 int wxChoice::FindString(const wxString
& s
, bool bCase
) const
318 #if defined(__WATCOMC__) && defined(__WIN386__)
319 // For some reason, Watcom in WIN386 mode crashes in the CB_FINDSTRINGEXACT message.
320 // wxChoice::Do it the long way instead.
321 unsigned int count
= GetCount();
322 for ( unsigned int i
= 0; i
< count
; i
++ )
324 // as CB_FINDSTRINGEXACT is case insensitive, be case insensitive too
325 if (GetString(i
).IsSameAs(s
, bCase
))
331 //TODO: Evidently some MSW versions (all?) don't like empty strings
332 //passed to SendMessage, so we have to do it ourselves in that case
335 unsigned int count
= GetCount();
336 for ( unsigned int i
= 0; i
< count
; i
++ )
338 if (GetString(i
).empty())
346 // back to base class search for not native search type
347 return wxItemContainerImmutable::FindString( s
, bCase
);
351 int pos
= (int)SendMessage(GetHwnd(), CB_FINDSTRINGEXACT
,
352 (WPARAM
)-1, (LPARAM
)s
.wx_str());
354 return pos
== LB_ERR
? wxNOT_FOUND
: pos
;
356 #endif // Watcom/!Watcom
359 void wxChoice::SetString(unsigned int n
, const wxString
& s
)
361 wxCHECK_RET( IsValid(n
), wxT("invalid item index in wxChoice::SetString") );
363 // we have to delete and add back the string as there is no way to change a
366 // we need to preserve the client data manually
367 void *oldData
= NULL
;
368 wxClientData
*oldObjData
= NULL
;
369 if ( HasClientUntypedData() )
370 oldData
= GetClientData(n
);
371 else if ( HasClientObjectData() )
372 oldObjData
= GetClientObject(n
);
374 ::SendMessage(GetHwnd(), CB_DELETESTRING
, n
, 0);
375 ::SendMessage(GetHwnd(), CB_INSERTSTRING
, n
, (LPARAM
)s
.wx_str() );
377 // restore the client data
379 SetClientData(n
, oldData
);
380 else if ( oldObjData
)
381 SetClientObject(n
, oldObjData
);
383 InvalidateBestSize();
386 wxString
wxChoice::GetString(unsigned int n
) const
388 int len
= (int)::SendMessage(GetHwnd(), CB_GETLBTEXTLEN
, n
, 0);
391 if ( len
!= CB_ERR
&& len
> 0 )
398 (LPARAM
)(wxChar
*)wxStringBuffer(str
, len
)
401 wxLogLastError(wxT("SendMessage(CB_GETLBTEXT)"));
408 // ----------------------------------------------------------------------------
410 // ----------------------------------------------------------------------------
412 void wxChoice::DoSetItemClientData(unsigned int n
, void* clientData
)
414 if ( ::SendMessage(GetHwnd(), CB_SETITEMDATA
,
415 n
, (LPARAM
)clientData
) == CB_ERR
)
417 wxLogLastError(wxT("CB_SETITEMDATA"));
421 void* wxChoice::DoGetItemClientData(unsigned int n
) const
423 LPARAM rc
= SendMessage(GetHwnd(), CB_GETITEMDATA
, n
, 0);
426 wxLogLastError(wxT("CB_GETITEMDATA"));
428 // unfortunately, there is no way to return an error code to the user
435 // ----------------------------------------------------------------------------
436 // wxMSW specific helpers
437 // ----------------------------------------------------------------------------
439 void wxChoice::UpdateVisibleHeight()
441 // be careful to not change the width here
442 DoSetSize(wxDefaultCoord
, wxDefaultCoord
, wxDefaultCoord
, GetSize().y
, wxSIZE_USE_EXISTING
);
445 void wxChoice::DoMoveWindow(int x
, int y
, int width
, int height
)
447 // here is why this is necessary: if the width is negative, the combobox
448 // window proc makes the window of the size width*height instead of
449 // interpreting height in the usual manner (meaning the height of the drop
450 // down list - usually the height specified in the call to MoveWindow()
451 // will not change the height of combo box per se)
453 // this behaviour is not documented anywhere, but this is just how it is
454 // here (NT 4.4) and, anyhow, the check shouldn't hurt - however without
455 // the check, constraints/sizers using combos may break the height
456 // constraint will have not at all the same value as expected
460 wxControl::DoMoveWindow(x
, y
, width
, height
);
463 void wxChoice::DoGetSize(int *w
, int *h
) const
465 // this is weird: sometimes, the height returned by Windows is clearly the
466 // total height of the control including the drop down list -- but only
467 // sometimes, and normally it isn't... I have no idea about what to do with
469 wxControl::DoGetSize(w
, h
);
472 void wxChoice::DoSetSize(int x
, int y
,
473 int width
, int height
,
476 int heightOrig
= height
;
478 // the height which we must pass to Windows should be the total height of
479 // the control including the drop down list while the height given to us
480 // is, of course, just the height of the permanently visible part of it
481 if ( height
!= wxDefaultCoord
)
483 // don't make the drop down list too tall, arbitrarily limit it to 40
484 // items max and also don't leave it empty
485 size_t nItems
= GetCount();
488 else if ( nItems
> 24 )
491 // add space for the drop down list
492 const int hItem
= SendMessage(GetHwnd(), CB_GETITEMHEIGHT
, 0, 0);
493 height
+= hItem
*(nItems
+ 1);
497 // We cannot pass wxDefaultCoord as height to wxControl. wxControl uses
498 // wxGetWindowRect() to determine the current height of the combobox,
499 // and then again sets the combobox's height to that value. Unfortunately,
500 // wxGetWindowRect doesn't include the dropdown list's height (at least
501 // on Win2K), so this would result in a combobox with dropdown height of
502 // 1 pixel. We have to determine the default height ourselves and call
503 // wxControl with that value instead.
507 if (::SendMessage(GetHwnd(), CB_GETDROPPEDCONTROLRECT
, 0, (LPARAM
) &r
) != 0)
509 height
= h
+ r
.bottom
- r
.top
;
513 wxControl::DoSetSize(x
, y
, width
, height
, sizeFlags
);
515 // If we're storing a pending size, make sure we store
516 // the original size for reporting back to the app.
517 if (m_pendingSize
!= wxDefaultSize
)
518 m_pendingSize
= wxSize(width
, heightOrig
);
520 // This solution works on XP, but causes choice/combobox lists to be
521 // too short on W2K and earlier.
523 int widthCurrent
, heightCurrent
;
524 DoGetSize(&widthCurrent
, &heightCurrent
);
526 // the height which we must pass to Windows should be the total height of
527 // the control including the drop down list while the height given to us
528 // is, of course, just the height of the permanently visible part of it
529 if ( height
!= wxDefaultCoord
&& height
!= heightCurrent
)
531 // don't make the drop down list too tall, arbitrarily limit it to 40
532 // items max and also don't leave it empty
533 unsigned int nItems
= GetCount();
536 else if ( nItems
> 24 )
539 // add space for the drop down list
540 const int hItem
= SendMessage(GetHwnd(), CB_GETITEMHEIGHT
, 0, 0);
541 height
+= hItem
*(nItems
+ 1);
543 else // keep the same height as now
545 // normally wxWindow::DoSetSize() checks if we set the same size as the
546 // window already has and does nothing in this case, but for us the
547 // check fails as the size we pass to it includes the dropdown while
548 // the size returned by our GetSize() does not, so test if the size
549 // didn't really change ourselves here
550 if ( width
== wxDefaultCoord
|| width
== widthCurrent
)
552 // size doesn't change, what about position?
553 int xCurrent
, yCurrent
;
554 DoGetPosition(&xCurrent
, &yCurrent
);
555 const bool defMeansUnchanged
= !(sizeFlags
& wxSIZE_ALLOW_MINUS_ONE
);
556 if ( ((x
== wxDefaultCoord
&& defMeansUnchanged
) || x
== xCurrent
)
558 ((y
== wxDefaultCoord
&& defMeansUnchanged
) || y
== yCurrent
) )
560 // nothing changes, nothing to do
565 // We cannot pass wxDefaultCoord as height to wxControl. wxControl uses
566 // wxGetWindowRect() to determine the current height of the combobox,
567 // and then again sets the combobox's height to that value. Unfortunately,
568 // wxGetWindowRect doesn't include the dropdown list's height (at least
569 // on Win2K), so this would result in a combobox with dropdown height of
570 // 1 pixel. We have to determine the default height ourselves and call
571 // wxControl with that value instead.
573 // Also notice that sometimes CB_GETDROPPEDCONTROLRECT seems to return
574 // wildly incorrect values (~32000) which looks like a bug in it, just
575 // ignore them in this case
577 if ( ::SendMessage(GetHwnd(), CB_GETDROPPEDCONTROLRECT
, 0, (LPARAM
) &r
)
578 && r
.bottom
< 30000 )
580 height
= heightCurrent
+ r
.bottom
- r
.top
;
584 wxControl::DoSetSize(x
, y
, width
, height
, sizeFlags
);
588 wxSize
wxChoice::DoGetBestSize() const
590 // find the widest string
592 const unsigned int nItems
= GetCount();
593 for ( unsigned int i
= 0; i
< nItems
; i
++ )
596 GetTextExtent(GetString(i
), &wLine
, NULL
);
597 if ( wLine
> wChoice
)
601 // give it some reasonable default value if there are no strings in the
606 // the combobox should be slightly larger than the widest string
607 wChoice
+= 5*GetCharWidth();
609 wxSize
best(wChoice
, EDIT_HEIGHT_FROM_CHAR_HEIGHT(GetCharHeight()));
614 WXLRESULT
wxChoice::MSWWindowProc(WXUINT nMsg
, WXWPARAM wParam
, WXLPARAM lParam
)
620 int x
= (int)LOWORD(lParam
);
621 int y
= (int)HIWORD(lParam
);
623 // Ok, this is truly weird, but if a panel with a wxChoice
624 // loses the focus, then you get a *fake* WM_LBUTTONUP message
625 // with x = 65535 and y = 65535. Filter out this nonsense.
627 // VZ: I'd like to know how to reproduce this please...
628 if ( x
== 65535 && y
== 65535 )
633 // we have to handle both: one for the normal case and the other
635 case WM_CTLCOLOREDIT
:
636 case WM_CTLCOLORLISTBOX
:
637 case WM_CTLCOLORSTATIC
:
641 UnpackCtlColor(wParam
, lParam
, &hdc
, &hwnd
);
643 WXHBRUSH hbr
= MSWControlColor((WXHDC
)hdc
, hwnd
);
645 return (WXLRESULT
)hbr
;
646 //else: fall through to default window proc
650 return wxWindow::MSWWindowProc(nMsg
, wParam
, lParam
);
653 bool wxChoice::MSWCommand(WXUINT param
, WXWORD
WXUNUSED(id
))
656 The native control provides a great variety in the events it sends in
657 the different selection scenarios (undoubtedly for greater amusement of
658 the programmers using it). For the reference, here are the cases when
659 the final selection is accepted (things are quite interesting when it
662 A. Selecting with just the arrows without opening the dropdown:
666 B. Opening dropdown with F4 and selecting with arrows:
668 2. many CBN_SELCHANGE while changing selection in the list
672 C. Selecting with the mouse:
674 -- no intermediate CBN_SELCHANGEs --
679 Admire the different order of messages in all of those cases, it must
680 surely have taken a lot of effort to Microsoft developers to achieve
686 // we use this value both because we don't want to track selection
687 // using CB_GETCURSEL while the dropdown is opened and because we
688 // need to reset the selection back to it if it's eventually
690 m_lastAcceptedSelection
= GetCurrentSelection();
691 if ( m_lastAcceptedSelection
== -1 )
693 // no current selection so no need to restore it later (this
694 // happens when opening a combobox containing text not from its
695 // list of items and we shouldn't erase this text)
696 m_lastAcceptedSelection
= wxID_NONE
;
701 // if the selection was accepted by the user, it should have been
702 // reset to wxID_NONE by CBN_SELENDOK, otherwise the selection was
703 // cancelled and we must restore the old one
704 if ( m_lastAcceptedSelection
!= wxID_NONE
)
706 SetSelection(m_lastAcceptedSelection
);
707 m_lastAcceptedSelection
= wxID_NONE
;
712 // reset it to prevent CBN_CLOSEUP from undoing the selection (it's
713 // ok to reset it now as GetCurrentSelection() will now return the
714 // same thing anyhow)
715 m_lastAcceptedSelection
= wxID_NONE
;
718 const int n
= GetSelection();
720 wxCommandEvent
event(wxEVT_COMMAND_CHOICE_SELECTED
, m_windowId
);
722 event
.SetEventObject(this);
726 event
.SetString(GetStringSelection());
727 InitCommandEventWithItems(event
, n
);
730 ProcessCommand(event
);
734 // don't handle CBN_SELENDCANCEL: just leave m_lastAcceptedSelection
735 // valid and the selection will be undone in CBN_CLOSEUP above
737 // don't handle CBN_SELCHANGE neither, we don't want to generate events
738 // while the dropdown is opened -- but do add it if we ever need this
747 WXHBRUSH
wxChoice::MSWControlColor(WXHDC hDC
, WXHWND hWnd
)
750 return MSWControlColorDisabled(hDC
);
752 return wxChoiceBase::MSWControlColor(hDC
, hWnd
);
755 #endif // wxUSE_CHOICE && !(__SMARTPHONE__ && __WXWINCE__)