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
|
.. 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.aui.AuiNotebookEvent:
==========================================================================================================================================
|phoenix_title| **wx.aui.AuiNotebookEvent**
==========================================================================================================================================
This class is used by the events generated by :ref:`wx.aui.AuiNotebook`.
.. _AuiNotebookEvent-events:
|events| Events Emitted by this Class
=====================================
Handlers bound for the following event types will receive a :ref:`wx.aui.AuiNotebookEvent` parameter.
- EVT_AUINOTEBOOK_PAGE_CLOSE: A page is about to be closed. Processes a ``wxEVT_AUINOTEBOOK_PAGE_CLOSE`` event.
- EVT_AUINOTEBOOK_PAGE_CLOSED(winid, fn): A page has been closed. Processes a ``wxEVT_AUINOTEBOOK_PAGE_CLOSED`` event.
- EVT_AUINOTEBOOK_PAGE_CHANGED: The page selection was changed. Processes a ``wxEVT_AUINOTEBOOK_PAGE_CHANGED`` event.
- EVT_AUINOTEBOOK_PAGE_CHANGING: The page selection is about to be changed. Processes a ``wxEVT_AUINOTEBOOK_PAGE_CHANGING`` event. This event can be vetoed.
- EVT_AUINOTEBOOK_BUTTON: The window list button has been pressed. Processes a ``wxEVT_AUINOTEBOOK_BUTTON`` event.
- EVT_AUINOTEBOOK_BEGIN_DRAG: Dragging is about to begin. Processes a ``wxEVT_AUINOTEBOOK_BEGIN_DRAG`` event.
- EVT_AUINOTEBOOK_END_DRAG: Dragging has ended. Processes a ``wxEVT_AUINOTEBOOK_END_DRAG`` event.
- EVT_AUINOTEBOOK_DRAG_MOTION: Emitted during a drag and drop operation. Processes a ``wxEVT_AUINOTEBOOK_DRAG_MOTION`` event.
- EVT_AUINOTEBOOK_ALLOW_DND: Whether to allow a tab to be dropped. Processes a ``wxEVT_AUINOTEBOOK_ALLOW_DND`` event. This event must be specially allowed.
- EVT_AUINOTEBOOK_DRAG_DONE(winid, fn): Notify that the tab has been dragged. Processes a ``wxEVT_AUINOTEBOOK_DRAG_DONE`` event.
- EVT_AUINOTEBOOK_TAB_MIDDLE_DOWN(winid, fn): The middle mouse button is pressed on a tab. Processes a ``wxEVT_AUINOTEBOOK_TAB_MIDDLE_DOWN`` event.
- EVT_AUINOTEBOOK_TAB_MIDDLE_UP(winid, fn): The middle mouse button is released on a tab. Processes a ``wxEVT_AUINOTEBOOK_TAB_MIDDLE_UP`` event.
- EVT_AUINOTEBOOK_TAB_RIGHT_DOWN(winid, fn): The right mouse button is pressed on a tab. Processes a ``wxEVT_AUINOTEBOOK_TAB_RIGHT_DOWN`` event.
- EVT_AUINOTEBOOK_TAB_RIGHT_UP(winid, fn): The right mouse button is released on a tab. Processes a ``wxEVT_AUINOTEBOOK_TAB_RIGHT_UP`` event.
- EVT_AUINOTEBOOK_BG_DCLICK(winid, fn): Double clicked on the tabs background area. Processes a ``wxEVT_AUINOTEBOOK_BG_DCLICK`` event.
.. seealso:: :ref:`wx.aui.AuiNotebook`, :ref:`wx.BookCtrlEvent`
|
|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>AuiNotebookEvent</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.aui.AuiNotebookEvent_inheritance.png" alt="Inheritance diagram of AuiNotebookEvent" 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.Object.html" title="wx.Object" alt="" coords="55,5,136,35"/> <area shape="rect" id="node6" href="wx.Event.html" title="wx.Event" alt="" coords="57,83,135,112"/> <area shape="rect" id="node2" href="wx.NotifyEvent.html" title="wx.NotifyEvent" alt="" coords="39,237,153,267"/> <area shape="rect" id="node5" href="wx.BookCtrlEvent.html" title="wx.BookCtrlEvent" alt="" coords="30,315,161,344"/> <area shape="rect" id="node3" href="wx.CommandEvent.html" title="wx.CommandEvent" alt="" coords="23,160,168,189"/> <area shape="rect" id="node4" href="wx.aui.AuiNotebookEvent.html" title="wx.aui.AuiNotebookEvent" alt="" coords="5,392,187,421"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.aui.AuiNotebookEvent.__init__` Constructor.
:meth:`~wx.aui.AuiNotebookEvent.Clone`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.aui.AuiNotebookEvent(BookCtrlEvent)
**Possible constructors**::
AuiNotebookEvent(command_type=wxEVT_NULL, win_id=0)
This class is used by the events generated by AuiNotebook.
.. method:: __init__(self, command_type=wxEVT_NULL, win_id=0)
Constructor.
:param `command_type`:
:type `command_type`: wx.EventType
:param `win_id`:
:type `win_id`: int
.. method:: Clone(self)
:rtype: :ref:`Event`
|
