include/wx/palmos/listctrl.h

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