]> git.saurik.com Git - wxWidgets.git/blame - include/wx/listbase.h
Added simplistic makefile/project files for wxWinCE.
[wxWidgets.git] / include / wx / listbase.h
CommitLineData
e81a301c
JS
1///////////////////////////////////////////////////////////////////////////////
2// Name: wx/listctrl.h
3// Purpose: wxListCtrl class
4// Author: Vadim Zeitlin
5// Modified by:
6// Created: 04.12.99
7// RCS-ID: $Id$
8// Copyright: (c) wxWindows team
9// Licence: wxWindows licence
10///////////////////////////////////////////////////////////////////////////////
11
12#ifndef _WX_LISTBASE_H_BASE_
13#define _WX_LISTBASE_H_BASE_
14
af49c4b8 15#if defined(__GNUG__) && !defined(__APPLE__)
e81a301c
JS
16// #pragma interface "listctrlbase.h"
17#endif
18
19#if wxUSE_LISTCTRL
20
21// ----------------------------------------------------------------------------
22// types
23// ----------------------------------------------------------------------------
24
25// type of compare function for wxListCtrl sort operation
26typedef int (wxCALLBACK *wxListCtrlCompare)(long item1, long item2, long sortData);
27
28// ----------------------------------------------------------------------------
29// wxListCtrl constants
30// ----------------------------------------------------------------------------
31
32// style flags
33#define wxLC_VRULES 0x0001
34#define wxLC_HRULES 0x0002
35
36#define wxLC_ICON 0x0004
37#define wxLC_SMALL_ICON 0x0008
38#define wxLC_LIST 0x0010
39#define wxLC_REPORT 0x0020
40
41#define wxLC_ALIGN_TOP 0x0040
42#define wxLC_ALIGN_LEFT 0x0080
43#define wxLC_AUTOARRANGE 0x0100
44#define wxLC_VIRTUAL 0x0200
45#define wxLC_EDIT_LABELS 0x0400
46#define wxLC_NO_HEADER 0x0800
47#define wxLC_NO_SORT_HEADER 0x1000
48#define wxLC_SINGLE_SEL 0x2000
49#define wxLC_SORT_ASCENDING 0x4000
50#define wxLC_SORT_DESCENDING 0x8000
51
52#define wxLC_MASK_TYPE (wxLC_ICON | wxLC_SMALL_ICON | wxLC_LIST | wxLC_REPORT)
53#define wxLC_MASK_ALIGN (wxLC_ALIGN_TOP | wxLC_ALIGN_LEFT)
54#define wxLC_MASK_SORT (wxLC_SORT_ASCENDING | wxLC_SORT_DESCENDING)
55
56// for compatibility only
57#define wxLC_USER_TEXT wxLC_VIRTUAL
58
59// Omitted because
60// (a) too much detail
61// (b) not enough style flags
62// (c) not implemented anyhow in the generic version
63//
64// #define wxLC_NO_SCROLL
65// #define wxLC_NO_LABEL_WRAP
66// #define wxLC_OWNERDRAW_FIXED
67// #define wxLC_SHOW_SEL_ALWAYS
68
69// Mask flags to tell app/GUI what fields of wxListItem are valid
70#define wxLIST_MASK_STATE 0x0001
71#define wxLIST_MASK_TEXT 0x0002
72#define wxLIST_MASK_IMAGE 0x0004
73#define wxLIST_MASK_DATA 0x0008
74#define wxLIST_SET_ITEM 0x0010
75#define wxLIST_MASK_WIDTH 0x0020
76#define wxLIST_MASK_FORMAT 0x0040
77
78// State flags for indicating the state of an item
79#define wxLIST_STATE_DONTCARE 0x0000
80#define wxLIST_STATE_DROPHILITED 0x0001 // MSW only
81#define wxLIST_STATE_FOCUSED 0x0002
82#define wxLIST_STATE_SELECTED 0x0004
83#define wxLIST_STATE_CUT 0x0008 // MSW only
84
85// Hit test flags, used in HitTest
86#define wxLIST_HITTEST_ABOVE 0x0001 // Above the client area.
87#define wxLIST_HITTEST_BELOW 0x0002 // Below the client area.
88#define wxLIST_HITTEST_NOWHERE 0x0004 // In the client area but below the last item.
89#define wxLIST_HITTEST_ONITEMICON 0x0020 // On the bitmap associated with an item.
90#define wxLIST_HITTEST_ONITEMLABEL 0x0080 // On the label (string) associated with an item.
91#define wxLIST_HITTEST_ONITEMRIGHT 0x0100 // In the area to the right of an item.
92#define wxLIST_HITTEST_ONITEMSTATEICON 0x0200 // On the state icon for a tree view item that is in a user-defined state.
93#define wxLIST_HITTEST_TOLEFT 0x0400 // To the left of the client area.
94#define wxLIST_HITTEST_TORIGHT 0x0800 // To the right of the client area.
95
96#define wxLIST_HITTEST_ONITEM (wxLIST_HITTEST_ONITEMICON | wxLIST_HITTEST_ONITEMLABEL | wxLIST_HITTEST_ONITEMSTATEICON)
97
98// Flags for GetNextItem (MSW only except wxLIST_NEXT_ALL)
99enum
100{
101 wxLIST_NEXT_ABOVE, // Searches for an item above the specified item
102 wxLIST_NEXT_ALL, // Searches for subsequent item by index
103 wxLIST_NEXT_BELOW, // Searches for an item below the specified item
104 wxLIST_NEXT_LEFT, // Searches for an item to the left of the specified item
105 wxLIST_NEXT_RIGHT // Searches for an item to the right of the specified item
106};
107
108// Alignment flags for Arrange (MSW only except wxLIST_ALIGN_LEFT)
109enum
110{
111 wxLIST_ALIGN_DEFAULT,
112 wxLIST_ALIGN_LEFT,
113 wxLIST_ALIGN_TOP,
114 wxLIST_ALIGN_SNAP_TO_GRID
115};
116
117// Column format (MSW only except wxLIST_FORMAT_LEFT)
118enum wxListColumnFormat
119{
120 wxLIST_FORMAT_LEFT,
121 wxLIST_FORMAT_RIGHT,
122 wxLIST_FORMAT_CENTRE,
123 wxLIST_FORMAT_CENTER = wxLIST_FORMAT_CENTRE
124};
125
126// Autosize values for SetColumnWidth
127enum
128{
129 wxLIST_AUTOSIZE = -1,
130 wxLIST_AUTOSIZE_USEHEADER = -2 // partly supported by generic version
131};
132
133// Flag values for GetItemRect
134enum
135{
136 wxLIST_RECT_BOUNDS,
137 wxLIST_RECT_ICON,
138 wxLIST_RECT_LABEL
139};
140
141// Flag values for FindItem (MSW only)
142enum
143{
144 wxLIST_FIND_UP,
145 wxLIST_FIND_DOWN,
146 wxLIST_FIND_LEFT,
147 wxLIST_FIND_RIGHT
148};
149
150// ----------------------------------------------------------------------------
151// wxListItemAttr: a structure containing the visual attributes of an item
152// ----------------------------------------------------------------------------
153
154class WXDLLEXPORT wxListItemAttr
155{
156public:
157 // ctors
158 wxListItemAttr() { }
159 wxListItemAttr(const wxColour& colText,
160 const wxColour& colBack,
161 const wxFont& font)
162 : m_colText(colText), m_colBack(colBack), m_font(font) { }
163
164 // setters
165 void SetTextColour(const wxColour& colText) { m_colText = colText; }
166 void SetBackgroundColour(const wxColour& colBack) { m_colBack = colBack; }
167 void SetFont(const wxFont& font) { m_font = font; }
168
169 // accessors
170 bool HasTextColour() const { return m_colText.Ok(); }
171 bool HasBackgroundColour() const { return m_colBack.Ok(); }
172 bool HasFont() const { return m_font.Ok(); }
173
174 const wxColour& GetTextColour() const { return m_colText; }
175 const wxColour& GetBackgroundColour() const { return m_colBack; }
176 const wxFont& GetFont() const { return m_font; }
177
178private:
179 wxColour m_colText,
180 m_colBack;
181 wxFont m_font;
182};
183
184// ----------------------------------------------------------------------------
185// wxListItem: the item or column info, used to exchange data with wxListCtrl
186// ----------------------------------------------------------------------------
187
188class WXDLLEXPORT wxListItem : public wxObject
189{
190public:
191 wxListItem() { Init(); m_attr = NULL; }
192 wxListItem(const wxListItem& item)
193 : wxObject(),
194 m_mask(item.m_mask),
195 m_itemId(item.m_itemId),
196 m_col(item.m_col),
197 m_state(item.m_state),
198 m_stateMask(item.m_stateMask),
199 m_text(item.m_text),
200 m_image(item.m_image),
201 m_data(item.m_data),
202 m_format(item.m_format),
203 m_width(item.m_width),
204 m_attr(NULL)
205 {
206 // copy list item attributes
207 if( item.HasAttributes() )
208 m_attr = new wxListItemAttr(*item.GetAttributes());
209 }
210 virtual ~wxListItem() { delete m_attr; }
211
212 // resetting
213 void Clear() { Init(); m_text.clear(); ClearAttributes(); }
214 void ClearAttributes() { if ( m_attr ) { delete m_attr; m_attr = NULL; } }
215
216 // setters
217 void SetMask(long mask) { m_mask = mask; }
218 void SetId(long id) { m_itemId = id; }
219 void SetColumn(int col) { m_col = col; }
220 void SetState(long state) { m_state = state; m_stateMask |= state; }
221 void SetStateMask(long stateMask) { m_stateMask = stateMask; }
222 void SetText(const wxString& text) { m_text = text; }
223 void SetImage(int image) { m_image = image; }
224 void SetData(long data) { m_data = data; }
225 void SetData(void *data) { m_data = (long)data; }
226
227 void SetWidth(int width) { m_width = width; }
228 void SetAlign(wxListColumnFormat align) { m_format = align; }
229
230 void SetTextColour(const wxColour& colText)
231 { Attributes().SetTextColour(colText); }
232 void SetBackgroundColour(const wxColour& colBack)
233 { Attributes().SetBackgroundColour(colBack); }
234 void SetFont(const wxFont& font)
235 { Attributes().SetFont(font); }
236
237 // accessors
238 long GetMask() const { return m_mask; }
239 long GetId() const { return m_itemId; }
240 int GetColumn() const { return m_col; }
241 long GetState() const { return m_state & m_stateMask; }
242 const wxString& GetText() const { return m_text; }
243 int GetImage() const { return m_image; }
244 long GetData() const { return m_data; }
245
246 int GetWidth() const { return m_width; }
247 wxListColumnFormat GetAlign() const { return (wxListColumnFormat)m_format; }
248
249 wxListItemAttr *GetAttributes() const { return m_attr; }
250 bool HasAttributes() const { return m_attr != NULL; }
251
252 wxColour GetTextColour() const
253 { return HasAttributes() ? m_attr->GetTextColour() : wxNullColour; }
254 wxColour GetBackgroundColour() const
255 { return HasAttributes() ? m_attr->GetBackgroundColour()
256 : wxNullColour; }
257 wxFont GetFont() const
258 { return HasAttributes() ? m_attr->GetFont() : wxNullFont; }
259
260 // this conversion is necessary to make old code using GetItem() to
261 // compile
262 operator long() const { return m_itemId; }
263
264 // these members are public for compatibility
265
266 long m_mask; // Indicates what fields are valid
267 long m_itemId; // The zero-based item position
268 int m_col; // Zero-based column, if in report mode
269 long m_state; // The state of the item
270 long m_stateMask;// Which flags of m_state are valid (uses same flags)
271 wxString m_text; // The label/header text
272 int m_image; // The zero-based index into an image list
273 long m_data; // App-defined data
274
275 // For columns only
276 int m_format; // left, right, centre
277 int m_width; // width of column
278
279protected:
280 // creates m_attr if we don't have it yet
281 wxListItemAttr& Attributes()
282 {
283 if ( !m_attr )
284 m_attr = new wxListItemAttr;
285
286 return *m_attr;
287 }
288
289 void Init()
290 {
291 m_mask = 0;
292 m_itemId = 0;
293 m_col = 0;
294 m_state = 0;
295 m_stateMask = 0;
296 m_image = 0;
297 m_data = 0;
298
299 m_format = wxLIST_FORMAT_CENTRE;
300 m_width = 0;
301 }
302
303 wxListItemAttr *m_attr; // optional pointer to the items style
304
305private:
306 // VZ: this is strange, we have a copy ctor but not operator=(), why?
307 wxListItem& operator=(const wxListItem& item);
308
309 DECLARE_DYNAMIC_CLASS(wxListItem)
310};
311
312// ----------------------------------------------------------------------------
313// wxListEvent - the event class for the wxListCtrl notifications
314// ----------------------------------------------------------------------------
315
316class WXDLLEXPORT wxListEvent : public wxNotifyEvent
317{
318public:
319 wxListEvent(wxEventType commandType = wxEVT_NULL, int id = 0)
320 : wxNotifyEvent(commandType, id)
321 , m_code(0)
322 , m_oldItemIndex(0)
323 , m_itemIndex(0)
324 , m_col(0)
325 , m_pointDrag()
326 , m_item()
327 { }
328
329 wxListEvent(const wxListEvent& event)
330 : wxNotifyEvent(event)
331 , m_code(event.m_code)
332 , m_oldItemIndex(event.m_oldItemIndex)
333 , m_itemIndex(event.m_itemIndex)
334 , m_col(event.m_col)
335 , m_pointDrag(event.m_pointDrag)
336 , m_item(event.m_item)
337 { }
338
339 int GetKeyCode() const { return m_code; }
340 long GetIndex() const { return m_itemIndex; }
341 int GetColumn() const { return m_col; }
342 wxPoint GetPoint() const { return m_pointDrag; }
343 const wxString& GetLabel() const { return m_item.m_text; }
344 const wxString& GetText() const { return m_item.m_text; }
345 int GetImage() const { return m_item.m_image; }
346 long GetData() const { return m_item.m_data; }
347 long GetMask() const { return m_item.m_mask; }
348 const wxListItem& GetItem() const { return m_item; }
349
350 // for wxEVT_COMMAND_LIST_CACHE_HINT only
351 long GetCacheFrom() const { return m_oldItemIndex; }
352 long GetCacheTo() const { return m_itemIndex; }
353
354#if WXWIN_COMPATIBILITY_2_2
355 // these methods don't do anything at all
356 long GetOldIndex() const { return 0; }
357 long GetOldItem() const { return 0; }
358
359 // this one is superseded by GetKeyCode()
360 int GetCode() const { return GetKeyCode(); }
361#endif // WXWIN_COMPATIBILITY_2_2
362
363 virtual wxEvent *Clone() const { return new wxListEvent(*this); }
364
365//protected: -- not for backwards compatibility
366 int m_code;
367 long m_oldItemIndex; // only for wxEVT_COMMAND_LIST_CACHE_HINT
368 long m_itemIndex;
369 int m_col;
370 wxPoint m_pointDrag;
371
372 wxListItem m_item;
373
374private:
375 DECLARE_DYNAMIC_CLASS(wxListEvent)
376};
377
378// ----------------------------------------------------------------------------
379// wxListCtrl event macros
380// ----------------------------------------------------------------------------
381
382BEGIN_DECLARE_EVENT_TYPES()
383 DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_BEGIN_DRAG, 700)
384 DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_BEGIN_RDRAG, 701)
385 DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT, 702)
386 DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_END_LABEL_EDIT, 703)
387 DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_DELETE_ITEM, 704)
388 DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_DELETE_ALL_ITEMS, 705)
389 DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_GET_INFO, 706)
390 DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_SET_INFO, 707)
391 DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_SELECTED, 708)
392 DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_DESELECTED, 709)
393 DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_KEY_DOWN, 710)
394 DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_INSERT_ITEM, 711)
395 DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_COL_CLICK, 712)
396 DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK, 713)
397 DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_MIDDLE_CLICK, 714)
398 DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_ACTIVATED, 715)
399 DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_CACHE_HINT, 716)
400 DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_COL_RIGHT_CLICK, 717)
401 DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_COL_BEGIN_DRAG, 718)
402 DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_COL_DRAGGING, 719)
403 DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_COL_END_DRAG, 720)
404 DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_FOCUSED, 721)
405END_DECLARE_EVENT_TYPES()
406
407typedef void (wxEvtHandler::*wxListEventFunction)(wxListEvent&);
408
409#define EVT_LIST_BEGIN_DRAG(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LIST_BEGIN_DRAG, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL ),
410#define EVT_LIST_BEGIN_RDRAG(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LIST_BEGIN_RDRAG, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL ),
411#define EVT_LIST_BEGIN_LABEL_EDIT(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL ),
412#define EVT_LIST_END_LABEL_EDIT(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LIST_END_LABEL_EDIT, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL ),
413#define EVT_LIST_DELETE_ITEM(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LIST_DELETE_ITEM, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL ),
414#define EVT_LIST_DELETE_ALL_ITEMS(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LIST_DELETE_ALL_ITEMS, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL ),
415#define EVT_LIST_GET_INFO(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LIST_GET_INFO, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL ),
416#define EVT_LIST_SET_INFO(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LIST_SET_INFO, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL ),
417#define EVT_LIST_KEY_DOWN(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LIST_KEY_DOWN, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL ),
418#define EVT_LIST_INSERT_ITEM(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LIST_INSERT_ITEM, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL ),
419
420#define EVT_LIST_COL_CLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LIST_COL_CLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL ),
421#define EVT_LIST_COL_RIGHT_CLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LIST_COL_RIGHT_CLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL ),
422#define EVT_LIST_COL_BEGIN_DRAG(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LIST_COL_BEGIN_DRAG, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL ),
423#define EVT_LIST_COL_DRAGGING(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LIST_COL_DRAGGING, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL ),
424#define EVT_LIST_COL_END_DRAG(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LIST_COL_END_DRAG, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL ),
425
426#define EVT_LIST_ITEM_SELECTED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LIST_ITEM_SELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL ),
427#define EVT_LIST_ITEM_DESELECTED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LIST_ITEM_DESELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL ),
428#define EVT_LIST_ITEM_RIGHT_CLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, (wxObject *) NULL ),
429#define EVT_LIST_ITEM_MIDDLE_CLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LIST_ITEM_MIDDLE_CLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, (wxObject *) NULL ),
430#define EVT_LIST_ITEM_ACTIVATED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LIST_ITEM_ACTIVATED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, (wxObject *) NULL ),
431#define EVT_LIST_ITEM_FOCUSED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LIST_ITEM_FOCUSED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, (wxObject *) NULL ),
432
433#define EVT_LIST_CACHE_HINT(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LIST_CACHE_HINT, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, (wxObject *) NULL ),
434
435#endif // wxUSE_LISTCTRL
436
437#endif
438 // _WX_LISTCTRL_H_BASE_