1 /////////////////////////////////////////////////////////////////////////////
2 // Name: wx/osx/listctrl.h
3 // Purpose: wxListCtrl class
4 // Author: Stefan Csomor
8 // Copyright: (c) Stefan Csomor
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
12 #ifndef _WX_LISTCTRL_H_
13 #define _WX_LISTCTRL_H_
16 #include "wx/generic/listctrl.h"
18 #define wxMAC_ALWAYS_USE_GENERIC_LISTCTRL wxT("mac.listctrl.always_use_generic")
20 class wxMacDataBrowserListCtrlControl
;
21 class wxListCtrlTextCtrlWrapper
;
22 class wxListCtrlRenameTimer
;
24 WX_DECLARE_EXPORTED_LIST(wxListItem
, wxColumnList
);
26 class WXDLLIMPEXP_CORE wxListCtrl
: public wxListCtrlBase
28 DECLARE_DYNAMIC_CLASS(wxListCtrl
)
34 wxListCtrl() { Init(); }
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
)
46 Create(parent
, id
, pos
, size
, style
, validator
, name
);
49 virtual ~wxListCtrl();
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
);
60 ////////////////////////////////////////////////////////////////////////////
62 // Gets information about this column
63 bool GetColumn(int col
, wxListItem
& item
) const;
65 // Sets information about this column
66 // TODO: NOT const to be compatible with wxGenericListCtrl API
67 bool SetColumn(int col
, wxListItem
& item
) ;
69 // Gets the column width
70 int GetColumnWidth(int col
) const;
72 // Sets the column width
73 bool SetColumnWidth(int col
, int width
) ;
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;
81 // Gets the edit control for editing labels.
82 wxTextCtrl
* GetEditControl() const;
84 // Gets information about the item
85 bool GetItem(wxListItem
& info
) const ;
87 // Sets information about the item
88 bool SetItem(wxListItem
& info
) ;
90 // Sets a string field at a particular column
91 long SetItem(long index
, int col
, const wxString
& label
, int imageId
= -1);
93 // Gets the item state
94 int GetItemState(long item
, long stateMask
) const ;
96 // Sets the item state
97 bool SetItemState(long item
, long state
, long stateMask
) ;
99 void AssignImageList(wxImageList
*imageList
, int which
);
101 // Sets the item image
102 bool SetItemImage(long item
, int image
, int selImage
= -1) ;
103 bool SetItemColumnImage(long item
, long column
, int image
);
105 // Gets the item text
106 wxString
GetItemText(long item
, int col
= 0) const ;
108 // Sets the item text
109 void SetItemText(long item
, const wxString
& str
) ;
111 void SetItemTextColour(long item
, const wxColour
& colour
) ;
112 wxColour
GetItemTextColour(long item
) const;
114 void SetItemBackgroundColour(long item
, const wxColour
& colour
) ;
115 wxColour
GetItemBackgroundColour(long item
) const;
117 void SetItemFont( long item
, const wxFont
&f
);
118 wxFont
GetItemFont( long item
) const;
120 // Gets the item data
121 long GetItemData(long item
) const ;
123 // Sets the item data
124 bool SetItemPtrData(long item
, wxUIntPtr data
);
125 bool SetItemData(long item
, long data
) { return SetItemPtrData(item
, data
); }
127 // Gets the item rectangle
128 bool GetItemRect(long item
, wxRect
& rect
, int code
= wxLIST_RECT_BOUNDS
) const ;
130 // Gets the item rectangle of a subitem
131 bool GetSubItemRect( long item
, long subItem
, wxRect
& rect
, int code
= wxLIST_RECT_BOUNDS
) const;
133 // Gets the item position
134 bool GetItemPosition(long item
, wxPoint
& pos
) const ;
136 // Sets the item position
137 bool SetItemPosition(long item
, const wxPoint
& pos
) ;
139 // Gets the number of items in the list control
140 int GetItemCount() const;
142 // Gets the number of columns in the list control
143 int GetColumnCount() const;
145 void SetItemSpacing( int spacing
, bool isSmall
= false );
146 wxSize
GetItemSpacing() const;
148 // Gets the number of selected items in the list control
149 int GetSelectedItemCount() const;
151 wxRect
GetViewRect() const;
153 // Gets the text colour of the listview
154 wxColour
GetTextColour() const;
156 // Sets the text colour of the listview
157 void SetTextColour(const wxColour
& col
);
159 // Gets the index of the topmost visible item when in
160 // list or report view
161 long GetTopItem() const ;
163 // Add or remove a single window style
164 void SetSingleStyle(long style
, bool add
= true) ;
166 // Set the whole window style
167 void SetWindowStyleFlag(long style
) ;
169 // Searches for an item, starting from 'item'.
170 // item can be -1 to find the first item that matches the
172 // Returns the item or -1 if unsuccessful.
173 long GetNextItem(long item
, int geometry
= wxLIST_NEXT_ALL
, int state
= wxLIST_STATE_DONTCARE
) const ;
175 // Implementation: converts wxWidgets style to MSW style.
176 // Can be a single style flag or a bit list.
177 // oldStyle is 'normalised' so that it doesn't contain
178 // conflicting styles.
179 long ConvertToMSWStyle(long& oldStyle
, long style
) const;
181 // Gets one of the three image lists
182 wxImageList
*GetImageList(int which
) const ;
184 // Sets the image list
185 // N.B. There's a quirk in the Win95 list view implementation.
186 // If in wxLC_LIST mode, it'll *still* display images by the labels if
187 // there's a small-icon image list set for the control - even though you
188 // haven't specified wxLIST_MASK_IMAGE when inserting.
189 // So you have to set a NULL small-icon image list to be sure that
190 // the wxLC_LIST mode works without icons. Of course, you may want icons...
191 void SetImageList(wxImageList
*imageList
, int which
) ;
194 ////////////////////////////////////////////////////////////////////////////
196 // Arranges the items
197 bool Arrange(int flag
= wxLIST_ALIGN_DEFAULT
);
200 bool DeleteItem(long item
);
203 bool DeleteAllItems() ;
206 bool DeleteColumn(int col
);
208 // Deletes all columns
209 bool DeleteAllColumns();
211 // Clears items, and columns if there are any.
215 wxTextCtrl
* EditLabel(long item
, wxClassInfo
* textControlClass
= wxCLASSINFO(wxTextCtrl
));
217 // End label editing, optionally cancelling the edit
218 bool EndEditLabel(bool cancel
);
220 // Ensures this item is visible
221 bool EnsureVisible(long item
) ;
223 // Find an item whose label matches this string, starting from the item after 'start'
224 // or the beginning if 'start' is -1.
225 long FindItem(long start
, const wxString
& str
, bool partial
= false);
227 // Find an item whose data matches this data, starting from the item after 'start'
228 // or the beginning if 'start' is -1.
229 long FindItem(long start
, long data
);
231 // Find an item nearest this position in the specified direction, starting from
232 // the item after 'start' or the beginning if 'start' is -1.
233 long FindItem(long start
, const wxPoint
& pt
, int direction
);
235 // Determines which item (if any) is at the specified point,
236 // giving details in 'flags' (see wxLIST_HITTEST_... flags above)
237 // Request the subitem number as well at the given coordinate.
238 long HitTest(const wxPoint
& point
, int& flags
, long* ptrSubItem
= NULL
) const;
240 // Inserts an item, returning the index of the new item if successful,
242 // TOD: Should also have some further convenience functions
243 // which don't require setting a wxListItem object
244 long InsertItem(wxListItem
& info
);
246 // Insert a string item
247 long InsertItem(long index
, const wxString
& label
);
249 // Insert an image item
250 long InsertItem(long index
, int imageIndex
);
252 // Insert an image/string item
253 long InsertItem(long index
, const wxString
& label
, int imageIndex
);
255 // For list view mode (only), inserts a column.
256 long InsertColumn(long col
, wxListItem
& info
);
258 long InsertColumn(long col
, const wxString
& heading
, int format
= wxLIST_FORMAT_LEFT
,
261 // Scrolls the list control. If in icon, small icon or report view mode,
262 // x specifies the number of pixels to scroll. If in list view mode, x
263 // specifies the number of columns to scroll.
264 // If in icon, small icon or list view mode, y specifies the number of pixels
265 // to scroll. If in report view mode, y specifies the number of lines to scroll.
266 bool ScrollList(int dx
, int dy
);
270 // fn is a function which takes 3 long arguments: item1, item2, data.
271 // item1 is the long data associated with a first item (NOT the index).
272 // item2 is the long data associated with a second item (NOT the index).
273 // data is the same value as passed to SortItems.
274 // The return value is a negative number if the first item should precede the second
275 // item, a positive number of the second item should precede the first,
276 // or zero if the two items are equivalent.
278 // data is arbitrary data to be passed to the sort function.
279 bool SortItems(wxListCtrlCompare fn
, wxIntPtr data
);
281 wxMacDataBrowserListCtrlControl
* GetListPeer() const;
283 // these functions are only used for virtual list view controls, i.e. the
284 // ones with wxLC_VIRTUAL style
286 void SetItemCount(long count
);
287 void RefreshItem(long item
);
288 void RefreshItems(long itemFrom
, long itemTo
);
290 // return the text for the given column of the given item
291 virtual wxString
OnGetItemText(long item
, long column
) const;
293 // return the icon for the given item. In report view, OnGetItemImage will
294 // only be called for the first column. See OnGetItemColumnImage for
296 virtual int OnGetItemImage(long item
) const;
298 // return the icon for the given item and column.
299 virtual int OnGetItemColumnImage(long item
, long column
) const;
301 // return the attribute for the item (may return NULL if none)
302 virtual wxListItemAttr
*OnGetItemAttr(long item
) const;
304 /* Why should we need this function? Leave for now.
305 * We might need it because item data may have changed,
306 * but the display needs refreshing (in string callback mode)
307 // Updates an item. If the list control has the wxLI_AUTO_ARRANGE style,
308 // the items will be rearranged.
309 bool Update(long item);
312 void Command(wxCommandEvent
& event
) { ProcessCommand(event
); }
314 wxListCtrlCompare
GetCompareFunc() { return m_compareFunc
; }
315 wxIntPtr
GetCompareFuncData() { return m_compareFuncData
; }
318 // public overrides needed for pimpl approach
319 virtual bool SetFont(const wxFont
& font
);
320 virtual bool SetForegroundColour(const wxColour
& colour
);
321 virtual bool SetBackgroundColour(const wxColour
& colour
);
322 virtual wxColour
GetBackgroundColour() const;
324 virtual void Freeze ();
325 virtual void Thaw ();
326 virtual void Update ();
328 // functions for editing/timer
329 void OnRenameTimer();
330 bool OnRenameAccept(long itemEdit
, const wxString
& value
);
331 void OnRenameCancelled(long itemEdit
);
333 void ChangeCurrent(long current
);
334 void ResetCurrent() { ChangeCurrent((long)-1); }
335 bool HasCurrent() const { return m_current
!= (long)-1; }
337 void OnLeftDown(wxMouseEvent
& event
);
338 void OnDblClick(wxMouseEvent
& event
);
340 void FinishEditing(wxTextCtrl
*text
)
343 m_textctrlWrapper
= NULL
;
347 virtual int GetScrollPos(int orient
) const;
349 void OnRightDown(wxMouseEvent
& event
);
350 void OnMiddleDown(wxMouseEvent
& event
);
351 void OnChar(wxKeyEvent
& event
);
352 virtual void SetFocus();
353 void FireMouseEvent(wxEventType eventType
, wxPoint position
);
355 virtual void SetDropTarget( wxDropTarget
*dropTarget
);
356 virtual wxDropTarget
* GetDropTarget() const;
358 // with CG, we need to get the context from an kEventControlDraw event
359 // unfortunately, the DataBrowser callbacks don't provide the context
360 // and we need it, so we need to set/remove it before and after draw
361 // events so we can access it in the callbacks.
362 void MacSetDrawingContext(void* context
) { m_cgContext
= context
; }
363 void* MacGetDrawingContext() { return m_cgContext
; }
365 virtual wxVisualAttributes
GetDefaultAttributes() const
367 return GetClassDefaultAttributes(GetWindowVariant());
370 static wxVisualAttributes
371 GetClassDefaultAttributes(wxWindowVariant variant
= wxWINDOW_VARIANT_NORMAL
);
375 // protected overrides needed for pimpl approach
376 virtual void DoSetSize(int x
, int y
,
377 int width
, int height
,
378 int sizeFlags
= wxSIZE_AUTO
);
380 virtual wxSize
DoGetBestSize() const;
383 wxListCtrlTextCtrlWrapper
*m_textctrlWrapper
;
384 wxListCtrlRenameTimer
*m_renameTimer
;
385 // common part of all ctors
388 wxGenericListCtrl
* m_genericImpl
; // allow use of the generic impl.
389 wxMacDataBrowserListCtrlControl
* m_dbImpl
;
390 void* m_macListCtrlEventHandler
;
392 wxListCtrlCompare m_compareFunc
;
393 wxIntPtr m_compareFuncData
;
395 wxTextCtrl
* m_textCtrl
; // The control used for editing a label
396 wxImageList
* m_imageListNormal
; // The image list for normal icons
397 wxImageList
* m_imageListSmall
; // The image list for small icons
398 wxImageList
* m_imageListState
; // The image list state icons (not implemented yet)
400 wxColumnList m_colsInfo
; // for storing info about each column
401 wxColour m_textColor
;
404 // keep track of whether or not we should delete the image list ourselves.
405 bool m_ownsImageListNormal
,
406 m_ownsImageListSmall
,
407 m_ownsImageListState
;
409 long m_baseStyle
; // Basic Windows style flags, for recreation purposes
410 int m_colCount
; // Windows doesn't have GetColumnCount so must
411 // keep track of inserted/deleted columns
413 int m_count
; // for virtual lists, store item count
416 int CalcColumnAutoWidth(int col
) const;