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"
37 #if defined(GetWindowStyle)
42 #include "wx/dynarray.h"
46 #include "wx/ownerdrw.h"
50 #if defined(__GNUWIN32__)
51 #include <wx/msw/gnuwin32/extra.h>
56 #ifndef ListBox_SetItemData
57 #define ListBox_SetItemData(hwndCtl, index, data) \
58 ((int)(DWORD)SendMessage((hwndCtl), LB_SETITEMDATA, (WPARAM)(int)(index), (LPARAM)(data)))
60 #ifndef ListBox_GetHorizontalExtent
61 #define ListBox_GetHorizontalExtent(hwndCtl) \
62 ((int)(DWORD)SendMessage((hwndCtl), LB_GETHORIZONTALEXTENT, 0L, 0L))
64 #ifndef ListBox_GetSelCount
65 #define ListBox_GetSelCount(hwndCtl) \
66 ((int)(DWORD)SendMessage((hwndCtl), LB_GETSELCOUNT, 0L, 0L))
68 #ifndef ListBox_GetSelItems
69 #define ListBox_GetSelItems(hwndCtl, cItems, lpItems) \
70 ((int)(DWORD)SendMessage((hwndCtl), LB_GETSELITEMS, (WPARAM)(int)(cItems), (LPARAM)(int *)(lpItems)))
72 #ifndef ListBox_GetTextLen
73 #define ListBox_GetTextLen(hwndCtl, index) \
74 ((int)(DWORD)SendMessage((hwndCtl), LB_GETTEXTLEN, (WPARAM)(int)(index), 0L))
76 #ifndef ListBox_GetText
77 #define ListBox_GetText(hwndCtl, index, lpszBuffer) \
78 ((int)(DWORD)SendMessage((hwndCtl), LB_GETTEXT, (WPARAM)(int)(index), (LPARAM)(LPCTSTR)(lpszBuffer)))
82 #if !USE_SHARED_LIBRARY
83 IMPLEMENT_DYNAMIC_CLASS(wxListBox
, wxControl
)
86 // ============================================================================
87 // list box item declaration and implementation
88 // ============================================================================
92 class wxListBoxItem
: public wxOwnerDrawn
95 wxListBoxItem(const wxString
& str
= "");
98 wxListBoxItem::wxListBoxItem(const wxString
& str
) : wxOwnerDrawn(str
, FALSE
)
100 // no bitmaps/checkmarks
104 wxOwnerDrawn
*wxListBox::CreateItem(size_t n
)
106 return new wxListBoxItem();
109 #endif //USE_OWNER_DRAWN
111 // ============================================================================
112 // list box control implementation
113 // ============================================================================
115 bool wxListBox::MSWCommand(WXUINT param
, WXWORD
WXUNUSED(id
))
118 if (param == LBN_SELCANCEL)
120 event.extraLong = FALSE;
123 if (param
== LBN_SELCHANGE
)
125 wxCommandEvent
event(wxEVT_COMMAND_LISTBOX_SELECTED
, m_windowId
);
126 wxArrayInt aSelections
;
127 int count
= GetSelections(aSelections
);
130 event
.m_commandInt
= aSelections
[0] ;
131 event
.m_clientData
= GetClientData(event
.m_commandInt
);
132 wxString
str(GetString(event
.m_commandInt
));
135 event
.m_commandString
= str
;
140 event
.m_commandInt
= -1 ;
141 event
.m_commandString
.Empty();
144 event
.SetEventObject( this );
145 ProcessCommand(event
);
148 else if (param
== LBN_DBLCLK
)
150 wxCommandEvent
event(wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
, m_windowId
);
151 event
.SetEventObject( this );
152 GetEventHandler()->ProcessEvent(event
) ;
160 wxListBox::wxListBox()
166 bool wxListBox::Create(wxWindow
*parent
,
170 int n
, const wxString choices
[],
172 const wxValidator
& validator
,
173 const wxString
& name
)
180 SetValidator(validator
);
183 parent
->AddChild(this);
185 wxSystemSettings settings
;
186 SetBackgroundColour(settings
.GetSystemColour(wxSYS_COLOUR_WINDOW
));
187 SetForegroundColour(parent
->GetForegroundColour());
189 m_windowId
= ( id
== -1 ) ? (int)NewControlId() : id
;
195 m_windowStyle
= style
;
197 DWORD wstyle
= WS_VISIBLE
| WS_VSCROLL
| WS_TABSTOP
|
198 LBS_NOTIFY
| LBS_HASSTRINGS
;
199 if (m_windowStyle
& wxLB_MULTIPLE
)
200 wstyle
|= LBS_MULTIPLESEL
;
201 else if (m_windowStyle
& wxLB_EXTENDED
)
202 wstyle
|= LBS_EXTENDEDSEL
;
204 if (m_windowStyle
& wxLB_ALWAYS_SB
)
205 wstyle
|= LBS_DISABLENOSCROLL
;
206 if (m_windowStyle
& wxLB_HSCROLL
)
207 wstyle
|= WS_HSCROLL
;
208 if (m_windowStyle
& wxLB_SORT
)
211 #if wxUSE_OWNER_DRAWN
212 if ( m_windowStyle
& wxLB_OWNERDRAW
) {
213 // we don't support LBS_OWNERDRAWVARIABLE yet
214 wstyle
|= LBS_OWNERDRAWFIXED
;
218 // Without this style, you get unexpected heights, so e.g. constraint layout
219 // doesn't work properly
220 wstyle
|= LBS_NOINTEGRALHEIGHT
;
223 WXDWORD exStyle
= Determine3DEffects(WS_EX_CLIENTEDGE
, &want3D
) ;
225 // Even with extended styles, need to combine with WS_BORDER
226 // for them to look right.
227 if ( want3D
|| wxStyleHasBorder(m_windowStyle
) )
232 m_hWnd
= (WXHWND
)::CreateWindowEx(exStyle
, _T("LISTBOX"), NULL
,
235 (HWND
)parent
->GetHWND(), (HMENU
)m_windowId
,
236 wxGetInstance(), NULL
);
238 wxCHECK_MSG( m_hWnd
, FALSE
, _T("Failed to create listbox") );
243 Ctl3dSubclassCtl(GetHwnd());
248 // Subclass again to catch messages
252 for (ui
= 0; ui
< (size_t)n
; ui
++) {
256 if ( (m_windowStyle
& wxLB_MULTIPLE
) == 0 )
257 SendMessage(GetHwnd(), LB_SETCURSEL
, 0, 0);
259 SetFont(parent
->GetFont());
261 SetSize(x
, y
, width
, height
);
268 wxListBox::~wxListBox()
270 #if wxUSE_OWNER_DRAWN
271 size_t uiCount
= m_aItems
.Count();
272 while ( uiCount
-- != 0 ) {
273 delete m_aItems
[uiCount
];
275 #endif // wxUSE_OWNER_DRAWN
278 void wxListBox::SetupColours()
280 SetBackgroundColour(wxSystemSettings::GetSystemColour(wxSYS_COLOUR_WINDOW
));
281 SetForegroundColour(GetParent()->GetForegroundColour());
284 void wxListBox::SetFirstItem(int N
)
286 wxCHECK_RET( N
>= 0 && N
< m_noItems
,
287 _T("invalid index in wxListBox::SetFirstItem") );
289 SendMessage(GetHwnd(),LB_SETTOPINDEX
,(WPARAM
)N
,(LPARAM
)0) ;
292 void wxListBox::SetFirstItem(const wxString
& s
)
294 int N
= FindString(s
) ;
300 void wxListBox::Delete(int N
)
302 wxCHECK_RET( N
>= 0 && N
< m_noItems
,
303 _T("invalid index in wxListBox::Delete") );
305 SendMessage(GetHwnd(), LB_DELETESTRING
, N
, 0);
308 SetHorizontalExtent("");
311 void wxListBox::Append(const wxString
& item
)
313 int index
= ListBox_AddString(GetHwnd(), item
);
316 #if wxUSE_OWNER_DRAWN
317 if ( m_windowStyle
& wxLB_OWNERDRAW
) {
318 wxOwnerDrawn
*pNewItem
= CreateItem(index
); // dummy argument
319 pNewItem
->SetName(item
);
320 m_aItems
.Add(pNewItem
);
321 ListBox_SetItemData(GetHwnd(), index
, pNewItem
);
325 SetHorizontalExtent(item
);
328 void wxListBox::Append(const wxString
& item
, void *Client_data
)
330 int index
= ListBox_AddString(GetHwnd(), item
);
333 #if wxUSE_OWNER_DRAWN
334 if ( m_windowStyle
& wxLB_OWNERDRAW
) {
335 // client data must be pointer to wxOwnerDrawn, otherwise we would crash
336 // in OnMeasure/OnDraw.
337 wxFAIL_MSG(_T("Can't use client data with owner-drawn listboxes"));
342 ListBox_SetItemData(GetHwnd(), index
, Client_data
);
344 SetHorizontalExtent(item
);
347 void wxListBox::Set(int n
, const wxString
*choices
, void** clientData
)
349 ShowWindow(GetHwnd(), SW_HIDE
);
350 ListBox_ResetContent(GetHwnd());
352 for (i
= 0; i
< n
; i
++)
354 ListBox_AddString(GetHwnd(), choices
[i
]);
356 ListBox_SetItemData(GetHwnd(), i
, clientData
[i
]);
360 #if wxUSE_OWNER_DRAWN
361 if ( m_windowStyle
& wxLB_OWNERDRAW
) {
362 // first delete old items
363 size_t ui
= m_aItems
.Count();
364 while ( ui
-- != 0 ) {
369 // then create new ones
370 for (ui
= 0; ui
< (size_t)n
; ui
++) {
371 wxOwnerDrawn
*pNewItem
= CreateItem(ui
);
372 pNewItem
->SetName(choices
[ui
]);
373 m_aItems
.Add(pNewItem
);
374 ListBox_SetItemData(GetHwnd(), ui
, pNewItem
);
376 wxASSERT_MSG(clientData
[ui
] == NULL
,
377 _T("Can't use client data with owner-drawn listboxes"));
382 SetHorizontalExtent("");
383 ShowWindow(GetHwnd(), SW_SHOW
);
386 int wxListBox::FindString(const wxString
& s
) const
388 int pos
= ListBox_FindStringExact(GetHwnd(), (WPARAM
)-1, s
);
395 void wxListBox::Clear()
397 ListBox_ResetContent(GetHwnd());
399 #if wxUSE_OWNER_DRAWN
400 size_t uiCount
= m_aItems
.Count();
401 while ( uiCount
-- != 0 ) {
402 delete m_aItems
[uiCount
];
406 #endif // wxUSE_OWNER_DRAWN
409 ListBox_GetHorizontalExtent(GetHwnd());
412 void wxListBox::SetSelection(int N
, bool select
)
414 wxCHECK_RET( N
>= 0 && N
< m_noItems
,
415 _T("invalid index in wxListBox::SetSelection") );
417 if ((m_windowStyle
& wxLB_MULTIPLE
) || (m_windowStyle
& wxLB_EXTENDED
))
418 SendMessage(GetHwnd(), LB_SETSEL
, select
, N
);
424 SendMessage(GetHwnd(), LB_SETCURSEL
, N1
, 0);
428 bool wxListBox::Selected(int N
) const
430 wxCHECK_MSG( N
>= 0 && N
< m_noItems
, FALSE
,
431 _T("invalid index in wxListBox::Selected") );
433 return SendMessage(GetHwnd(), LB_GETSEL
, N
, 0) == 0 ? FALSE
: TRUE
;
436 void wxListBox::Deselect(int N
)
438 wxCHECK_RET( N
>= 0 && N
< m_noItems
,
439 _T("invalid index in wxListBox::Deselect") );
441 if ((m_windowStyle
& wxLB_MULTIPLE
) || (m_windowStyle
& wxLB_EXTENDED
))
442 SendMessage(GetHwnd(), LB_SETSEL
, FALSE
, N
);
445 void *wxListBox::GetClientData(int N
) const
447 wxCHECK_MSG( N
>= 0 && N
< m_noItems
, NULL
,
448 _T("invalid index in wxListBox::GetClientData") );
450 return (void *)SendMessage(GetHwnd(), LB_GETITEMDATA
, N
, 0);
453 void wxListBox::SetClientData(int N
, void *Client_data
)
455 wxCHECK_RET( N
>= 0 && N
< m_noItems
,
456 _T("invalid index in wxListBox::SetClientData") );
458 if ( ListBox_SetItemData(GetHwnd(), N
, Client_data
) == LB_ERR
)
459 wxLogDebug(_T("LB_SETITEMDATA failed"));
462 // Return number of selections and an array of selected integers
463 int wxListBox::GetSelections(wxArrayInt
& aSelections
) const
467 if ((m_windowStyle
& wxLB_MULTIPLE
) || (m_windowStyle
& wxLB_EXTENDED
))
469 int no_sel
= ListBox_GetSelCount(GetHwnd());
471 int *selections
= new int[no_sel
];
472 if ( ListBox_GetSelItems(GetHwnd(), no_sel
, selections
) == LB_ERR
) {
473 wxFAIL_MSG(_T("This listbox can't have single-selection style!"));
476 aSelections
.Alloc(no_sel
);
477 for ( int n
= 0; n
< no_sel
; n
++ )
478 aSelections
.Add(selections
[n
]);
480 delete [] selections
;
485 else // single-selection listbox
487 aSelections
.Add(ListBox_GetCurSel(GetHwnd()));
493 // Get single selection, for single choice list items
494 int wxListBox::GetSelection() const
496 wxCHECK_MSG( !(m_windowStyle
& wxLB_MULTIPLE
) &&
497 !(m_windowStyle
& wxLB_EXTENDED
),
499 _T("GetSelection() can't be used with multiple-selection "
500 "listboxes, use GetSelections() instead.") );
502 return ListBox_GetCurSel(GetHwnd());
505 // Find string for position
506 wxString
wxListBox::GetString(int N
) const
508 wxCHECK_MSG( N
>= 0 && N
< m_noItems
, "",
509 _T("invalid index in wxListBox::GetClientData") );
511 int len
= ListBox_GetTextLen(GetHwnd(), N
);
513 // +1 for terminating NUL
515 ListBox_GetText(GetHwnd(), N
, result
.GetWriteBuf(len
+ 1));
516 result
.UngetWriteBuf();
521 // Windows-specific code to set the horizontal extent of the listbox, if
522 // necessary. If s is non-NULL, it's used to calculate the horizontal extent.
523 // Otherwise, all strings are used.
524 void wxListBox::SetHorizontalExtent(const wxString
& s
)
526 // Only necessary if we want a horizontal scrollbar
527 if (!(m_windowStyle
& wxHSCROLL
))
529 TEXTMETRIC lpTextMetric
;
533 int existingExtent
= (int)SendMessage(GetHwnd(), LB_GETHORIZONTALEXTENT
, 0, 0L);
534 HDC dc
= GetWindowDC(GetHwnd());
536 if (GetFont().Ok() && GetFont().GetResourceHandle())
537 oldFont
= (HFONT
) ::SelectObject(dc
, (HFONT
) GetFont().GetResourceHandle());
539 GetTextMetrics(dc
, &lpTextMetric
);
541 ::GetTextExtentPoint(dc
, (LPTSTR
) (const wxChar
*)s
, s
.Length(), &extentXY
);
542 int extentX
= (int)(extentXY
.cx
+ lpTextMetric
.tmAveCharWidth
);
545 ::SelectObject(dc
, oldFont
);
547 ReleaseDC(GetHwnd(), dc
);
548 if (extentX
> existingExtent
)
549 SendMessage(GetHwnd(), LB_SETHORIZONTALEXTENT
, LOWORD(extentX
), 0L);
554 int largestExtent
= 0;
555 HDC dc
= GetWindowDC(GetHwnd());
557 if (GetFont().Ok() && GetFont().GetResourceHandle())
558 oldFont
= (HFONT
) ::SelectObject(dc
, (HFONT
) GetFont().GetResourceHandle());
560 GetTextMetrics(dc
, &lpTextMetric
);
562 for (i
= 0; i
< m_noItems
; i
++)
564 int len
= (int)SendMessage(GetHwnd(), LB_GETTEXT
, i
, (LONG
)wxBuffer
);
567 ::GetTextExtentPoint(dc
, (LPTSTR
)wxBuffer
, len
, &extentXY
);
568 int extentX
= (int)(extentXY
.cx
+ lpTextMetric
.tmAveCharWidth
);
569 if (extentX
> largestExtent
)
570 largestExtent
= extentX
;
573 ::SelectObject(dc
, oldFont
);
575 ReleaseDC(GetHwnd(), dc
);
576 SendMessage(GetHwnd(), LB_SETHORIZONTALEXTENT
, LOWORD(largestExtent
), 0L);
581 wxListBox::InsertItems(int nItems
, const wxString items
[], int pos
)
583 wxCHECK_RET( pos
>= 0 && pos
<= m_noItems
,
584 _T("invalid index in wxListBox::InsertItems") );
587 for (i
= 0; i
< nItems
; i
++)
588 ListBox_InsertString(GetHwnd(), i
+ pos
, items
[i
]);
591 SetHorizontalExtent(_T(""));
594 void wxListBox::SetString(int N
, const wxString
& s
)
596 wxCHECK_RET( N
>= 0 && N
< m_noItems
,
597 _T("invalid index in wxListBox::SetString") );
600 if (!(m_windowStyle
& wxLB_MULTIPLE
) && !(m_windowStyle
& wxLB_EXTENDED
))
601 sel
= GetSelection();
603 void *oldData
= wxListBox::GetClientData(N
);
605 SendMessage(GetHwnd(), LB_DELETESTRING
, N
, 0);
608 if (N
== (m_noItems
- 1))
611 SendMessage(GetHwnd(), LB_INSERTSTRING
, newN
, (LPARAM
) (const wxChar
*)s
);
613 wxListBox::SetClientData(N
, oldData
);
615 // Selection may have changed
619 #if wxUSE_OWNER_DRAWN
620 if ( m_windowStyle
& wxLB_OWNERDRAW
)
621 // update item's text
622 m_aItems
[N
]->SetName(s
);
623 #endif //USE_OWNER_DRAWN
626 int wxListBox::Number () const
631 // For single selection items only
632 wxString
wxListBox::GetStringSelection () const
634 int sel
= GetSelection ();
636 return this->GetString (sel
);
641 bool wxListBox::SetStringSelection (const wxString
& s
, bool flag
)
643 int sel
= FindString (s
);
646 SetSelection (sel
, flag
);
653 wxSize
wxListBox::DoGetBestSize()
655 // find the widest string
658 for ( int i
= 0; i
< m_noItems
; i
++ )
660 wxString
str(GetString(i
));
661 GetTextExtent(str
, &wLine
, NULL
);
662 if ( wLine
> wListbox
)
666 // give it some reasonable default value if there are no strings in the
671 // the listbox should be slightly larger than the widest string
673 wxGetCharSize(GetHWND(), &cx
, &cy
, &GetFont());
677 int hListbox
= EDIT_HEIGHT_FROM_CHAR_HEIGHT(cy
)*(wxMax(m_noItems
, 7));
679 return wxSize(wListbox
, hListbox
);
682 // Is this the right thing? Won't setselection generate a command
683 // event too? No! It'll just generate a setselection event.
684 // But we still can't have this being called whenever a real command
685 // is generated, because it sets the selection, which will already
686 // have been done! (Unless we have an optional argument for calling
687 // by the actual window system, or a separate function, ProcessCommand)
688 void wxListBox::Command (wxCommandEvent
& event
)
690 if (event
.m_extraLong
)
691 SetSelection (event
.m_commandInt
);
694 Deselect (event
.m_commandInt
);
697 ProcessCommand (event
);
700 WXHBRUSH
wxListBox::OnCtlColor(WXHDC pDC
, WXHWND pWnd
, WXUINT nCtlColor
,
701 WXUINT message
, WXWPARAM wParam
, WXLPARAM lParam
)
706 HBRUSH hbrush
= Ctl3dCtlColorEx(message
, wParam
, lParam
);
707 return (WXHBRUSH
) hbrush
;
711 if (GetParent()->GetTransparentBackground())
712 SetBkMode((HDC
) pDC
, TRANSPARENT
);
714 SetBkMode((HDC
) pDC
, OPAQUE
);
716 ::SetBkColor((HDC
) pDC
, RGB(GetBackgroundColour().Red(), GetBackgroundColour().Green(), GetBackgroundColour().Blue()));
717 ::SetTextColor((HDC
) pDC
, RGB(GetForegroundColour().Red(), GetForegroundColour().Green(), GetForegroundColour().Blue()));
719 wxBrush
*backgroundBrush
= wxTheBrushList
->FindOrCreateBrush(GetBackgroundColour(), wxSOLID
);
721 // Note that this will be cleaned up in wxApp::OnIdle, if backgroundBrush
722 // has a zero usage count.
723 backgroundBrush
->RealizeResource();
724 return (WXHBRUSH
) backgroundBrush
->GetResourceHandle();
727 long wxListBox::MSWWindowProc(WXUINT nMsg
, WXWPARAM wParam
, WXLPARAM lParam
)
729 return wxControl::MSWWindowProc(nMsg
, wParam
, lParam
);
732 #if wxUSE_OWNER_DRAWN
737 // space beneath/above each row in pixels
738 // "standard" checklistbox use 1 here, some might prefer 2. 0 is ugly.
739 #define OWNER_DRAWN_LISTBOX_EXTRA_SPACE (1)
741 // the height is the same for all items
742 // TODO should be changed for LBS_OWNERDRAWVARIABLE style listboxes
744 // NB: can't forward this to wxListBoxItem because LB_SETITEMDATA
745 // message is not yet sent when we get here!
746 bool wxListBox::MSWOnMeasure(WXMEASUREITEMSTRUCT
*item
)
748 // only owner-drawn control should receive this message
749 wxCHECK( ((m_windowStyle
& wxLB_OWNERDRAW
) == wxLB_OWNERDRAW
), FALSE
);
751 MEASUREITEMSTRUCT
*pStruct
= (MEASUREITEMSTRUCT
*)item
;
754 dc
.SetHDC((WXHDC
)CreateIC(_T("DISPLAY"), NULL
, NULL
, 0));
755 dc
.SetFont(wxSystemSettings::GetSystemFont(wxSYS_ANSI_VAR_FONT
));
757 pStruct
->itemHeight
= dc
.GetCharHeight() + 2*OWNER_DRAWN_LISTBOX_EXTRA_SPACE
;
758 pStruct
->itemWidth
= dc
.GetCharWidth();
763 // forward the message to the appropriate item
764 bool wxListBox::MSWOnDraw(WXDRAWITEMSTRUCT
*item
)
766 // only owner-drawn control should receive this message
767 wxCHECK( ((m_windowStyle
& wxLB_OWNERDRAW
) == wxLB_OWNERDRAW
), FALSE
);
769 DRAWITEMSTRUCT
*pStruct
= (DRAWITEMSTRUCT
*)item
;
771 long data
= ListBox_GetItemData(GetHwnd(), pStruct
->itemID
);
773 wxCHECK( data
&& (data
!= LB_ERR
), FALSE
);
775 wxListBoxItem
*pItem
= (wxListBoxItem
*)data
;
778 dc
.SetHDC((WXHDC
)pStruct
->hDC
, FALSE
);
779 wxRect
rect(wxPoint(pStruct
->rcItem
.left
, pStruct
->rcItem
.top
),
780 wxPoint(pStruct
->rcItem
.right
, pStruct
->rcItem
.bottom
));
782 return pItem
->OnDrawItem(dc
, rect
,
783 (wxOwnerDrawn::wxODAction
)pStruct
->itemAction
,
784 (wxOwnerDrawn::wxODStatus
)pStruct
->itemState
);