]> git.saurik.com Git - wxWidgets.git/blame_incremental - include/wx/listbase.h
projects / wxWidgets.git / blame_incremental
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (non-incremental) | history | HEAD
renamed GetColHeader() to GetGridColHeader() for consistency with the other existing...
[wxWidgets.git] / include / wx / listbase.h
... / ...
CommitLineData
1///////////////////////////////////////////////////////////////////////////////
2// Name: wx/listbase.h
3// Purpose: wxListCtrl class
4// Author: Vadim Zeitlin
5// Modified by:
6// Created: 04.12.99
7// RCS-ID: $Id$
8// Copyright: (c) wxWidgets team
9// Licence: wxWindows licence
10///////////////////////////////////////////////////////////////////////////////
11
12#ifndef _WX_LISTBASE_H_BASE_
13#define _WX_LISTBASE_H_BASE_
14
15#include "wx/colour.h"
16#include "wx/font.h"
17#include "wx/gdicmn.h"
18#include "wx/event.h"
19
20// ----------------------------------------------------------------------------
21// types
22// ----------------------------------------------------------------------------
23
24// type of compare function for wxListCtrl sort operation
25typedef int (wxCALLBACK *wxListCtrlCompare)(long item1, long item2, long sortData);
26
27// ----------------------------------------------------------------------------
28// wxListCtrl constants
29// ----------------------------------------------------------------------------
30
31// style flags
32#define wxLC_VRULES 0x0001
33#define wxLC_HRULES 0x0002
34
35#define wxLC_ICON 0x0004
36#define wxLC_SMALL_ICON 0x0008
37#define wxLC_LIST 0x0010
38#define wxLC_REPORT 0x0020
39
40#define wxLC_ALIGN_TOP 0x0040
41#define wxLC_ALIGN_LEFT 0x0080
42#define wxLC_AUTOARRANGE 0x0100
43#define wxLC_VIRTUAL 0x0200
44#define wxLC_EDIT_LABELS 0x0400
45#define wxLC_NO_HEADER 0x0800
46#define wxLC_NO_SORT_HEADER 0x1000
47#define wxLC_SINGLE_SEL 0x2000
48#define wxLC_SORT_ASCENDING 0x4000
49#define wxLC_SORT_DESCENDING 0x8000
50
51#define wxLC_MASK_TYPE (wxLC_ICON | wxLC_SMALL_ICON | wxLC_LIST | wxLC_REPORT)
52#define wxLC_MASK_ALIGN (wxLC_ALIGN_TOP | wxLC_ALIGN_LEFT)
53#define wxLC_MASK_SORT (wxLC_SORT_ASCENDING | wxLC_SORT_DESCENDING)
54
55// for compatibility only
56#define wxLC_USER_TEXT wxLC_VIRTUAL
57
58// Omitted because
59// (a) too much detail
60// (b) not enough style flags
61// (c) not implemented anyhow in the generic version
62//
63// #define wxLC_NO_SCROLL
64// #define wxLC_NO_LABEL_WRAP
65// #define wxLC_OWNERDRAW_FIXED
66// #define wxLC_SHOW_SEL_ALWAYS
67
68// Mask flags to tell app/GUI what fields of wxListItem are valid
69#define wxLIST_MASK_STATE 0x0001
70#define wxLIST_MASK_TEXT 0x0002
71#define wxLIST_MASK_IMAGE 0x0004
72#define wxLIST_MASK_DATA 0x0008
73#define wxLIST_SET_ITEM 0x0010
74#define wxLIST_MASK_WIDTH 0x0020
75#define wxLIST_MASK_FORMAT 0x0040
76
77// State flags for indicating the state of an item
78#define wxLIST_STATE_DONTCARE 0x0000
79#define wxLIST_STATE_DROPHILITED 0x0001 // MSW only
80#define wxLIST_STATE_FOCUSED 0x0002
81#define wxLIST_STATE_SELECTED 0x0004
82#define wxLIST_STATE_CUT 0x0008 // MSW only
83#define wxLIST_STATE_DISABLED 0x0010 // OS2 only
84#define wxLIST_STATE_FILTERED 0x0020 // OS2 only
85#define wxLIST_STATE_INUSE 0x0040 // OS2 only
86#define wxLIST_STATE_PICKED 0x0080 // OS2 only
87#define wxLIST_STATE_SOURCE 0x0100 // OS2 only
88
89// Hit test flags, used in HitTest
90#define wxLIST_HITTEST_ABOVE 0x0001 // Above the client area.
91#define wxLIST_HITTEST_BELOW 0x0002 // Below the client area.
92#define wxLIST_HITTEST_NOWHERE 0x0004 // In the client area but below the last item.
93#define wxLIST_HITTEST_ONITEMICON 0x0020 // On the bitmap associated with an item.
94#define wxLIST_HITTEST_ONITEMLABEL 0x0080 // On the label (string) associated with an item.
95#define wxLIST_HITTEST_ONITEMRIGHT 0x0100 // In the area to the right of an item.
96#define wxLIST_HITTEST_ONITEMSTATEICON 0x0200 // On the state icon for a tree view item that is in a user-defined state.
97#define wxLIST_HITTEST_TOLEFT 0x0400 // To the left of the client area.
98#define wxLIST_HITTEST_TORIGHT 0x0800 // To the right of the client area.
99
100#define wxLIST_HITTEST_ONITEM (wxLIST_HITTEST_ONITEMICON | wxLIST_HITTEST_ONITEMLABEL | wxLIST_HITTEST_ONITEMSTATEICON)
101
102// GetSubItemRect constants
103#define wxLIST_GETSUBITEMRECT_WHOLEITEM -1l
104
105// Flags for GetNextItem (MSW only except wxLIST_NEXT_ALL)
106enum
107{
108 wxLIST_NEXT_ABOVE, // Searches for an item above the specified item
109 wxLIST_NEXT_ALL, // Searches for subsequent item by index
110 wxLIST_NEXT_BELOW, // Searches for an item below the specified item
111 wxLIST_NEXT_LEFT, // Searches for an item to the left of the specified item
112 wxLIST_NEXT_RIGHT // Searches for an item to the right of the specified item
113};
114
115// Alignment flags for Arrange (MSW only except wxLIST_ALIGN_LEFT)
116enum
117{
118 wxLIST_ALIGN_DEFAULT,
119 wxLIST_ALIGN_LEFT,
120 wxLIST_ALIGN_TOP,
121 wxLIST_ALIGN_SNAP_TO_GRID
122};
123
124// Column format (MSW only except wxLIST_FORMAT_LEFT)
125enum wxListColumnFormat
126{
127 wxLIST_FORMAT_LEFT,
128 wxLIST_FORMAT_RIGHT,
129 wxLIST_FORMAT_CENTRE,
130 wxLIST_FORMAT_CENTER = wxLIST_FORMAT_CENTRE
131};
132
133// Autosize values for SetColumnWidth
134enum
135{
136 wxLIST_AUTOSIZE = -1,
137 wxLIST_AUTOSIZE_USEHEADER = -2 // partly supported by generic version
138};
139
140// Flag values for GetItemRect
141enum
142{
143 wxLIST_RECT_BOUNDS,
144 wxLIST_RECT_ICON,
145 wxLIST_RECT_LABEL
146};
147
148// Flag values for FindItem (MSW only)
149enum
150{
151 wxLIST_FIND_UP,
152 wxLIST_FIND_DOWN,
153 wxLIST_FIND_LEFT,
154 wxLIST_FIND_RIGHT
155};
156
157// ----------------------------------------------------------------------------
158// wxListItemAttr: a structure containing the visual attributes of an item
159// ----------------------------------------------------------------------------
160
161// TODO: this should be renamed to wxItemAttr or something general like this
162// and used as base class for wxTextAttr which duplicates this class
163// entirely currently
164class WXDLLIMPEXP_CORE wxListItemAttr
165{
166public:
167 // ctors
168 wxListItemAttr() { }
169 wxListItemAttr(const wxColour& colText,
170 const wxColour& colBack,
171 const wxFont& font)
172 : m_colText(colText), m_colBack(colBack), m_font(font)
173 {
174 }
175
176 // default copy ctor, assignment operator and dtor are ok
177
178
179 // setters
180 void SetTextColour(const wxColour& colText) { m_colText = colText; }
181 void SetBackgroundColour(const wxColour& colBack) { m_colBack = colBack; }
182 void SetFont(const wxFont& font) { m_font = font; }
183
184 // accessors
185 bool HasTextColour() const { return m_colText.Ok(); }
186 bool HasBackgroundColour() const { return m_colBack.Ok(); }
187 bool HasFont() const { return m_font.Ok(); }
188
189 const wxColour& GetTextColour() const { return m_colText; }
190 const wxColour& GetBackgroundColour() const { return m_colBack; }
191 const wxFont& GetFont() const { return m_font; }
192
193
194 // this is almost like assignment operator except it doesn't overwrite the
195 // fields unset in the source attribute
196 void AssignFrom(const wxListItemAttr& source)
197 {
198 if ( source.HasTextColour() )
199 SetTextColour(source.GetTextColour());
200 if ( source.HasBackgroundColour() )
201 SetBackgroundColour(source.GetBackgroundColour());
202 if ( source.HasFont() )
203 SetFont(source.GetFont());
204 }
205
206private:
207 wxColour m_colText,
208 m_colBack;
209 wxFont m_font;
210};
211
212// ----------------------------------------------------------------------------
213// wxListItem: the item or column info, used to exchange data with wxListCtrl
214// ----------------------------------------------------------------------------
215
216class WXDLLIMPEXP_CORE wxListItem : public wxObject
217{
218public:
219 wxListItem() { Init(); m_attr = NULL; }
220 wxListItem(const wxListItem& item)
221 : wxObject(),
222 m_mask(item.m_mask),
223 m_itemId(item.m_itemId),
224 m_col(item.m_col),
225 m_state(item.m_state),
226 m_stateMask(item.m_stateMask),
227 m_text(item.m_text),
228 m_image(item.m_image),
229 m_data(item.m_data),
230 m_format(item.m_format),
231 m_width(item.m_width),
232 m_attr(NULL)
233 {
234 // copy list item attributes
235 if ( item.HasAttributes() )
236 m_attr = new wxListItemAttr(*item.GetAttributes());
237 }
238
239 wxListItem& operator=(const wxListItem& item)
240 {
241 if ( &item != this )
242 {
243 m_mask = item.m_mask;
244 m_itemId = item.m_itemId;
245 m_col = item.m_col;
246 m_state = item.m_state;
247 m_stateMask = item.m_stateMask;
248 m_text = item.m_text;
249 m_image = item.m_image;
250 m_data = item.m_data;
251 m_format = item.m_format;
252 m_width = item.m_width;
253 m_attr = item.m_attr ? new wxListItemAttr(*item.m_attr) : NULL;
254 }
255
256 return *this;
257 }
258
259 virtual ~wxListItem() { delete m_attr; }
260
261 // resetting
262 void Clear() { Init(); m_text.clear(); ClearAttributes(); }
263 void ClearAttributes() { if ( m_attr ) { delete m_attr; m_attr = NULL; } }
264
265 // setters
266 void SetMask(long mask)
267 { m_mask = mask; }
268 void SetId(long id)
269 { m_itemId = id; }
270 void SetColumn(int col)
271 { m_col = col; }
272 void SetState(long state)
273 { m_mask |= wxLIST_MASK_STATE; m_state = state; m_stateMask |= state; }
274 void SetStateMask(long stateMask)
275 { m_stateMask = stateMask; }
276 void SetText(const wxString& text)
277 { m_mask |= wxLIST_MASK_TEXT; m_text = text; }
278 void SetImage(int image)
279 { m_mask |= wxLIST_MASK_IMAGE; m_image = image; }
280 void SetData(long data)
281 { m_mask |= wxLIST_MASK_DATA; m_data = data; }
282 void SetData(void *data)
283 { m_mask |= wxLIST_MASK_DATA; m_data = wxPtrToUInt(data); }
284
285 void SetWidth(int width)
286 { m_mask |= wxLIST_MASK_WIDTH; m_width = width; }
287 void SetAlign(wxListColumnFormat align)
288 { m_mask |= wxLIST_MASK_FORMAT; m_format = align; }
289
290 void SetTextColour(const wxColour& colText)
291 { Attributes().SetTextColour(colText); }
292 void SetBackgroundColour(const wxColour& colBack)
293 { Attributes().SetBackgroundColour(colBack); }
294 void SetFont(const wxFont& font)
295 { Attributes().SetFont(font); }
296
297 // accessors
298 long GetMask() const { return m_mask; }
299 long GetId() const { return m_itemId; }
300 int GetColumn() const { return m_col; }
301 long GetState() const { return m_state & m_stateMask; }
302 const wxString& GetText() const { return m_text; }
303 int GetImage() const { return m_image; }
304 wxUIntPtr GetData() const { return m_data; }
305
306 int GetWidth() const { return m_width; }
307 wxListColumnFormat GetAlign() const { return (wxListColumnFormat)m_format; }
308
309 wxListItemAttr *GetAttributes() const { return m_attr; }
310 bool HasAttributes() const { return m_attr != NULL; }
311
312 wxColour GetTextColour() const
313 { return HasAttributes() ? m_attr->GetTextColour() : wxNullColour; }
314 wxColour GetBackgroundColour() const
315 { return HasAttributes() ? m_attr->GetBackgroundColour()
316 : wxNullColour; }
317 wxFont GetFont() const
318 { return HasAttributes() ? m_attr->GetFont() : wxNullFont; }
319
320 // this conversion is necessary to make old code using GetItem() to
321 // compile
322 operator long() const { return m_itemId; }
323
324 // these members are public for compatibility
325
326 long m_mask; // Indicates what fields are valid
327 long m_itemId; // The zero-based item position
328 int m_col; // Zero-based column, if in report mode
329 long m_state; // The state of the item
330 long m_stateMask;// Which flags of m_state are valid (uses same flags)
331 wxString m_text; // The label/header text
332 int m_image; // The zero-based index into an image list
333 wxUIntPtr m_data; // App-defined data
334
335 // For columns only
336 int m_format; // left, right, centre
337 int m_width; // width of column
338
339#ifdef __WXPM__
340 int m_miniImage; // handle to the mini image for OS/2
341#endif
342
343protected:
344 // creates m_attr if we don't have it yet
345 wxListItemAttr& Attributes()
346 {
347 if ( !m_attr )
348 m_attr = new wxListItemAttr;
349
350 return *m_attr;
351 }
352
353 void Init()
354 {
355 m_mask = 0;
356 m_itemId = 0;
357 m_col = 0;
358 m_state = 0;
359 m_stateMask = 0;
360 m_image = -1;
361 m_data = 0;
362
363 m_format = wxLIST_FORMAT_CENTRE;
364 m_width = 0;
365 }
366
367 wxListItemAttr *m_attr; // optional pointer to the items style
368
369private:
370 DECLARE_DYNAMIC_CLASS(wxListItem)
371};
372
373// ----------------------------------------------------------------------------
374// wxListEvent - the event class for the wxListCtrl notifications
375// ----------------------------------------------------------------------------
376
377class WXDLLIMPEXP_CORE wxListEvent : public wxNotifyEvent
378{
379public:
380 wxListEvent(wxEventType commandType = wxEVT_NULL, int winid = 0)
381 : wxNotifyEvent(commandType, winid)
382 , m_code(0)
383 , m_oldItemIndex(0)
384 , m_itemIndex(0)
385 , m_col(0)
386 , m_pointDrag()
387 , m_item()
388 , m_editCancelled(false)
389 { }
390
391 wxListEvent(const wxListEvent& event)
392 : wxNotifyEvent(event)
393 , m_code(event.m_code)
394 , m_oldItemIndex(event.m_oldItemIndex)
395 , m_itemIndex(event.m_itemIndex)
396 , m_col(event.m_col)
397 , m_pointDrag(event.m_pointDrag)
398 , m_item(event.m_item)
399 , m_editCancelled(event.m_editCancelled)
400 { }
401
402 int GetKeyCode() const { return m_code; }
403 long GetIndex() const { return m_itemIndex; }
404 int GetColumn() const { return m_col; }
405 wxPoint GetPoint() const { return m_pointDrag; }
406 const wxString& GetLabel() const { return m_item.m_text; }
407 const wxString& GetText() const { return m_item.m_text; }
408 int GetImage() const { return m_item.m_image; }
409 long GetData() const { return static_cast<long>(m_item.m_data); }
410 long GetMask() const { return m_item.m_mask; }
411 const wxListItem& GetItem() const { return m_item; }
412
413 // for wxEVT_COMMAND_LIST_CACHE_HINT only
414 long GetCacheFrom() const { return m_oldItemIndex; }
415 long GetCacheTo() const { return m_itemIndex; }
416
417 // was label editing canceled? (for wxEVT_COMMAND_LIST_END_LABEL_EDIT only)
418 bool IsEditCancelled() const { return m_editCancelled; }
419 void SetEditCanceled(bool editCancelled) { m_editCancelled = editCancelled; }
420
421 virtual wxEvent *Clone() const { return new wxListEvent(*this); }
422
423//protected: -- not for backwards compatibility
424 int m_code;
425 long m_oldItemIndex; // only for wxEVT_COMMAND_LIST_CACHE_HINT
426 long m_itemIndex;
427 int m_col;
428 wxPoint m_pointDrag;
429
430 wxListItem m_item;
431
432protected:
433 bool m_editCancelled;
434
435private:
436 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxListEvent)
437};
438
439// ----------------------------------------------------------------------------
440// wxListCtrl event macros
441// ----------------------------------------------------------------------------
442
443extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_LIST_BEGIN_DRAG;
444extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_LIST_BEGIN_RDRAG;
445extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT;
446extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_LIST_END_LABEL_EDIT;
447extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_LIST_DELETE_ITEM;
448extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_LIST_DELETE_ALL_ITEMS;
449
450extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_LIST_ITEM_SELECTED;
451extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_LIST_ITEM_DESELECTED;
452extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_LIST_KEY_DOWN;
453extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_LIST_INSERT_ITEM;
454extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_LIST_COL_CLICK;
455extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK;
456extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_LIST_ITEM_MIDDLE_CLICK;
457extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_LIST_ITEM_ACTIVATED;
458extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_LIST_CACHE_HINT;
459extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_LIST_COL_RIGHT_CLICK;
460extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_LIST_COL_BEGIN_DRAG;
461extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_LIST_COL_DRAGGING;
462extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_LIST_COL_END_DRAG;
463extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_LIST_ITEM_FOCUSED;
464
465typedef void (wxEvtHandler::*wxListEventFunction)(wxListEvent&);
466
467#define wxListEventHandler(func) \
468 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxListEventFunction, &func)
469
470#define wx__DECLARE_LISTEVT(evt, id, fn) \
471 wx__DECLARE_EVT1(wxEVT_COMMAND_LIST_ ## evt, id, wxListEventHandler(fn))
472
473#define EVT_LIST_BEGIN_DRAG(id, fn) wx__DECLARE_LISTEVT(BEGIN_DRAG, id, fn)
474#define EVT_LIST_BEGIN_RDRAG(id, fn) wx__DECLARE_LISTEVT(BEGIN_RDRAG, id, fn)
475#define EVT_LIST_BEGIN_LABEL_EDIT(id, fn) wx__DECLARE_LISTEVT(BEGIN_LABEL_EDIT, id, fn)
476#define EVT_LIST_END_LABEL_EDIT(id, fn) wx__DECLARE_LISTEVT(END_LABEL_EDIT, id, fn)
477#define EVT_LIST_DELETE_ITEM(id, fn) wx__DECLARE_LISTEVT(DELETE_ITEM, id, fn)
478#define EVT_LIST_DELETE_ALL_ITEMS(id, fn) wx__DECLARE_LISTEVT(DELETE_ALL_ITEMS, id, fn)
479#define EVT_LIST_KEY_DOWN(id, fn) wx__DECLARE_LISTEVT(KEY_DOWN, id, fn)
480#define EVT_LIST_INSERT_ITEM(id, fn) wx__DECLARE_LISTEVT(INSERT_ITEM, id, fn)
481
482#define EVT_LIST_COL_CLICK(id, fn) wx__DECLARE_LISTEVT(COL_CLICK, id, fn)
483#define EVT_LIST_COL_RIGHT_CLICK(id, fn) wx__DECLARE_LISTEVT(COL_RIGHT_CLICK, id, fn)
484#define EVT_LIST_COL_BEGIN_DRAG(id, fn) wx__DECLARE_LISTEVT(COL_BEGIN_DRAG, id, fn)
485#define EVT_LIST_COL_DRAGGING(id, fn) wx__DECLARE_LISTEVT(COL_DRAGGING, id, fn)
486#define EVT_LIST_COL_END_DRAG(id, fn) wx__DECLARE_LISTEVT(COL_END_DRAG, id, fn)
487
488#define EVT_LIST_ITEM_SELECTED(id, fn) wx__DECLARE_LISTEVT(ITEM_SELECTED, id, fn)
489#define EVT_LIST_ITEM_DESELECTED(id, fn) wx__DECLARE_LISTEVT(ITEM_DESELECTED, id, fn)
490#define EVT_LIST_ITEM_RIGHT_CLICK(id, fn) wx__DECLARE_LISTEVT(ITEM_RIGHT_CLICK, id, fn)
491#define EVT_LIST_ITEM_MIDDLE_CLICK(id, fn) wx__DECLARE_LISTEVT(ITEM_MIDDLE_CLICK, id, fn)
492#define EVT_LIST_ITEM_ACTIVATED(id, fn) wx__DECLARE_LISTEVT(ITEM_ACTIVATED, id, fn)
493#define EVT_LIST_ITEM_FOCUSED(id, fn) wx__DECLARE_LISTEVT(ITEM_FOCUSED, id, fn)
494
495#define EVT_LIST_CACHE_HINT(id, fn) wx__DECLARE_LISTEVT(CACHE_HINT, id, fn)
496
497
498#endif
499 // _WX_LISTCTRL_H_BASE_
wxWidgets (Impactor)