1 ///////////////////////////////////////////////////////////////////////////////
4 // Author: Julian Smart
5 // Modified by: Vadim Zeitlin (owner drawn stuff)
8 // Copyright: (c) Julian Smart
9 // Licence: wxWindows license
10 ///////////////////////////////////////////////////////////////////////////////
13 #pragma implementation "listbox.h"
16 // For compilers that support precompilation, includes "wx.h".
17 #include "wx/wxprec.h"
23 #include "wx/window.h"
24 #include "wx/msw/private.h"
27 #include "wx/listbox.h"
28 #include "wx/settings.h"
38 #if defined(GetWindowStyle)
43 #include "wx/dynarray.h"
47 #include "wx/ownerdrw.h"
51 #if defined(__GNUWIN32__)
52 #ifndef wxUSE_NORLANDER_HEADERS
53 #include <wx/msw/gnuwin32/extra.h>
59 #ifndef ListBox_SetItemData
60 #define ListBox_SetItemData(hwndCtl, index, data) \
61 ((int)(DWORD)SendMessage((hwndCtl), LB_SETITEMDATA, (WPARAM)(int)(index), (LPARAM)(data)))
63 #ifndef ListBox_GetHorizontalExtent
64 #define ListBox_GetHorizontalExtent(hwndCtl) \
65 ((int)(DWORD)SendMessage((hwndCtl), LB_GETHORIZONTALEXTENT, 0L, 0L))
67 #ifndef ListBox_GetSelCount
68 #define ListBox_GetSelCount(hwndCtl) \
69 ((int)(DWORD)SendMessage((hwndCtl), LB_GETSELCOUNT, 0L, 0L))
71 #ifndef ListBox_GetSelItems
72 #define ListBox_GetSelItems(hwndCtl, cItems, lpItems) \
73 ((int)(DWORD)SendMessage((hwndCtl), LB_GETSELITEMS, (WPARAM)(int)(cItems), (LPARAM)(int *)(lpItems)))
75 #ifndef ListBox_GetTextLen
76 #define ListBox_GetTextLen(hwndCtl, index) \
77 ((int)(DWORD)SendMessage((hwndCtl), LB_GETTEXTLEN, (WPARAM)(int)(index), 0L))
79 #ifndef ListBox_GetText
80 #define ListBox_GetText(hwndCtl, index, lpszBuffer) \
81 ((int)(DWORD)SendMessage((hwndCtl), LB_GETTEXT, (WPARAM)(int)(index), (LPARAM)(LPCTSTR)(lpszBuffer)))
85 #if !USE_SHARED_LIBRARY
86 IMPLEMENT_DYNAMIC_CLASS(wxListBox
, wxControl
)
89 // ============================================================================
90 // list box item declaration and implementation
91 // ============================================================================
95 class wxListBoxItem
: public wxOwnerDrawn
98 wxListBoxItem(const wxString
& str
= "");
101 wxListBoxItem
::wxListBoxItem(const wxString
& str
) : wxOwnerDrawn(str
, FALSE
)
103 // no bitmaps/checkmarks
107 wxOwnerDrawn
*wxListBox
::CreateItem(size_t n
)
109 return new wxListBoxItem();
112 #endif //USE_OWNER_DRAWN
114 // ============================================================================
115 // list box control implementation
116 // ============================================================================
118 // ----------------------------------------------------------------------------
120 // ----------------------------------------------------------------------------
123 wxListBox
::wxListBox()
129 bool wxListBox
::Create(wxWindow
*parent
,
133 int n
, const wxString choices
[],
135 const wxValidator
& validator
,
136 const wxString
& name
)
143 SetValidator(validator
);
146 parent
->AddChild(this);
148 wxSystemSettings settings
;
149 SetBackgroundColour(settings
.GetSystemColour(wxSYS_COLOUR_WINDOW
));
150 SetForegroundColour(parent
->GetForegroundColour());
152 m_windowId
= ( id
== -1 ) ?
(int)NewControlId() : id
;
158 m_windowStyle
= style
;
160 DWORD wstyle
= WS_VISIBLE
| WS_VSCROLL
| WS_TABSTOP
|
161 LBS_NOTIFY
| LBS_HASSTRINGS
;
162 if (m_windowStyle
& wxLB_MULTIPLE
)
163 wstyle
|= LBS_MULTIPLESEL
;
164 else if (m_windowStyle
& wxLB_EXTENDED
)
165 wstyle
|= LBS_EXTENDEDSEL
;
167 if (m_windowStyle
& wxLB_ALWAYS_SB
)
168 wstyle
|= LBS_DISABLENOSCROLL
;
169 if (m_windowStyle
& wxLB_HSCROLL
)
170 wstyle
|= WS_HSCROLL
;
171 if (m_windowStyle
& wxLB_SORT
)
174 #if wxUSE_OWNER_DRAWN
175 if ( m_windowStyle
& wxLB_OWNERDRAW
) {
176 // we don't support LBS_OWNERDRAWVARIABLE yet
177 wstyle
|= LBS_OWNERDRAWFIXED
;
181 // Without this style, you get unexpected heights, so e.g. constraint layout
182 // doesn't work properly
183 wstyle
|= LBS_NOINTEGRALHEIGHT
;
186 WXDWORD exStyle
= Determine3DEffects(WS_EX_CLIENTEDGE
, &want3D
);
188 // Even with extended styles, need to combine with WS_BORDER for them to
190 if ( want3D
|| wxStyleHasBorder(m_windowStyle
) )
195 m_hWnd
= (WXHWND
)::CreateWindowEx(exStyle
, wxT("LISTBOX"), NULL
,
198 (HWND
)parent
->GetHWND(), (HMENU
)m_windowId
,
199 wxGetInstance(), NULL
);
201 wxCHECK_MSG( m_hWnd
, FALSE
, wxT("Failed to create listbox") );
206 Ctl3dSubclassCtl(GetHwnd());
211 // Subclass again to catch messages
215 for (ui
= 0; ui
< (size_t)n
; ui
++) {
219 if ( (m_windowStyle
& wxLB_MULTIPLE
) == 0 )
220 SendMessage(GetHwnd(), LB_SETCURSEL
, 0, 0);
222 SetFont(parent
->GetFont());
224 SetSize(x
, y
, width
, height
);
231 wxListBox
::~wxListBox()
236 void wxListBox
::SetupColours()
238 SetBackgroundColour(wxSystemSettings
::GetSystemColour(wxSYS_COLOUR_WINDOW
));
239 SetForegroundColour(GetParent()->GetForegroundColour());
242 // ----------------------------------------------------------------------------
243 // implementation of wxListBoxBase methods
244 // ----------------------------------------------------------------------------
246 void wxListBox
::DoSetFirstItem(int N
)
248 wxCHECK_RET( N
>= 0 && N
< m_noItems
,
249 wxT("invalid index in wxListBox::SetFirstItem") );
251 SendMessage(GetHwnd(), LB_SETTOPINDEX
, (WPARAM
)N
, (LPARAM
)0);
254 void wxListBox
::Delete(int N
)
256 wxCHECK_RET( N
>= 0 && N
< m_noItems
,
257 wxT("invalid index in wxListBox::Delete") );
259 #if wxUSE_OWNER_DRAWN
262 #else // !wxUSE_OWNER_DRAWN
263 if ( HasClientObjectData() )
265 delete GetClientObject(N
);
267 #endif // wxUSE_OWNER_DRAWN/!wxUSE_OWNER_DRAWN
269 SendMessage(GetHwnd(), LB_DELETESTRING
, N
, 0);
272 SetHorizontalExtent("");
275 int wxListBox
::DoAppend(const wxString
& item
)
277 int index
= ListBox_AddString(GetHwnd(), item
);
280 #if wxUSE_OWNER_DRAWN
281 if ( m_windowStyle
& wxLB_OWNERDRAW
) {
282 wxOwnerDrawn
*pNewItem
= CreateItem(index
); // dummy argument
283 pNewItem
->SetName(item
);
284 m_aItems
.Add(pNewItem
);
285 ListBox_SetItemData(GetHwnd(), index
, pNewItem
);
289 SetHorizontalExtent(item
);
294 void wxListBox
::DoSetItems(const wxArrayString
& choices
, void** clientData
)
296 ShowWindow(GetHwnd(), SW_HIDE
);
298 ListBox_ResetContent(GetHwnd());
300 m_noItems
= choices
.GetCount();
302 for (i
= 0; i
< m_noItems
; i
++)
304 ListBox_AddString(GetHwnd(), choices
[i
]);
307 #if wxUSE_OWNER_DRAWN
308 wxASSERT_MSG(clientData
[i
] == NULL
,
309 wxT("Can't use client data with owner-drawn listboxes"));
310 #else // !wxUSE_OWNER_DRAWN
311 ListBox_SetItemData(GetHwnd(), i
, clientData
[i
]);
312 #endif // wxUSE_OWNER_DRAWN/!wxUSE_OWNER_DRAWN
316 #if wxUSE_OWNER_DRAWN
317 if ( m_windowStyle
& wxLB_OWNERDRAW
) {
318 // first delete old items
319 size_t ui
= m_aItems
.Count();
320 while ( ui
-- != 0 ) {
325 // then create new ones
326 for ( ui
= 0; ui
< (size_t)m_noItems
; ui
++ ) {
327 wxOwnerDrawn
*pNewItem
= CreateItem(ui
);
328 pNewItem
->SetName(choices
[ui
]);
329 m_aItems
.Add(pNewItem
);
330 ListBox_SetItemData(GetHwnd(), ui
, pNewItem
);
333 #endif // wxUSE_OWNER_DRAWN
335 SetHorizontalExtent();
337 ShowWindow(GetHwnd(), SW_SHOW
);
340 int wxListBox
::FindString(const wxString
& s
) const
342 int pos
= ListBox_FindStringExact(GetHwnd(), (WPARAM
)-1, s
);
349 void wxListBox
::Clear()
353 ListBox_ResetContent(GetHwnd());
356 SetHorizontalExtent();
359 void wxListBox
::Free()
360 #if wxUSE_OWNER_DRAWN
361 size_t uiCount
= m_aItems
.Count();
362 while ( uiCount
-- != 0 ) {
363 delete m_aItems
[uiCount
];
367 #else // !wxUSE_OWNER_DRAWN
368 if ( HasClientObjectData() )
370 for ( size_t n
= 0; n
< (size_t)m_noItems
; n
++ )
372 delete GetClientObject(n
);
375 #endif // wxUSE_OWNER_DRAWN/!wxUSE_OWNER_DRAWN
378 void wxListBox
::SetSelection(int N
, bool select
)
380 wxCHECK_RET( N
>= 0 && N
< m_noItems
,
381 wxT("invalid index in wxListBox::SetSelection") );
383 if ( HasMultipleSelection() )
385 SendMessage(GetHwnd(), LB_SETSEL
, select
, N
);
389 SendMessage(GetHwnd(), LB_SETCURSEL
, select ? N
: -1, 0);
393 bool wxListBox
::IsSelected(int N
) const
395 wxCHECK_MSG( N
>= 0 && N
< m_noItems
, FALSE
,
396 wxT("invalid index in wxListBox::Selected") );
398 return SendMessage(GetHwnd(), LB_GETSEL
, N
, 0) == 0 ? FALSE
: TRUE
;
401 wxClientData
* wxListBox
::DoGetItemClientObject(int n
) const
403 return (wxClientData
*)DoGetItemClientData(n
);
406 void *wxListBox
::DoGetItemClientData(int n
) const
408 wxCHECK_MSG( n
>= 0 && n
< m_noItems
, NULL
,
409 wxT("invalid index in wxListBox::GetClientData") );
411 return (void *)SendMessage(GetHwnd(), LB_GETITEMDATA
, n
, 0);
414 void wxListBox
::DoSetItemClientObject(int n
, wxClientData
* clientData
)
416 DoSetItemClientData(n
, clientData
);
419 void wxListBox
::DoSetItemClientData(int n
, void *clientData
)
421 wxCHECK_RET( n
>= 0 && n
< m_noItems
,
422 wxT("invalid index in wxListBox::SetClientData") );
424 #if wxUSE_OWNER_DRAWN
425 if ( m_windowStyle
& wxLB_OWNERDRAW
)
427 // client data must be pointer to wxOwnerDrawn, otherwise we would crash
428 // in OnMeasure/OnDraw.
429 wxFAIL_MSG(wxT("Can't use client data with owner-drawn listboxes"));
431 #endif // wxUSE_OWNER_DRAWN
433 if ( ListBox_SetItemData(GetHwnd(), n
, clientData
) == LB_ERR
)
434 wxLogDebug(wxT("LB_SETITEMDATA failed"));
437 bool wxListBox
::HasMultipleSelection() const
439 return (m_windowStyle
& wxLB_MULTIPLE
) || (m_windowStyle
& wxLB_EXTENDED
);
442 // Return number of selections and an array of selected integers
443 int wxListBox
::GetSelections(wxArrayInt
& aSelections
) const
447 if ( HasMultipleSelection() )
449 int no_sel
= ListBox_GetSelCount(GetHwnd());
451 int *selections
= new int[no_sel
];
452 int rc
= ListBox_GetSelItems(GetHwnd(), no_sel
, selections
);
454 wxCHECK_MSG(rc
!= LB_ERR
, -1, wxT("ListBox_GetSelItems failed"));
456 aSelections
.Alloc(no_sel
);
457 for ( int n
= 0; n
< no_sel
; n
++ )
458 aSelections
.Add(selections
[n
]);
460 delete [] selections
;
465 else // single-selection listbox
467 aSelections
.Add(ListBox_GetCurSel(GetHwnd()));
473 // Get single selection, for single choice list items
474 int wxListBox
::GetSelection() const
476 wxCHECK_MSG( !HasMultipleSelection(),
478 wxT("GetSelection() can't be used with multiple-selection "
479 "listboxes, use GetSelections() instead.") );
481 return ListBox_GetCurSel(GetHwnd());
484 // Find string for position
485 wxString wxListBox
::GetString(int N
) const
487 wxCHECK_MSG( N
>= 0 && N
< m_noItems
, "",
488 wxT("invalid index in wxListBox::GetClientData") );
490 int len
= ListBox_GetTextLen(GetHwnd(), N
);
492 // +1 for terminating NUL
494 ListBox_GetText(GetHwnd(), N
, result
.GetWriteBuf(len
+ 1));
495 result
.UngetWriteBuf();
501 wxListBox
::DoInsertItems(const wxArrayString
& items
, int pos
)
503 wxCHECK_RET( pos
>= 0 && pos
<= m_noItems
,
504 wxT("invalid index in wxListBox::InsertItems") );
506 int nItems
= items
.GetCount();
507 for ( int i
= 0; i
< nItems
; i
++ )
508 ListBox_InsertString(GetHwnd(), i
+ pos
, items
[i
]);
511 SetHorizontalExtent();
514 void wxListBox
::SetString(int N
, const wxString
& s
)
516 wxCHECK_RET( N
>= 0 && N
< m_noItems
,
517 wxT("invalid index in wxListBox::SetString") );
519 // remember the state of the item
520 bool wasSelected
= IsSelected(N
);
522 void *oldData
= NULL
;
523 wxClientData
*oldObjData
= NULL
;
524 if ( m_clientDataItemsType
== ClientData_Void
)
525 oldData
= GetClientData(N
);
526 else if ( m_clientDataItemsType
== ClientData_Object
)
527 oldObjData
= GetClientObject(N
);
529 // delete and recreate it
530 SendMessage(GetHwnd(), LB_DELETESTRING
, N
, 0);
533 if ( N
== m_noItems
- 1 )
536 ListBox_InsertString(GetHwnd(), newN
, s
);
538 // restore the client data
540 SetClientData(N
, oldData
);
541 else if ( oldObjData
)
542 SetClientObject(N
, oldObjData
);
544 // we may have lost the selection
548 #if wxUSE_OWNER_DRAWN
549 if ( m_windowStyle
& wxLB_OWNERDRAW
)
550 // update item's text
551 m_aItems
[N
]->SetName(s
);
552 #endif //USE_OWNER_DRAWN
555 int wxListBox
::GetCount() const
560 // ----------------------------------------------------------------------------
562 // ----------------------------------------------------------------------------
564 // Windows-specific code to set the horizontal extent of the listbox, if
565 // necessary. If s is non-NULL, it's used to calculate the horizontal extent.
566 // Otherwise, all strings are used.
567 void wxListBox
::SetHorizontalExtent(const wxString
& s
)
569 // Only necessary if we want a horizontal scrollbar
570 if (!(m_windowStyle
& wxHSCROLL
))
572 TEXTMETRIC lpTextMetric
;
576 int existingExtent
= (int)SendMessage(GetHwnd(), LB_GETHORIZONTALEXTENT
, 0, 0L);
577 HDC dc
= GetWindowDC(GetHwnd());
579 if (GetFont().Ok() && GetFont().GetResourceHandle())
580 oldFont
= (HFONT
) ::SelectObject(dc
, (HFONT
) GetFont().GetResourceHandle());
582 GetTextMetrics(dc
, &lpTextMetric
);
584 ::GetTextExtentPoint(dc
, (LPTSTR
) (const wxChar
*)s
, s
.Length(), &extentXY
);
585 int extentX
= (int)(extentXY
.cx
+ lpTextMetric
.tmAveCharWidth
);
588 ::SelectObject(dc
, oldFont
);
590 ReleaseDC(GetHwnd(), dc
);
591 if (extentX
> existingExtent
)
592 SendMessage(GetHwnd(), LB_SETHORIZONTALEXTENT
, LOWORD(extentX
), 0L);
596 int largestExtent
= 0;
597 HDC dc
= GetWindowDC(GetHwnd());
599 if (GetFont().Ok() && GetFont().GetResourceHandle())
600 oldFont
= (HFONT
) ::SelectObject(dc
, (HFONT
) GetFont().GetResourceHandle());
602 GetTextMetrics(dc
, &lpTextMetric
);
604 for (i
= 0; i
< m_noItems
; i
++)
606 int len
= (int)SendMessage(GetHwnd(), LB_GETTEXT
, i
, (LONG
)wxBuffer
);
609 ::GetTextExtentPoint(dc
, (LPTSTR
)wxBuffer
, len
, &extentXY
);
610 int extentX
= (int)(extentXY
.cx
+ lpTextMetric
.tmAveCharWidth
);
611 if (extentX
> largestExtent
)
612 largestExtent
= extentX
;
615 ::SelectObject(dc
, oldFont
);
617 ReleaseDC(GetHwnd(), dc
);
618 SendMessage(GetHwnd(), LB_SETHORIZONTALEXTENT
, LOWORD(largestExtent
), 0L);
622 wxSize wxListBox
::DoGetBestSize()
624 // find the widest string
627 for ( int i
= 0; i
< m_noItems
; i
++ )
629 wxString
str(GetString(i
));
630 GetTextExtent(str
, &wLine
, NULL
);
631 if ( wLine
> wListbox
)
635 // give it some reasonable default value if there are no strings in the
640 // the listbox should be slightly larger than the widest string
642 wxGetCharSize(GetHWND(), &cx
, &cy
, &GetFont());
646 int hListbox
= EDIT_HEIGHT_FROM_CHAR_HEIGHT(cy
)*(wxMax(m_noItems
, 7));
648 return wxSize(wListbox
, hListbox
);
651 // ----------------------------------------------------------------------------
653 // ----------------------------------------------------------------------------
655 bool wxListBox
::MSWCommand(WXUINT param
, WXWORD
WXUNUSED(id
))
657 if ( param
== LBN_SELCHANGE
)
659 wxCommandEvent
event(wxEVT_COMMAND_LISTBOX_SELECTED
, m_windowId
);
660 event
.SetEventObject( this );
662 wxArrayInt aSelections
;
663 int n
, count
= GetSelections(aSelections
);
667 if ( HasClientObjectData() )
668 event
.SetClientObject( GetClientObject(n
) );
669 else if ( HasClientUntypedData() )
670 event
.SetClientData( GetClientData(n
) );
671 event
.SetString( GetString(n
) );
678 event
.m_commandInt
= n
;
680 return GetEventHandler()->ProcessEvent(event
);
682 else if ( param
== LBN_DBLCLK
)
684 wxCommandEvent
event(wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
, m_windowId
);
685 event
.SetEventObject( this );
687 return GetEventHandler()->ProcessEvent(event
);
694 WXHBRUSH wxListBox
::OnCtlColor(WXHDC pDC
, WXHWND pWnd
, WXUINT nCtlColor
,
695 WXUINT message
, WXWPARAM wParam
, WXLPARAM lParam
)
700 HBRUSH hbrush
= Ctl3dCtlColorEx(message
, wParam
, lParam
);
701 return (WXHBRUSH
) hbrush
;
705 if (GetParent()->GetTransparentBackground())
706 SetBkMode((HDC
) pDC
, TRANSPARENT
);
708 SetBkMode((HDC
) pDC
, OPAQUE
);
710 ::SetBkColor((HDC
) pDC
, RGB(GetBackgroundColour().Red(), GetBackgroundColour().Green(), GetBackgroundColour().Blue()));
711 ::SetTextColor((HDC
) pDC
, RGB(GetForegroundColour().Red(), GetForegroundColour().Green(), GetForegroundColour().Blue()));
713 wxBrush
*backgroundBrush
= wxTheBrushList
->FindOrCreateBrush(GetBackgroundColour(), wxSOLID
);
715 // Note that this will be cleaned up in wxApp::OnIdle, if backgroundBrush
716 // has a zero usage count.
717 backgroundBrush
->RealizeResource();
718 return (WXHBRUSH
) backgroundBrush
->GetResourceHandle();
721 // ----------------------------------------------------------------------------
722 // wxCheckListBox support
723 // ----------------------------------------------------------------------------
725 #if wxUSE_OWNER_DRAWN
730 // space beneath/above each row in pixels
731 // "standard" checklistbox use 1 here, some might prefer 2. 0 is ugly.
732 #define OWNER_DRAWN_LISTBOX_EXTRA_SPACE (1)
734 // the height is the same for all items
735 // TODO should be changed for LBS_OWNERDRAWVARIABLE style listboxes
737 // NB: can't forward this to wxListBoxItem because LB_SETITEMDATA
738 // message is not yet sent when we get here!
739 bool wxListBox
::MSWOnMeasure(WXMEASUREITEMSTRUCT
*item
)
741 // only owner-drawn control should receive this message
742 wxCHECK( ((m_windowStyle
& wxLB_OWNERDRAW
) == wxLB_OWNERDRAW
), FALSE
);
744 MEASUREITEMSTRUCT
*pStruct
= (MEASUREITEMSTRUCT
*)item
;
747 dc
.SetHDC((WXHDC
)CreateIC(wxT("DISPLAY"), NULL
, NULL
, 0));
748 dc
.SetFont(wxSystemSettings
::GetSystemFont(wxSYS_ANSI_VAR_FONT
));
750 pStruct
->itemHeight
= dc
.GetCharHeight() + 2*OWNER_DRAWN_LISTBOX_EXTRA_SPACE
;
751 pStruct
->itemWidth
= dc
.GetCharWidth();
756 // forward the message to the appropriate item
757 bool wxListBox
::MSWOnDraw(WXDRAWITEMSTRUCT
*item
)
759 // only owner-drawn control should receive this message
760 wxCHECK( ((m_windowStyle
& wxLB_OWNERDRAW
) == wxLB_OWNERDRAW
), FALSE
);
762 DRAWITEMSTRUCT
*pStruct
= (DRAWITEMSTRUCT
*)item
;
764 long data
= ListBox_GetItemData(GetHwnd(), pStruct
->itemID
);
766 wxCHECK( data
&& (data
!= LB_ERR
), FALSE
);
768 wxListBoxItem
*pItem
= (wxListBoxItem
*)data
;
771 dc
.SetHDC((WXHDC
)pStruct
->hDC
, FALSE
);
772 wxRect
rect(wxPoint(pStruct
->rcItem
.left
, pStruct
->rcItem
.top
),
773 wxPoint(pStruct
->rcItem
.right
, pStruct
->rcItem
.bottom
));
775 return pItem
->OnDrawItem(dc
, rect
,
776 (wxOwnerDrawn
::wxODAction
)pStruct
->itemAction
,
777 (wxOwnerDrawn
::wxODStatus
)pStruct
->itemState
);