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
|
.. 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.BookCtrlEvent:
==========================================================================================================================================
|phoenix_title| **wx.BookCtrlEvent**
==========================================================================================================================================
This class represents the events generated by book controls (:ref:`wx.Notebook`, :ref:`wx.Listbook`, :ref:`wx.Choicebook`, :ref:`wx.Treebook`, :ref:`wx.aui.AuiNotebook`).
The ``PAGE_CHANGING`` events are sent before the current page is changed. It allows the program to examine the current page (which can be retrieved with :meth:`wx.BookCtrlEvent.GetOldSelection` ) and to veto the page change by calling :meth:`wx.NotifyEvent.Veto` if, for example, the current values in the controls of the old page are invalid.
The ``PAGE_CHANGED`` events are sent after the page has been changed and the program cannot veto it any more, it just informs it about the page change.
To summarize, if the program is interested in validating the page values before allowing the user to change it, it should process the ``PAGE_CHANGING`` event, otherwise ``PAGE_CHANGED`` is probably enough. In any case, it is probably unnecessary to process both events at once.
.. seealso:: :ref:`wx.Notebook`, :ref:`wx.Listbook`, :ref:`wx.Choicebook`, :ref:`wx.Treebook`, :ref:`wx.Toolbook`, :ref:`wx.aui.AuiNotebook`
|
|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>BookCtrlEvent</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.BookCtrlEvent_inheritance.png" alt="Inheritance diagram of BookCtrlEvent" 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.Event.html" title="wx.Event" alt="" coords="38,83,116,112"/> <area shape="rect" id="node3" href="wx.CommandEvent.html" title="wx.CommandEvent" alt="" coords="5,160,149,189"/> <area shape="rect" id="node2" href="wx.Object.html" title="wx.Object" alt="" coords="36,5,117,35"/> <area shape="rect" id="node5" href="wx.NotifyEvent.html" title="wx.NotifyEvent" alt="" coords="20,237,135,267"/> <area shape="rect" id="node4" href="wx.BookCtrlEvent.html" title="wx.BookCtrlEvent" alt="" coords="11,315,143,344"/> </map>
</p>
|
|sub_classes| Known Subclasses
==============================
:ref:`wx.aui.AuiNotebookEvent`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.BookCtrlEvent.__init__` Constructor (used internally by wxWidgets only).
:meth:`~wx.BookCtrlEvent.GetOldSelection` Returns the page that was selected before the change, ``NOT_FOUND`` if none was selected.
:meth:`~wx.BookCtrlEvent.GetSelection` Returns the currently selected page, or ``NOT_FOUND`` if none was selected.
:meth:`~wx.BookCtrlEvent.SetOldSelection` Sets the id of the page selected before the change.
:meth:`~wx.BookCtrlEvent.SetSelection` Sets the selection member variable.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.BookCtrlEvent.OldSelection` See :meth:`~wx.BookCtrlEvent.GetOldSelection` and :meth:`~wx.BookCtrlEvent.SetOldSelection`
:attr:`~wx.BookCtrlEvent.Selection` See :meth:`~wx.BookCtrlEvent.GetSelection` and :meth:`~wx.BookCtrlEvent.SetSelection`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.BookCtrlEvent(NotifyEvent)
**Possible constructors**::
BookCtrlEvent(eventType=wxEVT_NULL, id=0, sel=NOT_FOUND,
oldSel=NOT_FOUND)
This class represents the events generated by book controls
(wxNotebook, Listbook, Choicebook, Treebook, AuiNotebook).
.. method:: __init__(self, eventType=wxEVT_NULL, id=0, sel=NOT_FOUND, oldSel=NOT_FOUND)
Constructor (used internally by wxWidgets only).
:param `eventType`:
:type `eventType`: wx.EventType
:param `id`:
:type `id`: int
:param `sel`:
:type `sel`: int
:param `oldSel`:
:type `oldSel`: int
.. method:: GetOldSelection(self)
Returns the page that was selected before the change, ``NOT_FOUND`` if none was selected.
:rtype: `int`
.. method:: GetSelection(self)
Returns the currently selected page, or ``NOT_FOUND`` if none was selected.
:rtype: `int`
.. note::
under Windows, :meth:`GetSelection` will return the same value as :meth:`GetOldSelection` when called from the ``EVT_BOOKCTRL_PAGE_CHANGING`` handler and not the page which is going to be selected.
.. method:: SetOldSelection(self, page)
Sets the id of the page selected before the change.
:param `page`:
:type `page`: int
.. method:: SetSelection(self, page)
Sets the selection member variable.
:param `page`:
:type `page`: int
.. attribute:: OldSelection
See :meth:`~wx.BookCtrlEvent.GetOldSelection` and :meth:`~wx.BookCtrlEvent.SetOldSelection`
.. attribute:: Selection
See :meth:`~wx.BookCtrlEvent.GetSelection` and :meth:`~wx.BookCtrlEvent.SetSelection`
|
