include/wx/osx/carbon/listctrl.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        listctrl.h
   3 // Purpose:     wxListCtrl class
   4 // Author:      Stefan Csomor
   5 // Modified by:
   6 // Created:     1998-01-01
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Stefan Csomor
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_LISTCTRL_H_
  13 #define _WX_LISTCTRL_H_
  14
  15 #include "wx/defs.h"
  16 #include "wx/generic/listctrl.h"
  17
  18 #define wxMAC_ALWAYS_USE_GENERIC_LISTCTRL wxT("mac.listctrl.always_use_generic")
  19
  20 class wxMacDataBrowserListCtrlControl;
  21 class wxListCtrlTextCtrlWrapper;
  22 class wxListCtrlRenameTimer;
  23
  24 WX_DECLARE_EXPORTED_LIST(wxListItem, wxColumnList);
  25
  26 class WXDLLIMPEXP_CORE wxListCtrl: public wxControl
  27 {
  28   DECLARE_DYNAMIC_CLASS(wxListCtrl)
  29  public:
  30   /*
  31    * Public interface
  32    */
  33
  34     wxListCtrl() { Init(); }
  35
  36     wxListCtrl(wxWindow *parent,
  37                wxWindowID id = wxID_ANY,
  38                const wxPoint& pos = wxDefaultPosition,
  39                const wxSize& size = wxDefaultSize,
  40                long style = wxLC_ICON,
  41                const wxValidator& validator = wxDefaultValidator,
  42                const wxString& name = wxListCtrlNameStr)
  43     {
  44         Init();
  45
  46         Create(parent, id, pos, size, style, validator, name);
  47     }
  48
  49     virtual ~wxListCtrl();
  50
  51     bool Create(wxWindow *parent,
  52                 wxWindowID id = wxID_ANY,
  53                 const wxPoint& pos = wxDefaultPosition,
  54                 const wxSize& size = wxDefaultSize,
  55                 long style = wxLC_ICON,
  56                 const wxValidator& validator = wxDefaultValidator,
  57                 const wxString& name = wxListCtrlNameStr);
  58
  59   // Attributes
  60   ////////////////////////////////////////////////////////////////////////////
  61
  62   // Gets information about this column
  63   bool GetColumn(int col, wxListItem& item) const;
  64
  65   // Sets information about this column
  66   // TODO: NOT const to be compatible with wxGenericListCtrl API
  67   bool SetColumn(int col, wxListItem& item) ;
  68
  69   // Gets the column width
  70   int GetColumnWidth(int col) const;
  71
  72   // Sets the column width
  73   bool SetColumnWidth(int col, int width) ;
  74
  75   // Gets the number of items that can fit vertically in the
  76   // visible area of the list control (list or report view)
  77   // or the total number of items in the list control (icon
  78   // or small icon view)
  79   int GetCountPerPage() const;
  80
  81   // Gets the edit control for editing labels.
  82   wxTextCtrl* GetEditControl() const;
  83
  84   // Gets information about the item
  85   bool GetItem(wxListItem& info) const ;
  86
  87   // Sets information about the item
  88   bool SetItem(wxListItem& info) ;
  89
  90   // Sets a string field at a particular column
  91   long SetItem(long index, int col, const wxString& label, int imageId = -1);
  92
  93   // Gets the item state
  94   int  GetItemState(long item, long stateMask) const ;
  95
  96   // Sets the item state
  97   bool SetItemState(long item, long state, long stateMask) ;
  98
  99   void AssignImageList(wxImageList *imageList, int which);
 100
 101   // Sets the item image
 102   bool SetItemImage(long item, int image, int selImage = -1) ;
 103   bool SetItemColumnImage(long item, long column, int image);
 104
 105   // Gets the item text
 106   wxString GetItemText(long item) const ;
 107
 108   // Sets the item text
 109   void SetItemText(long item, const wxString& str) ;
 110
 111   void SetItemTextColour(long item, const wxColour& colour) ;
 112   wxColour GetItemTextColour(long item) const;
 113
 114   void SetItemBackgroundColour(long item, const wxColour& colour) ;
 115   wxColour GetItemBackgroundColour(long item) const;
 116
 117   void SetItemFont( long item, const wxFont &f);
 118   wxFont GetItemFont( long item ) const;
 119
 120   // Gets the item data
 121   long GetItemData(long item) const ;
 122
 123   // Sets the item data
 124   bool SetItemPtrData(long item, wxUIntPtr data);
 125   bool SetItemData(long item, long data) { return SetItemPtrData(item, data); }
 126
 127   // Gets the item rectangle
 128   bool GetItemRect(long item, wxRect& rect, int code = wxLIST_RECT_BOUNDS) const ;
 129
 130   // Gets the item position
 131   bool GetItemPosition(long item, wxPoint& pos) const ;
 132
 133   // Sets the item position
 134   bool SetItemPosition(long item, const wxPoint& pos) ;
 135
 136   // Gets the number of items in the list control
 137   int GetItemCount() const;
 138
 139   // Gets the number of columns in the list control
 140   int GetColumnCount() const;
 141
 142   void SetItemSpacing( int spacing, bool isSmall = false );
 143   wxSize GetItemSpacing() const;
 144
 145   // Gets the number of selected items in the list control
 146   int GetSelectedItemCount() const;
 147
 148   wxRect GetViewRect() const;
 149
 150   // Gets the text colour of the listview
 151   wxColour GetTextColour() const;
 152
 153   // Sets the text colour of the listview
 154   void SetTextColour(const wxColour& col);
 155
 156   // Gets the index of the topmost visible item when in
 157   // list or report view
 158   long GetTopItem() const ;
 159
 160   // are we in report mode?
 161   bool InReportView() const { return HasFlag(wxLC_REPORT); }
 162
 163   bool IsVirtual() const { return HasFlag(wxLC_VIRTUAL); }
 164
 165   // Add or remove a single window style
 166   void SetSingleStyle(long style, bool add = true) ;
 167
 168   // Set the whole window style
 169   void SetWindowStyleFlag(long style) ;
 170
 171   // Searches for an item, starting from 'item'.
 172   // item can be -1 to find the first item that matches the
 173   // specified flags.
 174   // Returns the item or -1 if unsuccessful.
 175   long GetNextItem(long item, int geometry = wxLIST_NEXT_ALL, int state = wxLIST_STATE_DONTCARE) const ;
 176
 177   // Implementation: converts wxWidgets style to MSW style.
 178   // Can be a single style flag or a bit list.
 179   // oldStyle is 'normalised' so that it doesn't contain
 180   // conflicting styles.
 181   long ConvertToMSWStyle(long& oldStyle, long style) const;
 182
 183   // Gets one of the three image lists
 184   wxImageList *GetImageList(int which) const ;
 185
 186   // Sets the image list
 187   // N.B. There's a quirk in the Win95 list view implementation.
 188   // If in wxLC_LIST mode, it'll *still* display images by the labels if
 189   // there's a small-icon image list set for the control - even though you
 190   // haven't specified wxLIST_MASK_IMAGE when inserting.
 191   // So you have to set a NULL small-icon image list to be sure that
 192   // the wxLC_LIST mode works without icons. Of course, you may want icons...
 193   void SetImageList(wxImageList *imageList, int which) ;
 194
 195   // Operations
 196   ////////////////////////////////////////////////////////////////////////////
 197
 198   // Arranges the items
 199   bool Arrange(int flag = wxLIST_ALIGN_DEFAULT);
 200
 201   // Deletes an item
 202   bool DeleteItem(long item);
 203
 204   // Deletes all items
 205   bool DeleteAllItems() ;
 206
 207   // Deletes a column
 208   bool DeleteColumn(int col);
 209
 210   // Deletes all columns
 211   bool DeleteAllColumns();
 212
 213   // Clears items, and columns if there are any.
 214   void ClearAll();
 215
 216   // Edit the label
 217   wxTextCtrl* EditLabel(long item, wxClassInfo* textControlClass = CLASSINFO(wxTextCtrl));
 218
 219   // End label editing, optionally cancelling the edit
 220   bool EndEditLabel(bool cancel);
 221
 222   // Ensures this item is visible
 223   bool EnsureVisible(long item) ;
 224
 225   // Find an item whose label matches this string, starting from the item after 'start'
 226   // or the beginning if 'start' is -1.
 227   long FindItem(long start, const wxString& str, bool partial = false);
 228
 229   // Find an item whose data matches this data, starting from the item after 'start'
 230   // or the beginning if 'start' is -1.
 231   long FindItem(long start, long data);
 232
 233   // Find an item nearest this position in the specified direction, starting from
 234   // the item after 'start' or the beginning if 'start' is -1.
 235   long FindItem(long start, const wxPoint& pt, int direction);
 236
 237   // Determines which item (if any) is at the specified point,
 238   // giving details in 'flags' (see wxLIST_HITTEST_... flags above)
 239   // Request the subitem number as well at the given coordinate.
 240   long HitTest(const wxPoint& point, int& flags, long* ptrSubItem = NULL) const;
 241
 242   // Inserts an item, returning the index of the new item if successful,
 243   // -1 otherwise.
 244   // TOD: Should also have some further convenience functions
 245   // which don't require setting a wxListItem object
 246   long InsertItem(wxListItem& info);
 247
 248   // Insert a string item
 249   long InsertItem(long index, const wxString& label);
 250
 251   // Insert an image item
 252   long InsertItem(long index, int imageIndex);
 253
 254   // Insert an image/string item
 255   long InsertItem(long index, const wxString& label, int imageIndex);
 256
 257   // For list view mode (only), inserts a column.
 258   long InsertColumn(long col, wxListItem& info);
 259
 260   long InsertColumn(long col, const wxString& heading, int format = wxLIST_FORMAT_LEFT,
 261     int width = -1);
 262
 263   // Scrolls the list control. If in icon, small icon or report view mode,
 264   // x specifies the number of pixels to scroll. If in list view mode, x
 265   // specifies the number of columns to scroll.
 266   // If in icon, small icon or list view mode, y specifies the number of pixels
 267   // to scroll. If in report view mode, y specifies the number of lines to scroll.
 268   bool ScrollList(int dx, int dy);
 269
 270   // Sort items.
 271
 272   // fn is a function which takes 3 long arguments: item1, item2, data.
 273   // item1 is the long data associated with a first item (NOT the index).
 274   // item2 is the long data associated with a second item (NOT the index).
 275   // data is the same value as passed to SortItems.
 276   // The return value is a negative number if the first item should precede the second
 277   // item, a positive number of the second item should precede the first,
 278   // or zero if the two items are equivalent.
 279
 280   // data is arbitrary data to be passed to the sort function.
 281   bool SortItems(wxListCtrlCompare fn, long data);
 282
 283   wxMacDataBrowserListCtrlControl* GetListPeer() const;
 284
 285     // these functions are only used for virtual list view controls, i.e. the
 286     // ones with wxLC_VIRTUAL style
 287
 288     void SetItemCount(long count);
 289     void RefreshItem(long item);
 290     void RefreshItems(long itemFrom, long itemTo);
 291
 292     // return the text for the given column of the given item
 293     virtual wxString OnGetItemText(long item, long column) const;
 294
 295     // return the icon for the given item. In report view, OnGetItemImage will
 296     // only be called for the first column. See OnGetItemColumnImage for
 297     // details.
 298     virtual int OnGetItemImage(long item) const;
 299
 300     // return the icon for the given item and column.
 301     virtual int OnGetItemColumnImage(long item, long column) const;
 302
 303     // return the attribute for the item (may return NULL if none)
 304     virtual wxListItemAttr *OnGetItemAttr(long item) const;
 305
 306 /* Why should we need this function? Leave for now.
 307  * We might need it because item data may have changed,
 308  * but the display needs refreshing (in string callback mode)
 309   // Updates an item. If the list control has the wxLI_AUTO_ARRANGE style,
 310   // the items will be rearranged.
 311   bool Update(long item);
 312 */
 313
 314   void Command(wxCommandEvent& event) { ProcessCommand(event); };
 315
 316   wxListCtrlCompare GetCompareFunc() { return m_compareFunc; };
 317   long GetCompareFuncData() { return m_compareFuncData; };
 318
 319
 320   // public overrides needed for pimpl approach
 321   virtual bool SetFont(const wxFont& font);
 322   virtual bool SetForegroundColour(const wxColour& colour);
 323   virtual bool SetBackgroundColour(const wxColour& colour);
 324   virtual wxColour GetBackgroundColour() const;
 325
 326   // functions for editing/timer
 327   void OnRenameTimer();
 328   bool OnRenameAccept(long itemEdit, const wxString& value);
 329   void OnRenameCancelled(long itemEdit);
 330
 331   void ChangeCurrent(long current);
 332   void ResetCurrent() { ChangeCurrent((long)-1); }
 333   bool HasCurrent() const { return m_current != (long)-1; }
 334
 335   void OnLeftDown(wxMouseEvent& event);
 336   void OnDblClick(wxMouseEvent& event);
 337
 338   void FinishEditing(wxTextCtrl *text)
 339   {
 340       delete text;
 341       m_textctrlWrapper = NULL;
 342       SetFocus();
 343   }
 344
 345   virtual int GetScrollPos(int orient) const;
 346
 347   void OnRightDown(wxMouseEvent& event);
 348   void OnMiddleDown(wxMouseEvent& event);
 349   void OnChar(wxKeyEvent& event);
 350   virtual void SetFocus();
 351   void FireMouseEvent(wxEventType eventType, wxPoint position);
 352
 353   virtual void SetDropTarget( wxDropTarget *dropTarget );
 354   virtual wxDropTarget* GetDropTarget() const;
 355
 356   // with CG, we need to get the context from an kEventControlDraw event
 357   // unfortunately, the DataBrowser callbacks don't provide the context
 358   // and we need it, so we need to set/remove it before and after draw
 359   // events so we can access it in the callbacks.
 360   void MacSetDrawingContext(void* context) { m_cgContext = context; }
 361   void* MacGetDrawingContext() { return m_cgContext; }
 362
 363   virtual wxVisualAttributes GetDefaultAttributes() const
 364   {
 365       return GetClassDefaultAttributes(GetWindowVariant());
 366   }
 367
 368   static wxVisualAttributes
 369   GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
 370
 371 protected:
 372
 373   // protected overrides needed for pimpl approach
 374   virtual void DoSetSize(int x, int y,
 375                          int width, int height,
 376                          int sizeFlags = wxSIZE_AUTO);
 377
 378   virtual wxSize DoGetBestSize() const;
 379
 380   long               m_current;
 381   wxListCtrlTextCtrlWrapper *m_textctrlWrapper;
 382   wxListCtrlRenameTimer *m_renameTimer;
 383   // common part of all ctors
 384   void Init();
 385
 386   wxGenericListCtrl* m_genericImpl;   // allow use of the generic impl.
 387   wxMacDataBrowserListCtrlControl* m_dbImpl;
 388   void*  m_macListCtrlEventHandler;
 389   void*  m_cgContext;
 390   wxListCtrlCompare m_compareFunc;
 391   long m_compareFuncData;
 392
 393   wxTextCtrl*       m_textCtrl;        // The control used for editing a label
 394   wxImageList *     m_imageListNormal; // The image list for normal icons
 395   wxImageList *     m_imageListSmall;  // The image list for small icons
 396   wxImageList *     m_imageListState;  // The image list state icons (not implemented yet)
 397
 398   wxColumnList      m_colsInfo; // for storing info about each column
 399   wxColour          m_textColor;
 400   wxColour          m_bgColor;
 401
 402   // keep track of whether or not we should delete the image list ourselves.
 403   bool              m_ownsImageListNormal,
 404                     m_ownsImageListSmall,
 405                     m_ownsImageListState;
 406
 407   long              m_baseStyle;  // Basic Windows style flags, for recreation purposes
 408   wxStringList      m_stringPool; // Pool of 3 strings to satisfy Windows callback
 409                                   // requirements
 410   int               m_colCount;   // Windows doesn't have GetColumnCount so must
 411                                   // keep track of inserted/deleted columns
 412
 413   int               m_count; // for virtual lists, store item count
 414
 415 private:
 416   int CalcColumnAutoWidth(int col) const;
 417
 418   DECLARE_EVENT_TABLE()
 419 };
 420
 421 #endif
 422     // _WX_LISTCTRL_H_