]> git.saurik.com Git - wxWidgets.git/blame - include/wx/generic/listctrl.h
Fixed to work with the new wxMacControl system.
[wxWidgets.git] / include / wx / generic / listctrl.h
CommitLineData
c801d85f 1/////////////////////////////////////////////////////////////////////////////
bdc72a22 2// Name: wx/generic/listctrl.h
c801d85f
KB
3// Purpose: Generic list control
4// Author: Robert Roebling
5// Created: 01/02/97
6// Id:
371a5b4e 7// Copyright: (c) 1998 Robert Roebling and Julian Smart
65571936 8// Licence: wxWindows licence
c801d85f
KB
9/////////////////////////////////////////////////////////////////////////////
10
11#ifndef __LISTCTRLH_G__
12#define __LISTCTRLH_G__
13
12028905 14#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
0d3820b3 15#pragma interface "listctrl.h"
c801d85f
KB
16#endif
17
18#include "wx/defs.h"
19#include "wx/object.h"
9cb07953 20#include "wx/generic/imaglist.h"
9cb07953 21
c801d85f
KB
22#include "wx/control.h"
23#include "wx/timer.h"
24#include "wx/dcclient.h"
25#include "wx/scrolwin.h"
26#include "wx/settings.h"
e81a301c 27#include "wx/listbase.h"
c801d85f 28
1e6d9499
JS
29#if wxUSE_DRAG_AND_DROP
30class WXDLLEXPORT wxDropTarget;
31#endif
32
c801d85f
KB
33//-----------------------------------------------------------------------------
34// classes
35//-----------------------------------------------------------------------------
36
1e6d9499
JS
37class WXDLLEXPORT wxListItem;
38class WXDLLEXPORT wxListEvent;
f9ceab7c 39
3a5bcc4d 40#if !defined(__WXMSW__) || defined(__WXUNIVERSAL__)
1e6d9499 41class WXDLLEXPORT wxListCtrl;
f9ceab7c
JS
42#define wxImageListType wxImageList
43#else
44#define wxImageListType wxGenericImageList
45#endif
c801d85f
KB
46
47//-----------------------------------------------------------------------------
48// internal classes
49//-----------------------------------------------------------------------------
50
1e6d9499
JS
51class WXDLLEXPORT wxListHeaderData;
52class WXDLLEXPORT wxListItemData;
53class WXDLLEXPORT wxListLineData;
c801d85f 54
1e6d9499
JS
55class WXDLLEXPORT wxListHeaderWindow;
56class WXDLLEXPORT wxListMainWindow;
c801d85f 57
1e6d9499 58class WXDLLEXPORT wxListRenameTimer;
e179bd65 59class WXDLLEXPORT wxListTextCtrl;
c801d85f 60
c801d85f
KB
61//-----------------------------------------------------------------------------
62// wxListCtrl
63//-----------------------------------------------------------------------------
64
3cd94a0d 65class WXDLLEXPORT wxGenericListCtrl: public wxControl
c801d85f 66{
b16088bf 67public:
3cd94a0d
JS
68 wxGenericListCtrl();
69 wxGenericListCtrl( wxWindow *parent,
ca65c044 70 wxWindowID winid = wxID_ANY,
674ac8b9
VZ
71 const wxPoint &pos = wxDefaultPosition,
72 const wxSize &size = wxDefaultSize,
73 long style = wxLC_ICON,
74 const wxValidator& validator = wxDefaultValidator,
6463b9f5
JS
75 const wxString &name = wxT("listctrl") )
76 {
77 Create(parent, winid, pos, size, style, validator, name);
78 }
3cd94a0d 79 ~wxGenericListCtrl();
29149a64 80
674ac8b9 81 bool Create( wxWindow *parent,
ca65c044 82 wxWindowID winid = wxID_ANY,
674ac8b9
VZ
83 const wxPoint &pos = wxDefaultPosition,
84 const wxSize &size = wxDefaultSize,
85 long style = wxLC_ICON,
86 const wxValidator& validator = wxDefaultValidator,
2b5f62a0 87 const wxString &name = wxT("listctrl") );
b16088bf 88
e487524e 89 bool GetColumn( int col, wxListItem& item ) const;
debe6624 90 bool SetColumn( int col, wxListItem& item );
e487524e 91 int GetColumnWidth( int col ) const;
debe6624 92 bool SetColumnWidth( int col, int width);
e179bd65 93 int GetCountPerPage() const; // not the same in wxGLC as in Windows, I think
11ebea16 94 wxRect GetViewRect() const;
b16088bf 95
e487524e 96 bool GetItem( wxListItem& info ) const;
c801d85f 97 bool SetItem( wxListItem& info ) ;
debe6624 98 long SetItem( long index, int col, const wxString& label, int imageId = -1 );
e487524e 99 int GetItemState( long item, long stateMask ) const;
debe6624
JS
100 bool SetItemState( long item, long state, long stateMask);
101 bool SetItemImage( long item, int image, int selImage);
e487524e 102 wxString GetItemText( long item ) const;
debe6624 103 void SetItemText( long item, const wxString& str );
e487524e 104 long GetItemData( long item ) const;
debe6624 105 bool SetItemData( long item, long data );
0a240683 106 bool GetItemRect( long item, wxRect& rect, int code = wxLIST_RECT_BOUNDS ) const;
e487524e 107 bool GetItemPosition( long item, wxPoint& pos ) const;
debe6624 108 bool SetItemPosition( long item, const wxPoint& pos ); // not supported in wxGLC
e179bd65
RR
109 int GetItemCount() const;
110 int GetColumnCount() const;
ca65c044 111 void SetItemSpacing( int spacing, bool isSmall = false );
5db8d758 112 wxSize GetItemSpacing() const;
5b98eb2f
RL
113 void SetItemTextColour( long item, const wxColour& col);
114 wxColour GetItemTextColour( long item ) const;
115 void SetItemBackgroundColour( long item, const wxColour &col);
116 wxColour GetItemBackgroundColour( long item ) const;
e179bd65 117 int GetSelectedItemCount() const;
0530737d
VZ
118 wxColour GetTextColour() const;
119 void SetTextColour(const wxColour& col);
e179bd65 120 long GetTopItem() const;
b16088bf 121
ca65c044 122 void SetSingleStyle( long style, bool add = true ) ;
e179bd65
RR
123 void SetWindowStyleFlag( long style );
124 void RecreateWindow() {}
125 long GetNextItem( long item, int geometry = wxLIST_NEXT_ALL, int state = wxLIST_STATE_DONTCARE ) const;
f9ceab7c
JS
126 wxImageListType *GetImageList( int which ) const;
127 void SetImageList( wxImageListType *imageList, int which );
128 void AssignImageList( wxImageListType *imageList, int which );
debe6624 129 bool Arrange( int flag = wxLIST_ALIGN_DEFAULT ); // always wxLIST_ALIGN_LEFT in wxGLC
57c4d796 130
4f22cf8d 131 void ClearAll();
debe6624 132 bool DeleteItem( long item );
e179bd65
RR
133 bool DeleteAllItems();
134 bool DeleteAllColumns();
debe6624 135 bool DeleteColumn( int col );
57c4d796 136
2c1f73ee
VZ
137 void SetItemCount(long count);
138
e179bd65
RR
139 void EditLabel( long item ) { Edit(item); }
140 void Edit( long item );
57c4d796 141
debe6624 142 bool EnsureVisible( long item );
ca65c044 143 long FindItem( long start, const wxString& str, bool partial = false );
e179bd65
RR
144 long FindItem( long start, long data );
145 long FindItem( long start, const wxPoint& pt, int direction ); // not supported in wxGLC
146 long HitTest( const wxPoint& point, int& flags);
c801d85f 147 long InsertItem(wxListItem& info);
e179bd65
RR
148 long InsertItem( long index, const wxString& label );
149 long InsertItem( long index, int imageIndex );
150 long InsertItem( long index, const wxString& label, int imageIndex );
151 long InsertColumn( long col, wxListItem& info );
2f1e3c46
VZ
152 long InsertColumn( long col, const wxString& heading,
153 int format = wxLIST_FORMAT_LEFT, int width = -1 );
e179bd65
RR
154 bool ScrollList( int dx, int dy );
155 bool SortItems( wxListCtrlCompare fn, long data );
156 bool Update( long item );
29149a64 157
b5d43d1d
VZ
158 // are we in report mode?
159 bool InReportView() const { return HasFlag(wxLC_REPORT); }
160
161 // are we in virtual report mode?
162 bool IsVirtual() const { return HasFlag(wxLC_VIRTUAL); }
163
164 // do we have a header window?
165 bool HasHeader() const
166 { return InReportView() && !HasFlag(wxLC_NO_HEADER); }
2c1f73ee 167
1a6cb56f
VZ
168 // refresh items selectively (only useful for virtual list controls)
169 void RefreshItem(long item);
170 void RefreshItems(long itemFrom, long itemTo);
171
5db8d758
VZ
172 // obsolete, don't use
173 wxDEPRECATED( int GetItemSpacing( bool isSmall ) const );
174
175
35d4c967
RD
176 virtual wxVisualAttributes GetDefaultAttributes() const
177 {
178 return GetClassDefaultAttributes(GetWindowVariant());
179 }
180
181 static wxVisualAttributes
182 GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
183
1a6cb56f
VZ
184 // implementation only from now on
185 // -------------------------------
186
5180055b 187 void OnInternalIdle( );
b16088bf 188 void OnSize( wxSizeEvent &event );
57c4d796 189
77e7a1dc 190 // We have to hand down a few functions
ca65c044 191 virtual void Refresh(bool eraseBackground = true,
2f1e3c46 192 const wxRect *rect = NULL);
57c4d796 193
c5c528fc
VZ
194 virtual void Freeze();
195 virtual void Thaw();
196
197 virtual bool SetBackgroundColour( const wxColour &colour );
198 virtual bool SetForegroundColour( const wxColour &colour );
199 virtual wxColour GetBackgroundColour() const;
200 virtual wxColour GetForegroundColour() const;
201 virtual bool SetFont( const wxFont &font );
202 virtual bool SetCursor( const wxCursor &cursor );
57c4d796 203
1e6d9499 204#if wxUSE_DRAG_AND_DROP
c5c528fc
VZ
205 virtual void SetDropTarget( wxDropTarget *dropTarget );
206 virtual wxDropTarget *GetDropTarget() const;
1e6d9499
JS
207#endif
208
c5c528fc
VZ
209 virtual bool DoPopupMenu( wxMenu *menu, int x, int y );
210
d4864e97 211 virtual bool ShouldInheritColours() const { return false; }
c5c528fc 212 virtual void SetFocus();
c801d85f 213
b16088bf
RR
214 // implementation
215 // --------------
57c4d796 216
f9ceab7c
JS
217 wxImageListType *m_imageListNormal;
218 wxImageListType *m_imageListSmall;
219 wxImageListType *m_imageListState; // what's that ?
29149a64 220 bool m_ownsImageListNormal,
2e12c11a
VS
221 m_ownsImageListSmall,
222 m_ownsImageListState;
c801d85f
KB
223 wxListHeaderWindow *m_headerWin;
224 wxListMainWindow *m_mainWin;
f8252483 225 wxCoord m_headerHeight;
a3622daa 226
2c1f73ee
VZ
227protected:
228 // return the text for the given column of the given item
229 virtual wxString OnGetItemText(long item, long column) const;
230
231 // return the icon for the given item
232 virtual int OnGetItemImage(long item) const;
233
6c02c329
VZ
234 // return the attribute for the item (may return NULL if none)
235 virtual wxListItemAttr *OnGetItemAttr(long item) const;
236
2c1f73ee 237 // it calls our OnGetXXX() functions
ad08ef44 238 friend class WXDLLEXPORT wxListMainWindow;
2c1f73ee 239
b16088bf 240private:
210a651b 241 // Virtual function hiding supression
8ac7c509 242 virtual void Update() { wxWindow::Update(); }
210a651b 243
cf1dfa6b
VZ
244 // create the header window
245 void CreateHeaderWindow();
246
f8252483
JS
247 // calculate and set height of the header
248 void CalculateAndSetHeaderHeight();
249
c0f8674c
VZ
250 // reposition the header and the main window in the report view depending
251 // on whether it should be shown or not
252 void ResizeReportView(bool showHeader);
253
b16088bf 254 DECLARE_EVENT_TABLE()
3cd94a0d 255 DECLARE_DYNAMIC_CLASS(wxGenericListCtrl);
c801d85f
KB
256};
257
3a5bcc4d 258#if !defined(__WXMSW__) || defined(__WXUNIVERSAL__)
b31989e2
JS
259/*
260 * wxListCtrl has to be a real class or we have problems with
261 * the run-time information.
262 */
c801d85f 263
b31989e2
JS
264class WXDLLEXPORT wxListCtrl: public wxGenericListCtrl
265{
266 DECLARE_DYNAMIC_CLASS(wxListCtrl)
267
268public:
6463b9f5 269 wxListCtrl() {}
b31989e2 270
ca65c044 271 wxListCtrl(wxWindow *parent, wxWindowID winid = wxID_ANY,
b31989e2
JS
272 const wxPoint& pos = wxDefaultPosition,
273 const wxSize& size = wxDefaultSize,
274 long style = wxLC_ICON,
275 const wxValidator &validator = wxDefaultValidator,
6463b9f5
JS
276 const wxString &name = wxT("listctrl") )
277 : wxGenericListCtrl(parent, winid, pos, size, style, validator, name)
278 {
279 }
b31989e2 280};
3a5bcc4d 281#endif // !__WXMSW__ || __WXUNIVERSAL__
5b98eb2f 282
b31989e2 283#endif // __LISTCTRLH_G__