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