]> git.saurik.com Git - wxWidgets.git/blame_incremental - src/msw/choice.cpp
warning fix - only use the function in debug mode
[wxWidgets.git] / src / msw / choice.cpp
... / ...
CommitLineData
1/////////////////////////////////////////////////////////////////////////////
2// Name: choice.cpp
3// Purpose: wxChoice
4// Author: Julian Smart
5// Modified by: Vadim Zeitlin to derive from wxChoiceBase
6// Created: 04/01/98
7// RCS-ID: $Id$
8// Copyright: (c) Julian Smart
9// Licence: wxWindows licence
10/////////////////////////////////////////////////////////////////////////////
11
12// ============================================================================
13// declarations
14// ============================================================================
15
16// ----------------------------------------------------------------------------
17// headers
18// ----------------------------------------------------------------------------
19
20#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
21 #pragma implementation "choice.h"
22#endif
23
24// For compilers that support precompilation, includes "wx.h".
25#include "wx/wxprec.h"
26
27#ifdef __BORLANDC__
28 #pragma hdrstop
29#endif
30
31#if wxUSE_CHOICE && !defined(__SMARTPHONE__)
32
33#ifndef WX_PRECOMP
34 #include "wx/choice.h"
35 #include "wx/utils.h"
36 #include "wx/log.h"
37 #include "wx/brush.h"
38 #include "wx/settings.h"
39#endif
40
41#include "wx/msw/private.h"
42
43#if wxUSE_EXTENDED_RTTI
44WX_DEFINE_FLAGS( wxChoiceStyle )
45
46wxBEGIN_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)
55
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)
63
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)
73
74wxEND_FLAGS( wxChoiceStyle )
75
76IMPLEMENT_DYNAMIC_CLASS_XTI(wxChoice, wxControl,"wx/choice.h")
77
78wxBEGIN_PROPERTIES_TABLE(wxChoice)
79 wxEVENT_PROPERTY( Select , wxEVT_COMMAND_CHOICE_SELECTED , wxCommandEvent )
80
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
85wxEND_PROPERTIES_TABLE()
86
87wxBEGIN_HANDLERS_TABLE(wxChoice)
88wxEND_HANDLERS_TABLE()
89
90wxCONSTRUCTOR_4( wxChoice , wxWindow* , Parent , wxWindowID , Id , wxPoint , Position , wxSize , Size )
91#else
92IMPLEMENT_DYNAMIC_CLASS(wxChoice, wxControl)
93#endif
94/*
95 TODO PROPERTIES
96 selection (long)
97 content (list)
98 item
99*/
100
101// ============================================================================
102// implementation
103// ============================================================================
104
105// ----------------------------------------------------------------------------
106// creation
107// ----------------------------------------------------------------------------
108
109bool wxChoice::Create(wxWindow *parent,
110 wxWindowID id,
111 const wxPoint& pos,
112 const wxSize& size,
113 int n, const wxString choices[],
114 long style,
115 const wxValidator& validator,
116 const wxString& name)
117{
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") );
125
126 return CreateAndInit(parent, id, pos, size, n, choices, style,
127 validator, name);
128}
129
130bool wxChoice::CreateAndInit(wxWindow *parent,
131 wxWindowID id,
132 const wxPoint& pos,
133 const wxSize& size,
134 int n, const wxString choices[],
135 long style,
136 const wxValidator& validator,
137 const wxString& name)
138{
139 // initialize wxControl
140 if ( !CreateControl(parent, id, pos, size, style, validator, name) )
141 return false;
142
143 // now create the real HWND
144 if ( !MSWCreateControl(wxT("COMBOBOX"), _T(""), pos, size) )
145 return false;
146
147
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));
151
152 // initialize the controls contents
153 for ( int i = 0; i < n; i++ )
154 {
155 Append(choices[i]);
156 }
157
158 // and now we may finally size the control properly (if needed)
159 SetBestSize(size);
160
161 return true;
162}
163
164bool wxChoice::Create(wxWindow *parent,
165 wxWindowID id,
166 const wxPoint& pos,
167 const wxSize& size,
168 const wxArrayString& choices,
169 long style,
170 const wxValidator& validator,
171 const wxString& name)
172{
173 wxCArrayString chs(choices);
174 return Create(parent, id, pos, size, chs.GetCount(), chs.GetStrings(),
175 style, validator, name);
176}
177
178bool wxChoice::MSWShouldPreProcessMessage(WXMSG *pMsg)
179{
180 MSG *msg = (MSG *) pMsg;
181
182 // if the dropdown list is visible, don't preprocess certain keys
183 if ( msg->message == WM_KEYDOWN
184 && (msg->wParam == VK_ESCAPE || msg->wParam == VK_RETURN) )
185 {
186 if (::SendMessage(GetHwndOf(this), CB_GETDROPPEDSTATE, 0, 0))
187 {
188 return false;
189 }
190 }
191
192 return wxControl::MSWShouldPreProcessMessage(pMsg);
193}
194
195WXDWORD wxChoice::MSWGetStyle(long style, WXDWORD *exstyle) const
196{
197 // we never have an external border
198 WXDWORD msStyle = wxControl::MSWGetStyle
199 (
200 (style & ~wxBORDER_MASK) | wxBORDER_NONE, exstyle
201 );
202
203 // WS_CLIPSIBLINGS is useful with wxChoice and doesn't seem to result in
204 // any problems
205 msStyle |= WS_CLIPSIBLINGS;
206
207 // wxChoice-specific styles
208 msStyle |= CBS_DROPDOWNLIST | WS_HSCROLL | WS_VSCROLL;
209 if ( style & wxCB_SORT )
210 msStyle |= CBS_SORT;
211
212 return msStyle;
213}
214
215wxChoice::~wxChoice()
216{
217 Free();
218}
219
220// ----------------------------------------------------------------------------
221// adding/deleting items to/from the list
222// ----------------------------------------------------------------------------
223
224int wxChoice::DoAppend(const wxString& item)
225{
226 int n = (int)SendMessage(GetHwnd(), CB_ADDSTRING, 0, (LPARAM)item.c_str());
227 if ( n == CB_ERR )
228 {
229 wxLogLastError(wxT("SendMessage(CB_ADDSTRING)"));
230 }
231 else // ok
232 {
233 // we need to refresh our size in order to have enough space for the
234 // newly added items
235 if ( !IsFrozen() )
236 UpdateVisibleHeight();
237 }
238
239 return n;
240}
241
242int wxChoice::DoInsert(const wxString& item, int pos)
243{
244 wxCHECK_MSG(!(GetWindowStyle() & wxCB_SORT), -1, wxT("can't insert into sorted list"));
245 wxCHECK_MSG((pos>=0) && (pos<=GetCount()), -1, wxT("invalid index"));
246
247 int n = (int)SendMessage(GetHwnd(), CB_INSERTSTRING, pos, (LPARAM)item.c_str());
248 if ( n == CB_ERR )
249 {
250 wxLogLastError(wxT("SendMessage(CB_INSERTSTRING)"));
251 }
252 else // ok
253 {
254 if ( !IsFrozen() )
255 UpdateVisibleHeight();
256 }
257
258 return n;
259}
260
261void wxChoice::Delete(int n)
262{
263 wxCHECK_RET( n < GetCount(), wxT("invalid item index in wxChoice::Delete") );
264
265 if ( HasClientObjectData() )
266 {
267 delete GetClientObject(n);
268 }
269
270 SendMessage(GetHwnd(), CB_DELETESTRING, n, 0);
271
272 if ( !IsFrozen() )
273 UpdateVisibleHeight();
274}
275
276void wxChoice::Clear()
277{
278 Free();
279
280 SendMessage(GetHwnd(), CB_RESETCONTENT, 0, 0);
281
282 if ( !IsFrozen() )
283 UpdateVisibleHeight();
284}
285
286void wxChoice::Free()
287{
288 if ( HasClientObjectData() )
289 {
290 size_t count = GetCount();
291 for ( size_t n = 0; n < count; n++ )
292 {
293 delete GetClientObject(n);
294 }
295 }
296}
297
298// ----------------------------------------------------------------------------
299// selection
300// ----------------------------------------------------------------------------
301
302int wxChoice::GetSelection() const
303{
304 return (int)SendMessage(GetHwnd(), CB_GETCURSEL, 0, 0);
305}
306
307void wxChoice::SetSelection(int n)
308{
309 SendMessage(GetHwnd(), CB_SETCURSEL, n, 0);
310}
311
312// ----------------------------------------------------------------------------
313// string list functions
314// ----------------------------------------------------------------------------
315
316int wxChoice::GetCount() const
317{
318 return (int)SendMessage(GetHwnd(), CB_GETCOUNT, 0, 0);
319}
320
321int wxChoice::FindString(const wxString& s) const
322{
323#if defined(__WATCOMC__) && defined(__WIN386__)
324 // For some reason, Watcom in WIN386 mode crashes in the CB_FINDSTRINGEXACT message.
325 // wxChoice::Do it the long way instead.
326 int count = GetCount();
327 for ( int i = 0; i < count; i++ )
328 {
329 // as CB_FINDSTRINGEXACT is case insensitive, be case insensitive too
330 if ( GetString(i).IsSameAs(s, false) )
331 return i;
332 }
333
334 return wxNOT_FOUND;
335#else // !Watcom
336 int pos = (int)SendMessage(GetHwnd(), CB_FINDSTRINGEXACT,
337 (WPARAM)-1, (LPARAM)s.c_str());
338
339 return pos == LB_ERR ? wxNOT_FOUND : pos;
340#endif // Watcom/!Watcom
341}
342
343void wxChoice::SetString(int n, const wxString& s)
344{
345 wxCHECK_RET( n >= 0 && n < GetCount(),
346 wxT("invalid item index in wxChoice::SetString") );
347
348 // we have to delete and add back the string as there is no way to change a
349 // string in place
350
351 // we need to preserve the client data
352 void *data;
353 if ( m_clientDataItemsType != wxClientData_None )
354 {
355 data = DoGetItemClientData(n);
356 }
357 else // no client data
358 {
359 data = NULL;
360 }
361
362 ::SendMessage(GetHwnd(), CB_DELETESTRING, n, 0);
363 ::SendMessage(GetHwnd(), CB_INSERTSTRING, n, (LPARAM)s.c_str() );
364
365 if ( data )
366 {
367 DoSetItemClientData(n, data);
368 }
369 //else: it's already NULL by default
370}
371
372wxString wxChoice::GetString(int n) const
373{
374 int len = (int)::SendMessage(GetHwnd(), CB_GETLBTEXTLEN, n, 0);
375
376 wxString str;
377 if ( len != CB_ERR && len > 0 )
378 {
379 if ( ::SendMessage
380 (
381 GetHwnd(),
382 CB_GETLBTEXT,
383 n,
384 (LPARAM)(wxChar *)wxStringBuffer(str, len)
385 ) == CB_ERR )
386 {
387 wxLogLastError(wxT("SendMessage(CB_GETLBTEXT)"));
388 }
389 }
390
391 return str;
392}
393
394// ----------------------------------------------------------------------------
395// client data
396// ----------------------------------------------------------------------------
397
398void wxChoice::DoSetItemClientData( int n, void* clientData )
399{
400 if ( ::SendMessage(GetHwnd(), CB_SETITEMDATA,
401 n, (LPARAM)clientData) == CB_ERR )
402 {
403 wxLogLastError(wxT("CB_SETITEMDATA"));
404 }
405}
406
407void* wxChoice::DoGetItemClientData( int n ) const
408{
409 LPARAM rc = SendMessage(GetHwnd(), CB_GETITEMDATA, n, 0);
410 if ( rc == CB_ERR )
411 {
412 wxLogLastError(wxT("CB_GETITEMDATA"));
413
414 // unfortunately, there is no way to return an error code to the user
415 rc = (LPARAM) NULL;
416 }
417
418 return (void *)rc;
419}
420
421void wxChoice::DoSetItemClientObject( int n, wxClientData* clientData )
422{
423 DoSetItemClientData(n, clientData);
424}
425
426wxClientData* wxChoice::DoGetItemClientObject( int n ) const
427{
428 return (wxClientData *)DoGetItemClientData(n);
429}
430
431// ----------------------------------------------------------------------------
432// wxMSW specific helpers
433// ----------------------------------------------------------------------------
434
435void wxChoice::UpdateVisibleHeight()
436{
437 // be careful to not change the width here
438 DoSetSize(wxDefaultCoord, wxDefaultCoord, wxDefaultCoord, GetSize().y, wxSIZE_USE_EXISTING);
439}
440
441void wxChoice::DoMoveWindow(int x, int y, int width, int height)
442{
443 // here is why this is necessary: if the width is negative, the combobox
444 // window proc makes the window of the size width*height instead of
445 // interpreting height in the usual manner (meaning the height of the drop
446 // down list - usually the height specified in the call to MoveWindow()
447 // will not change the height of combo box per se)
448 //
449 // this behaviour is not documented anywhere, but this is just how it is
450 // here (NT 4.4) and, anyhow, the check shouldn't hurt - however without
451 // the check, constraints/sizers using combos may break the height
452 // constraint will have not at all the same value as expected
453 if ( width < 0 )
454 return;
455
456 wxControl::DoMoveWindow(x, y, width, height);
457}
458
459void wxChoice::DoGetSize(int *w, int *h) const
460{
461 // this is weird: sometimes, the height returned by Windows is clearly the
462 // total height of the control including the drop down list -- but only
463 // sometimes, and normally it isn't... I have no idea about what to do with
464 // this
465 wxControl::DoGetSize(w, h);
466}
467
468void wxChoice::DoSetSize(int x, int y,
469 int width, int height,
470 int sizeFlags)
471{
472 int heightOrig = height;
473
474 // the height which we must pass to Windows should be the total height of
475 // the control including the drop down list while the height given to us
476 // is, of course, just the height of the permanently visible part of it
477 if ( height != wxDefaultCoord )
478 {
479 // don't make the drop down list too tall, arbitrarily limit it to 40
480 // items max and also don't leave it empty
481 size_t nItems = GetCount();
482 if ( !nItems )
483 nItems = 9;
484 else if ( nItems > 24 )
485 nItems = 24;
486
487 // add space for the drop down list
488 const int hItem = SendMessage(GetHwnd(), CB_GETITEMHEIGHT, 0, 0);
489 height += hItem*(nItems + 1);
490 }
491
492 wxControl::DoSetSize(x, y, width, height, sizeFlags);
493
494 // I'm commenting this out since the code appears to make choices
495 // and comboxes too high when they have associated sizers. I'm sure this
496 // is not the end of the story, which is why I'm leaving it #if'ed out for
497 // now. JACS.
498#if 0
499 // if the height specified for the visible part of the control is
500 // different from the current one, we need to change it separately
501 // as it is not affected by normal WM_SETSIZE
502 if ( height != wxDefaultCoord )
503 {
504 const int delta = heightOrig - GetSize().y;
505 if ( delta )
506 {
507 int h = ::SendMessage(GetHwnd(), CB_GETITEMHEIGHT, (WPARAM)-1, 0);
508 SendMessage(GetHwnd(), CB_SETITEMHEIGHT, (WPARAM)-1, h + delta);
509 }
510 }
511#else
512 wxUnusedVar(heightOrig);
513#endif
514}
515
516wxSize wxChoice::DoGetBestSize() const
517{
518 // find the widest string
519 int wChoice = 0;
520 const size_t nItems = GetCount();
521 for ( size_t i = 0; i < nItems; i++ )
522 {
523 int wLine;
524 GetTextExtent(GetString(i), &wLine, NULL);
525 if ( wLine > wChoice )
526 wChoice = wLine;
527 }
528
529 // give it some reasonable default value if there are no strings in the
530 // list
531 if ( wChoice == 0 )
532 wChoice = 100;
533
534 // the combobox should be slightly larger than the widest string
535 wChoice += 5*GetCharWidth();
536
537 return wxSize(wChoice, EDIT_HEIGHT_FROM_CHAR_HEIGHT(GetCharHeight()));
538}
539
540WXLRESULT wxChoice::MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam)
541{
542 switch ( nMsg )
543 {
544 case WM_LBUTTONUP:
545 {
546 int x = (int)LOWORD(lParam);
547 int y = (int)HIWORD(lParam);
548
549 // Ok, this is truly weird, but if a panel with a wxChoice
550 // loses the focus, then you get a *fake* WM_LBUTTONUP message
551 // with x = 65535 and y = 65535. Filter out this nonsense.
552 //
553 // VZ: I'd like to know how to reproduce this please...
554 if ( x == 65535 && y == 65535 )
555 return 0;
556 }
557 break;
558
559 // we have to handle both: one for the normal case and the other
560 // for readonly
561 case WM_CTLCOLOREDIT:
562 case WM_CTLCOLORLISTBOX:
563 case WM_CTLCOLORSTATIC:
564 {
565 WXWORD nCtlColor;
566 WXHDC hdc;
567 WXHWND hwnd;
568 UnpackCtlColor(wParam, lParam, &nCtlColor, &hdc, &hwnd);
569
570 return (WXLRESULT)OnCtlColor(hdc, hwnd, nCtlColor,
571 nMsg, wParam, lParam);
572 }
573 }
574
575 return wxWindow::MSWWindowProc(nMsg, wParam, lParam);
576}
577
578bool wxChoice::MSWCommand(WXUINT param, WXWORD WXUNUSED(id))
579{
580 if ( param != CBN_SELCHANGE)
581 {
582 // "selection changed" is the only event we're after
583 return false;
584 }
585
586 int n = GetSelection();
587 if (n > -1)
588 {
589 wxCommandEvent event(wxEVT_COMMAND_CHOICE_SELECTED, m_windowId);
590 event.SetInt(n);
591 event.SetEventObject(this);
592 event.SetString(GetStringSelection());
593 if ( HasClientObjectData() )
594 event.SetClientObject( GetClientObject(n) );
595 else if ( HasClientUntypedData() )
596 event.SetClientData( GetClientData(n) );
597 ProcessCommand(event);
598 }
599
600 return true;
601}
602
603WXHBRUSH wxChoice::OnCtlColor(WXHDC pDC, WXHWND WXUNUSED(pWnd), WXUINT WXUNUSED(nCtlColor),
604 WXUINT WXUNUSED(message),
605 WXWPARAM WXUNUSED(wParam),
606 WXLPARAM WXUNUSED(lParam)
607 )
608{
609 HDC hdc = (HDC)pDC;
610 wxColour colBack = GetBackgroundColour();
611
612 if (!IsEnabled())
613 colBack = wxSystemSettings::GetColour(wxSYS_COLOUR_3DFACE);
614
615 ::SetBkColor(hdc, wxColourToRGB(colBack));
616 ::SetTextColor(hdc, wxColourToRGB(GetForegroundColour()));
617
618 wxBrush *brush = wxTheBrushList->FindOrCreateBrush(colBack, wxSOLID);
619
620 return (WXHBRUSH)brush->GetResourceHandle();
621}
622
623#endif // wxUSE_CHOICE && !__SMARTPHONE__