include/wx/mac/classic/listctrl.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        listctrl.h
   3 // Purpose:     wxListCtrl class
   4 // Author:      Stefan Csomor
   5 // Modified by:
   6 // Created:     1998-01-01
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Stefan Csomor
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_LISTCTRL_H_
  13 #define _WX_LISTCTRL_H_
  14
  15 #include "wx/control.h"
  16 #include "wx/event.h"
  17 #include "wx/imaglist.h"
  18
  19 /*
  20     The wxListCtrl can show lists of items in four different modes:
  21     wxLC_LIST:   multicolumn list view, with optional small icons (icons could be
  22                  optional for some platforms). Columns are computed automatically,
  23                  i.e. you don't set columns as in wxLC_REPORT. In other words,
  24                  the list wraps, unlike a wxListBox.
  25     wxLC_REPORT: single or multicolumn report view (with optional header)
  26     wxLC_ICON:   large icon view, with optional labels
  27     wxLC_SMALL_ICON: small icon view, with optional labels
  28
  29     You can change the style dynamically, either with SetSingleStyle or
  30     SetWindowStyleFlag.
  31
  32     Further window styles:
  33
  34     wxLC_ALIGN_TOP          icons align to the top (default)
  35     wxLC_ALIGN_LEFT         icons align to the left
  36     wxLC_AUTOARRANGE        icons arrange themselves
  37     wxLC_USER_TEXT          the app provides label text on demand, except for column headers
  38     wxLC_EDIT_LABELS        labels are editable: app will be notified.
  39     wxLC_NO_HEADER          no header in report mode
  40     wxLC_NO_SORT_HEADER     can't click on header
  41     wxLC_SINGLE_SEL         single selection
  42     wxLC_SORT_ASCENDING     sort ascending (must still supply a comparison callback in SortItems)
  43     wxLC_SORT_DESCENDING    sort descending (ditto)
  44
  45     Items are referred to by their index (position in the list starting from zero).
  46
  47     Label text is supplied via insertion/setting functions and is stored by the
  48     control, unless the wxLC_USER_TEXT style has been specified, in which case
  49     the app will be notified when text is required (see sample).
  50
  51     Images are dealt with by (optionally) associating 3 image lists with the control.
  52     Zero-based indexes into these image lists indicate which image is to be used for
  53     which item. Each image in an image list can contain a mask, and can be made out
  54     of either a bitmap, two bitmaps or an icon. See ImagList.h for more details.
  55
  56     Notifications are passed via the wxWidgets 2.0 event system.
  57
  58     See the sample wxListCtrl app for API usage.
  59
  60  */
  61
  62 // Mask flags to tell app/GUI what fields of wxListItem are valid
  63 #define wxLIST_MASK_STATE           0x0001
  64 #define wxLIST_MASK_TEXT            0x0002
  65 #define wxLIST_MASK_IMAGE           0x0004
  66 #define wxLIST_MASK_DATA            0x0008
  67 #define wxLIST_SET_ITEM             0x0010
  68 #define wxLIST_MASK_WIDTH           0x0020
  69 #define wxLIST_MASK_FORMAT          0x0040
  70
  71 // State flags for indicating the state of an item
  72 #define wxLIST_STATE_DONTCARE       0x0000
  73 #define wxLIST_STATE_DROPHILITED    0x0001
  74 #define wxLIST_STATE_FOCUSED        0x0002
  75 #define wxLIST_STATE_SELECTED       0x0004
  76 #define wxLIST_STATE_CUT            0x0008
  77
  78 // Hit test flags, used in HitTest
  79 #define wxLIST_HITTEST_ABOVE            0x0001  // Above the client area.
  80 #define wxLIST_HITTEST_BELOW            0x0002  // Below the client area.
  81 #define wxLIST_HITTEST_NOWHERE          0x0004  // In the client area but below the last item.
  82 #define wxLIST_HITTEST_ONITEMICON       0x0020  // On the bitmap associated with an item.
  83 #define wxLIST_HITTEST_ONITEMLABEL      0x0080  // On the label (string) associated with an item.
  84 #define wxLIST_HITTEST_ONITEMRIGHT      0x0100  // In the area to the right of an item.
  85 #define wxLIST_HITTEST_ONITEMSTATEICON  0x0200  // On the state icon for a tree view item that is in a user-defined state.
  86 #define wxLIST_HITTEST_TOLEFT           0x0400  // To the left of the client area.
  87 #define wxLIST_HITTEST_TORIGHT          0x0800  // To the right of the client area.
  88
  89 #define wxLIST_HITTEST_ONITEM (wxLIST_HITTEST_ONITEMICON | wxLIST_HITTEST_ONITEMLABEL wxLIST_HITTEST_ONITEMSTATEICON)
  90
  91 // Flags for GetNextItem
  92 enum {
  93     wxLIST_NEXT_ABOVE,          // Searches for an item above the specified item
  94     wxLIST_NEXT_ALL,            // Searches for subsequent item by index
  95     wxLIST_NEXT_BELOW,          // Searches for an item below the specified item
  96     wxLIST_NEXT_LEFT,           // Searches for an item to the left of the specified item
  97     wxLIST_NEXT_RIGHT,          // Searches for an item to the right of the specified item
  98 };
  99
 100 // Alignment flags for Arrange
 101 enum {
 102     wxLIST_ALIGN_DEFAULT,
 103     wxLIST_ALIGN_LEFT,
 104     wxLIST_ALIGN_TOP,
 105     wxLIST_ALIGN_SNAP_TO_GRID
 106 };
 107
 108 // Column format
 109 enum {
 110     wxLIST_FORMAT_LEFT,
 111     wxLIST_FORMAT_RIGHT,
 112     wxLIST_FORMAT_CENTRE,
 113     wxLIST_FORMAT_CENTER = wxLIST_FORMAT_CENTRE
 114 };
 115
 116 // Autosize values for SetColumnWidth
 117 enum {
 118     wxLIST_AUTOSIZE = -1,
 119     wxLIST_AUTOSIZE_USEHEADER = -2
 120 };
 121
 122 // Flag values for GetItemRect
 123 enum {
 124     wxLIST_RECT_BOUNDS,
 125     wxLIST_RECT_ICON,
 126     wxLIST_RECT_LABEL
 127 };
 128
 129 // Flag values for FindItem
 130 enum {
 131     wxLIST_FIND_UP,
 132     wxLIST_FIND_DOWN,
 133     wxLIST_FIND_LEFT,
 134     wxLIST_FIND_RIGHT
 135 };
 136
 137 // wxListItem: data representing an item, or report field.
 138 // It also doubles up to represent entire column information
 139 // when inserting or setting a column.
 140 class WXDLLEXPORT wxListItem: public wxObject
 141 {
 142  DECLARE_DYNAMIC_CLASS(wxListItem)
 143 public:
 144     long            m_mask;     // Indicates what fields are valid
 145     long            m_itemId;   // The zero-based item position
 146     int             m_col;      // Zero-based column, if in report mode
 147     long            m_state;    // The state of the item
 148     long            m_stateMask; // Which flags of m_state are valid (uses same flags)
 149     wxString        m_text;     // The label/header text
 150     int             m_image;    // The zero-based index into an image list
 151     long            m_data;     // App-defined data
 152
 153     // For columns only
 154     int             m_format;   // left, right, centre
 155     int             m_width;    // width of column
 156
 157     wxListItem();
 158 };
 159
 160 // type of compare function for wxListCtrl sort operation
 161 typedef int (*wxListCtrlCompare)(long item1, long item2, long sortData);
 162
 163 class WXDLLEXPORT wxListCtrl: public wxControl
 164 {
 165   DECLARE_DYNAMIC_CLASS(wxListCtrl)
 166  public:
 167   /*
 168    * Public interface
 169    */
 170
 171   wxListCtrl();
 172
 173   inline wxListCtrl(wxWindow *parent, wxWindowID id = -1, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize,
 174             long style = wxLC_ICON, const wxValidator& validator = wxDefaultValidator,
 175             const wxString& name = wxListCtrlNameStr)
 176   {
 177     Create(parent, id, pos, size, style, validator, name);
 178   }
 179   ~wxListCtrl();
 180
 181   bool Create(wxWindow *parent, wxWindowID id = -1, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize,
 182             long style = wxLC_ICON, const wxValidator& validator = wxDefaultValidator, const wxString& name = wxListCtrlNameStr);
 183
 184
 185   // Attributes
 186   ////////////////////////////////////////////////////////////////////////////
 187
 188   // Gets information about this column
 189   bool GetColumn(int col, wxListItem& item) const;
 190
 191   // Sets information about this column
 192   bool SetColumn(int col, wxListItem& item) ;
 193
 194   // Gets the column width
 195   int GetColumnWidth(int col) const;
 196
 197   // Sets the column width
 198   bool SetColumnWidth(int col, int width) ;
 199
 200   // Gets the number of items that can fit vertically in the
 201   // visible area of the list control (list or report view)
 202   // or the total number of items in the list control (icon
 203   // or small icon view)
 204   int GetCountPerPage() const;
 205
 206   // Gets the edit control for editing labels.
 207   wxTextCtrl* GetEditControl() const;
 208
 209   // Gets information about the item
 210   bool GetItem(wxListItem& info) const ;
 211
 212   // Sets information about the item
 213   bool SetItem(wxListItem& info) ;
 214
 215   // Sets a string field at a particular column
 216   long SetItem(long index, int col, const wxString& label, int imageId = -1);
 217
 218   // Gets the item state
 219   int  GetItemState(long item, long stateMask) const ;
 220
 221   // Sets the item state
 222   bool SetItemState(long item, long state, long stateMask) ;
 223
 224   // Sets the item image
 225   bool SetItemImage(long item, int image, int selImage) ;
 226
 227   // Gets the item text
 228   wxString GetItemText(long item) const ;
 229
 230   // Sets the item text
 231   void SetItemText(long item, const wxString& str) ;
 232
 233   // Gets the item data
 234   long GetItemData(long item) const ;
 235
 236   // Sets the item data
 237   bool SetItemData(long item, long data) ;
 238
 239   // Gets the item rectangle
 240   bool GetItemRect(long item, wxRect& rect, int code = wxLIST_RECT_BOUNDS) const ;
 241
 242   // Gets the item position
 243   bool GetItemPosition(long item, wxPoint& pos) const ;
 244
 245   // Sets the item position
 246   bool SetItemPosition(long item, const wxPoint& pos) ;
 247
 248   // Gets the number of items in the list control
 249   int GetItemCount() const;
 250
 251   // Gets the number of columns in the list control
 252   int GetColumnCount() const;
 253
 254   // Retrieves the spacing between icons in pixels.
 255   // If isSmall is true, gets the spacing for the small icon
 256   // view, otherwise the large icon view.
 257   int GetItemSpacing(bool isSmall) const;
 258
 259   // Gets the number of selected items in the list control
 260   int GetSelectedItemCount() const;
 261
 262   // Gets the text colour of the listview
 263   wxColour GetTextColour() const;
 264
 265   // Sets the text colour of the listview
 266   void SetTextColour(const wxColour& col);
 267
 268   // Gets the index of the topmost visible item when in
 269   // list or report view
 270   long GetTopItem() const ;
 271
 272   // Add or remove a single window style
 273   void SetSingleStyle(long style, bool add = true) ;
 274
 275   // Set the whole window style
 276   void SetWindowStyleFlag(long style) ;
 277
 278   // Searches for an item, starting from 'item'.
 279   // item can be -1 to find the first item that matches the
 280   // specified flags.
 281   // Returns the item or -1 if unsuccessful.
 282   long GetNextItem(long item, int geometry = wxLIST_NEXT_ALL, int state = wxLIST_STATE_DONTCARE) const ;
 283
 284   // Implementation: converts wxWidgets style to MSW style.
 285   // Can be a single style flag or a bit list.
 286   // oldStyle is 'normalised' so that it doesn't contain
 287   // conflicting styles.
 288   long ConvertToMSWStyle(long& oldStyle, long style) const;
 289
 290   // Gets one of the three image lists
 291   wxImageList *GetImageList(int which) const ;
 292
 293   // Sets the image list
 294   // N.B. There's a quirk in the Win95 list view implementation.
 295   // If in wxLC_LIST mode, it'll *still* display images by the labels if
 296   // there's a small-icon image list set for the control - even though you
 297   // haven't specified wxLIST_MASK_IMAGE when inserting.
 298   // So you have to set a NULL small-icon image list to be sure that
 299   // the wxLC_LIST mode works without icons. Of course, you may want icons...
 300   void SetImageList(wxImageList *imageList, int which) ;
 301
 302   // Operations
 303   ////////////////////////////////////////////////////////////////////////////
 304
 305   // Arranges the items
 306   bool Arrange(int flag = wxLIST_ALIGN_DEFAULT);
 307
 308   // Deletes an item
 309   bool DeleteItem(long item);
 310
 311   // Deletes all items
 312   bool DeleteAllItems() ;
 313
 314   // Deletes a column
 315   bool DeleteColumn(int col);
 316
 317   // Deletes all columns
 318   bool DeleteAllColumns();
 319
 320   // Clears items, and columns if there are any.
 321   void ClearAll();
 322
 323   // Edit the label
 324   wxTextCtrl* EditLabel(long item, wxClassInfo* textControlClass = CLASSINFO(wxTextCtrl));
 325
 326   // End label editing, optionally cancelling the edit
 327   bool EndEditLabel(bool cancel);
 328
 329   // Ensures this item is visible
 330   bool EnsureVisible(long item) ;
 331
 332   // Find an item whose label matches this string, starting from the item after 'start'
 333   // or the beginning if 'start' is -1.
 334   long FindItem(long start, const wxString& str, bool partial = false);
 335
 336   // Find an item whose data matches this data, starting from the item after 'start'
 337   // or the beginning if 'start' is -1.
 338   long FindItem(long start, long data);
 339
 340   // Find an item nearest this position in the specified direction, starting from
 341   // the item after 'start' or the beginning if 'start' is -1.
 342   long FindItem(long start, const wxPoint& pt, int direction);
 343
 344   // Determines which item (if any) is at the specified point,
 345   // giving details in 'flags' (see wxLIST_HITTEST_... flags above)
 346   long HitTest(const wxPoint& point, int& flags);
 347
 348   // Inserts an item, returning the index of the new item if successful,
 349   // -1 otherwise.
 350   // TOD: Should also have some further convenience functions
 351   // which don't require setting a wxListItem object
 352   long InsertItem(wxListItem& info);
 353
 354   // Insert a string item
 355   long InsertItem(long index, const wxString& label);
 356
 357   // Insert an image item
 358   long InsertItem(long index, int imageIndex);
 359
 360   // Insert an image/string item
 361   long InsertItem(long index, const wxString& label, int imageIndex);
 362
 363   // For list view mode (only), inserts a column.
 364   long InsertColumn(long col, wxListItem& info);
 365
 366   long InsertColumn(long col, const wxString& heading, int format = wxLIST_FORMAT_LEFT,
 367     int width = -1);
 368
 369   // Scrolls the list control. If in icon, small icon or report view mode,
 370   // x specifies the number of pixels to scroll. If in list view mode, x
 371   // specifies the number of columns to scroll.
 372   // If in icon, small icon or list view mode, y specifies the number of pixels
 373   // to scroll. If in report view mode, y specifies the number of lines to scroll.
 374   bool ScrollList(int dx, int dy);
 375
 376   // Sort items.
 377
 378   // fn is a function which takes 3 long arguments: item1, item2, data.
 379   // item1 is the long data associated with a first item (NOT the index).
 380   // item2 is the long data associated with a second item (NOT the index).
 381   // data is the same value as passed to SortItems.
 382   // The return value is a negative number if the first item should precede the second
 383   // item, a positive number of the second item should precede the first,
 384   // or zero if the two items are equivalent.
 385
 386   // data is arbitrary data to be passed to the sort function.
 387   bool SortItems(wxListCtrlCompare fn, long data);
 388
 389 /* Why should we need this function? Leave for now.
 390  * We might need it because item data may have changed,
 391  * but the display needs refreshing (in string callback mode)
 392   // Updates an item. If the list control has the wxLI_AUTO_ARRANGE style,
 393   // the items will be rearranged.
 394   bool Update(long item);
 395 */
 396
 397   void Command(wxCommandEvent& event) { ProcessCommand(event); };
 398
 399 protected:
 400   wxTextCtrl*       m_textCtrl;        // The control used for editing a label
 401   wxImageList *     m_imageListNormal; // The image list for normal icons
 402   wxImageList *     m_imageListSmall;  // The image list for small icons
 403   wxImageList *     m_imageListState;  // The image list state icons (not implemented yet)
 404
 405   long              m_baseStyle;  // Basic Windows style flags, for recreation purposes
 406   wxStringList      m_stringPool; // Pool of 3 strings to satisfy Windows callback
 407                                   // requirements
 408   int               m_colCount;   // Windows doesn't have GetColumnCount so must
 409                                   // keep track of inserted/deleted columns
 410
 411 };
 412
 413 class WXDLLEXPORT wxListEvent: public wxCommandEvent
 414 {
 415   DECLARE_DYNAMIC_CLASS(wxListEvent)
 416
 417  public:
 418   wxListEvent(wxEventType commandType = wxEVT_NULL, int id = 0);
 419
 420   int           m_code;
 421   long          m_itemIndex;
 422   long          m_oldItemIndex;
 423   int           m_col;
 424   bool          m_cancelled;
 425   wxPoint       m_pointDrag;
 426
 427   wxListItem    m_item;
 428 };
 429
 430 typedef void (wxEvtHandler::*wxListEventFunction)(wxListEvent&);
 431
 432 #define EVT_LIST_BEGIN_DRAG(id, fn) { wxEVT_COMMAND_LIST_BEGIN_DRAG, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL },
 433 #define EVT_LIST_BEGIN_RDRAG(id, fn) { wxEVT_COMMAND_LIST_BEGIN_RDRAG, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL },
 434 #define EVT_LIST_BEGIN_LABEL_EDIT(id, fn) { wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL },
 435 #define EVT_LIST_END_LABEL_EDIT(id, fn) { wxEVT_COMMAND_LIST_END_LABEL_EDIT, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL },
 436 #define EVT_LIST_DELETE_ITEM(id, fn) { wxEVT_COMMAND_LIST_DELETE_ITEM, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL },
 437 #define EVT_LIST_DELETE_ALL_ITEMS(id, fn) { wxEVT_COMMAND_LIST_DELETE_ALL_ITEMS, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL },
 438 #define EVT_LIST_GET_INFO(id, fn) { wxEVT_COMMAND_LIST_GET_INFO, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL },
 439 #define EVT_LIST_SET_INFO(id, fn) { wxEVT_COMMAND_LIST_SET_INFO, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL },
 440 #define EVT_LIST_ITEM_SELECTED(id, fn) { wxEVT_COMMAND_LIST_ITEM_SELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL },
 441 #define EVT_LIST_ITEM_DESELECTED(id, fn) { wxEVT_COMMAND_LIST_ITEM_DESELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL },
 442 #define EVT_LIST_KEY_DOWN(id, fn) { wxEVT_COMMAND_LIST_KEY_DOWN, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL },
 443 #define EVT_LIST_INSERT_ITEM(id, fn) { wxEVT_COMMAND_LIST_INSERT_ITEM, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL },
 444 #define EVT_LIST_COL_CLICK(id, fn) { wxEVT_COMMAND_LIST_COL_CLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL },
 445
 446 #endif
 447     // _WX_LISTCTRL_H_