]>
Commit | Line | Data |
---|---|---|
1 | ///////////////////////////////////////////////////////////////////////////// | |
2 | // Name: wx/msw/listctrl.h | |
3 | // Purpose: wxListCtrl 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_LISTCTRL_H_ | |
13 | #define _WX_LISTCTRL_H_ | |
14 | ||
15 | #ifdef __GNUG__ | |
16 | #pragma interface "listctrl.h" | |
17 | #endif | |
18 | ||
19 | #include "wx/control.h" | |
20 | #include "wx/event.h" | |
21 | #include "wx/imaglist.h" | |
22 | #include "wx/hash.h" | |
23 | ||
24 | /* | |
25 | The wxListCtrl can show lists of items in four different modes: | |
26 | wxLC_LIST: multicolumn list view, with optional small icons (icons could be | |
27 | optional for some platforms). Columns are computed automatically, | |
28 | i.e. you don't set columns as in wxLC_REPORT. In other words, | |
29 | the list wraps, unlike a wxListBox. | |
30 | wxLC_REPORT: single or multicolumn report view (with optional header) | |
31 | wxLC_ICON: large icon view, with optional labels | |
32 | wxLC_SMALL_ICON: small icon view, with optional labels | |
33 | ||
34 | You can change the style dynamically, either with SetSingleStyle or | |
35 | SetWindowStyleFlag. | |
36 | ||
37 | Further window styles: | |
38 | ||
39 | wxLC_ALIGN_TOP icons align to the top (default) | |
40 | wxLC_ALIGN_LEFT icons align to the left | |
41 | wxLC_AUTOARRANGE icons arrange themselves | |
42 | wxLC_USER_TEXT the app provides label text on demand, except for column headers | |
43 | wxLC_EDIT_LABELS labels are editable: app will be notified. | |
44 | wxLC_NO_HEADER no header in report mode | |
45 | wxLC_NO_SORT_HEADER can't click on header | |
46 | wxLC_SINGLE_SEL single selection | |
47 | wxLC_SORT_ASCENDING sort ascending (must still supply a comparison callback in SortItems) | |
48 | wxLC_SORT_DESCENDING sort descending (ditto) | |
49 | ||
50 | Items are referred to by their index (position in the list starting from zero). | |
51 | ||
52 | Label text is supplied via insertion/setting functions and is stored by the | |
53 | control, unless the wxLC_USER_TEXT style has been specified, in which case | |
54 | the app will be notified when text is required (see sample). | |
55 | ||
56 | Images are dealt with by (optionally) associating 3 image lists with the control. | |
57 | Zero-based indexes into these image lists indicate which image is to be used for | |
58 | which item. Each image in an image list can contain a mask, and can be made out | |
59 | of either a bitmap, two bitmaps or an icon. See ImagList.h for more details. | |
60 | ||
61 | Notifications are passed via the wxWindows 2.0 event system, or using virtual | |
62 | functions in wxWindows 1.66. | |
63 | ||
64 | See the sample wxListCtrl app for API usage. | |
65 | ||
66 | TODO: | |
67 | - addition of further convenience functions | |
68 | to avoid use of wxListItem in some functions | |
69 | - state/overlay images: probably not needed. | |
70 | - in Win95, you can be called back to supply other information | |
71 | besides text, such as state information. This saves no memory | |
72 | and is probably superfluous to requirements. | |
73 | - testing of whole API, extending current sample. | |
74 | ||
75 | ||
76 | */ | |
77 | ||
78 | class WXDLLEXPORT wxListCtrl: public wxControl | |
79 | { | |
80 | public: | |
81 | /* | |
82 | * Public interface | |
83 | */ | |
84 | ||
85 | wxListCtrl() { Init(); } | |
86 | ||
87 | wxListCtrl(wxWindow *parent, | |
88 | wxWindowID id = -1, | |
89 | const wxPoint& pos = wxDefaultPosition, | |
90 | const wxSize& size = wxDefaultSize, | |
91 | long style = wxLC_ICON, | |
92 | const wxValidator& validator = wxDefaultValidator, | |
93 | const wxString& name = _T("wxListCtrl")) | |
94 | { | |
95 | Init(); | |
96 | ||
97 | Create(parent, id, pos, size, style, validator, name); | |
98 | } | |
99 | ||
100 | virtual ~wxListCtrl(); | |
101 | ||
102 | bool Create(wxWindow *parent, | |
103 | wxWindowID id = -1, | |
104 | const wxPoint& pos = wxDefaultPosition, | |
105 | const wxSize& size = wxDefaultSize, | |
106 | long style = wxLC_ICON, | |
107 | const wxValidator& validator = wxDefaultValidator, | |
108 | const wxString& name = _T("wxListCtrl")); | |
109 | ||
110 | ||
111 | // Attributes | |
112 | //////////////////////////////////////////////////////////////////////////// | |
113 | ||
114 | // Sets the background colour (GetBackgroundColour already implicit in | |
115 | // wxWindow class) | |
116 | bool SetBackgroundColour(const wxColour& col); | |
117 | ||
118 | // Gets information about this column | |
119 | bool GetColumn(int col, wxListItem& item) const; | |
120 | ||
121 | // Sets information about this column | |
122 | bool SetColumn(int col, wxListItem& item) ; | |
123 | ||
124 | // Gets the column width | |
125 | int GetColumnWidth(int col) const; | |
126 | ||
127 | // Sets the column width | |
128 | bool SetColumnWidth(int col, int width) ; | |
129 | ||
130 | // Gets the number of items that can fit vertically in the | |
131 | // visible area of the list control (list or report view) | |
132 | // or the total number of items in the list control (icon | |
133 | // or small icon view) | |
134 | int GetCountPerPage() const; | |
135 | ||
136 | // Gets the edit control for editing labels. | |
137 | wxTextCtrl* GetEditControl() const; | |
138 | ||
139 | // Gets information about the item | |
140 | bool GetItem(wxListItem& info) const ; | |
141 | ||
142 | // Sets information about the item | |
143 | bool SetItem(wxListItem& info) ; | |
144 | ||
145 | // Sets a string field at a particular column | |
146 | long SetItem(long index, int col, const wxString& label, int imageId = -1); | |
147 | ||
148 | // Gets the item state | |
149 | int GetItemState(long item, long stateMask) const ; | |
150 | ||
151 | // Sets the item state | |
152 | bool SetItemState(long item, long state, long stateMask) ; | |
153 | ||
154 | // Sets the item image | |
155 | bool SetItemImage(long item, int image, int selImage) ; | |
156 | ||
157 | // Gets the item text | |
158 | wxString GetItemText(long item) const ; | |
159 | ||
160 | // Sets the item text | |
161 | void SetItemText(long item, const wxString& str) ; | |
162 | ||
163 | // Gets the item data | |
164 | long GetItemData(long item) const ; | |
165 | ||
166 | // Sets the item data | |
167 | bool SetItemData(long item, long data) ; | |
168 | ||
169 | // Gets the item rectangle | |
170 | bool GetItemRect(long item, wxRect& rect, int code = wxLIST_RECT_BOUNDS) const ; | |
171 | ||
172 | // Gets the item position | |
173 | bool GetItemPosition(long item, wxPoint& pos) const ; | |
174 | ||
175 | // Sets the item position | |
176 | bool SetItemPosition(long item, const wxPoint& pos) ; | |
177 | ||
178 | // Gets the number of items in the list control | |
179 | int GetItemCount() const; | |
180 | ||
181 | // Gets the number of columns in the list control | |
182 | int GetColumnCount() const { return m_colCount; } | |
183 | ||
184 | // Retrieves the spacing between icons in pixels. | |
185 | // If small is TRUE, gets the spacing for the small icon | |
186 | // view, otherwise the large icon view. | |
187 | int GetItemSpacing(bool isSmall) const; | |
188 | ||
189 | // Gets the number of selected items in the list control | |
190 | int GetSelectedItemCount() const; | |
191 | ||
192 | // Gets the text colour of the listview | |
193 | wxColour GetTextColour() const; | |
194 | ||
195 | // Sets the text colour of the listview | |
196 | void SetTextColour(const wxColour& col); | |
197 | ||
198 | // Gets the index of the topmost visible item when in | |
199 | // list or report view | |
200 | long GetTopItem() const ; | |
201 | ||
202 | // Add or remove a single window style | |
203 | void SetSingleStyle(long style, bool add = TRUE) ; | |
204 | ||
205 | // Set the whole window style | |
206 | void SetWindowStyleFlag(long style) ; | |
207 | ||
208 | // Searches for an item, starting from 'item'. | |
209 | // item can be -1 to find the first item that matches the | |
210 | // specified flags. | |
211 | // Returns the item or -1 if unsuccessful. | |
212 | long GetNextItem(long item, int geometry = wxLIST_NEXT_ALL, int state = wxLIST_STATE_DONTCARE) const ; | |
213 | ||
214 | // Implementation: converts wxWindows style to MSW style. | |
215 | // Can be a single style flag or a bit list. | |
216 | // oldStyle is 'normalised' so that it doesn't contain | |
217 | // conflicting styles. | |
218 | long ConvertToMSWStyle(long& oldStyle, long style) const; | |
219 | ||
220 | // Gets one of the three image lists | |
221 | wxImageList *GetImageList(int which) const ; | |
222 | ||
223 | // Sets the image list | |
224 | // N.B. There's a quirk in the Win95 list view implementation. | |
225 | // If in wxLC_LIST mode, it'll *still* display images by the labels if | |
226 | // there's a small-icon image list set for the control - even though you | |
227 | // haven't specified wxLIST_MASK_IMAGE when inserting. | |
228 | // So you have to set a NULL small-icon image list to be sure that | |
229 | // the wxLC_LIST mode works without icons. Of course, you may want icons... | |
230 | void SetImageList(wxImageList *imageList, int which) ; | |
231 | ||
232 | // Operations | |
233 | //////////////////////////////////////////////////////////////////////////// | |
234 | ||
235 | // Arranges the items | |
236 | bool Arrange(int flag = wxLIST_ALIGN_DEFAULT); | |
237 | ||
238 | // Deletes an item | |
239 | bool DeleteItem(long item); | |
240 | ||
241 | // Deletes all items | |
242 | bool DeleteAllItems() ; | |
243 | ||
244 | // Deletes a column | |
245 | bool DeleteColumn(int col); | |
246 | ||
247 | // Deletes all columns | |
248 | bool DeleteAllColumns(); | |
249 | ||
250 | // Clears items, and columns if there are any. | |
251 | void ClearAll(); | |
252 | ||
253 | // Edit the label | |
254 | wxTextCtrl* EditLabel(long item, wxClassInfo* textControlClass = CLASSINFO(wxTextCtrl)); | |
255 | ||
256 | // End label editing, optionally cancelling the edit | |
257 | bool EndEditLabel(bool cancel); | |
258 | ||
259 | // Ensures this item is visible | |
260 | bool EnsureVisible(long item) ; | |
261 | ||
262 | // Find an item whose label matches this string, starting from the item after 'start' | |
263 | // or the beginning if 'start' is -1. | |
264 | long FindItem(long start, const wxString& str, bool partial = FALSE); | |
265 | ||
266 | // Find an item whose data matches this data, starting from the item after 'start' | |
267 | // or the beginning if 'start' is -1. | |
268 | long FindItem(long start, long data); | |
269 | ||
270 | // Find an item nearest this position in the specified direction, starting from | |
271 | // the item after 'start' or the beginning if 'start' is -1. | |
272 | long FindItem(long start, const wxPoint& pt, int direction); | |
273 | ||
274 | // Determines which item (if any) is at the specified point, | |
275 | // giving details in 'flags' (see wxLIST_HITTEST_... flags above) | |
276 | long HitTest(const wxPoint& point, int& flags); | |
277 | ||
278 | // Inserts an item, returning the index of the new item if successful, | |
279 | // -1 otherwise. | |
280 | long InsertItem(wxListItem& info); | |
281 | ||
282 | // Insert a string item | |
283 | long InsertItem(long index, const wxString& label); | |
284 | ||
285 | // Insert an image item | |
286 | long InsertItem(long index, int imageIndex); | |
287 | ||
288 | // Insert an image/string item | |
289 | long InsertItem(long index, const wxString& label, int imageIndex); | |
290 | ||
291 | // For list view mode (only), inserts a column. | |
292 | long InsertColumn(long col, wxListItem& info); | |
293 | ||
294 | long InsertColumn(long col, | |
295 | const wxString& heading, | |
296 | int format = wxLIST_FORMAT_LEFT, | |
297 | int width = -1); | |
298 | ||
299 | // Scrolls the list control. If in icon, small icon or report view mode, | |
300 | // x specifies the number of pixels to scroll. If in list view mode, x | |
301 | // specifies the number of columns to scroll. | |
302 | // If in icon, small icon or list view mode, y specifies the number of pixels | |
303 | // to scroll. If in report view mode, y specifies the number of lines to scroll. | |
304 | bool ScrollList(int dx, int dy); | |
305 | ||
306 | // Sort items. | |
307 | ||
308 | // fn is a function which takes 3 long arguments: item1, item2, data. | |
309 | // item1 is the long data associated with a first item (NOT the index). | |
310 | // item2 is the long data associated with a second item (NOT the index). | |
311 | // data is the same value as passed to SortItems. | |
312 | // The return value is a negative number if the first item should precede the second | |
313 | // item, a positive number of the second item should precede the first, | |
314 | // or zero if the two items are equivalent. | |
315 | ||
316 | // data is arbitrary data to be passed to the sort function. | |
317 | bool SortItems(wxListCtrlCompare fn, long data); | |
318 | ||
319 | // IMPLEMENTATION | |
320 | virtual bool MSWCommand(WXUINT param, WXWORD id); | |
321 | virtual bool MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result); | |
322 | ||
323 | // bring the control in sync with current m_windowStyle value | |
324 | void UpdateStyle(); | |
325 | ||
326 | // Add to pool: necessary because Windows needs to have a string | |
327 | // still exist across 3 callbacks. | |
328 | wxChar *AddPool(const wxString& str); | |
329 | ||
330 | protected: | |
331 | // common part of all ctors | |
332 | void Init(); | |
333 | ||
334 | wxTextCtrl* m_textCtrl; // The control used for editing a label | |
335 | wxImageList * m_imageListNormal; // The image list for normal icons | |
336 | wxImageList * m_imageListSmall; // The image list for small icons | |
337 | wxImageList * m_imageListState; // The image list state icons (not implemented yet) | |
338 | ||
339 | long m_baseStyle; // Basic Windows style flags, for recreation purposes | |
340 | wxStringList m_stringPool; // Pool of 3 strings to satisfy Windows callback requirements | |
341 | int m_colCount; // Windows doesn't have GetColumnCount so must | |
342 | // keep track of inserted/deleted columns | |
343 | ||
344 | // the hash table we use for storing pointers to the items attributes | |
345 | wxHashTable m_attrs; | |
346 | ||
347 | // TRUE if we have any items with custom attributes | |
348 | bool m_hasAnyAttr; | |
349 | ||
350 | private: | |
351 | bool DoCreateControl(int x, int y, int w, int h); | |
352 | ||
353 | DECLARE_DYNAMIC_CLASS(wxListCtrl) | |
354 | }; | |
355 | ||
356 | #endif | |
357 | // _WX_LISTCTRL_H_ |