]>
Commit | Line | Data |
---|---|---|
1 | ///////////////////////////////////////////////////////////////////////////// | |
2 | // Name: wx/msw/listbox.h | |
3 | // Purpose: wxListBox class | |
4 | // Author: Julian Smart | |
5 | // Modified by: | |
6 | // Created: 01/02/97 | |
7 | // RCS-ID: $Id$ | |
8 | // Copyright: (c) Julian Smart | |
9 | // Licence: wxWindows licence | |
10 | ///////////////////////////////////////////////////////////////////////////// | |
11 | ||
12 | #ifndef _WX_LISTBOX_H_ | |
13 | #define _WX_LISTBOX_H_ | |
14 | ||
15 | #if wxUSE_LISTBOX | |
16 | ||
17 | // ---------------------------------------------------------------------------- | |
18 | // simple types | |
19 | // ---------------------------------------------------------------------------- | |
20 | ||
21 | #if wxUSE_OWNER_DRAWN | |
22 | class WXDLLIMPEXP_FWD_CORE wxOwnerDrawn; | |
23 | ||
24 | // define the array of list box items | |
25 | #include "wx/dynarray.h" | |
26 | ||
27 | WX_DEFINE_EXPORTED_ARRAY_PTR(wxOwnerDrawn *, wxListBoxItemsArray); | |
28 | #endif // wxUSE_OWNER_DRAWN | |
29 | ||
30 | // forward decl for GetSelections() | |
31 | class WXDLLIMPEXP_FWD_BASE wxArrayInt; | |
32 | ||
33 | // ---------------------------------------------------------------------------- | |
34 | // List box control | |
35 | // ---------------------------------------------------------------------------- | |
36 | ||
37 | class WXDLLEXPORT wxListBox : public wxListBoxBase | |
38 | { | |
39 | public: | |
40 | // ctors and such | |
41 | wxListBox(); | |
42 | wxListBox(wxWindow *parent, wxWindowID id, | |
43 | const wxPoint& pos = wxDefaultPosition, | |
44 | const wxSize& size = wxDefaultSize, | |
45 | int n = 0, const wxString choices[] = NULL, | |
46 | long style = 0, | |
47 | const wxValidator& validator = wxDefaultValidator, | |
48 | const wxString& name = wxListBoxNameStr) | |
49 | { | |
50 | Create(parent, id, pos, size, n, choices, style, validator, name); | |
51 | } | |
52 | wxListBox(wxWindow *parent, wxWindowID id, | |
53 | const wxPoint& pos, | |
54 | const wxSize& size, | |
55 | const wxArrayString& choices, | |
56 | long style = 0, | |
57 | const wxValidator& validator = wxDefaultValidator, | |
58 | const wxString& name = wxListBoxNameStr) | |
59 | { | |
60 | Create(parent, id, pos, size, choices, style, validator, name); | |
61 | } | |
62 | ||
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, | |
67 | long style = 0, | |
68 | const wxValidator& validator = wxDefaultValidator, | |
69 | const wxString& name = wxListBoxNameStr); | |
70 | bool Create(wxWindow *parent, wxWindowID id, | |
71 | const wxPoint& pos, | |
72 | const wxSize& size, | |
73 | const wxArrayString& choices, | |
74 | long style = 0, | |
75 | const wxValidator& validator = wxDefaultValidator, | |
76 | const wxString& name = wxListBoxNameStr); | |
77 | ||
78 | virtual ~wxListBox(); | |
79 | ||
80 | // implement base class pure virtuals | |
81 | virtual void DoClear(); | |
82 | virtual void DoDeleteOneItem(unsigned int n); | |
83 | ||
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; | |
88 | ||
89 | virtual bool IsSelected(int n) const; | |
90 | virtual int GetSelection() const; | |
91 | virtual int GetSelections(wxArrayInt& aSelections) const; | |
92 | ||
93 | // wxCheckListBox support | |
94 | #if wxUSE_OWNER_DRAWN | |
95 | bool MSWOnMeasure(WXMEASUREITEMSTRUCT *item); | |
96 | bool MSWOnDraw(WXDRAWITEMSTRUCT *item); | |
97 | ||
98 | // plug-in for derived classes | |
99 | virtual wxOwnerDrawn *CreateLboxItem(size_t n); | |
100 | ||
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]; } | |
103 | ||
104 | // get the index of the given item | |
105 | int GetItemIndex(wxOwnerDrawn *item) const { return m_aItems.Index(item); } | |
106 | #endif // wxUSE_OWNER_DRAWN | |
107 | ||
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); | |
113 | ||
114 | // Windows callbacks | |
115 | bool MSWCommand(WXUINT param, WXWORD id); | |
116 | WXDWORD MSWGetStyle(long style, WXDWORD *exstyle) const; | |
117 | ||
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() | |
121 | { | |
122 | return false; | |
123 | } | |
124 | ||
125 | virtual wxVisualAttributes GetDefaultAttributes() const | |
126 | { | |
127 | return GetClassDefaultAttributes(GetWindowVariant()); | |
128 | } | |
129 | ||
130 | static wxVisualAttributes | |
131 | GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL) | |
132 | { | |
133 | return GetCompositeControlsDefaultAttributes(variant); | |
134 | } | |
135 | ||
136 | protected: | |
137 | virtual void DoSetSelection(int n, bool select); | |
138 | ||
139 | virtual int DoInsertItems(const wxArrayStringsAdapter& items, | |
140 | unsigned int pos, | |
141 | void **clientData, wxClientDataType type); | |
142 | ||
143 | virtual void DoSetFirstItem(int n); | |
144 | virtual void DoSetItemClientData(unsigned int n, void* clientData); | |
145 | virtual void* DoGetItemClientData(unsigned int n) const; | |
146 | virtual int DoListHitTest(const wxPoint& point) const; | |
147 | ||
148 | // free memory (common part of Clear() and dtor) | |
149 | void Free(); | |
150 | ||
151 | unsigned int m_noItems; | |
152 | int m_selected; | |
153 | ||
154 | virtual wxSize DoGetBestSize() const; | |
155 | ||
156 | #if wxUSE_OWNER_DRAWN | |
157 | // control items | |
158 | wxListBoxItemsArray m_aItems; | |
159 | #endif | |
160 | ||
161 | private: | |
162 | DECLARE_DYNAMIC_CLASS_NO_COPY(wxListBox) | |
163 | }; | |
164 | ||
165 | #endif // wxUSE_LISTBOX | |
166 | ||
167 | #endif | |
168 | // _WX_LISTBOX_H_ |