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, long 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         This function may be overloaded in the derived class for a control with
 584         @c wxLC_VIRTUAL style. It should return the attribute for the specified
 585         @c item or @NULL to use the default appearance parameters.
 586
 587         wxListCtrl will not delete the pointer or keep a reference of it.
 588         You can return the same wxListItemAttr pointer for every OnGetItemAttr() call.
 589
 590         The base class version always returns @NULL.
 591
 592         @see OnGetItemImage(), OnGetItemColumnImage(), OnGetItemText()
 593     */
 594     virtual wxListItemAttr* OnGetItemAttr(long item) const;
 595
 596     /**
 597         Overload this function in the derived class for a control with
 598         @c wxLC_VIRTUAL and @c wxLC_REPORT styles in order to specify the image
 599         index for the given line and column.
 600
 601         The base class version always calls OnGetItemImage() for the first column, else
 602         it returns -1.
 603
 604         @see OnGetItemText(), OnGetItemImage(), OnGetItemAttr()
 605     */
 606     virtual int OnGetItemColumnImage(long item, long column) const;
 607
 608     /**
 609         This function must be overloaded in the derived class for a control with
 610         @c wxLC_VIRTUAL style having an @ref SetImageList() "image list"
 611         (if the control doesn't have an image list, it is not necessary to overload it).
 612         It should return the index of the items image in the controls image list
 613         or -1 for no image.
 614
 615         In a control with @c wxLC_REPORT style, OnGetItemImage() only gets called for
 616         the first column of each line.
 617
 618         The base class version always returns -1.
 619
 620         @see OnGetItemText(), OnGetItemColumnImage(), OnGetItemAttr()
 621     */
 622     virtual int OnGetItemImage(long item) const;
 623
 624     /**
 625         This function @b must be overloaded in the derived class for a control with
 626         @c wxLC_VIRTUAL style. It should return the string containing the text of
 627         the given @a column for the specified @c item.
 628
 629         @see SetItemCount(), OnGetItemImage(), OnGetItemColumnImage(), OnGetItemAttr()
 630     */
 631     virtual wxString OnGetItemText(long item, long column) const;
 632
 633     /**
 634         Redraws the given @e item.
 635
 636         This is only useful for the virtual list controls as without calling this
 637         function the displayed value of the item doesn't change even when the
 638         underlying data does change.
 639
 640         @see RefreshItems()
 641     */
 642     void RefreshItem(long item);
 643
 644     /**
 645         Redraws the items between @a itemFrom and @e itemTo.
 646         The starting item must be less than or equal to the ending one.
 647
 648         Just as RefreshItem() this is only useful for virtual list controls.
 649     */
 650     void RefreshItems(long itemFrom, long itemTo);
 651
 652     /**
 653         Scrolls the list control. If in icon, small icon or report view mode,
 654         @a dx specifies the number of pixels to scroll. If in list view mode,
 655         @a dx specifies the number of columns to scroll. @a dy always specifies
 656         the number of pixels to scroll vertically.
 657
 658         @note This method is currently only implemented in the Windows version.
 659     */
 660     bool ScrollList(int dx, int dy);
 661
 662     /**
 663         Sets the background colour.
 664
 665         Note that the wxWindow::GetBackgroundColour() function of wxWindow base
 666         class can be used to retrieve the current background colour.
 667     */
 668     virtual bool SetBackgroundColour(const wxColour& col);
 669
 670     /**
 671         Sets information about this column.
 672         See SetItem() for more information.
 673     */
 674     bool SetColumn(int col, wxListItem& item);
 675
 676     /**
 677         Sets the column width.
 678
 679         @a width can be a width in pixels or @c wxLIST_AUTOSIZE (-1) or
 680         @c wxLIST_AUTOSIZE_USEHEADER (-2).
 681
 682         @c wxLIST_AUTOSIZE will resize the column to the length of its longest item.
 683
 684         @c wxLIST_AUTOSIZE_USEHEADER will resize the column to the length of the
 685         header (Win32) or 80 pixels (other platforms).
 686
 687         In small or normal icon view, @a col must be -1, and the column width is set
 688         for all columns.
 689     */
 690     bool SetColumnWidth(int col, int width);
 691
 692     /**
 693         Sets the order of all columns at once.
 694
 695         The @a orders array must have the same number elements as the number of
 696         columns and contain each position exactly once.
 697
 698         This function is valid in report view only.
 699     */
 700     bool SetColumnOrder(const wxArrayInt& orders) const;
 701
 702     /**
 703         Sets the image list associated with the control.
 704
 705         @a which is one of @c wxIMAGE_LIST_NORMAL, @c wxIMAGE_LIST_SMALL,
 706         @c wxIMAGE_LIST_STATE (the last is unimplemented).
 707
 708         This method does not take ownership of the image list, you have to
 709         delete it yourself.
 710
 711         @see AssignImageList()
 712     */
 713     void SetImageList(wxImageList* imageList, int which);
 714
 715     /**
 716         Sets the data of an item.
 717
 718         Using the wxListItem's mask and state mask, you can change only selected
 719         attributes of a wxListCtrl item.
 720     */
 721     bool SetItem(wxListItem& info);
 722
 723     /**
 724         Sets an item string field at a particular column.
 725     */
 726     long SetItem(long index, int column, const wxString& label, int imageId = -1);
 727
 728     /**
 729         Sets the background colour for this item.
 730         This function only works in report view mode.
 731         The colour can be retrieved using GetItemBackgroundColour().
 732     */
 733     void SetItemBackgroundColour(long item, const wxColour& col);
 734
 735     /**
 736         Sets the image associated with the item.
 737         In report view, you can specify the column.
 738         The image is an index into the image list associated with the list control.
 739     */
 740     bool SetItemColumnImage(long item, long column, int image);
 741
 742     /**
 743         This method can only be used with virtual list controls.
 744
 745         It is used to indicate to the control the number of items it contains.
 746         After calling it, the main program should be ready to handle calls to
 747         various item callbacks (such as wxListCtrl::OnGetItemText) for all
 748         items in the range from 0 to @a count.
 749
 750         Notice that the control is not necessarily redrawn after this call as
 751         it may be undesirable if an item which is not visible on the screen
 752         anyhow was added to or removed from a control displaying many items, if
 753         you do need to refresh the display you can just call Refresh() manually.
 754     */
 755     void SetItemCount(long count);
 756
 757     /**
 758         Associates application-defined data with this item.
 759
 760         Notice that this function cannot be used to associate pointers with the control
 761         items, use SetItemPtrData() instead.
 762     */
 763     bool SetItemData(long item, long data);
 764
 765     /**
 766          Sets the item's font.
 767     */
 768     void SetItemFont(long item, const wxFont& font);
 769
 770     /**
 771         Sets the unselected and selected images associated with the item.
 772         The images are indices into the image list associated with the list control.
 773     */
 774     bool SetItemImage(long item, int image, int selImage = -1);
 775
 776     /**
 777         Sets the unselected and selected images associated with the item.
 778         The images are indices into the image list associated with the list control.
 779
 780         @deprecated
 781         This form is deprecated: @a selImage is not used; use the other
 782         SetItemImage() overload.
 783     */
 784     bool SetItemImage(long item, int image, int selImage = -1);
 785
 786     /**
 787         Sets the position of the item, in icon or small icon view. Windows only.
 788     */
 789     bool SetItemPosition(long item, const wxPoint& pos);
 790
 791     /**
 792         Associates application-defined data with this item.
 793
 794         The @a data parameter may be either an integer or a pointer cast to the
 795         @c wxUIntPtr type which is guaranteed to be large enough to be able to
 796         contain all integer types and pointers.
 797
 798         @since 2.8.4
 799     */
 800     bool SetItemPtrData(long item, wxUIntPtr data);
 801
 802     /**
 803         Sets the item state. For a list of state flags, see SetItem().
 804         The @b stateMask indicates which state flags are valid.
 805     */
 806     bool SetItemState(long item, long state, long stateMask);
 807
 808     /**
 809         Sets the item text for this item.
 810     */
 811     void SetItemText(long item, const wxString& text);
 812
 813     /**
 814         Sets the colour for this item.
 815         This function only works in report view.
 816         The colour can be retrieved using GetItemTextColour().
 817     */
 818     void SetItemTextColour(long item, const wxColour& col);
 819
 820     /**
 821         Adds or removes a single window style.
 822     */
 823     void SetSingleStyle(long style, bool add = true);
 824
 825     /**
 826         Sets the text colour of the list control.
 827     */
 828     void SetTextColour(const wxColour& col);
 829
 830     /**
 831         Sets the whole window style, deleting all items.
 832     */
 833     void SetWindowStyleFlag(long style);
 834
 835     /**
 836         Call this function to sort the items in the list control. Sorting is done
 837         using the specified @a fnSortCallBack function. This function must have the
 838         following prototype:
 839         @code
 840         int wxCALLBACK wxListCompareFunction(long item1, long item2, long sortData)
 841         @endcode
 842
 843         It is called each time when the two items must be compared and should return 0
 844         if the items are equal, negative value if the first item is less than the
 845         second one and positive value if the first one is greater than the second one
 846         (the same convention as used by @c qsort(3)).
 847
 848         The parameter @e item1 is the client data associated with the first item (NOT the index).
 849         The parameter @e item2 is the client data associated with the second item (NOT the index).
 850         The parameter @e data is the value passed to SortItems() itself.
 851
 852         Notice that the control may only be sorted on client data associated with
 853         the items, so you must use SetItemData if you want to be able to sort the
 854         items in the control.
 855
 856         Please see the @ref page_samples_listctrl for an example of using this function.
 857     */
 858     bool SortItems(wxListCtrlCompare fnSortCallBack, long data);
 859 };
 860
 861
 862
 863 /**
 864     @class wxListEvent
 865
 866     A list event holds information about events associated with wxListCtrl objects.
 867
 868     @beginEventTable{wxListEvent}
 869     @event{EVT_LIST_BEGIN_DRAG(id, func)}
 870         Begin dragging with the left mouse button.
 871     @event{EVT_LIST_BEGIN_RDRAG(id, func)}
 872         Begin dragging with the right mouse button.
 873     @event{EVT_LIST_BEGIN_LABEL_EDIT(id, func)}
 874         Begin editing a label. This can be prevented by calling Veto().
 875     @event{EVT_LIST_END_LABEL_EDIT(id, func)}
 876         Finish editing a label. This can be prevented by calling Veto().
 877     @event{EVT_LIST_DELETE_ITEM(id, func)}
 878         Delete an item.
 879     @event{EVT_LIST_DELETE_ALL_ITEMS(id, func)}
 880         Delete all items.
 881     @event{EVT_LIST_ITEM_SELECTED(id, func)}
 882         The item has been selected.
 883     @event{EVT_LIST_ITEM_DESELECTED(id, func)}
 884         The item has been deselected.
 885     @event{EVT_LIST_ITEM_ACTIVATED(id, func)}
 886         The item has been activated (ENTER or double click).
 887     @event{EVT_LIST_ITEM_FOCUSED(id, func)}
 888         The currently focused item has changed.
 889     @event{EVT_LIST_ITEM_MIDDLE_CLICK(id, func)}
 890         The middle mouse button has been clicked on an item.
 891     @event{EVT_LIST_ITEM_RIGHT_CLICK(id, func)}
 892         The right mouse button has been clicked on an item.
 893     @event{EVT_LIST_KEY_DOWN(id, func)}
 894         A key has been pressed.
 895     @event{EVT_LIST_INSERT_ITEM(id, func)}
 896         An item has been inserted.
 897     @event{EVT_LIST_COL_CLICK(id, func)}
 898         A column (m_col) has been left-clicked.
 899     @event{EVT_LIST_COL_RIGHT_CLICK(id, func)}
 900         A column (m_col) (which can be -1 if the click occurred outside any column)
 901         has been right-clicked.
 902     @event{EVT_LIST_COL_BEGIN_DRAG(id, func)}
 903         The user started resizing a column - can be vetoed.
 904     @event{EVT_LIST_COL_DRAGGING(id, func)}
 905         The divider between columns is being dragged.
 906     @event{EVT_LIST_COL_END_DRAG(id, func)}
 907         A column has been resized by the user.
 908     @event{EVT_LIST_CACHE_HINT(id, func)}
 909         Prepare cache for a virtual list control
 910     @endEventTable
 911
 912
 913     @library{wxbase}
 914     @category{events}
 915
 916     @see wxListCtrl
 917 */
 918 class wxListEvent : public wxNotifyEvent
 919 {
 920 public:
 921     /**
 922         Constructor.
 923     */
 924     wxListEvent(wxEventType commandType = 0, int id = 0);
 925
 926     /**
 927         For @c EVT_LIST_CACHE_HINT event only: return the first item which the
 928         list control advises us to cache.
 929     */
 930     long GetCacheFrom() const;
 931
 932     /**
 933         For @c EVT_LIST_CACHE_HINT event only: return the last item (inclusive)
 934         which the list control advises us to cache.
 935     */
 936     long GetCacheTo() const;
 937
 938     /**
 939         The column position: it is only used with @c COL events.
 940
 941         For the column dragging events, it is the column to the left of the divider
 942         being dragged, for the column click events it may be -1 if the user clicked
 943         in the list control header outside any column.
 944     */
 945     int GetColumn() const;
 946
 947     /**
 948         The data.
 949     */
 950     long GetData() const;
 951
 952     /**
 953         The image.
 954     */
 955     int GetImage() const;
 956
 957     /**
 958         The item index.
 959     */
 960     long GetIndex() const;
 961
 962     /**
 963         An item object, used by some events. See also wxListCtrl::SetItem.
 964     */
 965     const wxListItem& GetItem() const;
 966
 967     /**
 968         Key code if the event is a keypress event.
 969     */
 970     int GetKeyCode() const;
 971
 972     /**
 973         The (new) item label for @c EVT_LIST_END_LABEL_EDIT event.
 974     */
 975     const wxString& GetLabel() const;
 976
 977     /**
 978         The mask.
 979     */
 980     long GetMask() const;
 981
 982     /**
 983         The position of the mouse pointer if the event is a drag event.
 984     */
 985     wxPoint GetPoint() const;
 986
 987     /**
 988         The text.
 989     */
 990     const wxString& GetText() const;
 991
 992     /**
 993         This method only makes sense for @c EVT_LIST_END_LABEL_EDIT message and
 994         returns @true if it the label editing has been cancelled by the user
 995         (GetLabel() returns an empty string in this case but it doesn't allow the
 996         application to distinguish between really cancelling the edit and the
 997         admittedly rare case when the user wants to rename it to an empty string).
 998     */
 999     bool IsEditCancelled() const;
1000 };
1001
1002
1003
1004 /**
1005     @class wxListItemAttr
1006
1007     Represents the attributes (color, font, ...) of a wxListCtrl's wxListItem.
1008
1009     @library{wxbase}
1010     @category{ctrl}
1011
1012     @see @ref overview_listctrl, wxListCtrl, wxListItem
1013 */
1014 class wxListItemAttr
1015 {
1016 public:
1017     /**
1018         Default Constructor.
1019     */
1020     wxListItemAttr();
1021
1022     /**
1023         Construct a wxListItemAttr with the specified foreground and
1024         background colors and font.
1025     */
1026     wxListItemAttr(const wxColour colText,
1027                    const wxColour colBack,
1028                    const wxFont font);
1029
1030     /**
1031         Returns the currently set background color.
1032     */
1033     const wxColour& GetBackgroundColour() const;
1034
1035     /**
1036         Returns the currently set font.
1037     */
1038     const wxFont& GetFont() const;
1039
1040     /**
1041         Returns the currently set text color.
1042     */
1043     const wxColour& GetTextColour() const;
1044
1045     /**
1046         Returns @true if the currently set background color is valid.
1047     */
1048     bool HasBackgroundColour() const;
1049
1050     /**
1051         Returns @true if the currently set font is valid.
1052     */
1053     bool HasFont() const;
1054
1055     /**
1056         Returns @true if the currently set text color is valid.
1057     */
1058     bool HasTextColour() const;
1059
1060     /**
1061         Sets a new background color.
1062     */
1063     void SetBackgroundColour(const wxColour& colour);
1064
1065     /**
1066         Sets a new font.
1067     */
1068     void SetFont(const wxFont& font);
1069
1070     /**
1071         Sets a new text color.
1072     */
1073     void SetTextColour(const wxColour& colour);
1074 };
1075
1076
1077
1078 /**
1079     @class wxListView
1080
1081     This class currently simply presents a simpler to use interface for the
1082     wxListCtrl -- it can be thought of as a @e façade for that complicated class.
1083
1084     Using it is preferable to using wxListCtrl directly whenever possible because
1085     in the future some ports might implement wxListView but not the full set of
1086     wxListCtrl features.
1087
1088     Other than different interface, this class is identical to wxListCtrl.
1089     In particular, it uses the same events, same window styles and so on.
1090
1091     @library{wxcore}
1092     @category{ctrl}
1093     @appearance{listview.png}
1094
1095     @see wxListView::SetColumnImage
1096 */
1097 class wxListView : public wxListCtrl
1098 {
1099 public:
1100     /**
1101         Resets the column image -- after calling this function, no image will be shown.
1102
1103         @param col
1104             the column to clear image for
1105
1106         @see SetColumnImage()
1107     */
1108     void ClearColumnImage(int col);
1109
1110     /**
1111         Sets focus to the item with the given @a index.
1112     */
1113     void Focus(long index);
1114
1115     /**
1116         Returns the first selected item in a (presumably) multiple selection control.
1117         Together with GetNextSelected() it can be used to iterate over all selected
1118         items in the control.
1119
1120         @return The first selected item, if any, -1 otherwise.
1121     */
1122     long GetFirstSelected() const;
1123
1124     /**
1125         Returns the currently focused item or -1 if none.
1126
1127         @see IsSelected(), Focus()
1128     */
1129     long GetFocusedItem() const;
1130
1131     /**
1132         Used together with GetFirstSelected() to iterate over all selected items
1133         in the control.
1134
1135         @return Returns the next selected item or -1 if there are no more of them.
1136     */
1137     long GetNextSelected(long item) const;
1138
1139     /**
1140         Returns @true if the item with the given @a index is selected,
1141         @false otherwise.
1142
1143         @see GetFirstSelected(), GetNextSelected()
1144     */
1145     bool IsSelected(long index) const;
1146
1147     /**
1148         Selects or unselects the given item.
1149
1150         @param n
1151             the item to select or unselect
1152         @param on
1153             if @true (default), selects the item, otherwise unselects it
1154
1155         @see wxListCtrl::SetItemState
1156     */
1157     void Select(long n, bool on = true);
1158
1159     /**
1160         Sets the column image for the specified column.
1161         To use the column images, the control must have a valid image list with
1162         at least one image.
1163
1164         @param col
1165             the column to set image for
1166         @param image
1167             the index of the column image in the controls image list
1168     */
1169     void SetColumnImage(int col, int image);
1170 };
1171
1172
1173 /**
1174     Column format (MSW only except wxLIST_FORMAT_LEFT).
1175 */
1176 enum wxListColumnFormat
1177 {
1178     wxLIST_FORMAT_LEFT,
1179     wxLIST_FORMAT_RIGHT,
1180     wxLIST_FORMAT_CENTRE,
1181     wxLIST_FORMAT_CENTER = wxLIST_FORMAT_CENTRE
1182 };
1183
1184 /**
1185     @class wxListItem
1186
1187     This class stores information about a wxListCtrl item or column.
1188
1189     wxListItem is a class which contains informations about:
1190     - Zero based item position; see SetId() and GetId().
1191     - Zero based column index; see SetColumn() and GetColumn().
1192     - The label (or header for columns); see SetText() and GetText().
1193     - The zero based index into an image list; see GetImage() and SetImage().
1194     - Application defined data; see SetData() and GetData().
1195     - For columns only: the width of the column; see SetWidth() and GetWidth().
1196     - For columns only: the format of the column; one of @c wxLIST_FORMAT_LEFT,
1197       @c wxLIST_FORMAT_RIGHT, @c wxLIST_FORMAT_CENTRE. See SetAlign() and GetAlign().
1198     - The state of the item; see SetState() and GetState().
1199       This is a bitlist of the following flags:
1200         - @c wxLIST_STATE_FOCUSED: The item has the focus.
1201         - @c wxLIST_STATE_SELECTED: The item is selected.
1202         - @c wxLIST_STATE_DONTCARE: Don't care what the state is. Win32 only.
1203         - @c wxLIST_STATE_DROPHILITED: The item is highlighted to receive a drop event. Win32 only.
1204         - @c wxLIST_STATE_CUT: The item is in the cut state. Win32 only.
1205     - A mask indicating which state flags are valid; this is a bitlist of the
1206       flags reported above for the item state. See SetStateMask() and GetStateMask().
1207     - A mask indicating which fields of this class are valid; see SetMask() and GetMask().
1208       This is a bitlist of the following flags:
1209         - @c wxLIST_MASK_STATE: The state field is valid.
1210         - @c wxLIST_MASK_TEXT: The label field is valid.
1211         - @c wxLIST_MASK_IMAGE: The image field is valid.
1212         - @c wxLIST_MASK_DATA: The application-defined data field is valid.
1213         - @c wxLIST_MASK_WIDTH: The column width field is valid.
1214         - @c wxLIST_MASK_FORMAT: The column format field is valid.
1215
1216     The wxListItem object can also contain item-specific colour and font
1217     information: for this you need to call one of SetTextColour(), SetBackgroundColour()
1218     or SetFont() functions on it passing it the colour/font to use.
1219     If the colour/font is not specified, the default list control colour/font is used.
1220
1221     @library{wxbase}
1222     @category{ctrl}
1223
1224     @see wxListCtrl
1225 */
1226 class wxListItem : public wxObject
1227 {
1228 public:
1229     /**
1230         Constructor.
1231     */
1232     wxListItem();
1233
1234     /**
1235         Resets the item state to the default.
1236     */
1237     void Clear();
1238
1239     /**
1240         Returns the alignment for this item.
1241         Can be one of @c wxLIST_FORMAT_LEFT, @c wxLIST_FORMAT_RIGHT or @c wxLIST_FORMAT_CENTRE.
1242     */
1243     wxListColumnFormat GetAlign() const;
1244
1245     /**
1246         Returns the background colour for this item.
1247     */
1248     wxColour GetBackgroundColour() const;
1249
1250     /**
1251         Returns the zero-based column; meaningful only in report mode.
1252     */
1253     int GetColumn() const;
1254
1255     /**
1256         Returns client data associated with the control.
1257         Please note that client data is associated with the item and not with subitems.
1258     */
1259     wxUIntPtr GetData() const;
1260
1261     /**
1262         Returns the font used to display the item.
1263     */
1264     wxFont GetFont() const;
1265
1266     /**
1267         Returns the zero-based item position.
1268     */
1269     long GetId() const;
1270
1271     /**
1272         Returns the zero-based index of the image associated with the item into
1273         the image list.
1274     */
1275     int GetImage() const;
1276
1277     /**
1278         Returns a bit mask indicating which fields of the structure are valid.
1279
1280         Can be any combination of the following values:
1281         - wxLIST_MASK_STATE: @b GetState is valid.
1282         - wxLIST_MASK_TEXT: @b GetText is valid.
1283         - wxLIST_MASK_IMAGE: @b GetImage is valid.
1284         - wxLIST_MASK_DATA: @b GetData is valid.
1285         - wxLIST_MASK_WIDTH: @b GetWidth is valid.
1286         - wxLIST_MASK_FORMAT: @b GetFormat is valid.
1287     */
1288     long GetMask() const;
1289
1290     /**
1291         Returns a bit field representing the state of the item.
1292
1293         Can be any combination of:
1294         - wxLIST_STATE_DONTCARE: Don't care what the state is. Win32 only.
1295         - wxLIST_STATE_DROPHILITED: The item is highlighted to receive a drop event. Win32 only.
1296         - wxLIST_STATE_FOCUSED: The item has the focus.
1297         - wxLIST_STATE_SELECTED: The item is selected.
1298         - wxLIST_STATE_CUT: The item is in the cut state. Win32 only.
1299     */
1300     long GetState() const;
1301
1302     /**
1303         Returns the label/header text.
1304     */
1305     const wxString& GetText() const;
1306
1307     /**
1308         Returns the text colour.
1309     */
1310     wxColour GetTextColour() const;
1311
1312     /**
1313         Meaningful only for column headers in report mode. Returns the column width.
1314     */
1315     int GetWidth() const;
1316
1317     /**
1318         Sets the alignment for the item. See also GetAlign()
1319     */
1320     void SetAlign(wxListColumnFormat align);
1321
1322     /**
1323         Sets the background colour for the item.
1324     */
1325     void SetBackgroundColour(const wxColour& colBack);
1326
1327     /**
1328         Sets the zero-based column. Meaningful only in report mode.
1329     */
1330     void SetColumn(int col);
1331
1332     //@{
1333     /**
1334         Sets client data for the item.
1335         Please note that client data is associated with the item and not with subitems.
1336     */
1337     void SetData(long data);
1338     void SetData(void* data);
1339     //@}
1340
1341     /**
1342         Sets the font for the item.
1343     */
1344     void SetFont(const wxFont& font);
1345
1346     /**
1347         Sets the zero-based item position.
1348     */
1349     void SetId(long id);
1350
1351     /**
1352         Sets the zero-based index of the image associated with the item
1353         into the image list.
1354     */
1355     void SetImage(int image);
1356
1357     /**
1358         Sets the mask of valid fields. See GetMask().
1359     */
1360     void SetMask(long mask);
1361
1362     /**
1363         Sets the item state flags (note that the valid state flags are influenced
1364         by the value of the state mask, see wxListItem::SetStateMask).
1365
1366         See GetState() for valid flag values.
1367     */
1368     void SetState(long state);
1369
1370     /**
1371         Sets the bitmask that is used to determine which of the state flags
1372         are to be set. See also SetState().
1373     */
1374     void SetStateMask(long stateMask);
1375
1376     /**
1377         Sets the text label for the item.
1378     */
1379     void SetText(const wxString& text);
1380
1381     /**
1382         Sets the text colour for the item.
1383     */
1384     void SetTextColour(const wxColour& colText);
1385
1386     /**
1387         Meaningful only for column headers in report mode. Sets the column width.
1388     */
1389     void SetWidth(int width);
1390 };
1391