]> git.saurik.com Git - wxWidgets.git/blame - include/wx/msw/treectrl.h
correct (working) version of wxString
[wxWidgets.git] / include / wx / msw / treectrl.h
CommitLineData
2bda0e17
KB
1/////////////////////////////////////////////////////////////////////////////
2// Name: treectrl.h
3// Purpose: wxTreeCtrl class
4// Author: Julian Smart
5// Modified by:
6// Created: 01/02/97
7// RCS-ID: $Id$
8// Copyright: (c) Julian Smart and Markus Holzem
9// Licence: wxWindows license
10/////////////////////////////////////////////////////////////////////////////
11
12#ifndef __TREECTRLH__
13#define __TREECTRLH__
14
15#ifdef __GNUG__
16#pragma interface "treectrl.h"
17#endif
18
19#include "wx/control.h"
20#include "wx/event.h"
21#include "wx/imaglist.h"
22
23// WXDLLEXPORT_DATA(extern const char*) wxTreeNameStr;
24
25#define wxTREE_MASK_HANDLE 0x0001
26#define wxTREE_MASK_STATE 0x0002
27#define wxTREE_MASK_TEXT 0x0004
28#define wxTREE_MASK_IMAGE 0x0008
29#define wxTREE_MASK_SELECTED_IMAGE 0x0010
30#define wxTREE_MASK_CHILDREN 0x0020
31#define wxTREE_MASK_DATA 0x0040
32
33#define wxTREE_STATE_BOLD 0x0001
34#define wxTREE_STATE_DROPHILITED 0x0002
35#define wxTREE_STATE_EXPANDED 0x0004
36#define wxTREE_STATE_EXPANDEDONCE 0x0008
37#define wxTREE_STATE_FOCUSED 0x0010
38#define wxTREE_STATE_SELECTED 0x0020
39#define wxTREE_STATE_CUT 0x0040
40
41#define wxTREE_HITTEST_ABOVE 0x0001 // Above the client area.
42#define wxTREE_HITTEST_BELOW 0x0002 // Below the client area.
43#define wxTREE_HITTEST_NOWHERE 0x0004 // In the client area but below the last item.
44#define wxTREE_HITTEST_ONITEMBUTTON 0x0010 // On the button associated with an item.
45#define wxTREE_HITTEST_ONITEMICON 0x0020 // On the bitmap associated with an item.
46#define wxTREE_HITTEST_ONITEMINDENT 0x0040 // In the indentation associated with an item.
47#define wxTREE_HITTEST_ONITEMLABEL 0x0080 // On the label (string) associated with an item.
48#define wxTREE_HITTEST_ONITEMRIGHT 0x0100 // In the area to the right of an item.
49#define wxTREE_HITTEST_ONITEMSTATEICON 0x0200 // On the state icon for a tree view item that is in a user-defined state.
50#define wxTREE_HITTEST_TOLEFT 0x0400 // To the right of the client area.
51#define wxTREE_HITTEST_TORIGHT 0x0800 // To the left of the client area.
52
4efd7443 53#define wxTREE_HITTEST_ONITEM (wxTREE_HITTEST_ONITEMICON | wxTREE_HITTEST_ONITEMLABEL | wxTREE_HITTEST_ONITEMSTATEICON)
2bda0e17
KB
54
55// Flags for GetNextItem
56enum {
57 wxTREE_NEXT_CARET, // Retrieves the currently selected item.
58 wxTREE_NEXT_CHILD, // Retrieves the first child item. The hItem parameter must be NULL.
59 wxTREE_NEXT_DROPHILITE, // Retrieves the item that is the target of a drag-and-drop operation.
60 wxTREE_NEXT_FIRSTVISIBLE, // Retrieves the first visible item.
61 wxTREE_NEXT_NEXT, // Retrieves the next sibling item.
62 wxTREE_NEXT_NEXTVISIBLE, // Retrieves the next visible item that follows the specified item.
63 wxTREE_NEXT_PARENT, // Retrieves the parent of the specified item.
64 wxTREE_NEXT_PREVIOUS, // Retrieves the previous sibling item.
65 wxTREE_NEXT_PREVIOUSVISIBLE, // Retrieves the first visible item that precedes the specified item.
66 wxTREE_NEXT_ROOT // Retrieves the first child item of the root item of which the specified item is a part.
67};
68
69// Flags for ExpandItem
70enum {
71 wxTREE_EXPAND_EXPAND,
72 wxTREE_EXPAND_COLLAPSE,
73 wxTREE_EXPAND_COLLAPSE_RESET,
74 wxTREE_EXPAND_TOGGLE
75};
76
77// Flags for InsertItem
78enum {
79 wxTREE_INSERT_LAST = -1,
80 wxTREE_INSERT_FIRST = -2,
81 wxTREE_INSERT_SORT = -3
82};
83
84class WXDLLEXPORT wxTreeItem: public wxObject
85{
86 DECLARE_DYNAMIC_CLASS(wxTreeItem)
87public:
88 long m_mask;
89 long m_itemId;
90 long m_state;
91 long m_stateMask;
92 wxString m_text;
93 int m_image;
94 int m_selectedImage;
95 int m_children;
96 long m_data;
97
092bddef 98 wxTreeItem();
64693098
JS
99
100// Accessors
101 inline long GetMask() const { return m_mask; }
102 inline long GetItemId() const { return m_itemId; }
103 inline long GetState() const { return m_state; }
104 inline long GetStateMask() const { return m_stateMask; }
105 inline wxString GetText() const { return m_text; }
106 inline int GetImage() const { return m_image; }
107 inline int GetSelectedImage() const { return m_selectedImage; }
108 inline int GetChildren() const { return m_children; }
109 inline long GetData() const { return m_data; }
110
111 inline void SetMask(long mask) { m_mask = mask; }
112 inline void SetItemId(long id) { m_itemId = m_itemId = id; }
092bddef 113 inline void SetState(long state) { m_state = state; }
64693098
JS
114 inline void SetStateMask(long stateMask) { m_stateMask = stateMask; }
115 inline void GetText(const wxString& text) { m_text = text; }
116 inline void SetImage(int image) { m_image = image; }
117 inline void GetSelectedImage(int selImage) { m_selectedImage = selImage; }
118 inline void SetChildren(int children) { m_children = children; }
119 inline void SetData(long data) { m_data = data; }
2bda0e17
KB
120};
121
122class WXDLLEXPORT wxTreeCtrl: public wxControl
123{
092bddef
VZ
124public:
125 /*
126 * Public interface
127 */
128
129 // creation
130 // --------
131 wxTreeCtrl();
132
133 inline wxTreeCtrl(wxWindow *parent, wxWindowID id = -1,
134 const wxPoint& pos = wxDefaultPosition,
135 const wxSize& size = wxDefaultSize,
136 long style = wxTR_HAS_BUTTONS|wxTR_LINES_AT_ROOT,
137 const wxValidator& validator = wxDefaultValidator,
138 const wxString& name = "wxTreeCtrl")
139 {
140 Create(parent, id, pos, size, style, validator, name);
141 }
142 ~wxTreeCtrl();
143
144 bool Create(wxWindow *parent, wxWindowID id = -1,
145 const wxPoint& pos = wxDefaultPosition,
146 const wxSize& size = wxDefaultSize,
147 long style = wxTR_HAS_BUTTONS|wxTR_LINES_AT_ROOT,
148 const wxValidator& validator = wxDefaultValidator,
149 const wxString& name = "wxTreeCtrl");
150
151 // accessors
152 // ---------
153 //
154 int GetCount() const;
155
156 // indent
157 int GetIndent() const;
158 void SetIndent(int indent);
159 // image list
160 wxImageList *GetImageList(int which = wxIMAGE_LIST_NORMAL) const;
161 void SetImageList(wxImageList *imageList, int which = wxIMAGE_LIST_NORMAL);
162
163 // navigation inside the tree
164 long GetNextItem(long item, int code) const;
165 bool ItemHasChildren(long item) const;
166 long GetChild(long item) const;
167 long GetParent(long item) const;
168 long GetFirstVisibleItem() const;
169 long GetNextVisibleItem(long item) const;
170 long GetSelection() const;
171 long GetRootItem() const;
172
173 // generic function for (g|s)etting item attributes
174 bool GetItem(wxTreeItem& info) const;
175 bool SetItem(wxTreeItem& info);
176 // item state
177 int GetItemState(long item, long stateMask) const;
178 bool SetItemState(long item, long state, long stateMask);
179 // item image
180 bool SetItemImage(long item, int image, int selImage);
181 // item text
182 wxString GetItemText(long item) const;
183 void SetItemText(long item, const wxString& str);
184 // custom data associated with the item
185 long GetItemData(long item) const;
186 bool SetItemData(long item, long data);
187 // convenience function
188 bool IsItemExpanded(long item)
189 {
190 return (GetItemState(item, wxTREE_STATE_EXPANDED) &
191 wxTREE_STATE_EXPANDED) != 0;
192 }
193
194 // bounding rect
195 bool GetItemRect(long item, wxRectangle& rect, bool textOnly = FALSE) const;
196 //
197 wxTextCtrl& GetEditControl() const;
198
199 // operations
200 // ----------
201 // adding/deleting items
202 bool DeleteItem(long item);
203 long InsertItem(long parent, wxTreeItem& info,
204 long insertAfter = wxTREE_INSERT_LAST);
205 // If image > -1 and selImage == -1, the same image is used for
206 // both selected and unselected items.
207 long InsertItem(long parent, const wxString& label,
208 int image = -1, int selImage = -1,
209 long insertAfter = wxTREE_INSERT_LAST);
210
211 // changing item state
212 bool ExpandItem(long item) { return ExpandItem(item, wxTREE_EXPAND_EXPAND); }
213 bool CollapseItem(long item) { return ExpandItem(item, wxTREE_EXPAND_COLLAPSE); }
214 bool ToggleItem(long item) { return ExpandItem(item, wxTREE_EXPAND_TOGGLE); }
215 // common interface for {Expand|Collapse|Toggle}Item
216 bool ExpandItem(long item, int action);
217
218 //
219 bool SelectItem(long item);
220 bool ScrollTo(long item);
221 bool DeleteAllItems();
222 wxTextCtrl& Edit(long item);
223 long HitTest(const wxPoint& point, int& flags);
224 // wxImageList *CreateDragImage(long item);
225 bool SortChildren(long item);
226 bool EnsureVisible(long item);
227
228 // IMPLEMENTATION
229 void Command(wxCommandEvent& event) { ProcessCommand(event); };
230 bool MSWCommand(WXUINT param, WXWORD id);
231 bool MSWNotify(WXWPARAM wParam, WXLPARAM lParam);
232
2bda0e17 233protected:
092bddef
VZ
234 wxTextCtrl m_textCtrl;
235 wxImageList *m_imageListNormal;
236 wxImageList *m_imageListState;
237
238 DECLARE_DYNAMIC_CLASS(wxTreeCtrl)
2bda0e17
KB
239};
240
241/*
242 wxEVT_COMMAND_TREE_BEGIN_DRAG,
243 wxEVT_COMMAND_TREE_BEGIN_RDRAG,
244 wxEVT_COMMAND_TREE_BEGIN_LABEL_EDIT,
245 wxEVT_COMMAND_TREE_END_LABEL_EDIT,
246 wxEVT_COMMAND_TREE_DELETE_ITEM,
247 wxEVT_COMMAND_TREE_GET_INFO,
248 wxEVT_COMMAND_TREE_SET_INFO,
249 wxEVT_COMMAND_TREE_ITEM_EXPANDED,
250 wxEVT_COMMAND_TREE_ITEM_EXPANDING,
092bddef
VZ
251 wxEVT_COMMAND_TREE_ITEM_COLLAPSED,
252 wxEVT_COMMAND_TREE_ITEM_COLLAPSING,
2bda0e17
KB
253 wxEVT_COMMAND_TREE_SEL_CHANGED,
254 wxEVT_COMMAND_TREE_SEL_CHANGING,
255 wxEVT_COMMAND_TREE_KEY_DOWN
256*/
257
258class WXDLLEXPORT wxTreeEvent: public wxCommandEvent
259{
260 DECLARE_DYNAMIC_CLASS(wxTreeEvent)
261
262 public:
64693098 263 wxTreeEvent(wxEventType commandType = wxEVT_NULL, int id = 0);
2bda0e17
KB
264
265 int m_code;
266 wxTreeItem m_item;
267 long m_oldItem;
268 wxPoint m_pointDrag;
64693098
JS
269
270 inline long GetOldItem() const { return m_oldItem; }
271 inline wxTreeItem& GetItem() const { return (wxTreeItem&) m_item; }
272 inline wxPoint GetPoint() const { return m_pointDrag; }
273 inline int GetCode() const { return m_code; }
2bda0e17
KB
274};
275
276typedef void (wxEvtHandler::*wxTreeEventFunction)(wxTreeEvent&);
277
fe71f65c
RR
278#define EVT_TREE_BEGIN_DRAG(id, fn) { wxEVT_COMMAND_TREE_BEGIN_DRAG, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL },
279#define EVT_TREE_BEGIN_RDRAG(id, fn) { wxEVT_COMMAND_TREE_BEGIN_RDRAG, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL },
280#define EVT_TREE_BEGIN_LABEL_EDIT(id, fn) { wxEVT_COMMAND_TREE_BEGIN_LABEL_EDIT, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL },
281#define EVT_TREE_END_LABEL_EDIT(id, fn) { wxEVT_COMMAND_TREE_END_LABEL_EDIT, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL },
282#define EVT_TREE_DELETE_ITEM(id, fn) { wxEVT_COMMAND_TREE_DELETE_ITEM, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL },
283#define EVT_TREE_GET_INFO(id, fn) { wxEVT_COMMAND_TREE_GET_INFO, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL },
284#define EVT_TREE_SET_INFO(id, fn) { wxEVT_COMMAND_TREE_SET_INFO, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL },
285#define EVT_TREE_ITEM_EXPANDED(id, fn) { wxEVT_COMMAND_TREE_ITEM_EXPANDED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL },
286#define EVT_TREE_ITEM_EXPANDING(id, fn) { wxEVT_COMMAND_TREE_ITEM_EXPANDING, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL },
092bddef
VZ
287#define EVT_TREE_ITEM_COLLAPSED(id, fn) { wxEVT_COMMAND_TREE_ITEM_COLLAPSED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL },
288#define EVT_TREE_ITEM_COLLAPSING(id, fn) { wxEVT_COMMAND_TREE_ITEM_COLLAPSING, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL },
fe71f65c
RR
289#define EVT_TREE_SEL_CHANGED(id, fn) { wxEVT_COMMAND_TREE_SEL_CHANGED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL },
290#define EVT_TREE_SEL_CHANGING(id, fn) { wxEVT_COMMAND_TREE_SEL_CHANGING, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL },
291#define EVT_TREE_KEY_DOWN(id, fn) { wxEVT_COMMAND_TREE_KEY_DOWN, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL },
2bda0e17
KB
292
293#endif
294 // __TREECTRLH__