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
|
.. 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.Listbook:
==========================================================================================================================================
|phoenix_title| **wx.Listbook**
==========================================================================================================================================
:ref:`wx.Listbook` is a class similar to :ref:`wx.Notebook` but which uses a :ref:`wx.ListCtrl` to show the labels instead of the tabs.
The underlying :ref:`wx.ListCtrl` displays page labels in a one-column report view by default. Calling `BookCtrl.SetImageList` will implicitly switch the control to use an icon view.
For usage documentation of this class, please refer to the base abstract class BookCtrl. You can also use the :ref:`Notebook Sample <notebook sample>` to see :ref:`wx.Listbook` in action.
.. _Listbook-styles:
|styles| Window Styles
================================
This class supports the following styles:
- ``wx.LB_DEFAULT``: Choose the default location for the labels depending on the current platform (left everywhere except Mac where it is top).
- ``wx.LB_TOP``: Place labels above the page area.
- ``wx.LB_LEFT``: Place labels on the left side.
- ``wx.LB_RIGHT``: Place labels on the right side.
- ``wx.LB_BOTTOM``: Place labels below the page area.
.. _Listbook-events:
|events| Events Emitted by this Class
=====================================
Handlers bound for the following event types will receive a :ref:`wx.BookCtrlEvent` parameter.
- EVT_LISTBOOK_PAGE_CHANGED: The page selection was changed. Processes a ``wxEVT_LISTBOOK_PAGE_CHANGED`` event.
- EVT_LISTBOOK_PAGE_CHANGING: The page selection is about to be changed. Processes a ``wxEVT_LISTBOOK_PAGE_CHANGING`` event. This event can be vetoed.
.. seealso:: :ref:`wx.BookCtrl`, :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>Listbook</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.Listbook_inheritance.png" alt="Inheritance diagram of Listbook" 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="node4" 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.Listbook.html" title="wx.Listbook" alt="" coords="78,392,172,421"/> <area shape="rect" id="node5" href="wx.EvtHandler.html" title="wx.EvtHandler" alt="" coords="133,83,244,112"/> <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.Object.html" title="wx.Object" alt="" coords="91,5,172,35"/> <area shape="rect" id="node8" href="wx.Trackable.html" title="wx.Trackable" alt="" coords="197,5,299,35"/> </map>
</p>
|
|appearance| Control Appearance
===============================
|
.. figure:: _static/images/widgets/fullsize/wxmsw/wx.listbook.png
:alt: wxMSW
:figclass: floatleft
**wxMSW**
.. figure:: _static/images/widgets/fullsize/wxmac/wx.listbook.png
:alt: wxMAC
:figclass: floatright
**wxMAC**
.. figure:: _static/images/widgets/fullsize/wxgtk/wx.listbook.png
:alt: wxGTK
:figclass: floatcenter
**wxGTK**
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.Listbook.__init__` Default constructor.
:meth:`~wx.Listbook.Create` Create the list book control that has already been constructed with the default constructor.
:meth:`~wx.Listbook.GetListView` Returns the :ref:`wx.ListView` associated with the control.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.Listbook.ListView` See :meth:`~wx.Listbook.GetListView`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.Listbook(BookCtrlBase)
**Possible constructors**::
Listbook()
Listbook(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize,
style=0, name=EmptyString)
Listbook is a class similar to Notebook but which uses a
ListCtrl to show the labels instead of the tabs.
.. method:: __init__(self, *args, **kw)
|overload| Overloaded Implementations:
**~~~**
**__init__** `(self)`
Default constructor.
**~~~**
**__init__** `(self, parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=0, name=EmptyString)`
Constructs a listbook control.
: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
**~~~**
.. method:: Create(self, parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=0, name=EmptyString)
Create the list 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:: GetListView(self, *args, **kw)
|overload| Overloaded Implementations:
**~~~**
**GetListView** `(self)`
Returns the :ref:`wx.ListView` associated with the control.
:rtype: :ref:`wx.ListView`
**~~~**
**GetListView** `(self)`
Returns the list control used for selecting pages.
:rtype: :ref:`wx.ListView`
**~~~**
.. attribute:: ListView
See :meth:`~wx.Listbook.GetListView`
|
