]> git.saurik.com Git - wxWidgets.git/blob - include/wx/generic/listctrl.h
Fixed to work with the new wxMacControl system.
[wxWidgets.git] / include / wx / generic / listctrl.h
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: wx/generic/listctrl.h
3 // Purpose: Generic list control
4 // Author: Robert Roebling
5 // Created: 01/02/97
6 // Id:
7 // Copyright: (c) 1998 Robert Roebling and Julian Smart
8 // Licence: wxWindows licence
9 /////////////////////////////////////////////////////////////////////////////
10
11 #ifndef __LISTCTRLH_G__
12 #define __LISTCTRLH_G__
13
14 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
15 #pragma interface "listctrl.h"
16 #endif
17
18 #include "wx/defs.h"
19 #include "wx/object.h"
20 #include "wx/generic/imaglist.h"
21
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"
27 #include "wx/listbase.h"
28
29 #if wxUSE_DRAG_AND_DROP
30 class WXDLLEXPORT wxDropTarget;
31 #endif
32
33 //-----------------------------------------------------------------------------
34 // classes
35 //-----------------------------------------------------------------------------
36
37 class WXDLLEXPORT wxListItem;
38 class WXDLLEXPORT wxListEvent;
39
40 #if !defined(__WXMSW__) || defined(__WXUNIVERSAL__)
41 class WXDLLEXPORT wxListCtrl;
42 #define wxImageListType wxImageList
43 #else
44 #define wxImageListType wxGenericImageList
45 #endif
46
47 //-----------------------------------------------------------------------------
48 // internal classes
49 //-----------------------------------------------------------------------------
50
51 class WXDLLEXPORT wxListHeaderData;
52 class WXDLLEXPORT wxListItemData;
53 class WXDLLEXPORT wxListLineData;
54
55 class WXDLLEXPORT wxListHeaderWindow;
56 class WXDLLEXPORT wxListMainWindow;
57
58 class WXDLLEXPORT wxListRenameTimer;
59 class WXDLLEXPORT wxListTextCtrl;
60
61 //-----------------------------------------------------------------------------
62 // wxListCtrl
63 //-----------------------------------------------------------------------------
64
65 class WXDLLEXPORT wxGenericListCtrl: public wxControl
66 {
67 public:
68 wxGenericListCtrl();
69 wxGenericListCtrl( wxWindow *parent,
70 wxWindowID winid = wxID_ANY,
71 const wxPoint &pos = wxDefaultPosition,
72 const wxSize &size = wxDefaultSize,
73 long style = wxLC_ICON,
74 const wxValidator& validator = wxDefaultValidator,
75 const wxString &name = wxT("listctrl") )
76 {
77 Create(parent, winid, pos, size, style, validator, name);
78 }
79 ~wxGenericListCtrl();
80
81 bool Create( wxWindow *parent,
82 wxWindowID winid = wxID_ANY,
83 const wxPoint &pos = wxDefaultPosition,
84 const wxSize &size = wxDefaultSize,
85 long style = wxLC_ICON,
86 const wxValidator& validator = wxDefaultValidator,
87 const wxString &name = wxT("listctrl") );
88
89 bool GetColumn( int col, wxListItem& item ) const;
90 bool SetColumn( int col, wxListItem& item );
91 int GetColumnWidth( int col ) const;
92 bool SetColumnWidth( int col, int width);
93 int GetCountPerPage() const; // not the same in wxGLC as in Windows, I think
94 wxRect GetViewRect() const;
95
96 bool GetItem( wxListItem& info ) const;
97 bool SetItem( wxListItem& info ) ;
98 long SetItem( long index, int col, const wxString& label, int imageId = -1 );
99 int GetItemState( long item, long stateMask ) const;
100 bool SetItemState( long item, long state, long stateMask);
101 bool SetItemImage( long item, int image, int selImage);
102 wxString GetItemText( long item ) const;
103 void SetItemText( long item, const wxString& str );
104 long GetItemData( long item ) const;
105 bool SetItemData( long item, long data );
106 bool GetItemRect( long item, wxRect& rect, int code = wxLIST_RECT_BOUNDS ) const;
107 bool GetItemPosition( long item, wxPoint& pos ) const;
108 bool SetItemPosition( long item, const wxPoint& pos ); // not supported in wxGLC
109 int GetItemCount() const;
110 int GetColumnCount() const;
111 void SetItemSpacing( int spacing, bool isSmall = false );
112 wxSize GetItemSpacing() const;
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;
117 int GetSelectedItemCount() const;
118 wxColour GetTextColour() const;
119 void SetTextColour(const wxColour& col);
120 long GetTopItem() const;
121
122 void SetSingleStyle( long style, bool add = true ) ;
123 void SetWindowStyleFlag( long style );
124 void RecreateWindow() {}
125 long GetNextItem( long item, int geometry = wxLIST_NEXT_ALL, int state = wxLIST_STATE_DONTCARE ) const;
126 wxImageListType *GetImageList( int which ) const;
127 void SetImageList( wxImageListType *imageList, int which );
128 void AssignImageList( wxImageListType *imageList, int which );
129 bool Arrange( int flag = wxLIST_ALIGN_DEFAULT ); // always wxLIST_ALIGN_LEFT in wxGLC
130
131 void ClearAll();
132 bool DeleteItem( long item );
133 bool DeleteAllItems();
134 bool DeleteAllColumns();
135 bool DeleteColumn( int col );
136
137 void SetItemCount(long count);
138
139 void EditLabel( long item ) { Edit(item); }
140 void Edit( long item );
141
142 bool EnsureVisible( long item );
143 long FindItem( long start, const wxString& str, bool partial = false );
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);
147 long InsertItem(wxListItem& info);
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 );
152 long InsertColumn( long col, const wxString& heading,
153 int format = wxLIST_FORMAT_LEFT, int width = -1 );
154 bool ScrollList( int dx, int dy );
155 bool SortItems( wxListCtrlCompare fn, long data );
156 bool Update( long item );
157
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); }
167
168 // refresh items selectively (only useful for virtual list controls)
169 void RefreshItem(long item);
170 void RefreshItems(long itemFrom, long itemTo);
171
172 // obsolete, don't use
173 wxDEPRECATED( int GetItemSpacing( bool isSmall ) const );
174
175
176 virtual wxVisualAttributes GetDefaultAttributes() const
177 {
178 return GetClassDefaultAttributes(GetWindowVariant());
179 }
180
181 static wxVisualAttributes
182 GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
183
184 // implementation only from now on
185 // -------------------------------
186
187 void OnInternalIdle( );
188 void OnSize( wxSizeEvent &event );
189
190 // We have to hand down a few functions
191 virtual void Refresh(bool eraseBackground = true,
192 const wxRect *rect = NULL);
193
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 );
203
204 #if wxUSE_DRAG_AND_DROP
205 virtual void SetDropTarget( wxDropTarget *dropTarget );
206 virtual wxDropTarget *GetDropTarget() const;
207 #endif
208
209 virtual bool DoPopupMenu( wxMenu *menu, int x, int y );
210
211 virtual bool ShouldInheritColours() const { return false; }
212 virtual void SetFocus();
213
214 // implementation
215 // --------------
216
217 wxImageListType *m_imageListNormal;
218 wxImageListType *m_imageListSmall;
219 wxImageListType *m_imageListState; // what's that ?
220 bool m_ownsImageListNormal,
221 m_ownsImageListSmall,
222 m_ownsImageListState;
223 wxListHeaderWindow *m_headerWin;
224 wxListMainWindow *m_mainWin;
225 wxCoord m_headerHeight;
226
227 protected:
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
234 // return the attribute for the item (may return NULL if none)
235 virtual wxListItemAttr *OnGetItemAttr(long item) const;
236
237 // it calls our OnGetXXX() functions
238 friend class WXDLLEXPORT wxListMainWindow;
239
240 private:
241 // Virtual function hiding supression
242 virtual void Update() { wxWindow::Update(); }
243
244 // create the header window
245 void CreateHeaderWindow();
246
247 // calculate and set height of the header
248 void CalculateAndSetHeaderHeight();
249
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
254 DECLARE_EVENT_TABLE()
255 DECLARE_DYNAMIC_CLASS(wxGenericListCtrl);
256 };
257
258 #if !defined(__WXMSW__) || defined(__WXUNIVERSAL__)
259 /*
260 * wxListCtrl has to be a real class or we have problems with
261 * the run-time information.
262 */
263
264 class WXDLLEXPORT wxListCtrl: public wxGenericListCtrl
265 {
266 DECLARE_DYNAMIC_CLASS(wxListCtrl)
267
268 public:
269 wxListCtrl() {}
270
271 wxListCtrl(wxWindow *parent, wxWindowID winid = wxID_ANY,
272 const wxPoint& pos = wxDefaultPosition,
273 const wxSize& size = wxDefaultSize,
274 long style = wxLC_ICON,
275 const wxValidator &validator = wxDefaultValidator,
276 const wxString &name = wxT("listctrl") )
277 : wxGenericListCtrl(parent, winid, pos, size, style, validator, name)
278 {
279 }
280 };
281 #endif // !__WXMSW__ || __WXUNIVERSAL__
282
283 #endif // __LISTCTRLH_G__