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
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
|
.. 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.BookCtrlBase:
==========================================================================================================================================
|phoenix_title| **wx.BookCtrlBase**
==========================================================================================================================================
A book control is a convenient way of displaying multiple pages of information, displayed one page at a time.
wxWidgets has five variants of this control:
- :ref:`wx.Choicebook`: controlled by a :ref:`wx.Choice`
- :ref:`wx.Listbook`: controlled by a :ref:`wx.ListCtrl`
- :ref:`wx.Notebook`: uses a row of tabs
- :ref:`wx.Treebook`: controlled by a :ref:`wx.TreeCtrl`
- :ref:`wx.Toolbook`: controlled by a :ref:`wx.ToolBar`
This abstract class is the parent of all these book controls, and provides their basic interface. This is a pure virtual class so you cannot allocate it directly.
.. seealso:: :ref:`BookCtrl Overview <bookctrl overview>`
|
|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>BookCtrlBase</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.BookCtrlBase_inheritance.png" alt="Inheritance diagram of BookCtrlBase" 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="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>
|
|sub_classes| Known Subclasses
==============================
:ref:`wx.aui.AuiNotebook`, :ref:`wx.Choicebook`, :ref:`wx.Listbook`, :ref:`wx.Notebook`, :ref:`wx.Simplebook`, :ref:`wx.Toolbook`, :ref:`wx.Treebook`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.BookCtrlBase.__init__` Default constructor.
:meth:`~wx.BookCtrlBase.AddPage` Adds a new page.
:meth:`~wx.BookCtrlBase.AdvanceSelection` Cycles through the tabs.
:meth:`~wx.BookCtrlBase.ChangeSelection` Changes the selection to the given page, returning the previous selection.
:meth:`~wx.BookCtrlBase.Create` Constructs the book control with the given parameters.
:meth:`~wx.BookCtrlBase.DeleteAllPages` Deletes all pages.
:meth:`~wx.BookCtrlBase.DeletePage` Deletes the specified page, and the associated window.
:meth:`~wx.BookCtrlBase.FindPage` Returns the index of the specified tab window or ``NOT_FOUND`` if not found.
:meth:`~wx.BookCtrlBase.GetCurrentPage` Returns the currently selected page or ``None``.
:meth:`~wx.BookCtrlBase.GetPage` Returns the window at the given page position.
:meth:`~wx.BookCtrlBase.GetPageCount` Returns the number of pages in the control.
:meth:`~wx.BookCtrlBase.GetPageImage` Returns the image index for the given page.
:meth:`~wx.BookCtrlBase.GetPageText` Returns the string for the given page.
:meth:`~wx.BookCtrlBase.GetSelection` Returns the currently selected page, or ``NOT_FOUND`` if none was selected.
:meth:`~wx.BookCtrlBase.HitTest` Returns the index of the tab at the specified position or ``NOT_FOUND`` if none.
:meth:`~wx.BookCtrlBase.InsertPage` Inserts a new page at the specified position.
:meth:`~wx.BookCtrlBase.RemovePage` Deletes the specified page, without deleting the associated window.
:meth:`~wx.BookCtrlBase.SetPageImage` Sets the image index for the given page.
:meth:`~wx.BookCtrlBase.SetPageSize` Sets the width and height of the pages.
:meth:`~wx.BookCtrlBase.SetPageText` Sets the text for the given page.
:meth:`~wx.BookCtrlBase.SetSelection` Sets the selection to the given page, returning the previous selection.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.BookCtrlBase.CurrentPage` See :meth:`~wx.BookCtrlBase.GetCurrentPage`
:attr:`~wx.BookCtrlBase.PageCount` See :meth:`~wx.BookCtrlBase.GetPageCount`
:attr:`~wx.BookCtrlBase.Selection` See :meth:`~wx.BookCtrlBase.GetSelection` and :meth:`~wx.BookCtrlBase.SetSelection`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.BookCtrlBase(Control, WithImages)
**Possible constructors**::
BookCtrlBase()
BookCtrlBase(parent, winid, pos=DefaultPosition, size=DefaultSize,
style=0, name=EmptyString)
A book control is a convenient way of displaying multiple pages of
information, displayed one page at a time.
.. method:: __init__(self, *args, **kw)
|overload| Overloaded Implementations:
**~~~**
**__init__** `(self)`
Default constructor.
**~~~**
**__init__** `(self, parent, winid, pos=DefaultPosition, size=DefaultSize, style=0, name=EmptyString)`
Constructs the book control with the given parameters.
See :meth:`Create` for two-step construction.
:param `parent`:
:type `parent`: wx.Window
:param `winid`:
:type `winid`: 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:: AddPage(self, page, text, select=False, imageId=NO_IMAGE)
Adds a new page.
The page must have the book control itself as the parent and must not have been added to this control previously.
The call to this function may generate the page changing events.
:param `page`: Specifies the new page.
:type `page`: wx.Window
:param `text`: Specifies the text for the new page.
:type `text`: string
:param `select`: Specifies whether the page should be selected.
:type `select`: bool
:param `imageId`: Specifies the optional image index for the new page.
:type `imageId`: int
:rtype: `bool`
:returns:
``True`` if successful, ``False`` otherwise.
.. note::
Do not delete the page, it will be deleted by the book control.
.. seealso:: :meth:`InsertPage`
.. method:: AdvanceSelection(self, forward=True)
Cycles through the tabs.
The call to this function generates the page changing events.
:param `forward`:
:type `forward`: bool
.. method:: ChangeSelection(self, page)
Changes the selection to the given page, returning the previous selection.
This function behaves as :meth:`SetSelection` but does `not` generate the page changing events.
See :ref:`User Generated Events vs Programmatically Generated Events <user generated events vs programmatically generated events>` for more information.
:param `page`:
:type `page`: int
:rtype: `int`
.. method:: Create(self, parent, winid, pos=DefaultPosition, size=DefaultSize, style=0, name=EmptyString)
Constructs the book control with the given parameters.
:param `parent`:
:type `parent`: wx.Window
:param `winid`:
:type `winid`: 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:: DeleteAllPages(self)
Deletes all pages.
:rtype: `bool`
.. method:: DeletePage(self, page)
Deletes the specified page, and the associated window.
The call to this function generates the page changing events.
:param `page`:
:type `page`: int
:rtype: `bool`
.. method:: FindPage(self, page)
Returns the index of the specified tab window or ``NOT_FOUND`` if not found.
:param `page`: One of the control pages.
:type `page`: wx.Window
:rtype: `int`
:returns:
The zero-based tab index or ``NOT_FOUND`` if not found.
.. versionadded:: 2.9.5
.. method:: GetCurrentPage(self)
Returns the currently selected page or ``None``.
:rtype: :ref:`wx.Window`
.. method:: GetPage(self, page)
Returns the window at the given page position.
:param `page`:
:type `page`: int
:rtype: :ref:`wx.Window`
.. method:: GetPageCount(self)
Returns the number of pages in the control.
:rtype: `int`
.. method:: GetPageImage(self, nPage)
Returns the image index for the given page.
:param `nPage`:
:type `nPage`: int
:rtype: `int`
.. method:: GetPageText(self, nPage)
Returns the string for the given page.
:param `nPage`:
:type `nPage`: int
:rtype: `string`
.. method:: GetSelection(self)
Returns the currently selected page, or ``NOT_FOUND`` if none was selected.
Note that this method may return either the previously or newly selected page when called from the ``EVT_BOOKCTRL_PAGE_CHANGED`` handler depending on the platform and so :meth:`wx.BookCtrlEvent.GetSelection` should be used instead in this case.
:rtype: `int`
.. method:: HitTest(self, pt)
Returns the index of the tab at the specified position or ``NOT_FOUND`` if none.
If `flags` parameter is non-NULL, the position of the point inside the tab is returned as well.
:param `pt`: Specifies the point for the hit test.
:type `pt`: wx.Point
:rtype: `tuple`
:returns:
( `int`, `flags` )
.. method:: InsertPage(self, index, page, text, select=False, imageId=NO_IMAGE)
Inserts a new page at the specified position.
:param `index`: Specifies the position for the new page.
:type `index`: int
:param `page`: Specifies the new page.
:type `page`: wx.Window
:param `text`: Specifies the text for the new page.
:type `text`: string
:param `select`: Specifies whether the page should be selected.
:type `select`: bool
:param `imageId`: Specifies the optional image index for the new page.
:type `imageId`: int
:rtype: `bool`
:returns:
``True`` if successful, ``False`` otherwise.
.. note::
Do not delete the page, it will be deleted by the book control.
.. seealso:: :meth:`AddPage`
.. method:: RemovePage(self, page)
Deletes the specified page, without deleting the associated window.
:param `page`:
:type `page`: int
:rtype: `bool`
.. method:: SetPageImage(self, page, image)
Sets the image index for the given page.
`image` is an index into the image list which was set with :meth:`SetImageList` .
:param `page`:
:type `page`: int
:param `image`:
:type `image`: int
:rtype: `bool`
.. method:: SetPageSize(self, size)
Sets the width and height of the pages.
:param `size`:
:type `size`: wx.Size
.. note::
This method is currently not implemented for wxGTK.
.. method:: SetPageText(self, page, text)
Sets the text for the given page.
:param `page`:
:type `page`: int
:param `text`:
:type `text`: string
:rtype: `bool`
.. method:: SetSelection(self, page)
Sets the selection to the given page, returning the previous selection.
Notice that the call to this function generates the page changing events, use the :meth:`ChangeSelection` function if you don't want these events to be generated.
:param `page`:
:type `page`: int
:rtype: `int`
.. seealso:: :meth:`GetSelection`
.. attribute:: CurrentPage
See :meth:`~wx.BookCtrlBase.GetCurrentPage`
.. attribute:: PageCount
See :meth:`~wx.BookCtrlBase.GetPageCount`
.. attribute:: Selection
See :meth:`~wx.BookCtrlBase.GetSelection` and :meth:`~wx.BookCtrlBase.SetSelection`
|
