]>
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 | |
52f2ad08 | 6 | // RCS-ID: $Id$ |
371a5b4e | 7 | // Copyright: (c) 1998 Robert Roebling and Julian Smart |
65571936 | 8 | // Licence: wxWindows licence |
c801d85f KB |
9 | ///////////////////////////////////////////////////////////////////////////// |
10 | ||
e409b62a PC |
11 | #ifndef _WX_GENERIC_LISTCTRL_H_ |
12 | #define _WX_GENERIC_LISTCTRL_H_ | |
13 | ||
473d6885 | 14 | #include "wx/scrolwin.h" |
70ad0e06 | 15 | #include "wx/textctrl.h" |
c801d85f | 16 | |
b5dbe15d | 17 | class WXDLLIMPEXP_FWD_CORE wxImageList; |
e409b62a | 18 | |
1e6d9499 | 19 | #if wxUSE_DRAG_AND_DROP |
b5dbe15d | 20 | class WXDLLIMPEXP_FWD_CORE wxDropTarget; |
1e6d9499 JS |
21 | #endif |
22 | ||
c801d85f KB |
23 | //----------------------------------------------------------------------------- |
24 | // internal classes | |
25 | //----------------------------------------------------------------------------- | |
26 | ||
b5dbe15d VS |
27 | class WXDLLIMPEXP_FWD_CORE wxListHeaderWindow; |
28 | class WXDLLIMPEXP_FWD_CORE wxListMainWindow; | |
c801d85f | 29 | |
c801d85f KB |
30 | //----------------------------------------------------------------------------- |
31 | // wxListCtrl | |
32 | //----------------------------------------------------------------------------- | |
33 | ||
06cd40a8 RR |
34 | class WXDLLIMPEXP_CORE wxGenericListCtrl: public wxControl, |
35 | public wxScrollHelper | |
c801d85f | 36 | { |
b16088bf | 37 | public: |
e2bc1d69 | 38 | |
06cd40a8 RR |
39 | wxGenericListCtrl() : wxScrollHelper(this) |
40 | { | |
41 | Init(); | |
42 | } | |
ad486020 | 43 | |
3cd94a0d | 44 | wxGenericListCtrl( wxWindow *parent, |
ca65c044 | 45 | wxWindowID winid = wxID_ANY, |
674ac8b9 VZ |
46 | const wxPoint &pos = wxDefaultPosition, |
47 | const wxSize &size = wxDefaultSize, | |
48 | long style = wxLC_ICON, | |
49 | const wxValidator& validator = wxDefaultValidator, | |
ad486020 | 50 | const wxString &name = wxListCtrlNameStr) |
06cd40a8 | 51 | : wxScrollHelper(this) |
6463b9f5 JS |
52 | { |
53 | Create(parent, winid, pos, size, style, validator, name); | |
54 | } | |
ad486020 | 55 | |
d3c7fc99 | 56 | virtual ~wxGenericListCtrl(); |
ad486020 | 57 | |
06cd40a8 | 58 | void Init(); |
29149a64 | 59 | |
674ac8b9 | 60 | bool Create( wxWindow *parent, |
ca65c044 | 61 | wxWindowID winid = wxID_ANY, |
674ac8b9 VZ |
62 | const wxPoint &pos = wxDefaultPosition, |
63 | const wxSize &size = wxDefaultSize, | |
64 | long style = wxLC_ICON, | |
65 | const wxValidator& validator = wxDefaultValidator, | |
ddb2cbee | 66 | const wxString &name = wxListCtrlNameStr); |
b16088bf | 67 | |
e487524e | 68 | bool GetColumn( int col, wxListItem& item ) const; |
debe6624 | 69 | bool SetColumn( int col, wxListItem& item ); |
e487524e | 70 | int GetColumnWidth( int col ) const; |
debe6624 | 71 | bool SetColumnWidth( int col, int width); |
e179bd65 | 72 | int GetCountPerPage() const; // not the same in wxGLC as in Windows, I think |
11ebea16 | 73 | wxRect GetViewRect() const; |
b16088bf | 74 | |
e487524e | 75 | bool GetItem( wxListItem& info ) const; |
c801d85f | 76 | bool SetItem( wxListItem& info ) ; |
debe6624 | 77 | long SetItem( long index, int col, const wxString& label, int imageId = -1 ); |
e487524e | 78 | int GetItemState( long item, long stateMask ) const; |
debe6624 | 79 | bool SetItemState( long item, long state, long stateMask); |
aba3d35e | 80 | bool SetItemImage( long item, int image, int selImage = -1 ); |
06db67bc | 81 | bool SetItemColumnImage( long item, long column, int image ); |
e487524e | 82 | wxString GetItemText( long item ) const; |
debe6624 | 83 | void SetItemText( long item, const wxString& str ); |
81ce36aa | 84 | wxUIntPtr GetItemData( long item ) const; |
9fcd0bf7 VZ |
85 | bool SetItemPtrData(long item, wxUIntPtr data); |
86 | bool SetItemData(long item, long data) { return SetItemPtrData(item, data); } | |
0a240683 | 87 | bool GetItemRect( long item, wxRect& rect, int code = wxLIST_RECT_BOUNDS ) const; |
e974c5d2 | 88 | bool GetSubItemRect( long item, long subItem, wxRect& rect, int code = wxLIST_RECT_BOUNDS ) const; |
e487524e | 89 | bool GetItemPosition( long item, wxPoint& pos ) const; |
debe6624 | 90 | bool SetItemPosition( long item, const wxPoint& pos ); // not supported in wxGLC |
e179bd65 RR |
91 | int GetItemCount() const; |
92 | int GetColumnCount() const; | |
ca65c044 | 93 | void SetItemSpacing( int spacing, bool isSmall = false ); |
5db8d758 | 94 | wxSize GetItemSpacing() const; |
5b98eb2f RL |
95 | void SetItemTextColour( long item, const wxColour& col); |
96 | wxColour GetItemTextColour( long item ) const; | |
97 | void SetItemBackgroundColour( long item, const wxColour &col); | |
98 | wxColour GetItemBackgroundColour( long item ) const; | |
35c2acd4 MW |
99 | void SetItemFont( long item, const wxFont &f); |
100 | wxFont GetItemFont( long item ) const; | |
e179bd65 | 101 | int GetSelectedItemCount() const; |
0530737d VZ |
102 | wxColour GetTextColour() const; |
103 | void SetTextColour(const wxColour& col); | |
e179bd65 | 104 | long GetTopItem() const; |
b16088bf | 105 | |
ca65c044 | 106 | void SetSingleStyle( long style, bool add = true ) ; |
e179bd65 RR |
107 | void SetWindowStyleFlag( long style ); |
108 | void RecreateWindow() {} | |
109 | long GetNextItem( long item, int geometry = wxLIST_NEXT_ALL, int state = wxLIST_STATE_DONTCARE ) const; | |
8a3e173a KO |
110 | wxImageList *GetImageList( int which ) const; |
111 | void SetImageList( wxImageList *imageList, int which ); | |
112 | void AssignImageList( wxImageList *imageList, int which ); | |
debe6624 | 113 | bool Arrange( int flag = wxLIST_ALIGN_DEFAULT ); // always wxLIST_ALIGN_LEFT in wxGLC |
57c4d796 | 114 | |
4f22cf8d | 115 | void ClearAll(); |
debe6624 | 116 | bool DeleteItem( long item ); |
e179bd65 RR |
117 | bool DeleteAllItems(); |
118 | bool DeleteAllColumns(); | |
debe6624 | 119 | bool DeleteColumn( int col ); |
57c4d796 | 120 | |
2c1f73ee VZ |
121 | void SetItemCount(long count); |
122 | ||
26e8da41 VZ |
123 | wxTextCtrl *EditLabel(long item, |
124 | wxClassInfo* textControlClass = CLASSINFO(wxTextCtrl)); | |
125 | wxTextCtrl* GetEditControl() const; | |
126 | void Edit( long item ) { EditLabel(item); } | |
57c4d796 | 127 | |
debe6624 | 128 | bool EnsureVisible( long item ); |
ca65c044 | 129 | long FindItem( long start, const wxString& str, bool partial = false ); |
81ce36aa | 130 | long FindItem( long start, wxUIntPtr data ); |
e179bd65 | 131 | long FindItem( long start, const wxPoint& pt, int direction ); // not supported in wxGLC |
be0e5d69 | 132 | long HitTest( const wxPoint& point, int& flags, long *pSubItem = NULL ) const; |
c801d85f | 133 | long InsertItem(wxListItem& info); |
e179bd65 RR |
134 | long InsertItem( long index, const wxString& label ); |
135 | long InsertItem( long index, int imageIndex ); | |
136 | long InsertItem( long index, const wxString& label, int imageIndex ); | |
137 | long InsertColumn( long col, wxListItem& info ); | |
2f1e3c46 VZ |
138 | long InsertColumn( long col, const wxString& heading, |
139 | int format = wxLIST_FORMAT_LEFT, int width = -1 ); | |
e179bd65 | 140 | bool ScrollList( int dx, int dy ); |
b18e2046 | 141 | bool SortItems( wxListCtrlCompare fn, wxIntPtr data ); |
e179bd65 | 142 | bool Update( long item ); |
6f02a879 VZ |
143 | // Must provide overload to avoid hiding it (and warnings about it) |
144 | virtual void Update() { wxControl::Update(); } | |
29149a64 | 145 | |
b5d43d1d VZ |
146 | // are we in report mode? |
147 | bool InReportView() const { return HasFlag(wxLC_REPORT); } | |
148 | ||
149 | // are we in virtual report mode? | |
150 | bool IsVirtual() const { return HasFlag(wxLC_VIRTUAL); } | |
151 | ||
152 | // do we have a header window? | |
153 | bool HasHeader() const | |
154 | { return InReportView() && !HasFlag(wxLC_NO_HEADER); } | |
2c1f73ee | 155 | |
1a6cb56f VZ |
156 | // refresh items selectively (only useful for virtual list controls) |
157 | void RefreshItem(long item); | |
158 | void RefreshItems(long itemFrom, long itemTo); | |
159 | ||
ca3e85cf | 160 | #if WXWIN_COMPATIBILITY_2_6 |
5db8d758 VZ |
161 | // obsolete, don't use |
162 | wxDEPRECATED( int GetItemSpacing( bool isSmall ) const ); | |
ca3e85cf | 163 | #endif // WXWIN_COMPATIBILITY_2_6 |
5db8d758 | 164 | |
35d4c967 RD |
165 | virtual wxVisualAttributes GetDefaultAttributes() const |
166 | { | |
167 | return GetClassDefaultAttributes(GetWindowVariant()); | |
168 | } | |
169 | ||
170 | static wxVisualAttributes | |
171 | GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL); | |
172 | ||
1a6cb56f VZ |
173 | // implementation only from now on |
174 | // ------------------------------- | |
175 | ||
5180055b | 176 | void OnInternalIdle( ); |
57c4d796 | 177 | |
77e7a1dc | 178 | // We have to hand down a few functions |
ca65c044 | 179 | virtual void Refresh(bool eraseBackground = true, |
2f1e3c46 | 180 | const wxRect *rect = NULL); |
57c4d796 | 181 | |
c5c528fc VZ |
182 | virtual bool SetBackgroundColour( const wxColour &colour ); |
183 | virtual bool SetForegroundColour( const wxColour &colour ); | |
184 | virtual wxColour GetBackgroundColour() const; | |
185 | virtual wxColour GetForegroundColour() const; | |
186 | virtual bool SetFont( const wxFont &font ); | |
187 | virtual bool SetCursor( const wxCursor &cursor ); | |
57c4d796 | 188 | |
1e6d9499 | 189 | #if wxUSE_DRAG_AND_DROP |
c5c528fc VZ |
190 | virtual void SetDropTarget( wxDropTarget *dropTarget ); |
191 | virtual wxDropTarget *GetDropTarget() const; | |
1e6d9499 JS |
192 | #endif |
193 | ||
d4864e97 | 194 | virtual bool ShouldInheritColours() const { return false; } |
c5c528fc | 195 | virtual void SetFocus(); |
c801d85f | 196 | |
b16088bf RR |
197 | // implementation |
198 | // -------------- | |
57c4d796 | 199 | |
8a3e173a KO |
200 | wxImageList *m_imageListNormal; |
201 | wxImageList *m_imageListSmall; | |
202 | wxImageList *m_imageListState; // what's that ? | |
29149a64 | 203 | bool m_ownsImageListNormal, |
2e12c11a VS |
204 | m_ownsImageListSmall, |
205 | m_ownsImageListState; | |
c801d85f KB |
206 | wxListHeaderWindow *m_headerWin; |
207 | wxListMainWindow *m_mainWin; | |
f8252483 | 208 | wxCoord m_headerHeight; |
a3622daa | 209 | |
2c1f73ee | 210 | protected: |
6f02a879 VZ |
211 | virtual bool DoPopupMenu( wxMenu *menu, int x, int y ); |
212 | ||
7447bdd7 VZ |
213 | // take into account the coordinates difference between the container |
214 | // window and the list control window itself here | |
215 | virtual void DoClientToScreen( int *x, int *y ) const; | |
216 | virtual void DoScreenToClient( int *x, int *y ) const; | |
217 | ||
6f02a879 VZ |
218 | virtual wxSize DoGetBestSize() const; |
219 | ||
2c1f73ee VZ |
220 | // return the text for the given column of the given item |
221 | virtual wxString OnGetItemText(long item, long column) const; | |
222 | ||
208458a7 | 223 | // return the icon for the given item. In report view, OnGetItemImage will |
ca3e85cf | 224 | // only be called for the first column. See OnGetItemColumnImage for |
208458a7 | 225 | // details. |
2c1f73ee VZ |
226 | virtual int OnGetItemImage(long item) const; |
227 | ||
208458a7 RD |
228 | // return the icon for the given item and column. |
229 | virtual int OnGetItemColumnImage(long item, long column) const; | |
230 | ||
6c02c329 VZ |
231 | // return the attribute for the item (may return NULL if none) |
232 | virtual wxListItemAttr *OnGetItemAttr(long item) const; | |
233 | ||
2c1f73ee | 234 | // it calls our OnGetXXX() functions |
b5dbe15d | 235 | friend class WXDLLIMPEXP_FWD_CORE wxListMainWindow; |
2c1f73ee | 236 | |
06cd40a8 RR |
237 | virtual wxBorder GetDefaultBorder() const; |
238 | ||
b16088bf | 239 | private: |
06cd40a8 RR |
240 | void CreateOrDestroyHeaderWindowAsNeeded(); |
241 | void OnScroll( wxScrollWinEvent& event ); | |
242 | void OnSize( wxSizeEvent &event ); | |
243 | virtual wxSize GetSizeAvailableForScrollTarget(const wxSize& size); | |
cf1dfa6b | 244 | |
06cd40a8 RR |
245 | // we need to return a special WM_GETDLGCODE value to process just the |
246 | // arrows but let the other navigation characters through | |
5d55031c VZ |
247 | #if defined(__WXMSW__) && !defined(__WXWINCE__) && !defined(__WXUNIVERSAL__) |
248 | virtual WXLRESULT | |
249 | MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam); | |
06cd40a8 | 250 | #endif // __WXMSW__ |
f8252483 | 251 | |
06cd40a8 | 252 | WX_FORWARD_TO_SCROLL_HELPER() |
c0f8674c | 253 | |
b16088bf | 254 | DECLARE_EVENT_TABLE() |
6b99f53e | 255 | DECLARE_DYNAMIC_CLASS(wxGenericListCtrl) |
c801d85f KB |
256 | }; |
257 | ||
5712a1f5 | 258 | #if (!defined(__WXMSW__) || defined(__WXUNIVERSAL__)) && (!(defined(__WXMAC__) && wxOSX_USE_CARBON) || 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 | |
53a2db12 | 264 | class WXDLLIMPEXP_CORE wxListCtrl: public wxGenericListCtrl |
b31989e2 JS |
265 | { |
266 | DECLARE_DYNAMIC_CLASS(wxListCtrl) | |
267 | ||
268 | public: | |
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, | |
52f2ad08 | 276 | const wxString &name = wxListCtrlNameStr) |
6463b9f5 JS |
277 | : wxGenericListCtrl(parent, winid, pos, size, style, validator, name) |
278 | { | |
279 | } | |
ad486020 | 280 | |
b31989e2 | 281 | }; |
3a5bcc4d | 282 | #endif // !__WXMSW__ || __WXUNIVERSAL__ |
5b98eb2f | 283 | |
e409b62a | 284 | #endif // _WX_GENERIC_LISTCTRL_H_ |