/usr/share/gtk-doc/html/pygtk/class-gdkevent.html is in python-gtk2-doc 2.24.0-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 | <html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>gtk.gdk.Event</title><link rel="stylesheet" href="style.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.75.2"><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="prev" 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" title="gtk.gdk.Event"><a name="class-gdkevent"></a><div class="titlepage"></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" title="Synopsis"><a name="id2930364"></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 class="link" href="class-gdkevent.html#constructor-gdkevent" title="Constructor">gtk.gdk.Event</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>type</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" 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 class="link" 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 class="link" 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 class="link" 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 class="link" href="class-gdkevent.html#method-gdkevent--get-state" title="gtk.gdk.Event.get_state">get_state</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>state</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" 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 class="link" 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 class="link" href="class-gdkevent.html#method-gdkevent--get-axis" title="gtk.gdk.Event.get_axis">get_axis</a></span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>axis_use</code></em></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gdkevent.html#method-gdkevent--set-screen" title="gtk.gdk.Event.set_screen">set_screen</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>screen</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" 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><pre class="programlisting">
<span class="bold"><strong>Functions</strong></span>
<code class="methodsynopsis"> def <span class="methodname"><a class="link" 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 class="link" 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"><em class="parameter"><code></code></em></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" 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"><em class="parameter"><code></code></em></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" 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"><strong class="parameter"><code>window</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" 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"><strong class="parameter"><code>show_events</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" 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"><em class="parameter"><code></code></em></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gdkevent.html#function-gdk--event-handler-set" title="gtk.gdk.event_handler_set">gtk.gdk.event_handler_set</a></span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>func</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>data</code></em></span><span class="initializer">=None</span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gdkevent.html#function-gdk--event-request-motions" title="gtk.gdk.event_request_motions">gtk.gdk.event_request_motions</a></span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>event</code></em></span></span>)</code></pre></div><div class="refsect1" title="Attributes"><a name="id3175054"></a><h2>Attributes</h2><p>The attributes available for a <a class="link" href="class-gdkevent.html" title="gtk.gdk.Event"><code class="classname">gtk.gdk.Event</code></a> are
dependent on the type of the event. The event types are described in the
<a class="link" href="class-gdkevent.html#description-gdkevent" title="Description">Description</a> section.</p><div class="refsect2" title="gtk.gdk.NOTHING"><a name="id3257200"></a><h3><code class="literal">gtk.gdk.NOTHING</code></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 width="1in"><col width="1in"><col width="4in"></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 class="link" 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 class="link" href="class-gdkwindow.html" title="gtk.gdk.Window"><code class="classname">gtk.gdk.Window</code></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"><code class="literal">True</code> if the event was sent
explicitly.</td></tr></tbody></table></div></td></tr></table></div><p>Contain only the fields that are common to all event
types.</p></div><div class="refsect2" title="gtk.gdk.EXPOSE"><a name="id3315809"></a><h3><code class="literal">gtk.gdk.EXPOSE</code></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 width="1in"><col width="1in"><col width="4in"></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 class="link" 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 class="link" href="class-gdkwindow.html" title="gtk.gdk.Window"><code class="classname">gtk.gdk.Window</code></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"><code class="literal">True</code> if the event was sent
explicitly.</td></tr><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
<code class="literal">PyGTK</code> performs some exposure compression so this is not
normally needed.</td></tr></tbody></table></div></td></tr></table></div><p>Generated when all or part of a window becomes visible and needs
to be redrawn.</p></div><div class="refsect2" title="gtk.gdk.MOTION_NOTIFY"><a name="id3322064"></a><h3><code class="literal">gtk.gdk.MOTION_NOTIFY</code></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 width="1in"><col width="1in"><col width="4in"></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 class="link" 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 class="link" href="class-gdkwindow.html" title="gtk.gdk.Window"><code class="classname">gtk.gdk.Window</code></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"><code class="literal">True</code> if the event was sent
explicitly.</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">"axes"</td><td valign="top">Read</td><td valign="top"><em class="parameter"><code>x</code></em>, <em class="parameter"><code>y</code></em>
translated to the axes of <em class="parameter"><code>device</code></em>, or
<code class="literal">None</code> if <em class="parameter"><code>device</code></em> 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 class="keycap"><strong>Control</strong></span>, <span class="keycap"><strong>Shift</strong></span> and
<span class="keycap"><strong>Alt</strong></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"><code class="literal">True</code> if the
<code class="literal">gdk.POINTER_MOTION_HINT_MASK</code> 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><p>Generated when the pointer moves.</p></div><div class="refsect2" title="gtk.gdk.BUTTON_PRESS"><a name="id3180065"></a><h3><code class="literal">gtk.gdk.BUTTON_PRESS</code></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 width="1in"><col width="1in"><col width="4in"></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 class="link" 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 class="link" href="class-gdkwindow.html" title="gtk.gdk.Window"><code class="classname">gtk.gdk.Window</code></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"><code class="literal">True</code> if the event was sent
explicitly.</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">"axes"</td><td valign="top">Read</td><td valign="top"><em class="parameter"><code>x</code></em>, <em class="parameter"><code>y</code></em>
translated to the axes of <em class="parameter"><code>device</code></em>, or
<code class="literal">None</code> if <em class="parameter"><code>device</code></em> 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 class="keycap"><strong>Control</strong></span>, <span class="keycap"><strong>Shift</strong></span> and
<span class="keycap"><strong>Alt</strong></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><p>Used for button press and button release events.</p><p>Double and triple-clicks result in a sequence of events being
received. For double-clicks the order of events will be:</p><div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><code class="literal">gtk.gdk.BUTTON_PRESS</code></li><li class="listitem"><code class="literal">gtk.gdk.BUTTON_RELEASE</code></li><li class="listitem"><code class="literal">gtk.gdk.BUTTON_PRESS</code></li><li class="listitem"><code class="literal">gtk.gdk._2BUTTON_PRESS</code></li><li class="listitem"><code class="literal">gtk.gdk.BUTTON_RELEASE</code></li></ol></div><p>Note that the first click is received just like a normal button
press, while the second click results in a
<code class="literal">gtk.gdk._2BUTTON_PRESS</code> being received just after the
<code class="literal">gtk.gdk.BUTTON_PRESS</code>.</p><p>Triple-clicks are very similar to double-clicks, except that
<code class="literal">gtk.gdk._3BUTTON_PRESS</code> is inserted after the third
click. The order of the events is:</p><div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><code class="literal">gtk.gdk.BUTTON_PRESS</code></li><li class="listitem"><code class="literal">gtk.gdk.BUTTON_RELEASE</code></li><li class="listitem"><code class="literal">gtk.gdk.BUTTON_PRESS</code></li><li class="listitem"><code class="literal">gtk.gdk._2BUTTON_PRESS</code></li><li class="listitem"><code class="literal">gtk.gdk.BUTTON_RELEASE</code></li><li class="listitem"><code class="literal">gtk.gdk.BUTTON_PRESS</code></li><li class="listitem"><code class="literal">gtk.gdk._3BUTTON_PRESS</code></li><li class="listitem"><code class="literal">gtk.gdk.BUTTON_RELEASE</code></li></ol></div><p>For a double click to occur, the second button press must occur
within 1/4 of a second of the first. For a triple click to occur, the
third button press must also occur within 1/2 second of the first
button press.</p></div><div class="refsect2" title="gtk.gdk.KEY_PRESS"><a name="id2905326"></a><h3><code class="literal">gtk.gdk.KEY_PRESS</code></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 width="1in"><col width="1in"><col width="4in"></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 class="link" 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 class="link" href="class-gdkwindow.html" title="gtk.gdk.Window"><code class="classname">gtk.gdk.Window</code></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"><code class="literal">True</code> if the event was sent
explicitly.</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">A bit-mask representing the state of the modifier
keys (e.g. <span class="keycap"><strong>Control</strong></span>, <span class="keycap"><strong>Shift</strong></span> and
<span class="keycap"><strong>Alt</strong></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 class="link" href="class-gtkentry.html" title="gtk.Entry"><code class="classname">gtk.Entry</code></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><p>Generated for a key press or key release event.</p></div><div class="refsect2" title="gtk.gdk.ENTER_NOTIFY"><a name="id2893462"></a><h3><code class="literal">gtk.gdk.ENTER_NOTIFY</code></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 width="1in"><col width="1in"><col width="4in"></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 class="link" 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 class="link" href="class-gdkwindow.html" title="gtk.gdk.Window"><code class="classname">gtk.gdk.Window</code></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"><code class="literal">True</code> if the event was sent
explicitly.</td></tr><tr valign="top"><td valign="top">"subwindow"</td><td valign="top">Read/Write</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
(<code class="literal">gtk.gdk.CROSSING_NORMAL</code>,
<code class="literal">gtk.gdk.CROSSING_GRAB</code> or
<code class="literal">gtk.gdk.CROSSING_UNGRAB</code>).</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
(<code class="literal">gtk.gdk.NOTIFY_INFERIOR</code>,
<code class="literal">gtk.gdk.NOTIFY_ANCESTOR</code>,
<code class="literal">gtk.gdk.NOTIFY_VIRTUAL</code>,
<code class="literal">gtk.gdk.NOTIFY_NONLINEAR</code> or
<code class="literal">gtk.gdk.NOTIFY_NONLINEAR_VIRTUAL</code>).</td></tr><tr valign="top"><td valign="top">"focus"</td><td valign="top">Read/Write</td><td valign="top"><code class="literal">True</code> if
<em class="parameter"><code>window</code></em> 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 class="keycap"><strong>Control</strong></span>, <span class="keycap"><strong>Shift</strong></span> and
<span class="keycap"><strong>Alt</strong></span>) and the pointer buttons.</td></tr></tbody></table></div></td></tr></table></div><p>Generated when the pointer enters or leaves a window.</p></div><div class="refsect2" title="gtk.gdk.FOCUS_CHANGE"><a name="id2967342"></a><h3><code class="literal">gtk.gdk.FOCUS_CHANGE</code></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 width="1in"><col width="1in"><col width="4in"></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 class="link" 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 class="link" href="class-gdkwindow.html" title="gtk.gdk.Window"><code class="classname">gtk.gdk.Window</code></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"><code class="literal">True</code> if the event was sent
explicitly.</td></tr><tr valign="top"><td valign="top">"in_"</td><td valign="top">Read/Write</td><td valign="top"><code class="literal">True</code> if the window has gained the
keyboard focus, <code class="literal">False</code> if it has lost the focus.</td></tr></tbody></table></div></td></tr></table></div><p>Describes a change of keyboard focus.</p></div><div class="refsect2" title="gtk.gdk.CONFIGURE"><a name="id2894385"></a><h3><code class="literal">gtk.gdk.CONFIGURE</code></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 width="1in"><col width="1in"><col width="4in"></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 class="link" 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 class="link" href="class-gdkwindow.html" title="gtk.gdk.Window"><code class="classname">gtk.gdk.Window</code></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"><code class="literal">True</code> if the event was sent
explicitly.</td></tr><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><p>Generated when a window size or position has changed.</p></div><div class="refsect2" title="gtk.gdk.PROPERTY_NOTIFY"><a name="id2930087"></a><h3><code class="literal">gtk.gdk.PROPERTY_NOTIFY</code></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 width="1in"><col width="1in"><col width="4in"></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 class="link" 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 class="link" href="class-gdkwindow.html" title="gtk.gdk.Window"><code class="classname">gtk.gdk.Window</code></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"><code class="literal">True</code> if the event was sent
explicitly.</td></tr><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
(<code class="literal">gtk.gdk.PROPERTY_NEW_VALUE</code>) or deleted
(<code class="literal">gtk.gdk.PROPERTY_DELETE</code>).</td></tr></tbody></table></div></td></tr></table></div><p>Describes a property change on a window.</p></div><div class="refsect2" title="gtk.gdk.SELECTION_CLEAR"><a name="id3025875"></a><h3><code class="literal">gtk.gdk.SELECTION_CLEAR</code></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 width="1in"><col width="1in"><col width="4in"></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 class="link" 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 class="link" href="class-gdkwindow.html" title="gtk.gdk.Window"><code class="classname">gtk.gdk.Window</code></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"><code class="literal">True</code> if the event was sent
explicitly.</td></tr><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><p>Generated when a selection is requested or ownership of a
selection is taken over by another client application.</p></div><div class="refsect2" title="gtk.gdk.PROXIMITY_IN"><a name="id2913639"></a><h3><code class="literal">gtk.gdk.PROXIMITY_IN</code></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 width="1in"><col width="1in"><col width="4in"></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 class="link" 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 class="link" href="class-gdkwindow.html" title="gtk.gdk.Window"><code class="classname">gtk.gdk.Window</code></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"><code class="literal">True</code> if the event was sent
explicitly.</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">"device"</td><td valign="top">Read</td><td valign="top">The device where the event originated.</td></tr></tbody></table></div></td></tr></table></div><p>Proximity events are generated when using GDK's wrapper for the
XInput extension. The XInput extension is an add-on for standard X
that allows you to use nonstandard devices such as graphics tablets. A
proximity event indicates that the stylus has moved in or out of
contact with the tablet, or perhaps that the user's finger has moved
in or out of contact with a touch screen.</p></div><div class="refsect2" title="gtk.gdk.DRAG_ENTER"><a name="id2893801"></a><h3><code class="literal">gtk.gdk.DRAG_ENTER</code></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 width="1in"><col width="1in"><col width="4in"></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 class="link" 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 class="link" href="class-gdkwindow.html" title="gtk.gdk.Window"><code class="classname">gtk.gdk.Window</code></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"><code class="literal">True</code> if the event was sent
explicitly.</td></tr><tr valign="top"><td valign="top">"context"</td><td valign="top">Read</td><td valign="top">The <a class="link" href="class-gdkdragcontext.html" title="gtk.gdk.DragContext"><code class="classname">gtk.gdk.DragContext</code></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 <code class="literal">gtk.gdk.DRAG_MOTION</code> and
<code class="literal">gtk.gdk.DROP_START</code>.</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 <code class="literal">gtk.gdk.DRAG_MOTION</code> and
<code class="literal">gtk.gdk.DROP_START</code>.</td></tr></tbody></table></div></td></tr></table></div><p>Generated during Drag and Drop operations.</p></div><div class="refsect2" title="gtk.gdk.CLIENT_EVENT"><a name="id2929529"></a><h3><code class="literal">gtk.gdk.CLIENT_EVENT</code></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 width="1in"><col width="1in"><col width="4in"></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 class="link" 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 class="link" href="class-gdkwindow.html" title="gtk.gdk.Window"><code class="classname">gtk.gdk.Window</code></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"><code class="literal">True</code> if the event was sent
explicitly.</td></tr><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><p>An event sent by another client application.</p></div><div class="refsect2" title="gtk.gdk.VISIBILITY_NOTIFY"><a name="id3336724"></a><h3><code class="literal">gtk.gdk.VISIBILITY_NOTIFY</code></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 width="1in"><col width="1in"><col width="4in"></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 class="link" 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 class="link" href="class-gdkwindow.html" title="gtk.gdk.Window"><code class="classname">gtk.gdk.Window</code></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"><code class="literal">True</code> if the event was sent
explicitly.</td></tr><tr valign="top"><td valign="top">"state"</td><td valign="top">Read/Write</td><td valign="top">The new visibility state
(<code class="literal">gtk.gdk.VISIBILITY_FULLY_OBSCURED</code>,
<code class="literal">gtk.gdk.VISIBILITY_PARTIAL</code> or
<code class="literal">gtk.gdk.VISIBILITY_UNOBSCURED</code>).</td></tr></tbody></table></div></td></tr></table></div><p>Generated when the window visibility status has changed.</p></div><div class="refsect2" title="gtk.gdk.SCROLL"><a name="id3208489"></a><h3><code class="literal">gtk.gdk.SCROLL</code></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 width="1in"><col width="1in"><col width="4in"></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 class="link" 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 class="link" href="class-gdkwindow.html" title="gtk.gdk.Window"><code class="classname">gtk.gdk.Window</code></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"><code class="literal">True</code> if the event was sent
explicitly.</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">"state"</td><td valign="top">Read/Write</td><td valign="top">A bit-mask representing the state of the modifier
keys (e.g. <span class="keycap"><strong>Control</strong></span>, <span class="keycap"><strong>Shift</strong></span> and
<span class="keycap"><strong>Alt</strong></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
<code class="literal">gtk.gdk.SCROLL_UP</code>,
<code class="literal">gtk.gdk.SCROLL_DOWN</code>,
<code class="literal">gtk.gdk.SCROLL_LEFT</code> or
<code class="literal">gtk.gdk.SCROLL_RIGHT</code>).</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><p>Generated from button presses for the buttons 4 to 7. Wheel mice
are usually configured to generate button press events for buttons 4
and 5 when the wheel is turned.</p></div><div class="refsect2" title="gtk.gdk.WINDOW_STATE"><a name="id2914311"></a><h3><code class="literal">gtk.gdk.WINDOW_STATE</code></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 width="1in"><col width="1in"><col width="4in"></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 class="link" 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 class="link" href="class-gdkwindow.html" title="gtk.gdk.Window"><code class="classname">gtk.gdk.Window</code></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"><code class="literal">True</code> if the event was sent
explicitly.</td></tr><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: <code class="literal">gtk.gdk.WINDOW_STATE_WITHDRAWN</code>,
<code class="literal">gtk.gdk.WINDOW_STATE_ICONIFIED</code>,
<code class="literal">gtk.gdk.WINDOW_STATE_MAXIMIZED</code> and
<code class="literal">gtk.gdk.WINDOW_STATE_STICKY</code></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:
<code class="literal">gtk.gdk.WINDOW_STATE_WITHDRAWN</code>,
<code class="literal">gtk.gdk.WINDOW_STATE_ICONIFIED</code>,
<code class="literal">gtk.gdk.WINDOW_STATE_MAXIMIZED</code> and
<code class="literal">gtk.gdk.WINDOW_STATE_STICKY</code></td></tr></tbody></table></div></td></tr></table></div><p>Generated when the state of a toplevel window changes.</p></div><div class="refsect2" title="gtk.gdk.SETTING"><a name="id2909473"></a><h3><code class="literal">gtk.gdk.SETTING</code></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 width="1in"><col width="1in"><col width="4in"></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 class="link" 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 class="link" href="class-gdkwindow.html" title="gtk.gdk.Window"><code class="classname">gtk.gdk.Window</code></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"><code class="literal">True</code> if the event was sent
explicitly.</td></tr><tr valign="top"><td valign="top">"action"</td><td valign="top">Read/Write</td><td valign="top">What happened to the setting
(<code class="literal">gtk.gdk.SETTING_ACTION_NEW</code>,
<code class="literal">gtk.gdk.SETTING_ACTION_CHANGED</code> or
<code class="literal">gtk.gdk.SETTING_ACTION_DELETED</code>).</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><p>Generated when a setting is modified.</p></div><div class="refsect2" title="gtk.gdk.OWNER_CHANGE"><a name="id2921467"></a><h3><code class="literal">gtk.gdk.OWNER_CHANGE</code></h3><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This Event type is available in PyGTK 2.8 and above.</p></div><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 width="1in"><col width="1in"><col width="4in"></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 class="link" 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 class="link" href="class-gdkwindow.html" title="gtk.gdk.Window"><code class="classname">gtk.gdk.Window</code></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"><code class="literal">True</code> if the event was sent
explicitly.</td></tr><tr valign="top"><td valign="top">"owner"</td><td valign="top">Read/Write</td><td valign="top">the new owner of the selection - the native window
ID as an integer</td></tr><tr valign="top"><td valign="top">"reason"</td><td valign="top">Read/Write</td><td valign="top">the reason for the ownership change indicated by one
of the <a class="xref" href="gdk-constants.html#gdk-owner-change-constants" title="GDK Owner Change Constants">GDK Owner Change Constants</a>.</td></tr><tr valign="top"><td valign="top">"selection"</td><td valign="top">Read</td><td valign="top">the atom identifying the selection</td></tr><tr valign="top"><td valign="top">"time"</td><td valign="top">Read/Write</td><td valign="top">the timestamp of the event</td></tr><tr valign="top"><td valign="top">"selection_time"</td><td valign="top">Read/Write</td><td valign="top">the time at which the selection ownership was taken
over</td></tr></tbody></table></div></td></tr></table></div><p>Generated when the owner of a selection changes. On X11, this
information is only available if the X server supports the XFIXES
extension.</p></div><div class="refsect2" title="gtk.gdk.GRAB_BROKEN"><a name="id2915230"></a><h3><code class="literal">gtk.gdk.GRAB_BROKEN</code></h3><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This Event type is available in PyGTK 2.8 and above.</p></div><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 width="1in"><col width="1in"><col width="4in"></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 class="link" 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 class="link" href="class-gdkwindow.html" title="gtk.gdk.Window"><code class="classname">gtk.gdk.Window</code></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"><code class="literal">True</code> if the event was sent
explicitly.</td></tr><tr valign="top"><td valign="top">"keyboard"</td><td valign="top">Read/Write</td><td valign="top">if <code class="literal">True</code> a keyboard grab was
broken; if <code class="literal">False</code> a pointer grab was
broken</td></tr><tr valign="top"><td valign="top">"implicit"</td><td valign="top">Read/Write</td><td valign="top">if True the broken grab was implicit</td></tr><tr valign="top"><td valign="top">"grab_window"</td><td valign="top">Read</td><td valign="top">If this event is caused by another grab in the same
application, <em class="parameter"><code>grab_window</code></em> contains the
new grab window. Otherwise
<em class="parameter"><code>grab_window</code></em> is
<code class="literal">None</code>.</td></tr></tbody></table></div></td></tr></table></div><p>Generated when a pointer or keyboard grab is broken. On X11,
this happens when the grab window becomes unviewable (i.e. it or one
of its ancestors is unmapped), or if the same application grabs the
pointer or keyboard again. Note that implicit grabs (which are
initiated by button presses) can also cause
<code class="literal">gtk.gdk.GRAB_BROKEN</code> events.</p></div><p></p></div><div class="refsect1" title="Description"><a name="description-gdkevent"></a><h2>Description</h2><p>A <a class="link" href="class-gdkevent.html" title="gtk.gdk.Event"><code class="classname">gtk.gdk.Event</code></a>
represents an event from the windowing system. The <a class="link" href="class-gdkevent.html" title="gtk.gdk.Event"><code class="classname">gtk.gdk.Event</code></a>
methods are usually not used by applications since the
<code class="literal">PyGTK</code> 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><p><span class="term"><code class="literal">gtk.gdk.NOTHING</code></span></p></td><td>a special code to indicate a null event.</td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.DELETE</code></span></p></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><p><span class="term"><code class="literal">gtk.gdk.DESTROY</code></span></p></td><td>the window has been destroyed.</td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.EXPOSE</code></span></p></td><td>all or part of the window has become visible and needs to be redrawn.</td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.MOTION_NOTIFY</code></span></p></td><td>the pointer (usually a mouse) has moved.</td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.BUTTON_PRESS</code></span></p></td><td>a mouse button has been pressed.</td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk._2BUTTON_PRESS</code></span></p></td><td>a mouse button has been double-clicked (clicked twice within a short period of time). Note that each click also generates a <code class="literal">gtk.gdk.BUTTON_PRESS</code> event.</td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk._3BUTTON_PRESS</code></span></p></td><td>a mouse button has been clicked 3 times in a short period of time. Note that each click also generates a <code class="literal">gtk.gdk.BUTTON_PRESS</code> event.</td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.BUTTON_RELEASE</code></span></p></td><td>a mouse button has been released.</td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.KEY_PRESS</code></span></p></td><td>a key has been pressed.</td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.KEY_RELEASE</code></span></p></td><td>a key has been released.</td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.ENTER_NOTIFY</code></span></p></td><td>the pointer has entered the window.</td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.LEAVE_NOTIFY</code></span></p></td><td>the pointer has left the window.</td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.FOCUS_CHANGE</code></span></p></td><td>the keyboard focus has entered or left the window.</td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.CONFIGURE</code></span></p></td><td>the size, position or stacking order of the window has changed. Note that <code class="literal">PyGTK</code> discards these events for <code class="literal">gtk.gdk.WINDOW_CHILD</code> windows.</td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.MAP</code></span></p></td><td>the window has been mapped.</td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.UNMA</code></span></p></td><td>the window has been unmapped.</td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.PROPERTY_NOTIFY</code></span></p></td><td>a property on the window has been changed or deleted.</td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.SELECTION_CLEAR</code></span></p></td><td>the application has lost ownership of a selection.</td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.SELECTION_REQUEST</code></span></p></td><td>another application has requested a selection.</td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.SELECTION_NOTIFY</code></span></p></td><td>a selection has been received.</td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.PROXIMITY_IN</code></span></p></td><td>an input device has moved into contact with a sensing surface (e.g. a touchscreen or graphics tablet).</td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.PROXIMITY_OUT</code></span></p></td><td>an input device has moved out of contact with a sensing surface.</td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.DRAG_ENTER</code></span></p></td><td>the mouse has entered the window while a drag is in progress.</td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.DRAG_LEAVE</code></span></p></td><td>the mouse has left the window while a drag is in progress</td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.DRAG_MOTION</code></span></p></td><td>the mouse has moved in the window while a drag is in progress.</td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.DRAG_STATUS</code></span></p></td><td>the status of the drag operation initiated by the window has changed.</td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.DROP_START</code></span></p></td><td>a drop operation onto the window has started.</td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.DROP_FINISHED</code></span></p></td><td>the drop operation initiated by the window has completed.</td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.CLIENT_EVENT</code></span></p></td><td>a message has been received from another application.</td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.VISIBILITY_NOTIFY</code></span></p></td><td>the window visibility status has changed.</td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.NO_EXPOSE</code></span></p></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><p><span class="term"><code class="literal">gtk.gdk.SCROLL</code></span></p></td><td>a scroll had occurred for a window</td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.WINDOW_STATE</code></span></p></td><td>the window state has changed</td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.SETTING</code></span></p></td><td>a setting has changed</td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.OWNER_CHANGE</code></span></p></td><td>the owner of a selection has changed. Added in GTK+
2.6</td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.GRAB_BROKEN</code></span></p></td><td>a pointer or keyboard grab was broken. Added in GTK+
2.8.</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. Use the <a class="link" href="class-gtkwidget.html#method-gtkwidget--set-events" title="gtk.Widget.set_events"><code class="methodname">gtk.Widget.set_events</code>()</a>
method to indicate which events a widget should receive.</p><p>The <code class="literal">gtk.gdk.POINTER_MOTION_HINT_MASK</code> is a
special mask which is used to reduce the number of
<code class="literal">gtk.gdk.MOTION_NOTIFY</code> events received. Normally a
<code class="literal">gtk.gdk.MOTION_NOTIFY</code> 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
<code class="literal">gtk.gdk.POINTER_MOTION_HINT_MASK</code> the server will only
send a single <code class="literal">gtk.gdk.MOTION_NOTIFY</code> event (which is
marked as a hint) until the application asks for more, by calling the <a class="link" href="class-gdkwindow.html#method-gdkwindow--get-pointer" title="gtk.gdk.Window.get_pointer"><code class="methodname">gtk.gdk.Window.get_pointer</code>()</a>
method. The masks are:</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><code class="literal">gtk.gdk.EXPOSURE_MASK</code></li><li class="listitem"><code class="literal">gtk.gdk.POINTER_MOTION_MASK</code></li><li class="listitem"><code class="literal">gtk.gdk.POINTER_MOTION_HINT_MASK</code></li><li class="listitem"><code class="literal">gtk.gdk.BUTTON_MOTION_MASK</code></li><li class="listitem"><code class="literal">gtk.gdk.BUTTON1_MOTION_MASK</code></li><li class="listitem"><code class="literal">gtk.gdk.BUTTON2_MOTION_MASK</code></li><li class="listitem"><code class="literal">gtk.gdk.BUTTON3_MOTION_MASK</code></li><li class="listitem"><code class="literal">gtk.gdk.BUTTON_PRESS_MASK</code></li><li class="listitem"><code class="literal">gtk.gdk.BUTTON_RELEASE_MASK</code></li><li class="listitem"><code class="literal">gtk.gdk.KEY_PRESS_MASK</code></li><li class="listitem"><code class="literal">gtk.gdk.KEY_RELEASE_MASK</code></li><li class="listitem"><code class="literal">gtk.gdk.ENTER_NOTIFY_MASK</code></li><li class="listitem"><code class="literal">gtk.gdk.LEAVE_NOTIFY_MASK</code></li><li class="listitem"><code class="literal">gtk.gdk.FOCUS_CHANGE_MASK</code></li><li class="listitem"><code class="literal">gtk.gdk.STRUCTURE_MASK</code></li><li class="listitem"><code class="literal">gtk.gdk.PROPERTY_CHANGE_MASK</code></li><li class="listitem"><code class="literal">gtk.gdk.VISIBILITY_NOTIFY_MASK</code></li><li class="listitem"><code class="literal">gtk.gdk.PROXIMITY_IN_MASK</code></li><li class="listitem"><code class="literal">gtk.gdk.PROXIMITY_OUT_MASK</code></li><li class="listitem"><code class="literal">gtk.gdk.SUBSTRUCTURE_MASK</code></li><li class="listitem"><code class="literal">gtk.gdk.SCROLL_MASK</code></li><li class="listitem"><code class="literal">gtk.gdk.ALL_EVENTS_MASK</code></li></ul></div><p><code class="literal">gtk.gdk.ALL_EVENTS_MASK</code> is a combination of all
the event masks.</p><p>
Starting with PyGTK 2.14 <code class="classname">gtk.gdk.Event</code> objects have custom
support for <code class="function">repr</code> Python function. Text representation will
include event type and a few most important event attributes,
e.g. <code class="literal">x</code>, <code class="literal">y</code> and <code class="literal">button</code>
for <code class="literal">gtk.gdk.BUTTON_PRESS</code> events. However, round-tripping
through <code class="literal">eval(repr(event))</code> is not possible: representation string
uses <code class="literal"><...></code> form.
</p></div><div class="refsect1" title="Constructor"><a name="constructor-gdkevent"></a><h2>Constructor</h2><pre class="programlisting"><code class="constructorsynopsis"> <span class="methodname">gtk.gdk.Event</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>type</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td><td>a
event type - see the <a class="link" href="class-gdkevent.html#description-gdkevent" title="Description">Description</a>
above</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a newly-allocated <a class="link" href="class-gdkevent.html" title="gtk.gdk.Event"><code class="classname">gtk.gdk.Event</code></a>.</td></tr></tbody></table><div class="note" title="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 class="link" href="class-gdkevent.html" title="gtk.gdk.Event"><code class="classname">gtk.gdk.Event</code></a> of the
given type. All fields are set to 0.</p></div><div class="refsect1" title="Methods"><a name="id3426688"></a><h2>Methods</h2><div class="refsect2" title="gtk.gdk.Event.put"><a name="method-gdkevent--put"></a><h3>gtk.gdk.Event.put</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">put</span>(<span class="methodparam"></span>)</code></pre><p>The <code class="methodname">put</code>() method appends a copy of the
given event onto the tail of the event queue.</p></div><div class="refsect2" title="gtk.gdk.Event.copy"><a name="method-gdkevent--copy"></a><h3>gtk.gdk.Event.copy</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">copy</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a copy of the event</td></tr></tbody></table><p>The <code class="methodname">copy</code>() method copies the event,
copying or incrementing the reference count of the resources
associated with it (e.g. windows and strings).</p></div><div class="refsect2" title="gtk.gdk.Event.free"><a name="method-gdkevent--free"></a><h3>gtk.gdk.Event.free</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">free</span>(<span class="methodparam"></span>)</code></pre><div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Warning</h3><p>This method is deprecated and should not be used since it may
crash your application.</p></div><p>The <code class="methodname">free</code>() method frees the event,
freeing or decrementing any resources associated with it. Note that this
method should only be called on <a class="link" href="class-gdkevent.html" title="gtk.gdk.Event"><code class="classname">gtk.gdk.Event</code></a> objects
returned from methods or functions such as <a class="link" href="class-gdkevent.html#function-gdk--event-peek" title="gtk.gdk.event_peek"><code class="methodname">gtk.gdk.event_peek</code>()</a>,
<a class="link" href="class-gdkevent.html#function-gdk--event-get" title="gtk.gdk.event_get"><code class="methodname">gtk.gdk.event_get</code>()</a>,
<a class="link" href="class-gdkevent.html#function-gdk--event-get-graphics-expose" title="gtk.gdk.event_get_graphics_expose"><code class="methodname">gtk.gdk.event_get_graphics_expose</code>()</a>
and <a class="link" href="class-gdkevent.html#method-gdkevent--copy" title="gtk.gdk.Event.copy"><code class="methodname">copy</code>()</a>.</p></div><div class="refsect2" title="gtk.gdk.Event.get_time"><a name="method-gdkevent--get-time"></a><h3>gtk.gdk.Event.get_time</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_time</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the time stamp field from the
event</td></tr></tbody></table><p>The <code class="methodname">get_time</code>() method returns the time
stamp from the event, if there is one; otherwise returns 0.</p></div><div class="refsect2" title="gtk.gdk.Event.get_state"><a name="method-gdkevent--get-state"></a><h3>gtk.gdk.Event.get_state</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_state</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the modifier state</td></tr></tbody></table><div class="note" title="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 <code class="methodname">get_state</code>() 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 the <a class="xref" href="gdk-constants.html#gdk-modifier-constants" title="GDK Modifier Constants">GDK Modifier Constants</a>.</p></div><div class="refsect2" title="gtk.gdk.NOTHING"><a name="id3167114"></a><h3><code class="literal">gtk.gdk.NOTHING</code></h3><div class="blockquote"><blockquote class="blockquote"><p>These events do not have any additional attributes.</p></blockquote></div></div><div class="refsect2" title="gtk.gdk.Event.get_coords"><a name="method-gdkevent--get-coords"></a><h3>gtk.gdk.Event.get_coords</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_coords</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></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 <code class="methodname">get_coords</code>() method returns a tuple
containing the x and y coordinates of an event relative to the event <a class="link" href="class-gdkwindow.html" title="gtk.gdk.Window"><code class="classname">gtk.gdk.Window</code></a> or an
empty tuple if the event did not deliver event window coordinates.</p></div><div class="refsect2" title="gtk.gdk.Event.get_root_coords"><a name="method-gdkevent--get-root-coords"></a><h3>gtk.gdk.Event.get_root_coords</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_root_coords</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></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 <code class="methodname">get_root_coords</code>() 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" title="gtk.gdk.Event.get_axis"><a name="method-gdkevent--get-axis"></a><h3>gtk.gdk.Event.get_axis</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_axis</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>axis_use</code></em></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><em class="parameter"><code>axis_use</code></em> :</span></p></td><td>the axis use to look for</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the value found or <code class="literal">None</code> if
the axis was not found.</td></tr></tbody></table><p>The <code class="methodname">get_axis</code>() method returns the axis
value for the axis use specified by <em class="parameter"><code>axis_use</code></em> from an
event structure. The value of <em class="parameter"><code>axis_use</code></em> must be one
of:</p><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><code class="literal">gtk.gdk.AXIS_IGNORE</code></span></p></td><td>the axis is ignored.</td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.AXIS_X</code></span></p></td><td>the axis is used as the x axis.</td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.AXIS_Y</code></span></p></td><td>the axis is used as the y axis.</td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.AXIS_PRESSURE</code></span></p></td><td>the axis is used for pressure information.</td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.AXIS_XTILT</code></span></p></td><td>the axis is used for x tilt information.</td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.AXIS_YTILT</code></span></p></td><td>the axis is used for y tilt information.</td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.AXIS_WHEEL</code></span></p></td><td>the axis is used for wheel information.</td></tr><tr><td><p><span class="term"><code class="literal">gtk.gdk.AXIS_LAST</code></span></p></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 <code class="literal">None</code>.</p></div><div class="refsect2" title="gtk.gdk.Event.set_screen"><a name="method-gdkevent--set-screen"></a><h3>gtk.gdk.Event.set_screen</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_screen</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>screen</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>screen</code></strong> :</span></p></td><td>a <a class="link" href="class-gdkscreen.html" title="gtk.gdk.Screen"><code class="classname">gtk.gdk.Screen</code></a></td></tr></tbody></table><div class="note" title="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 <code class="methodname">set_screen</code>() method sets the <a class="link" href="class-gdkscreen.html" title="gtk.gdk.Screen"><code class="classname">gtk.gdk.Screen</code></a> to
the value of <em class="parameter"><code>screen</code></em>. The event must have been
allocated by <code class="literal">PyGTK</code>, for instance, by the <a class="link" href="class-gdkevent.html#method-gdkevent--copy" title="gtk.gdk.Event.copy"><code class="methodname">gtk.gdk.Event.copy()</code></a>
method.</p></div><div class="refsect2" title="gtk.gdk.Event.get_screen"><a name="method-gdkevent--get-screen"></a><h3>gtk.gdk.Event.get_screen</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_screen</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the screen for the event</td></tr></tbody></table><div class="note" title="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 <code class="methodname">get_screen</code>() method returns the
<a class="link" href="class-gdkscreen.html" title="gtk.gdk.Screen"><code class="classname">gtk.gdk.Screen</code></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" title="Functions"><a name="id3310898"></a><h2>Functions</h2><div class="refsect2" title="gtk.gdk.events_pending"><a name="function-gdk--events-pending"></a><h3>gtk.gdk.events_pending</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.gdk.events_pending</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td><code class="literal">True</code> if any events are
pending</td></tr></tbody></table><p>The <code class="function">gtk.gdk.events_pending</code>() function
returns <code class="literal">True</code> if any events are ready to be
processed.</p></div><div class="refsect2" title="gtk.gdk.event_peek"><a name="function-gdk--event-peek"></a><h3>gtk.gdk.event_peek</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.gdk.event_peek</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a copy of the first <a class="link" href="class-gdkevent.html" title="gtk.gdk.Event"><code class="classname">gtk.gdk.Event</code></a> on the
event queue or <code class="literal">None</code> if there is no event in the
queue.</td></tr></tbody></table><p>The <code class="function">gtk.gdk.event_peek</code>() function returns a
copy of the first <a class="link" href="class-gdkevent.html" title="gtk.gdk.Event"><code class="classname">gtk.gdk.Event</code></a> on the
event queue or <code class="literal">None</code> if there is no event on the event
queue.</p></div><div class="refsect2" title="gtk.gdk.event_get"><a name="function-gdk--event-get"></a><h3>gtk.gdk.event_get</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.gdk.event_get</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the next <a class="link" href="class-gdkevent.html" title="gtk.gdk.Event"><code class="classname">gtk.gdk.Event</code></a> to be
processed, or <code class="literal">None</code> if no events are
pending.</td></tr></tbody></table><p>The <code class="function">gtk.gdk.event_get</code>() function returns
the next <a class="link" href="class-gdkevent.html" title="gtk.gdk.Event"><code class="classname">gtk.gdk.Event</code></a> to be
processed or <code class="literal">None</code> if no events are available.</p></div><div class="refsect2" title="gtk.gdk.event_get_graphics_expose"><a name="function-gdk--event-get-graphics-expose"></a><h3>gtk.gdk.event_get_graphics_expose</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.gdk.event_get_graphics_expose</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>window</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>window</code></strong> :</span></p></td><td>a <a class="link" href="class-gdkwindow.html" title="gtk.gdk.Window"><code class="classname">gtk.gdk.Window</code></a></td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>an expose <a class="link" href="class-gdkevent.html" title="gtk.gdk.Event"><code class="classname">gtk.gdk.Event</code></a> if a
<code class="literal">GraphicsExpose</code> was received, or <code class="literal">None</code>
if a <code class="literal">NoExpose</code> event was received.</td></tr></tbody></table><p>The <code class="function">gtk.gdk.event_get_graphics_expose</code>()
function waits for and returns returns an expose <a class="link" href="class-gdkevent.html" title="gtk.gdk.Event"><code class="classname">gtk.gdk.Event</code></a> if a
<code class="literal">GraphicsExpose</code> was received, or <code class="literal">None</code>
if a <code class="literal">NoExpose</code> event was received.</p></div><div class="refsect2" title="gtk.gdk.set_show_events"><a name="function-gdk--set-show-events"></a><h3>gtk.gdk.set_show_events</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.gdk.set_show_events</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>show_events</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>show_events</code></strong> :</span></p></td><td>if <code class="literal">True</code> output event debug
information</td></tr></tbody></table><p>The <code class="function">gtk.gdk.set_show_events</code>() function sets
the debug events flag if <em class="parameter"><code>show_events</code></em> is
<code class="literal">True</code>. Otherwise the debug events flag is unset.</p></div><div class="refsect2" title="gtk.gdk.get_show_events"><a name="function-gdk--get-show-events"></a><h3>gtk.gdk.get_show_events</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.gdk.get_show_events</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td><code class="literal">True</code> if the debug events
flag is set.</td></tr></tbody></table><p>The <code class="function">gtk.gdk.get_show_events</code>() function
returns the setting of the internal debug events flag.</p></div><div class="refsect2" title="gtk.gdk.event_handler_set"><a name="function-gdk--event-handler-set"></a><h3>gtk.gdk.event_handler_set</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.gdk.event_handler_set</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>func</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>data</code></em></span><span class="initializer">=None</span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><em class="parameter"><code>func</code></em> :</span></p></td><td> the function to call to handle events from GDK
or <code class="literal">None</code>.</td></tr><tr><td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td><td> user data to pass to the function.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This function is available in PyGTK 2.10 and above.</p></div><p>The <code class="function">gtk.gdk.event_handler_set</code>() function
specifies <em class="parameter"><code>func</code></em> as the function to call to
handle all events from GDK. <em class="parameter"><code>data</code></em> is the
optional user data to pass to <em class="parameter"><code>func</code></em>.</p><p>The signature of <em class="parameter"><code>func</code></em> is:</p><pre class="programlisting">
def func(event, user_data):
</pre><p>where <em class="parameter"><code>event</code></em> is the <a class="link" href="class-gdkevent.html" title="gtk.gdk.Event"><code class="classname">gtk.gdk.Event</code></a>
and <em class="parameter"><code>user_data</code></em> is
<em class="parameter"><code>data</code></em>.</p></div><div class="refsect2" title="gtk.gdk.event_request_motions"><a name="function-gdk--event-request-motions"></a><h3>gtk.gdk.event_request_motions</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.gdk.event_request_motions</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>event</code></em></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><em class="parameter"><code>event</code></em> :</span></p></td><td>a valid <a class="link" href="class-gdkevent.html" title="gtk.gdk.Event"><code class="classname">gtk.gdk.Event</code></a>
</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This function is available in PyGTK 2.12 and above.</p></div><p>The <code class="function">gtk.gdk.event_request_motions</code>() function
request more motion notifies if event is a motion notify hint event.
This function should be used instead of <code class="methodname"><a class="link" href="class-gdkwindow.html#method-gdkwindow--get-pointer" title="gtk.gdk.Window.get_pointer">gtk.gdk.Window.get_pointer</a></code>() to
request further motion notifies, because it also works for extension
events where motion notifies are provided for devices other than the core pointer.
</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>
|