1 ///////////////////////////////////////////////////////////////////////////////
3 // Purpose: wxTreebook: wxNotebook-like control presenting pages in a tree
4 // Author: Evgeniy Tarassov, Vadim Zeitlin
8 // Copyright: (c) 2005 Vadim Zeitlin <vadim@wxwidgets.org>
9 // Licence: wxWindows licence
10 ///////////////////////////////////////////////////////////////////////////////
12 #ifndef _WX_TREEBOOK_H_
13 #define _WX_TREEBOOK_H_
19 #include "wx/bookctrl.h"
20 #include "wx/treectrl.h" // for wxArrayTreeItemIds
21 #include "wx/containr.h"
23 typedef wxWindow wxTreebookPage
;
25 class WXDLLEXPORT wxTreeEvent
;
27 // ----------------------------------------------------------------------------
29 // ----------------------------------------------------------------------------
31 class WXDLLEXPORT wxTreebook
: public wxBookCtrlBase
34 // Constructors and such
35 // ---------------------
37 // Default ctor doesn't create the control, use Create() afterwards
43 // This ctor creates the tree book control
44 wxTreebook(wxWindow
*parent
,
46 const wxPoint
& pos
= wxDefaultPosition
,
47 const wxSize
& size
= wxDefaultSize
,
48 long style
= wxBK_DEFAULT
,
49 const wxString
& name
= wxEmptyString
)
53 (void)Create(parent
, id
, pos
, size
, style
, name
);
56 // Really creates the control
57 bool Create(wxWindow
*parent
,
59 const wxPoint
& pos
= wxDefaultPosition
,
60 const wxSize
& size
= wxDefaultSize
,
61 long style
= wxBK_DEFAULT
,
62 const wxString
& name
= wxEmptyString
);
65 // Page insertion operations
66 // -------------------------
68 // Notice that page pointer may be NULL in which case the next non NULL
69 // page (usually the first child page of a node) is shown when this page is
72 // Inserts a new page just before the page indicated by page.
73 // The new page is placed on the same level as page.
74 virtual bool InsertPage(size_t pos
,
78 int imageId
= wxNOT_FOUND
);
80 // Inserts a new sub-page to the end of children of the page at given pos.
81 virtual bool InsertSubPage(size_t pos
,
85 int imageId
= wxNOT_FOUND
);
87 // Adds a new page at top level after all other pages.
88 virtual bool AddPage(wxWindow
*page
,
91 int imageId
= wxNOT_FOUND
);
93 // Adds a new child-page to the last top-level page inserted.
94 // Useful when constructing 1 level tree structure.
95 virtual bool AddSubPage(wxWindow
*page
,
98 int imageId
= wxNOT_FOUND
);
100 // Deletes the page and ALL its children. Could trigger page selection
101 // change in a case when selected page is removed. In that case its parent
102 // is selected (or the next page if no parent).
103 virtual bool DeletePage(size_t pos
);
109 // Gets the page node state -- node is expanded or collapsed
110 virtual bool IsNodeExpanded(size_t pos
) const;
112 // Expands or collapses the page node. Returns the previous state.
113 // May generate page changing events (if selected page
114 // is under the collapsed branch, then parent is autoselected).
115 virtual bool ExpandNode(size_t pos
, bool expand
= true);
117 // shortcut for ExpandNode(pos, false)
118 bool CollapseNode(size_t pos
) { return ExpandNode(pos
, false); }
120 // get the parent page or wxNOT_FOUND if this is a top level page
121 int GetPageParent(size_t pos
) const;
123 // the tree control we use for showing the pages index tree
124 wxTreeCtrl
* GetTreeCtrl() const { return (wxTreeCtrl
*)m_bookctrl
; }
127 // Standard operations inherited from wxBookCtrlBase
128 // -------------------------------------------------
130 virtual int GetSelection() const;
131 virtual bool SetPageText(size_t n
, const wxString
& strText
);
132 virtual wxString
GetPageText(size_t n
) const;
133 virtual int GetPageImage(size_t n
) const;
134 virtual bool SetPageImage(size_t n
, int imageId
);
135 virtual wxSize
CalcSizeFromPage(const wxSize
& sizePage
) const;
136 virtual int SetSelection(size_t n
) { return DoSetSelection(n
, SetSelection_SendEvent
); }
137 virtual int ChangeSelection(size_t n
) { return DoSetSelection(n
); }
138 virtual int HitTest(const wxPoint
& pt
, long *flags
= NULL
) const;
139 virtual void SetImageList(wxImageList
*imageList
);
140 virtual void AssignImageList(wxImageList
*imageList
);
141 virtual bool DeleteAllPages();
144 // Implementation of a page removal. See DeletPage for comments.
145 wxTreebookPage
*DoRemovePage(size_t pos
);
147 // This subclass of wxBookCtrlBase accepts NULL page pointers (empty pages)
148 virtual bool AllowNullPage() const { return true; }
151 void OnTreeSelectionChange(wxTreeEvent
& event
);
152 void OnTreeNodeExpandedCollapsed(wxTreeEvent
& event
);
154 // array of page ids and page windows
155 wxArrayTreeItemIds m_treeIds
;
157 // the currently selected page or wxNOT_FOUND if none
160 // in the situation when m_selection page is not wxNOT_FOUND but page is
161 // NULL this is the first (sub)child that has a non-NULL page
162 int m_actualSelection
;
165 // common part of all constructors
168 // The real implementations of page insertion functions
169 // ------------------------------------------------------
170 // All DoInsert/Add(Sub)Page functions add the page into :
172 // - the tree control
173 // - update the index/TreeItemId corespondance array
174 bool DoInsertPage(size_t pos
,
176 const wxString
& text
,
177 bool bSelect
= false,
178 int imageId
= wxNOT_FOUND
);
179 bool DoInsertSubPage(size_t pos
,
181 const wxString
& text
,
182 bool bSelect
= false,
183 int imageId
= wxNOT_FOUND
);
184 bool DoAddSubPage(wxWindow
*page
,
185 const wxString
& text
,
186 bool bSelect
= false,
187 int imageId
= wxNOT_FOUND
);
189 // Sets selection in the tree control and updates the page being shown.
190 int DoSetSelection(size_t pos
, int flags
= 0);
192 // Returns currently shown page. In a case when selected the node
193 // has empty (NULL) page finds first (sub)child with not-empty page.
194 wxTreebookPage
*DoGetCurrentPage() const;
196 // Does the selection update. Called from page insertion functions
197 // to update selection if the selected page was pushed by the newly inserted
198 void DoUpdateSelection(bool bSelect
, int page
);
201 // Operations on the internal private members of the class
202 // -------------------------------------------------------
203 // Returns the page TreeItemId for the page.
204 // Or, if the page index is incorrect, a fake one (fakePage.IsOk() == false)
205 wxTreeItemId
DoInternalGetPage(size_t pos
) const;
207 // Linear search for a page with the id specified. If no page
208 // found wxNOT_FOUND is returned. The function is used when we catch an event
209 // from m_tree (wxTreeCtrl) component.
210 int DoInternalFindPageById(wxTreeItemId page
) const;
212 // Updates page and wxTreeItemId correspondance.
213 void DoInternalAddPage(size_t newPos
, wxWindow
*page
, wxTreeItemId pageId
);
215 // Removes the page from internal structure.
216 void DoInternalRemovePage(size_t pos
)
217 { DoInternalRemovePageRange(pos
, 0); }
219 // Removes the page and all its children designated by subCount
220 // from internal structures of the control.
221 void DoInternalRemovePageRange(size_t pos
, size_t subCount
);
223 // Returns internal number of pages which can be different from
224 // GetPageCount() while performing a page insertion or removal.
225 size_t DoInternalGetPageCount() const { return m_treeIds
.Count(); }
228 DECLARE_EVENT_TABLE()
229 DECLARE_DYNAMIC_CLASS_NO_COPY(wxTreebook
)
230 WX_DECLARE_CONTROL_CONTAINER();
234 // ----------------------------------------------------------------------------
235 // treebook event class and related stuff
236 // ----------------------------------------------------------------------------
238 class WXDLLEXPORT wxTreebookEvent
: public wxBookCtrlBaseEvent
241 wxTreebookEvent(wxEventType commandType
= wxEVT_NULL
, int id
= 0,
242 int nSel
= wxNOT_FOUND
, int nOldSel
= wxNOT_FOUND
)
243 : wxBookCtrlBaseEvent(commandType
, id
, nSel
, nOldSel
)
247 wxTreebookEvent(const wxTreebookEvent
& event
)
248 : wxBookCtrlBaseEvent(event
)
252 virtual wxEvent
*Clone() const { return new wxTreebookEvent(*this); }
255 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxTreebookEvent
)
258 extern WXDLLIMPEXP_CORE
const wxEventType wxEVT_COMMAND_TREEBOOK_PAGE_CHANGED
;
259 extern WXDLLIMPEXP_CORE
const wxEventType wxEVT_COMMAND_TREEBOOK_PAGE_CHANGING
;
260 extern WXDLLIMPEXP_CORE
const wxEventType wxEVT_COMMAND_TREEBOOK_NODE_COLLAPSED
;
261 extern WXDLLIMPEXP_CORE
const wxEventType wxEVT_COMMAND_TREEBOOK_NODE_EXPANDED
;
263 typedef void (wxEvtHandler::*wxTreebookEventFunction
)(wxTreebookEvent
&);
265 #define wxTreebookEventHandler(func) \
266 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxTreebookEventFunction, &func)
268 #define EVT_TREEBOOK_PAGE_CHANGED(winid, fn) \
269 wx__DECLARE_EVT1(wxEVT_COMMAND_TREEBOOK_PAGE_CHANGED, winid, wxTreebookEventHandler(fn))
271 #define EVT_TREEBOOK_PAGE_CHANGING(winid, fn) \
272 wx__DECLARE_EVT1(wxEVT_COMMAND_TREEBOOK_PAGE_CHANGING, winid, wxTreebookEventHandler(fn))
274 #define EVT_TREEBOOK_NODE_COLLAPSED(winid, fn) \
275 wx__DECLARE_EVT1(wxEVT_COMMAND_TREEBOOK_NODE_COLLAPSED, winid, wxTreebookEventHandler(fn))
277 #define EVT_TREEBOOK_NODE_EXPANDED(winid, fn) \
278 wx__DECLARE_EVT1(wxEVT_COMMAND_TREEBOOK_NODE_EXPANDED, winid, wxTreebookEventHandler(fn))
281 #endif // wxUSE_TREEBOOK
283 #endif // _WX_TREEBOOK_H_