1 /////////////////////////////////////////////////////////////////////////////
2 // Name: wx/msw/listbox.h
3 // Purpose: wxListBox class
4 // Author: Julian Smart
8 // Copyright: (c) Julian Smart
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
12 #ifndef _WX_LISTBOX_H_
13 #define _WX_LISTBOX_H_
17 // ----------------------------------------------------------------------------
19 // ----------------------------------------------------------------------------
22 class WXDLLIMPEXP_FWD_CORE wxOwnerDrawn
;
24 // define the array of list box items
25 #include "wx/dynarray.h"
27 WX_DEFINE_EXPORTED_ARRAY_PTR(wxOwnerDrawn
*, wxListBoxItemsArray
);
28 #endif // wxUSE_OWNER_DRAWN
30 // forward decl for GetSelections()
31 class WXDLLIMPEXP_FWD_BASE wxArrayInt
;
33 // ----------------------------------------------------------------------------
35 // ----------------------------------------------------------------------------
37 class WXDLLEXPORT wxListBox
: public wxListBoxBase
42 wxListBox(wxWindow
*parent
, wxWindowID id
,
43 const wxPoint
& pos
= wxDefaultPosition
,
44 const wxSize
& size
= wxDefaultSize
,
45 int n
= 0, const wxString choices
[] = NULL
,
47 const wxValidator
& validator
= wxDefaultValidator
,
48 const wxString
& name
= wxListBoxNameStr
)
50 Create(parent
, id
, pos
, size
, n
, choices
, style
, validator
, name
);
52 wxListBox(wxWindow
*parent
, wxWindowID id
,
55 const wxArrayString
& choices
,
57 const wxValidator
& validator
= wxDefaultValidator
,
58 const wxString
& name
= wxListBoxNameStr
)
60 Create(parent
, id
, pos
, size
, choices
, style
, validator
, name
);
63 bool Create(wxWindow
*parent
, wxWindowID id
,
64 const wxPoint
& pos
= wxDefaultPosition
,
65 const wxSize
& size
= wxDefaultSize
,
66 int n
= 0, const wxString choices
[] = NULL
,
68 const wxValidator
& validator
= wxDefaultValidator
,
69 const wxString
& name
= wxListBoxNameStr
);
70 bool Create(wxWindow
*parent
, wxWindowID id
,
73 const wxArrayString
& choices
,
75 const wxValidator
& validator
= wxDefaultValidator
,
76 const wxString
& name
= wxListBoxNameStr
);
80 // implement base class pure virtuals
82 virtual void Delete(unsigned int n
);
84 virtual unsigned int GetCount() const;
85 virtual wxString
GetString(unsigned int n
) const;
86 virtual void SetString(unsigned int n
, const wxString
& s
);
87 virtual int FindString(const wxString
& s
, bool bCase
= false) const;
89 virtual bool IsSelected(int n
) const;
90 virtual int GetSelection() const;
91 virtual int GetSelections(wxArrayInt
& aSelections
) const;
93 // wxCheckListBox support
95 bool MSWOnMeasure(WXMEASUREITEMSTRUCT
*item
);
96 bool MSWOnDraw(WXDRAWITEMSTRUCT
*item
);
98 // plug-in for derived classes
99 virtual wxOwnerDrawn
*CreateLboxItem(size_t n
);
101 // allows to get the item and use SetXXX functions to set it's appearance
102 wxOwnerDrawn
*GetItem(size_t n
) const { return m_aItems
[n
]; }
104 // get the index of the given item
105 int GetItemIndex(wxOwnerDrawn
*item
) const { return m_aItems
.Index(item
); }
106 #endif // wxUSE_OWNER_DRAWN
108 // Windows-specific code to update the horizontal extent of the listbox, if
109 // necessary. If s is non-empty, the horizontal extent is increased to the
110 // length of this string if it's currently too short, otherwise the maximum
111 // extent of all strings is used. In any case calls InvalidateBestSize()
112 virtual void SetHorizontalExtent(const wxString
& s
= wxEmptyString
);
115 bool MSWCommand(WXUINT param
, WXWORD id
);
116 WXDWORD
MSWGetStyle(long style
, WXDWORD
*exstyle
) const;
118 // under XP when using "transition effect for menus and tooltips" if we
119 // return true for WM_PRINTCLIENT here then it causes noticable slowdown
120 virtual bool MSWShouldPropagatePrintChild()
125 virtual wxVisualAttributes
GetDefaultAttributes() const
127 return GetClassDefaultAttributes(GetWindowVariant());
130 static wxVisualAttributes
131 GetClassDefaultAttributes(wxWindowVariant variant
= wxWINDOW_VARIANT_NORMAL
)
133 return GetCompositeControlsDefaultAttributes(variant
);
137 virtual void DoSetSelection(int n
, bool select
);
138 virtual int DoAppend(const wxString
& item
);
139 virtual void DoInsertItems(const wxArrayString
& items
, unsigned int pos
);
140 virtual void DoSetItems(const wxArrayString
& items
, void **clientData
);
141 virtual void DoSetFirstItem(int n
);
142 virtual void DoSetItemClientData(unsigned int n
, void* clientData
);
143 virtual void* DoGetItemClientData(unsigned int n
) const;
144 virtual void DoSetItemClientObject(unsigned int n
, wxClientData
* clientData
);
145 virtual wxClientData
* DoGetItemClientObject(unsigned int n
) const;
146 virtual int DoListHitTest(const wxPoint
& point
) const;
148 // free memory (common part of Clear() and dtor)
151 unsigned int m_noItems
;
154 virtual wxSize
DoGetBestSize() const;
156 #if wxUSE_OWNER_DRAWN
158 wxListBoxItemsArray m_aItems
;
162 DECLARE_DYNAMIC_CLASS_NO_COPY(wxListBox
)
165 #endif // wxUSE_LISTBOX