include/wx/osx/listctrl.h

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