1 ///////////////////////////////////////////////////////////////////////////////
3 // Purpose: wxListCtrl class
4 // Author: Vadim Zeitlin
8 // Copyright: (c) wxWindows team
9 // Licence: wxWindows licence
10 ///////////////////////////////////////////////////////////////////////////////
12 #ifndef _WX_LISTBASE_H_BASE_
13 #define _WX_LISTBASE_H_BASE_
15 #if defined(__GNUG__) && !defined(__APPLE__)
16 // #pragma interface "listctrlbase.h"
21 // ----------------------------------------------------------------------------
23 // ----------------------------------------------------------------------------
25 // type of compare function for wxListCtrl sort operation
26 typedef int (wxCALLBACK
*wxListCtrlCompare
)(long item1
, long item2
, long sortData
);
28 // ----------------------------------------------------------------------------
29 // wxListCtrl constants
30 // ----------------------------------------------------------------------------
33 #define wxLC_VRULES 0x0001
34 #define wxLC_HRULES 0x0002
36 #define wxLC_ICON 0x0004
37 #define wxLC_SMALL_ICON 0x0008
38 #define wxLC_LIST 0x0010
39 #define wxLC_REPORT 0x0020
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
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)
56 // for compatibility only
57 #define wxLC_USER_TEXT wxLC_VIRTUAL
60 // (a) too much detail
61 // (b) not enough style flags
62 // (c) not implemented anyhow in the generic version
64 // #define wxLC_NO_SCROLL
65 // #define wxLC_NO_LABEL_WRAP
66 // #define wxLC_OWNERDRAW_FIXED
67 // #define wxLC_SHOW_SEL_ALWAYS
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
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 #define wxLIST_STATE_DISABLED 0x0010 // OS2 only
85 #define wxLIST_STATE_FILTERED 0x0020 // OS2 only
86 #define wxLIST_STATE_INUSE 0x0040 // OS2 only
87 #define wxLIST_STATE_PICKED 0x0080 // OS2 only
88 #define wxLIST_STATE_SOURCE 0x0100 // OS2 only
90 // Hit test flags, used in HitTest
91 #define wxLIST_HITTEST_ABOVE 0x0001 // Above the client area.
92 #define wxLIST_HITTEST_BELOW 0x0002 // Below the client area.
93 #define wxLIST_HITTEST_NOWHERE 0x0004 // In the client area but below the last item.
94 #define wxLIST_HITTEST_ONITEMICON 0x0020 // On the bitmap associated with an item.
95 #define wxLIST_HITTEST_ONITEMLABEL 0x0080 // On the label (string) associated with an item.
96 #define wxLIST_HITTEST_ONITEMRIGHT 0x0100 // In the area to the right of an item.
97 #define wxLIST_HITTEST_ONITEMSTATEICON 0x0200 // On the state icon for a tree view item that is in a user-defined state.
98 #define wxLIST_HITTEST_TOLEFT 0x0400 // To the left of the client area.
99 #define wxLIST_HITTEST_TORIGHT 0x0800 // To the right of the client area.
101 #define wxLIST_HITTEST_ONITEM (wxLIST_HITTEST_ONITEMICON | wxLIST_HITTEST_ONITEMLABEL | wxLIST_HITTEST_ONITEMSTATEICON)
103 // Flags for GetNextItem (MSW only except wxLIST_NEXT_ALL)
106 wxLIST_NEXT_ABOVE
, // Searches for an item above the specified item
107 wxLIST_NEXT_ALL
, // Searches for subsequent item by index
108 wxLIST_NEXT_BELOW
, // Searches for an item below the specified item
109 wxLIST_NEXT_LEFT
, // Searches for an item to the left of the specified item
110 wxLIST_NEXT_RIGHT
// Searches for an item to the right of the specified item
113 // Alignment flags for Arrange (MSW only except wxLIST_ALIGN_LEFT)
116 wxLIST_ALIGN_DEFAULT
,
119 wxLIST_ALIGN_SNAP_TO_GRID
122 // Column format (MSW only except wxLIST_FORMAT_LEFT)
123 enum wxListColumnFormat
127 wxLIST_FORMAT_CENTRE
,
128 wxLIST_FORMAT_CENTER
= wxLIST_FORMAT_CENTRE
131 // Autosize values for SetColumnWidth
134 wxLIST_AUTOSIZE
= -1,
135 wxLIST_AUTOSIZE_USEHEADER
= -2 // partly supported by generic version
138 // Flag values for GetItemRect
146 // Flag values for FindItem (MSW only)
155 // ----------------------------------------------------------------------------
156 // wxListItemAttr: a structure containing the visual attributes of an item
157 // ----------------------------------------------------------------------------
159 class WXDLLEXPORT wxListItemAttr
164 wxListItemAttr(const wxColour
& colText
,
165 const wxColour
& colBack
,
167 : m_colText(colText
), m_colBack(colBack
), m_font(font
) { }
170 void SetTextColour(const wxColour
& colText
) { m_colText
= colText
; }
171 void SetBackgroundColour(const wxColour
& colBack
) { m_colBack
= colBack
; }
172 void SetFont(const wxFont
& font
) { m_font
= font
; }
175 bool HasTextColour() const { return m_colText
.Ok(); }
176 bool HasBackgroundColour() const { return m_colBack
.Ok(); }
177 bool HasFont() const { return m_font
.Ok(); }
179 const wxColour
& GetTextColour() const { return m_colText
; }
180 const wxColour
& GetBackgroundColour() const { return m_colBack
; }
181 const wxFont
& GetFont() const { return m_font
; }
189 // ----------------------------------------------------------------------------
190 // wxListItem: the item or column info, used to exchange data with wxListCtrl
191 // ----------------------------------------------------------------------------
193 class WXDLLEXPORT wxListItem
: public wxObject
196 wxListItem() { Init(); m_attr
= NULL
; }
197 wxListItem(const wxListItem
& item
)
200 m_itemId(item
.m_itemId
),
202 m_state(item
.m_state
),
203 m_stateMask(item
.m_stateMask
),
205 m_image(item
.m_image
),
207 m_format(item
.m_format
),
208 m_width(item
.m_width
),
211 // copy list item attributes
212 if( item
.HasAttributes() )
213 m_attr
= new wxListItemAttr(*item
.GetAttributes());
215 virtual ~wxListItem() { delete m_attr
; }
218 void Clear() { Init(); m_text
.clear(); ClearAttributes(); }
219 void ClearAttributes() { if ( m_attr
) { delete m_attr
; m_attr
= NULL
; } }
222 void SetMask(long mask
)
226 void SetColumn(int col
)
228 void SetState(long state
)
229 { m_mask
|= wxLIST_MASK_STATE
; m_state
= state
; m_stateMask
|= state
; }
230 void SetStateMask(long stateMask
)
231 { m_stateMask
= stateMask
; }
232 void SetText(const wxString
& text
)
233 { m_mask
|= wxLIST_MASK_TEXT
; m_text
= text
; }
234 void SetImage(int image
)
235 { m_mask
|= wxLIST_MASK_IMAGE
; m_image
= image
; }
236 void SetData(long data
)
237 { m_mask
|= wxLIST_MASK_DATA
; m_data
= data
; }
238 void SetData(void *data
)
239 { m_mask
|= wxLIST_MASK_DATA
; m_data
= (long)data
; }
241 void SetWidth(int width
)
242 { m_mask
|= wxLIST_MASK_WIDTH
; m_width
= width
; }
243 void SetAlign(wxListColumnFormat align
)
244 { m_mask
|= wxLIST_MASK_FORMAT
; m_format
= align
; }
246 void SetTextColour(const wxColour
& colText
)
247 { Attributes().SetTextColour(colText
); }
248 void SetBackgroundColour(const wxColour
& colBack
)
249 { Attributes().SetBackgroundColour(colBack
); }
250 void SetFont(const wxFont
& font
)
251 { Attributes().SetFont(font
); }
254 long GetMask() const { return m_mask
; }
255 long GetId() const { return m_itemId
; }
256 int GetColumn() const { return m_col
; }
257 long GetState() const { return m_state
& m_stateMask
; }
258 const wxString
& GetText() const { return m_text
; }
259 int GetImage() const { return m_image
; }
260 long GetData() const { return m_data
; }
262 int GetWidth() const { return m_width
; }
263 wxListColumnFormat
GetAlign() const { return (wxListColumnFormat
)m_format
; }
265 wxListItemAttr
*GetAttributes() const { return m_attr
; }
266 bool HasAttributes() const { return m_attr
!= NULL
; }
268 wxColour
GetTextColour() const
269 { return HasAttributes() ? m_attr
->GetTextColour() : wxNullColour
; }
270 wxColour
GetBackgroundColour() const
271 { return HasAttributes() ? m_attr
->GetBackgroundColour()
273 wxFont
GetFont() const
274 { return HasAttributes() ? m_attr
->GetFont() : wxNullFont
; }
276 // this conversion is necessary to make old code using GetItem() to
278 operator long() const { return m_itemId
; }
280 // these members are public for compatibility
282 long m_mask
; // Indicates what fields are valid
283 long m_itemId
; // The zero-based item position
284 int m_col
; // Zero-based column, if in report mode
285 long m_state
; // The state of the item
286 long m_stateMask
;// Which flags of m_state are valid (uses same flags)
287 wxString m_text
; // The label/header text
288 int m_image
; // The zero-based index into an image list
289 long m_data
; // App-defined data
292 int m_format
; // left, right, centre
293 int m_width
; // width of column
296 int m_miniImage
; // handle to the mini image for OS/2
300 // creates m_attr if we don't have it yet
301 wxListItemAttr
& Attributes()
304 m_attr
= new wxListItemAttr
;
319 m_format
= wxLIST_FORMAT_CENTRE
;
323 wxListItemAttr
*m_attr
; // optional pointer to the items style
326 // VZ: this is strange, we have a copy ctor but not operator=(), why?
327 wxListItem
& operator=(const wxListItem
& item
);
329 DECLARE_DYNAMIC_CLASS(wxListItem
)
332 // ----------------------------------------------------------------------------
333 // wxListEvent - the event class for the wxListCtrl notifications
334 // ----------------------------------------------------------------------------
336 class WXDLLEXPORT wxListEvent
: public wxNotifyEvent
339 wxListEvent(wxEventType commandType
= wxEVT_NULL
, int id
= 0)
340 : wxNotifyEvent(commandType
, id
)
349 wxListEvent(const wxListEvent
& event
)
350 : wxNotifyEvent(event
)
351 , m_code(event
.m_code
)
352 , m_oldItemIndex(event
.m_oldItemIndex
)
353 , m_itemIndex(event
.m_itemIndex
)
355 , m_pointDrag(event
.m_pointDrag
)
356 , m_item(event
.m_item
)
359 int GetKeyCode() const { return m_code
; }
360 long GetIndex() const { return m_itemIndex
; }
361 int GetColumn() const { return m_col
; }
362 wxPoint
GetPoint() const { return m_pointDrag
; }
363 const wxString
& GetLabel() const { return m_item
.m_text
; }
364 const wxString
& GetText() const { return m_item
.m_text
; }
365 int GetImage() const { return m_item
.m_image
; }
366 long GetData() const { return m_item
.m_data
; }
367 long GetMask() const { return m_item
.m_mask
; }
368 const wxListItem
& GetItem() const { return m_item
; }
370 // for wxEVT_COMMAND_LIST_CACHE_HINT only
371 long GetCacheFrom() const { return m_oldItemIndex
; }
372 long GetCacheTo() const { return m_itemIndex
; }
374 #if WXWIN_COMPATIBILITY_2_2
375 // these methods don't do anything at all
376 long GetOldIndex() const { return 0; }
377 long GetOldItem() const { return 0; }
379 // this one is superseded by GetKeyCode()
380 int GetCode() const { return GetKeyCode(); }
381 #endif // WXWIN_COMPATIBILITY_2_2
383 virtual wxEvent
*Clone() const { return new wxListEvent(*this); }
385 //protected: -- not for backwards compatibility
387 long m_oldItemIndex
; // only for wxEVT_COMMAND_LIST_CACHE_HINT
395 DECLARE_DYNAMIC_CLASS(wxListEvent
)
398 // ----------------------------------------------------------------------------
399 // wxListCtrl event macros
400 // ----------------------------------------------------------------------------
402 BEGIN_DECLARE_EVENT_TYPES()
403 DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_BEGIN_DRAG
, 700)
404 DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_BEGIN_RDRAG
, 701)
405 DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT
, 702)
406 DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_END_LABEL_EDIT
, 703)
407 DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_DELETE_ITEM
, 704)
408 DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_DELETE_ALL_ITEMS
, 705)
409 DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_GET_INFO
, 706)
410 DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_SET_INFO
, 707)
411 DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_SELECTED
, 708)
412 DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_DESELECTED
, 709)
413 DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_KEY_DOWN
, 710)
414 DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_INSERT_ITEM
, 711)
415 DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_COL_CLICK
, 712)
416 DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK
, 713)
417 DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_MIDDLE_CLICK
, 714)
418 DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_ACTIVATED
, 715)
419 DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_CACHE_HINT
, 716)
420 DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_COL_RIGHT_CLICK
, 717)
421 DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_COL_BEGIN_DRAG
, 718)
422 DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_COL_DRAGGING
, 719)
423 DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_COL_END_DRAG
, 720)
424 DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_FOCUSED
, 721)
425 END_DECLARE_EVENT_TYPES()
427 typedef void (wxEvtHandler::*wxListEventFunction
)(wxListEvent
&);
429 #define EVT_LIST_BEGIN_DRAG(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LIST_BEGIN_DRAG, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL ),
430 #define EVT_LIST_BEGIN_RDRAG(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LIST_BEGIN_RDRAG, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL ),
431 #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 ),
432 #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 ),
433 #define EVT_LIST_DELETE_ITEM(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LIST_DELETE_ITEM, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL ),
434 #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 ),
435 #define EVT_LIST_GET_INFO(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LIST_GET_INFO, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL ),
436 #define EVT_LIST_SET_INFO(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LIST_SET_INFO, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL ),
437 #define EVT_LIST_KEY_DOWN(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LIST_KEY_DOWN, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL ),
438 #define EVT_LIST_INSERT_ITEM(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LIST_INSERT_ITEM, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL ),
440 #define EVT_LIST_COL_CLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LIST_COL_CLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL ),
441 #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 ),
442 #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 ),
443 #define EVT_LIST_COL_DRAGGING(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LIST_COL_DRAGGING, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL ),
444 #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 ),
446 #define EVT_LIST_ITEM_SELECTED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LIST_ITEM_SELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL ),
447 #define EVT_LIST_ITEM_DESELECTED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LIST_ITEM_DESELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL ),
448 #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 ),
449 #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 ),
450 #define EVT_LIST_ITEM_ACTIVATED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LIST_ITEM_ACTIVATED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, (wxObject *) NULL ),
451 #define EVT_LIST_ITEM_FOCUSED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LIST_ITEM_FOCUSED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, (wxObject *) NULL ),
453 #define EVT_LIST_CACHE_HINT(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LIST_CACHE_HINT, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, (wxObject *) NULL ),
455 #endif // wxUSE_LISTCTRL
458 // _WX_LISTCTRL_H_BASE_