]>
Commit | Line | Data |
---|---|---|
bdc72a22 VZ |
1 | /////////////////////////////////////////////////////////////////////////////// |
2 | // Name: wx/listctrl.h | |
3 | // Purpose: wxListCtrl class | |
4 | // Author: Vadim Zeitlin | |
5 | // Modified by: | |
6 | // Created: 04.12.99 | |
7 | // RCS-ID: $Id$ | |
8 | // Copyright: (c) wxWindows team | |
9 | // Licence: wxWindows licence | |
10 | /////////////////////////////////////////////////////////////////////////////// | |
11 | ||
34138703 JS |
12 | #ifndef _WX_LISTCTRL_H_BASE_ |
13 | #define _WX_LISTCTRL_H_BASE_ | |
c801d85f | 14 | |
bdc72a22 VZ |
15 | // ---------------------------------------------------------------------------- |
16 | // types | |
17 | // ---------------------------------------------------------------------------- | |
18 | ||
19 | // type of compare function for wxListCtrl sort operation | |
20 | typedef int (wxCALLBACK *wxListCtrlCompare)(long item1, long item2, long sortData); | |
21 | ||
22 | // ---------------------------------------------------------------------------- | |
23 | // wxListCtrl constants | |
24 | // ---------------------------------------------------------------------------- | |
25 | ||
26 | // Mask flags to tell app/GUI what fields of wxListItem are valid | |
27 | #define wxLIST_MASK_STATE 0x0001 | |
28 | #define wxLIST_MASK_TEXT 0x0002 | |
29 | #define wxLIST_MASK_IMAGE 0x0004 | |
30 | #define wxLIST_MASK_DATA 0x0008 | |
31 | #define wxLIST_SET_ITEM 0x0010 | |
32 | #define wxLIST_MASK_WIDTH 0x0020 | |
33 | #define wxLIST_MASK_FORMAT 0x0040 | |
34 | ||
35 | // State flags for indicating the state of an item | |
36 | #define wxLIST_STATE_DONTCARE 0x0000 | |
37 | #define wxLIST_STATE_DROPHILITED 0x0001 // MSW only | |
38 | #define wxLIST_STATE_FOCUSED 0x0002 | |
39 | #define wxLIST_STATE_SELECTED 0x0004 | |
40 | #define wxLIST_STATE_CUT 0x0008 // MSW only | |
41 | ||
42 | // Hit test flags, used in HitTest | |
43 | #define wxLIST_HITTEST_ABOVE 0x0001 // Above the client area. | |
44 | #define wxLIST_HITTEST_BELOW 0x0002 // Below the client area. | |
45 | #define wxLIST_HITTEST_NOWHERE 0x0004 // In the client area but below the last item. | |
46 | #define wxLIST_HITTEST_ONITEMICON 0x0020 // On the bitmap associated with an item. | |
47 | #define wxLIST_HITTEST_ONITEMLABEL 0x0080 // On the label (string) associated with an item. | |
48 | #define wxLIST_HITTEST_ONITEMRIGHT 0x0100 // In the area to the right of an item. | |
49 | #define wxLIST_HITTEST_ONITEMSTATEICON 0x0200 // On the state icon for a tree view item that is in a user-defined state. | |
50 | #define wxLIST_HITTEST_TOLEFT 0x0400 // To the left of the client area. | |
51 | #define wxLIST_HITTEST_TORIGHT 0x0800 // To the right of the client area. | |
52 | ||
53 | #define wxLIST_HITTEST_ONITEM (wxLIST_HITTEST_ONITEMICON | wxLIST_HITTEST_ONITEMLABEL | wxLIST_HITTEST_ONITEMSTATEICON) | |
54 | ||
55 | // Flags for GetNextItem (MSW only except wxLIST_NEXT_ALL) | |
56 | enum | |
57 | { | |
58 | wxLIST_NEXT_ABOVE, // Searches for an item above the specified item | |
59 | wxLIST_NEXT_ALL, // Searches for subsequent item by index | |
60 | wxLIST_NEXT_BELOW, // Searches for an item below the specified item | |
61 | wxLIST_NEXT_LEFT, // Searches for an item to the left of the specified item | |
43543d98 | 62 | wxLIST_NEXT_RIGHT // Searches for an item to the right of the specified item |
bdc72a22 VZ |
63 | }; |
64 | ||
65 | // Alignment flags for Arrange (MSW only except wxLIST_ALIGN_LEFT) | |
66 | enum | |
67 | { | |
68 | wxLIST_ALIGN_DEFAULT, | |
69 | wxLIST_ALIGN_LEFT, | |
70 | wxLIST_ALIGN_TOP, | |
71 | wxLIST_ALIGN_SNAP_TO_GRID | |
72 | }; | |
73 | ||
74 | // Column format (MSW only except wxLIST_FORMAT_LEFT) | |
75 | enum wxListColumnFormat | |
76 | { | |
77 | wxLIST_FORMAT_LEFT, | |
78 | wxLIST_FORMAT_RIGHT, | |
79 | wxLIST_FORMAT_CENTRE, | |
80 | wxLIST_FORMAT_CENTER = wxLIST_FORMAT_CENTRE | |
81 | }; | |
82 | ||
83 | // Autosize values for SetColumnWidth | |
84 | enum | |
85 | { | |
86 | wxLIST_AUTOSIZE = -1, | |
87 | wxLIST_AUTOSIZE_USEHEADER = -2 // partly supported by generic version | |
88 | }; | |
89 | ||
90 | // Flag values for GetItemRect | |
91 | enum | |
92 | { | |
93 | wxLIST_RECT_BOUNDS, | |
94 | wxLIST_RECT_ICON, | |
95 | wxLIST_RECT_LABEL | |
96 | }; | |
97 | ||
98 | // Flag values for FindItem (MSW only) | |
99 | enum | |
100 | { | |
101 | wxLIST_FIND_UP, | |
102 | wxLIST_FIND_DOWN, | |
103 | wxLIST_FIND_LEFT, | |
104 | wxLIST_FIND_RIGHT | |
105 | }; | |
106 | ||
107 | // ---------------------------------------------------------------------------- | |
108 | // wxListItemAttr: a structure containing the visual attributes of an item | |
109 | // ---------------------------------------------------------------------------- | |
110 | ||
111 | class WXDLLEXPORT wxListItemAttr | |
112 | { | |
113 | public: | |
114 | // ctors | |
115 | wxListItemAttr() { } | |
116 | wxListItemAttr(const wxColour& colText, | |
117 | const wxColour& colBack, | |
118 | const wxFont& font) | |
119 | : m_colText(colText), m_colBack(colBack), m_font(font) { } | |
120 | ||
121 | // setters | |
122 | void SetTextColour(const wxColour& colText) { m_colText = colText; } | |
123 | void SetBackgroundColour(const wxColour& colBack) { m_colBack = colBack; } | |
124 | void SetFont(const wxFont& font) { m_font = font; } | |
125 | ||
126 | // accessors | |
d62228a6 VZ |
127 | bool HasTextColour() const { return m_colText.Ok(); } |
128 | bool HasBackgroundColour() const { return m_colBack.Ok(); } | |
129 | bool HasFont() const { return m_font.Ok(); } | |
130 | ||
bdc72a22 VZ |
131 | const wxColour& GetTextColour() const { return m_colText; } |
132 | const wxColour& GetBackgroundColour() const { return m_colBack; } | |
133 | const wxFont& GetFont() const { return m_font; } | |
134 | ||
135 | private: | |
136 | wxColour m_colText, | |
137 | m_colBack; | |
138 | wxFont m_font; | |
139 | }; | |
140 | ||
141 | // ---------------------------------------------------------------------------- | |
142 | // wxListItem: the item or column info, used to exchange data with wxListCtrl | |
143 | // ---------------------------------------------------------------------------- | |
144 | ||
145 | class WXDLLEXPORT wxListItem : public wxObject | |
146 | { | |
147 | public: | |
148 | wxListItem(); | |
d62228a6 | 149 | ~wxListItem() { delete m_attr; } |
bdc72a22 | 150 | |
9b00bb16 RR |
151 | // resetting |
152 | void Clear(); | |
153 | void ClearAttributes(); | |
154 | ||
bdc72a22 VZ |
155 | // setters |
156 | void SetMask(long mask) { m_mask = mask; } | |
157 | void SetId(long id) { m_itemId = id; } | |
158 | void SetColumn(int col) { m_col = col; } | |
159 | void SetState(long state) { m_state = state; m_stateMask |= state; } | |
160 | void SetStateMask(long stateMask) { m_stateMask = stateMask; } | |
161 | void SetText(const wxString& text) { m_text = text; } | |
162 | void SetImage(int image) { m_image = image; } | |
163 | void SetData(long data) { m_data = data; } | |
164 | void SetData(void *data) { m_data = (long)data; } | |
165 | ||
166 | void SetWidth(int width) { m_width = width; } | |
167 | void SetAlign(wxListColumnFormat align) { m_format = align; } | |
168 | ||
169 | void SetTextColour(const wxColour& colText) | |
170 | { Attributes().SetTextColour(colText); } | |
171 | void SetBackgroundColour(const wxColour& colBack) | |
172 | { Attributes().SetBackgroundColour(colBack); } | |
173 | void SetFont(const wxFont& font) | |
174 | { Attributes().SetFont(font); } | |
175 | ||
176 | // accessors | |
177 | long GetMask() const { return m_mask; } | |
178 | long GetId() const { return m_itemId; } | |
179 | int GetColumn() const { return m_col; } | |
180 | long GetState() const { return m_state & m_stateMask; } | |
181 | const wxString& GetText() const { return m_text; } | |
182 | int GetImage() const { return m_image; } | |
183 | long GetData() const { return m_data; } | |
184 | ||
185 | int GetWidth() const { return m_width; } | |
186 | wxListColumnFormat GetAlign() const { return (wxListColumnFormat)m_format; } | |
187 | ||
188 | wxListItemAttr *GetAttributes() const { return m_attr; } | |
189 | bool HasAttributes() const { return m_attr != NULL; } | |
190 | ||
13111b2a | 191 | wxColour GetTextColour() const |
bdc72a22 | 192 | { return HasAttributes() ? m_attr->GetTextColour() : wxNullColour; } |
13111b2a | 193 | wxColour GetBackgroundColour() const |
bdc72a22 VZ |
194 | { return HasAttributes() ? m_attr->GetBackgroundColour() |
195 | : wxNullColour; } | |
13111b2a | 196 | wxFont GetFont() const |
bdc72a22 VZ |
197 | { return HasAttributes() ? m_attr->GetFont() : wxNullFont; } |
198 | ||
199 | // these members are public for compatibility | |
200 | ||
201 | long m_mask; // Indicates what fields are valid | |
202 | long m_itemId; // The zero-based item position | |
203 | int m_col; // Zero-based column, if in report mode | |
204 | long m_state; // The state of the item | |
205 | long m_stateMask;// Which flags of m_state are valid (uses same flags) | |
206 | wxString m_text; // The label/header text | |
207 | int m_image; // The zero-based index into an image list | |
208 | long m_data; // App-defined data | |
209 | ||
210 | // For columns only | |
211 | int m_format; // left, right, centre | |
212 | int m_width; // width of column | |
213 | ||
214 | protected: | |
215 | // creates m_attr if we don't have it yet | |
216 | wxListItemAttr& Attributes() | |
217 | { | |
218 | if ( !m_attr ) | |
219 | m_attr = new wxListItemAttr; | |
220 | ||
221 | return *m_attr; | |
222 | } | |
223 | ||
224 | wxListItemAttr *m_attr; // optional pointer to the items style | |
225 | ||
226 | private: | |
227 | DECLARE_DYNAMIC_CLASS(wxListItem) | |
228 | }; | |
229 | ||
230 | // ---------------------------------------------------------------------------- | |
231 | // include the wxListCtrl class declaration | |
232 | // ---------------------------------------------------------------------------- | |
233 | ||
2049ba38 | 234 | #if defined(__WXMSW__) |
bdc72a22 VZ |
235 | #ifdef __WIN16__ |
236 | #include "wx/generic/listctrl.h" | |
237 | #else | |
238 | #include "wx/msw/listctrl.h" | |
239 | #endif | |
2049ba38 | 240 | #elif defined(__WXMOTIF__) |
bdc72a22 | 241 | #include "wx/generic/listctrl.h" |
2049ba38 | 242 | #elif defined(__WXGTK__) |
bdc72a22 | 243 | #include "wx/generic/listctrl.h" |
b4e76e0d | 244 | #elif defined(__WXQT__) |
bdc72a22 | 245 | #include "wx/generic/listctrl.h" |
34138703 | 246 | #elif defined(__WXMAC__) |
bdc72a22 | 247 | #include "wx/generic/listctrl.h" |
1777b9bb | 248 | #elif defined(__WXPM__) |
bdc72a22 | 249 | #include "wx/generic/listctrl.h" |
34138703 | 250 | #elif defined(__WXSTUBS__) |
bdc72a22 | 251 | #include "wx/generic/listctrl.h" |
c801d85f KB |
252 | #endif |
253 | ||
86f975a8 VZ |
254 | // ---------------------------------------------------------------------------- |
255 | // wxListEvent - the event class for the wxListCtrl notifications | |
256 | // ---------------------------------------------------------------------------- | |
257 | ||
258 | class WXDLLEXPORT wxListEvent : public wxNotifyEvent | |
259 | { | |
260 | public: | |
261 | wxListEvent(wxEventType commandType = wxEVT_NULL, int id = 0); | |
262 | ||
263 | int m_code; | |
264 | long m_itemIndex; | |
265 | long m_oldItemIndex; | |
266 | int m_col; | |
267 | bool m_cancelled; | |
268 | wxPoint m_pointDrag; | |
269 | ||
270 | wxListItem m_item; | |
cdf1e714 | 271 | |
0b855868 RR |
272 | inline int GetCode() { return m_code; } |
273 | inline long GetIndex() { return m_itemIndex; } | |
274 | inline long GetOldIndex() { return m_oldItemIndex; } | |
275 | inline long GetItem() { return m_itemIndex; } | |
276 | inline long GetOldItem() { return m_oldItemIndex; } | |
277 | inline int GetColumn() { return m_col; } | |
278 | inline bool Cancelled() { return m_cancelled; } | |
279 | inline wxPoint GetPoint() { return m_pointDrag; } | |
280 | inline const wxString &GetLabel() const { return m_item.m_text; } | |
281 | inline const wxString &GetText() const { return m_item.m_text; } | |
282 | inline int GetImage() { return m_item.m_image; } | |
283 | inline long GetData() { return m_item.m_data; } | |
284 | inline long GetMask() { return m_item.m_mask; } | |
285 | inline const wxListItem &GetItem() const { return m_item; } | |
86f975a8 | 286 | |
e4c730e9 | 287 | void CopyObject(wxObject& object_dest) const; |
e4c730e9 | 288 | |
86f975a8 VZ |
289 | private: |
290 | DECLARE_DYNAMIC_CLASS(wxListEvent) | |
291 | }; | |
292 | ||
293 | typedef void (wxEvtHandler::*wxListEventFunction)(wxListEvent&); | |
294 | ||
295 | #define EVT_LIST_BEGIN_DRAG(id, fn) { wxEVT_COMMAND_LIST_BEGIN_DRAG, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL }, | |
296 | #define EVT_LIST_BEGIN_RDRAG(id, fn) { wxEVT_COMMAND_LIST_BEGIN_RDRAG, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL }, | |
297 | #define EVT_LIST_BEGIN_LABEL_EDIT(id, fn) { wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL }, | |
298 | #define EVT_LIST_END_LABEL_EDIT(id, fn) { wxEVT_COMMAND_LIST_END_LABEL_EDIT, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL }, | |
299 | #define EVT_LIST_DELETE_ITEM(id, fn) { wxEVT_COMMAND_LIST_DELETE_ITEM, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL }, | |
300 | #define EVT_LIST_DELETE_ALL_ITEMS(id, fn) { wxEVT_COMMAND_LIST_DELETE_ALL_ITEMS, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL }, | |
301 | #define EVT_LIST_GET_INFO(id, fn) { wxEVT_COMMAND_LIST_GET_INFO, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL }, | |
302 | #define EVT_LIST_SET_INFO(id, fn) { wxEVT_COMMAND_LIST_SET_INFO, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL }, | |
303 | #define EVT_LIST_ITEM_SELECTED(id, fn) { wxEVT_COMMAND_LIST_ITEM_SELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL }, | |
304 | #define EVT_LIST_ITEM_DESELECTED(id, fn) { wxEVT_COMMAND_LIST_ITEM_DESELECTED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL }, | |
305 | #define EVT_LIST_KEY_DOWN(id, fn) { wxEVT_COMMAND_LIST_KEY_DOWN, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL }, | |
306 | #define EVT_LIST_INSERT_ITEM(id, fn) { wxEVT_COMMAND_LIST_INSERT_ITEM, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL }, | |
307 | #define EVT_LIST_COL_CLICK(id, fn) { wxEVT_COMMAND_LIST_COL_CLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, NULL }, | |
4debf135 UC |
308 | #define EVT_LIST_ITEM_RIGHT_CLICK(id, fn) { wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, (wxObject *) NULL }, |
309 | #define EVT_LIST_ITEM_MIDDLE_CLICK(id, fn) { wxEVT_COMMAND_LIST_ITEM_MIDDLE_CLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, (wxObject *) NULL }, | |
86f975a8 VZ |
310 | #define EVT_LIST_ITEM_ACTIVATED(id, fn) { wxEVT_COMMAND_LIST_ITEM_ACTIVATED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxListEventFunction) & fn, (wxObject *) NULL }, |
311 | ||
c801d85f | 312 | #endif |
34138703 | 313 | // _WX_LISTCTRL_H_BASE_ |