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
|
.. 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
.. currentmodule:: wx.lib.agw.labelbook
.. highlight:: python
.. _wx.lib.agw.labelbook.ImageNotebookEvent:
==========================================================================================================================================
|phoenix_title| **wx.lib.agw.labelbook.ImageNotebookEvent**
==========================================================================================================================================
This events will be sent when a ``EVT_IMAGENOTEBOOK_PAGE_CHANGED``,
``EVT_IMAGENOTEBOOK_PAGE_CHANGING``, ``EVT_IMAGENOTEBOOK_PAGE_CLOSING``,
``EVT_IMAGENOTEBOOK_PAGE_CLOSED`` is mapped in the parent.
|
|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>ImageNotebookEvent</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.lib.agw.labelbook.ImageNotebookEvent_inheritance.png" alt="Inheritance diagram of ImageNotebookEvent" 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.lib.agw.labelbook.ImageNotebookEvent.html" title="wx.lib.agw.labelbook.ImageNotebookEvent" alt="" coords="5,315,296,344"/> <area shape="rect" id="node2" href="wx.PyCommandEvent.html" title="wx.PyCommandEvent" alt="" coords="71,237,229,267"/> <area shape="rect" id="node3" href="wx.Event.html" title="wx.Event" alt="" coords="111,83,189,112"/> <area shape="rect" id="node5" href="wx.CommandEvent.html" title="wx.CommandEvent" alt="" coords="78,160,223,189"/> <area shape="rect" id="node4" href="wx.Object.html" title="wx.Object" alt="" coords="109,5,191,35"/> </map>
</p>
|
|super_classes| Known Superclasses
==================================
:class:`wx.PyCommandEvent`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.lib.agw.labelbook.ImageNotebookEvent.__init__` Default class constructor.
:meth:`~wx.lib.agw.labelbook.ImageNotebookEvent.Allow` This is the opposite of :meth:`~ImageNotebookEvent.Veto`: it explicitly allows the event to be processed.
:meth:`~wx.lib.agw.labelbook.ImageNotebookEvent.GetOldSelection` Returns the old event selection.
:meth:`~wx.lib.agw.labelbook.ImageNotebookEvent.GetSelection` Returns the event selection.
:meth:`~wx.lib.agw.labelbook.ImageNotebookEvent.IsAllowed` Returns ``True`` if the change is allowed (:meth:`~ImageNotebookEvent.Veto` hasn't been called) or
:meth:`~wx.lib.agw.labelbook.ImageNotebookEvent.SetOldSelection` Sets the event old selection.
:meth:`~wx.lib.agw.labelbook.ImageNotebookEvent.SetSelection` Sets the event selection.
:meth:`~wx.lib.agw.labelbook.ImageNotebookEvent.Veto` Prevents the change announced by this event from happening.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: ImageNotebookEvent(wx.PyCommandEvent)
This events will be sent when a ``EVT_IMAGENOTEBOOK_PAGE_CHANGED``,
``EVT_IMAGENOTEBOOK_PAGE_CHANGING``, ``EVT_IMAGENOTEBOOK_PAGE_CLOSING``,
``EVT_IMAGENOTEBOOK_PAGE_CLOSED`` is mapped in the parent.
.. method:: __init__(self, eventType, eventId=1, sel=-1, oldsel=-1)
Default class constructor.
:param `eventType`: the event type;
:param `eventId`: the event identifier;
:param `sel`: the current selection;
:param `oldsel`: the old selection.
.. method:: Allow(self)
This is the opposite of :meth:`~ImageNotebookEvent.Veto`: it explicitly allows the event to be processed.
For most events it is not necessary to call this method as the events are
allowed anyhow but some are forbidden by default (this will be mentioned
in the corresponding event description).
.. method:: GetOldSelection(self)
Returns the old event selection.
.. method:: GetSelection(self)
Returns the event selection.
.. method:: IsAllowed(self)
Returns ``True`` if the change is allowed (:meth:`~ImageNotebookEvent.Veto` hasn't been called) or
``False`` otherwise (if it was).
.. method:: SetOldSelection(self, s)
Sets the event old selection.
:param `s`: an integer specifying the old selection.
.. method:: SetSelection(self, s)
Sets the event selection.
:param `s`: an integer specifying the new selection.
.. method:: Veto(self)
Prevents the change announced by this event from happening.
:note: It is in general a good idea to notify the user about the reasons
for vetoing the change because otherwise the applications behaviour (which
just refuses to do what the user wants) might be quite surprising.
|
