1 ///////////////////////////////////////////////////////////////////////////////
2 // Name: src/msw/listbox.cpp
4 // Author: Julian Smart
5 // Modified by: Vadim Zeitlin (owner drawn stuff)
8 // Copyright: (c) Julian Smart
9 // Licence: wxWindows licence
10 ///////////////////////////////////////////////////////////////////////////////
13 #pragma implementation "listbox.h"
16 // For compilers that support precompilation, includes "wx.h".
17 #include "wx/wxprec.h"
26 #include "wx/listbox.h"
27 #include "wx/settings.h"
34 #include "wx/window.h"
35 #include "wx/msw/private.h"
39 #include "wx/dynarray.h"
43 #include "wx/ownerdrw.h"
46 #ifdef __GNUWIN32_OLD__
47 #include "wx/msw/gnuwin32/extra.h"
50 IMPLEMENT_DYNAMIC_CLASS(wxListBox
, wxControl
)
52 // ============================================================================
53 // list box item declaration and implementation
54 // ============================================================================
58 class wxListBoxItem
: public wxOwnerDrawn
61 wxListBoxItem(const wxString
& str
= wxEmptyString
);
64 wxListBoxItem::wxListBoxItem(const wxString
& str
) : wxOwnerDrawn(str
, FALSE
)
66 // no bitmaps/checkmarks
70 wxOwnerDrawn
*wxListBox::CreateLboxItem(size_t WXUNUSED(n
))
72 return new wxListBoxItem();
75 #endif //USE_OWNER_DRAWN
77 // ============================================================================
78 // list box control implementation
79 // ============================================================================
81 // ----------------------------------------------------------------------------
83 // ----------------------------------------------------------------------------
86 wxListBox::wxListBox()
92 bool wxListBox::Create(wxWindow
*parent
,
96 int n
, const wxString choices
[],
98 const wxValidator
& validator
,
107 SetValidator(validator
);
108 #endif // wxUSE_VALIDATORS
111 parent
->AddChild(this);
113 SetBackgroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOW
));
114 SetForegroundColour(parent
->GetForegroundColour());
116 m_windowId
= ( id
== -1 ) ? (int)NewControlId() : id
;
122 m_windowStyle
= style
;
124 DWORD wstyle
= WS_VISIBLE
| WS_CHILD
| WS_VSCROLL
| WS_TABSTOP
|
125 LBS_NOTIFY
| LBS_HASSTRINGS
;
127 wxASSERT_MSG( !(style
& wxLB_MULTIPLE
) || !(style
& wxLB_EXTENDED
),
128 _T("only one of listbox selection modes can be specified") );
130 if ( (m_windowStyle
& wxBORDER_MASK
) == wxBORDER_DEFAULT
)
131 m_windowStyle
|= wxBORDER_SUNKEN
;
133 if ( m_windowStyle
& wxCLIP_SIBLINGS
)
134 wstyle
|= WS_CLIPSIBLINGS
;
136 if (m_windowStyle
& wxLB_MULTIPLE
)
137 wstyle
|= LBS_MULTIPLESEL
;
138 else if (m_windowStyle
& wxLB_EXTENDED
)
139 wstyle
|= LBS_EXTENDEDSEL
;
141 if (m_windowStyle
& wxLB_ALWAYS_SB
)
142 wstyle
|= LBS_DISABLENOSCROLL
;
143 if (m_windowStyle
& wxLB_HSCROLL
)
144 wstyle
|= WS_HSCROLL
;
145 if (m_windowStyle
& wxLB_SORT
)
148 #if wxUSE_OWNER_DRAWN
149 if ( m_windowStyle
& wxLB_OWNERDRAW
) {
150 // we don't support LBS_OWNERDRAWVARIABLE yet
151 wstyle
|= LBS_OWNERDRAWFIXED
;
155 // Without this style, you get unexpected heights, so e.g. constraint layout
156 // doesn't work properly
157 wstyle
|= LBS_NOINTEGRALHEIGHT
;
160 (void) MSWGetStyle(m_windowStyle
, & exStyle
) ;
162 m_hWnd
= (WXHWND
)::CreateWindowEx(exStyle
, wxT("LISTBOX"), NULL
,
165 (HWND
)parent
->GetHWND(), (HMENU
)m_windowId
,
166 wxGetInstance(), NULL
);
168 wxCHECK_MSG( m_hWnd
, FALSE
, wxT("Failed to create listbox") );
170 // Subclass again to catch messages
174 for (ui
= 0; ui
< (size_t)n
; ui
++) {
178 if ( (m_windowStyle
& wxLB_MULTIPLE
) == 0 )
179 SendMessage(GetHwnd(), LB_SETCURSEL
, 0, 0);
181 SetFont(parent
->GetFont());
183 SetSize(x
, y
, width
, height
);
188 wxListBox::~wxListBox()
193 void wxListBox::SetupColours()
195 SetBackgroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOW
));
196 SetForegroundColour(GetParent()->GetForegroundColour());
199 // ----------------------------------------------------------------------------
200 // implementation of wxListBoxBase methods
201 // ----------------------------------------------------------------------------
203 void wxListBox::DoSetFirstItem(int N
)
205 wxCHECK_RET( N
>= 0 && N
< m_noItems
,
206 wxT("invalid index in wxListBox::SetFirstItem") );
208 SendMessage(GetHwnd(), LB_SETTOPINDEX
, (WPARAM
)N
, (LPARAM
)0);
211 void wxListBox::Delete(int N
)
213 wxCHECK_RET( N
>= 0 && N
< m_noItems
,
214 wxT("invalid index in wxListBox::Delete") );
216 // for owner drawn objects, the data is used for storing wxOwnerDrawn
217 // pointers and we shouldn't touch it
218 #if !wxUSE_OWNER_DRAWN
219 if ( !(m_windowStyle
& wxLB_OWNERDRAW
) )
220 #endif // !wxUSE_OWNER_DRAWN
221 if ( HasClientObjectData() )
223 delete GetClientObject(N
);
226 SendMessage(GetHwnd(), LB_DELETESTRING
, N
, 0);
229 SetHorizontalExtent(wxEmptyString
);
232 int wxListBox::DoAppend(const wxString
& item
)
234 int index
= ListBox_AddString(GetHwnd(), item
);
237 #if wxUSE_OWNER_DRAWN
238 if ( m_windowStyle
& wxLB_OWNERDRAW
) {
239 wxOwnerDrawn
*pNewItem
= CreateLboxItem(index
); // dummy argument
240 pNewItem
->SetName(item
);
241 m_aItems
.Insert(pNewItem
, index
);
242 ListBox_SetItemData(GetHwnd(), index
, pNewItem
);
243 pNewItem
->SetFont(GetFont());
245 #endif // wxUSE_OWNER_DRAWN
247 SetHorizontalExtent(item
);
252 void wxListBox::DoSetItems(const wxArrayString
& choices
, void** clientData
)
254 // avoid flicker - but don't need to do this for a hidden listbox
255 bool hideAndShow
= IsShown();
258 ShowWindow(GetHwnd(), SW_HIDE
);
261 ListBox_ResetContent(GetHwnd());
263 m_noItems
= choices
.GetCount();
265 for (i
= 0; i
< m_noItems
; i
++)
267 ListBox_AddString(GetHwnd(), choices
[i
]);
270 SetClientData(i
, clientData
[i
]);
274 #if wxUSE_OWNER_DRAWN
275 if ( m_windowStyle
& wxLB_OWNERDRAW
) {
276 // first delete old items
277 WX_CLEAR_ARRAY(m_aItems
);
279 // then create new ones
280 for ( size_t ui
= 0; ui
< (size_t)m_noItems
; ui
++ ) {
281 wxOwnerDrawn
*pNewItem
= CreateLboxItem(ui
);
282 pNewItem
->SetName(choices
[ui
]);
283 m_aItems
.Add(pNewItem
);
284 ListBox_SetItemData(GetHwnd(), ui
, pNewItem
);
287 #endif // wxUSE_OWNER_DRAWN
289 SetHorizontalExtent();
293 // show the listbox back if we hid it
294 ShowWindow(GetHwnd(), SW_SHOW
);
298 int wxListBox::FindString(const wxString
& s
) const
300 int pos
= ListBox_FindStringExact(GetHwnd(), (WPARAM
)-1, s
);
307 void wxListBox::Clear()
311 ListBox_ResetContent(GetHwnd());
314 SetHorizontalExtent();
317 void wxListBox::Free()
319 #if wxUSE_OWNER_DRAWN
320 if ( m_windowStyle
& wxLB_OWNERDRAW
)
322 WX_CLEAR_ARRAY(m_aItems
);
325 #endif // wxUSE_OWNER_DRAWN
326 if ( HasClientObjectData() )
328 for ( size_t n
= 0; n
< (size_t)m_noItems
; n
++ )
330 delete GetClientObject(n
);
335 void wxListBox::SetSelection(int N
, bool select
)
337 wxCHECK_RET( N
>= 0 && N
< m_noItems
,
338 wxT("invalid index in wxListBox::SetSelection") );
340 if ( HasMultipleSelection() )
342 SendMessage(GetHwnd(), LB_SETSEL
, select
, N
);
346 SendMessage(GetHwnd(), LB_SETCURSEL
, select
? N
: -1, 0);
350 bool wxListBox::IsSelected(int N
) const
352 wxCHECK_MSG( N
>= 0 && N
< m_noItems
, FALSE
,
353 wxT("invalid index in wxListBox::Selected") );
355 return SendMessage(GetHwnd(), LB_GETSEL
, N
, 0) == 0 ? FALSE
: TRUE
;
358 wxClientData
* wxListBox::DoGetItemClientObject(int n
) const
360 return (wxClientData
*)DoGetItemClientData(n
);
363 void *wxListBox::DoGetItemClientData(int n
) const
365 wxCHECK_MSG( n
>= 0 && n
< m_noItems
, NULL
,
366 wxT("invalid index in wxListBox::GetClientData") );
368 return (void *)SendMessage(GetHwnd(), LB_GETITEMDATA
, n
, 0);
371 void wxListBox::DoSetItemClientObject(int n
, wxClientData
* clientData
)
373 DoSetItemClientData(n
, clientData
);
376 void wxListBox::DoSetItemClientData(int n
, void *clientData
)
378 wxCHECK_RET( n
>= 0 && n
< m_noItems
,
379 wxT("invalid index in wxListBox::SetClientData") );
381 #if wxUSE_OWNER_DRAWN
382 if ( m_windowStyle
& wxLB_OWNERDRAW
)
384 // client data must be pointer to wxOwnerDrawn, otherwise we would crash
385 // in OnMeasure/OnDraw.
386 wxFAIL_MSG(wxT("Can't use client data with owner-drawn listboxes"));
388 #endif // wxUSE_OWNER_DRAWN
390 if ( ListBox_SetItemData(GetHwnd(), n
, clientData
) == LB_ERR
)
391 wxLogDebug(wxT("LB_SETITEMDATA failed"));
394 // Return number of selections and an array of selected integers
395 int wxListBox::GetSelections(wxArrayInt
& aSelections
) const
399 if ( HasMultipleSelection() )
401 int countSel
= ListBox_GetSelCount(GetHwnd());
402 if ( countSel
== LB_ERR
)
404 wxLogDebug(_T("ListBox_GetSelCount failed"));
406 else if ( countSel
!= 0 )
408 int *selections
= new int[countSel
];
410 if ( ListBox_GetSelItems(GetHwnd(),
411 countSel
, selections
) == LB_ERR
)
413 wxLogDebug(wxT("ListBox_GetSelItems failed"));
418 aSelections
.Alloc(countSel
);
419 for ( int n
= 0; n
< countSel
; n
++ )
420 aSelections
.Add(selections
[n
]);
423 delete [] selections
;
428 else // single-selection listbox
430 if (ListBox_GetCurSel(GetHwnd()) > -1)
431 aSelections
.Add(ListBox_GetCurSel(GetHwnd()));
433 return aSelections
.Count();
437 // Get single selection, for single choice list items
438 int wxListBox::GetSelection() const
440 wxCHECK_MSG( !HasMultipleSelection(),
442 wxT("GetSelection() can't be used with multiple-selection listboxes, use GetSelections() instead.") );
444 return ListBox_GetCurSel(GetHwnd());
447 // Find string for position
448 wxString
wxListBox::GetString(int N
) const
450 wxCHECK_MSG( N
>= 0 && N
< m_noItems
, wxEmptyString
,
451 wxT("invalid index in wxListBox::GetClientData") );
453 int len
= ListBox_GetTextLen(GetHwnd(), N
);
455 // +1 for terminating NUL
457 ListBox_GetText(GetHwnd(), N
, result
.GetWriteBuf(len
+ 1));
458 result
.UngetWriteBuf();
464 wxListBox::DoInsertItems(const wxArrayString
& items
, int pos
)
466 wxCHECK_RET( pos
>= 0 && pos
<= m_noItems
,
467 wxT("invalid index in wxListBox::InsertItems") );
469 int nItems
= items
.GetCount();
470 for ( int i
= 0; i
< nItems
; i
++ )
472 int idx
= ListBox_InsertString(GetHwnd(), i
+ pos
, items
[i
]);
474 #if wxUSE_OWNER_DRAWN
475 if ( m_windowStyle
& wxLB_OWNERDRAW
)
477 wxOwnerDrawn
*pNewItem
= CreateLboxItem(idx
);
478 pNewItem
->SetName(items
[i
]);
479 pNewItem
->SetFont(GetFont());
480 m_aItems
.Insert(pNewItem
, idx
);
482 ListBox_SetItemData(GetHwnd(), idx
, pNewItem
);
484 #endif // wxUSE_OWNER_DRAWN
489 SetHorizontalExtent();
492 void wxListBox::SetString(int N
, const wxString
& s
)
494 wxCHECK_RET( N
>= 0 && N
< m_noItems
,
495 wxT("invalid index in wxListBox::SetString") );
497 // remember the state of the item
498 bool wasSelected
= IsSelected(N
);
500 void *oldData
= NULL
;
501 wxClientData
*oldObjData
= NULL
;
502 if ( m_clientDataItemsType
== wxClientData_Void
)
503 oldData
= GetClientData(N
);
504 else if ( m_clientDataItemsType
== wxClientData_Object
)
505 oldObjData
= GetClientObject(N
);
507 // delete and recreate it
508 SendMessage(GetHwnd(), LB_DELETESTRING
, N
, 0);
511 if ( N
== m_noItems
- 1 )
514 ListBox_InsertString(GetHwnd(), newN
, s
);
516 // restore the client data
518 SetClientData(N
, oldData
);
519 else if ( oldObjData
)
520 SetClientObject(N
, oldObjData
);
522 // we may have lost the selection
526 #if wxUSE_OWNER_DRAWN
527 if ( m_windowStyle
& wxLB_OWNERDRAW
)
529 // update item's text
530 m_aItems
[N
]->SetName(s
);
532 // reassign the item's data
533 ListBox_SetItemData(GetHwnd(), N
, m_aItems
[N
]);
535 #endif //USE_OWNER_DRAWN
538 int wxListBox::GetCount() const
543 // ----------------------------------------------------------------------------
545 // ----------------------------------------------------------------------------
547 // Windows-specific code to set the horizontal extent of the listbox, if
548 // necessary. If s is non-NULL, it's used to calculate the horizontal extent.
549 // Otherwise, all strings are used.
550 void wxListBox::SetHorizontalExtent(const wxString
& s
)
552 // Only necessary if we want a horizontal scrollbar
553 if (!(m_windowStyle
& wxHSCROLL
))
555 TEXTMETRIC lpTextMetric
;
559 int existingExtent
= (int)SendMessage(GetHwnd(), LB_GETHORIZONTALEXTENT
, 0, 0L);
560 HDC dc
= GetWindowDC(GetHwnd());
562 if (GetFont().Ok() && GetFont().GetResourceHandle())
563 oldFont
= (HFONT
) ::SelectObject(dc
, (HFONT
) GetFont().GetResourceHandle());
565 GetTextMetrics(dc
, &lpTextMetric
);
567 ::GetTextExtentPoint(dc
, (LPTSTR
) (const wxChar
*)s
, s
.Length(), &extentXY
);
568 int extentX
= (int)(extentXY
.cx
+ lpTextMetric
.tmAveCharWidth
);
571 ::SelectObject(dc
, oldFont
);
573 ReleaseDC(GetHwnd(), dc
);
574 if (extentX
> existingExtent
)
575 SendMessage(GetHwnd(), LB_SETHORIZONTALEXTENT
, LOWORD(extentX
), 0L);
579 int largestExtent
= 0;
580 HDC dc
= GetWindowDC(GetHwnd());
582 if (GetFont().Ok() && GetFont().GetResourceHandle())
583 oldFont
= (HFONT
) ::SelectObject(dc
, (HFONT
) GetFont().GetResourceHandle());
585 GetTextMetrics(dc
, &lpTextMetric
);
587 for (i
= 0; i
< m_noItems
; i
++)
589 int len
= (int)SendMessage(GetHwnd(), LB_GETTEXT
, i
, (LONG
)wxBuffer
);
592 ::GetTextExtentPoint(dc
, (LPTSTR
)wxBuffer
, len
, &extentXY
);
593 int extentX
= (int)(extentXY
.cx
+ lpTextMetric
.tmAveCharWidth
);
594 if (extentX
> largestExtent
)
595 largestExtent
= extentX
;
598 ::SelectObject(dc
, oldFont
);
600 ReleaseDC(GetHwnd(), dc
);
601 SendMessage(GetHwnd(), LB_SETHORIZONTALEXTENT
, LOWORD(largestExtent
), 0L);
605 wxSize
wxListBox::DoGetBestSize() const
607 // find the widest string
610 for ( int i
= 0; i
< m_noItems
; i
++ )
612 wxString
str(GetString(i
));
613 GetTextExtent(str
, &wLine
, NULL
);
614 if ( wLine
> wListbox
)
618 // give it some reasonable default value if there are no strings in the
623 // the listbox should be slightly larger than the widest string
625 wxGetCharSize(GetHWND(), &cx
, &cy
, &GetFont());
629 // don't make the listbox too tall (limit height to 10 items) but don't
630 // make it too small neither
631 int hListbox
= EDIT_HEIGHT_FROM_CHAR_HEIGHT(cy
)*
632 wxMin(wxMax(m_noItems
, 3), 10);
634 return wxSize(wListbox
, hListbox
);
637 // ----------------------------------------------------------------------------
639 // ----------------------------------------------------------------------------
641 bool wxListBox::MSWCommand(WXUINT param
, WXWORD
WXUNUSED(id
))
644 if ( param
== LBN_SELCHANGE
)
646 evtType
= wxEVT_COMMAND_LISTBOX_SELECTED
;
648 else if ( param
== LBN_DBLCLK
)
650 evtType
= wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
;
654 // some event we're not interested in
658 wxCommandEvent
event(evtType
, m_windowId
);
659 event
.SetEventObject( this );
661 // retrieve the affected item
662 int n
= SendMessage(GetHwnd(), LB_GETCARETINDEX
, 0, 0);
665 if ( HasClientObjectData() )
666 event
.SetClientObject( GetClientObject(n
) );
667 else if ( HasClientUntypedData() )
668 event
.SetClientData( GetClientData(n
) );
670 event
.SetString( GetString(n
) );
671 event
.SetExtraLong( HasMultipleSelection() ? IsSelected(n
) : TRUE
);
674 event
.m_commandInt
= n
;
676 return GetEventHandler()->ProcessEvent(event
);
679 // ----------------------------------------------------------------------------
680 // wxCheckListBox support
681 // ----------------------------------------------------------------------------
683 #if wxUSE_OWNER_DRAWN
688 // space beneath/above each row in pixels
689 // "standard" checklistbox use 1 here, some might prefer 2. 0 is ugly.
690 #define OWNER_DRAWN_LISTBOX_EXTRA_SPACE (1)
692 // the height is the same for all items
693 // TODO should be changed for LBS_OWNERDRAWVARIABLE style listboxes
695 // NB: can't forward this to wxListBoxItem because LB_SETITEMDATA
696 // message is not yet sent when we get here!
697 bool wxListBox::MSWOnMeasure(WXMEASUREITEMSTRUCT
*item
)
699 // only owner-drawn control should receive this message
700 wxCHECK( ((m_windowStyle
& wxLB_OWNERDRAW
) == wxLB_OWNERDRAW
), FALSE
);
702 MEASUREITEMSTRUCT
*pStruct
= (MEASUREITEMSTRUCT
*)item
;
704 HDC hdc
= CreateIC(wxT("DISPLAY"), NULL
, NULL
, 0);
707 dc
.SetHDC((WXHDC
)hdc
);
708 dc
.SetFont(wxSystemSettings::GetFont(wxSYS_ANSI_VAR_FONT
));
710 pStruct
->itemHeight
= dc
.GetCharHeight() + 2*OWNER_DRAWN_LISTBOX_EXTRA_SPACE
;
711 pStruct
->itemWidth
= dc
.GetCharWidth();
720 // forward the message to the appropriate item
721 bool wxListBox::MSWOnDraw(WXDRAWITEMSTRUCT
*item
)
723 // only owner-drawn control should receive this message
724 wxCHECK( ((m_windowStyle
& wxLB_OWNERDRAW
) == wxLB_OWNERDRAW
), FALSE
);
726 DRAWITEMSTRUCT
*pStruct
= (DRAWITEMSTRUCT
*)item
;
727 UINT itemID
= pStruct
->itemID
;
729 // the item may be -1 for an empty listbox
730 if ( itemID
== (UINT
)-1 )
733 long data
= ListBox_GetItemData(GetHwnd(), pStruct
->itemID
);
735 wxCHECK( data
&& (data
!= LB_ERR
), FALSE
);
737 wxListBoxItem
*pItem
= (wxListBoxItem
*)data
;
739 wxDCTemp
dc((WXHDC
)pStruct
->hDC
);
740 wxRect
rect(wxPoint(pStruct
->rcItem
.left
, pStruct
->rcItem
.top
),
741 wxPoint(pStruct
->rcItem
.right
, pStruct
->rcItem
.bottom
));
743 return pItem
->OnDrawItem(dc
, rect
,
744 (wxOwnerDrawn::wxODAction
)pStruct
->itemAction
,
745 (wxOwnerDrawn::wxODStatus
)pStruct
->itemState
);
748 #endif // wxUSE_OWNER_DRAWN
750 #endif // wxUSE_LISTBOX