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