interface/wx/listctrl.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        listctrl.h
   3 // Purpose:     interface of wxListCtrl
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows license
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9 /**
  10     @class wxListCtrl
  11
  12     A list control presents lists in a number of formats: list view, report view,
  13     icon view and small icon view. In any case, elements are numbered from zero.
  14     For all these modes, the items are stored in the control and must be added to
  15     it using wxListCtrl::InsertItem method.
  16
  17     A special case of report view quite different from the other modes of the list
  18     control is a virtual control in which the items data (including text, images
  19     and attributes) is managed by the main program and is requested by the control
  20     itself only when needed which allows to have controls with millions of items
  21     without consuming much memory. To use virtual list control you must use
  22     wxListCtrl::SetItemCount first and overload at least wxListCtrl::OnGetItemText
  23     (and optionally wxListCtrl::OnGetItemImage or wxListCtrl::OnGetItemColumnImage and
  24     wxListCtrl::OnGetItemAttr) to return the information about the items when the
  25     control requests it.
  26     Virtual list control can be used as a normal one except that no operations
  27     which can take time proportional to the number of items in the control happen
  28     -- this is required to allow having a practically infinite number of items.
  29     For example, in a multiple selection virtual list control, the selections won't
  30     be sent when many items are selected at once because this could mean iterating
  31     over all the items.
  32
  33     Using many of wxListCtrl features is shown in the
  34     @ref page_samples_listctrl "corresponding sample".
  35
  36     To intercept events from a list control, use the event table macros described
  37     in wxListEvent.
  38
  39     <b>wxMac Note</b>: Starting with wxWidgets 2.8, wxListCtrl uses a native
  40     implementation for report mode, and uses a generic implementation for other
  41     modes. You can use the generic implementation for report mode as well by setting
  42     the @c mac.listctrl.always_use_generic system option (see wxSystemOption) to 1.
  43
  44     <b>wxMSW Note</b>: In report view, the control has several columns
  45     which are identified by their internal indices. By default, these indices
  46     correspond to their order on screen, i.e. the column 0 appears first (in the
  47     left-to-right or maybe right-to-left if the current language uses this writing
  48     direction), the column 1 next and so on. However it is possible to reorder the
  49     columns visual order using SetColumnsOrder() method and the user can also
  50     rearrange the columns interactively by dragging them. In this case, the index
  51     of the column is not the same as its order and the functions GetColumnOrder()
  52     and GetColumnIndexFromOrder() should be used to translate between them.
  53
  54
  55     @beginStyleTable
  56     @style{wxLC_LIST}
  57            Multicolumn list view, with optional small icons. Columns are
  58            computed automatically, i.e. you don't set columns as in
  59            wxLC_REPORT. In other words, the list wraps, unlike a wxListBox.
  60     @style{wxLC_REPORT}
  61            Single or multicolumn report view, with optional header.
  62     @style{wxLC_VIRTUAL}
  63            The application provides items text on demand. May only be used
  64            with wxLC_REPORT.
  65     @style{wxLC_ICON}
  66            Large icon view, with optional labels.
  67     @style{wxLC_SMALL_ICON}
  68            Small icon view, with optional labels.
  69     @style{wxLC_ALIGN_TOP}
  70            Icons align to the top. Win32 default, Win32 only.
  71     @style{wxLC_ALIGN_LEFT}
  72            Icons align to the left.
  73     @style{wxLC_AUTOARRANGE}
  74            Icons arrange themselves. Win32 only.
  75     @style{wxLC_EDIT_LABELS}
  76            Labels are editable: the application will be notified when editing
  77            starts.
  78     @style{wxLC_NO_HEADER}
  79            No header in report mode.
  80     @style{wxLC_SINGLE_SEL}
  81            Single selection (default is multiple).
  82     @style{wxLC_SORT_ASCENDING}
  83            Sort in ascending order. (You must still supply a comparison callback
  84            in wxListCtrl::SortItems.)
  85     @style{wxLC_SORT_DESCENDING}
  86            Sort in descending order. (You must still supply a comparison callback
  87            in wxListCtrl::SortItems.)
  88     @style{wxLC_HRULES}
  89            Draws light horizontal rules between rows in report mode.
  90     @style{wxLC_VRULES}
  91            Draws light vertical rules between columns in report mode.
  92     @endStyleTable
  93
  94
  95     @beginEventTable{wxListEvent}
  96     @event{EVT_LIST_BEGIN_DRAG(id, func)}
  97            Begin dragging with the left mouse button.
  98     @event{EVT_LIST_BEGIN_RDRAG(id, func)}
  99            Begin dragging with the right mouse button..
 100     @event{EVT_BEGIN_LABEL_EDIT(id, func)}
 101            Begin editing a label. This can be prevented by calling Veto().
 102     @event{EVT_LIST_END_LABEL_EDIT(id, func)}
 103            Finish editing a label. This can be prevented by calling Veto().
 104     @event{EVT_LIST_DELETE_ITEM(id, func)}
 105            An item was deleted.
 106     @event{EVT_LIST_DELETE_ALL_ITEMS(id, func)}
 107            All items were deleted.
 108     @event{EVT_LIST_ITEM_SELECTED(id, func)}
 109            The item has been selected.
 110     @event{EVT_LIST_ITEM_DESELECTED(id, func)}
 111            The item has been deselected.
 112     @event{EVT_LIST_ITEM_ACTIVATED(id, func)}
 113            The item has been activated (ENTER or double click).
 114     @event{EVT_LIST_ITEM_FOCUSED(id, func)}
 115            The currently focused item has changed.
 116     @event{EVT_LIST_ITEM_MIDDLE_CLICK(id, func)}
 117            The middle mouse button has been clicked on an item.
 118     @event{EVT_LIST_ITEM_RIGHT_CLICK(id, func)}
 119           The right mouse button has been clicked on an item.
 120     @event{EVT_LIST_KEY_DOWN(id, func)}
 121            A key has been pressed.
 122     @event{EVT_LIST_INSERT_ITEM(id, func)}
 123            An item has been inserted.
 124     @event{EVT_LIST_COL_CLICK(id, func)}
 125            A column (m_col) has been left-clicked.
 126     @event{EVT_LIST_COL_RIGHT_CLICK(id, func)}
 127            A column (m_col) has been right-clicked.
 128     @event{EVT_LIST_COL_BEGIN_DRAG(id, func)}
 129            The user started resizing a column - can be vetoed.
 130     @event{EVT_LIST_COL_DRAGGING(id, func)}
 131            The divider between columns is being dragged.
 132     @event{EVT_LIST_COL_END_DRAG(id, func)}
 133            A column has been resized by the user.
 134     @event{EVT_LIST_CACHE_HINT(id, func)}
 135            Prepare cache for a virtual list control.
 136     @endEventTable
 137
 138
 139     @library{wxcore}
 140     @category{ctrl}
 141     @appearance{listctrl.png}
 142
 143     @see @ref overview_listctrl, wxListView, wxListBox, wxTreeCtrl, wxImageList,
 144          wxListEvent, wxListItem, wxEditableListBox
 145 */
 146 class wxListCtrl : public wxControl
 147 {
 148 public:
 149     /**
 150        Default constructor.
 151     */
 152     wxListCtrl();
 153
 154     /**
 155         Constructor, creating and showing a list control.
 156
 157         @param parent
 158             Parent window. Must not be @NULL.
 159         @param id
 160             Window identifier. The value wxID_ANY indicates a default value.
 161         @param pos
 162             Window position.
 163         @param size
 164             Window size.
 165             If wxDefaultSize is specified then the window is sized appropriately.
 166         @param style
 167             Window style. See wxListCtrl.
 168         @param validator
 169             Window validator.
 170         @param name
 171             Window name.
 172
 173         @see Create(), wxValidator
 174     */
 175     wxListCtrl(wxWindow* parent, wxWindowID id,
 176                const wxPoint& pos = wxDefaultPosition,
 177                const wxSize& size = wxDefaultSize,
 178                long style = wxLC_ICON,
 179                const wxValidator& validator = wxDefaultValidator,
 180                const wxString& name = wxListCtrlNameStr);
 181
 182     /**
 183         Destructor, destroying the list control.
 184     */
 185     virtual ~wxListCtrl();
 186
 187     /**
 188         Arranges the items in icon or small icon view.
 189         This only has effect on Win32. @a flag is one of:
 190         - wxLIST_ALIGN_DEFAULT: Default alignment.
 191         - wxLIST_ALIGN_LEFT: Align to the left side of the control.
 192         - wxLIST_ALIGN_TOP: Align to the top side of the control.
 193         - wxLIST_ALIGN_SNAP_TO_GRID: Snap to grid.
 194     */
 195     bool Arrange(int flag = wxLIST_ALIGN_DEFAULT);
 196
 197     /**
 198         Sets the image list associated with the control and takes ownership of it
 199         (i.e. the control will, unlike when using SetImageList(), delete the list
 200         when destroyed). @a which is one of @c wxIMAGE_LIST_NORMAL, @c wxIMAGE_LIST_SMALL,
 201         @c wxIMAGE_LIST_STATE (the last is unimplemented).
 202
 203         @see SetImageList()
 204     */
 205     void AssignImageList(wxImageList* imageList, int which);
 206
 207     /**
 208         Deletes all items and all columns.
 209     */
 210     void ClearAll();
 211
 212     /**
 213         Creates the list control. See wxListCtrl() for further details.
 214     */
 215     bool Create(wxWindow* parent, wxWindowID id,
 216                 const wxPoint& pos = wxDefaultPosition,
 217                 const wxSize& size = wxDefaultSize,
 218                 long style = wxLC_ICON,
 219                 const wxValidator& validator = wxDefaultValidator,
 220                 const wxString& name = wxListCtrlNameStr);
 221
 222     /**
 223         Deletes all items in the list control.
 224
 225         @note This function does @e not send the @c wxEVT_COMMAND_LIST_DELETE_ITEM
 226               event because deleting many items from the control would be too slow
 227               then (unlike wxListCtrl::DeleteItem).
 228     */
 229     bool DeleteAllItems();
 230
 231     /**
 232         Deletes a column.
 233     */
 234     bool DeleteColumn(int col);
 235
 236     /**
 237         Deletes the specified item.
 238         This function sends the @c wxEVT_COMMAND_LIST_DELETE_ITEM event for the
 239         item being deleted.
 240
 241         @see DeleteAllItems()
 242     */
 243     bool DeleteItem(long item);
 244
 245     /**
 246         Starts editing the label of the given item.
 247
 248         This function generates a @c EVT_LIST_BEGIN_LABEL_EDIT event which can be
 249         vetoed so that no text control will appear for in-place editing.
 250
 251         If the user changed the label (i.e. s/he does not press ESC or leave
 252         the text control without changes, a @c EVT_LIST_END_LABEL_EDIT event
 253         will be sent which can be vetoed as well.
 254     */
 255     wxTextCtrl* EditLabel(long item,
 256                           wxClassInfo* textControlClass = CLASSINFO(wxTextCtrl));
 257
 258     /**
 259         Ensures this item is visible.
 260     */
 261     bool EnsureVisible(long item);
 262
 263     /**
 264         Find an item whose label matches this string, starting from start or the
 265         beginning if start is @c -1. The string comparison is case insensitive.
 266
 267         If @a partial is @true then this method will look for items which begin with @a str.
 268     */
 269     long FindItem(long start, const wxString& str,
 270                   bool partial = false);
 271
 272     /**
 273         Find an item whose data matches this data, starting from start or the
 274         beginning if 'start' is @c -1.
 275     */
 276     long FindItem(long start, wxUIntPtr data);
 277
 278     /**
 279         Find an item nearest this position in the specified direction,
 280         starting from @a start or the beginning if @a start is -1.
 281     */
 282     long FindItem(long start, const wxPoint& pt, int direction);
 283
 284     /**
 285         Gets information about this column.
 286         See SetItem() for more information.
 287     */
 288     bool GetColumn(int col, wxListItem& item) const;
 289
 290     /**
 291         Returns the number of columns.
 292     */
 293     int GetColumnCount() const;
 294
 295     /**
 296         Gets the column number by visual order index (report view only).
 297     */
 298     int GetColumnIndexFromOrder(int order) const;
 299
 300     /**
 301         Gets the column visual order index (valid in report view only).
 302     */
 303     int GetColumnOrder(int col) const;
 304
 305     /**
 306         Gets the column width (report view only).
 307     */
 308     int GetColumnWidth(int col) const;
 309
 310     /**
 311         Returns the array containing the orders of all columns.
 312         On error, an empty array is returned.
 313     */
 314     wxArrayInt GetColumnsOrder() const;
 315
 316     /**
 317         Gets the number of items that can fit vertically in the visible area of
 318         the list control (list or report view) or the total number of items in
 319         the list control (icon or small icon view).
 320     */
 321     int GetCountPerPage() const;
 322
 323     /**
 324         Returns the edit control being currently used to edit a label.
 325         Returns @NULL if no label is being edited.
 326
 327         @note It is currently only implemented for wxMSW and the generic version,
 328               not for the native Mac OS X version.
 329     */
 330     wxTextCtrl* GetEditControl() const;
 331
 332     /**
 333         Returns the specified image list. @a which may be one of:
 334         - wxIMAGE_LIST_NORMAL: The normal (large icon) image list.
 335         - wxIMAGE_LIST_SMALL: The small icon image list.
 336         - wxIMAGE_LIST_STATE: The user-defined state image list (unimplemented).
 337     */
 338     wxImageList* GetImageList(int which) const;
 339
 340     /**
 341         Gets information about the item. See SetItem() for more information.
 342         You must call @e info.SetId() to the ID of item you're interested in
 343         before calling this method.
 344     */
 345     bool GetItem(wxListItem& info) const;
 346
 347     /**
 348         Returns the colour for this item.
 349         If the item has no specific colour, returns an invalid colour
 350         (and not the default background control of the control itself).
 351
 352         @see GetItemTextColour()
 353     */
 354     wxColour GetItemBackgroundColour(long item) const;
 355
 356     /**
 357         Returns the number of items in the list control.
 358     */
 359     int GetItemCount() const;
 360
 361     /**
 362         Gets the application-defined data associated with this item.
 363     */
 364     wxUIntPtr GetItemData(long item) const;
 365
 366     /**
 367         Returns the item's font.
 368     */
 369     wxFont GetItemFont(long item) const;
 370
 371     /**
 372         Returns the position of the item, in icon or small icon view.
 373     */
 374     bool GetItemPosition(long item, wxPoint& pos) const;
 375
 376     /**
 377         Returns the rectangle representing the item's size and position, in physical
 378         coordinates.
 379
 380         @a code is one of wxLIST_RECT_BOUNDS, wxLIST_RECT_ICON, wxLIST_RECT_LABEL.
 381     */
 382     bool GetItemRect(long item, wxRect& rect,
 383                      int code = wxLIST_RECT_BOUNDS) const;
 384
 385     /**
 386         Retrieves the spacing between icons in pixels: horizontal spacing is
 387         returned as @c x component of the wxSize object and the vertical spacing
 388         as its @c y component.
 389     */
 390     wxSize GetItemSpacing() const;
 391
 392     /**
 393         Gets the item state. For a list of state flags, see SetItem().
 394         The @a stateMask indicates which state flags are of interest.
 395     */
 396     int GetItemState(long item, long stateMask) const;
 397
 398     /**
 399         Gets the item text for this item.
 400     */
 401     wxString GetItemText(long item) const;
 402
 403     /**
 404         Returns the colour for this item.
 405
 406         If the item has no specific colour, returns an invalid colour (and not the
 407         default foreground control of the control itself as this wouldn't allow
 408         distinguishing between items having the same colour as the current control
 409         foreground and items with default colour which, hence, have always the
 410         same colour as the control).
 411     */
 412     wxColour GetItemTextColour(long item) const;
 413
 414     /**
 415         Searches for an item with the given geometry or state, starting from
 416         @a item but excluding the @a item itself.
 417
 418         If @a item is -1, the first item that matches the specified flags will be returned.
 419         Returns the first item with given state following @a item or -1 if no such item found.
 420         This function may be used to find all selected items in the control like this:
 421
 422         @code
 423         long item = -1;
 424         for ( ;; )
 425         {
 426             item = listctrl->GetNextItem(item,
 427                                         wxLIST_NEXT_ALL,
 428                                         wxLIST_STATE_SELECTED);
 429             if ( item == -1 )
 430                 break;
 431
 432             // this item is selected - do whatever is needed with it
 433             wxLogMessage("Item %ld is selected.", item);
 434         }
 435         @endcode
 436
 437         @a geometry can be one of:
 438         - wxLIST_NEXT_ABOVE: Searches for an item above the specified item.
 439         - wxLIST_NEXT_ALL: Searches for subsequent item by index.
 440         - wxLIST_NEXT_BELOW: Searches for an item below the specified item.
 441         - wxLIST_NEXT_LEFT: Searches for an item to the left of the specified item.
 442         - wxLIST_NEXT_RIGHT: Searches for an item to the right of the specified item.
 443
 444         @note this parameter is only supported by wxMSW currently and ignored on
 445               other platforms.
 446
 447         @a state can be a bitlist of the following:
 448         - wxLIST_STATE_DONTCARE: Don't care what the state is.
 449         - wxLIST_STATE_DROPHILITED: The item indicates it is a drop target.
 450         - wxLIST_STATE_FOCUSED: The item has the focus.
 451         - wxLIST_STATE_SELECTED: The item is selected.
 452         - wxLIST_STATE_CUT: The item is selected as part of a cut and paste operation.
 453     */
 454     long GetNextItem(long item, int geometry = wxLIST_NEXT_ALL,
 455                      int state = wxLIST_STATE_DONTCARE) const;
 456
 457     /**
 458         Returns the number of selected items in the list control.
 459     */
 460     int GetSelectedItemCount() const;
 461
 462     /**
 463         Returns the rectangle representing the size and position, in physical
 464         coordinates, of the given subitem, i.e. the part of the row @a item in the
 465         column @a subItem.
 466
 467         This method is only meaningfull when the wxListCtrl is in the report mode.
 468         If @a subItem parameter is equal to the special value
 469         @c wxLIST_GETSUBITEMRECT_WHOLEITEM the return value is the same as
 470         for GetItemRect().
 471
 472         @a code can be one of @c wxLIST_RECT_BOUNDS, @c wxLIST_RECT_ICON or
 473         @c wxLIST_RECT_LABEL.
 474
 475         @since 2.7.0
 476     */
 477     bool GetSubItemRect(long item, long subItem, wxRect& rect,
 478                         int code = wxLIST_RECT_BOUNDS) const;
 479
 480     /**
 481         Gets the text colour of the list control.
 482     */
 483     wxColour GetTextColour() const;
 484
 485     /**
 486         Gets the index of the topmost visible item when in list or report view.
 487     */
 488     long GetTopItem() const;
 489
 490     /**
 491         Returns the rectangle taken by all items in the control. In other words, if the
 492         controls client size were equal to the size of this rectangle, no scrollbars
 493         would be needed and no free space would be left.
 494
 495         Note that this function only works in the icon and small icon views, not in
 496         list or report views (this is a limitation of the native Win32 control).
 497     */
 498     wxRect GetViewRect() const;
 499
 500     /**
 501         Determines which item (if any) is at the specified point, giving details
 502         in @a flags. Returns index of the item or @c wxNOT_FOUND if no item is at
 503         the specified point.
 504
 505         @a flags will be a combination of the following flags:
 506         - wxLIST_HITTEST_ABOVE: Above the client area.
 507         - wxLIST_HITTEST_BELOW: Below the client area.
 508         - wxLIST_HITTEST_NOWHERE: In the client area but below the last item.
 509         - wxLIST_HITTEST_ONITEMICON: On the bitmap associated with an item.
 510         - wxLIST_HITTEST_ONITEMLABEL: On the label (string) associated with an item.
 511         - wxLIST_HITTEST_ONITEMRIGHT: In the area to the right of an item.
 512         - wxLIST_HITTEST_ONITEMSTATEICON: On the state icon for a tree view item
 513           that is in a user-defined state.
 514         - wxLIST_HITTEST_TOLEFT: To the right of the client area.
 515         - wxLIST_HITTEST_TORIGHT: To the left of the client area.
 516         - wxLIST_HITTEST_ONITEM: Combination of @c wxLIST_HITTEST_ONITEMICON,
 517           @c wxLIST_HITTEST_ONITEMLABEL, @c wxLIST_HITTEST_ONITEMSTATEICON.
 518
 519         If @a ptrSubItem is not @NULL and the wxListCtrl is in the report
 520         mode the subitem (or column) number will also be provided.
 521         This feature is only available in version 2.7.0 or higher and is currently only
 522         implemented under wxMSW and requires at least comctl32.dll of verion 4.70 on
 523         the host system or the value stored in @a ptrSubItem will be always -1.
 524         To compile this feature into wxWidgets library you need to have access to
 525         commctrl.h of version 4.70 that is provided by Microsoft.
 526     */
 527     long HitTest(const wxPoint& point, int& flags, long* ptrSubItem = NULL) const;
 528
 529     /**
 530         For report view mode (only), inserts a column. For more details, see SetItem().
 531     */
 532     long InsertColumn(long col, wxListItem& info);
 533
 534     /**
 535         For report view mode (only), inserts a column. For more details, see SetItem().
 536     */
 537     long InsertColumn(long col, const wxString& heading,
 538                       int format = wxLIST_FORMAT_LEFT,
 539                       int width = -1);
 540
 541     /**
 542         Inserts an item, returning the index of the new item if successful, -1 otherwise.
 543
 544         @param info
 545             wxListItem object
 546     */
 547     long InsertItem(wxListItem& info);
 548
 549     /**
 550         Insert an string item.
 551
 552         @param index
 553             Index of the new item, supplied by the application
 554         @param label
 555             String label
 556     */
 557     long InsertItem(long index, const wxString& label);
 558
 559     /**
 560         Insert an image item.
 561
 562         @param index
 563             Index of the new item, supplied by the application
 564         @param imageIndex
 565             Index into the image list associated with this control and view style
 566     */
 567     long InsertItem(long index, int imageIndex);
 568
 569     /**
 570         Insert an image/string item.
 571
 572         @param index
 573             Index of the new item, supplied by the application
 574         @param label
 575             String label
 576         @param imageIndex
 577             Index into the image list associated with this control and view style
 578     */
 579     long InsertItem(long index, const wxString& label,
 580                     int imageIndex);
 581
 582     /**
 583         Redraws the given @e item.
 584
 585         This is only useful for the virtual list controls as without calling this
 586         function the displayed value of the item doesn't change even when the
 587         underlying data does change.
 588
 589         @see RefreshItems()
 590     */
 591     void RefreshItem(long item);
 592
 593     /**
 594         Redraws the items between @a itemFrom and @e itemTo.
 595         The starting item must be less than or equal to the ending one.
 596
 597         Just as RefreshItem() this is only useful for virtual list controls.
 598     */
 599     void RefreshItems(long itemFrom, long itemTo);
 600
 601     /**
 602         Scrolls the list control. If in icon, small icon or report view mode,
 603         @a dx specifies the number of pixels to scroll. If in list view mode,
 604         @a dx specifies the number of columns to scroll. @a dy always specifies
 605         the number of pixels to scroll vertically.
 606
 607         @note This method is currently only implemented in the Windows version.
 608     */
 609     bool ScrollList(int dx, int dy);
 610
 611     /**
 612         Sets the background colour.
 613
 614         Note that the wxWindow::GetBackgroundColour() function of wxWindow base
 615         class can be used to retrieve the current background colour.
 616     */
 617     virtual bool SetBackgroundColour(const wxColour& col);
 618
 619     /**
 620         Sets information about this column.
 621         See SetItem() for more information.
 622     */
 623     bool SetColumn(int col, wxListItem& item);
 624
 625     /**
 626         Sets the column width.
 627
 628         @a width can be a width in pixels or @c wxLIST_AUTOSIZE (-1) or
 629         @c wxLIST_AUTOSIZE_USEHEADER (-2).
 630
 631         @c wxLIST_AUTOSIZE will resize the column to the length of its longest item.
 632
 633         @c wxLIST_AUTOSIZE_USEHEADER will resize the column to the length of the
 634         header (Win32) or 80 pixels (other platforms).
 635
 636         In small or normal icon view, @a col must be -1, and the column width is set
 637         for all columns.
 638     */
 639     bool SetColumnWidth(int col, int width);
 640
 641     /**
 642         Sets the order of all columns at once.
 643
 644         The @a orders array must have the same number elements as the number of
 645         columns and contain each position exactly once.
 646
 647         This function is valid in report view only.
 648     */
 649     bool SetColumnOrder(const wxArrayInt& orders) const;
 650
 651     /**
 652         Sets the image list associated with the control.
 653
 654         @a which is one of @c wxIMAGE_LIST_NORMAL, @c wxIMAGE_LIST_SMALL,
 655         @c wxIMAGE_LIST_STATE (the last is unimplemented).
 656
 657         This method does not take ownership of the image list, you have to
 658         delete it yourself.
 659
 660         @see AssignImageList()
 661     */
 662     void SetImageList(wxImageList* imageList, int which);
 663
 664     /**
 665         Sets the data of an item.
 666
 667         Using the wxListItem's mask and state mask, you can change only selected
 668         attributes of a wxListCtrl item.
 669     */
 670     bool SetItem(wxListItem& info);
 671
 672     /**
 673         Sets an item string field at a particular column.
 674     */
 675     long SetItem(long index, int column, const wxString& label, int imageId = -1);
 676
 677     /**
 678         Sets the background colour for this item.
 679         This function only works in report view mode.
 680         The colour can be retrieved using GetItemBackgroundColour().
 681     */
 682     void SetItemBackgroundColour(long item, const wxColour& col);
 683
 684     /**
 685         Sets the image associated with the item.
 686         In report view, you can specify the column.
 687         The image is an index into the image list associated with the list control.
 688     */
 689     bool SetItemColumnImage(long item, long column, int image);
 690
 691     /**
 692         This method can only be used with virtual list controls.
 693
 694         It is used to indicate to the control the number of items it contains.
 695         After calling it, the main program should be ready to handle calls to
 696         various item callbacks (such as wxListCtrl::OnGetItemText) for all
 697         items in the range from 0 to @a count.
 698
 699         Notice that the control is not necessarily redrawn after this call as
 700         it may be undesirable if an item which is not visible on the screen
 701         anyhow was added to or removed from a control displaying many items, if
 702         you do need to refresh the display you can just call Refresh() manually.
 703     */
 704     void SetItemCount(long count);
 705
 706     /**
 707         Associates application-defined data with this item.
 708
 709         Notice that this function cannot be used to associate pointers with the control
 710         items, use SetItemPtrData() instead.
 711     */
 712     bool SetItemData(long item, long data);
 713
 714     /**
 715          Sets the item's font.
 716     */
 717     void SetItemFont(long item, const wxFont& font);
 718
 719     /**
 720         Sets the unselected and selected images associated with the item.
 721         The images are indices into the image list associated with the list control.
 722     */
 723     bool SetItemImage(long item, int image, int selImage = -1);
 724
 725     /**
 726         Sets the unselected and selected images associated with the item.
 727         The images are indices into the image list associated with the list control.
 728
 729         @deprecated
 730         This form is deprecated: @a selImage is not used; use the other
 731         SetItemImage() overload.
 732     */
 733     bool SetItemImage(long item, int image, int selImage = -1);
 734
 735     /**
 736         Sets the position of the item, in icon or small icon view. Windows only.
 737     */
 738     bool SetItemPosition(long item, const wxPoint& pos);
 739
 740     /**
 741         Associates application-defined data with this item.
 742
 743         The @a data parameter may be either an integer or a pointer cast to the
 744         @c wxUIntPtr type which is guaranteed to be large enough to be able to
 745         contain all integer types and pointers.
 746
 747         @since 2.8.4
 748     */
 749     bool SetItemPtrData(long item, wxUIntPtr data);
 750
 751     /**
 752         Sets the item state. For a list of state flags, see SetItem().
 753         The @b stateMask indicates which state flags are valid.
 754     */
 755     bool SetItemState(long item, long state, long stateMask);
 756
 757     /**
 758         Sets the item text for this item.
 759     */
 760     void SetItemText(long item, const wxString& text);
 761
 762     /**
 763         Sets the colour for this item.
 764         This function only works in report view.
 765         The colour can be retrieved using GetItemTextColour().
 766     */
 767     void SetItemTextColour(long item, const wxColour& col);
 768
 769     /**
 770         Adds or removes a single window style.
 771     */
 772     void SetSingleStyle(long style, bool add = true);
 773
 774     /**
 775         Sets the text colour of the list control.
 776     */
 777     void SetTextColour(const wxColour& col);
 778
 779     /**
 780         Sets the whole window style, deleting all items.
 781     */
 782     void SetWindowStyleFlag(long style);
 783
 784     /**
 785         Call this function to sort the items in the list control. Sorting is done
 786         using the specified @a fnSortCallBack function. This function must have the
 787         following prototype:
 788         @code
 789         int wxCALLBACK wxListCompareFunction(long item1, long item2, long sortData)
 790         @endcode
 791
 792         It is called each time when the two items must be compared and should return 0
 793         if the items are equal, negative value if the first item is less than the
 794         second one and positive value if the first one is greater than the second one
 795         (the same convention as used by @c qsort(3)).
 796
 797         The parameter @e item1 is the client data associated with the first item (NOT the index).
 798         The parameter @e item2 is the client data associated with the second item (NOT the index).
 799         The parameter @e data is the value passed to SortItems() itself.
 800
 801         Notice that the control may only be sorted on client data associated with
 802         the items, so you must use SetItemData if you want to be able to sort the
 803         items in the control.
 804
 805         Please see the @ref page_samples_listctrl for an example of using this function.
 806     */
 807     bool SortItems(wxListCtrlCompare fnSortCallBack, long data);
 808
 809 protected:
 810
 811     /**
 812         This function may be overloaded in the derived class for a control with
 813         @c wxLC_VIRTUAL style. It should return the attribute for the specified
 814         @c item or @NULL to use the default appearance parameters.
 815
 816         wxListCtrl will not delete the pointer or keep a reference of it.
 817         You can return the same wxListItemAttr pointer for every OnGetItemAttr() call.
 818
 819         The base class version always returns @NULL.
 820
 821         @see OnGetItemImage(), OnGetItemColumnImage(), OnGetItemText()
 822     */
 823     virtual wxListItemAttr* OnGetItemAttr(long item) const;
 824
 825     /**
 826         Overload this function in the derived class for a control with
 827         @c wxLC_VIRTUAL and @c wxLC_REPORT styles in order to specify the image
 828         index for the given line and column.
 829
 830         The base class version always calls OnGetItemImage() for the first column, else
 831         it returns -1.
 832
 833         @see OnGetItemText(), OnGetItemImage(), OnGetItemAttr()
 834     */
 835     virtual int OnGetItemColumnImage(long item, long column) const;
 836
 837     /**
 838         This function must be overloaded in the derived class for a control with
 839         @c wxLC_VIRTUAL style having an @ref SetImageList() "image list"
 840         (if the control doesn't have an image list, it is not necessary to overload it).
 841         It should return the index of the items image in the controls image list
 842         or -1 for no image.
 843
 844         In a control with @c wxLC_REPORT style, OnGetItemImage() only gets called for
 845         the first column of each line.
 846
 847         The base class version always returns -1.
 848
 849         @see OnGetItemText(), OnGetItemColumnImage(), OnGetItemAttr()
 850     */
 851     virtual int OnGetItemImage(long item) const;
 852
 853     /**
 854         This function @b must be overloaded in the derived class for a control with
 855         @c wxLC_VIRTUAL style. It should return the string containing the text of
 856         the given @a column for the specified @c item.
 857
 858         @see SetItemCount(), OnGetItemImage(), OnGetItemColumnImage(), OnGetItemAttr()
 859     */
 860     virtual wxString OnGetItemText(long item, long column) const;
 861 };
 862
 863
 864
 865 /**
 866     @class wxListEvent
 867
 868     A list event holds information about events associated with wxListCtrl objects.
 869
 870     @beginEventTable{wxListEvent}
 871     @event{EVT_LIST_BEGIN_DRAG(id, func)}
 872         Begin dragging with the left mouse button.
 873     @event{EVT_LIST_BEGIN_RDRAG(id, func)}
 874         Begin dragging with the right mouse button.
 875     @event{EVT_LIST_BEGIN_LABEL_EDIT(id, func)}
 876         Begin editing a label. This can be prevented by calling Veto().
 877     @event{EVT_LIST_END_LABEL_EDIT(id, func)}
 878         Finish editing a label. This can be prevented by calling Veto().
 879     @event{EVT_LIST_DELETE_ITEM(id, func)}
 880         Delete an item.
 881     @event{EVT_LIST_DELETE_ALL_ITEMS(id, func)}
 882         Delete all items.
 883     @event{EVT_LIST_ITEM_SELECTED(id, func)}
 884         The item has been selected.
 885     @event{EVT_LIST_ITEM_DESELECTED(id, func)}
 886         The item has been deselected.
 887     @event{EVT_LIST_ITEM_ACTIVATED(id, func)}
 888         The item has been activated (ENTER or double click).
 889     @event{EVT_LIST_ITEM_FOCUSED(id, func)}
 890         The currently focused item has changed.
 891     @event{EVT_LIST_ITEM_MIDDLE_CLICK(id, func)}
 892         The middle mouse button has been clicked on an item.
 893     @event{EVT_LIST_ITEM_RIGHT_CLICK(id, func)}
 894         The right mouse button has been clicked on an item.
 895     @event{EVT_LIST_KEY_DOWN(id, func)}
 896         A key has been pressed.
 897     @event{EVT_LIST_INSERT_ITEM(id, func)}
 898         An item has been inserted.
 899     @event{EVT_LIST_COL_CLICK(id, func)}
 900         A column (m_col) has been left-clicked.
 901     @event{EVT_LIST_COL_RIGHT_CLICK(id, func)}
 902         A column (m_col) (which can be -1 if the click occurred outside any column)
 903         has been right-clicked.
 904     @event{EVT_LIST_COL_BEGIN_DRAG(id, func)}
 905         The user started resizing a column - can be vetoed.
 906     @event{EVT_LIST_COL_DRAGGING(id, func)}
 907         The divider between columns is being dragged.
 908     @event{EVT_LIST_COL_END_DRAG(id, func)}
 909         A column has been resized by the user.
 910     @event{EVT_LIST_CACHE_HINT(id, func)}
 911         Prepare cache for a virtual list control
 912     @endEventTable
 913
 914
 915     @library{wxbase}
 916     @category{events}
 917
 918     @see wxListCtrl
 919 */
 920 class wxListEvent : public wxNotifyEvent
 921 {
 922 public:
 923     /**
 924         Constructor.
 925     */
 926     wxListEvent(wxEventType commandType = wxEVT_NULL, int id = 0);
 927
 928     /**
 929         For @c EVT_LIST_CACHE_HINT event only: return the first item which the
 930         list control advises us to cache.
 931     */
 932     long GetCacheFrom() const;
 933
 934     /**
 935         For @c EVT_LIST_CACHE_HINT event only: return the last item (inclusive)
 936         which the list control advises us to cache.
 937     */
 938     long GetCacheTo() const;
 939
 940     /**
 941         The column position: it is only used with @c COL events.
 942
 943         For the column dragging events, it is the column to the left of the divider
 944         being dragged, for the column click events it may be -1 if the user clicked
 945         in the list control header outside any column.
 946     */
 947     int GetColumn() const;
 948
 949     /**
 950         The data.
 951     */
 952     long GetData() const;
 953
 954     /**
 955         The image.
 956     */
 957     int GetImage() const;
 958
 959     /**
 960         The item index.
 961     */
 962     long GetIndex() const;
 963
 964     /**
 965         An item object, used by some events. See also wxListCtrl::SetItem.
 966     */
 967     const wxListItem& GetItem() const;
 968
 969     /**
 970         Key code if the event is a keypress event.
 971     */
 972     int GetKeyCode() const;
 973
 974     /**
 975         The (new) item label for @c EVT_LIST_END_LABEL_EDIT event.
 976     */
 977     const wxString& GetLabel() const;
 978
 979     /**
 980         The mask.
 981     */
 982     long GetMask() const;
 983
 984     /**
 985         The position of the mouse pointer if the event is a drag event.
 986     */
 987     wxPoint GetPoint() const;
 988
 989     /**
 990         The text.
 991     */
 992     const wxString& GetText() const;
 993
 994     /**
 995         This method only makes sense for @c EVT_LIST_END_LABEL_EDIT message and
 996         returns @true if it the label editing has been cancelled by the user
 997         (GetLabel() returns an empty string in this case but it doesn't allow the
 998         application to distinguish between really cancelling the edit and the
 999         admittedly rare case when the user wants to rename it to an empty string).
1000     */
1001     bool IsEditCancelled() const;
1002 };
1003
1004
1005
1006 /**
1007     @class wxListItemAttr
1008
1009     Represents the attributes (color, font, ...) of a wxListCtrl's wxListItem.
1010
1011     @library{wxbase}
1012     @category{ctrl}
1013
1014     @see @ref overview_listctrl, wxListCtrl, wxListItem
1015 */
1016 class wxListItemAttr
1017 {
1018 public:
1019     /**
1020         Default Constructor.
1021     */
1022     wxListItemAttr();
1023
1024     /**
1025         Construct a wxListItemAttr with the specified foreground and
1026         background colors and font.
1027     */
1028     wxListItemAttr(const wxColour& colText,
1029                    const wxColour& colBack,
1030                    const wxFont& font);
1031
1032     /**
1033         Returns the currently set background color.
1034     */
1035     const wxColour& GetBackgroundColour() const;
1036
1037     /**
1038         Returns the currently set font.
1039     */
1040     const wxFont& GetFont() const;
1041
1042     /**
1043         Returns the currently set text color.
1044     */
1045     const wxColour& GetTextColour() const;
1046
1047     /**
1048         Returns @true if the currently set background color is valid.
1049     */
1050     bool HasBackgroundColour() const;
1051
1052     /**
1053         Returns @true if the currently set font is valid.
1054     */
1055     bool HasFont() const;
1056
1057     /**
1058         Returns @true if the currently set text color is valid.
1059     */
1060     bool HasTextColour() const;
1061
1062     /**
1063         Sets a new background color.
1064     */
1065     void SetBackgroundColour(const wxColour& colour);
1066
1067     /**
1068         Sets a new font.
1069     */
1070     void SetFont(const wxFont& font);
1071
1072     /**
1073         Sets a new text color.
1074     */
1075     void SetTextColour(const wxColour& colour);
1076 };
1077
1078
1079
1080 /**
1081     @class wxListView
1082
1083     This class currently simply presents a simpler to use interface for the
1084     wxListCtrl -- it can be thought of as a @e façade for that complicated class.
1085
1086     Using it is preferable to using wxListCtrl directly whenever possible because
1087     in the future some ports might implement wxListView but not the full set of
1088     wxListCtrl features.
1089
1090     Other than different interface, this class is identical to wxListCtrl.
1091     In particular, it uses the same events, same window styles and so on.
1092
1093     @library{wxcore}
1094     @category{ctrl}
1095     @appearance{listview.png}
1096
1097     @see wxListView::SetColumnImage
1098 */
1099 class wxListView : public wxListCtrl
1100 {
1101 public:
1102     /**
1103         Resets the column image -- after calling this function, no image will be shown.
1104
1105         @param col
1106             the column to clear image for
1107
1108         @see SetColumnImage()
1109     */
1110     void ClearColumnImage(int col);
1111
1112     /**
1113         Sets focus to the item with the given @a index.
1114     */
1115     void Focus(long index);
1116
1117     /**
1118         Returns the first selected item in a (presumably) multiple selection control.
1119         Together with GetNextSelected() it can be used to iterate over all selected
1120         items in the control.
1121
1122         @return The first selected item, if any, -1 otherwise.
1123     */
1124     long GetFirstSelected() const;
1125
1126     /**
1127         Returns the currently focused item or -1 if none.
1128
1129         @see IsSelected(), Focus()
1130     */
1131     long GetFocusedItem() const;
1132
1133     /**
1134         Used together with GetFirstSelected() to iterate over all selected items
1135         in the control.
1136
1137         @return Returns the next selected item or -1 if there are no more of them.
1138     */
1139     long GetNextSelected(long item) const;
1140
1141     /**
1142         Returns @true if the item with the given @a index is selected,
1143         @false otherwise.
1144
1145         @see GetFirstSelected(), GetNextSelected()
1146     */
1147     bool IsSelected(long index) const;
1148
1149     /**
1150         Selects or unselects the given item.
1151
1152         @param n
1153             the item to select or unselect
1154         @param on
1155             if @true (default), selects the item, otherwise unselects it
1156
1157         @see wxListCtrl::SetItemState
1158     */
1159     void Select(long n, bool on = true);
1160
1161     /**
1162         Sets the column image for the specified column.
1163         To use the column images, the control must have a valid image list with
1164         at least one image.
1165
1166         @param col
1167             the column to set image for
1168         @param image
1169             the index of the column image in the controls image list
1170     */
1171     void SetColumnImage(int col, int image);
1172 };
1173
1174
1175 /**
1176     Column format (MSW only except wxLIST_FORMAT_LEFT).
1177 */
1178 enum wxListColumnFormat
1179 {
1180     wxLIST_FORMAT_LEFT,
1181     wxLIST_FORMAT_RIGHT,
1182     wxLIST_FORMAT_CENTRE,
1183     wxLIST_FORMAT_CENTER = wxLIST_FORMAT_CENTRE
1184 };
1185
1186 /**
1187     @class wxListItem
1188
1189     This class stores information about a wxListCtrl item or column.
1190
1191     wxListItem is a class which contains informations about:
1192     - Zero based item position; see SetId() and GetId().
1193     - Zero based column index; see SetColumn() and GetColumn().
1194     - The label (or header for columns); see SetText() and GetText().
1195     - The zero based index into an image list; see GetImage() and SetImage().
1196     - Application defined data; see SetData() and GetData().
1197     - For columns only: the width of the column; see SetWidth() and GetWidth().
1198     - For columns only: the format of the column; one of @c wxLIST_FORMAT_LEFT,
1199       @c wxLIST_FORMAT_RIGHT, @c wxLIST_FORMAT_CENTRE. See SetAlign() and GetAlign().
1200     - The state of the item; see SetState() and GetState().
1201       This is a bitlist of the following flags:
1202         - @c wxLIST_STATE_FOCUSED: The item has the focus.
1203         - @c wxLIST_STATE_SELECTED: The item is selected.
1204         - @c wxLIST_STATE_DONTCARE: Don't care what the state is. Win32 only.
1205         - @c wxLIST_STATE_DROPHILITED: The item is highlighted to receive a drop event. Win32 only.
1206         - @c wxLIST_STATE_CUT: The item is in the cut state. Win32 only.
1207     - A mask indicating which state flags are valid; this is a bitlist of the
1208       flags reported above for the item state. See SetStateMask() and GetStateMask().
1209     - A mask indicating which fields of this class are valid; see SetMask() and GetMask().
1210       This is a bitlist of the following flags:
1211         - @c wxLIST_MASK_STATE: The state field is valid.
1212         - @c wxLIST_MASK_TEXT: The label field is valid.
1213         - @c wxLIST_MASK_IMAGE: The image field is valid.
1214         - @c wxLIST_MASK_DATA: The application-defined data field is valid.
1215         - @c wxLIST_MASK_WIDTH: The column width field is valid.
1216         - @c wxLIST_MASK_FORMAT: The column format field is valid.
1217
1218     The wxListItem object can also contain item-specific colour and font
1219     information: for this you need to call one of SetTextColour(), SetBackgroundColour()
1220     or SetFont() functions on it passing it the colour/font to use.
1221     If the colour/font is not specified, the default list control colour/font is used.
1222
1223     @library{wxbase}
1224     @category{ctrl}
1225
1226     @see wxListCtrl
1227 */
1228 class wxListItem : public wxObject
1229 {
1230 public:
1231     /**
1232         Constructor.
1233     */
1234     wxListItem();
1235
1236     /**
1237         Resets the item state to the default.
1238     */
1239     void Clear();
1240
1241     /**
1242         Returns the alignment for this item.
1243         Can be one of @c wxLIST_FORMAT_LEFT, @c wxLIST_FORMAT_RIGHT or @c wxLIST_FORMAT_CENTRE.
1244     */
1245     wxListColumnFormat GetAlign() const;
1246
1247     /**
1248         Returns the background colour for this item.
1249     */
1250     wxColour GetBackgroundColour() const;
1251
1252     /**
1253         Returns the zero-based column; meaningful only in report mode.
1254     */
1255     int GetColumn() const;
1256
1257     /**
1258         Returns client data associated with the control.
1259         Please note that client data is associated with the item and not with subitems.
1260     */
1261     wxUIntPtr GetData() const;
1262
1263     /**
1264         Returns the font used to display the item.
1265     */
1266     wxFont GetFont() const;
1267
1268     /**
1269         Returns the zero-based item position.
1270     */
1271     long GetId() const;
1272
1273     /**
1274         Returns the zero-based index of the image associated with the item into
1275         the image list.
1276     */
1277     int GetImage() const;
1278
1279     /**
1280         Returns a bit mask indicating which fields of the structure are valid.
1281
1282         Can be any combination of the following values:
1283         - wxLIST_MASK_STATE: @b GetState is valid.
1284         - wxLIST_MASK_TEXT: @b GetText is valid.
1285         - wxLIST_MASK_IMAGE: @b GetImage is valid.
1286         - wxLIST_MASK_DATA: @b GetData is valid.
1287         - wxLIST_MASK_WIDTH: @b GetWidth is valid.
1288         - wxLIST_MASK_FORMAT: @b GetFormat is valid.
1289     */
1290     long GetMask() const;
1291
1292     /**
1293         Returns a bit field representing the state of the item.
1294
1295         Can be any combination of:
1296         - wxLIST_STATE_DONTCARE: Don't care what the state is. Win32 only.
1297         - wxLIST_STATE_DROPHILITED: The item is highlighted to receive a drop event. Win32 only.
1298         - wxLIST_STATE_FOCUSED: The item has the focus.
1299         - wxLIST_STATE_SELECTED: The item is selected.
1300         - wxLIST_STATE_CUT: The item is in the cut state. Win32 only.
1301     */
1302     long GetState() const;
1303
1304     /**
1305         Returns the label/header text.
1306     */
1307     const wxString& GetText() const;
1308
1309     /**
1310         Returns the text colour.
1311     */
1312     wxColour GetTextColour() const;
1313
1314     /**
1315         Meaningful only for column headers in report mode. Returns the column width.
1316     */
1317     int GetWidth() const;
1318
1319     /**
1320         Sets the alignment for the item. See also GetAlign()
1321     */
1322     void SetAlign(wxListColumnFormat align);
1323
1324     /**
1325         Sets the background colour for the item.
1326     */
1327     void SetBackgroundColour(const wxColour& colBack);
1328
1329     /**
1330         Sets the zero-based column. Meaningful only in report mode.
1331     */
1332     void SetColumn(int col);
1333
1334     //@{
1335     /**
1336         Sets client data for the item.
1337         Please note that client data is associated with the item and not with subitems.
1338     */
1339     void SetData(long data);
1340     void SetData(void* data);
1341     //@}
1342
1343     /**
1344         Sets the font for the item.
1345     */
1346     void SetFont(const wxFont& font);
1347
1348     /**
1349         Sets the zero-based item position.
1350     */
1351     void SetId(long id);
1352
1353     /**
1354         Sets the zero-based index of the image associated with the item
1355         into the image list.
1356     */
1357     void SetImage(int image);
1358
1359     /**
1360         Sets the mask of valid fields. See GetMask().
1361     */
1362     void SetMask(long mask);
1363
1364     /**
1365         Sets the item state flags (note that the valid state flags are influenced
1366         by the value of the state mask, see wxListItem::SetStateMask).
1367
1368         See GetState() for valid flag values.
1369     */
1370     void SetState(long state);
1371
1372     /**
1373         Sets the bitmask that is used to determine which of the state flags
1374         are to be set. See also SetState().
1375     */
1376     void SetStateMask(long stateMask);
1377
1378     /**
1379         Sets the text label for the item.
1380     */
1381     void SetText(const wxString& text);
1382
1383     /**
1384         Sets the text colour for the item.
1385     */
1386     void SetTextColour(const wxColour& colText);
1387
1388     /**
1389         Meaningful only for column headers in report mode. Sets the column width.
1390     */
1391     void SetWidth(int width);
1392 };
1393