]> git.saurik.com Git - wxWidgets.git/blame - src/msw/listbox.cpp
full keyboard access support
[wxWidgets.git] / src / msw / listbox.cpp
CommitLineData
2bda0e17 1///////////////////////////////////////////////////////////////////////////////
1e6feb95 2// Name: src/msw/listbox.cpp
2bda0e17
KB
3// Purpose: wxListBox
4// Author: Julian Smart
5// Modified by: Vadim Zeitlin (owner drawn stuff)
dd3c394a 6// Created:
2bda0e17
KB
7// RCS-ID: $Id$
8// Copyright: (c) Julian Smart
65571936 9// Licence: wxWindows licence
2bda0e17
KB
10///////////////////////////////////////////////////////////////////////////////
11
2bda0e17
KB
12// For compilers that support precompilation, includes "wx.h".
13#include "wx/wxprec.h"
14
15#ifdef __BORLANDC__
dd3c394a 16 #pragma hdrstop
2bda0e17
KB
17#endif
18
1e6feb95 19#if wxUSE_LISTBOX
0c589ad0 20
2bda0e17 21#ifndef WX_PRECOMP
0c589ad0
BM
22#include "wx/listbox.h"
23#include "wx/settings.h"
24#include "wx/brush.h"
25#include "wx/font.h"
26#include "wx/dc.h"
2662e49e 27#include "wx/utils.h"
2bda0e17
KB
28#endif
29
1e6feb95
VZ
30#include "wx/window.h"
31#include "wx/msw/private.h"
32
5ea105e0
RR
33#include <windowsx.h>
34
0c589ad0
BM
35#include "wx/dynarray.h"
36#include "wx/log.h"
2bda0e17 37
0c589ad0
BM
38#if wxUSE_OWNER_DRAWN
39 #include "wx/ownerdrw.h"
40#endif
2bda0e17 41
6a89f9ee 42#if wxUSE_EXTENDED_RTTI
bc9fb572
JS
43WX_DEFINE_FLAGS( wxListBoxStyle )
44
3ff066a4 45wxBEGIN_FLAGS( wxListBoxStyle )
bc9fb572
JS
46 // new style border flags, we put them first to
47 // use them for streaming out
3ff066a4
SC
48 wxFLAGS_MEMBER(wxBORDER_SIMPLE)
49 wxFLAGS_MEMBER(wxBORDER_SUNKEN)
50 wxFLAGS_MEMBER(wxBORDER_DOUBLE)
51 wxFLAGS_MEMBER(wxBORDER_RAISED)
52 wxFLAGS_MEMBER(wxBORDER_STATIC)
53 wxFLAGS_MEMBER(wxBORDER_NONE)
7ec5921d 54
bc9fb572 55 // old style border flags
3ff066a4
SC
56 wxFLAGS_MEMBER(wxSIMPLE_BORDER)
57 wxFLAGS_MEMBER(wxSUNKEN_BORDER)
58 wxFLAGS_MEMBER(wxDOUBLE_BORDER)
59 wxFLAGS_MEMBER(wxRAISED_BORDER)
60 wxFLAGS_MEMBER(wxSTATIC_BORDER)
cb0afb26 61 wxFLAGS_MEMBER(wxBORDER)
bc9fb572
JS
62
63 // standard window styles
3ff066a4
SC
64 wxFLAGS_MEMBER(wxTAB_TRAVERSAL)
65 wxFLAGS_MEMBER(wxCLIP_CHILDREN)
66 wxFLAGS_MEMBER(wxTRANSPARENT_WINDOW)
67 wxFLAGS_MEMBER(wxWANTS_CHARS)
cb0afb26 68 wxFLAGS_MEMBER(wxFULL_REPAINT_ON_RESIZE)
3ff066a4
SC
69 wxFLAGS_MEMBER(wxALWAYS_SHOW_SB )
70 wxFLAGS_MEMBER(wxVSCROLL)
71 wxFLAGS_MEMBER(wxHSCROLL)
72
73 wxFLAGS_MEMBER(wxLB_SINGLE)
74 wxFLAGS_MEMBER(wxLB_MULTIPLE)
75 wxFLAGS_MEMBER(wxLB_EXTENDED)
76 wxFLAGS_MEMBER(wxLB_HSCROLL)
77 wxFLAGS_MEMBER(wxLB_ALWAYS_SB)
78 wxFLAGS_MEMBER(wxLB_NEEDED_SB)
79 wxFLAGS_MEMBER(wxLB_SORT)
80
81wxEND_FLAGS( wxListBoxStyle )
bc9fb572 82
6a89f9ee
SC
83IMPLEMENT_DYNAMIC_CLASS_XTI(wxListBox, wxControl,"wx/listbox.h")
84
3ff066a4 85wxBEGIN_PROPERTIES_TABLE(wxListBox)
665b71b1
WS
86 wxEVENT_PROPERTY( Select , wxEVT_COMMAND_LISTBOX_SELECTED , wxCommandEvent )
87 wxEVENT_PROPERTY( DoubleClick , wxEVT_COMMAND_LISTBOX_DOUBLECLICKED , wxCommandEvent )
c5ca409b 88
af498247 89 wxPROPERTY( Font , wxFont , SetFont , GetFont , EMPTY_MACROVALUE, 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
3ff066a4 90 wxPROPERTY_COLLECTION( Choices , wxArrayString , wxString , AppendString , GetStrings, 0 /*flags*/ , wxT("Helpstring") , wxT("group") )
665b71b1 91 wxPROPERTY( Selection ,int, SetSelection, GetSelection, EMPTY_MACROVALUE , 0 /*flags*/ , wxT("Helpstring") , wxT("group") )
af498247 92 wxPROPERTY_FLAGS( WindowStyle , wxListBoxStyle , long , SetWindowStyleFlag , GetWindowStyleFlag , EMPTY_MACROVALUE , 0 /*flags*/ , wxT("Helpstring") , wxT("group")) // style
3ff066a4 93wxEND_PROPERTIES_TABLE()
6a89f9ee 94
3ff066a4
SC
95wxBEGIN_HANDLERS_TABLE(wxListBox)
96wxEND_HANDLERS_TABLE()
6a89f9ee 97
7ec5921d 98wxCONSTRUCTOR_4( wxListBox , wxWindow* , Parent , wxWindowID , Id , wxPoint , Position , wxSize , Size )
6a89f9ee 99#else
9c9c3d7a 100IMPLEMENT_DYNAMIC_CLASS(wxListBox, wxControl)
6a89f9ee 101#endif
2bda0e17 102
066f1b7a
SC
103/*
104TODO PROPERTIES
665b71b1
WS
105 selection
106 content
107 item
066f1b7a
SC
108*/
109
2bda0e17
KB
110// ============================================================================
111// list box item declaration and implementation
112// ============================================================================
113
47d67540 114#if wxUSE_OWNER_DRAWN
2bda0e17
KB
115
116class wxListBoxItem : public wxOwnerDrawn
117{
118public:
2b5f62a0 119 wxListBoxItem(const wxString& str = wxEmptyString);
2bda0e17
KB
120};
121
598ddd96 122wxListBoxItem::wxListBoxItem(const wxString& str) : wxOwnerDrawn(str, false)
2bda0e17 123{
dd3c394a
VZ
124 // no bitmaps/checkmarks
125 SetMarginWidth(0);
2bda0e17
KB
126}
127
2b5f62a0 128wxOwnerDrawn *wxListBox::CreateLboxItem(size_t WXUNUSED(n))
2bda0e17 129{
dd3c394a 130 return new wxListBoxItem();
2bda0e17
KB
131}
132
133#endif //USE_OWNER_DRAWN
134
135// ============================================================================
136// list box control implementation
137// ============================================================================
138
2ee3ee1b
VZ
139// ----------------------------------------------------------------------------
140// creation
141// ----------------------------------------------------------------------------
dd3c394a 142
2ee3ee1b 143// Listbox item
bfc6fde4 144wxListBox::wxListBox()
2bda0e17 145{
dd3c394a
VZ
146 m_noItems = 0;
147 m_selected = 0;
2bda0e17
KB
148}
149
dd3c394a
VZ
150bool wxListBox::Create(wxWindow *parent,
151 wxWindowID id,
2bda0e17
KB
152 const wxPoint& pos,
153 const wxSize& size,
debe6624
JS
154 int n, const wxString choices[],
155 long style,
56a44c64 156 const wxValidator& validator,
2bda0e17
KB
157 const wxString& name)
158{
dd3c394a 159 m_noItems = 0;
dd3c394a 160 m_selected = 0;
2bda0e17 161
7a69cd96
VZ
162 // initialize base class fields
163 if ( !CreateControl(parent, id, pos, size, style, validator, name) )
164 return false;
2bda0e17 165
7a69cd96
VZ
166 // create the native control
167 if ( !MSWCreateControl(_T("LISTBOX"), wxEmptyString, pos, size) )
168 {
169 // control creation failed
170 return false;
2bda0e17 171 }
1c089c47 172
7a69cd96
VZ
173 // initialize the contents
174 for ( int i = 0; i < n; i++ )
175 {
176 Append(choices[i]);
2bda0e17 177 }
2bda0e17 178
7ec5921d
VZ
179 // now we can compute our best size correctly, so do it if necessary
180 SetBestSize(size);
181
7a69cd96 182 return true;
2bda0e17
KB
183}
184
584ad2a3
MB
185bool wxListBox::Create(wxWindow *parent,
186 wxWindowID id,
187 const wxPoint& pos,
188 const wxSize& size,
189 const wxArrayString& choices,
190 long style,
76efbc2a 191 const wxValidator& validator,
584ad2a3
MB
192 const wxString& name)
193{
194 wxCArrayString chs(choices);
195 return Create(parent, id, pos, size, chs.GetCount(), chs.GetStrings(),
196 style, validator, name);
197}
198
bfc6fde4 199wxListBox::~wxListBox()
2bda0e17 200{
baccb514 201 Free();
2bda0e17
KB
202}
203
7a69cd96 204WXDWORD wxListBox::MSWGetStyle(long style, WXDWORD *exstyle) const
2bda0e17 205{
7a69cd96
VZ
206 WXDWORD msStyle = wxControl::MSWGetStyle(style, exstyle);
207
6079ab87
VZ
208 // always show the vertical scrollbar if necessary -- otherwise it is
209 // impossible to use the control with the mouse
210 msStyle |= WS_VSCROLL;
211
7a69cd96
VZ
212 // we always want to get the notifications
213 msStyle |= LBS_NOTIFY;
214
215 // without this style, you get unexpected heights, so e.g. constraint
216 // layout doesn't work properly
217 msStyle |= LBS_NOINTEGRALHEIGHT;
218
219 wxASSERT_MSG( !(style & wxLB_MULTIPLE) || !(style & wxLB_EXTENDED),
220 _T("only one of listbox selection modes can be specified") );
221
222 if ( style & wxLB_MULTIPLE )
223 msStyle |= LBS_MULTIPLESEL;
224 else if ( style & wxLB_EXTENDED )
225 msStyle |= LBS_EXTENDEDSEL;
226
227 if ( m_windowStyle & wxLB_ALWAYS_SB )
228 msStyle |= LBS_DISABLENOSCROLL;
229 if ( m_windowStyle & wxLB_HSCROLL )
230 msStyle |= WS_HSCROLL;
231 if ( m_windowStyle & wxLB_SORT )
232 msStyle |= LBS_SORT;
233
234#if wxUSE_OWNER_DRAWN && !defined(__WXWINCE__)
235 if ( m_windowStyle & wxLB_OWNERDRAW )
236 {
237 // we don't support LBS_OWNERDRAWVARIABLE yet and we also always put
238 // the strings in the listbox for simplicity even though we could have
239 // avoided it in this case
240 msStyle |= LBS_OWNERDRAWFIXED | LBS_HASSTRINGS;
241 }
242#endif // wxUSE_OWNER_DRAWN
243
244 return msStyle;
2bda0e17
KB
245}
246
2ee3ee1b
VZ
247// ----------------------------------------------------------------------------
248// implementation of wxListBoxBase methods
249// ----------------------------------------------------------------------------
250
251void wxListBox::DoSetFirstItem(int N)
2bda0e17 252{
dd3c394a 253 wxCHECK_RET( N >= 0 && N < m_noItems,
223d09f6 254 wxT("invalid index in wxListBox::SetFirstItem") );
dd3c394a 255
2ee3ee1b 256 SendMessage(GetHwnd(), LB_SETTOPINDEX, (WPARAM)N, (LPARAM)0);
2bda0e17
KB
257}
258
debe6624 259void wxListBox::Delete(int N)
2bda0e17 260{
dd3c394a 261 wxCHECK_RET( N >= 0 && N < m_noItems,
223d09f6 262 wxT("invalid index in wxListBox::Delete") );
dd3c394a 263
07cf98cb
VZ
264 // for owner drawn objects, the data is used for storing wxOwnerDrawn
265 // pointers and we shouldn't touch it
266#if !wxUSE_OWNER_DRAWN
267 if ( !(m_windowStyle & wxLB_OWNERDRAW) )
268#endif // !wxUSE_OWNER_DRAWN
269 if ( HasClientObjectData() )
270 {
271 delete GetClientObject(N);
272 }
6c8a980f 273
a23fd0e1 274 SendMessage(GetHwnd(), LB_DELETESTRING, N, 0);
dd3c394a
VZ
275 m_noItems--;
276
2b5f62a0 277 SetHorizontalExtent(wxEmptyString);
31582e4e
RD
278
279 InvalidateBestSize();
2bda0e17
KB
280}
281
2ee3ee1b 282int wxListBox::DoAppend(const wxString& item)
2bda0e17 283{
a23fd0e1 284 int index = ListBox_AddString(GetHwnd(), item);
2ee3ee1b 285 m_noItems++;
2bda0e17 286
47d67540 287#if wxUSE_OWNER_DRAWN
2bda0e17 288 if ( m_windowStyle & wxLB_OWNERDRAW ) {
2b5f62a0 289 wxOwnerDrawn *pNewItem = CreateLboxItem(index); // dummy argument
dd3c394a 290 pNewItem->SetName(item);
fd7ab28c 291 m_aItems.Insert(pNewItem, index);
a23fd0e1 292 ListBox_SetItemData(GetHwnd(), index, pNewItem);
60c65519 293 pNewItem->SetFont(GetFont());
2bda0e17 294 }
fd7ab28c 295#endif // wxUSE_OWNER_DRAWN
2bda0e17 296
dd3c394a 297 SetHorizontalExtent(item);
dd3c394a 298
31582e4e 299 InvalidateBestSize();
2ee3ee1b 300 return index;
2bda0e17
KB
301}
302
2ee3ee1b 303void wxListBox::DoSetItems(const wxArrayString& choices, void** clientData)
2bda0e17 304{
f6bcfd97
BP
305 // avoid flicker - but don't need to do this for a hidden listbox
306 bool hideAndShow = IsShown();
307 if ( hideAndShow )
308 {
309 ShowWindow(GetHwnd(), SW_HIDE);
310 }
2ee3ee1b 311
a23fd0e1 312 ListBox_ResetContent(GetHwnd());
2ee3ee1b
VZ
313
314 m_noItems = choices.GetCount();
dd3c394a 315 int i;
2ee3ee1b 316 for (i = 0; i < m_noItems; i++)
dd3c394a 317 {
a23fd0e1 318 ListBox_AddString(GetHwnd(), choices[i]);
dd3c394a 319 if ( clientData )
2ee3ee1b 320 {
2b5f62a0 321 SetClientData(i, clientData[i]);
2ee3ee1b 322 }
dd3c394a 323 }
2bda0e17 324
47d67540 325#if wxUSE_OWNER_DRAWN
2bda0e17 326 if ( m_windowStyle & wxLB_OWNERDRAW ) {
dd3c394a 327 // first delete old items
fd7ab28c 328 WX_CLEAR_ARRAY(m_aItems);
dd3c394a
VZ
329
330 // then create new ones
fd7ab28c 331 for ( size_t ui = 0; ui < (size_t)m_noItems; ui++ ) {
2b5f62a0 332 wxOwnerDrawn *pNewItem = CreateLboxItem(ui);
dd3c394a
VZ
333 pNewItem->SetName(choices[ui]);
334 m_aItems.Add(pNewItem);
a23fd0e1 335 ListBox_SetItemData(GetHwnd(), ui, pNewItem);
dd3c394a 336 }
2bda0e17 337 }
2ee3ee1b
VZ
338#endif // wxUSE_OWNER_DRAWN
339
340 SetHorizontalExtent();
2bda0e17 341
f6bcfd97
BP
342 if ( hideAndShow )
343 {
344 // show the listbox back if we hid it
345 ShowWindow(GetHwnd(), SW_SHOW);
346 }
31582e4e
RD
347
348 InvalidateBestSize();
2bda0e17
KB
349}
350
11e62fe6 351int wxListBox::FindString(const wxString& s, bool bCase) const
2bda0e17 352{
11e62fe6
WS
353 // back to base class search for not native search type
354 if (bCase)
355 return wxItemContainerImmutable::FindString( s, bCase );
356
4a10ea8b 357 int pos = ListBox_FindStringExact(GetHwnd(), -1, s);
dd3c394a 358 if (pos == LB_ERR)
2ee3ee1b 359 return wxNOT_FOUND;
dd3c394a
VZ
360 else
361 return pos;
2bda0e17
KB
362}
363
bfc6fde4 364void wxListBox::Clear()
2bda0e17 365{
baccb514 366 Free();
8ee9d618
VZ
367
368 ListBox_ResetContent(GetHwnd());
369
370 m_noItems = 0;
371 SetHorizontalExtent();
31582e4e
RD
372
373 InvalidateBestSize();
8ee9d618
VZ
374}
375
376void wxListBox::Free()
2b273975 377{
dd3c394a 378#if wxUSE_OWNER_DRAWN
185fa6bf
VZ
379 if ( m_windowStyle & wxLB_OWNERDRAW )
380 {
fd7ab28c 381 WX_CLEAR_ARRAY(m_aItems);
185fa6bf
VZ
382 }
383 else
384#endif // wxUSE_OWNER_DRAWN
6c8a980f
VZ
385 if ( HasClientObjectData() )
386 {
387 for ( size_t n = 0; n < (size_t)m_noItems; n++ )
388 {
389 delete GetClientObject(n);
390 }
391 }
2bda0e17 392}
baccb514 393
c6179a84 394void wxListBox::DoSetSelection(int N, bool select)
2bda0e17 395{
7ec5921d 396 wxCHECK_RET( N == wxNOT_FOUND ||
5955710c 397 (N >= 0 && N < m_noItems),
223d09f6 398 wxT("invalid index in wxListBox::SetSelection") );
dd3c394a 399
2ee3ee1b
VZ
400 if ( HasMultipleSelection() )
401 {
a23fd0e1 402 SendMessage(GetHwnd(), LB_SETSEL, select, N);
2ee3ee1b 403 }
dd3c394a
VZ
404 else
405 {
2ee3ee1b 406 SendMessage(GetHwnd(), LB_SETCURSEL, select ? N : -1, 0);
dd3c394a 407 }
2bda0e17
KB
408}
409
2ee3ee1b 410bool wxListBox::IsSelected(int N) const
2bda0e17 411{
598ddd96 412 wxCHECK_MSG( N >= 0 && N < m_noItems, false,
223d09f6 413 wxT("invalid index in wxListBox::Selected") );
dd3c394a 414
598ddd96 415 return SendMessage(GetHwnd(), LB_GETSEL, N, 0) == 0 ? false : true;
2bda0e17
KB
416}
417
6c8a980f 418wxClientData* wxListBox::DoGetItemClientObject(int n) const
2bda0e17 419{
6c8a980f 420 return (wxClientData *)DoGetItemClientData(n);
2bda0e17
KB
421}
422
6c8a980f 423void *wxListBox::DoGetItemClientData(int n) const
2bda0e17 424{
2ee3ee1b 425 wxCHECK_MSG( n >= 0 && n < m_noItems, NULL,
223d09f6 426 wxT("invalid index in wxListBox::GetClientData") );
dd3c394a 427
2ee3ee1b 428 return (void *)SendMessage(GetHwnd(), LB_GETITEMDATA, n, 0);
2bda0e17
KB
429}
430
6c8a980f 431void wxListBox::DoSetItemClientObject(int n, wxClientData* clientData)
2bda0e17 432{
6c8a980f 433 DoSetItemClientData(n, clientData);
2ee3ee1b
VZ
434}
435
6c8a980f 436void wxListBox::DoSetItemClientData(int n, void *clientData)
2ee3ee1b
VZ
437{
438 wxCHECK_RET( n >= 0 && n < m_noItems,
223d09f6 439 wxT("invalid index in wxListBox::SetClientData") );
dd3c394a 440
2ee3ee1b
VZ
441#if wxUSE_OWNER_DRAWN
442 if ( m_windowStyle & wxLB_OWNERDRAW )
443 {
444 // client data must be pointer to wxOwnerDrawn, otherwise we would crash
445 // in OnMeasure/OnDraw.
446 wxFAIL_MSG(wxT("Can't use client data with owner-drawn listboxes"));
447 }
448#endif // wxUSE_OWNER_DRAWN
449
450 if ( ListBox_SetItemData(GetHwnd(), n, clientData) == LB_ERR )
223d09f6 451 wxLogDebug(wxT("LB_SETITEMDATA failed"));
2bda0e17
KB
452}
453
454// Return number of selections and an array of selected integers
14483330 455int wxListBox::GetSelections(wxArrayInt& aSelections) const
2bda0e17 456{
dd3c394a 457 aSelections.Empty();
14483330 458
2ee3ee1b 459 if ( HasMultipleSelection() )
dd3c394a 460 {
d90879fa
VZ
461 int countSel = ListBox_GetSelCount(GetHwnd());
462 if ( countSel == LB_ERR )
463 {
464 wxLogDebug(_T("ListBox_GetSelCount failed"));
465 }
466 else if ( countSel != 0 )
467 {
468 int *selections = new int[countSel];
14483330 469
d90879fa
VZ
470 if ( ListBox_GetSelItems(GetHwnd(),
471 countSel, selections) == LB_ERR )
472 {
473 wxLogDebug(wxT("ListBox_GetSelItems failed"));
474 countSel = -1;
475 }
476 else
477 {
478 aSelections.Alloc(countSel);
479 for ( int n = 0; n < countSel; n++ )
480 aSelections.Add(selections[n]);
481 }
14483330 482
dd3c394a
VZ
483 delete [] selections;
484 }
14483330 485
d90879fa 486 return countSel;
dd3c394a
VZ
487 }
488 else // single-selection listbox
489 {
f6bcfd97
BP
490 if (ListBox_GetCurSel(GetHwnd()) > -1)
491 aSelections.Add(ListBox_GetCurSel(GetHwnd()));
14483330 492
f6bcfd97 493 return aSelections.Count();
dd3c394a 494 }
2bda0e17
KB
495}
496
497// Get single selection, for single choice list items
14483330 498int wxListBox::GetSelection() const
2bda0e17 499{
2ee3ee1b 500 wxCHECK_MSG( !HasMultipleSelection(),
dd3c394a 501 -1,
f6bcfd97 502 wxT("GetSelection() can't be used with multiple-selection listboxes, use GetSelections() instead.") );
14483330 503
a23fd0e1 504 return ListBox_GetCurSel(GetHwnd());
2bda0e17
KB
505}
506
507// Find string for position
debe6624 508wxString wxListBox::GetString(int N) const
2bda0e17 509{
2b5f62a0 510 wxCHECK_MSG( N >= 0 && N < m_noItems, wxEmptyString,
66cf41cb 511 wxT("invalid index in wxListBox::GetString") );
dd3c394a 512
a23fd0e1 513 int len = ListBox_GetTextLen(GetHwnd(), N);
dd3c394a
VZ
514
515 // +1 for terminating NUL
516 wxString result;
c34924f7 517 ListBox_GetText(GetHwnd(), N, (wxChar*)wxStringBuffer(result, len + 1));
dd3c394a
VZ
518
519 return result;
2bda0e17
KB
520}
521
2ee3ee1b
VZ
522void
523wxListBox::DoInsertItems(const wxArrayString& items, int pos)
524{
525 wxCHECK_RET( pos >= 0 && pos <= m_noItems,
526 wxT("invalid index in wxListBox::InsertItems") );
527
528 int nItems = items.GetCount();
529 for ( int i = 0; i < nItems; i++ )
fd7ab28c
VZ
530 {
531 int idx = ListBox_InsertString(GetHwnd(), i + pos, items[i]);
532
533#if wxUSE_OWNER_DRAWN
9085d634
RD
534 if ( m_windowStyle & wxLB_OWNERDRAW )
535 {
2b5f62a0 536 wxOwnerDrawn *pNewItem = CreateLboxItem(idx);
9085d634
RD
537 pNewItem->SetName(items[i]);
538 pNewItem->SetFont(GetFont());
539 m_aItems.Insert(pNewItem, idx);
fd7ab28c 540
9085d634
RD
541 ListBox_SetItemData(GetHwnd(), idx, pNewItem);
542 }
665b71b1
WS
543#else
544 wxUnusedVar(idx);
fd7ab28c
VZ
545#endif // wxUSE_OWNER_DRAWN
546 }
547
2ee3ee1b
VZ
548 m_noItems += nItems;
549
550 SetHorizontalExtent();
31582e4e
RD
551
552 InvalidateBestSize();
2ee3ee1b
VZ
553}
554
555void wxListBox::SetString(int N, const wxString& s)
556{
557 wxCHECK_RET( N >= 0 && N < m_noItems,
558 wxT("invalid index in wxListBox::SetString") );
559
560 // remember the state of the item
561 bool wasSelected = IsSelected(N);
562
563 void *oldData = NULL;
564 wxClientData *oldObjData = NULL;
1e6feb95 565 if ( m_clientDataItemsType == wxClientData_Void )
2ee3ee1b 566 oldData = GetClientData(N);
1e6feb95 567 else if ( m_clientDataItemsType == wxClientData_Object )
2ee3ee1b
VZ
568 oldObjData = GetClientObject(N);
569
570 // delete and recreate it
571 SendMessage(GetHwnd(), LB_DELETESTRING, N, 0);
572
573 int newN = N;
574 if ( N == m_noItems - 1 )
575 newN = -1;
576
577 ListBox_InsertString(GetHwnd(), newN, s);
578
579 // restore the client data
580 if ( oldData )
581 SetClientData(N, oldData);
582 else if ( oldObjData )
583 SetClientObject(N, oldObjData);
584
2ee3ee1b
VZ
585#if wxUSE_OWNER_DRAWN
586 if ( m_windowStyle & wxLB_OWNERDRAW )
c294f450 587 {
2ee3ee1b
VZ
588 // update item's text
589 m_aItems[N]->SetName(s);
fd7ab28c 590
c294f450
RD
591 // reassign the item's data
592 ListBox_SetItemData(GetHwnd(), N, m_aItems[N]);
593 }
2ee3ee1b 594#endif //USE_OWNER_DRAWN
781bdbb4
JS
595
596 // we may have lost the selection
597 if ( wasSelected )
598 Select(N);
31582e4e
RD
599
600 InvalidateBestSize();
2ee3ee1b
VZ
601}
602
603int wxListBox::GetCount() const
604{
605 return m_noItems;
606}
607
608// ----------------------------------------------------------------------------
609// helpers
610// ----------------------------------------------------------------------------
611
4438caf4
VZ
612// Windows-specific code to set the horizontal extent of the listbox, if
613// necessary. If s is non-NULL, it's used to calculate the horizontal extent.
2bda0e17
KB
614// Otherwise, all strings are used.
615void wxListBox::SetHorizontalExtent(const wxString& s)
616{
dd3c394a
VZ
617 // Only necessary if we want a horizontal scrollbar
618 if (!(m_windowStyle & wxHSCROLL))
619 return;
620 TEXTMETRIC lpTextMetric;
621
c34924f7 622 if ( !s.empty() )
2bda0e17 623 {
a23fd0e1
VZ
624 int existingExtent = (int)SendMessage(GetHwnd(), LB_GETHORIZONTALEXTENT, 0, 0L);
625 HDC dc = GetWindowDC(GetHwnd());
dd3c394a 626 HFONT oldFont = 0;
6305fabe 627 if (GetFont().Ok() && GetFont().GetResourceHandle() != 0)
dd3c394a
VZ
628 oldFont = (HFONT) ::SelectObject(dc, (HFONT) GetFont().GetResourceHandle());
629
630 GetTextMetrics(dc, &lpTextMetric);
631 SIZE extentXY;
767b35a5 632 ::GetTextExtentPoint32(dc, (LPTSTR) (const wxChar *)s, s.Length(), &extentXY);
dd3c394a
VZ
633 int extentX = (int)(extentXY.cx + lpTextMetric.tmAveCharWidth);
634
635 if (oldFont)
636 ::SelectObject(dc, oldFont);
637
a23fd0e1 638 ReleaseDC(GetHwnd(), dc);
dd3c394a 639 if (extentX > existingExtent)
a23fd0e1 640 SendMessage(GetHwnd(), LB_SETHORIZONTALEXTENT, LOWORD(extentX), 0L);
dd3c394a
VZ
641 }
642 else
643 {
644 int largestExtent = 0;
a23fd0e1 645 HDC dc = GetWindowDC(GetHwnd());
dd3c394a 646 HFONT oldFont = 0;
6305fabe 647 if (GetFont().Ok() && GetFont().GetResourceHandle() != 0)
dd3c394a
VZ
648 oldFont = (HFONT) ::SelectObject(dc, (HFONT) GetFont().GetResourceHandle());
649
650 GetTextMetrics(dc, &lpTextMetric);
3e3be693 651
3e3be693 652 for (int i = 0; i < m_noItems; i++)
dd3c394a 653 {
50c6bf91 654 wxString str = GetString(i);
dd3c394a 655 SIZE extentXY;
767b35a5 656 ::GetTextExtentPoint32(dc, str.c_str(), str.length(), &extentXY);
dd3c394a
VZ
657 int extentX = (int)(extentXY.cx + lpTextMetric.tmAveCharWidth);
658 if (extentX > largestExtent)
659 largestExtent = extentX;
660 }
661 if (oldFont)
662 ::SelectObject(dc, oldFont);
663
a23fd0e1
VZ
664 ReleaseDC(GetHwnd(), dc);
665 SendMessage(GetHwnd(), LB_SETHORIZONTALEXTENT, LOWORD(largestExtent), 0L);
2bda0e17 666 }
2bda0e17
KB
667}
668
f68586e5 669wxSize wxListBox::DoGetBestSize() const
b908d224
VZ
670{
671 // find the widest string
672 int wLine;
673 int wListbox = 0;
674 for ( int i = 0; i < m_noItems; i++ )
675 {
676 wxString str(GetString(i));
677 GetTextExtent(str, &wLine, NULL);
678 if ( wLine > wListbox )
679 wListbox = wLine;
680 }
681
682 // give it some reasonable default value if there are no strings in the
683 // list
684 if ( wListbox == 0 )
685 wListbox = 100;
686
687 // the listbox should be slightly larger than the widest string
688 int cx, cy;
7a5e53ab 689 wxGetCharSize(GetHWND(), &cx, &cy, GetFont());
b908d224
VZ
690
691 wListbox += 3*cx;
692
908f91bc
RD
693 // Add room for the scrollbar
694 wListbox += wxSystemSettings::GetMetric(wxSYS_VSCROLL_X);
695
5b6d6b70
VZ
696 // don't make the listbox too tall (limit height to 10 items) but don't
697 // make it too small neither
698 int hListbox = EDIT_HEIGHT_FROM_CHAR_HEIGHT(cy)*
699 wxMin(wxMax(m_noItems, 3), 10);
b908d224 700
31582e4e
RD
701 wxSize best(wListbox, hListbox);
702 CacheBestSize(best);
703 return best;
b908d224
VZ
704}
705
2ee3ee1b
VZ
706// ----------------------------------------------------------------------------
707// callbacks
708// ----------------------------------------------------------------------------
709
710bool wxListBox::MSWCommand(WXUINT param, WXWORD WXUNUSED(id))
2bda0e17 711{
bada28f0 712 wxEventType evtType;
8ee9d618 713 if ( param == LBN_SELCHANGE )
2bda0e17 714 {
bada28f0 715 evtType = wxEVT_COMMAND_LISTBOX_SELECTED;
2bda0e17 716 }
8ee9d618 717 else if ( param == LBN_DBLCLK )
2ee3ee1b 718 {
bada28f0
VZ
719 evtType = wxEVT_COMMAND_LISTBOX_DOUBLECLICKED;
720 }
721 else
722 {
723 // some event we're not interested in
598ddd96 724 return false;
bada28f0
VZ
725 }
726
727 wxCommandEvent event(evtType, m_windowId);
728 event.SetEventObject( this );
8ee9d618 729
9c9c3d7a
VZ
730 // retrieve the affected item
731 int n = SendMessage(GetHwnd(), LB_GETCARETINDEX, 0, 0);
732 if ( n != LB_ERR )
bada28f0 733 {
bada28f0
VZ
734 if ( HasClientObjectData() )
735 event.SetClientObject( GetClientObject(n) );
736 else if ( HasClientUntypedData() )
737 event.SetClientData( GetClientData(n) );
9c9c3d7a 738
bada28f0 739 event.SetString( GetString(n) );
598ddd96 740 event.SetExtraLong( HasMultipleSelection() ? IsSelected(n) : true );
bada28f0
VZ
741 }
742
687706f5 743 event.SetInt(n);
2ee3ee1b 744
bada28f0 745 return GetEventHandler()->ProcessEvent(event);
2bda0e17
KB
746}
747
2ee3ee1b
VZ
748// ----------------------------------------------------------------------------
749// wxCheckListBox support
750// ----------------------------------------------------------------------------
2bda0e17 751
47d67540 752#if wxUSE_OWNER_DRAWN
2bda0e17
KB
753
754// drawing
755// -------
756
757// space beneath/above each row in pixels
758// "standard" checklistbox use 1 here, some might prefer 2. 0 is ugly.
759#define OWNER_DRAWN_LISTBOX_EXTRA_SPACE (1)
760
761// the height is the same for all items
dd3c394a
VZ
762// TODO should be changed for LBS_OWNERDRAWVARIABLE style listboxes
763
764// NB: can't forward this to wxListBoxItem because LB_SETITEMDATA
765// message is not yet sent when we get here!
2bda0e17
KB
766bool wxListBox::MSWOnMeasure(WXMEASUREITEMSTRUCT *item)
767{
dd3c394a 768 // only owner-drawn control should receive this message
598ddd96 769 wxCHECK( ((m_windowStyle & wxLB_OWNERDRAW) == wxLB_OWNERDRAW), false );
2bda0e17 770
dd3c394a 771 MEASUREITEMSTRUCT *pStruct = (MEASUREITEMSTRUCT *)item;
2bda0e17 772
4676948b
JS
773#ifdef __WXWINCE__
774 HDC hdc = GetDC(NULL);
775#else
07cf98cb 776 HDC hdc = CreateIC(wxT("DISPLAY"), NULL, NULL, 0);
4676948b 777#endif
07cf98cb 778
7d09b97f
VZ
779 {
780 wxDCTemp dc((WXHDC)hdc);
781 dc.SetFont(GetFont());
2bda0e17 782
7d09b97f
VZ
783 pStruct->itemHeight = dc.GetCharHeight() + 2*OWNER_DRAWN_LISTBOX_EXTRA_SPACE;
784 pStruct->itemWidth = dc.GetCharWidth();
785 }
07cf98cb 786
7d09b97f
VZ
787#ifdef __WXWINCE__
788 ReleaseDC(NULL, hdc);
789#else
07cf98cb 790 DeleteDC(hdc);
7d09b97f 791#endif
07cf98cb 792
598ddd96 793 return true;
2bda0e17
KB
794}
795
796// forward the message to the appropriate item
797bool wxListBox::MSWOnDraw(WXDRAWITEMSTRUCT *item)
798{
dd3c394a 799 // only owner-drawn control should receive this message
598ddd96 800 wxCHECK( ((m_windowStyle & wxLB_OWNERDRAW) == wxLB_OWNERDRAW), false );
dd3c394a
VZ
801
802 DRAWITEMSTRUCT *pStruct = (DRAWITEMSTRUCT *)item;
f6bcfd97
BP
803 UINT itemID = pStruct->itemID;
804
805 // the item may be -1 for an empty listbox
806 if ( itemID == (UINT)-1 )
598ddd96 807 return false;
dd3c394a 808
a23fd0e1 809 long data = ListBox_GetItemData(GetHwnd(), pStruct->itemID);
2bda0e17 810
598ddd96 811 wxCHECK( data && (data != LB_ERR), false );
2bda0e17 812
dd3c394a 813 wxListBoxItem *pItem = (wxListBoxItem *)data;
2bda0e17 814
7561aacd 815 wxDCTemp dc((WXHDC)pStruct->hDC);
42841dfc
WS
816 wxPoint pt1(pStruct->rcItem.left, pStruct->rcItem.top);
817 wxPoint pt2(pStruct->rcItem.right, pStruct->rcItem.bottom);
818 wxRect rect(pt1, pt2);
2bda0e17 819
dd3c394a 820 return pItem->OnDrawItem(dc, rect,
7561aacd
VZ
821 (wxOwnerDrawn::wxODAction)pStruct->itemAction,
822 (wxOwnerDrawn::wxODStatus)pStruct->itemState);
2bda0e17
KB
823}
824
1e6feb95
VZ
825#endif // wxUSE_OWNER_DRAWN
826
827#endif // wxUSE_LISTBOX