1 /////////////////////////////////////////////////////////////////////////////
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 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
21 #pragma implementation "choice.h"
24 // For compilers that support precompilation, includes "wx.h".
25 #include "wx/wxprec.h"
31 #if wxUSE_CHOICE && !(defined(__SMARTPHONE__) && defined(__WXWINCE__))
34 #include "wx/choice.h"
38 #include "wx/settings.h"
41 #include "wx/msw/private.h"
43 #if wxUSE_EXTENDED_RTTI
44 WX_DEFINE_FLAGS( wxChoiceStyle
)
46 wxBEGIN_FLAGS( wxChoiceStyle
)
47 // new style border flags, we put them first to
48 // use them for streaming out
49 wxFLAGS_MEMBER(wxBORDER_SIMPLE
)
50 wxFLAGS_MEMBER(wxBORDER_SUNKEN
)
51 wxFLAGS_MEMBER(wxBORDER_DOUBLE
)
52 wxFLAGS_MEMBER(wxBORDER_RAISED
)
53 wxFLAGS_MEMBER(wxBORDER_STATIC
)
54 wxFLAGS_MEMBER(wxBORDER_NONE
)
56 // old style border flags
57 wxFLAGS_MEMBER(wxSIMPLE_BORDER
)
58 wxFLAGS_MEMBER(wxSUNKEN_BORDER
)
59 wxFLAGS_MEMBER(wxDOUBLE_BORDER
)
60 wxFLAGS_MEMBER(wxRAISED_BORDER
)
61 wxFLAGS_MEMBER(wxSTATIC_BORDER
)
62 wxFLAGS_MEMBER(wxBORDER
)
64 // standard window styles
65 wxFLAGS_MEMBER(wxTAB_TRAVERSAL
)
66 wxFLAGS_MEMBER(wxCLIP_CHILDREN
)
67 wxFLAGS_MEMBER(wxTRANSPARENT_WINDOW
)
68 wxFLAGS_MEMBER(wxWANTS_CHARS
)
69 wxFLAGS_MEMBER(wxFULL_REPAINT_ON_RESIZE
)
70 wxFLAGS_MEMBER(wxALWAYS_SHOW_SB
)
71 wxFLAGS_MEMBER(wxVSCROLL
)
72 wxFLAGS_MEMBER(wxHSCROLL
)
74 wxEND_FLAGS( wxChoiceStyle
)
76 IMPLEMENT_DYNAMIC_CLASS_XTI(wxChoice
, wxControl
,"wx/choice.h")
78 wxBEGIN_PROPERTIES_TABLE(wxChoice
)
79 wxEVENT_PROPERTY( Select
, wxEVT_COMMAND_CHOICE_SELECTED
, wxCommandEvent
)
81 wxPROPERTY( Font
, wxFont
, SetFont
, GetFont
, EMPTY_MACROVALUE
, 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
82 wxPROPERTY_COLLECTION( Choices
, wxArrayString
, wxString
, AppendString
, GetStrings
, 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
83 wxPROPERTY( Selection
,int, SetSelection
, GetSelection
, EMPTY_MACROVALUE
, 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
84 wxPROPERTY_FLAGS( WindowStyle
, wxChoiceStyle
, long , SetWindowStyleFlag
, GetWindowStyleFlag
, EMPTY_MACROVALUE
, 0 /*flags*/ , wxT("Helpstring") , wxT("group")) // style
85 wxEND_PROPERTIES_TABLE()
87 wxBEGIN_HANDLERS_TABLE(wxChoice
)
88 wxEND_HANDLERS_TABLE()
90 wxCONSTRUCTOR_4( wxChoice
, wxWindow
* , Parent
, wxWindowID
, Id
, wxPoint
, Position
, wxSize
, Size
)
92 IMPLEMENT_DYNAMIC_CLASS(wxChoice
, wxControl
)
101 // ============================================================================
103 // ============================================================================
105 // ----------------------------------------------------------------------------
107 // ----------------------------------------------------------------------------
109 bool wxChoice::Create(wxWindow
*parent
,
113 int n
, const wxString choices
[],
115 const wxValidator
& validator
,
116 const wxString
& name
)
118 // Experience shows that wxChoice vs. wxComboBox distinction confuses
119 // quite a few people - try to help them
120 wxASSERT_MSG( !(style
& wxCB_DROPDOWN
) &&
121 !(style
& wxCB_READONLY
) &&
122 !(style
& wxCB_SIMPLE
),
123 _T("this style flag is ignored by wxChoice, you ")
124 _T("probably want to use a wxComboBox") );
126 return CreateAndInit(parent
, id
, pos
, size
, n
, choices
, style
,
130 bool wxChoice::CreateAndInit(wxWindow
*parent
,
134 int n
, const wxString choices
[],
136 const wxValidator
& validator
,
137 const wxString
& name
)
141 // initialize wxControl
142 if ( !CreateControl(parent
, id
, pos
, size
, style
, validator
, name
) )
145 // now create the real HWND
146 if ( !MSWCreateControl(wxT("COMBOBOX"), wxEmptyString
, pos
, size
) )
150 // choice/combobox normally has "white" (depends on colour scheme, of
151 // course) background rather than inheriting the parent's background
152 SetBackgroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOW
));
154 // initialize the controls contents
155 for ( int i
= 0; i
< n
; i
++ )
160 // and now we may finally size the control properly (if needed)
166 bool wxChoice::Create(wxWindow
*parent
,
170 const wxArrayString
& choices
,
172 const wxValidator
& validator
,
173 const wxString
& name
)
175 wxCArrayString
chs(choices
);
176 return Create(parent
, id
, pos
, size
, chs
.GetCount(), chs
.GetStrings(),
177 style
, validator
, name
);
180 bool wxChoice::MSWShouldPreProcessMessage(WXMSG
*pMsg
)
182 MSG
*msg
= (MSG
*) pMsg
;
184 // if the dropdown list is visible, don't preprocess certain keys
185 if ( msg
->message
== WM_KEYDOWN
186 && (msg
->wParam
== VK_ESCAPE
|| msg
->wParam
== VK_RETURN
) )
188 if (::SendMessage(GetHwndOf(this), CB_GETDROPPEDSTATE
, 0, 0))
194 return wxControl::MSWShouldPreProcessMessage(pMsg
);
197 WXDWORD
wxChoice::MSWGetStyle(long style
, WXDWORD
*exstyle
) const
199 // we never have an external border
200 WXDWORD msStyle
= wxControl::MSWGetStyle
202 (style
& ~wxBORDER_MASK
) | wxBORDER_NONE
, exstyle
205 // WS_CLIPSIBLINGS is useful with wxChoice and doesn't seem to result in
207 msStyle
|= WS_CLIPSIBLINGS
;
209 // wxChoice-specific styles
210 msStyle
|= CBS_DROPDOWNLIST
| WS_HSCROLL
| WS_VSCROLL
;
211 if ( style
& wxCB_SORT
)
217 wxChoice::~wxChoice()
222 // ----------------------------------------------------------------------------
223 // adding/deleting items to/from the list
224 // ----------------------------------------------------------------------------
226 int wxChoice::DoAppend(const wxString
& item
)
228 int n
= (int)SendMessage(GetHwnd(), CB_ADDSTRING
, 0, (LPARAM
)item
.c_str());
231 wxLogLastError(wxT("SendMessage(CB_ADDSTRING)"));
235 // we need to refresh our size in order to have enough space for the
238 UpdateVisibleHeight();
241 InvalidateBestSize();
245 int wxChoice::DoInsert(const wxString
& item
, int pos
)
247 wxCHECK_MSG(!(GetWindowStyle() & wxCB_SORT
), -1, wxT("can't insert into sorted list"));
248 wxCHECK_MSG((pos
>=0) && (pos
<=GetCount()), -1, wxT("invalid index"));
250 int n
= (int)SendMessage(GetHwnd(), CB_INSERTSTRING
, pos
, (LPARAM
)item
.c_str());
253 wxLogLastError(wxT("SendMessage(CB_INSERTSTRING)"));
258 UpdateVisibleHeight();
261 InvalidateBestSize();
265 void wxChoice::Delete(int n
)
267 wxCHECK_RET( n
< GetCount(), wxT("invalid item index in wxChoice::Delete") );
269 if ( HasClientObjectData() )
271 delete GetClientObject(n
);
274 SendMessage(GetHwnd(), CB_DELETESTRING
, n
, 0);
277 UpdateVisibleHeight();
279 InvalidateBestSize();
282 void wxChoice::Clear()
286 SendMessage(GetHwnd(), CB_RESETCONTENT
, 0, 0);
289 UpdateVisibleHeight();
291 InvalidateBestSize();
294 void wxChoice::Free()
296 if ( HasClientObjectData() )
298 size_t count
= GetCount();
299 for ( size_t n
= 0; n
< count
; n
++ )
301 delete GetClientObject(n
);
306 // ----------------------------------------------------------------------------
308 // ----------------------------------------------------------------------------
310 int wxChoice::GetSelection() const
312 // if m_lastAcceptedSelection is set, it means that the dropdown is
313 // currently shown and that we want to use the last "permanent" selection
314 // instead of whatever is under the mouse pointer currently
316 // otherwise, get the selection from the control
317 return m_lastAcceptedSelection
== wxID_NONE
? GetCurrentSelection()
318 : m_lastAcceptedSelection
;
321 int wxChoice::GetCurrentSelection() const
323 return (int)SendMessage(GetHwnd(), CB_GETCURSEL
, 0, 0);
326 void wxChoice::SetSelection(int n
)
328 SendMessage(GetHwnd(), CB_SETCURSEL
, n
, 0);
331 // ----------------------------------------------------------------------------
332 // string list functions
333 // ----------------------------------------------------------------------------
335 int wxChoice::GetCount() const
337 return (int)SendMessage(GetHwnd(), CB_GETCOUNT
, 0, 0);
340 int wxChoice::FindString(const wxString
& s
) const
342 #if defined(__WATCOMC__) && defined(__WIN386__)
343 // For some reason, Watcom in WIN386 mode crashes in the CB_FINDSTRINGEXACT message.
344 // wxChoice::Do it the long way instead.
345 int count
= GetCount();
346 for ( int i
= 0; i
< count
; i
++ )
348 // as CB_FINDSTRINGEXACT is case insensitive, be case insensitive too
349 if ( GetString(i
).IsSameAs(s
, false) )
355 //TODO: Evidently some MSW versions (all?) don't like empty strings
356 //passed to SendMessage, so we have to do it ourselves in that case
359 int count
= GetCount();
360 for ( int i
= 0; i
< count
; i
++ )
362 if ( GetString(i
).empty() )
370 int pos
= (int)SendMessage(GetHwnd(), CB_FINDSTRINGEXACT
,
371 (WPARAM
)-1, (LPARAM
)s
.c_str());
373 return pos
== LB_ERR
? wxNOT_FOUND
: pos
;
375 #endif // Watcom/!Watcom
378 void wxChoice::SetString(int n
, const wxString
& s
)
380 wxCHECK_RET( n
>= 0 && n
< GetCount(),
381 wxT("invalid item index in wxChoice::SetString") );
383 // we have to delete and add back the string as there is no way to change a
386 // we need to preserve the client data
388 if ( m_clientDataItemsType
!= wxClientData_None
)
390 data
= DoGetItemClientData(n
);
392 else // no client data
397 ::SendMessage(GetHwnd(), CB_DELETESTRING
, n
, 0);
398 ::SendMessage(GetHwnd(), CB_INSERTSTRING
, n
, (LPARAM
)s
.c_str() );
402 DoSetItemClientData(n
, data
);
404 //else: it's already NULL by default
406 InvalidateBestSize();
409 wxString
wxChoice::GetString(int n
) const
411 int len
= (int)::SendMessage(GetHwnd(), CB_GETLBTEXTLEN
, n
, 0);
414 if ( len
!= CB_ERR
&& len
> 0 )
421 (LPARAM
)(wxChar
*)wxStringBuffer(str
, len
)
424 wxLogLastError(wxT("SendMessage(CB_GETLBTEXT)"));
431 // ----------------------------------------------------------------------------
433 // ----------------------------------------------------------------------------
435 void wxChoice::DoSetItemClientData( int n
, void* clientData
)
437 if ( ::SendMessage(GetHwnd(), CB_SETITEMDATA
,
438 n
, (LPARAM
)clientData
) == CB_ERR
)
440 wxLogLastError(wxT("CB_SETITEMDATA"));
444 void* wxChoice::DoGetItemClientData( int n
) const
446 LPARAM rc
= SendMessage(GetHwnd(), CB_GETITEMDATA
, n
, 0);
449 wxLogLastError(wxT("CB_GETITEMDATA"));
451 // unfortunately, there is no way to return an error code to the user
458 void wxChoice::DoSetItemClientObject( int n
, wxClientData
* clientData
)
460 DoSetItemClientData(n
, clientData
);
463 wxClientData
* wxChoice::DoGetItemClientObject( int n
) const
465 return (wxClientData
*)DoGetItemClientData(n
);
468 // ----------------------------------------------------------------------------
469 // wxMSW specific helpers
470 // ----------------------------------------------------------------------------
472 void wxChoice::UpdateVisibleHeight()
474 // be careful to not change the width here
475 DoSetSize(wxDefaultCoord
, wxDefaultCoord
, wxDefaultCoord
, GetSize().y
, wxSIZE_USE_EXISTING
);
478 void wxChoice::DoMoveWindow(int x
, int y
, int width
, int height
)
480 // here is why this is necessary: if the width is negative, the combobox
481 // window proc makes the window of the size width*height instead of
482 // interpreting height in the usual manner (meaning the height of the drop
483 // down list - usually the height specified in the call to MoveWindow()
484 // will not change the height of combo box per se)
486 // this behaviour is not documented anywhere, but this is just how it is
487 // here (NT 4.4) and, anyhow, the check shouldn't hurt - however without
488 // the check, constraints/sizers using combos may break the height
489 // constraint will have not at all the same value as expected
493 wxControl::DoMoveWindow(x
, y
, width
, height
);
496 void wxChoice::DoGetSize(int *w
, int *h
) const
498 // this is weird: sometimes, the height returned by Windows is clearly the
499 // total height of the control including the drop down list -- but only
500 // sometimes, and normally it isn't... I have no idea about what to do with
502 wxControl::DoGetSize(w
, h
);
505 void wxChoice::DoSetSize(int x
, int y
,
506 int width
, int height
,
509 int heightOrig
= height
;
511 // the height which we must pass to Windows should be the total height of
512 // the control including the drop down list while the height given to us
513 // is, of course, just the height of the permanently visible part of it
514 if ( height
!= wxDefaultCoord
)
516 // don't make the drop down list too tall, arbitrarily limit it to 40
517 // items max and also don't leave it empty
518 size_t nItems
= GetCount();
521 else if ( nItems
> 24 )
524 // add space for the drop down list
525 const int hItem
= SendMessage(GetHwnd(), CB_GETITEMHEIGHT
, 0, 0);
526 height
+= hItem
*(nItems
+ 1);
530 // We cannot pass wxDefaultCoord as height to wxControl. wxControl uses
531 // wxGetWindowRect() to determine the current height of the combobox,
532 // and then again sets the combobox's height to that value. Unfortunately,
533 // wxGetWindowRect doesn't include the dropdown list's height (at least
534 // on Win2K), so this would result in a combobox with dropdown height of
535 // 1 pixel. We have to determine the default height ourselves and call
536 // wxControl with that value instead.
540 if (::SendMessage(GetHwnd(), CB_GETDROPPEDCONTROLRECT
, 0, (LPARAM
) &r
) != 0)
542 height
= h
+ r
.bottom
- r
.top
;
546 wxControl::DoSetSize(x
, y
, width
, height
, sizeFlags
);
548 // I'm commenting this out since the code appears to make choices
549 // and comboxes too high when they have associated sizers. I'm sure this
550 // is not the end of the story, which is why I'm leaving it #if'ed out for
553 // if the height specified for the visible part of the control is
554 // different from the current one, we need to change it separately
555 // as it is not affected by normal WM_SETSIZE
556 if ( height
!= wxDefaultCoord
)
558 const int delta
= heightOrig
- GetSize().y
;
561 int h
= ::SendMessage(GetHwnd(), CB_GETITEMHEIGHT
, (WPARAM
)-1, 0);
562 SendMessage(GetHwnd(), CB_SETITEMHEIGHT
, (WPARAM
)-1, h
+ delta
);
566 wxUnusedVar(heightOrig
);
570 wxSize
wxChoice::DoGetBestSize() const
572 // find the widest string
574 const size_t nItems
= GetCount();
575 for ( size_t i
= 0; i
< nItems
; i
++ )
578 GetTextExtent(GetString(i
), &wLine
, NULL
);
579 if ( wLine
> wChoice
)
583 // give it some reasonable default value if there are no strings in the
588 // the combobox should be slightly larger than the widest string
589 wChoice
+= 5*GetCharWidth();
591 wxSize
best(wChoice
, EDIT_HEIGHT_FROM_CHAR_HEIGHT(GetCharHeight()));
596 WXLRESULT
wxChoice::MSWWindowProc(WXUINT nMsg
, WXWPARAM wParam
, WXLPARAM lParam
)
602 int x
= (int)LOWORD(lParam
);
603 int y
= (int)HIWORD(lParam
);
605 // Ok, this is truly weird, but if a panel with a wxChoice
606 // loses the focus, then you get a *fake* WM_LBUTTONUP message
607 // with x = 65535 and y = 65535. Filter out this nonsense.
609 // VZ: I'd like to know how to reproduce this please...
610 if ( x
== 65535 && y
== 65535 )
615 // we have to handle both: one for the normal case and the other
617 case WM_CTLCOLOREDIT
:
618 case WM_CTLCOLORLISTBOX
:
619 case WM_CTLCOLORSTATIC
:
623 UnpackCtlColor(wParam
, lParam
, &hdc
, &hwnd
);
625 WXHBRUSH hbr
= MSWControlColor((WXHDC
)hdc
, hwnd
);
627 return (WXLRESULT
)hbr
;
628 //else: fall through to default window proc
632 return wxWindow::MSWWindowProc(nMsg
, wParam
, lParam
);
635 bool wxChoice::MSWCommand(WXUINT param
, WXWORD
WXUNUSED(id
))
640 // we don't want to track selection using CB_GETCURSEL while the
641 // dropdown is opened
642 m_lastAcceptedSelection
= GetCurrentSelection();
646 // it should be safe to use CB_GETCURSEL again
647 m_lastAcceptedSelection
= wxID_NONE
;
652 const int n
= GetSelection();
654 wxCommandEvent
event(wxEVT_COMMAND_CHOICE_SELECTED
, m_windowId
);
656 event
.SetEventObject(this);
660 event
.SetString(GetStringSelection());
661 if ( HasClientObjectData() )
662 event
.SetClientObject( GetClientObject(n
) );
663 else if ( HasClientUntypedData() )
664 event
.SetClientData( GetClientData(n
) );
667 ProcessCommand(event
);
675 WXHBRUSH
wxChoice::MSWControlColor(WXHDC hDC
, WXHWND hWnd
)
678 return MSWControlColorDisabled(hDC
);
680 return wxChoiceBase::MSWControlColor(hDC
, hWnd
);
683 #endif // wxUSE_CHOICE && !(__SMARTPHONE__ && __WXWINCE__)