include/wx/msw/listctrl.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/msw/listctrl.h
   3 // Purpose:     wxListCtrl class
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:     01/02/97
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_LISTCTRL_H_
  13 #define _WX_LISTCTRL_H_
  14
  15 #ifdef __GNUG__
  16     #pragma interface "listctrl.h"
  17 #endif
  18
  19 #if wxUSE_LISTCTRL
  20
  21 #include "wx/control.h"
  22 #include "wx/event.h"
  23 #include "wx/hash.h"
  24 #include "wx/textctrl.h"
  25
  26
  27 class WXDLLEXPORT wxImageList;
  28
  29 /*
  30     The wxListCtrl can show lists of items in four different modes:
  31     wxLC_LIST:   multicolumn list view, with optional small icons (icons could be
  32                  optional for some platforms). Columns are computed automatically,
  33                  i.e. you don't set columns as in wxLC_REPORT. In other words,
  34                  the list wraps, unlike a wxListBox.
  35     wxLC_REPORT: single or multicolumn report view (with optional header)
  36     wxLC_ICON:   large icon view, with optional labels
  37     wxLC_SMALL_ICON: small icon view, with optional labels
  38
  39     You can change the style dynamically, either with SetSingleStyle or
  40     SetWindowStyleFlag.
  41
  42     Further window styles:
  43
  44     wxLC_ALIGN_TOP          icons align to the top (default)
  45     wxLC_ALIGN_LEFT         icons align to the left
  46     wxLC_AUTOARRANGE        icons arrange themselves
  47     wxLC_USER_TEXT          the app provides label text on demand, except for column headers
  48     wxLC_EDIT_LABELS        labels are editable: app will be notified.
  49     wxLC_NO_HEADER          no header in report mode
  50     wxLC_NO_SORT_HEADER     can't click on header
  51     wxLC_SINGLE_SEL         single selection
  52     wxLC_SORT_ASCENDING     sort ascending (must still supply a comparison callback in SortItems)
  53     wxLC_SORT_DESCENDING    sort descending (ditto)
  54
  55     Items are referred to by their index (position in the list starting from zero).
  56
  57     Label text is supplied via insertion/setting functions and is stored by the
  58     control, unless the wxLC_USER_TEXT style has been specified, in which case
  59     the app will be notified when text is required (see sample).
  60
  61     Images are dealt with by (optionally) associating 3 image lists with the control.
  62     Zero-based indexes into these image lists indicate which image is to be used for
  63     which item. Each image in an image list can contain a mask, and can be made out
  64     of either a bitmap, two bitmaps or an icon. See ImagList.h for more details.
  65
  66     Notifications are passed via the wxWindows 2.0 event system, or using virtual
  67     functions in wxWindows 1.66.
  68
  69     See the sample wxListCtrl app for API usage.
  70
  71     TODO:
  72      - addition of further convenience functions
  73        to avoid use of wxListItem in some functions
  74      - state/overlay images: probably not needed.
  75      - in Win95, you can be called back to supply other information
  76        besides text, such as state information. This saves no memory
  77        and is probably superfluous to requirements.
  78      - testing of whole API, extending current sample.
  79
  80
  81  */
  82
  83 class WXDLLEXPORT wxListCtrl: public wxControl
  84 {
  85 public:
  86     /*
  87      * Public interface
  88      */
  89
  90     wxListCtrl() { Init(); }
  91
  92     wxListCtrl(wxWindow *parent,
  93                wxWindowID id = -1,
  94                const wxPoint& pos = wxDefaultPosition,
  95                const wxSize& size = wxDefaultSize,
  96                long style = wxLC_ICON,
  97                const wxValidator& validator = wxDefaultValidator,
  98                const wxString& name = _T("wxListCtrl"))
  99     {
 100         Init();
 101
 102         Create(parent, id, pos, size, style, validator, name);
 103     }
 104
 105     virtual ~wxListCtrl();
 106
 107     bool Create(wxWindow *parent,
 108                 wxWindowID id = -1,
 109                 const wxPoint& pos = wxDefaultPosition,
 110                 const wxSize& size = wxDefaultSize,
 111                 long style = wxLC_ICON,
 112                 const wxValidator& validator = wxDefaultValidator,
 113                 const wxString& name = _T("wxListCtrl"));
 114
 115
 116     // Attributes
 117     ////////////////////////////////////////////////////////////////////////////
 118
 119     // Set the control colours
 120     bool SetForegroundColour(const wxColour& col);
 121     bool SetBackgroundColour(const wxColour& col);
 122
 123     // Gets information about this column
 124     bool GetColumn(int col, wxListItem& item) const;
 125
 126     // Sets information about this column
 127     bool SetColumn(int col, wxListItem& item) ;
 128
 129     // Gets the column width
 130     int GetColumnWidth(int col) const;
 131
 132     // Sets the column width
 133     bool SetColumnWidth(int col, int width) ;
 134
 135     // Gets the number of items that can fit vertically in the
 136     // visible area of the list control (list or report view)
 137     // or the total number of items in the list control (icon
 138     // or small icon view)
 139     int GetCountPerPage() const;
 140
 141     // Gets the edit control for editing labels.
 142     wxTextCtrl* GetEditControl() const;
 143
 144     // Gets information about the item
 145     bool GetItem(wxListItem& info) const ;
 146
 147     // Sets information about the item
 148     bool SetItem(wxListItem& info) ;
 149
 150     // Sets a string field at a particular column
 151     long SetItem(long index, int col, const wxString& label, int imageId = -1);
 152
 153     // Gets the item state
 154     int  GetItemState(long item, long stateMask) const ;
 155
 156     // Sets the item state
 157     bool SetItemState(long item, long state, long stateMask) ;
 158
 159     // Sets the item image
 160     bool SetItemImage(long item, int image, int selImage) ;
 161
 162     // Gets the item text
 163     wxString GetItemText(long item) const ;
 164
 165     // Sets the item text
 166     void SetItemText(long item, const wxString& str) ;
 167
 168     // Gets the item data
 169     long GetItemData(long item) const ;
 170
 171     // Sets the item data
 172     bool SetItemData(long item, long data) ;
 173
 174     // Gets the item rectangle
 175     bool GetItemRect(long item, wxRect& rect, int code = wxLIST_RECT_BOUNDS) const ;
 176
 177     // Gets the item position
 178     bool GetItemPosition(long item, wxPoint& pos) const ;
 179
 180     // Sets the item position
 181     bool SetItemPosition(long item, const wxPoint& pos) ;
 182
 183     // Gets the number of items in the list control
 184     int GetItemCount() const;
 185
 186     // Gets the number of columns in the list control
 187     int GetColumnCount() const { return m_colCount; }
 188
 189     // Retrieves the spacing between icons in pixels.
 190     // If small is TRUE, gets the spacing for the small icon
 191     // view, otherwise the large icon view.
 192     int GetItemSpacing(bool isSmall) const;
 193
 194     // Gets the number of selected items in the list control
 195     int GetSelectedItemCount() const;
 196
 197     // Gets the text colour of the listview
 198     wxColour GetTextColour() const;
 199
 200     // Sets the text colour of the listview
 201     void SetTextColour(const wxColour& col);
 202
 203     // Gets the index of the topmost visible item when in
 204     // list or report view
 205     long GetTopItem() const ;
 206
 207     // Add or remove a single window style
 208     void SetSingleStyle(long style, bool add = TRUE) ;
 209
 210     // Set the whole window style
 211     void SetWindowStyleFlag(long style) ;
 212
 213     // Searches for an item, starting from 'item'.
 214     // item can be -1 to find the first item that matches the
 215     // specified flags.
 216     // Returns the item or -1 if unsuccessful.
 217     long GetNextItem(long item, int geometry = wxLIST_NEXT_ALL, int state = wxLIST_STATE_DONTCARE) const ;
 218
 219     // Gets one of the three image lists
 220     wxImageList *GetImageList(int which) const ;
 221
 222     // Sets the image list
 223     // N.B. There's a quirk in the Win95 list view implementation.
 224     // If in wxLC_LIST mode, it'll *still* display images by the labels if
 225     // there's a small-icon image list set for the control - even though you
 226     // haven't specified wxLIST_MASK_IMAGE when inserting.
 227     // So you have to set a NULL small-icon image list to be sure that
 228     // the wxLC_LIST mode works without icons. Of course, you may want icons...
 229     void SetImageList(wxImageList *imageList, int which) ;
 230     void AssignImageList(wxImageList *imageList, int which) ;
 231
 232     // returns true if it is a virtual list control
 233     bool IsVirtual() const { return (GetWindowStyle() & wxLC_VIRTUAL) != 0; }
 234
 235     // refresh items selectively (only useful for virtual list controls)
 236     void RefreshItem(long item);
 237     void RefreshItems(long itemFrom, long itemTo);
 238
 239     // Operations
 240     ////////////////////////////////////////////////////////////////////////////
 241
 242     // Arranges the items
 243     bool Arrange(int flag = wxLIST_ALIGN_DEFAULT);
 244
 245     // Deletes an item
 246     bool DeleteItem(long item);
 247
 248     // Deletes all items
 249     bool DeleteAllItems() ;
 250
 251     // Deletes a column
 252     bool DeleteColumn(int col);
 253
 254     // Deletes all columns
 255     bool DeleteAllColumns();
 256
 257     // Clears items, and columns if there are any.
 258     void ClearAll();
 259
 260     // Edit the label
 261     wxTextCtrl* EditLabel(long item, wxClassInfo* textControlClass = CLASSINFO(wxTextCtrl));
 262
 263     // End label editing, optionally cancelling the edit
 264     bool EndEditLabel(bool cancel);
 265
 266     // Ensures this item is visible
 267     bool EnsureVisible(long item) ;
 268
 269     // Find an item whose label matches this string, starting from the item after 'start'
 270     // or the beginning if 'start' is -1.
 271     long FindItem(long start, const wxString& str, bool partial = FALSE);
 272
 273     // Find an item whose data matches this data, starting from the item after 'start'
 274     // or the beginning if 'start' is -1.
 275     long FindItem(long start, long data);
 276
 277     // Find an item nearest this position in the specified direction, starting from
 278     // the item after 'start' or the beginning if 'start' is -1.
 279     long FindItem(long start, const wxPoint& pt, int direction);
 280
 281     // Determines which item (if any) is at the specified point,
 282     // giving details in 'flags' (see wxLIST_HITTEST_... flags above)
 283     long HitTest(const wxPoint& point, int& flags);
 284
 285     // Inserts an item, returning the index of the new item if successful,
 286     // -1 otherwise.
 287     long InsertItem(wxListItem& info);
 288
 289     // Insert a string item
 290     long InsertItem(long index, const wxString& label);
 291
 292     // Insert an image item
 293     long InsertItem(long index, int imageIndex);
 294
 295     // Insert an image/string item
 296     long InsertItem(long index, const wxString& label, int imageIndex);
 297
 298     // For list view mode (only), inserts a column.
 299     long InsertColumn(long col, wxListItem& info);
 300
 301     long InsertColumn(long col,
 302                       const wxString& heading,
 303                       int format = wxLIST_FORMAT_LEFT,
 304                       int width = -1);
 305
 306     // set the number of items in a virtual list control
 307     void SetItemCount(long count);
 308
 309     // Scrolls the list control. If in icon, small icon or report view mode,
 310     // x specifies the number of pixels to scroll. If in list view mode, x
 311     // specifies the number of columns to scroll.
 312     // If in icon, small icon or list view mode, y specifies the number of pixels
 313     // to scroll. If in report view mode, y specifies the number of lines to scroll.
 314     bool ScrollList(int dx, int dy);
 315
 316     // Sort items.
 317
 318     // fn is a function which takes 3 long arguments: item1, item2, data.
 319     // item1 is the long data associated with a first item (NOT the index).
 320     // item2 is the long data associated with a second item (NOT the index).
 321     // data is the same value as passed to SortItems.
 322     // The return value is a negative number if the first item should precede the second
 323     // item, a positive number of the second item should precede the first,
 324     // or zero if the two items are equivalent.
 325
 326     // data is arbitrary data to be passed to the sort function.
 327     bool SortItems(wxListCtrlCompare fn, long data);
 328
 329     // IMPLEMENTATION
 330     virtual bool MSWCommand(WXUINT param, WXWORD id);
 331     virtual bool MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result);
 332
 333     // bring the control in sync with current m_windowStyle value
 334     void UpdateStyle();
 335
 336     // Implementation: converts wxWindows style to MSW style.
 337     // Can be a single style flag or a bit list.
 338     // oldStyle is 'normalised' so that it doesn't contain
 339     // conflicting styles.
 340     long ConvertToMSWStyle(long& oldStyle, long style) const;
 341
 342     // Event handlers
 343     ////////////////////////////////////////////////////////////////////////////
 344     // Necessary for drawing hrules and vrules, if specified
 345     void OnPaint(wxPaintEvent& event);
 346
 347 protected:
 348     // common part of all ctors
 349     void Init();
 350
 351     // free memory taken by all attributes and recreate the hash table
 352     void FreeAllAttrs(bool dontRecreate = FALSE);
 353
 354     wxTextCtrl*       m_textCtrl;        // The control used for editing a label
 355     wxImageList *     m_imageListNormal; // The image list for normal icons
 356     wxImageList *     m_imageListSmall;  // The image list for small icons
 357     wxImageList *     m_imageListState;  // The image list state icons (not implemented yet)
 358     bool              m_ownsImageListNormal,
 359                       m_ownsImageListSmall,
 360                       m_ownsImageListState;
 361
 362     long              m_baseStyle;  // Basic Windows style flags, for recreation purposes
 363     int               m_colCount;   // Windows doesn't have GetColumnCount so must
 364                                     // keep track of inserted/deleted columns
 365
 366     // the hash table we use for storing pointers to the items attributes
 367     wxHashTable m_attrs;
 368
 369     // TRUE if we have any items with custom attributes
 370     bool m_hasAnyAttr;
 371
 372     // these functions are only used for virtual list view controls, i.e. the
 373     // ones with wxLC_VIRTUAL style
 374
 375     // return the text for the given column of the given item
 376     virtual wxString OnGetItemText(long item, long column) const;
 377
 378     // return the icon for the given item
 379     virtual int OnGetItemImage(long item) const;
 380
 381     // return the attribute for the item (may return NULL if none)
 382     virtual wxListItemAttr *OnGetItemAttr(long item) const;
 383
 384 private:
 385     bool DoCreateControl(int x, int y, int w, int h);
 386
 387     // process NM_CUSTOMDRAW notification message
 388     WXLPARAM OnCustomDraw(WXLPARAM lParam);
 389
 390     DECLARE_DYNAMIC_CLASS(wxListCtrl)
 391     DECLARE_EVENT_TABLE()
 392 };
 393
 394 #endif // wxUSE_LISTCTRL
 395
 396 #endif
 397     // _WX_LISTCTRL_H_