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
|
.. 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.ActivateEvent:
==========================================================================================================================================
|phoenix_title| **wx.ActivateEvent**
==========================================================================================================================================
An activate event is sent when a window or application is being activated or deactivated.
.. _ActivateEvent-events:
|events| Events Emitted by this Class
=====================================
Handlers bound for the following event types will receive a :ref:`wx.ActivateEvent` parameter.
Event macros:
- EVT_ACTIVATE: Process a ``wxEVT_ACTIVATE`` event.
- EVT_ACTIVATE_APP: Process a ``wxEVT_ACTIVATE_APP`` event. This event is received by the App-derived instance only.
- EVT_HIBERNATE: Process a hibernate event, supplying the member function. This event applies to :ref:`wx.App` only, and only on Windows SmartPhone and PocketPC. It is generated when the system is low on memory; the application should free up as much memory as possible, and restore full working state when it receives a ``wxEVT_ACTIVATE`` or ``wxEVT_ACTIVATE_APP`` event.
.. seealso:: :ref:`Events and Event Handling <events and event handling>`, :meth:`wx.App.IsActive`
|
|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>ActivateEvent</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.ActivateEvent_inheritance.png" alt="Inheritance diagram of ActivateEvent" 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="30,83,108,112"/> <area shape="rect" id="node3" href="wx.ActivateEvent.html" title="wx.ActivateEvent" alt="" coords="4,160,133,189"/> <area shape="rect" id="node2" href="wx.Object.html" title="wx.Object" alt="" coords="28,5,109,35"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.ActivateEvent.__init__` Constructor.
:meth:`~wx.ActivateEvent.GetActivationReason` Allows to check if the window was activated by clicking it with the mouse or in some other way.
:meth:`~wx.ActivateEvent.GetActive` Returns ``True`` if the application or window is being activated, ``False`` otherwise.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.ActivateEvent.Active` See :meth:`~wx.ActivateEvent.GetActive`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.ActivateEvent(Event)
**Possible constructors**::
ActivateEvent(eventType=wxEVT_NULL, active=True, id=0,
ActivationReason=Reason_Unknown)
An activate event is sent when a window or application is being
activated or deactivated.
.. method:: __init__(self, eventType=wxEVT_NULL, active=True, id=0, ActivationReason=Reason_Unknown)
Constructor.
:param `eventType`:
:type `eventType`: wx.EventType
:param `active`:
:type `active`: bool
:param `id`:
:type `id`: int
:param `ActivationReason`:
:type `ActivationReason`: wx.ActivateEvent.Reason
.. method:: GetActivationReason(self)
Allows to check if the window was activated by clicking it with the mouse or in some other way.
This method is currently only implemented in wxMSW and returns ``Reason_Mouse`` there if the window was activated by a mouse click and ``Reason_Unknown`` if it was activated in any other way (e.g. from keyboard or programmatically).
Under all the other platforms, ``Reason_Unknown`` is always returned.
:rtype: :ref:`wx.ActivateEvent.Reason`
.. versionadded:: 3.0
.. method:: GetActive(self)
Returns ``True`` if the application or window is being activated, ``False`` otherwise.
:rtype: `bool`
.. attribute:: Active
See :meth:`~wx.ActivateEvent.GetActive`
.. toctree::
:maxdepth: 1
:hidden:
wx.ActivateEvent.Reason.enumeration
|
