include/wx/listctrl.h

   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_LISTCTRL_H_BASE_
  13 #define _WX_LISTCTRL_H_BASE_
  14
  15 #ifdef __GNUG__
  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
  26 typedef int (wxCALLBACK *wxListCtrlCompare)(long item1, long item2, long sortData);
  27
  28 // ----------------------------------------------------------------------------
  29 // wxListCtrl constants
  30 // ----------------------------------------------------------------------------
  31
  32 // Mask flags to tell app/GUI what fields of wxListItem are valid
  33 #define wxLIST_MASK_STATE           0x0001
  34 #define wxLIST_MASK_TEXT            0x0002
  35 #define wxLIST_MASK_IMAGE           0x0004
  36 #define wxLIST_MASK_DATA            0x0008
  37 #define wxLIST_SET_ITEM             0x0010
  38 #define wxLIST_MASK_WIDTH           0x0020
  39 #define wxLIST_MASK_FORMAT          0x0040
  40
  41 // State flags for indicating the state of an item
  42 #define wxLIST_STATE_DONTCARE       0x0000
  43 #define wxLIST_STATE_DROPHILITED    0x0001      // MSW only
  44 #define wxLIST_STATE_FOCUSED        0x0002
  45 #define wxLIST_STATE_SELECTED       0x0004
  46 #define wxLIST_STATE_CUT            0x0008      // MSW only
  47
  48 // Hit test flags, used in HitTest
  49 #define wxLIST_HITTEST_ABOVE            0x0001  // Above the client area.
  50 #define wxLIST_HITTEST_BELOW            0x0002  // Below the client area.
  51 #define wxLIST_HITTEST_NOWHERE          0x0004  // In the client area but below the last item.
  52 #define wxLIST_HITTEST_ONITEMICON       0x0020  // On the bitmap associated with an item.
  53 #define wxLIST_HITTEST_ONITEMLABEL      0x0080  // On the label (string) associated with an item.
  54 #define wxLIST_HITTEST_ONITEMRIGHT      0x0100  // In the area to the right of an item.
  55 #define wxLIST_HITTEST_ONITEMSTATEICON  0x0200  // On the state icon for a tree view item that is in a user-defined state.
  56 #define wxLIST_HITTEST_TOLEFT           0x0400  // To the left of the client area.
  57 #define wxLIST_HITTEST_TORIGHT          0x0800  // To the right of the client area.
  58
  59 #define wxLIST_HITTEST_ONITEM (wxLIST_HITTEST_ONITEMICON | wxLIST_HITTEST_ONITEMLABEL | wxLIST_HITTEST_ONITEMSTATEICON)
  60
  61 // Flags for GetNextItem (MSW only except wxLIST_NEXT_ALL)
  62 enum
  63 {
  64     wxLIST_NEXT_ABOVE,          // Searches for an item above the specified item
  65     wxLIST_NEXT_ALL,            // Searches for subsequent item by index
  66     wxLIST_NEXT_BELOW,          // Searches for an item below the specified item
  67     wxLIST_NEXT_LEFT,           // Searches for an item to the left of the specified item
  68     wxLIST_NEXT_RIGHT           // Searches for an item to the right of the specified item
  69 };
  70
  71 // Alignment flags for Arrange (MSW only except wxLIST_ALIGN_LEFT)
  72 enum
  73 {
  74     wxLIST_ALIGN_DEFAULT,
  75     wxLIST_ALIGN_LEFT,
  76     wxLIST_ALIGN_TOP,
  77     wxLIST_ALIGN_SNAP_TO_GRID
  78 };
  79
  80 // Column format (MSW only except wxLIST_FORMAT_LEFT)
  81 enum wxListColumnFormat
  82 {
  83     wxLIST_FORMAT_LEFT,
  84     wxLIST_FORMAT_RIGHT,
  85     wxLIST_FORMAT_CENTRE,
  86     wxLIST_FORMAT_CENTER = wxLIST_FORMAT_CENTRE
  87 };
  88
  89 // Autosize values for SetColumnWidth
  90 enum
  91 {
  92     wxLIST_AUTOSIZE = -1,
  93     wxLIST_AUTOSIZE_USEHEADER = -2      // partly supported by generic version
  94 };
  95
  96 // Flag values for GetItemRect
  97 enum
  98 {
  99     wxLIST_RECT_BOUNDS,
 100     wxLIST_RECT_ICON,
 101     wxLIST_RECT_LABEL
 102 };
 103
 104 // Flag values for FindItem (MSW only)
 105 enum
 106 {
 107     wxLIST_FIND_UP,
 108     wxLIST_FIND_DOWN,
 109     wxLIST_FIND_LEFT,
 110     wxLIST_FIND_RIGHT
 111 };
 112
 113 // ----------------------------------------------------------------------------
 114 // wxListItemAttr: a structure containing the visual attributes of an item
 115 // ----------------------------------------------------------------------------
 116
 117 class WXDLLEXPORT wxListItemAttr
 118 {
 119 public:
 120     // ctors
 121     wxListItemAttr() { }
 122     wxListItemAttr(const wxColour& colText,
 123                    const wxColour& colBack,
 124                    const wxFont& font)
 125         : m_colText(colText), m_colBack(colBack), m_font(font) { }
 126
 127     // setters
 128     void SetTextColour(const wxColour& colText) { m_colText = colText; }
 129     void SetBackgroundColour(const wxColour& colBack) { m_colBack = colBack; }
 130     void SetFont(const wxFont& font) { m_font = font; }
 131
 132     // accessors
 133     bool HasTextColour() const { return m_colText.Ok(); }
 134     bool HasBackgroundColour() const { return m_colBack.Ok(); }
 135     bool HasFont() const { return m_font.Ok(); }
 136
 137     const wxColour& GetTextColour() const { return m_colText; }
 138     const wxColour& GetBackgroundColour() const { return m_colBack; }
 139     const wxFont& GetFont() const { return m_font; }
 140
 141 private:
 142     wxColour m_colText,
 143              m_colBack;
 144     wxFont   m_font;
 145 };
 146
 147 // ----------------------------------------------------------------------------
 148 // wxListItem: the item or column info, used to exchange data with wxListCtrl
 149 // ----------------------------------------------------------------------------
 150
 151 class WXDLLEXPORT wxListItem : public wxObject
 152 {
 153 public:
 154     wxListItem();
 155     ~wxListItem() { delete m_attr; }
 156
 157     // resetting
 158     void Clear();
 159     void ClearAttributes();
 160
 161     // setters
 162     void SetMask(long mask) { m_mask = mask; }
 163     void SetId(long id) { m_itemId = id; }
 164     void SetColumn(int col) { m_col = col; }
 165     void SetState(long state) { m_state = state; m_stateMask |= state; }
 166     void SetStateMask(long stateMask) { m_stateMask = stateMask; }
 167     void SetText(const wxString& text) { m_text = text; }
 168     void SetImage(int image) { m_image = image; }
 169     void SetData(long data) { m_data = data; }
 170     void SetData(void *data) { m_data = (long)data; }
 171
 172     void SetWidth(int width) { m_width = width; }
 173     void SetAlign(wxListColumnFormat align) { m_format = align; }
 174
 175     void SetTextColour(const wxColour& colText)
 176         { Attributes().SetTextColour(colText); }
 177     void SetBackgroundColour(const wxColour& colBack)
 178         { Attributes().SetBackgroundColour(colBack); }
 179     void SetFont(const wxFont& font)
 180         { Attributes().SetFont(font); }
 181
 182     // accessors
 183     long GetMask() const { return m_mask; }
 184     long GetId() const { return m_itemId; }
 185     int GetColumn() const { return m_col; }
 186     long GetState() const { return m_state & m_stateMask; }
 187     const wxString& GetText() const { return m_text; }
 188     int GetImage() const { return m_image; }
 189     long GetData() const { return m_data; }
 190
 191     int GetWidth() const { return m_width; }
 192     wxListColumnFormat GetAlign() const { return (wxListColumnFormat)m_format; }
 193
 194     wxListItemAttr *GetAttributes() const { return m_attr; }
 195     bool HasAttributes() const { return m_attr != NULL; }
 196
 197     wxColour GetTextColour() const
 198         { return HasAttributes() ? m_attr->GetTextColour() : wxNullColour; }
 199     wxColour GetBackgroundColour() const
 200         { return HasAttributes() ? m_attr->GetBackgroundColour()
 201                                  : wxNullColour; }
 202     wxFont GetFont() const
 203         { return HasAttributes() ? m_attr->GetFont() : wxNullFont; }
 204
 205     // this conversion is necessary to make old code using GetItem() to
 206     // compile
 207     operator long() const { return m_itemId; }
 208
 209     // these members are public for compatibility
 210
 211     long            m_mask;     // Indicates what fields are valid
 212     long            m_itemId;   // The zero-based item position
 213     int             m_col;      // Zero-based column, if in report mode
 214     long            m_state;    // The state of the item
 215     long            m_stateMask;// Which flags of m_state are valid (uses same flags)
 216     wxString        m_text;     // The label/header text
 217     int             m_image;    // The zero-based index into an image list
 218     long            m_data;     // App-defined data
 219
 220     // For columns only
 221     int             m_format;   // left, right, centre
 222     int             m_width;    // width of column
 223
 224 protected:
 225     // creates m_attr if we don't have it yet
 226     wxListItemAttr& Attributes()
 227     {
 228         if ( !m_attr )
 229             m_attr = new wxListItemAttr;
 230
 231         return *m_attr;
 232     }
 233
 234     wxListItemAttr *m_attr;     // optional pointer to the items style
 235
 236 private:
 237     DECLARE_DYNAMIC_CLASS(wxListItem)
 238 };
 239
 240 // ----------------------------------------------------------------------------
 241 // include the wxListCtrl class declaration
 242 // ----------------------------------------------------------------------------
 243
 244 #if defined(__WXUNIVERSAL__)
 245     #include "wx/generic/listctrl.h"
 246 #elif defined(__WXMSW__)
 247     #ifdef __WIN16__
 248         #include "wx/generic/listctrl.h"
 249     #else
 250         #include "wx/msw/listctrl.h"
 251     #endif
 252 #elif defined(__WXMOTIF__)
 253     #include "wx/generic/listctrl.h"
 254 #elif defined(__WXGTK__)
 255     #include "wx/generic/listctrl.h"
 256 #elif defined(__WXQT__)
 257     #include "wx/generic/listctrl.h"
 258 #elif defined(__WXMAC__)
 259     #include "wx/generic/listctrl.h"
 260 #elif defined(__WXPM__)
 261     #include "wx/generic/listctrl.h"
 262 #elif defined(__WXSTUBS__)
 263     #include "wx/generic/listctrl.h"
 264 #endif
 265
 266 // ----------------------------------------------------------------------------
 267 // wxListEvent - the event class for the wxListCtrl notifications
 268 // ----------------------------------------------------------------------------
 269
 270 class WXDLLEXPORT wxListEvent : public wxNotifyEvent
 271 {
 272 public:
 273     wxListEvent(wxEventType commandType = wxEVT_NULL, int id = 0);
 274
 275     int           m_code;
 276     long          m_itemIndex;
 277     long          m_oldItemIndex;
 278     int           m_col;
 279     bool          m_cancelled;
 280     wxPoint       m_pointDrag;
 281
 282     wxListItem    m_item;
 283
 284     int GetCode() const { return m_code; }
 285     long GetIndex() const { return m_itemIndex; }
 286     long GetOldIndex() const { return m_oldItemIndex; }
 287     long GetOldItem() const { return m_oldItemIndex; }
 288     int GetColumn() const { return m_col; }
 289     bool Cancelled() const { return m_cancelled; }
 290     wxPoint GetPoint() const { return m_pointDrag; }
 291     const wxString& GetLabel() const { return m_item.m_text; }
 292     const wxString& GetText() const { return m_item.m_text; }
 293     int GetImage() const { return m_item.m_image; }
 294     long GetData() const { return m_item.m_data; }
 295     long GetMask() const { return m_item.m_mask; }
 296     const wxListItem& GetItem() const { return m_item; }
 297
 298     void CopyObject(wxObject& object_dest) const;
 299
 300 private:
 301     DECLARE_DYNAMIC_CLASS(wxListEvent)
 302 };
 303
 304 // ----------------------------------------------------------------------------
 305 // wxListCtrl event macros
 306 // ----------------------------------------------------------------------------
 307
 308 BEGIN_DECLARE_EVENT_TYPES()
 309     DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_BEGIN_DRAG, 700)
 310     DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_BEGIN_RDRAG, 701)
 311     DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT, 702)
 312     DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_END_LABEL_EDIT, 703)
 313     DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_DELETE_ITEM, 704)
 314     DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_DELETE_ALL_ITEMS, 705)
 315     DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_GET_INFO, 706)
 316     DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_SET_INFO, 707)
 317     DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_SELECTED, 708)
 318     DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_DESELECTED, 709)
 319     DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_KEY_DOWN, 710)
 320     DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_INSERT_ITEM, 711)
 321     DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_COL_CLICK, 712)
 322     DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK, 713)
 323     DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_MIDDLE_CLICK, 714)
 324     DECLARE_EVENT_TYPE(wxEVT_COMMAND_LIST_ITEM_ACTIVATED, 715)
 325 END_DECLARE_EVENT_TYPES()
 326
 327 typedef void (wxEvtHandler::*wxListEventFunction)(wxListEvent&);
 328
 329 #define EVT_LIST_BEGIN_DRAG(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LIST_BEGIN_DRAG, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL ),
 330 #define EVT_LIST_BEGIN_RDRAG(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LIST_BEGIN_RDRAG, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL ),
 331 #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 ),
 332 #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 ),
 333 #define EVT_LIST_DELETE_ITEM(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LIST_DELETE_ITEM, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL ),
 334 #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 ),
 335 #define EVT_LIST_GET_INFO(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LIST_GET_INFO, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL ),
 336 #define EVT_LIST_SET_INFO(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LIST_SET_INFO, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL ),
 337 #define EVT_LIST_ITEM_SELECTED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LIST_ITEM_SELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL ),
 338 #define EVT_LIST_ITEM_DESELECTED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LIST_ITEM_DESELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL ),
 339 #define EVT_LIST_KEY_DOWN(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LIST_KEY_DOWN, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL ),
 340 #define EVT_LIST_INSERT_ITEM(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LIST_INSERT_ITEM, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL ),
 341 #define EVT_LIST_COL_CLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LIST_COL_CLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL ),
 342 #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 ),
 343 #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 ),
 344 #define EVT_LIST_ITEM_ACTIVATED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_COMMAND_LIST_ITEM_ACTIVATED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, (wxObject *) NULL ),
 345
 346 #endif // wxUSE_LISTCTRL
 347
 348 #endif
 349     // _WX_LISTCTRL_H_BASE_