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