]>
Commit | Line | Data |
---|---|---|
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 |
bdc72a22 | 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 |
30 | class WXDLLEXPORT wxDropTarget; | |
31 | #endif | |
32 | ||
c801d85f KB |
33 | //----------------------------------------------------------------------------- |
34 | // classes | |
35 | //----------------------------------------------------------------------------- | |
36 | ||
1e6d9499 JS |
37 | class WXDLLEXPORT wxListItem; |
38 | class WXDLLEXPORT wxListEvent; | |
f9ceab7c JS |
39 | |
40 | #if !defined(__WXMSW__) || defined(__WIN16__) || defined(__WXUNIVERSAL__) | |
1e6d9499 | 41 | class 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 |
51 | class WXDLLEXPORT wxListHeaderData; |
52 | class WXDLLEXPORT wxListItemData; | |
53 | class WXDLLEXPORT wxListLineData; | |
c801d85f | 54 | |
1e6d9499 JS |
55 | class WXDLLEXPORT wxListHeaderWindow; |
56 | class WXDLLEXPORT wxListMainWindow; | |
c801d85f | 57 | |
1e6d9499 | 58 | class WXDLLEXPORT wxListRenameTimer; |
e179bd65 | 59 | class WXDLLEXPORT wxListTextCtrl; |
c801d85f | 60 | |
c801d85f KB |
61 | //----------------------------------------------------------------------------- |
62 | // wxListCtrl | |
63 | //----------------------------------------------------------------------------- | |
64 | ||
3cd94a0d | 65 | class WXDLLEXPORT wxGenericListCtrl: public wxControl |
c801d85f | 66 | { |
b16088bf | 67 | public: |
3cd94a0d JS |
68 | wxGenericListCtrl(); |
69 | wxGenericListCtrl( wxWindow *parent, | |
921176c5 | 70 | wxWindowID winid = -1, |
674ac8b9 VZ |
71 | const wxPoint &pos = wxDefaultPosition, |
72 | const wxSize &size = wxDefaultSize, | |
73 | long style = wxLC_ICON, | |
74 | const wxValidator& validator = wxDefaultValidator, | |
1169a919 | 75 | const wxString &name = wxT("listctrl") ); |
3cd94a0d | 76 | ~wxGenericListCtrl(); |
29149a64 | 77 | |
674ac8b9 | 78 | bool Create( wxWindow *parent, |
921176c5 | 79 | wxWindowID winid = -1, |
674ac8b9 VZ |
80 | const wxPoint &pos = wxDefaultPosition, |
81 | const wxSize &size = wxDefaultSize, | |
82 | long style = wxLC_ICON, | |
83 | const wxValidator& validator = wxDefaultValidator, | |
2b5f62a0 | 84 | const wxString &name = wxT("listctrl") ); |
b16088bf | 85 | |
e487524e | 86 | bool GetColumn( int col, wxListItem& item ) const; |
debe6624 | 87 | bool SetColumn( int col, wxListItem& item ); |
e487524e | 88 | int GetColumnWidth( int col ) const; |
debe6624 | 89 | bool SetColumnWidth( int col, int width); |
e179bd65 | 90 | int GetCountPerPage() const; // not the same in wxGLC as in Windows, I think |
11ebea16 | 91 | wxRect GetViewRect() const; |
b16088bf | 92 | |
e487524e | 93 | bool GetItem( wxListItem& info ) const; |
c801d85f | 94 | bool SetItem( wxListItem& info ) ; |
debe6624 | 95 | long SetItem( long index, int col, const wxString& label, int imageId = -1 ); |
e487524e | 96 | int GetItemState( long item, long stateMask ) const; |
debe6624 JS |
97 | bool SetItemState( long item, long state, long stateMask); |
98 | bool SetItemImage( long item, int image, int selImage); | |
e487524e | 99 | wxString GetItemText( long item ) const; |
debe6624 | 100 | void SetItemText( long item, const wxString& str ); |
e487524e | 101 | long GetItemData( long item ) const; |
debe6624 | 102 | bool SetItemData( long item, long data ); |
0a240683 | 103 | bool GetItemRect( long item, wxRect& rect, int code = wxLIST_RECT_BOUNDS ) const; |
e487524e | 104 | bool GetItemPosition( long item, wxPoint& pos ) const; |
debe6624 | 105 | bool SetItemPosition( long item, const wxPoint& pos ); // not supported in wxGLC |
e179bd65 RR |
106 | int GetItemCount() const; |
107 | int GetColumnCount() const; | |
33d0b396 | 108 | void SetItemSpacing( int spacing, bool isSmall = FALSE ); |
5db8d758 | 109 | wxSize GetItemSpacing() const; |
5b98eb2f RL |
110 | void SetItemTextColour( long item, const wxColour& col); |
111 | wxColour GetItemTextColour( long item ) const; | |
112 | void SetItemBackgroundColour( long item, const wxColour &col); | |
113 | wxColour GetItemBackgroundColour( long item ) const; | |
e179bd65 | 114 | int GetSelectedItemCount() const; |
0530737d VZ |
115 | wxColour GetTextColour() const; |
116 | void SetTextColour(const wxColour& col); | |
e179bd65 | 117 | long GetTopItem() const; |
b16088bf | 118 | |
debe6624 | 119 | void SetSingleStyle( long style, bool add = TRUE ) ; |
e179bd65 RR |
120 | void SetWindowStyleFlag( long style ); |
121 | void RecreateWindow() {} | |
122 | long GetNextItem( long item, int geometry = wxLIST_NEXT_ALL, int state = wxLIST_STATE_DONTCARE ) const; | |
f9ceab7c JS |
123 | wxImageListType *GetImageList( int which ) const; |
124 | void SetImageList( wxImageListType *imageList, int which ); | |
125 | void AssignImageList( wxImageListType *imageList, int which ); | |
debe6624 | 126 | bool Arrange( int flag = wxLIST_ALIGN_DEFAULT ); // always wxLIST_ALIGN_LEFT in wxGLC |
57c4d796 | 127 | |
4f22cf8d | 128 | void ClearAll(); |
debe6624 | 129 | bool DeleteItem( long item ); |
e179bd65 RR |
130 | bool DeleteAllItems(); |
131 | bool DeleteAllColumns(); | |
debe6624 | 132 | bool DeleteColumn( int col ); |
57c4d796 | 133 | |
2c1f73ee VZ |
134 | void SetItemCount(long count); |
135 | ||
e179bd65 RR |
136 | void EditLabel( long item ) { Edit(item); } |
137 | void Edit( long item ); | |
57c4d796 | 138 | |
debe6624 | 139 | bool EnsureVisible( long item ); |
e179bd65 RR |
140 | long FindItem( long start, const wxString& str, bool partial = FALSE ); |
141 | long FindItem( long start, long data ); | |
142 | long FindItem( long start, const wxPoint& pt, int direction ); // not supported in wxGLC | |
143 | long HitTest( const wxPoint& point, int& flags); | |
c801d85f | 144 | long InsertItem(wxListItem& info); |
e179bd65 RR |
145 | long InsertItem( long index, const wxString& label ); |
146 | long InsertItem( long index, int imageIndex ); | |
147 | long InsertItem( long index, const wxString& label, int imageIndex ); | |
148 | long InsertColumn( long col, wxListItem& info ); | |
2f1e3c46 VZ |
149 | long InsertColumn( long col, const wxString& heading, |
150 | int format = wxLIST_FORMAT_LEFT, int width = -1 ); | |
e179bd65 RR |
151 | bool ScrollList( int dx, int dy ); |
152 | bool SortItems( wxListCtrlCompare fn, long data ); | |
153 | bool Update( long item ); | |
29149a64 | 154 | |
2c1f73ee VZ |
155 | // returns true if it is a virtual list control |
156 | bool IsVirtual() const { return (GetWindowStyle() & wxLC_VIRTUAL) != 0; } | |
157 | ||
1a6cb56f VZ |
158 | // refresh items selectively (only useful for virtual list controls) |
159 | void RefreshItem(long item); | |
160 | void RefreshItems(long itemFrom, long itemTo); | |
161 | ||
5db8d758 VZ |
162 | // obsolete, don't use |
163 | wxDEPRECATED( int GetItemSpacing( bool isSmall ) const ); | |
164 | ||
165 | ||
1a6cb56f VZ |
166 | // implementation only from now on |
167 | // ------------------------------- | |
168 | ||
5180055b | 169 | void OnInternalIdle( ); |
b16088bf | 170 | void OnSize( wxSizeEvent &event ); |
57c4d796 | 171 | |
77e7a1dc | 172 | // We have to hand down a few functions |
2f1e3c46 VZ |
173 | virtual void Refresh(bool eraseBackground = TRUE, |
174 | const wxRect *rect = NULL); | |
57c4d796 | 175 | |
c5c528fc VZ |
176 | virtual void Freeze(); |
177 | virtual void Thaw(); | |
178 | ||
179 | virtual bool SetBackgroundColour( const wxColour &colour ); | |
180 | virtual bool SetForegroundColour( const wxColour &colour ); | |
181 | virtual wxColour GetBackgroundColour() const; | |
182 | virtual wxColour GetForegroundColour() const; | |
183 | virtual bool SetFont( const wxFont &font ); | |
184 | virtual bool SetCursor( const wxCursor &cursor ); | |
57c4d796 | 185 | |
1e6d9499 | 186 | #if wxUSE_DRAG_AND_DROP |
c5c528fc VZ |
187 | virtual void SetDropTarget( wxDropTarget *dropTarget ); |
188 | virtual wxDropTarget *GetDropTarget() const; | |
1e6d9499 JS |
189 | #endif |
190 | ||
c5c528fc VZ |
191 | virtual bool DoPopupMenu( wxMenu *menu, int x, int y ); |
192 | ||
d4864e97 | 193 | virtual bool ShouldInheritColours() const { return false; } |
c5c528fc | 194 | virtual void SetFocus(); |
c801d85f | 195 | |
b16088bf RR |
196 | // implementation |
197 | // -------------- | |
57c4d796 | 198 | |
f9ceab7c JS |
199 | wxImageListType *m_imageListNormal; |
200 | wxImageListType *m_imageListSmall; | |
201 | wxImageListType *m_imageListState; // what's that ? | |
29149a64 | 202 | bool m_ownsImageListNormal, |
2e12c11a VS |
203 | m_ownsImageListSmall, |
204 | m_ownsImageListState; | |
c801d85f KB |
205 | wxListHeaderWindow *m_headerWin; |
206 | wxListMainWindow *m_mainWin; | |
f8252483 | 207 | wxCoord m_headerHeight; |
a3622daa | 208 | |
2c1f73ee VZ |
209 | protected: |
210 | // return the text for the given column of the given item | |
211 | virtual wxString OnGetItemText(long item, long column) const; | |
212 | ||
213 | // return the icon for the given item | |
214 | virtual int OnGetItemImage(long item) const; | |
215 | ||
6c02c329 VZ |
216 | // return the attribute for the item (may return NULL if none) |
217 | virtual wxListItemAttr *OnGetItemAttr(long item) const; | |
218 | ||
2c1f73ee | 219 | // it calls our OnGetXXX() functions |
ad08ef44 | 220 | friend class WXDLLEXPORT wxListMainWindow; |
2c1f73ee | 221 | |
b16088bf | 222 | private: |
210a651b | 223 | // Virtual function hiding supression |
8ac7c509 | 224 | virtual void Update() { wxWindow::Update(); } |
210a651b | 225 | |
cf1dfa6b VZ |
226 | // create the header window |
227 | void CreateHeaderWindow(); | |
228 | ||
f8252483 JS |
229 | // calculate and set height of the header |
230 | void CalculateAndSetHeaderHeight(); | |
231 | ||
c0f8674c VZ |
232 | // reposition the header and the main window in the report view depending |
233 | // on whether it should be shown or not | |
234 | void ResizeReportView(bool showHeader); | |
235 | ||
b16088bf | 236 | DECLARE_EVENT_TABLE() |
3cd94a0d | 237 | DECLARE_DYNAMIC_CLASS(wxGenericListCtrl); |
c801d85f KB |
238 | }; |
239 | ||
b31989e2 JS |
240 | #if !defined(__WXMSW__) || defined(__WIN16__) || defined(__WXUNIVERSAL__) |
241 | /* | |
242 | * wxListCtrl has to be a real class or we have problems with | |
243 | * the run-time information. | |
244 | */ | |
c801d85f | 245 | |
b31989e2 JS |
246 | class WXDLLEXPORT wxListCtrl: public wxGenericListCtrl |
247 | { | |
248 | DECLARE_DYNAMIC_CLASS(wxListCtrl) | |
249 | ||
250 | public: | |
1169a919 | 251 | wxListCtrl(); |
b31989e2 | 252 | |
921176c5 | 253 | wxListCtrl(wxWindow *parent, wxWindowID winid = -1, |
b31989e2 JS |
254 | const wxPoint& pos = wxDefaultPosition, |
255 | const wxSize& size = wxDefaultSize, | |
256 | long style = wxLC_ICON, | |
257 | const wxValidator &validator = wxDefaultValidator, | |
1169a919 | 258 | const wxString &name = wxT("listctrl") ); |
b31989e2 JS |
259 | }; |
260 | #endif // !__WXMSW__ || __WIN16__ || __WXUNIVERSAL__ | |
5b98eb2f | 261 | |
b31989e2 | 262 | #endif // __LISTCTRLH_G__ |