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
|
.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2020 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. _wx.Toolbook:
==========================================================================================================================================
|phoenix_title| **wx.Toolbook**
==========================================================================================================================================
:ref:`wx.Toolbook` is a class similar to :ref:`wx.Notebook` but which uses a :ref:`wx.ToolBar` to show the labels instead of the tabs.
There is no documentation for this class yet but its usage is identical to :ref:`wx.Notebook` (except for the features clearly related to tabs only), so please refer to that class documentation for now. You can also use the :ref:`Notebook Sample <notebook sample>` to see :ref:`wx.Toolbook` in action.
One feature of this class not supported by :ref:`wx.BookCtrlBase` is the support for disabling some of the pages, see :meth:`~wx.Toolbook.EnablePage`.
^^
.. _Toolbook-styles:
|styles| Window Styles
================================
This class supports the following styles:
- ``wx.TBK_BUTTONBAR``: Use ButtonToolBar-based implementation under macOS (ignored under other platforms).
- ``wx.TBK_HORZ_LAYOUT``: Shows the text and the icons alongside, not vertically stacked (only implement under Windows and GTK 2 platforms as it relies on ``TB_HORZ_LAYOUT`` flag support). ^^
The common BookCtrl styles described in the
:ref:`BookCtrl Overview <bookctrl overview>` are also supported.
^^
.. _Toolbook-events:
|events| Events Emitted by this Class
=====================================
Handlers bound for the following event types will receive a :ref:`wx.BookCtrlEvent` parameter.
- EVT_TOOLBOOK_PAGE_CHANGED: The page selection was changed. Processes a ``wxEVT_TOOLBOOK_PAGE_CHANGED`` event.
- EVT_TOOLBOOK_PAGE_CHANGING: The page selection is about to be changed. Processes a ``wxEVT_TOOLBOOK_PAGE_CHANGING`` event. This event can be vetoed (using :meth:`wx.NotifyEvent.Veto` ). ^^
.. seealso:: :ref:`BookCtrl Overview <bookctrl overview>`, :ref:`wx.BookCtrlBase`, :ref:`wx.Notebook`, :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>Toolbook</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.Toolbook_inheritance.png" alt="Inheritance diagram of Toolbook" usemap="#dummy" class="inheritance"/></center>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.Toolbook.html" title="wx.Toolbook" alt="" coords="123,392,225,421"/> <area shape="rect" id="node2" href="wx.BookCtrlBase.html" title="wx.BookCtrlBase" alt="" coords="107,315,241,344"/> <area shape="rect" id="node3" href="wx.Control.html" title="wx.Control" alt="" coords="63,237,155,267"/> <area shape="rect" id="node4" href="wx.WithImages.html" title="wx.WithImages" alt="" coords="179,237,302,267"/> <area shape="rect" id="node5" href="wx.Window.html" title="wx.Window" alt="" coords="60,160,157,189"/> <area shape="rect" id="node6" href="wx.EvtHandler.html" title="wx.EvtHandler" alt="" coords="50,83,167,112"/> <area shape="rect" id="node7" href="wx.Object.html" title="wx.Object" alt="" coords="5,5,92,35"/> <area shape="rect" id="node8" href="wx.Trackable.html" title="wx.Trackable" alt="" coords="117,5,223,35"/> </map>
</p>
</div>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.Toolbook.__init__` Constructs a choicebook control.
:meth:`~wx.Toolbook.Create` Create the tool book control that has already been constructed with the default constructor.
:meth:`~wx.Toolbook.EnablePage` Enables or disables the specified page.
:meth:`~wx.Toolbook.GetClassDefaultAttributes`
:meth:`~wx.Toolbook.GetToolBar` Return the toolbar used for page selection.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.Toolbook.ToolBar` See :meth:`~wx.Toolbook.GetToolBar`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.Toolbook(BookCtrlBase)
**Possible constructors**::
Toolbook()
Toolbook(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize,
style=0, name=EmptyString)
Toolbook is a class similar to Notebook but which uses a ToolBar
to show the labels instead of the tabs.
.. method:: __init__(self, *args, **kw)
Constructs a choicebook control.
|overload| Overloaded Implementations:
:html:`<hr class="overloadsep" /><br />`
**__init__** `(self)`
:html:`<hr class="overloadsep" /><br />`
**__init__** `(self, parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=0, name=EmptyString)`
: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
:html:`<hr class="overloadsep" /><br />`
.. method:: Create(self, parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=0, name=EmptyString)
Create the tool book control that has already been constructed with the default constructor.
: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:: EnablePage(self, *args, **kw)
|overload| Overloaded Implementations:
:html:`<hr class="overloadsep" /><br />`
**EnablePage** `(self, page, enable)`
Enables or disables the specified page.
Using this function, a page can be disabled when it can't be used, while still remaining present to let the users know that more functionality is available, even if currently inaccessible.
Icons for disabled pages are created by :meth:`wx.Bitmap.ConvertToDisabled` .
:param `page`: The index of the page.
:type `page`: int
:param `enable`: ``True`` to enable the page and ``False`` to disable it.
:type `enable`: bool
:rtype: `bool`
:returns:
``True`` if successful, ``False`` otherwise (currently only if the index is invalid).
.. versionadded:: 4.1/wxWidgets-3.1.2
:html:`<hr class="overloadsep" /><br />`
**EnablePage** `(self, page, enable)`
Enables or disables the specified page.
This is similar to the overload above, but finds the index of the specified page.
:param `page`: Pointer of a page windows inside the book control.
:type `page`: wx.Window
:param `enable`: ``True`` to enable the page and ``False`` to disable it.
:type `enable`: bool
:rtype: `bool`
:returns:
``True`` if successful, ``False`` otherwise, e.g. if `page` is not one of the pages of this control.
.. versionadded:: 4.1/wxWidgets-3.1.2
:html:`<hr class="overloadsep" /><br />`
.. staticmethod:: GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL)
:param `variant`:
:type `variant`: wx.WindowVariant
:rtype: :ref:`wx.VisualAttributes`
.. method:: GetToolBar(self)
Return the toolbar used for page selection.
:rtype: :ref:`wx.ToolBar`
.. attribute:: ToolBar
See :meth:`~wx.Toolbook.GetToolBar`
|
