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
, 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(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 size_t count
= GetCount();
293 for ( size_t 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 size_t wxChoice::GetCount() const
331 return (size_t)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 size_t count
= GetCount();
340 for ( size_t 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 size_t count
= GetCount();
354 for ( size_t 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(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(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( 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( 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( int n
, wxClientData
* clientData
)
458 DoSetItemClientData(n
, clientData
);
461 wxClientData
* wxChoice::DoGetItemClientObject( 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 int heightOrig
= height
;
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
)
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();
519 else if ( nItems
> 24 )
522 // add space for the drop down list
523 const int hItem
= SendMessage(GetHwnd(), CB_GETITEMHEIGHT
, 0, 0);
524 height
+= hItem
*(nItems
+ 1);
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.
538 if (::SendMessage(GetHwnd(), CB_GETDROPPEDCONTROLRECT
, 0, (LPARAM
) &r
) != 0)
540 height
= h
+ r
.bottom
- r
.top
;
544 wxControl::DoSetSize(x
, y
, width
, height
, sizeFlags
);
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
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
)
556 const int delta
= heightOrig
- GetSize().y
;
559 int h
= ::SendMessage(GetHwnd(), CB_GETITEMHEIGHT
, (WPARAM
)-1, 0);
560 SendMessage(GetHwnd(), CB_SETITEMHEIGHT
, (WPARAM
)-1, h
+ delta
);
564 wxUnusedVar(heightOrig
);
568 wxSize
wxChoice::DoGetBestSize() const
570 // find the widest string
572 const size_t nItems
= GetCount();
573 for ( size_t i
= 0; i
< nItems
; i
++ )
576 GetTextExtent(GetString(i
), &wLine
, NULL
);
577 if ( wLine
> wChoice
)
581 // give it some reasonable default value if there are no strings in the
586 // the combobox should be slightly larger than the widest string
587 wChoice
+= 5*GetCharWidth();
589 wxSize
best(wChoice
, EDIT_HEIGHT_FROM_CHAR_HEIGHT(GetCharHeight()));
594 WXLRESULT
wxChoice::MSWWindowProc(WXUINT nMsg
, WXWPARAM wParam
, WXLPARAM lParam
)
600 int x
= (int)LOWORD(lParam
);
601 int y
= (int)HIWORD(lParam
);
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.
607 // VZ: I'd like to know how to reproduce this please...
608 if ( x
== 65535 && y
== 65535 )
613 // we have to handle both: one for the normal case and the other
615 case WM_CTLCOLOREDIT
:
616 case WM_CTLCOLORLISTBOX
:
617 case WM_CTLCOLORSTATIC
:
621 UnpackCtlColor(wParam
, lParam
, &hdc
, &hwnd
);
623 WXHBRUSH hbr
= MSWControlColor((WXHDC
)hdc
, hwnd
);
625 return (WXLRESULT
)hbr
;
626 //else: fall through to default window proc
630 return wxWindow::MSWWindowProc(nMsg
, wParam
, lParam
);
633 bool wxChoice::MSWCommand(WXUINT param
, WXWORD
WXUNUSED(id
))
636 The native control provides a great variety in the events it sends in
637 the different selection scenarios (undoubtedly for greater amusement of
638 the programmers using it). For the reference, here are the cases when
639 the final selection is accepted (things are quite interesting when it
642 A. Selecting with just the arrows without opening the dropdown:
646 B. Opening dropdown with F4 and selecting with arrows:
648 2. many CBN_SELCHANGE while changing selection in the list
652 C. Selecting with the mouse:
654 -- no intermediate CBN_SELCHANGEs --
659 Admire the different order of messages in all of those cases, it must
660 surely have taken a lot of effort to Microsoft developers to achieve
666 // we use this value both because we don't want to track selection
667 // using CB_GETCURSEL while the dropdown is opened and because we
668 // need to reset the selection back to it if it's eventually
670 m_lastAcceptedSelection
= GetCurrentSelection();
674 // if the selection was accepted by the user, it should have been
675 // reset to wxID_NONE by CBN_SELENDOK, otherwise the selection was
676 // cancelled and we must restore the old one
677 if ( m_lastAcceptedSelection
!= wxID_NONE
)
679 SetSelection(m_lastAcceptedSelection
);
680 m_lastAcceptedSelection
= wxID_NONE
;
685 // reset it to prevent CBN_CLOSEUP from undoing the selection (it's
686 // ok to reset it now as GetCurrentSelection() will now return the
687 // same thing anyhow)
688 m_lastAcceptedSelection
= wxID_NONE
;
691 const int n
= GetSelection();
693 wxCommandEvent
event(wxEVT_COMMAND_CHOICE_SELECTED
, m_windowId
);
695 event
.SetEventObject(this);
699 event
.SetString(GetStringSelection());
700 if ( HasClientObjectData() )
701 event
.SetClientObject( GetClientObject(n
) );
702 else if ( HasClientUntypedData() )
703 event
.SetClientData( GetClientData(n
) );
706 ProcessCommand(event
);
710 // don't handle CBN_SELENDCANCEL: just leave m_lastAcceptedSelection
711 // valid and the selection will be undone in CBN_CLOSEUP above
713 // don't handle CBN_SELCHANGE neither, we don't want to generate events
714 // while the dropdown is opened -- but do add it if we ever need this
723 WXHBRUSH
wxChoice::MSWControlColor(WXHDC hDC
, WXHWND hWnd
)
726 return MSWControlColorDisabled(hDC
);
728 return wxChoiceBase::MSWControlColor(hDC
, hWnd
);
731 #endif // wxUSE_CHOICE && !(__SMARTPHONE__ && __WXWINCE__)