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 ///////////////////////////////////////////////////////////////////////////////
12 // For compilers that support precompilation, includes "wx.h".
13 #include "wx/wxprec.h"
21 #include "wx/listbox.h"
24 #include "wx/dynarray.h"
25 #include "wx/settings.h"
31 #include "wx/window.h"
34 #include "wx/msw/private.h"
35 #include "wx/msw/dc.h"
40 #include "wx/ownerdrw.h"
43 #if wxUSE_EXTENDED_RTTI
44 WX_DEFINE_FLAGS( wxListBoxStyle
)
46 wxBEGIN_FLAGS( wxListBoxStyle
)
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
)
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
)
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
)
74 wxFLAGS_MEMBER(wxLB_SINGLE
)
75 wxFLAGS_MEMBER(wxLB_MULTIPLE
)
76 wxFLAGS_MEMBER(wxLB_EXTENDED
)
77 wxFLAGS_MEMBER(wxLB_HSCROLL
)
78 wxFLAGS_MEMBER(wxLB_ALWAYS_SB
)
79 wxFLAGS_MEMBER(wxLB_NEEDED_SB
)
80 wxFLAGS_MEMBER(wxLB_NO_SB
)
81 wxFLAGS_MEMBER(wxLB_SORT
)
83 wxEND_FLAGS( wxListBoxStyle
)
85 IMPLEMENT_DYNAMIC_CLASS_XTI(wxListBox
, wxControlWithItems
,"wx/listbox.h")
87 wxBEGIN_PROPERTIES_TABLE(wxListBox
)
88 wxEVENT_PROPERTY( Select
, wxEVT_COMMAND_LISTBOX_SELECTED
, wxCommandEvent
)
89 wxEVENT_PROPERTY( DoubleClick
, wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
, wxCommandEvent
)
91 wxPROPERTY( Font
, wxFont
, SetFont
, GetFont
, EMPTY_MACROVALUE
, 0 /*flags*/ , wxT("Helpstring") , wxT("group"))
92 wxPROPERTY_COLLECTION( Choices
, wxArrayString
, wxString
, AppendString
, GetStrings
, 0 /*flags*/ , wxT("Helpstring") , wxT("group") )
93 wxPROPERTY( Selection
,int, SetSelection
, GetSelection
, EMPTY_MACROVALUE
, 0 /*flags*/ , wxT("Helpstring") , wxT("group") )
94 wxPROPERTY_FLAGS( WindowStyle
, wxListBoxStyle
, long , SetWindowStyleFlag
, GetWindowStyleFlag
, EMPTY_MACROVALUE
, 0 /*flags*/ , wxT("Helpstring") , wxT("group")) // style
95 wxEND_PROPERTIES_TABLE()
97 wxBEGIN_HANDLERS_TABLE(wxListBox
)
98 wxEND_HANDLERS_TABLE()
100 wxCONSTRUCTOR_4( wxListBox
, wxWindow
* , Parent
, wxWindowID
, Id
, wxPoint
, Position
, wxSize
, Size
)
102 IMPLEMENT_DYNAMIC_CLASS(wxListBox
, wxControlWithItems
)
112 // ============================================================================
113 // list box item declaration and implementation
114 // ============================================================================
116 #if wxUSE_OWNER_DRAWN
118 class wxListBoxItem
: public wxOwnerDrawn
121 wxListBoxItem(wxListBox
*parent
)
122 { m_parent
= parent
; }
124 wxListBox
*GetParent() const
128 { return m_parent
->GetItemIndex(const_cast<wxListBoxItem
*>(this)); }
130 wxString
GetName() const
131 { return m_parent
->GetString(GetIndex()); }
137 wxOwnerDrawn
*wxListBox::CreateLboxItem(size_t WXUNUSED(n
))
139 return new wxListBoxItem(this);
142 #endif //USE_OWNER_DRAWN
144 // ============================================================================
145 // list box control implementation
146 // ============================================================================
148 // ----------------------------------------------------------------------------
150 // ----------------------------------------------------------------------------
153 wxListBox::wxListBox()
156 m_updateHorizontalExtent
= false;
159 bool wxListBox::Create(wxWindow
*parent
,
163 int n
, const wxString choices
[],
165 const wxValidator
& validator
,
166 const wxString
& name
)
169 m_updateHorizontalExtent
= false;
171 // initialize base class fields
172 if ( !CreateControl(parent
, id
, pos
, size
, style
, validator
, name
) )
175 // create the native control
176 if ( !MSWCreateControl(wxT("LISTBOX"), wxEmptyString
, pos
, size
) )
178 // control creation failed
182 // initialize the contents
183 for ( int i
= 0; i
< n
; i
++ )
188 // now we can compute our best size correctly, so do it again
189 InvalidateBestSize();
190 SetInitialSize(size
);
195 bool wxListBox::Create(wxWindow
*parent
,
199 const wxArrayString
& choices
,
201 const wxValidator
& validator
,
202 const wxString
& name
)
204 wxCArrayString
chs(choices
);
205 return Create(parent
, id
, pos
, size
, chs
.GetCount(), chs
.GetStrings(),
206 style
, validator
, name
);
209 wxListBox::~wxListBox()
214 WXDWORD
wxListBox::MSWGetStyle(long style
, WXDWORD
*exstyle
) const
216 WXDWORD msStyle
= wxControl::MSWGetStyle(style
, exstyle
);
218 // we always want to get the notifications
219 msStyle
|= LBS_NOTIFY
;
221 // without this style, you get unexpected heights, so e.g. constraint
222 // layout doesn't work properly
223 msStyle
|= LBS_NOINTEGRALHEIGHT
;
225 wxASSERT_MSG( !(style
& wxLB_MULTIPLE
) || !(style
& wxLB_EXTENDED
),
226 wxT("only one of listbox selection modes can be specified") );
228 if ( style
& wxLB_MULTIPLE
)
229 msStyle
|= LBS_MULTIPLESEL
;
230 else if ( style
& wxLB_EXTENDED
)
231 msStyle
|= LBS_EXTENDEDSEL
;
233 wxASSERT_MSG( !(style
& wxLB_ALWAYS_SB
) || !(style
& wxLB_NO_SB
),
234 wxT( "Conflicting styles wxLB_ALWAYS_SB and wxLB_NO_SB." ) );
236 if ( !(style
& wxLB_NO_SB
) )
238 msStyle
|= WS_VSCROLL
;
239 if ( style
& wxLB_ALWAYS_SB
)
240 msStyle
|= LBS_DISABLENOSCROLL
;
243 if ( m_windowStyle
& wxLB_HSCROLL
)
244 msStyle
|= WS_HSCROLL
;
245 if ( m_windowStyle
& wxLB_SORT
)
248 #if wxUSE_OWNER_DRAWN && !defined(__WXWINCE__)
249 if ( m_windowStyle
& wxLB_OWNERDRAW
)
251 // we don't support LBS_OWNERDRAWVARIABLE yet and we also always put
252 // the strings in the listbox for simplicity even though we could have
253 // avoided it in this case
254 msStyle
|= LBS_OWNERDRAWFIXED
| LBS_HASSTRINGS
;
256 #endif // wxUSE_OWNER_DRAWN
261 void wxListBox::OnInternalIdle()
263 wxWindow::OnInternalIdle();
265 if (m_updateHorizontalExtent
)
267 SetHorizontalExtent(wxEmptyString
);
268 m_updateHorizontalExtent
= false;
272 // ----------------------------------------------------------------------------
273 // implementation of wxListBoxBase methods
274 // ----------------------------------------------------------------------------
276 void wxListBox::DoSetFirstItem(int N
)
278 wxCHECK_RET( IsValid(N
),
279 wxT("invalid index in wxListBox::SetFirstItem") );
281 SendMessage(GetHwnd(), LB_SETTOPINDEX
, (WPARAM
)N
, (LPARAM
)0);
284 void wxListBox::DoDeleteOneItem(unsigned int n
)
286 wxCHECK_RET( IsValid(n
),
287 wxT("invalid index in wxListBox::Delete") );
289 #if wxUSE_OWNER_DRAWN
290 if ( HasFlag(wxLB_OWNERDRAW
) )
293 m_aItems
.RemoveAt(n
);
295 #endif // wxUSE_OWNER_DRAWN
297 SendMessage(GetHwnd(), LB_DELETESTRING
, n
, 0);
300 // SetHorizontalExtent(wxEmptyString); can be slow
301 m_updateHorizontalExtent
= true;
303 UpdateOldSelections();
306 int wxListBox::FindString(const wxString
& s
, bool bCase
) const
308 // back to base class search for not native search type
310 return wxItemContainerImmutable::FindString( s
, bCase
);
312 int pos
= ListBox_FindStringExact(GetHwnd(), -1, s
.wx_str());
319 void wxListBox::DoClear()
321 #if wxUSE_OWNER_DRAWN
322 if ( HasFlag(wxLB_OWNERDRAW
) )
324 WX_CLEAR_ARRAY(m_aItems
);
326 #endif // wxUSE_OWNER_DRAWN
328 ListBox_ResetContent(GetHwnd());
331 m_updateHorizontalExtent
= true;
333 UpdateOldSelections();
336 void wxListBox::DoSetSelection(int N
, bool select
)
338 wxCHECK_RET( N
== wxNOT_FOUND
|| IsValid(N
),
339 wxT("invalid index in wxListBox::SetSelection") );
341 if ( HasMultipleSelection() )
343 SendMessage(GetHwnd(), LB_SETSEL
, select
, N
);
347 SendMessage(GetHwnd(), LB_SETCURSEL
, select
? N
: -1, 0);
350 UpdateOldSelections();
353 bool wxListBox::IsSelected(int N
) const
355 wxCHECK_MSG( IsValid(N
), false,
356 wxT("invalid index in wxListBox::Selected") );
358 return SendMessage(GetHwnd(), LB_GETSEL
, N
, 0) == 0 ? false : true;
361 void *wxListBox::DoGetItemClientData(unsigned int n
) const
363 wxCHECK_MSG( IsValid(n
), NULL
,
364 wxT("invalid index in wxListBox::GetClientData") );
366 return (void *)SendMessage(GetHwnd(), LB_GETITEMDATA
, n
, 0);
369 void wxListBox::DoSetItemClientData(unsigned int n
, void *clientData
)
371 wxCHECK_RET( IsValid(n
),
372 wxT("invalid index in wxListBox::SetClientData") );
374 if ( ListBox_SetItemData(GetHwnd(), n
, clientData
) == LB_ERR
)
376 wxLogDebug(wxT("LB_SETITEMDATA failed"));
380 // Return number of selections and an array of selected integers
381 int wxListBox::GetSelections(wxArrayInt
& aSelections
) const
385 if ( HasMultipleSelection() )
387 int countSel
= ListBox_GetSelCount(GetHwnd());
388 if ( countSel
== LB_ERR
)
390 wxLogDebug(wxT("ListBox_GetSelCount failed"));
392 else if ( countSel
!= 0 )
394 int *selections
= new int[countSel
];
396 if ( ListBox_GetSelItems(GetHwnd(),
397 countSel
, selections
) == LB_ERR
)
399 wxLogDebug(wxT("ListBox_GetSelItems failed"));
404 aSelections
.Alloc(countSel
);
405 for ( int n
= 0; n
< countSel
; n
++ )
406 aSelections
.Add(selections
[n
]);
409 delete [] selections
;
414 else // single-selection listbox
416 if (ListBox_GetCurSel(GetHwnd()) > -1)
417 aSelections
.Add(ListBox_GetCurSel(GetHwnd()));
419 return aSelections
.Count();
423 // Get single selection, for single choice list items
424 int wxListBox::GetSelection() const
426 wxCHECK_MSG( !HasMultipleSelection(),
428 wxT("GetSelection() can't be used with multiple-selection listboxes, use GetSelections() instead.") );
430 return ListBox_GetCurSel(GetHwnd());
433 // Find string for position
434 wxString
wxListBox::GetString(unsigned int n
) const
436 wxCHECK_MSG( IsValid(n
), wxEmptyString
,
437 wxT("invalid index in wxListBox::GetString") );
439 int len
= ListBox_GetTextLen(GetHwnd(), n
);
441 // +1 for terminating NUL
443 ListBox_GetText(GetHwnd(), n
, (wxChar
*)wxStringBuffer(result
, len
+ 1));
448 int wxListBox::DoInsertItems(const wxArrayStringsAdapter
& items
,
451 wxClientDataType type
)
453 MSWAllocStorage(items
, LB_INITSTORAGE
);
455 const bool append
= pos
== GetCount();
457 // we must use CB_ADDSTRING when appending as only it works correctly for
458 // the sorted controls
459 const unsigned msg
= append
? LB_ADDSTRING
: LB_INSERTSTRING
;
466 const unsigned int numItems
= items
.GetCount();
467 for ( unsigned int i
= 0; i
< numItems
; i
++ )
469 n
= MSWInsertOrAppendItem(pos
, items
[i
], msg
);
470 if ( n
== wxNOT_FOUND
)
478 #if wxUSE_OWNER_DRAWN
479 if ( HasFlag(wxLB_OWNERDRAW
) )
481 wxOwnerDrawn
*pNewItem
= CreateLboxItem(n
);
482 pNewItem
->SetFont(GetFont());
483 m_aItems
.Insert(pNewItem
, n
);
485 #endif // wxUSE_OWNER_DRAWN
486 AssignNewItemClientData(n
, clientData
, i
, type
);
489 m_updateHorizontalExtent
= true;
491 UpdateOldSelections();
496 int wxListBox::DoHitTestList(const wxPoint
& point
) const
498 LRESULT lRes
= ::SendMessage(GetHwnd(), LB_ITEMFROMPOINT
,
499 0, MAKELPARAM(point
.x
, point
.y
));
501 // non zero high-order word means that this item is outside of the client
502 // area, IOW the point is outside of the listbox
503 return HIWORD(lRes
) ? wxNOT_FOUND
: LOWORD(lRes
);
506 void wxListBox::SetString(unsigned int n
, const wxString
& s
)
508 wxCHECK_RET( IsValid(n
),
509 wxT("invalid index in wxListBox::SetString") );
511 // remember the state of the item
512 bool wasSelected
= IsSelected(n
);
514 void *oldData
= NULL
;
515 wxClientData
*oldObjData
= NULL
;
516 if ( HasClientUntypedData() )
517 oldData
= GetClientData(n
);
518 else if ( HasClientObjectData() )
519 oldObjData
= GetClientObject(n
);
521 // delete and recreate it
522 SendMessage(GetHwnd(), LB_DELETESTRING
, n
, 0);
525 if ( n
== (m_noItems
- 1) )
528 ListBox_InsertString(GetHwnd(), newN
, s
.wx_str());
530 // restore the client data
532 SetClientData(n
, oldData
);
533 else if ( oldObjData
)
534 SetClientObject(n
, oldObjData
);
536 // we may have lost the selection
540 m_updateHorizontalExtent
= true;
543 unsigned int wxListBox::GetCount() const
548 // ----------------------------------------------------------------------------
549 // size-related stuff
550 // ----------------------------------------------------------------------------
552 void wxListBox::SetHorizontalExtent(const wxString
& s
)
554 // in any case, our best size could have changed
555 InvalidateBestSize();
557 // the rest is only necessary if we want a horizontal scrollbar
558 if ( !HasFlag(wxHSCROLL
) )
562 WindowHDC
dc(GetHwnd());
563 SelectInHDC
selFont(dc
, GetHfontOf(GetFont()));
565 TEXTMETRIC lpTextMetric
;
566 ::GetTextMetrics(dc
, &lpTextMetric
);
568 int largestExtent
= 0;
573 // set extent to the max length of all strings
574 for ( unsigned int i
= 0; i
< m_noItems
; i
++ )
576 const wxString str
= GetString(i
);
577 ::GetTextExtentPoint32(dc
, str
.c_str(), str
.length(), &extentXY
);
579 int extentX
= (int)(extentXY
.cx
+ lpTextMetric
.tmAveCharWidth
);
580 if ( extentX
> largestExtent
)
581 largestExtent
= extentX
;
584 else // just increase the extent to the length of this string
586 int existingExtent
= (int)SendMessage(GetHwnd(),
587 LB_GETHORIZONTALEXTENT
, 0, 0L);
589 ::GetTextExtentPoint32(dc
, s
.c_str(), s
.length(), &extentXY
);
591 int extentX
= (int)(extentXY
.cx
+ lpTextMetric
.tmAveCharWidth
);
592 if ( extentX
> existingExtent
)
593 largestExtent
= extentX
;
597 SendMessage(GetHwnd(), LB_SETHORIZONTALEXTENT
, LOWORD(largestExtent
), 0L);
598 //else: it shouldn't change
601 wxSize
wxListBox::DoGetBestClientSize() const
603 // find the widest string
606 for (unsigned int i
= 0; i
< m_noItems
; i
++)
608 wxString
str(GetString(i
));
609 GetTextExtent(str
, &wLine
, NULL
);
610 if ( wLine
> wListbox
)
614 // give it some reasonable default value if there are no strings in the
619 // the listbox should be slightly larger than the widest string
620 wListbox
+= 3*GetCharWidth();
622 // add room for the scrollbar
623 wListbox
+= wxSystemSettings::GetMetric(wxSYS_VSCROLL_X
);
625 // don't make the listbox too tall (limit height to 10 items) but don't
626 // make it too small neither
627 int hListbox
= SendMessage(GetHwnd(), LB_GETITEMHEIGHT
, 0, 0)*
628 wxMin(wxMax(m_noItems
, 3), 10);
630 return wxSize(wListbox
, hListbox
);
633 // ----------------------------------------------------------------------------
635 // ----------------------------------------------------------------------------
637 bool wxListBox::MSWCommand(WXUINT param
, WXWORD
WXUNUSED(id
))
639 if ((param
== LBN_SELCHANGE
) && HasMultipleSelection())
647 if ( param
== LBN_SELCHANGE
)
649 evtType
= wxEVT_COMMAND_LISTBOX_SELECTED
;
650 n
= SendMessage(GetHwnd(), LB_GETCARETINDEX
, 0, 0);
652 // NB: conveniently enough, LB_ERR is the same as wxNOT_FOUND
654 else if ( param
== LBN_DBLCLK
)
656 evtType
= wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
;
657 n
= HitTest(ScreenToClient(wxGetMousePosition()));
661 // some event we're not interested in
665 // retrieve the affected item
666 if ( n
== wxNOT_FOUND
)
669 wxCommandEvent
event(evtType
, m_windowId
);
670 event
.SetEventObject(this);
672 if ( HasClientObjectData() )
673 event
.SetClientObject( GetClientObject(n
) );
674 else if ( HasClientUntypedData() )
675 event
.SetClientData( GetClientData(n
) );
677 event
.SetString(GetString(n
));
680 return HandleWindowEvent(event
);
683 // ----------------------------------------------------------------------------
684 // owner-drawn list boxes support
685 // ----------------------------------------------------------------------------
687 #if wxUSE_OWNER_DRAWN
689 // misc overloaded methods
690 // -----------------------
692 bool wxListBox::SetFont(const wxFont
&font
)
694 if ( HasFlag(wxLB_OWNERDRAW
) )
696 const unsigned count
= m_aItems
.GetCount();
697 for ( unsigned i
= 0; i
< count
; i
++ )
698 m_aItems
[i
]->SetFont(font
);
701 wxListBoxBase::SetFont(font
);
706 bool wxListBox::GetItemRect(size_t n
, wxRect
& rect
) const
708 wxCHECK_MSG( IsValid(n
), false,
709 wxT("invalid index in wxListBox::GetItemRect") );
713 if ( ListBox_GetItemRect(GetHwnd(), n
, &rc
) != LB_ERR
)
715 rect
= wxRectFromRECT(rc
);
720 // couldn't retrieve rect: for example, item isn't visible
725 bool wxListBox::RefreshItem(size_t n
)
728 if ( !GetItemRect(n
, rect
) )
732 wxCopyRectToRECT(rect
, rc
);
734 return ::InvalidateRect((HWND
)GetHWND(), &rc
, FALSE
) == TRUE
;
743 // space beneath/above each row in pixels
744 static const int LISTBOX_EXTRA_SPACE
= 1;
746 } // anonymous namespace
748 // the height is the same for all items
749 // TODO should be changed for LBS_OWNERDRAWVARIABLE style listboxes
751 // NB: can't forward this to wxListBoxItem because LB_SETITEMDATA
752 // message is not yet sent when we get here!
753 bool wxListBox::MSWOnMeasure(WXMEASUREITEMSTRUCT
*item
)
755 // only owner-drawn control should receive this message
756 wxCHECK( HasFlag(wxLB_OWNERDRAW
), false );
758 MEASUREITEMSTRUCT
*pStruct
= (MEASUREITEMSTRUCT
*)item
;
761 HDC hdc
= GetDC(NULL
);
763 HDC hdc
= CreateIC(wxT("DISPLAY"), NULL
, NULL
, 0);
767 wxDCTemp
dc((WXHDC
)hdc
);
768 dc
.SetFont(GetFont());
770 pStruct
->itemHeight
= dc
.GetCharHeight() + 2 * LISTBOX_EXTRA_SPACE
;
771 pStruct
->itemWidth
= dc
.GetCharWidth();
775 ReleaseDC(NULL
, hdc
);
783 // forward the message to the appropriate item
784 bool wxListBox::MSWOnDraw(WXDRAWITEMSTRUCT
*item
)
786 // only owner-drawn control should receive this message
787 wxCHECK( HasFlag(wxLB_OWNERDRAW
), false );
789 DRAWITEMSTRUCT
*pStruct
= (DRAWITEMSTRUCT
*)item
;
791 // the item may be -1 for an empty listbox
792 if ( pStruct
->itemID
== (UINT
)-1 )
795 wxListBoxItem
*pItem
= (wxListBoxItem
*)m_aItems
[pStruct
->itemID
];
797 wxDCTemp
dc((WXHDC
)pStruct
->hDC
);
799 return pItem
->OnDrawItem(dc
, wxRectFromRECT(pStruct
->rcItem
),
800 (wxOwnerDrawn::wxODAction
)pStruct
->itemAction
,
801 (wxOwnerDrawn::wxODStatus
)(pStruct
->itemState
| wxOwnerDrawn::wxODHidePrefix
));
804 #endif // wxUSE_OWNER_DRAWN
806 #endif // wxUSE_LISTBOX