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
|
.. 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.Simplebook:
==========================================================================================================================================
|phoenix_title| **wx.Simplebook**
==========================================================================================================================================
:ref:`wx.Simplebook` is a control showing exactly one of its several pages.
It implements :ref:`wx.BookCtrlBase` class interface but doesn't allow the user to change the page being displayed, unlike all the other book control classes, only the program can do it.
This class is created in the same manner as any other BookCtrl but then the program will typically call :meth:`~wx.Simplebook.ChangeSelection` to show different pages. See the :ref:`Notebook Sample <notebook sample>` for an example of :ref:`wx.Simplebook` in action.
Notice that is often convenient to use :meth:`~wx.Simplebook.ShowNewPage` instead of the base class :meth:`~wx.Simplebook.AddPage`.
There are no special styles defined for this class as it has no visual appearance of its own.
There are also no special events, this class reuses ``wxEVT_BOOKCTRL_PAGE_CHANGING`` and ``wxEVT_BOOKCTRL_PAGE_CHANGED`` events for the events it generates if the program calls :meth:`~wx.Simplebook.SetSelection`.
.. versionadded:: 2.9.5
.. 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>Simplebook</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.Simplebook_inheritance.png" alt="Inheritance diagram of Simplebook" 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.Simplebook.html" title="wx.Simplebook" alt="" coords="67,392,183,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.Simplebook.__init__` Default constructor.
:meth:`~wx.Simplebook.Create` Really create the window of an object created using default constructor.
:meth:`~wx.Simplebook.SetEffect` Set the same effect to use for both showing and hiding the pages.
:meth:`~wx.Simplebook.SetEffectTimeout` Set the same effect timeout to use for both showing and hiding the pages.
:meth:`~wx.Simplebook.SetEffects` Set the effects to use for showing and hiding the pages.
:meth:`~wx.Simplebook.SetEffectsTimeouts` Set the effect timeout to use for showing and hiding the pages.
:meth:`~wx.Simplebook.ShowNewPage` Add a new page and show it immediately.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.Simplebook(BookCtrlBase)
**Possible constructors**::
Simplebook()
Simplebook(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize,
style=0, name=EmptyString)
Simplebook is a control showing exactly one of its several pages.
.. method:: __init__(self, *args, **kw)
|overload| Overloaded Implementations:
**~~~**
**__init__** `(self)`
Default constructor.
Use :meth:`Create` later to really create the control.
**~~~**
**__init__** `(self, parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=0, name=EmptyString)`
Constructs a simple book 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)
Really create the window of an object created using 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`
.. versionadded:: 3.0.2
.. method:: SetEffect(self, effect)
Set the same effect to use for both showing and hiding the pages.
This is the same as ``SetEffects(effect, effect)`` .
:param `effect`:
:type `effect`: wx.ShowEffect
.. seealso:: :meth:`SetEffectTimeout`
.. method:: SetEffectTimeout(self, timeout)
Set the same effect timeout to use for both showing and hiding the pages.
This is the same as ``SetEffectsTimeouts(timeout, timeout)`` .
:param `timeout`:
.. seealso:: :meth:`SetEffect`
.. method:: SetEffects(self, showEffect, hideEffect)
Set the effects to use for showing and hiding the pages.
This method allows to specify the effects passed to :meth:`wx.Window.ShowWithEffect` and :meth:`wx.Window.HideWithEffect` respectively when the pages need to be shown or hidden.
By default, no effects are used, but as the pages are only changed by the program and not the user himself, it may be useful to use some visual effects to make the changes more noticeable.
:param `showEffect`: The effect to use for showing the newly selected page.
:type `showEffect`: wx.ShowEffect
:param `hideEffect`: The effect to use for hiding the previously selected page.
:type `hideEffect`: wx.ShowEffect
.. seealso:: :meth:`SetEffectsTimeouts`
.. method:: SetEffectsTimeouts(self, showTimeout, hideTimeout)
Set the effect timeout to use for showing and hiding the pages.
This method allows to configure the timeout arguments passed to :meth:`wx.Window.ShowWithEffect` and :meth:`wx.Window.HideWithEffect` if a non-default effect is used.
If this method is not called, default, system-dependent timeout is used.
:param `showTimeout`: Timeout of the show effect, in milliseconds.
:param `hideTimeout`: Timeout of the hide effect, in milliseconds.
.. seealso:: :meth:`SetEffects`
.. method:: ShowNewPage(self, page)
Add a new page and show it immediately.
This is simply a thin wrapper around the base class :meth:`wx.BookCtrlBase.AddPage` method using empty label (which is unused by this class anyhow) and selecting the new page immediately.
:param `page`:
:type `page`: wx.Window
:rtype: `bool`
|
