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
|
.. 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.FocusEvent:
==========================================================================================================================================
|phoenix_title| **wx.FocusEvent**
==========================================================================================================================================
A focus event is sent when a window's focus changes.
The window losing focus receives a "kill focus" event while the window gaining it gets a "set focus" one.
Notice that the set focus event happens both when the user gives focus to the window (whether using the mouse or keyboard) and when it is done from the program itself using :meth:`wx.Window.SetFocus` .
The focus event handlers should almost invariably call :meth:`wx.Event.Skip` on their event argument to allow the default handling to take place. Failure to do this may result in incorrect behaviour of the native controls. Also note that wxEVT_KILL_FOCUS handler must not call :meth:`wx.Window.SetFocus` as this, again, is not supported by all native controls. If you need to do this, consider using the :ref:`Delayed Action Mechanism <wx.IdleEvent>` described in :ref:`wx.IdleEvent` documentation.
.. _FocusEvent-events:
|events| Events Emitted by this Class
=====================================
Handlers bound for the following event types will receive a :ref:`wx.FocusEvent` parameter.
Event macros:
- EVT_SET_FOCUS: Process a ``wxEVT_SET_FOCUS`` event.
- EVT_KILL_FOCUS: Process a ``wxEVT_KILL_FOCUS`` event.
.. seealso:: :ref:`Events and Event Handling <events and event handling>`
|
|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>FocusEvent</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.FocusEvent_inheritance.png" alt="Inheritance diagram of FocusEvent" 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="23,83,101,112"/> <area shape="rect" id="node3" href="wx.FocusEvent.html" title="wx.FocusEvent" alt="" coords="5,160,120,189"/> <area shape="rect" id="node2" href="wx.Object.html" title="wx.Object" alt="" coords="21,5,103,35"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.FocusEvent.__init__` Constructor.
:meth:`~wx.FocusEvent.GetWindow` Returns the window associated with this event, that is the window which had the focus before for the ``wxEVT_SET_FOCUS`` event and the window which is going to receive focus for the ``wxEVT_KILL_FOCUS`` one.
:meth:`~wx.FocusEvent.SetWindow`
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.FocusEvent.Window` See :meth:`~wx.FocusEvent.GetWindow` and :meth:`~wx.FocusEvent.SetWindow`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.FocusEvent(Event)
**Possible constructors**::
FocusEvent(eventType=wxEVT_NULL, id=0)
A focus event is sent when a window's focus changes.
.. method:: __init__(self, eventType=wxEVT_NULL, id=0)
Constructor.
:param `eventType`:
:type `eventType`: wx.EventType
:param `id`:
:type `id`: int
.. method:: GetWindow(self)
Returns the window associated with this event, that is the window which had the focus before for the ``wxEVT_SET_FOCUS`` event and the window which is going to receive focus for the ``wxEVT_KILL_FOCUS`` one.
Warning: the window pointer may be ``None``!
:rtype: :ref:`wx.Window`
.. method:: SetWindow(self, win)
:param `win`:
:type `win`: wx.Window
.. attribute:: Window
See :meth:`~wx.FocusEvent.GetWindow` and :meth:`~wx.FocusEvent.SetWindow`
|
