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
|
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>gtk.gdk.Event</title><meta name="generator" content="DocBook XSL Stylesheets V1.65.1"><link rel="home" href="index.html" title="PyGTK 2.0 Reference Manual"><link rel="up" href="gdk-class-reference.html" title="The gtk.gdk Class Reference"><link rel="previous" href="class-gdkdrawable.html" title="gtk.gdk.Drawable"><link rel="next" href="class-gdkgc.html" title="gtk.gdk.GC"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">gtk.gdk.Event</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gdkdrawable.html">Prev</a></td><th width="60%" align="center">The gtk.gdk Class Reference</th><td width="20%" align="right"><a accesskey="n" href="class-gdkgc.html">Next</a></td></tr></table><hr></div><div class="refentry" lang="en"><a name="class-gdkevent"></a><div class="titlepage"><div></div><div></div></div><div class="refnamediv"><h2>gtk.gdk.Event</h2><p>gtk.gdk.Event — an object representing an event from the windowing
system</p></div><div class="refsect1" lang="en"><a name="id2983660"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.gdk.Event</span></span>(<span class="ooclass"><span class="classname">gobject.GBoxed</span></span>):
<code class="constructorsynopsis"> <span class="methodname"><a href="class-gdkevent.html#constructor-gdkevent" title="Constructor">gtk.gdk.Event</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>type</tt></b></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gdkevent.html#method-gdkevent--put" title="gtk.gdk.Event.put">put</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gdkevent.html#method-gdkevent--copy" title="gtk.gdk.Event.copy">copy</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gdkevent.html#method-gdkevent--free" title="gtk.gdk.Event.free">free</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gdkevent.html#method-gdkevent--get-time" title="gtk.gdk.Event.get_time">get_time</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gdkevent.html#method-gdkevent--get-state" title="gtk.gdk.Event.get_state">get_state</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>state</tt></b></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gdkevent.html#method-gdkevent--get-coords" title="gtk.gdk.Event.get_coords">get_coords</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gdkevent.html#method-gdkevent--get-root-coords" title="gtk.gdk.Event.get_root_coords">get_root_coords</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gdkevent.html#method-gdkevent--get-axis" title="gtk.gdk.Event.get_axis">get_axis</a></span>(<span class="methodparam"><span class="parameter"><i class="parameter"><tt>axis_use</tt></i></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gdkevent.html#method-gdkevent--set-screen" title="gtk.gdk.Event.set_screen">set_screen</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>screen</tt></b></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gdkevent.html#method-gdkevent--get-screen" title="gtk.gdk.Event.get_screen">get_screen</a></span>(<span class="methodparam"></span>)</code><br></pre></td></tr></table><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting">
<span class="bold"><b>Functions</b></span>
<code class="methodsynopsis"> def <span class="methodname"><a href="class-gdkevent.html#function-gdk--events-pending" title="gtk.gdk.events_pending">gtk.gdk.events_pending</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gdkevent.html#function-gdk--event-peek" title="gtk.gdk.event_peek">gtk.gdk.event_peek</a></span>(<span class="methodparam"><span class="parameter"><i class="parameter"><tt></tt></i></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gdkevent.html#function-gdk--event-get" title="gtk.gdk.event_get">gtk.gdk.event_get</a></span>(<span class="methodparam"><span class="parameter"><i class="parameter"><tt></tt></i></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gdkevent.html#function-gdk--event-get-graphics-expose" title="gtk.gdk.event_get_graphics_expose">gtk.gdk.event_get_graphics_expose</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>window</tt></b></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gdkevent.html#function-gdk--set-show-events" title="gtk.gdk.set_show_events">gtk.gdk.set_show_events</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>show_events</tt></b></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a href="class-gdkevent.html#function-gdk--get-show-events" title="gtk.gdk.get_show_events">gtk.gdk.get_show_events</a></span>(<span class="methodparam"><span class="parameter"><i class="parameter"><tt></tt></i></span></span>)</code></pre></td></tr></table></div><div class="refsect1" lang="en"><a name="id3028172"></a><h2>Attributes</h2><p>The attributes available for a <a href="class-gdkevent.html" title="gtk.gdk.Event"><tt class="classname">gtk.gdk.Event</tt></a> are
dependent on the type of the event. The event types are described in the
<a href="class-gdkevent.html#description-gdkevent" title="Description">Description</a> section.</p><p>The following attributes are available to all different kind of events:</p><div class="refsect2" lang="en"><a name="id2973841"></a><div class="blockquote"><table width="100%" border="0" bgcolor="#E0E0E0"><tr><td valign="top"><div class="informaltable"><table cellpadding="5" width="100%" border="0"><colgroup><col><col><col></colgroup><tbody><tr valign="top"><td valign="top">"type"</td><td valign="top">Read</td><td valign="top">The event type - see the list below in the <a href="class-gdkevent.html#description-gdkevent" title="Description">Description</a> section</td></tr><tr valign="top"><td valign="top">"window"</td><td valign="top">Read/Write</td><td valign="top">The <a href="class-gdkwindow.html" title="gtk.gdk.Window"><tt class="classname">gtk.gdk.Window</tt></a> the
event occurred on.</td></tr><tr valign="top"><td valign="top">"send_event"</td><td valign="top">Read/Write</td><td valign="top"><tt class="literal">TRUE</tt> if the event was sent
explicitly.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect2" lang="en"><a name="id2992359"></a><h3><tt class="literal">gtk.gdk.EXPOSE</tt></h3><div class="blockquote"><table width="100%" border="0" bgcolor="#E0E0E0"><tr><td valign="top"><div class="informaltable"><table cellpadding="5" width="100%" border="0"><colgroup><col><col><col></colgroup><tbody><tr valign="top"><td valign="top">"area"</td><td valign="top">Read/Write</td><td valign="top">The bounding box of the area to be redrawn</td></tr><tr valign="top"><td valign="top">"count"</td><td valign="top">Read/Write</td><td valign="top">The number of contiguous gtk.gdk.EXPOSE events
following this one. The only use for this is "exposure compression", i.e.
handling all contiguous gtk.gdk.EXPOSE events in one go, though
<tt class="literal">PyGTK</tt> performs some exposure compression so this is not
normally needed.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect2" lang="en"><a name="id3001948"></a><h3><tt class="literal">gtk.gdk.MOTION_NOTIFY</tt></h3><div class="blockquote"><table width="100%" border="0" bgcolor="#E0E0E0"><tr><td valign="top"><div class="informaltable"><table cellpadding="5" width="100%" border="0"><colgroup><col><col><col></colgroup><tbody><tr valign="top"><td valign="top">"time"</td><td valign="top">Read/Write</td><td valign="top">The time of the event in milliseconds.</td></tr><tr valign="top"><td valign="top">"x"</td><td valign="top">Read/Write</td><td valign="top">The x coordinate of the pointer relative to the
window.</td></tr><tr valign="top"><td valign="top">"y"</td><td valign="top">Read/Write</td><td valign="top">The y coordinate of the pointer relative to the
window.</td></tr><tr valign="top"><td valign="top">"axes"</td><td valign="top">Read</td><td valign="top"><i class="parameter"><tt>x</tt></i>, <i class="parameter"><tt>y</tt></i>
translated to the axes of <i class="parameter"><tt>device</tt></i>, or
<tt class="literal">None</tt> if <i class="parameter"><tt>device</tt></i> is the
mouse.</td></tr><tr valign="top"><td valign="top">"state"</td><td valign="top">Read/Write</td><td valign="top">A bit-mask representing the state of the modifier
keys (e.g. <span><b class="keycap">Control</b></span>, <span><b class="keycap">Shift</b></span> and
<span><b class="keycap">Alt</b></span>) and the pointer buttons.</td></tr><tr valign="top"><td valign="top">"is_hint"</td><td valign="top">Read/Write</td><td valign="top"><tt class="literal">TRUE</tt> if the
<tt class="literal">gdk.POINTER_MOTION_HINT_MASK</tt> is set.</td></tr><tr valign="top"><td valign="top">"device"</td><td valign="top">Read</td><td valign="top">The device where the event originated.</td></tr><tr valign="top"><td valign="top">"x_root"</td><td valign="top">Read/Write</td><td valign="top">The x coordinate of the pointer relative to the root
of the screen.</td></tr><tr valign="top"><td valign="top">"y_root"</td><td valign="top">Read/Write</td><td valign="top">The y coordinate of the pointer relative to the root
of the screen.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect2" lang="en"><a name="id3092596"></a><h3><tt class="literal">gtk.gdk.BUTTON_PRESS</tt></h3><h3><tt class="literal">gtk.gdk._2BUTTON_PRESS</tt></h3><h3><tt class="literal">gtk.gdk._3BUTTON_PRESS</tt></h3><h3><tt class="literal">gtk.gdk.BUTTON_RELEASE</tt></h3><div class="blockquote"><table width="100%" border="0" bgcolor="#E0E0E0"><tr><td valign="top"><div class="informaltable"><table cellpadding="5" width="100%" border="0"><colgroup><col><col><col></colgroup><tbody><tr valign="top"><td valign="top">"time"</td><td valign="top">Read/Write</td><td valign="top">The time of the event in milliseconds.</td></tr><tr valign="top"><td valign="top">"x"</td><td valign="top">Read/Write</td><td valign="top">The x coordinate of the pointer relative to the
window.</td></tr><tr valign="top"><td valign="top">"y"</td><td valign="top">Read/Write</td><td valign="top">The y coordinate of the pointer relative to the
window.</td></tr><tr valign="top"><td valign="top">"axes"</td><td valign="top">Read</td><td valign="top"><i class="parameter"><tt>x</tt></i>, <i class="parameter"><tt>y</tt></i>
translated to the axes of <i class="parameter"><tt>device</tt></i>, or
<tt class="literal">None</tt> if <i class="parameter"><tt>device</tt></i> is the
mouse.</td></tr><tr valign="top"><td valign="top">"state"</td><td valign="top">Read/Write</td><td valign="top">A bit-mask representing the state of the modifier
keys (e.g. <span><b class="keycap">Control</b></span>, <span><b class="keycap">Shift</b></span> and
<span><b class="keycap">Alt</b></span>) and the pointer buttons.</td></tr><tr valign="top"><td valign="top">"button"</td><td valign="top">Read/Write</td><td valign="top">The button which was pressed or released, numbered
from 1 to 5. Normally button 1 is the left mouse button, 2 is the middle
button, and 3 is the right button. On 2-button mice, the middle button can
often be simulated by pressing both mouse buttons together.</td></tr><tr valign="top"><td valign="top">"device"</td><td valign="top">Read</td><td valign="top">The device where the event originated.</td></tr><tr valign="top"><td valign="top">"x_root"</td><td valign="top">Read/Write</td><td valign="top">The x coordinate of the pointer relative to the root
of the screen.</td></tr><tr valign="top"><td valign="top">"y_root"</td><td valign="top">Read/Write</td><td valign="top">The y coordinate of the pointer relative to the root
of the screen.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect2" lang="en"><a name="id2928996"></a><h3><tt class="literal">gtk.gdk.KEY_PRESS</tt></h3><h3><tt class="literal">gtk.gdk.KEY_RELEASE</tt></h3><div class="blockquote"><table width="100%" border="0" bgcolor="#E0E0E0"><tr><td valign="top"><div class="informaltable"><table cellpadding="5" width="100%" border="0"><colgroup><col><col><col></colgroup><tbody><tr valign="top"><td valign="top">"time"</td><td valign="top">Read/Write</td><td valign="top">The time of the event in milliseconds.</td></tr><tr valign="top"><td valign="top">"state"</td><td valign="top">Read/Write</td><td valign="top">A bit-mask representing the state of the modifier
keys (e.g. <span><b class="keycap">Control</b></span>, <span><b class="keycap">Shift</b></span> and
<span><b class="keycap">Alt</b></span>) and the pointer buttons.</td></tr><tr valign="top"><td valign="top">"keyval"</td><td valign="top">Read/Write</td><td valign="top">The key that was pressed or released.</td></tr><tr valign="top"><td valign="top">"string"</td><td valign="top">Read/Write</td><td valign="top">A multi-byte string containing the composed
characters resulting from the key press. When text is being input, in a
<a href="class-gtkentry.html" title="gtk.Entry"><tt class="classname">gtk.Entry</tt></a> for
example, it is these characters which should be added to the input buffer.
When using Input Methods to support internationalized text input, the
composed characters appear here after the pre-editing has been
completed.</td></tr><tr valign="top"><td valign="top">"hardware_keycode"</td><td valign="top">Read/Write</td><td valign="top">The raw code of the key that was pressed or
released. Available in PyGTK 2.2 and above.</td></tr><tr valign="top"><td valign="top">"group"</td><td valign="top">Read/Write</td><td valign="top">the keyboard group. Available in PyGTK 2.4 and
above.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect2" lang="en"><a name="id3220987"></a><h3><tt class="literal">gtk.gdk.ENTER_NOTIFY</tt></h3><h3><tt class="literal">gtk.gdk.LEAVE_NOTIFY</tt></h3><div class="blockquote"><table width="100%" border="0" bgcolor="#E0E0E0"><tr><td valign="top"><div class="informaltable"><table cellpadding="5" width="100%" border="0"><colgroup><col><col><col></colgroup><tbody><tr valign="top"><td valign="top">"subwindow"</td><td valign="top">Read</td><td valign="top">The window that was entered or left.</td></tr><tr valign="top"><td valign="top">"time"</td><td valign="top">Read/Write</td><td valign="top">The time of the event in milliseconds.</td></tr><tr valign="top"><td valign="top">"x"</td><td valign="top">Read/Write</td><td valign="top">The x coordinate of the pointer relative to the
window.</td></tr><tr valign="top"><td valign="top">"y"</td><td valign="top">Read/Write</td><td valign="top">The y coordinate of the pointer relative to the
window.</td></tr><tr valign="top"><td valign="top">"x_root"</td><td valign="top">Read/Write</td><td valign="top">The x coordinate of the pointer relative to the root
of the screen.</td></tr><tr valign="top"><td valign="top">"y_root"</td><td valign="top">Read/Write</td><td valign="top">The y coordinate of the pointer relative to the root
of the screen.</td></tr><tr valign="top"><td valign="top">"mode"</td><td valign="top">Read/Write</td><td valign="top">The crossing mode
(<tt class="literal">gtk.gdk.CROSSING_NORMAL</tt>,
<tt class="literal">gtk.gdk.CROSSING_GRAB</tt> or
<tt class="literal">gtk.gdk.CROSSING_UNGRAB</tt>).</td></tr><tr valign="top"><td valign="top">"detail"</td><td valign="top">Read/Write</td><td valign="top">The kind of crossing that happened
(<tt class="literal">gtk.gdk.NOTIFY_INFERIOR</tt>,
<tt class="literal">gtk.gdk.NOTIFY_ANCESTOR</tt>,
<tt class="literal">gtk.gdk.NOTIFY_VIRTUAL</tt>,
<tt class="literal">gtk.gdk.NOTIFY_NONLINEAR</tt> or
<tt class="literal">gtk.gdk.NOTIFY_NONLINEAR_VIRTUAL</tt>).</td></tr><tr valign="top"><td valign="top">"focus"</td><td valign="top">Read/Write</td><td valign="top"><tt class="literal">TRUE</tt> if
<i class="parameter"><tt>window</tt></i> is the focus window or an inferior.</td></tr><tr valign="top"><td valign="top">"state"</td><td valign="top">Read/Write</td><td valign="top">A bit-mask representing the state of the modifier
keys (e.g. <span><b class="keycap">Control</b></span>, <span><b class="keycap">Shift</b></span> and
<span><b class="keycap">Alt</b></span>) and the pointer buttons.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect2" lang="en"><a name="id2960718"></a><h3><tt class="literal">gtk.gdk.FOCUS_CHANGE</tt></h3><div class="blockquote"><table width="100%" border="0" bgcolor="#E0E0E0"><tr><td valign="top"><div class="informaltable"><table cellpadding="5" width="100%" border="0"><colgroup><col><col><col></colgroup><tbody><tr valign="top"><td valign="top">"in_"</td><td valign="top">Read/Write</td><td valign="top"><tt class="literal">TRUE</tt> if the window has gained the
keyboard focus, <tt class="literal">FALSE</tt> if it has lost the focus.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect2" lang="en"><a name="id2990658"></a><h3><tt class="literal">gtk.gdk.CONFIGURE</tt></h3><div class="blockquote"><table width="100%" border="0" bgcolor="#E0E0E0"><tr><td valign="top"><div class="informaltable"><table cellpadding="5" width="100%" border="0"><colgroup><col><col><col></colgroup><tbody><tr valign="top"><td valign="top">"x"</td><td valign="top">Read/Write</td><td valign="top">The new x coordinate of the window relative to its
parent.</td></tr><tr valign="top"><td valign="top">"y"</td><td valign="top">Read/Write</td><td valign="top">The new y coordinate of the window relative to its
parent.</td></tr><tr valign="top"><td valign="top">"width"</td><td valign="top">Read/Write</td><td valign="top">The new width of the window.</td></tr><tr valign="top"><td valign="top">"height"</td><td valign="top">Read/Write</td><td valign="top">The new height of the window.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect2" lang="en"><a name="id2976661"></a><h3><tt class="literal">gtk.gdk.PROPERTY_NOTIFY</tt></h3><div class="blockquote"><table width="100%" border="0" bgcolor="#E0E0E0"><tr><td valign="top"><div class="informaltable"><table cellpadding="5" width="100%" border="0"><colgroup><col><col><col></colgroup><tbody><tr valign="top"><td valign="top">"atom"</td><td valign="top">Read</td><td valign="top">The property that was changed.</td></tr><tr valign="top"><td valign="top">"time"</td><td valign="top">Read/Write</td><td valign="top">The time of the event in milliseconds.</td></tr><tr valign="top"><td valign="top">"state"</td><td valign="top">Read/Write</td><td valign="top">The property was changed
(<tt class="literal">gtk.gdk.PROPERTY_NEW_VALUE</tt>) or deleted
(<tt class="literal">gtk.gdk.PROPERTY_DELETE</tt>).</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect2" lang="en"><a name="id2985330"></a><h3><tt class="literal">gtk.gdk.SELECTION_CLEAR</tt></h3><h3><tt class="literal">gtk.gdk.SELECTION_REQUEST</tt></h3><h3><tt class="literal">gtk.gdk.SELECTION_NOTIFY</tt></h3><div class="blockquote"><table width="100%" border="0" bgcolor="#E0E0E0"><tr><td valign="top"><div class="informaltable"><table cellpadding="5" width="100%" border="0"><colgroup><col><col><col></colgroup><tbody><tr valign="top"><td valign="top">"selection"</td><td valign="top">Read</td><td valign="top">The selection.</td></tr><tr valign="top"><td valign="top">"target"</td><td valign="top">Read</td><td valign="top">The target to which the selection should be
converted.</td></tr><tr valign="top"><td valign="top">"property"</td><td valign="top">Read</td><td valign="top">The property in which to place the result of the
conversion.</td></tr><tr valign="top"><td valign="top">"requestor"</td><td valign="top">Read/Write</td><td valign="top">the native window ID on which to place
property.</td></tr><tr valign="top"><td valign="top">"time"</td><td valign="top">Read/Write</td><td valign="top">The time of the event in milliseconds.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect2" lang="en"><a name="id3021934"></a><h3><tt class="literal">gtk.gdk.PROXIMITY_IN</tt></h3><h3><tt class="literal">gtk.gdk.PROXIMITY_OUT</tt></h3><div class="blockquote"><table width="100%" border="0" bgcolor="#E0E0E0"><tr><td valign="top"><div class="informaltable"><table cellpadding="5" width="100%" border="0"><colgroup><col><col><col></colgroup><tbody><tr valign="top"><td valign="top">"time"</td><td valign="top">Read/Write</td><td valign="top">The time of the event in milliseconds.</td></tr><tr valign="top"><td valign="top">"device"</td><td valign="top">Read/Write</td><td valign="top">The device where the event originated.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect2" lang="en"><a name="id2988418"></a><h3><tt class="literal">gtk.gdk.DRAG_ENTER</tt></h3><h3><tt class="literal">gtk.gdk.DRAG_LEAVE</tt></h3><h3><tt class="literal">gtk.gdk.DRAG_MOTION</tt></h3><h3><tt class="literal">gtk.gdk.DRAG_STATUS</tt></h3><h3><tt class="literal">gtk.gdk.DRAG_START</tt></h3><h3><tt class="literal">gtk.gdk.DRAG_FINISHED</tt></h3><div class="blockquote"><table width="100%" border="0" bgcolor="#E0E0E0"><tr><td valign="top"><div class="informaltable"><table cellpadding="5" width="100%" border="0"><colgroup><col><col><col></colgroup><tbody><tr valign="top"><td valign="top">"context"</td><td valign="top">Read</td><td valign="top">The <a href="class-gdkdragcontext.html" title="gtk.gdk.DragContext"><tt class="classname">gtk.gdk.DragContext</tt></a>
for the current DND operation.</td></tr><tr valign="top"><td valign="top">"time"</td><td valign="top">Read/Write</td><td valign="top">The time of the event in milliseconds.</td></tr><tr valign="top"><td valign="top">"x_root"</td><td valign="top">Read/Write</td><td valign="top">The x coordinate of the pointer relative to the root
of the screen only set for <tt class="literal">gtk.gdk.DRAG_MOTION</tt> and
<tt class="literal">gtk.gdk.DROP_START</tt>.</td></tr><tr valign="top"><td valign="top">"y_root"</td><td valign="top">Read/Write</td><td valign="top">The y coordinate of the pointer relative to the root
of the screen only set for <tt class="literal">gtk.gdk.DRAG_MOTION</tt> and
<tt class="literal">gtk.gdk.DROP_START</tt>.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect2" lang="en"><a name="id2860584"></a><h3><tt class="literal">gtk.gdk.CLIENT_EVENT</tt></h3><div class="blockquote"><table width="100%" border="0" bgcolor="#E0E0E0"><tr><td valign="top"><div class="informaltable"><table cellpadding="5" width="100%" border="0"><colgroup><col><col><col></colgroup><tbody><tr valign="top"><td valign="top">"message_type"</td><td valign="top">Read/Write</td><td valign="top">The type of the message, which can be defined by the
application.</td></tr><tr valign="top"><td valign="top">"data_format"</td><td valign="top">Read/Write</td><td valign="top">The format of the data, given as the number of bits
in each data element, i.e. 8, 16, or 32.</td></tr><tr valign="top"><td valign="top">"data"</td><td valign="top">Read/Write</td><td valign="top">The data as a string of 8-bit characters.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect2" lang="en"><a name="id2961742"></a><h3><tt class="literal">gtk.gdk.VISIBILITY_NOTIFY</tt></h3><div class="blockquote"><table width="100%" border="0" bgcolor="#E0E0E0"><tr><td valign="top"><div class="informaltable"><table cellpadding="5" width="100%" border="0"><colgroup><col><col><col></colgroup><tbody><tr valign="top"><td valign="top">"state"</td><td valign="top">Read/Write</td><td valign="top">The new visibility state
(<tt class="literal">gtk.gdk.VISIBILITY_FULLY_OBSCURED</tt>,
<tt class="literal">gtk.gdk.VISIBILITY_PARTIAL</tt> or
<tt class="literal">gtk.gdk.VISIBILITY_UNOBSCURED</tt>).</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect2" lang="en"><a name="id3021459"></a><h3><tt class="literal">gtk.gdk.SCROLL</tt></h3><div class="blockquote"><table width="100%" border="0" bgcolor="#E0E0E0"><tr><td valign="top"><div class="informaltable"><table cellpadding="5" width="100%" border="0"><colgroup><col><col><col></colgroup><tbody><tr valign="top"><td valign="top">"time"</td><td valign="top">Read/Write</td><td valign="top">The time of the event in milliseconds.</td></tr><tr valign="top"><td valign="top">"x"</td><td valign="top">Read/Write</td><td valign="top">The x coordinate of the pointer relative to the
window.</td></tr><tr valign="top"><td valign="top">"y"</td><td valign="top">Read/Write</td><td valign="top">The y coordinate of the pointer relative to the
window.</td></tr><tr valign="top"><td valign="top">"state"</td><td valign="top">Read/Write</td><td valign="top">A bit-mask representing the state of the modifier
keys (e.g. <span><b class="keycap">Control</b></span>, <span><b class="keycap">Shift</b></span> and
<span><b class="keycap">Alt</b></span>) and the pointer buttons.</td></tr><tr valign="top"><td valign="top">"direction"</td><td valign="top">Read/Write</td><td valign="top">The direction to scroll to (one of
<tt class="literal">gtk.gdk.SCROLL_UP</tt>,
<tt class="literal">gtk.gdk.SCROLL_DOWN</tt>,
<tt class="literal">gtk.gdk.SCROLL_LEFT</tt> or
<tt class="literal">gtk.gdk.SCROLL_RIGHT</tt>).</td></tr><tr valign="top"><td valign="top">"device"</td><td valign="top">Read</td><td valign="top">The device where the event originated.</td></tr><tr valign="top"><td valign="top">"x_root"</td><td valign="top">Read/Write</td><td valign="top">The x coordinate of the pointer relative to the root
of the screen.</td></tr><tr valign="top"><td valign="top">"y_root"</td><td valign="top">Read/Write</td><td valign="top">The y coordinate of the pointer relative to the root
of the screen.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect2" lang="en"><a name="id3001154"></a><h3><tt class="literal">gtk.gdk.WINDOW_STATE</tt></h3><div class="blockquote"><table width="100%" border="0" bgcolor="#E0E0E0"><tr><td valign="top"><div class="informaltable"><table cellpadding="5" width="100%" border="0"><colgroup><col><col><col></colgroup><tbody><tr valign="top"><td valign="top">"changed_mask"</td><td valign="top">Read/Write</td><td valign="top">The mask specifying what flags have changed - a
combination of: <tt class="literal">gtk.gdk.WINDOW_STATE_WITHDRAWN</tt>,
<tt class="literal">gtk.gdk.WINDOW_STATE_ICONIFIED</tt>,
<tt class="literal">gtk.gdk.WINDOW_STATE_MAXIMIZED</tt> and
<tt class="literal">gtk.gdk.WINDOW_STATE_STICKY</tt></td></tr><tr valign="top"><td valign="top">"new_window_state"</td><td valign="top">Read/Write</td><td valign="top">The new window state - a combination of:
<tt class="literal">gtk.gdk.WINDOW_STATE_WITHDRAWN</tt>,
<tt class="literal">gtk.gdk.WINDOW_STATE_ICONIFIED</tt>,
<tt class="literal">gtk.gdk.WINDOW_STATE_MAXIMIZED</tt> and
<tt class="literal">gtk.gdk.WINDOW_STATE_STICKY</tt></td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect2" lang="en"><a name="id3028348"></a><h3><tt class="literal">gtk.gdk.SETTING</tt></h3><div class="blockquote"><table width="100%" border="0" bgcolor="#E0E0E0"><tr><td valign="top"><div class="informaltable"><table cellpadding="5" width="100%" border="0"><colgroup><col><col><col></colgroup><tbody><tr valign="top"><td valign="top">"action"</td><td valign="top">Read/Write</td><td valign="top">What happened to the setting
(<tt class="literal">gtk.gdk.SETTING_ACTION_NEW</tt>,
<tt class="literal">gtk.gdk.SETTING_ACTION_CHANGED</tt> or
<tt class="literal">gtk.gdk.SETTING_ACTION_DELETED</tt>).</td></tr><tr valign="top"><td valign="top">"name"</td><td valign="top">Read/Write</td><td valign="top">The name of the setting.</td></tr></tbody></table></div></td></tr></table></div></div><p></p></div><div class="refsect1" lang="en"><a name="description-gdkevent"></a><h2>Description</h2><p>A <a href="class-gdkevent.html" title="gtk.gdk.Event"><tt class="classname">gtk.gdk.Event</tt></a> represents an event from the windowing system. The <a href="class-gdkevent.html" title="gtk.gdk.Event"><tt class="classname">gtk.gdk.Event</tt></a> methods are usually not used by applications since the <tt class="literal">PyGTK</tt> main loop generates signals and invokes the appropriate signal handler. The event types are:</p><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><tt class="literal">gtk.gdk.NOTHING</tt></span></td><td>a special code to indicate a null event.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.DELETE</tt></span></td><td>the window manager has requested that the toplevel window be hidden or destroyed, usually when the user clicks on a special icon in the title bar.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.DESTROY</tt></span></td><td>the window has been destroyed.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.EXPOSE</tt></span></td><td>all or part of the window has become visible and needs to be redrawn.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.MOTION_NOTIFY</tt></span></td><td>the pointer (usually a mouse) has moved.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.BUTTON_PRESS</tt></span></td><td>a mouse button has been pressed.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk._2BUTTON_PRESS</tt></span></td><td>a mouse button has been double-clicked (clicked twice within a short period of time). Note that each click also generates a <tt class="literal">gtk.gdk.BUTTON_PRESS</tt> event.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk._3BUTTON_PRESS</tt></span></td><td>a mouse button has been clicked 3 times in a short period of time. Note that each click also generates a <tt class="literal">gtk.gdk.BUTTON_PRESS</tt> event.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.BUTTON_RELEASE</tt></span></td><td>a mouse button has been released.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.KEY_PRESS</tt></span></td><td>a key has been pressed.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.KEY_RELEASE</tt></span></td><td>a key has been released.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.ENTER_NOTIFY</tt></span></td><td>the pointer has entered the window.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.LEAVE_NOTIFY</tt></span></td><td>the pointer has left the window.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.FOCUS_CHANGE</tt></span></td><td>the keyboard focus has entered or left the window.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.CONFIGURE</tt></span></td><td>the size, position or stacking order of the window has changed. Note that <tt class="literal">PyGTK</tt> discards these events for <tt class="literal">gtk.gdk.WINDOW_CHILD</tt> windows.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.MAP</tt></span></td><td>the window has been mapped.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.UNMA</tt></span></td><td>the window has been unmapped.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.PROPERTY_NOTIFY</tt></span></td><td>a property on the window has been changed or deleted.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.SELECTION_CLEAR</tt></span></td><td>the application has lost ownership of a selection.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.SELECTION_REQUEST</tt></span></td><td>another application has requested a selection.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.SELECTION_NOTIFY</tt></span></td><td>a selection has been received.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.PROXIMITY_IN</tt></span></td><td>an input device has moved into contact with a sensing surface (e.g. a touchscreen or graphics tablet).</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.PROXIMITY_OUT</tt></span></td><td>an input device has moved out of contact with a sensing surface.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.DRAG_ENTER</tt></span></td><td>the mouse has entered the window while a drag is in progress.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.DRAG_LEAVE</tt></span></td><td>the mouse has left the window while a drag is in progress</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.DRAG_MOTION</tt></span></td><td>the mouse has moved in the window while a drag is in progress.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.DRAG_STATUS</tt></span></td><td>the status of the drag operation initiated by the window has changed.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.DROP_START</tt></span></td><td>a drop operation onto the window has started.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.DROP_FINISHED</tt></span></td><td>the drop operation initiated by the window has completed.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.CLIENT_EVENT</tt></span></td><td>a message has been received from another application.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.VISIBILITY_NOTIFY</tt></span></td><td>the window visibility status has changed.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.NO_EXPOSE</tt></span></td><td>indicates that the source region was completely available when parts of a drawable were copied. This is not very useful.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.SCROLL</tt></span></td><td>a scroll had occurred for a window</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.WINDOW_STATE</tt></span></td><td>the window state has changed</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.SETTING</tt></span></td><td>a setting has changed</td></tr></tbody></table><p>A set of bit-flags is used to indicate which events a window is to
receive. Most of these masks map onto one or more of the event types
above.</p><p>The <tt class="literal">gtk.gdk.POINTER_MOTION_HINT_MASK</tt> is a
special mask which is used to reduce the number of
<tt class="literal">gtk.gdk.MOTION_NOTIFY</tt> events received. Normally a
<tt class="literal">gtk.gdk.MOTION_NOTIFY</tt> event is received each time the
mouse moves. However, if the application spends a lot of time processing the
event (updating the display, for example), it can easily lag behind the
position of the mouse. When using the
<tt class="literal">gtk.gdk.POINTER_MOTION_HINT_MASK</tt> the server will only
send a single <tt class="literal">gtk.gdk.MOTION_NOTIFY</tt> event (which is
marked as a hint) until the application asks for more, by calling the <a href="class-gdkwindow.html#method-gdkwindow--get-pointer" title="gtk.gdk.Window.get_pointer"><tt class="methodname">gtk.gdk.Window.get_pointer</tt>()</a>
method. The masks are:</p><div class="itemizedlist"><ul type="disc"><li><tt class="literal">gtk.gdk.EXPOSURE_MASK</tt></li><li><tt class="literal">gtk.gdk.POINTER_MOTION_MASK</tt></li><li><tt class="literal">gtk.gdk.POINTER_MOTION_HINT_MASK</tt></li><li><tt class="literal">gtk.gdk.BUTTON_MOTION_MASK</tt></li><li><tt class="literal">gtk.gdk.BUTTON1_MOTION_MASK</tt></li><li><tt class="literal">gtk.gdk.BUTTON2_MOTION_MASK</tt></li><li><tt class="literal">gtk.gdk.BUTTON3_MOTION_MASK</tt></li><li><tt class="literal">gtk.gdk.BUTTON_PRESS_MASK</tt></li><li><tt class="literal">gtk.gdk.BUTTON_RELEASE_MASK</tt></li><li><tt class="literal">gtk.gdk.KEY_PRESS_MASK</tt></li><li><tt class="literal">gtk.gdk.KEY_RELEASE_MASK</tt></li><li><tt class="literal">gtk.gdk.ENTER_NOTIFY_MASK</tt></li><li><tt class="literal">gtk.gdk.LEAVE_NOTIFY_MASK</tt></li><li><tt class="literal">gtk.gdk.FOCUS_CHANGE_MASK</tt></li><li><tt class="literal">gtk.gdk.STRUCTURE_MASK</tt></li><li><tt class="literal">gtk.gdk.PROPERTY_CHANGE_MASK</tt></li><li><tt class="literal">gtk.gdk.VISIBILITY_NOTIFY_MASK</tt></li><li><tt class="literal">gtk.gdk.PROXIMITY_IN_MASK</tt></li><li><tt class="literal">gtk.gdk.PROXIMITY_OUT_MASK</tt></li><li><tt class="literal">gtk.gdk.SUBSTRUCTURE_MASK</tt></li><li><tt class="literal">gtk.gdk.SCROLL_MASK</tt></li><li><tt class="literal">gtk.gdk.ALL_EVENTS_MASK</tt></li></ul></div><p><tt class="literal">gtk.gdk.ALL_EVENTS_MASK</tt> is a combination of all
the event masks.</p></div><div class="refsect1" lang="en"><a name="constructor-gdkevent"></a><h2>Constructor</h2><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="constructorsynopsis"> <span class="methodname">gtk.gdk.Event</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>type</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><i class="parameter"><tt>type</tt></i>:</span></td><td>a
event type - see the <a href="class-gdkevent.html#description-gdkevent" title="Description">Description</a>
above</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>a newly-allocated <a href="class-gdkevent.html" title="gtk.gdk.Event"><tt class="classname">gtk.gdk.Event</tt></a>. The
returned <a href="class-gdkevent.html" title="gtk.gdk.Event"><tt class="classname">gtk.gdk.Event</tt></a>
should be freed with <a href="class-gdkevent.html#method-gdkevent--free" title="gtk.gdk.Event.free"><tt class="methodname">gtk.gdk.Event.free()</tt></a>.</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This constructor is available in PyGTK 2.2 and above.</p></div><p>Creates a new <a href="class-gdkevent.html" title="gtk.gdk.Event"><tt class="classname">gtk.gdk.Event</tt></a> of the
given type. All fields are set to 0.</p></div><div class="refsect1" lang="en"><a name="id2964048"></a><h2>Methods</h2><div class="refsect2" lang="en"><a name="method-gdkevent--put"></a><h3>gtk.gdk.Event.put</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">put</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><p>The <tt class="methodname">put</tt>() method appends a copy of the
given event onto the tail of the event queue.</p></div><div class="refsect2" lang="en"><a name="method-gdkevent--copy"></a><h3>gtk.gdk.Event.copy</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">copy</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>a copy of the event</td></tr></tbody></table><p>The <tt class="methodname">copy</tt>() method copies the event,
copying or incrementing the reference count of the resources associated with
it (e.g. windows and strings). The new <a href="class-gdkevent.html" title="gtk.gdk.Event"><tt class="classname">gtk.gdk.Event</tt></a> must be
freed with the <a href="class-gdkevent.html#method-gdkevent--free" title="gtk.gdk.Event.free"><tt class="methodname">free</tt>()</a>
method.</p></div><div class="refsect2" lang="en"><a name="method-gdkevent--free"></a><h3>gtk.gdk.Event.free</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">free</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><p>The <tt class="methodname">free</tt>() method frees the event,
freeing or decrementing any resources associated with it. Note that this
method should only be called on <a href="class-gdkevent.html" title="gtk.gdk.Event"><tt class="classname">gtk.gdk.Event</tt></a> objects
returned from methods or functions such as <a href="class-gdkevent.html#function-gdk--event-peek" title="gtk.gdk.event_peek"><tt class="methodname">gtk.gdk.event_peek</tt>()</a>,
<a href="class-gdkevent.html#function-gdk--event-get" title="gtk.gdk.event_get"><tt class="methodname">gtk.gdk.event_get</tt>()</a>,
<a href="class-gdkevent.html#function-gdk--event-get-graphics-expose" title="gtk.gdk.event_get_graphics_expose"><tt class="methodname">gtk.gdk.event_get_graphics_expose</tt>()</a>
and <a href="class-gdkevent.html#method-gdkevent--copy" title="gtk.gdk.Event.copy"><tt class="methodname">copy</tt>()</a>.</p></div><div class="refsect2" lang="en"><a name="method-gdkevent--get-time"></a><h3>gtk.gdk.Event.get_time</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_time</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>the time stamp field from the
event</td></tr></tbody></table><p>The <tt class="methodname">get_time</tt>() method returns the time
stamp from the event, if there is one; otherwise returns 0.</p></div><div class="refsect2" lang="en"><a name="method-gdkevent--get-state"></a><h3>gtk.gdk.Event.get_state</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_state</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>the modifier state</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <tt class="methodname">get_state</tt>() method returns the
value of the modifier "state" field. If the event has no "state" field the
empty state value (0) is returned. The "state" field contains a modifier
type: a combination of:</p><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><tt class="literal">gtk.gdk.SHIFT_MASK</tt></span></td><td>The Shift key.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.LOCK_MASK</tt></span></td><td>A Lock key (depending on the modifier mapping of the X
server this may either be CapsLock or ShiftLock).</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.CONTROL_MASK</tt></span></td><td>The Control key. </td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.MOD1_MASK</tt></span></td><td>The fourth modifier key (it depends on the modifier
mapping of the X server which key is interpreted as this modifier, but
normally it is the Alt key).</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.MOD2_MASK</tt></span></td><td>The fifth modifier key (it depends on the modifier
mapping of the X server which key is interpreted as this
modifier).</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.MOD3_MASK</tt></span></td><td>The sixth modifier key (it depends on the modifier
mapping of the X server which key is interpreted as this
modifier).</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.MOD4_MASK</tt></span></td><td>The seventh modifier key (it depends on the modifier
mapping of the X server which key is interpreted as this
modifier).</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.MOD5_MASK</tt></span></td><td>The eighth modifier key (it depends on the modifier
mapping of the X server which key is interpreted as this
modifier).</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.BUTTON1_MASK</tt></span></td><td>The first mouse button.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.BUTTON2_MASK</tt></span></td><td>The second mouse button.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.BUTTON3_MASK</tt></span></td><td>The third mouse button.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.BUTTON4_MASK</tt></span></td><td>The fourth mouse button.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.BUTTON5_MASK</tt></span></td><td>The fifth mouse button.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.RELEASE_MASK</tt></span></td><td>Differentiates between (keyval, modifiers) pairs from
key press and release events.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.MODIFIER_MASK</tt></span></td><td>all of the above</td></tr></tbody></table><p></p></div><div class="refsect2" lang="en"><a name="id2974175"></a><h3><tt class="literal">gtk.gdk.NOTHING</tt></h3><h3><tt class="literal">gtk.gdk.DELETE</tt></h3><h3><tt class="literal">gtk.gdk.DESTROY</tt></h3><h3><tt class="literal">gtk.gdk.MAP</tt></h3><h3><tt class="literal">gtk.gdk.UNMAP</tt></h3><h3><tt class="literal">gtk.gdk.NO_EXPOSE</tt></h3><div class="blockquote"><blockquote class="blockquote"><p>These events does not have any additional attributes.</p></blockquote></div></div><div class="refsect2" lang="en"><a name="method-gdkevent--get-coords"></a><h3>gtk.gdk.Event.get_coords</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_coords</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>a tuple containing the event window x and y
coordinates or an empty tuple if the event did not deliver event window
coordinates</td></tr></tbody></table><p>The <tt class="methodname">get_coords</tt>() method returns a tuple
containing the x and y coordinates of an event relative to the event <a href="class-gdkwindow.html" title="gtk.gdk.Window"><tt class="classname">gtk.gdk.Window</tt></a> or an
empty tuple if the event did not deliver event window coordinates.</p></div><div class="refsect2" lang="en"><a name="method-gdkevent--get-root-coords"></a><h3>gtk.gdk.Event.get_root_coords</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_root_coords</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>a tuple containing the root window x and y
coordinates or an empty tuple if the event did not deliver root window
coordinates</td></tr></tbody></table><p>The <tt class="methodname">get_root_coords</tt>() method returns a
tuple containing the x and y coordinates from an event relative to the root
window or an empty tuple if the event did not deliver root window
coordinates.</p></div><div class="refsect2" lang="en"><a name="method-gdkevent--get-axis"></a><h3>gtk.gdk.Event.get_axis</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_axis</span>(<span class="methodparam"><span class="parameter"><i class="parameter"><tt>axis_use</tt></i></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><i class="parameter"><tt>axis_use</tt></i>:</span></td><td>the axis use to look for</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>the value found or <tt class="literal">None</tt> if
the axis was not found.</td></tr></tbody></table><p>The <tt class="methodname">get_axis</tt>() method returns the axis
value for the axis use specified by <i class="parameter"><tt>axis_use</tt></i> from an
event structure. The value of <i class="parameter"><tt>axis_use</tt></i> must be one
of:</p><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><tt class="literal">gtk.gdk.AXIS_IGNORE</tt></span></td><td>the axis is ignored.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.AXIS_X</tt></span></td><td>the axis is used as the x axis.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.AXIS_Y</tt></span></td><td>the axis is used as the y axis.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.AXIS_PRESSURE</tt></span></td><td>the axis is used for pressure information.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.AXIS_XTILT</tt></span></td><td>the axis is used for x tilt information.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.AXIS_YTILT</tt></span></td><td>the axis is used for y tilt information.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.AXIS_WHEEL</tt></span></td><td>the axis is used for wheel information.</td></tr><tr><td><span class="term"><tt class="literal">gtk.gdk.AXIS_LAST</tt></span></td><td>a constant equal to the numerically highest axis
value.</td></tr></tbody></table><p>If an axis with the specified axis use is not found, this method
returns <tt class="literal">None</tt>.</p></div><div class="refsect2" lang="en"><a name="method-gdkevent--set-screen"></a><h3>gtk.gdk.Event.set_screen</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_screen</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>screen</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>screen</tt></b>:</span></td><td>a <a href="class-gdkscreen.html" title="gtk.gdk.Screen"><tt class="classname">gtk.gdk.Screen</tt></a></td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.2 and above.</p></div><p>The <tt class="methodname">set_screen</tt>() method sets the <a href="class-gdkscreen.html" title="gtk.gdk.Screen"><tt class="classname">gtk.gdk.Screen</tt></a> to
the value of <i class="parameter"><tt>screen</tt></i>. The event must have been
allocated by <tt class="literal">PyGTK</tt>, for instance, by the <a href="class-gdkevent.html#method-gdkevent--copy" title="gtk.gdk.Event.copy"><tt class="methodname">gtk.gdk.Event.copy()</tt></a>
method.</p></div><div class="refsect2" lang="en"><a name="method-gdkevent--get-screen"></a><h3>gtk.gdk.Event.get_screen</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_screen</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>the screen for the event</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.2 and above.</p></div><p>The <tt class="methodname">get_screen</tt>() method returns the
<a href="class-gdkscreen.html" title="gtk.gdk.Screen"><tt class="classname">gtk.gdk.Screen</tt></a>
for the event. The screen is typically the screen for the event window, but
for events such as mouse events, it is the screen where the the pointer was
when the event occurs - that is, the screen that has the root window for the
event.</p></div></div><div class="refsect1" lang="en"><a name="id2928446"></a><h2>Functions</h2><div class="refsect2" lang="en"><a name="function-gdk--events-pending"></a><h3>gtk.gdk.events_pending</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.gdk.events_pending</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td><tt class="literal">TRUE</tt> if any events are
pending</td></tr></tbody></table><p>The <tt class="function">gtk.gdk.events_pending</tt>() function
returns <tt class="literal">TRUE</tt> if any events are ready to be
processed.</p></div><div class="refsect2" lang="en"><a name="function-gdk--event-peek"></a><h3>gtk.gdk.event_peek</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.gdk.event_peek</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>a copy of the first <a href="class-gdkevent.html" title="gtk.gdk.Event"><tt class="classname">gtk.gdk.Event</tt></a> on the
event queue or <tt class="literal">None</tt> if there is no event in the
queue.</td></tr></tbody></table><p>The <tt class="function">gtk.gdk.event_peek</tt>() function returns a
copy of the first <a href="class-gdkevent.html" title="gtk.gdk.Event"><tt class="classname">gtk.gdk.Event</tt></a> on the
event queue or <tt class="literal">None</tt> if there is no event on the event
queue. The returned <a href="class-gdkevent.html" title="gtk.gdk.Event"><tt class="classname">gtk.gdk.Event</tt></a> should
be freed with the <a href="class-gdkevent.html#method-gdkevent--free" title="gtk.gdk.Event.free"><tt class="methodname">free</tt>()</a>
method.</p></div><div class="refsect2" lang="en"><a name="function-gdk--event-get"></a><h3>gtk.gdk.event_get</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.gdk.event_get</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>the next <a href="class-gdkevent.html" title="gtk.gdk.Event"><tt class="classname">gtk.gdk.Event</tt></a> to be
processed, or <tt class="literal">None</tt> if no events are
pending.</td></tr></tbody></table><p>The <tt class="function">gtk.gdk.event_get</tt>() function returns
the next <a href="class-gdkevent.html" title="gtk.gdk.Event"><tt class="classname">gtk.gdk.Event</tt></a> to be
processed or <tt class="literal">None</tt> if no events are available. The
returned <a href="class-gdkevent.html" title="gtk.gdk.Event"><tt class="classname">gtk.gdk.Event</tt></a> should
be freed using the <a href="class-gdkevent.html#method-gdkevent--free" title="gtk.gdk.Event.free"><tt class="methodname">free</tt>()</a>
method.</p></div><div class="refsect2" lang="en"><a name="function-gdk--event-get-graphics-expose"></a><h3>gtk.gdk.event_get_graphics_expose</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.gdk.event_get_graphics_expose</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>window</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>window</tt></b>:</span></td><td>a <a href="class-gdkwindow.html" title="gtk.gdk.Window"><tt class="classname">gtk.gdk.Window</tt></a></td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>an expose <a href="class-gdkevent.html" title="gtk.gdk.Event"><tt class="classname">gtk.gdk.Event</tt></a> if a
<tt class="literal">GraphicsExpose</tt> was received, or <tt class="literal">None</tt>
if a <tt class="literal">NoExpose</tt> event was received.</td></tr></tbody></table><p>The <tt class="function">gtk.gdk.event_get_graphics_expose</tt>()
function waits for and returns returns an expose <a href="class-gdkevent.html" title="gtk.gdk.Event"><tt class="classname">gtk.gdk.Event</tt></a> if a
<tt class="literal">GraphicsExpose</tt> was received, or <tt class="literal">None</tt>
if a <tt class="literal">NoExpose</tt> event was received.</p></div><div class="refsect2" lang="en"><a name="function-gdk--set-show-events"></a><h3>gtk.gdk.set_show_events</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.gdk.set_show_events</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>show_events</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>show_events</tt></b>:</span></td><td>if <tt class="literal">TRUE</tt> output event debug
information</td></tr></tbody></table><p>The <tt class="function">gtk.gdk.set_show_events</tt>() function sets
the debug events flag if <i class="parameter"><tt>show_events</tt></i> is
<tt class="literal">TRUE</tt>. Otherwise the debug events flag is unset.</p></div><div class="refsect2" lang="en"><a name="function-gdk--get-show-events"></a><h3>gtk.gdk.get_show_events</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.gdk.get_show_events</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td><tt class="literal">TRUE</tt> if the debug events
flag is set.</td></tr></tbody></table><p>The <tt class="function">gtk.gdk.get_show_events</tt>() function
returns the setting of the internal debug events flag.</p></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="class-gdkdrawable.html">Prev</a></td><td width="20%" align="center"><a accesskey="u" href="gdk-class-reference.html">Up</a></td><td width="40%" align="right"><a accesskey="n" href="class-gdkgc.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">gtk.gdk.Drawable</td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top">gtk.gdk.GC</td></tr></table></div></body></html>
|
