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((pos
>=0) && (pos
<=GetCount()), -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( n
< GetCount(), 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 int wxChoice::GetCount() const
331 return (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 int count
= GetCount();
340 for ( 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 int count
= GetCount();
354 for ( 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(int n
, const wxString
& s
)
379 wxCHECK_RET( n
>= 0 && n
< GetCount(),
380 wxT("invalid item index in wxChoice::SetString") );
382 // we have to delete and add back the string as there is no way to change a
385 // we need to preserve the client data
387 if ( m_clientDataItemsType
!= wxClientData_None
)
389 data
= DoGetItemClientData(n
);
391 else // no client data
396 ::SendMessage(GetHwnd(), CB_DELETESTRING
, n
, 0);
397 ::SendMessage(GetHwnd(), CB_INSERTSTRING
, n
, (LPARAM
)s
.c_str() );
401 DoSetItemClientData(n
, data
);
403 //else: it's already NULL by default
405 InvalidateBestSize();
408 wxString
wxChoice::GetString(int n
) const
410 int len
= (int)::SendMessage(GetHwnd(), CB_GETLBTEXTLEN
, n
, 0);
413 if ( len
!= CB_ERR
&& len
> 0 )
420 (LPARAM
)(wxChar
*)wxStringBuffer(str
, len
)
423 wxLogLastError(wxT("SendMessage(CB_GETLBTEXT)"));
430 // ----------------------------------------------------------------------------
432 // ----------------------------------------------------------------------------
434 void wxChoice::DoSetItemClientData( int n
, void* clientData
)
436 if ( ::SendMessage(GetHwnd(), CB_SETITEMDATA
,
437 n
, (LPARAM
)clientData
) == CB_ERR
)
439 wxLogLastError(wxT("CB_SETITEMDATA"));
443 void* wxChoice::DoGetItemClientData( int n
) const
445 LPARAM rc
= SendMessage(GetHwnd(), CB_GETITEMDATA
, n
, 0);
448 wxLogLastError(wxT("CB_GETITEMDATA"));
450 // unfortunately, there is no way to return an error code to the user
457 void wxChoice::DoSetItemClientObject( int n
, wxClientData
* clientData
)
459 DoSetItemClientData(n
, clientData
);
462 wxClientData
* wxChoice::DoGetItemClientObject( int n
) const
464 return (wxClientData
*)DoGetItemClientData(n
);
467 // ----------------------------------------------------------------------------
468 // wxMSW specific helpers
469 // ----------------------------------------------------------------------------
471 void wxChoice::UpdateVisibleHeight()
473 // be careful to not change the width here
474 DoSetSize(wxDefaultCoord
, wxDefaultCoord
, wxDefaultCoord
, GetSize().y
, wxSIZE_USE_EXISTING
);
477 void wxChoice::DoMoveWindow(int x
, int y
, int width
, int height
)
479 // here is why this is necessary: if the width is negative, the combobox
480 // window proc makes the window of the size width*height instead of
481 // interpreting height in the usual manner (meaning the height of the drop
482 // down list - usually the height specified in the call to MoveWindow()
483 // will not change the height of combo box per se)
485 // this behaviour is not documented anywhere, but this is just how it is
486 // here (NT 4.4) and, anyhow, the check shouldn't hurt - however without
487 // the check, constraints/sizers using combos may break the height
488 // constraint will have not at all the same value as expected
492 wxControl::DoMoveWindow(x
, y
, width
, height
);
495 void wxChoice::DoGetSize(int *w
, int *h
) const
497 // this is weird: sometimes, the height returned by Windows is clearly the
498 // total height of the control including the drop down list -- but only
499 // sometimes, and normally it isn't... I have no idea about what to do with
501 wxControl::DoGetSize(w
, h
);
504 void wxChoice::DoSetSize(int x
, int y
,
505 int width
, int height
,
508 int heightOrig
= height
;
510 // the height which we must pass to Windows should be the total height of
511 // the control including the drop down list while the height given to us
512 // is, of course, just the height of the permanently visible part of it
513 if ( height
!= wxDefaultCoord
)
515 // don't make the drop down list too tall, arbitrarily limit it to 40
516 // items max and also don't leave it empty
517 size_t nItems
= GetCount();
520 else if ( nItems
> 24 )
523 // add space for the drop down list
524 const int hItem
= SendMessage(GetHwnd(), CB_GETITEMHEIGHT
, 0, 0);
525 height
+= hItem
*(nItems
+ 1);
529 // We cannot pass wxDefaultCoord as height to wxControl. wxControl uses
530 // wxGetWindowRect() to determine the current height of the combobox,
531 // and then again sets the combobox's height to that value. Unfortunately,
532 // wxGetWindowRect doesn't include the dropdown list's height (at least
533 // on Win2K), so this would result in a combobox with dropdown height of
534 // 1 pixel. We have to determine the default height ourselves and call
535 // wxControl with that value instead.
539 if (::SendMessage(GetHwnd(), CB_GETDROPPEDCONTROLRECT
, 0, (LPARAM
) &r
) != 0)
541 height
= h
+ r
.bottom
- r
.top
;
545 wxControl::DoSetSize(x
, y
, width
, height
, sizeFlags
);
547 // I'm commenting this out since the code appears to make choices
548 // and comboxes too high when they have associated sizers. I'm sure this
549 // is not the end of the story, which is why I'm leaving it #if'ed out for
552 // if the height specified for the visible part of the control is
553 // different from the current one, we need to change it separately
554 // as it is not affected by normal WM_SETSIZE
555 if ( height
!= wxDefaultCoord
)
557 const int delta
= heightOrig
- GetSize().y
;
560 int h
= ::SendMessage(GetHwnd(), CB_GETITEMHEIGHT
, (WPARAM
)-1, 0);
561 SendMessage(GetHwnd(), CB_SETITEMHEIGHT
, (WPARAM
)-1, h
+ delta
);
565 wxUnusedVar(heightOrig
);
569 wxSize
wxChoice::DoGetBestSize() const
571 // find the widest string
573 const size_t nItems
= GetCount();
574 for ( size_t i
= 0; i
< nItems
; i
++ )
577 GetTextExtent(GetString(i
), &wLine
, NULL
);
578 if ( wLine
> wChoice
)
582 // give it some reasonable default value if there are no strings in the
587 // the combobox should be slightly larger than the widest string
588 wChoice
+= 5*GetCharWidth();
590 wxSize
best(wChoice
, EDIT_HEIGHT_FROM_CHAR_HEIGHT(GetCharHeight()));
595 WXLRESULT
wxChoice::MSWWindowProc(WXUINT nMsg
, WXWPARAM wParam
, WXLPARAM lParam
)
601 int x
= (int)LOWORD(lParam
);
602 int y
= (int)HIWORD(lParam
);
604 // Ok, this is truly weird, but if a panel with a wxChoice
605 // loses the focus, then you get a *fake* WM_LBUTTONUP message
606 // with x = 65535 and y = 65535. Filter out this nonsense.
608 // VZ: I'd like to know how to reproduce this please...
609 if ( x
== 65535 && y
== 65535 )
614 // we have to handle both: one for the normal case and the other
616 case WM_CTLCOLOREDIT
:
617 case WM_CTLCOLORLISTBOX
:
618 case WM_CTLCOLORSTATIC
:
622 UnpackCtlColor(wParam
, lParam
, &hdc
, &hwnd
);
624 WXHBRUSH hbr
= MSWControlColor((WXHDC
)hdc
, hwnd
);
626 return (WXLRESULT
)hbr
;
627 //else: fall through to default window proc
631 return wxWindow::MSWWindowProc(nMsg
, wParam
, lParam
);
634 bool wxChoice::MSWCommand(WXUINT param
, WXWORD
WXUNUSED(id
))
639 // we don't want to track selection using CB_GETCURSEL while the
640 // dropdown is opened
641 m_lastAcceptedSelection
= GetCurrentSelection();
645 // it should be safe to use CB_GETCURSEL again
646 m_lastAcceptedSelection
= wxID_NONE
;
651 const int n
= GetSelection();
653 wxCommandEvent
event(wxEVT_COMMAND_CHOICE_SELECTED
, m_windowId
);
655 event
.SetEventObject(this);
659 event
.SetString(GetStringSelection());
660 if ( HasClientObjectData() )
661 event
.SetClientObject( GetClientObject(n
) );
662 else if ( HasClientUntypedData() )
663 event
.SetClientData( GetClientData(n
) );
666 ProcessCommand(event
);
674 WXHBRUSH
wxChoice::MSWControlColor(WXHDC hDC
, WXHWND hWnd
)
677 return MSWControlColorDisabled(hDC
);
679 return wxChoiceBase::MSWControlColor(hDC
, hWnd
);
682 #endif // wxUSE_CHOICE && !(__SMARTPHONE__ && __WXWINCE__)