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