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"
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
)
139 // initialize wxControl
140 if ( !CreateControl(parent
, id
, pos
, size
, style
, validator
, name
) )
143 // now create the real HWND
144 if ( !MSWCreateControl(wxT("COMBOBOX"), _T(""), pos
, size
) )
148 // choice/combobox normally has "white" (depends on colour scheme, of
149 // course) background rather than inheriting the parent's background
150 SetBackgroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOW
));
152 // initialize the controls contents
153 for ( int i
= 0; i
< n
; i
++ )
158 // and now we may finally size the control properly (if needed)
164 bool wxChoice::Create(wxWindow
*parent
,
168 const wxArrayString
& choices
,
170 const wxValidator
& validator
,
171 const wxString
& name
)
173 wxCArrayString
chs(choices
);
174 return Create(parent
, id
, pos
, size
, chs
.GetCount(), chs
.GetStrings(),
175 style
, validator
, name
);
178 bool wxChoice::MSWShouldPreProcessMessage(WXMSG
*pMsg
)
180 MSG
*msg
= (MSG
*) pMsg
;
182 // don't preprocess "ESC" if combobox is dropped down
183 if ( msg
->message
== WM_KEYDOWN
&& msg
->wParam
== VK_ESCAPE
)
185 if (::SendMessage(GetHwndOf(this), CB_GETDROPPEDSTATE
, 0, 0))
191 return wxControl::MSWShouldPreProcessMessage(pMsg
);
194 WXDWORD
wxChoice::MSWGetStyle(long style
, WXDWORD
*exstyle
) const
196 // we never have an external border
197 WXDWORD msStyle
= wxControl::MSWGetStyle
199 (style
& ~wxBORDER_MASK
) | wxBORDER_NONE
, exstyle
202 // WS_CLIPSIBLINGS is useful with wxChoice and doesn't seem to result in
204 msStyle
|= WS_CLIPSIBLINGS
;
206 // wxChoice-specific styles
207 msStyle
|= CBS_DROPDOWNLIST
| WS_HSCROLL
| WS_VSCROLL
;
208 if ( style
& wxCB_SORT
)
214 wxChoice::~wxChoice()
219 // ----------------------------------------------------------------------------
220 // adding/deleting items to/from the list
221 // ----------------------------------------------------------------------------
223 int wxChoice::DoAppend(const wxString
& item
)
225 int n
= (int)SendMessage(GetHwnd(), CB_ADDSTRING
, 0, (LPARAM
)item
.c_str());
228 wxLogLastError(wxT("SendMessage(CB_ADDSTRING)"));
232 // we need to refresh our size in order to have enough space for the
234 UpdateVisibleHeight();
240 int wxChoice::DoInsert(const wxString
& item
, int pos
)
242 wxCHECK_MSG(!(GetWindowStyle() & wxCB_SORT
), -1, wxT("can't insert into sorted list"));
243 wxCHECK_MSG((pos
>=0) && (pos
<=GetCount()), -1, wxT("invalid index"));
245 int n
= (int)SendMessage(GetHwnd(), CB_INSERTSTRING
, pos
, (LPARAM
)item
.c_str());
248 wxLogLastError(wxT("SendMessage(CB_INSERTSTRING)"));
252 UpdateVisibleHeight();
258 void wxChoice::Delete(int n
)
260 wxCHECK_RET( n
< GetCount(), wxT("invalid item index in wxChoice::Delete") );
262 if ( HasClientObjectData() )
264 delete GetClientObject(n
);
267 SendMessage(GetHwnd(), CB_DELETESTRING
, n
, 0);
269 UpdateVisibleHeight();
272 void wxChoice::Clear()
276 SendMessage(GetHwnd(), CB_RESETCONTENT
, 0, 0);
278 UpdateVisibleHeight();
281 void wxChoice::Free()
283 if ( HasClientObjectData() )
285 size_t count
= GetCount();
286 for ( size_t n
= 0; n
< count
; n
++ )
288 delete GetClientObject(n
);
293 // ----------------------------------------------------------------------------
295 // ----------------------------------------------------------------------------
297 int wxChoice::GetSelection() 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 int wxChoice::GetCount() const
313 return (int)SendMessage(GetHwnd(), CB_GETCOUNT
, 0, 0);
316 int wxChoice::FindString(const wxString
& s
) 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 int count
= GetCount();
322 for ( int i
= 0; i
< count
; i
++ )
324 // as CB_FINDSTRINGEXACT is case insensitive, be case insensitive too
325 if ( GetString(i
).IsSameAs(s
, FALSE
) )
331 int pos
= (int)SendMessage(GetHwnd(), CB_FINDSTRINGEXACT
,
332 (WPARAM
)-1, (LPARAM
)s
.c_str());
334 return pos
== LB_ERR
? wxNOT_FOUND
: pos
;
335 #endif // Watcom/!Watcom
338 void wxChoice::SetString(int n
, const wxString
& s
)
340 wxCHECK_RET( n
>= 0 && n
< GetCount(),
341 wxT("invalid item index in wxChoice::SetString") );
343 // we have to delete and add back the string as there is no way to change a
346 // we need to preserve the client data
348 if ( m_clientDataItemsType
!= wxClientData_None
)
350 data
= DoGetItemClientData(n
);
352 else // no client data
357 ::SendMessage(GetHwnd(), CB_DELETESTRING
, n
, 0);
358 ::SendMessage(GetHwnd(), CB_INSERTSTRING
, n
, (LPARAM
)s
.c_str() );
362 DoSetItemClientData(n
, data
);
364 //else: it's already NULL by default
367 wxString
wxChoice::GetString(int n
) const
369 int len
= (int)::SendMessage(GetHwnd(), CB_GETLBTEXTLEN
, n
, 0);
372 if ( len
!= CB_ERR
&& len
> 0 )
379 (LPARAM
)(wxChar
*)wxStringBuffer(str
, len
)
382 wxLogLastError(wxT("SendMessage(CB_GETLBTEXT)"));
389 // ----------------------------------------------------------------------------
391 // ----------------------------------------------------------------------------
393 void wxChoice::DoSetItemClientData( int n
, void* clientData
)
395 if ( ::SendMessage(GetHwnd(), CB_SETITEMDATA
,
396 n
, (LPARAM
)clientData
) == CB_ERR
)
398 wxLogLastError(wxT("CB_SETITEMDATA"));
402 void* wxChoice::DoGetItemClientData( int n
) const
404 LPARAM rc
= SendMessage(GetHwnd(), CB_GETITEMDATA
, n
, 0);
407 wxLogLastError(wxT("CB_GETITEMDATA"));
409 // unfortunately, there is no way to return an error code to the user
416 void wxChoice::DoSetItemClientObject( int n
, wxClientData
* clientData
)
418 DoSetItemClientData(n
, clientData
);
421 wxClientData
* wxChoice::DoGetItemClientObject( int n
) const
423 return (wxClientData
*)DoGetItemClientData(n
);
426 // ----------------------------------------------------------------------------
427 // wxMSW specific helpers
428 // ----------------------------------------------------------------------------
430 void wxChoice::UpdateVisibleHeight()
432 // be careful to not change the width here
433 DoSetSize(-1, -1, -1, GetSize().y
, wxSIZE_USE_EXISTING
);
436 void wxChoice::DoMoveWindow(int x
, int y
, int width
, int height
)
438 // here is why this is necessary: if the width is negative, the combobox
439 // window proc makes the window of the size width*height instead of
440 // interpreting height in the usual manner (meaning the height of the drop
441 // down list - usually the height specified in the call to MoveWindow()
442 // will not change the height of combo box per se)
444 // this behaviour is not documented anywhere, but this is just how it is
445 // here (NT 4.4) and, anyhow, the check shouldn't hurt - however without
446 // the check, constraints/sizers using combos may break the height
447 // constraint will have not at all the same value as expected
451 wxControl::DoMoveWindow(x
, y
, width
, height
);
454 void wxChoice::DoGetSize(int *w
, int *h
) const
456 // this is weird: sometimes, the height returned by Windows is clearly the
457 // total height of the control including the drop down list -- but only
458 // sometimes, and normally it isn't... I have no idea about what to do with
460 wxControl::DoGetSize(w
, h
);
463 void wxChoice::DoSetSize(int x
, int y
,
464 int width
, int height
,
467 int heightOrig
= height
;
469 // the height which we must pass to Windows should be the total height of
470 // the control including the drop down list while the height given to us
471 // is, of course, just the height of the permanently visible part of it
474 // don't make the drop down list too tall, arbitrarily limit it to 40
475 // items max and also don't leave it empty
476 size_t nItems
= GetCount();
479 else if ( nItems
> 39 )
482 // add space for the drop down list
483 const int hItem
= SendMessage(GetHwnd(), CB_GETITEMHEIGHT
, 0, 0);
484 height
+= hItem
*(nItems
+ 1);
487 wxControl::DoSetSize(x
, y
, width
, height
, sizeFlags
);
489 // if the height specified for the visible part of the control is
490 // different from the current one, we need to change it separately
491 // as it is not affected by normal WM_SETSIZE
494 const int delta
= heightOrig
- GetSize().y
;
497 int h
= ::SendMessage(GetHwnd(), CB_GETITEMHEIGHT
, (WPARAM
)-1, 0);
498 SendMessage(GetHwnd(), CB_SETITEMHEIGHT
, (WPARAM
)-1, h
+ delta
);
503 wxSize
wxChoice::DoGetBestSize() const
505 // find the widest string
507 const size_t nItems
= GetCount();
508 for ( size_t i
= 0; i
< nItems
; i
++ )
511 GetTextExtent(GetString(i
), &wLine
, NULL
);
512 if ( wLine
> wChoice
)
516 // give it some reasonable default value if there are no strings in the
521 // the combobox should be slightly larger than the widest string
522 wChoice
+= 5*GetCharWidth();
524 return wxSize(wChoice
, EDIT_HEIGHT_FROM_CHAR_HEIGHT(GetCharHeight()));
527 WXLRESULT
wxChoice::MSWWindowProc(WXUINT nMsg
, WXWPARAM wParam
, WXLPARAM lParam
)
529 if ( nMsg
== WM_LBUTTONUP
)
531 int x
= (int)LOWORD(lParam
);
532 int y
= (int)HIWORD(lParam
);
534 // Ok, this is truly weird, but if a panel with a wxChoice loses the
535 // focus, then you get a *fake* WM_LBUTTONUP message with x = 65535 and
536 // y = 65535. Filter out this nonsense.
538 // VZ: I'd like to know how to reproduce this please...
539 if ( x
== 65535 && y
== 65535 )
543 return wxWindow::MSWWindowProc(nMsg
, wParam
, lParam
);
546 bool wxChoice::MSWCommand(WXUINT param
, WXWORD
WXUNUSED(id
))
548 if ( param
!= CBN_SELCHANGE
)
550 // "selection changed" is the only event we're after
554 int n
= GetSelection();
557 wxCommandEvent
event(wxEVT_COMMAND_CHOICE_SELECTED
, m_windowId
);
559 event
.SetEventObject(this);
560 event
.SetString(GetStringSelection());
561 if ( HasClientObjectData() )
562 event
.SetClientObject( GetClientObject(n
) );
563 else if ( HasClientUntypedData() )
564 event
.SetClientData( GetClientData(n
) );
565 ProcessCommand(event
);
571 WXHBRUSH
wxChoice::OnCtlColor(WXHDC pDC
, WXHWND
WXUNUSED(pWnd
), WXUINT
WXUNUSED(nCtlColor
),
572 WXUINT
WXUNUSED(message
),
573 WXWPARAM
WXUNUSED(wParam
),
574 WXLPARAM
WXUNUSED(lParam
)
578 wxColour colBack
= GetBackgroundColour();
581 colBack
= wxSystemSettings::GetColour(wxSYS_COLOUR_3DFACE
);
583 ::SetBkColor(hdc
, wxColourToRGB(colBack
));
584 ::SetTextColor(hdc
, wxColourToRGB(GetForegroundColour()));
586 wxBrush
*brush
= wxTheBrushList
->FindOrCreateBrush(colBack
, wxSOLID
);
588 return (WXHBRUSH
)brush
->GetResourceHandle();
591 #endif // wxUSE_CHOICE