1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
|
.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2018 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. _wx.Treebook:
==========================================================================================================================================
|phoenix_title| **wx.Treebook**
==========================================================================================================================================
This class is an extension of the :ref:`wx.Notebook` class that allows a tree structured set of pages to be shown in a control.
A classic example is a netscape preferences dialog that shows a tree of preference sections on the left and select section page on the right.
To use the class simply create it and populate with pages using :meth:`~wx.Treebook.InsertPage`, :meth:`~wx.Treebook.InsertSubPage`, :meth:`~wx.Treebook.AddPage`, :meth:`~wx.Treebook.AddSubPage`.
If your tree is no more than 1 level in depth then you could simply use :meth:`~wx.Treebook.AddPage` and :meth:`~wx.Treebook.AddSubPage` to sequentially populate your tree by adding at every step a page or a subpage to the end of the tree.
.. _Treebook-events:
|events| Events Emitted by this Class
=====================================
Handlers bound for the following event types will receive a :ref:`wx.BookCtrlEvent` parameter.
- EVT_TREEBOOK_PAGE_CHANGED: The page selection was changed. Processes a ``wxEVT_TREEBOOK_PAGE_CHANGED`` event.
- EVT_TREEBOOK_PAGE_CHANGING: The page selection is about to be changed. Processes a ``wxEVT_TREEBOOK_PAGE_CHANGING`` event. This event can be :meth:`~wx.Treebook.vetoed`.
- EVT_TREEBOOK_NODE_COLLAPSED: The page node is going to be collapsed. Processes a ``wxEVT_TREEBOOK_NODE_COLLAPSED`` event.
- EVT_TREEBOOK_NODE_EXPANDED: The page node is going to be expanded. Processes a ``wxEVT_TREEBOOK_NODE_EXPANDED`` event.
.. seealso:: :ref:`wx.BookCtrl`, :ref:`wx.BookCtrlEvent`, :ref:`wx.Notebook`, :ref:`wx.TreeCtrl`, :ref:`wx.ImageList`, :ref:`BookCtrl Overview <bookctrl overview>`, :ref:`Notebook Sample <notebook sample>`
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html
<div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
<img id="toggleBlock-trigger" src="_static/images/closed.png"/>
Inheritance diagram for class <strong>Treebook</strong>:
</div>
<div id="toggleBlock-summary" style="display:block;"></div>
<div id="toggleBlock-content" style="display:none;">
<p class="graphviz">
<center><img src="_static/images/inheritance/wx.Treebook_inheritance.png" alt="Inheritance diagram of Treebook" usemap="#dummy" class="inheritance"/></center>
</div>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.Control.html" title="wx.Control" alt="" coords="145,237,233,267"/> <area shape="rect" id="node5" href="wx.BookCtrlBase.html" title="wx.BookCtrlBase" alt="" coords="61,315,189,344"/> <area shape="rect" id="node2" href="wx.Window.html" title="wx.Window" alt="" coords="145,160,233,189"/> <area shape="rect" id="node3" href="wx.Object.html" title="wx.Object" alt="" coords="91,5,172,35"/> <area shape="rect" id="node4" href="wx.EvtHandler.html" title="wx.EvtHandler" alt="" coords="133,83,244,112"/> <area shape="rect" id="node8" href="wx.Treebook.html" title="wx.Treebook" alt="" coords="76,392,175,421"/> <area shape="rect" id="node6" href="wx.WithImages.html" title="wx.WithImages" alt="" coords="5,237,120,267"/> <area shape="rect" id="node7" href="wx.Trackable.html" title="wx.Trackable" alt="" coords="197,5,299,35"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.Treebook.__init__` Default constructor.
:meth:`~wx.Treebook.AddPage` Adds a new page.
:meth:`~wx.Treebook.AddSubPage` Adds a new child-page to the last top-level page.
:meth:`~wx.Treebook.CollapseNode` Shortcut for :meth:`~Treebook.ExpandNode` ( `pageId`, ``False`` ).
:meth:`~wx.Treebook.Create` Creates a treebook control.
:meth:`~wx.Treebook.DeletePage` Deletes the page at the specified position and all its children.
:meth:`~wx.Treebook.ExpandNode` Expands (collapses) the `pageId` node.
:meth:`~wx.Treebook.GetPageParent` Returns the parent page of the given one or ``NOT_FOUND`` if this is a top-level page.
:meth:`~wx.Treebook.GetSelection` Returns the currently selected page, or ``NOT_FOUND`` if none was selected.
:meth:`~wx.Treebook.GetTreeCtrl` Returns the tree control used for selecting pages.
:meth:`~wx.Treebook.InsertPage` Inserts a new page just before the page indicated by `pagePos`.
:meth:`~wx.Treebook.InsertSubPage` Inserts a sub page under the specified page.
:meth:`~wx.Treebook.IsNodeExpanded` Returns ``True`` if the page represented by `pageId` is expanded.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.Treebook.Selection` See :meth:`~wx.Treebook.GetSelection`
:attr:`~wx.Treebook.TreeCtrl` See :meth:`~wx.Treebook.GetTreeCtrl`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.Treebook(BookCtrlBase)
**Possible constructors**::
Treebook()
Treebook(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize,
style=BK_DEFAULT, name=EmptyString)
This class is an extension of the Notebook class that allows a tree
structured set of pages to be shown in a control.
.. method:: __init__(self, *args, **kw)
|overload| Overloaded Implementations:
**~~~**
**__init__** `(self)`
Default constructor.
**~~~**
**__init__** `(self, parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=BK_DEFAULT, name=EmptyString)`
Creates an empty :ref:`wx.Treebook`.
:param `parent`: The parent window. Must be non-NULL.
:type `parent`: wx.Window
:param `id`: The window identifier.
:type `id`: wx.WindowID
:param `pos`: The window position.
:type `pos`: wx.Point
:param `size`: The window size.
:type `size`: wx.Size
:param `style`: The window style. See :ref:`wx.Notebook`.
:type `style`: long
:param `name`: The name of the control (used only under Motif).
:type `name`: string
**~~~**
.. method:: AddPage(self, page, text, bSelect=False, imageId=NOT_FOUND)
Adds a new page.
The page is placed at the topmost level after all other pages. ``None`` could be specified for page to create an empty page.
:param `page`:
:type `page`: wx.Window
:param `text`:
:type `text`: string
:param `bSelect`:
:type `bSelect`: bool
:param `imageId`:
:type `imageId`: int
:rtype: `bool`
.. method:: AddSubPage(self, page, text, bSelect=False, imageId=NOT_FOUND)
Adds a new child-page to the last top-level page.
``None`` could be specified for page to create an empty page.
:param `page`:
:type `page`: wx.Window
:param `text`:
:type `text`: string
:param `bSelect`:
:type `bSelect`: bool
:param `imageId`:
:type `imageId`: int
:rtype: `bool`
.. method:: CollapseNode(self, pageId)
Shortcut for :meth:`ExpandNode` ( `pageId`, ``False`` ).
:param `pageId`:
:type `pageId`: int
:rtype: `bool`
.. method:: Create(self, parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=BK_DEFAULT, name=EmptyString)
Creates a treebook control.
See :meth:`Treebook.__init__` for the description of the parameters.
:param `parent`:
:type `parent`: wx.Window
:param `id`:
:type `id`: wx.WindowID
:param `pos`:
:type `pos`: wx.Point
:param `size`:
:type `size`: wx.Size
:param `style`:
:type `style`: long
:param `name`:
:type `name`: string
:rtype: `bool`
.. method:: DeletePage(self, pagePos)
Deletes the page at the specified position and all its children.
Could trigger page selection change in a case when selected page is removed. In that case its parent is selected (or the next page if no parent).
:param `pagePos`:
:type `pagePos`: int
:rtype: `bool`
.. method:: ExpandNode(self, pageId, expand=True)
Expands (collapses) the `pageId` node.
Returns the previous state. May generate page changing events (if selected page is under the collapsed branch, then its parent is autoselected).
:param `pageId`:
:type `pageId`: int
:param `expand`:
:type `expand`: bool
:rtype: `bool`
.. method:: GetPageParent(self, page)
Returns the parent page of the given one or ``NOT_FOUND`` if this is a top-level page.
:param `page`:
:type `page`: int
:rtype: `int`
.. method:: GetSelection(self)
Returns the currently selected page, or ``NOT_FOUND`` if none was selected.
:rtype: `int`
.. note::
This method may return either the previously or newly selected page when called from the EVT_TREEBOOK_PAGE_CHANGED() handler depending on the platform and so :meth:`wx.BookCtrlEvent.GetSelection` should be used instead in this case.
.. method:: GetTreeCtrl(self)
Returns the tree control used for selecting pages.
:rtype: :ref:`wx.TreeCtrl`
.. method:: InsertPage(self, pagePos, page, text, bSelect=False, imageId=NOT_FOUND)
Inserts a new page just before the page indicated by `pagePos`.
The new page is placed before `pagePos` page and on the same level. ``None`` could be specified for page to create an empty page.
:param `pagePos`:
:type `pagePos`: int
:param `page`:
:type `page`: wx.Window
:param `text`:
:type `text`: string
:param `bSelect`:
:type `bSelect`: bool
:param `imageId`:
:type `imageId`: int
:rtype: `bool`
.. method:: InsertSubPage(self, pagePos, page, text, bSelect=False, imageId=NOT_FOUND)
Inserts a sub page under the specified page.
``None`` could be specified for page to create an empty page.
:param `pagePos`:
:type `pagePos`: int
:param `page`:
:type `page`: wx.Window
:param `text`:
:type `text`: string
:param `bSelect`:
:type `bSelect`: bool
:param `imageId`:
:type `imageId`: int
:rtype: `bool`
.. method:: IsNodeExpanded(self, pageId)
Returns ``True`` if the page represented by `pageId` is expanded.
:param `pageId`:
:type `pageId`: int
:rtype: `bool`
.. attribute:: Selection
See :meth:`~wx.Treebook.GetSelection`
.. attribute:: TreeCtrl
See :meth:`~wx.Treebook.GetTreeCtrl`
|
