1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: wxTreeCtrl class
4 // Author: Julian Smart
8 // Copyright: (c) Julian Smart and Markus Holzem
9 // Licence: wxWindows license
10 /////////////////////////////////////////////////////////////////////////////
16 #pragma interface "treectrl.h"
19 #include "wx/control.h"
21 #include "wx/imaglist.h"
23 // WXDLLEXPORT_DATA(extern const char*) wxTreeNameStr;
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
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
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.
53 #define wxTREE_HITTEST_ONITEM (wxTREE_HITTEST_ONITEMICON | wxTREE_HITTEST_ONITEMLABEL | wxTREE_HITTEST_ONITEMSTATEICON)
55 // Flags for GetNextItem
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.
69 // Flags for ExpandItem
72 wxTREE_EXPAND_COLLAPSE
,
73 wxTREE_EXPAND_COLLAPSE_RESET
,
77 // Flags for InsertItem
78 #define wxTREE_INSERT_FIRST 0xFFFF0001
79 #define wxTREE_INSERT_LAST 0xFFFF0002
80 #define wxTREE_INSERT_SORT 0xFFFF0003
82 class WXDLLEXPORT wxTreeItem
: public wxObject
84 DECLARE_DYNAMIC_CLASS(wxTreeItem
)
99 inline long GetMask() const { return m_mask
; }
100 inline long GetItemId() const { return m_itemId
; }
101 inline long GetState() const { return m_state
; }
102 inline long GetStateMask() const { return m_stateMask
; }
103 inline wxString
GetText() const { return m_text
; }
104 inline int GetImage() const { return m_image
; }
105 inline int GetSelectedImage() const { return m_selectedImage
; }
106 inline int GetChildren() const { return m_children
; }
107 inline long GetData() const { return m_data
; }
109 inline void SetMask(long mask
) { m_mask
= mask
; }
110 inline void SetItemId(long id
) { m_itemId
= m_itemId
= id
; }
111 inline void SetState(long state
) { m_state
= state
; }
112 inline void SetStateMask(long stateMask
) { m_stateMask
= stateMask
; }
113 inline void GetText(const wxString
& text
) { m_text
= text
; }
114 inline void SetImage(int image
) { m_image
= image
; }
115 inline void GetSelectedImage(int selImage
) { m_selectedImage
= selImage
; }
116 inline void SetChildren(int children
) { m_children
= children
; }
117 inline void SetData(long data
) { m_data
= data
; }
120 class WXDLLEXPORT wxTreeCtrl
: public wxControl
131 inline wxTreeCtrl(wxWindow
*parent
, wxWindowID id
= -1,
132 const wxPoint
& pos
= wxDefaultPosition
,
133 const wxSize
& size
= wxDefaultSize
,
134 long style
= wxTR_HAS_BUTTONS
|wxTR_LINES_AT_ROOT
,
135 const wxValidator
& validator
= wxDefaultValidator
,
136 const wxString
& name
= "wxTreeCtrl")
138 Create(parent
, id
, pos
, size
, style
, validator
, name
);
142 bool Create(wxWindow
*parent
, wxWindowID id
= -1,
143 const wxPoint
& pos
= wxDefaultPosition
,
144 const wxSize
& size
= wxDefaultSize
,
145 long style
= wxTR_HAS_BUTTONS
|wxTR_LINES_AT_ROOT
,
146 const wxValidator
& validator
= wxDefaultValidator
,
147 const wxString
& name
= "wxTreeCtrl");
152 int GetCount() const;
155 int GetIndent() const;
156 void SetIndent(int indent
);
158 wxImageList
*GetImageList(int which
= wxIMAGE_LIST_NORMAL
) const;
159 void SetImageList(wxImageList
*imageList
, int which
= wxIMAGE_LIST_NORMAL
);
161 // navigation inside the tree
162 long GetNextItem(long item
, int code
) const;
163 bool ItemHasChildren(long item
) const;
164 long GetChild(long item
) const;
165 long GetParent(long item
) const;
166 long GetFirstVisibleItem() const;
167 long GetNextVisibleItem(long item
) const;
168 long GetSelection() const;
169 long GetRootItem() const;
171 // generic function for (g|s)etting item attributes
172 bool GetItem(wxTreeItem
& info
) const;
173 bool SetItem(wxTreeItem
& info
);
175 int GetItemState(long item
, long stateMask
) const;
176 bool SetItemState(long item
, long state
, long stateMask
);
178 bool SetItemImage(long item
, int image
, int selImage
);
180 wxString
GetItemText(long item
) const;
181 void SetItemText(long item
, const wxString
& str
);
182 // custom data associated with the item
183 long GetItemData(long item
) const;
184 bool SetItemData(long item
, long data
);
185 // convenience function
186 bool IsItemExpanded(long item
)
188 return (GetItemState(item
, wxTREE_STATE_EXPANDED
) &
189 wxTREE_STATE_EXPANDED
) != 0;
193 bool GetItemRect(long item
, wxRectangle
& rect
, bool textOnly
= FALSE
) const;
195 wxTextCtrl
& GetEditControl() const;
199 // adding/deleting items
200 bool DeleteItem(long item
);
201 long InsertItem(long parent
, wxTreeItem
& info
,
202 long insertAfter
= wxTREE_INSERT_LAST
);
203 // If image > -1 and selImage == -1, the same image is used for
204 // both selected and unselected items.
205 long InsertItem(long parent
, const wxString
& label
,
206 int image
= -1, int selImage
= -1,
207 long insertAfter
= wxTREE_INSERT_LAST
);
209 // changing item state
210 bool ExpandItem(long item
) { return ExpandItem(item
, wxTREE_EXPAND_EXPAND
); }
211 bool CollapseItem(long item
) { return ExpandItem(item
, wxTREE_EXPAND_COLLAPSE
); }
212 bool ToggleItem(long item
) { return ExpandItem(item
, wxTREE_EXPAND_TOGGLE
); }
213 // common interface for {Expand|Collapse|Toggle}Item
214 bool ExpandItem(long item
, int action
);
217 bool SelectItem(long item
);
218 bool ScrollTo(long item
);
219 bool DeleteAllItems();
220 wxTextCtrl
& Edit(long item
);
221 long HitTest(const wxPoint
& point
, int& flags
);
222 // wxImageList *CreateDragImage(long item);
223 bool SortChildren(long item
);
224 bool EnsureVisible(long item
);
227 void Command(wxCommandEvent
& event
) { ProcessCommand(event
); };
228 bool MSWCommand(WXUINT param
, WXWORD id
);
229 bool MSWNotify(WXWPARAM wParam
, WXLPARAM lParam
);
232 wxTextCtrl m_textCtrl
;
233 wxImageList
*m_imageListNormal
;
234 wxImageList
*m_imageListState
;
236 DECLARE_DYNAMIC_CLASS(wxTreeCtrl
)
240 wxEVT_COMMAND_TREE_BEGIN_DRAG,
241 wxEVT_COMMAND_TREE_BEGIN_RDRAG,
242 wxEVT_COMMAND_TREE_BEGIN_LABEL_EDIT,
243 wxEVT_COMMAND_TREE_END_LABEL_EDIT,
244 wxEVT_COMMAND_TREE_DELETE_ITEM,
245 wxEVT_COMMAND_TREE_GET_INFO,
246 wxEVT_COMMAND_TREE_SET_INFO,
247 wxEVT_COMMAND_TREE_ITEM_EXPANDED,
248 wxEVT_COMMAND_TREE_ITEM_EXPANDING,
249 wxEVT_COMMAND_TREE_ITEM_COLLAPSED,
250 wxEVT_COMMAND_TREE_ITEM_COLLAPSING,
251 wxEVT_COMMAND_TREE_SEL_CHANGED,
252 wxEVT_COMMAND_TREE_SEL_CHANGING,
253 wxEVT_COMMAND_TREE_KEY_DOWN
256 class WXDLLEXPORT wxTreeEvent
: public wxCommandEvent
258 DECLARE_DYNAMIC_CLASS(wxTreeEvent
)
261 wxTreeEvent(wxEventType commandType
= wxEVT_NULL
, int id
= 0);
268 inline long GetOldItem() const { return m_oldItem
; }
269 inline wxTreeItem
& GetItem() const { return (wxTreeItem
&) m_item
; }
270 inline wxPoint
GetPoint() const { return m_pointDrag
; }
271 inline int GetCode() const { return m_code
; }
274 typedef void (wxEvtHandler::*wxTreeEventFunction
)(wxTreeEvent
&);
276 #define EVT_TREE_BEGIN_DRAG(id, fn) { wxEVT_COMMAND_TREE_BEGIN_DRAG, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL },
277 #define EVT_TREE_BEGIN_RDRAG(id, fn) { wxEVT_COMMAND_TREE_BEGIN_RDRAG, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL },
278 #define EVT_TREE_BEGIN_LABEL_EDIT(id, fn) { wxEVT_COMMAND_TREE_BEGIN_LABEL_EDIT, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL },
279 #define EVT_TREE_END_LABEL_EDIT(id, fn) { wxEVT_COMMAND_TREE_END_LABEL_EDIT, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL },
280 #define EVT_TREE_DELETE_ITEM(id, fn) { wxEVT_COMMAND_TREE_DELETE_ITEM, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL },
281 #define EVT_TREE_GET_INFO(id, fn) { wxEVT_COMMAND_TREE_GET_INFO, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL },
282 #define EVT_TREE_SET_INFO(id, fn) { wxEVT_COMMAND_TREE_SET_INFO, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL },
283 #define EVT_TREE_ITEM_EXPANDED(id, fn) { wxEVT_COMMAND_TREE_ITEM_EXPANDED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL },
284 #define EVT_TREE_ITEM_EXPANDING(id, fn) { wxEVT_COMMAND_TREE_ITEM_EXPANDING, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL },
285 #define EVT_TREE_ITEM_COLLAPSED(id, fn) { wxEVT_COMMAND_TREE_ITEM_COLLAPSED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL },
286 #define EVT_TREE_ITEM_COLLAPSING(id, fn) { wxEVT_COMMAND_TREE_ITEM_COLLAPSING, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL },
287 #define EVT_TREE_SEL_CHANGED(id, fn) { wxEVT_COMMAND_TREE_SEL_CHANGED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL },
288 #define EVT_TREE_SEL_CHANGING(id, fn) { wxEVT_COMMAND_TREE_SEL_CHANGING, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL },
289 #define EVT_TREE_KEY_DOWN(id, fn) { wxEVT_COMMAND_TREE_KEY_DOWN, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxTreeEventFunction) & fn, NULL },