]> git.saurik.com Git - wxWidgets.git/blob - include/wx/treebook.h
set eol-style
[wxWidgets.git] / include / wx / treebook.h
1 ///////////////////////////////////////////////////////////////////////////////
2 // Name: wx/treebook.h
3 // Purpose: wxTreebook: wxNotebook-like control presenting pages in a tree
4 // Author: Evgeniy Tarassov, Vadim Zeitlin
5 // Modified by:
6 // Created: 2005-09-15
7 // RCS-ID: $Id$
8 // Copyright: (c) 2005 Vadim Zeitlin <vadim@wxwidgets.org>
9 // Licence: wxWindows licence
10 ///////////////////////////////////////////////////////////////////////////////
11
12 #ifndef _WX_TREEBOOK_H_
13 #define _WX_TREEBOOK_H_
14
15 #include "wx/defs.h"
16
17 #if wxUSE_TREEBOOK
18
19 #include "wx/bookctrl.h"
20 #include "wx/treectrl.h" // for wxArrayTreeItemIds
21
22 typedef wxWindow wxTreebookPage;
23
24 class WXDLLIMPEXP_FWD_CORE wxTreeEvent;
25
26 // ----------------------------------------------------------------------------
27 // wxTreebook
28 // ----------------------------------------------------------------------------
29
30 class WXDLLEXPORT wxTreebook : public wxBookCtrlBase
31 {
32 public:
33 // Constructors and such
34 // ---------------------
35
36 // Default ctor doesn't create the control, use Create() afterwards
37 wxTreebook()
38 {
39 Init();
40 }
41
42 // This ctor creates the tree book control
43 wxTreebook(wxWindow *parent,
44 wxWindowID id,
45 const wxPoint& pos = wxDefaultPosition,
46 const wxSize& size = wxDefaultSize,
47 long style = wxBK_DEFAULT,
48 const wxString& name = wxEmptyString)
49 {
50 Init();
51
52 (void)Create(parent, id, pos, size, style, name);
53 }
54
55 // Really creates the control
56 bool Create(wxWindow *parent,
57 wxWindowID id,
58 const wxPoint& pos = wxDefaultPosition,
59 const wxSize& size = wxDefaultSize,
60 long style = wxBK_DEFAULT,
61 const wxString& name = wxEmptyString);
62
63
64 // Page insertion operations
65 // -------------------------
66
67 // Notice that page pointer may be NULL in which case the next non NULL
68 // page (usually the first child page of a node) is shown when this page is
69 // selected
70
71 // Inserts a new page just before the page indicated by page.
72 // The new page is placed on the same level as page.
73 virtual bool InsertPage(size_t pos,
74 wxWindow *page,
75 const wxString& text,
76 bool bSelect = false,
77 int imageId = wxNOT_FOUND);
78
79 // Inserts a new sub-page to the end of children of the page at given pos.
80 virtual bool InsertSubPage(size_t pos,
81 wxWindow *page,
82 const wxString& text,
83 bool bSelect = false,
84 int imageId = wxNOT_FOUND);
85
86 // Adds a new page at top level after all other pages.
87 virtual bool AddPage(wxWindow *page,
88 const wxString& text,
89 bool bSelect = false,
90 int imageId = wxNOT_FOUND);
91
92 // Adds a new child-page to the last top-level page inserted.
93 // Useful when constructing 1 level tree structure.
94 virtual bool AddSubPage(wxWindow *page,
95 const wxString& text,
96 bool bSelect = false,
97 int imageId = wxNOT_FOUND);
98
99 // Deletes the page and ALL its children. Could trigger page selection
100 // change in a case when selected page is removed. In that case its parent
101 // is selected (or the next page if no parent).
102 virtual bool DeletePage(size_t pos);
103
104
105 // Tree operations
106 // ---------------
107
108 // Gets the page node state -- node is expanded or collapsed
109 virtual bool IsNodeExpanded(size_t pos) const;
110
111 // Expands or collapses the page node. Returns the previous state.
112 // May generate page changing events (if selected page
113 // is under the collapsed branch, then parent is autoselected).
114 virtual bool ExpandNode(size_t pos, bool expand = true);
115
116 // shortcut for ExpandNode(pos, false)
117 bool CollapseNode(size_t pos) { return ExpandNode(pos, false); }
118
119 // get the parent page or wxNOT_FOUND if this is a top level page
120 int GetPageParent(size_t pos) const;
121
122 // the tree control we use for showing the pages index tree
123 wxTreeCtrl* GetTreeCtrl() const { return (wxTreeCtrl*)m_bookctrl; }
124
125
126 // Standard operations inherited from wxBookCtrlBase
127 // -------------------------------------------------
128
129 virtual int GetSelection() const;
130 virtual bool SetPageText(size_t n, const wxString& strText);
131 virtual wxString GetPageText(size_t n) const;
132 virtual int GetPageImage(size_t n) const;
133 virtual bool SetPageImage(size_t n, int imageId);
134 virtual wxSize CalcSizeFromPage(const wxSize& sizePage) const;
135 virtual int SetSelection(size_t n) { return DoSetSelection(n, SetSelection_SendEvent); }
136 virtual int ChangeSelection(size_t n) { return DoSetSelection(n); }
137 virtual int HitTest(const wxPoint& pt, long *flags = NULL) const;
138 virtual void SetImageList(wxImageList *imageList);
139 virtual void AssignImageList(wxImageList *imageList);
140 virtual bool DeleteAllPages();
141
142 protected:
143 // Implementation of a page removal. See DeletPage for comments.
144 wxTreebookPage *DoRemovePage(size_t pos);
145
146 // This subclass of wxBookCtrlBase accepts NULL page pointers (empty pages)
147 virtual bool AllowNullPage() const { return true; }
148
149 // event handlers
150 void OnTreeSelectionChange(wxTreeEvent& event);
151 void OnTreeNodeExpandedCollapsed(wxTreeEvent& event);
152
153 // array of page ids and page windows
154 wxArrayTreeItemIds m_treeIds;
155
156 // the currently selected page or wxNOT_FOUND if none
157 int m_selection;
158
159 // in the situation when m_selection page is not wxNOT_FOUND but page is
160 // NULL this is the first (sub)child that has a non-NULL page
161 int m_actualSelection;
162
163 private:
164 // common part of all constructors
165 void Init();
166
167 // The real implementations of page insertion functions
168 // ------------------------------------------------------
169 // All DoInsert/Add(Sub)Page functions add the page into :
170 // - the base class
171 // - the tree control
172 // - update the index/TreeItemId corespondance array
173 bool DoInsertPage(size_t pos,
174 wxWindow *page,
175 const wxString& text,
176 bool bSelect = false,
177 int imageId = wxNOT_FOUND);
178 bool DoInsertSubPage(size_t pos,
179 wxWindow *page,
180 const wxString& text,
181 bool bSelect = false,
182 int imageId = wxNOT_FOUND);
183 bool DoAddSubPage(wxWindow *page,
184 const wxString& text,
185 bool bSelect = false,
186 int imageId = wxNOT_FOUND);
187
188 // Sets selection in the tree control and updates the page being shown.
189 int DoSetSelection(size_t pos, int flags = 0);
190
191 // Returns currently shown page. In a case when selected the node
192 // has empty (NULL) page finds first (sub)child with not-empty page.
193 wxTreebookPage *DoGetCurrentPage() const;
194
195 // Does the selection update. Called from page insertion functions
196 // to update selection if the selected page was pushed by the newly inserted
197 void DoUpdateSelection(bool bSelect, int page);
198
199
200 // Operations on the internal private members of the class
201 // -------------------------------------------------------
202 // Returns the page TreeItemId for the page.
203 // Or, if the page index is incorrect, a fake one (fakePage.IsOk() == false)
204 wxTreeItemId DoInternalGetPage(size_t pos) const;
205
206 // Linear search for a page with the id specified. If no page
207 // found wxNOT_FOUND is returned. The function is used when we catch an event
208 // from m_tree (wxTreeCtrl) component.
209 int DoInternalFindPageById(wxTreeItemId page) const;
210
211 // Updates page and wxTreeItemId correspondance.
212 void DoInternalAddPage(size_t newPos, wxWindow *page, wxTreeItemId pageId);
213
214 // Removes the page from internal structure.
215 void DoInternalRemovePage(size_t pos)
216 { DoInternalRemovePageRange(pos, 0); }
217
218 // Removes the page and all its children designated by subCount
219 // from internal structures of the control.
220 void DoInternalRemovePageRange(size_t pos, size_t subCount);
221
222 // Returns internal number of pages which can be different from
223 // GetPageCount() while performing a page insertion or removal.
224 size_t DoInternalGetPageCount() const { return m_treeIds.GetCount(); }
225
226
227 DECLARE_EVENT_TABLE()
228 DECLARE_DYNAMIC_CLASS_NO_COPY(wxTreebook)
229 };
230
231
232 // ----------------------------------------------------------------------------
233 // treebook event class and related stuff
234 // ----------------------------------------------------------------------------
235
236 class WXDLLEXPORT wxTreebookEvent : public wxBookCtrlBaseEvent
237 {
238 public:
239 wxTreebookEvent(wxEventType commandType = wxEVT_NULL, int id = 0,
240 int nSel = wxNOT_FOUND, int nOldSel = wxNOT_FOUND)
241 : wxBookCtrlBaseEvent(commandType, id, nSel, nOldSel)
242 {
243 }
244
245 wxTreebookEvent(const wxTreebookEvent& event)
246 : wxBookCtrlBaseEvent(event)
247 {
248 }
249
250 virtual wxEvent *Clone() const { return new wxTreebookEvent(*this); }
251
252 private:
253 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxTreebookEvent)
254 };
255
256 extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_TREEBOOK_PAGE_CHANGED;
257 extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_TREEBOOK_PAGE_CHANGING;
258 extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_TREEBOOK_NODE_COLLAPSED;
259 extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_TREEBOOK_NODE_EXPANDED;
260
261 typedef void (wxEvtHandler::*wxTreebookEventFunction)(wxTreebookEvent&);
262
263 #define wxTreebookEventHandler(func) \
264 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxTreebookEventFunction, &func)
265
266 #define EVT_TREEBOOK_PAGE_CHANGED(winid, fn) \
267 wx__DECLARE_EVT1(wxEVT_COMMAND_TREEBOOK_PAGE_CHANGED, winid, wxTreebookEventHandler(fn))
268
269 #define EVT_TREEBOOK_PAGE_CHANGING(winid, fn) \
270 wx__DECLARE_EVT1(wxEVT_COMMAND_TREEBOOK_PAGE_CHANGING, winid, wxTreebookEventHandler(fn))
271
272 #define EVT_TREEBOOK_NODE_COLLAPSED(winid, fn) \
273 wx__DECLARE_EVT1(wxEVT_COMMAND_TREEBOOK_NODE_COLLAPSED, winid, wxTreebookEventHandler(fn))
274
275 #define EVT_TREEBOOK_NODE_EXPANDED(winid, fn) \
276 wx__DECLARE_EVT1(wxEVT_COMMAND_TREEBOOK_NODE_EXPANDED, winid, wxTreebookEventHandler(fn))
277
278
279 #endif // wxUSE_TREEBOOK
280
281 #endif // _WX_TREEBOOK_H_