1
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2
<html xmlns="http://www.w3.org/1999/xhtml">
4
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5
<title>gtkmm: Gdk::Event Class Reference</title>
6
<link href="tabs.css" rel="stylesheet" type="text/css"/>
7
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
10
<!-- Generated by Doxygen 1.7.3 -->
13
<table cellspacing="0" cellpadding="0">
15
<tr style="height: 56px;">
16
<td style="padding-left: 0.5em;">
17
<div id="projectname">gtkmm <span id="projectnumber">2.24.2</span></div>
23
<div id="navrow1" class="tabs">
25
<li><a href="index.html"><span>Main Page</span></a></li>
26
<li><a href="pages.html"><span>Related Pages</span></a></li>
27
<li><a href="modules.html"><span>Modules</span></a></li>
28
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
29
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
32
<div id="navrow2" class="tabs2">
34
<li><a href="annotated.html"><span>Class List</span></a></li>
35
<li><a href="classes.html"><span>Class Index</span></a></li>
36
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
37
<li><a href="functions.html"><span>Class Members</span></a></li>
40
<div id="nav-path" class="navpath">
42
<li class="navelem"><a class="el" href="namespaceGdk.html">Gdk</a> </li>
43
<li class="navelem"><a class="el" href="classGdk_1_1Event.html">Event</a> </li>
49
<a href="#pub-methods">Public Member Functions</a> |
50
<a href="#pub-static-methods">Static Public Member Functions</a> |
51
<a href="#pro-attribs">Protected Attributes</a> |
52
<a href="#related">Related Functions</a> </div>
53
<div class="headertitle">
54
<h1>Gdk::Event Class Reference</h1> </div>
56
<div class="contents">
57
<!-- doxytag: class="Gdk::Event" -->
58
<p><a href="classGdk_1_1Event-members.html">List of all members.</a></p>
59
<table class="memberdecls">
60
<tr><td colspan="2"><h2><a name="pub-methods"></a>
61
Public Member Functions</h2></td></tr>
62
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1Event.html#ae03c66bcd189f44073891575592b7677">Event</a> ()</td></tr>
63
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1Event.html#af5f1d2094cb30b218c337c29e0764925">Event</a> (GdkEvent* gobject, bool make_a_copy=true)</td></tr>
64
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1Event.html#a130915030025da8d1653506122c84385">Event</a> (const <a class="el" href="classGdk_1_1Event.html">Event</a>& other)</td></tr>
65
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classGdk_1_1Event.html">Event</a>& </td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1Event.html#abd217b33d80155460a6c5d6339f914bc">operator=</a> (const <a class="el" href="classGdk_1_1Event.html">Event</a>& other)</td></tr>
66
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1Event.html#aff6e2fdbf97ab2bd759b64652a86d8b2">~Event</a> ()</td></tr>
67
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1Event.html#ac46208ba6a7b2f61f486997146728f4c">swap</a> (<a class="el" href="classGdk_1_1Event.html">Event</a>& other)</td></tr>
68
<tr><td class="memItemLeft" align="right" valign="top">GdkEvent* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1Event.html#a21a5ddedef8a375f19412ce2d6c37d90">gobj</a> ()</td></tr>
69
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C instance. <a href="#a21a5ddedef8a375f19412ce2d6c37d90"></a><br/></td></tr>
70
<tr><td class="memItemLeft" align="right" valign="top">const GdkEvent* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1Event.html#a63e34d8c6300a5fe4939e4dc4fcbf440">gobj</a> () const </td></tr>
71
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C instance. <a href="#a63e34d8c6300a5fe4939e4dc4fcbf440"></a><br/></td></tr>
72
<tr><td class="memItemLeft" align="right" valign="top">GdkEvent* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1Event.html#a322551c2b247575997ef1e3bc498751a">gobj_copy</a> () const </td></tr>
73
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C instance. The caller is responsible for freeing it. Use when directly setting fields in structs. <a href="#a322551c2b247575997ef1e3bc498751a"></a><br/></td></tr>
74
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1Event.html#a7e9830470be83a7206db3a8c5436ef08">put</a> ()</td></tr>
75
<tr><td class="mdescLeft"> </td><td class="mdescRight">Appends a copy of the given event onto the front of the event queue for event->any.window's display, or the default event queue if event->any.window is <code>0</code>. <a href="#a7e9830470be83a7206db3a8c5436ef08"></a><br/></td></tr>
76
<tr><td class="memItemLeft" align="right" valign="top">guint32 </td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1Event.html#a6d785b16c3532cdcd0794d7d4161c40e">get_time</a> () const </td></tr>
77
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the time stamp from <em>event</em>, if there is one; otherwise returns Gdk::CURRENT_TIME. <a href="#a6d785b16c3532cdcd0794d7d4161c40e"></a><br/></td></tr>
78
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1Event.html#adcd60bfd108f761e7f52505eefddf7e7">get_state</a> (<a class="el" href="group__gdkmmEnums.html#ga734c2979005c87dbe51223a0128cdd97">ModifierType</a>& state) const </td></tr>
79
<tr><td class="mdescLeft"> </td><td class="mdescRight">If the event contains a "state" field, puts that field in <em>state</em>. <a href="#adcd60bfd108f761e7f52505eefddf7e7"></a><br/></td></tr>
80
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1Event.html#aa509fcaf5f106ca22379ccea781ceb06">get_coords</a> (double& x_win, double& y_win) const </td></tr>
81
<tr><td class="mdescLeft"> </td><td class="mdescRight">Extract the event window relative x/y coordinates from an event. <a href="#aa509fcaf5f106ca22379ccea781ceb06"></a><br/></td></tr>
82
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1Event.html#a08b20bab46fdea9b34b7e7c612110c69">get_root_coords</a> (double& x_root, double& y_root) const </td></tr>
83
<tr><td class="mdescLeft"> </td><td class="mdescRight">Extract the root window relative x/y coordinates from an event. <a href="#a08b20bab46fdea9b34b7e7c612110c69"></a><br/></td></tr>
84
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1Event.html#a647640a87ff5976a4ad442d86e7799cc">get_axis</a> (<a class="el" href="group__gdkmmEnums.html#gaa3ef1fe9ccf3e0e884578dba5a63feb7">AxisUse</a> axis_use, double&<a class="elRef" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01580.html#ga1c9e781d8d15a3814a601f471797c825">value</a>) const </td></tr>
85
<tr><td class="mdescLeft"> </td><td class="mdescRight">Extract the axis value for a particular axis use from an event structure. <a href="#a647640a87ff5976a4ad442d86e7799cc"></a><br/></td></tr>
86
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1Event.html#a2fc30fd4d95b4bf9f8f8a7f731fbba08">set_screen</a> (const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGdk_1_1Screen.html">Screen</a> >& screen)</td></tr>
87
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the screen for <em>event</em> to <em>screen</em>. <a href="#a2fc30fd4d95b4bf9f8f8a7f731fbba08"></a><br/></td></tr>
88
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGdk_1_1Screen.html">Screen</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1Event.html#a1a0386cc3586fc098ddb5feabc37226e">get_screen</a> ()</td></tr>
89
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the screen for the event. <a href="#a1a0386cc3586fc098ddb5feabc37226e"></a><br/></td></tr>
90
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< const <a class="el" href="classGdk_1_1Screen.html">Screen</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1Event.html#aea9ca52d43535409b3ee18ac6c18830e">get_screen</a> () const </td></tr>
91
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the screen for the event. <a href="#aea9ca52d43535409b3ee18ac6c18830e"></a><br/></td></tr>
92
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1Event.html#a47dcee1faab7a5c7b84561de153008c2">send_client_message</a> (<a class="el" href="namespaceGdk.html#abc645cff9ee57146245d4a5b4da7abac">NativeWindow</a> winid)</td></tr>
93
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sends an X ClientMessage event to a given window (which must be on the default <a class="el" href="classGdk_1_1Display.html" title="Gdk::Display object's purpose is two fold: To grab/ungrab keyboard focus and mouse pointer To man...">Gdk::Display</a>.) This could be used for communicating between different applications, though the amount of data is limited to 20 bytes. <a href="#a47dcee1faab7a5c7b84561de153008c2"></a><br/></td></tr>
94
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1Event.html#a0c11543ac2e244bcc98ffe5011732902">send_client_message</a> (const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGdk_1_1Display.html">Display</a> >& display, <a class="el" href="namespaceGdk.html#abc645cff9ee57146245d4a5b4da7abac">NativeWindow</a> winid)</td></tr>
95
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
96
Static Public Member Functions</h2></td></tr>
97
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classGdk_1_1Event.html">Event</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1Event.html#aeac82b61cdde5e8e6477f1835a5095de">get</a> ()</td></tr>
98
<tr><td class="mdescLeft"> </td><td class="mdescRight">Checks all open displays for a <a class="el" href="classGdk_1_1Event.html">Gdk::Event</a> to process,to be processed on, fetching events from the windowing system if necessary. <a href="#aeac82b61cdde5e8e6477f1835a5095de"></a><br/></td></tr>
99
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classGdk_1_1Event.html">Event</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1Event.html#ab3a63d0588191feb265efb712c46f411">peek</a> ()</td></tr>
100
<tr><td class="mdescLeft"> </td><td class="mdescRight">If there is an event waiting in the event queue of some open display, returns a copy of it. <a href="#ab3a63d0588191feb265efb712c46f411"></a><br/></td></tr>
101
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classGdk_1_1Event.html">Event</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1Event.html#a9a282af82acec6d3b6d233503cb85691">get_graphics_expose</a> (const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGdk_1_1Window.html">Window</a> >& window)</td></tr>
102
<tr><td class="mdescLeft"> </td><td class="mdescRight">Waits for a GraphicsExpose or NoExpose event from the X server. <a href="#a9a282af82acec6d3b6d233503cb85691"></a><br/></td></tr>
103
<tr><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1Event.html#ad3844a1151ae6549af4ac19f7abd41dd">events_pending</a> ()</td></tr>
104
<tr><td class="mdescLeft"> </td><td class="mdescRight">Checks if any events are ready to be processed for any display. <a href="#ad3844a1151ae6549af4ac19f7abd41dd"></a><br/></td></tr>
105
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1Event.html#aca840aa197d7ea9ea36c7e0061300607">set_show_events</a> (bool show_events)</td></tr>
106
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets whether a trace of received events is output. <a href="#aca840aa197d7ea9ea36c7e0061300607"></a><br/></td></tr>
107
<tr><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1Event.html#ac4498a06c7bdf8804f91af934e5d2b7a">get_show_events</a> ()</td></tr>
108
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets whether event debugging output is enabled. <a href="#ac4498a06c7bdf8804f91af934e5d2b7a"></a><br/></td></tr>
109
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
110
Protected Attributes</h2></td></tr>
111
<tr><td class="memItemLeft" align="right" valign="top">GdkEvent* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1Event.html#a297866c4cc91dbe6cacb3236361301a9">gobject_</a></td></tr>
112
<tr><td colspan="2"><h2><a name="related"></a>
113
Related Functions</h2></td></tr>
114
<tr><td colspan="2">(Note that these are not member functions.) <br/></td></tr>
115
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1Event.html#a5d74f5c6134933e244ca0bf21cdc4d91">swap</a> (<a class="el" href="classGdk_1_1Event.html">Event</a>& lhs, <a class="el" href="classGdk_1_1Event.html">Event</a>& rhs)</td></tr>
116
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classGdk_1_1Event.html">Gdk::Event</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1Event.html#a90bf6ff26dda59432c3ac822dde33098">wrap</a> (GdkEvent* object, bool take_copy=false)</td></tr>
117
<tr><td class="mdescLeft"> </td><td class="mdescRight">A <a class="elRef" href="../../../glibmm-2.4/reference/html/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. <a href="#a90bf6ff26dda59432c3ac822dde33098"></a><br/></td></tr>
119
<hr/><h2>Constructor & Destructor Documentation</h2>
120
<a class="anchor" id="ae03c66bcd189f44073891575592b7677"></a><!-- doxytag: member="Gdk::Event::Event" ref="ae03c66bcd189f44073891575592b7677" args="()" -->
121
<div class="memitem">
122
<div class="memproto">
123
<table class="memname">
125
<td class="memname">Gdk::Event::Event </td>
127
<td class="paramname"></td><td>)</td>
136
<a class="anchor" id="af5f1d2094cb30b218c337c29e0764925"></a><!-- doxytag: member="Gdk::Event::Event" ref="af5f1d2094cb30b218c337c29e0764925" args="(GdkEvent *gobject, bool make_a_copy=true)" -->
137
<div class="memitem">
138
<div class="memproto">
139
<table class="memname">
141
<td class="memname">Gdk::Event::Event </td>
143
<td class="paramtype">GdkEvent * </td>
144
<td class="paramname"><em>gobject</em>, </td>
147
<td class="paramkey"></td>
149
<td class="paramtype">bool </td>
150
<td class="paramname"><em>make_a_copy</em> = <code>true</code> </td>
155
<td></td><td><code> [explicit]</code></td>
163
<a class="anchor" id="a130915030025da8d1653506122c84385"></a><!-- doxytag: member="Gdk::Event::Event" ref="a130915030025da8d1653506122c84385" args="(const Event &other)" -->
164
<div class="memitem">
165
<div class="memproto">
166
<table class="memname">
168
<td class="memname">Gdk::Event::Event </td>
170
<td class="paramtype">const <a class="el" href="classGdk_1_1Event.html">Event</a>& </td>
171
<td class="paramname"><em>other</em></td><td>)</td>
180
<a class="anchor" id="aff6e2fdbf97ab2bd759b64652a86d8b2"></a><!-- doxytag: member="Gdk::Event::~Event" ref="aff6e2fdbf97ab2bd759b64652a86d8b2" args="()" -->
181
<div class="memitem">
182
<div class="memproto">
183
<table class="memname">
185
<td class="memname">Gdk::Event::~Event </td>
187
<td class="paramname"></td><td>)</td>
196
<hr/><h2>Member Function Documentation</h2>
197
<a class="anchor" id="ad3844a1151ae6549af4ac19f7abd41dd"></a><!-- doxytag: member="Gdk::Event::events_pending" ref="ad3844a1151ae6549af4ac19f7abd41dd" args="()" -->
198
<div class="memitem">
199
<div class="memproto">
200
<table class="memname">
202
<td class="memname">static bool Gdk::Event::events_pending </td>
204
<td class="paramname"></td><td>)</td>
205
<td><code> [static]</code></td>
211
<p>Checks if any events are ready to be processed for any display. </p>
212
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if any events are pending. </dd></dl>
216
<a class="anchor" id="aeac82b61cdde5e8e6477f1835a5095de"></a><!-- doxytag: member="Gdk::Event::get" ref="aeac82b61cdde5e8e6477f1835a5095de" args="()" -->
217
<div class="memitem">
218
<div class="memproto">
219
<table class="memname">
221
<td class="memname">static <a class="el" href="classGdk_1_1Event.html">Event</a> Gdk::Event::get </td>
223
<td class="paramname"></td><td>)</td>
224
<td><code> [static]</code></td>
230
<p>Checks all open displays for a <a class="el" href="classGdk_1_1Event.html">Gdk::Event</a> to process,to be processed on, fetching events from the windowing system if necessary. </p>
231
<p>See <a class="el" href="classGdk_1_1Display.html#a71ef8186ac0ebce17ab869eb77f5e9e7" title="Gets the next Gdk::Event to be processed for display, fetching events from the windowing system if ne...">Gdk::Display::get_event()</a>. </p>
232
<dl class="return"><dt><b>Returns:</b></dt><dd>The next <a class="el" href="classGdk_1_1Event.html">Gdk::Event</a> to be processed, or <code>0</code> if no events are pending. The returned <a class="el" href="classGdk_1_1Event.html">Gdk::Event</a> should be freed with free(). </dd></dl>
236
<a class="anchor" id="a647640a87ff5976a4ad442d86e7799cc"></a><!-- doxytag: member="Gdk::Event::get_axis" ref="a647640a87ff5976a4ad442d86e7799cc" args="(AxisUse axis_use, double &value) const " -->
237
<div class="memitem">
238
<div class="memproto">
239
<table class="memname">
241
<td class="memname">bool Gdk::Event::get_axis </td>
243
<td class="paramtype"><a class="el" href="group__gdkmmEnums.html#gaa3ef1fe9ccf3e0e884578dba5a63feb7">AxisUse</a> </td>
244
<td class="paramname"><em>axis_use</em>, </td>
247
<td class="paramkey"></td>
249
<td class="paramtype">double & </td>
250
<td class="paramname"><em>value</em> </td>
255
<td></td><td> const</td>
261
<p>Extract the axis value for a particular axis use from an event structure. </p>
262
<dl><dt><b>Parameters:</b></dt><dd>
263
<table class="params">
264
<tr><td class="paramname">axis_use</td><td>The axis use to look for. </td></tr>
265
<tr><td class="paramname">value</td><td>Location to store the value found. </td></tr>
269
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if the specified axis was found, otherwise <code>false</code>. </dd></dl>
273
<a class="anchor" id="aa509fcaf5f106ca22379ccea781ceb06"></a><!-- doxytag: member="Gdk::Event::get_coords" ref="aa509fcaf5f106ca22379ccea781ceb06" args="(double &x_win, double &y_win) const " -->
274
<div class="memitem">
275
<div class="memproto">
276
<table class="memname">
278
<td class="memname">bool Gdk::Event::get_coords </td>
280
<td class="paramtype">double & </td>
281
<td class="paramname"><em>x_win</em>, </td>
284
<td class="paramkey"></td>
286
<td class="paramtype">double & </td>
287
<td class="paramname"><em>y_win</em> </td>
292
<td></td><td> const</td>
298
<p>Extract the event window relative x/y coordinates from an event. </p>
299
<dl><dt><b>Parameters:</b></dt><dd>
300
<table class="params">
301
<tr><td class="paramname">x_win</td><td>Location to put event window x coordinate. </td></tr>
302
<tr><td class="paramname">y_win</td><td>Location to put event window y coordinate. </td></tr>
306
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if the event delivered event window coordinates. </dd></dl>
310
<a class="anchor" id="a9a282af82acec6d3b6d233503cb85691"></a><!-- doxytag: member="Gdk::Event::get_graphics_expose" ref="a9a282af82acec6d3b6d233503cb85691" args="(const Glib::RefPtr< Window > &window)" -->
311
<div class="memitem">
312
<div class="memproto">
313
<table class="memname">
315
<td class="memname">static <a class="el" href="classGdk_1_1Event.html">Event</a> Gdk::Event::get_graphics_expose </td>
317
<td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGdk_1_1Window.html">Window</a> >& </td>
318
<td class="paramname"><em>window</em></td><td>)</td>
319
<td><code> [static]</code></td>
325
<p>Waits for a GraphicsExpose or NoExpose event from the X server. </p>
326
<p>This is used in the Gtk::Text and Gtk::CList widgets in GTK+ to make sure any GraphicsExpose events are handled before the widget is scrolled.</p>
327
<p>Deprecated: 2.18: </p>
328
<dl><dt><b>Parameters:</b></dt><dd>
329
<table class="params">
330
<tr><td class="paramname">window</td><td>The <a class="el" href="classGdk_1_1Window.html" title="A Gdk::Window is a rectangular region on the screen.">Gdk::Window</a> to wait for the events for. </td></tr>
334
<dl class="return"><dt><b>Returns:</b></dt><dd>A Gdk::EventExpose if a GraphicsExpose was received, or <code>0</code> if a NoExpose event was received. </dd></dl>
338
<a class="anchor" id="a08b20bab46fdea9b34b7e7c612110c69"></a><!-- doxytag: member="Gdk::Event::get_root_coords" ref="a08b20bab46fdea9b34b7e7c612110c69" args="(double &x_root, double &y_root) const " -->
339
<div class="memitem">
340
<div class="memproto">
341
<table class="memname">
343
<td class="memname">bool Gdk::Event::get_root_coords </td>
345
<td class="paramtype">double & </td>
346
<td class="paramname"><em>x_root</em>, </td>
349
<td class="paramkey"></td>
351
<td class="paramtype">double & </td>
352
<td class="paramname"><em>y_root</em> </td>
357
<td></td><td> const</td>
363
<p>Extract the root window relative x/y coordinates from an event. </p>
364
<dl><dt><b>Parameters:</b></dt><dd>
365
<table class="params">
366
<tr><td class="paramname">x_root</td><td>Location to put root window x coordinate. </td></tr>
367
<tr><td class="paramname">y_root</td><td>Location to put root window y coordinate. </td></tr>
371
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if the event delivered root window coordinates. </dd></dl>
375
<a class="anchor" id="a1a0386cc3586fc098ddb5feabc37226e"></a><!-- doxytag: member="Gdk::Event::get_screen" ref="a1a0386cc3586fc098ddb5feabc37226e" args="()" -->
376
<div class="memitem">
377
<div class="memproto">
378
<table class="memname">
380
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGdk_1_1Screen.html">Screen</a>> Gdk::Event::get_screen </td>
382
<td class="paramname"></td><td>)</td>
389
<p>Returns the screen for the event. </p>
390
<p>The screen is typically the screen for <code>event->any.window</code>, but for events such as mouse events, it is the screen where the pointer was when the event occurs - that is, the screen which has the root window to which <code>event->motion.x_root</code> and <code>event->motion.y_root</code> are relative.</p>
391
<dl class="since_2_2"><dt><b><a class="el" href="since_2_2.html#_since_2_2000052">Since gtkmm 2.2:</a></b></dt><dd></dd></dl>
392
<dl class="return"><dt><b>Returns:</b></dt><dd>The screen for the event. </dd></dl>
396
<a class="anchor" id="aea9ca52d43535409b3ee18ac6c18830e"></a><!-- doxytag: member="Gdk::Event::get_screen" ref="aea9ca52d43535409b3ee18ac6c18830e" args="() const " -->
397
<div class="memitem">
398
<div class="memproto">
399
<table class="memname">
401
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><const <a class="el" href="classGdk_1_1Screen.html">Screen</a>> Gdk::Event::get_screen </td>
403
<td class="paramname"></td><td>)</td>
410
<p>Returns the screen for the event. </p>
411
<p>The screen is typically the screen for <code>event->any.window</code>, but for events such as mouse events, it is the screen where the pointer was when the event occurs - that is, the screen which has the root window to which <code>event->motion.x_root</code> and <code>event->motion.y_root</code> are relative.</p>
412
<dl class="since_2_2"><dt><b><a class="el" href="since_2_2.html#_since_2_2000053">Since gtkmm 2.2:</a></b></dt><dd></dd></dl>
413
<dl class="return"><dt><b>Returns:</b></dt><dd>The screen for the event. </dd></dl>
417
<a class="anchor" id="ac4498a06c7bdf8804f91af934e5d2b7a"></a><!-- doxytag: member="Gdk::Event::get_show_events" ref="ac4498a06c7bdf8804f91af934e5d2b7a" args="()" -->
418
<div class="memitem">
419
<div class="memproto">
420
<table class="memname">
422
<td class="memname">static bool Gdk::Event::get_show_events </td>
424
<td class="paramname"></td><td>)</td>
425
<td><code> [static]</code></td>
431
<p>Gets whether event debugging output is enabled. </p>
432
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if event debugging output is enabled. </dd></dl>
436
<a class="anchor" id="adcd60bfd108f761e7f52505eefddf7e7"></a><!-- doxytag: member="Gdk::Event::get_state" ref="adcd60bfd108f761e7f52505eefddf7e7" args="(ModifierType &state) const " -->
437
<div class="memitem">
438
<div class="memproto">
439
<table class="memname">
441
<td class="memname">bool Gdk::Event::get_state </td>
443
<td class="paramtype"><a class="el" href="group__gdkmmEnums.html#ga734c2979005c87dbe51223a0128cdd97">ModifierType</a>& </td>
444
<td class="paramname"><em>state</em></td><td>)</td>
451
<p>If the event contains a "state" field, puts that field in <em>state</em>. </p>
452
<p>Otherwise stores an empty state (0). Returns <code>true</code> if there was a state field in the event. <em>event</em> may be <code>0</code>, in which case it's treated as if the event had no state field. </p>
453
<dl><dt><b>Parameters:</b></dt><dd>
454
<table class="params">
455
<tr><td class="paramname">state</td><td>Return location for state. </td></tr>
459
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if there was a state field in the event. </dd></dl>
463
<a class="anchor" id="a6d785b16c3532cdcd0794d7d4161c40e"></a><!-- doxytag: member="Gdk::Event::get_time" ref="a6d785b16c3532cdcd0794d7d4161c40e" args="() const " -->
464
<div class="memitem">
465
<div class="memproto">
466
<table class="memname">
468
<td class="memname">guint32 Gdk::Event::get_time </td>
470
<td class="paramname"></td><td>)</td>
477
<p>Returns the time stamp from <em>event</em>, if there is one; otherwise returns Gdk::CURRENT_TIME. </p>
478
<p>If <em>event</em> is <code>0</code>, returns Gdk::CURRENT_TIME. </p>
479
<dl class="return"><dt><b>Returns:</b></dt><dd>Time stamp field from <em>event</em>. </dd></dl>
483
<a class="anchor" id="a63e34d8c6300a5fe4939e4dc4fcbf440"></a><!-- doxytag: member="Gdk::Event::gobj" ref="a63e34d8c6300a5fe4939e4dc4fcbf440" args="() const " -->
484
<div class="memitem">
485
<div class="memproto">
486
<table class="memname">
488
<td class="memname">const GdkEvent* Gdk::Event::gobj </td>
490
<td class="paramname"></td><td>)</td>
491
<td> const<code> [inline]</code></td>
497
<p>Provides access to the underlying C instance. </p>
501
<a class="anchor" id="a21a5ddedef8a375f19412ce2d6c37d90"></a><!-- doxytag: member="Gdk::Event::gobj" ref="a21a5ddedef8a375f19412ce2d6c37d90" args="()" -->
502
<div class="memitem">
503
<div class="memproto">
504
<table class="memname">
506
<td class="memname">GdkEvent* Gdk::Event::gobj </td>
508
<td class="paramname"></td><td>)</td>
509
<td><code> [inline]</code></td>
515
<p>Provides access to the underlying C instance. </p>
519
<a class="anchor" id="a322551c2b247575997ef1e3bc498751a"></a><!-- doxytag: member="Gdk::Event::gobj_copy" ref="a322551c2b247575997ef1e3bc498751a" args="() const " -->
520
<div class="memitem">
521
<div class="memproto">
522
<table class="memname">
524
<td class="memname">GdkEvent* Gdk::Event::gobj_copy </td>
526
<td class="paramname"></td><td>)</td>
533
<p>Provides access to the underlying C instance. The caller is responsible for freeing it. Use when directly setting fields in structs. </p>
537
<a class="anchor" id="abd217b33d80155460a6c5d6339f914bc"></a><!-- doxytag: member="Gdk::Event::operator=" ref="abd217b33d80155460a6c5d6339f914bc" args="(const Event &other)" -->
538
<div class="memitem">
539
<div class="memproto">
540
<table class="memname">
542
<td class="memname"><a class="el" href="classGdk_1_1Event.html">Event</a>& Gdk::Event::operator= </td>
544
<td class="paramtype">const <a class="el" href="classGdk_1_1Event.html">Event</a>& </td>
545
<td class="paramname"><em>other</em></td><td>)</td>
554
<a class="anchor" id="ab3a63d0588191feb265efb712c46f411"></a><!-- doxytag: member="Gdk::Event::peek" ref="ab3a63d0588191feb265efb712c46f411" args="()" -->
555
<div class="memitem">
556
<div class="memproto">
557
<table class="memname">
559
<td class="memname">static <a class="el" href="classGdk_1_1Event.html">Event</a> Gdk::Event::peek </td>
561
<td class="paramname"></td><td>)</td>
562
<td><code> [static]</code></td>
568
<p>If there is an event waiting in the event queue of some open display, returns a copy of it. </p>
569
<p>See <a class="el" href="classGdk_1_1Display.html#a3b7ad20b7a23a50c3b5b48482deac281" title="Gets a copy of the first Gdk::Event in the display's event queue, without removing the event from...">Gdk::Display::peek_event()</a>. </p>
570
<dl class="return"><dt><b>Returns:</b></dt><dd>A copy of the first <a class="el" href="classGdk_1_1Event.html">Gdk::Event</a> on some event queue, or <code>0</code> if no events are in any queues. The returned <a class="el" href="classGdk_1_1Event.html">Gdk::Event</a> should be freed with free(). </dd></dl>
574
<a class="anchor" id="a7e9830470be83a7206db3a8c5436ef08"></a><!-- doxytag: member="Gdk::Event::put" ref="a7e9830470be83a7206db3a8c5436ef08" args="()" -->
575
<div class="memitem">
576
<div class="memproto">
577
<table class="memname">
579
<td class="memname">void Gdk::Event::put </td>
581
<td class="paramname"></td><td>)</td>
588
<p>Appends a copy of the given event onto the front of the event queue for event->any.window's display, or the default event queue if event->any.window is <code>0</code>. </p>
589
<p>See <a class="el" href="classGdk_1_1Display.html#afaca03c9f4b869fdd127c298869f948b" title="Appends a copy of the given event onto the front of the event queue for display.">Gdk::Display::put_event()</a>. </p>
593
<a class="anchor" id="a47dcee1faab7a5c7b84561de153008c2"></a><!-- doxytag: member="Gdk::Event::send_client_message" ref="a47dcee1faab7a5c7b84561de153008c2" args="(NativeWindow winid)" -->
594
<div class="memitem">
595
<div class="memproto">
596
<table class="memname">
598
<td class="memname">bool Gdk::Event::send_client_message </td>
600
<td class="paramtype"><a class="el" href="namespaceGdk.html#abc645cff9ee57146245d4a5b4da7abac">NativeWindow</a> </td>
601
<td class="paramname"><em>winid</em></td><td>)</td>
608
<p>Sends an X ClientMessage event to a given window (which must be on the default <a class="el" href="classGdk_1_1Display.html" title="Gdk::Display object's purpose is two fold: To grab/ungrab keyboard focus and mouse pointer To man...">Gdk::Display</a>.) This could be used for communicating between different applications, though the amount of data is limited to 20 bytes. </p>
609
<dl><dt><b>Parameters:</b></dt><dd>
610
<table class="params">
611
<tr><td class="paramname">winid</td><td>The window to send the X ClientMessage event to. </td></tr>
615
<dl class="return"><dt><b>Returns:</b></dt><dd>Non-zero on success. </dd></dl>
619
<a class="anchor" id="a0c11543ac2e244bcc98ffe5011732902"></a><!-- doxytag: member="Gdk::Event::send_client_message" ref="a0c11543ac2e244bcc98ffe5011732902" args="(const Glib::RefPtr< Display > &display, NativeWindow winid)" -->
620
<div class="memitem">
621
<div class="memproto">
622
<table class="memname">
624
<td class="memname">bool Gdk::Event::send_client_message </td>
626
<td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGdk_1_1Display.html">Display</a> >& </td>
627
<td class="paramname"><em>display</em>, </td>
630
<td class="paramkey"></td>
632
<td class="paramtype"><a class="el" href="namespaceGdk.html#abc645cff9ee57146245d4a5b4da7abac">NativeWindow</a> </td>
633
<td class="paramname"><em>winid</em> </td>
646
<a class="anchor" id="a2fc30fd4d95b4bf9f8f8a7f731fbba08"></a><!-- doxytag: member="Gdk::Event::set_screen" ref="a2fc30fd4d95b4bf9f8f8a7f731fbba08" args="(const Glib::RefPtr< Screen > &screen)" -->
647
<div class="memitem">
648
<div class="memproto">
649
<table class="memname">
651
<td class="memname">void Gdk::Event::set_screen </td>
653
<td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGdk_1_1Screen.html">Screen</a> >& </td>
654
<td class="paramname"><em>screen</em></td><td>)</td>
661
<p>Sets the screen for <em>event</em> to <em>screen</em>. </p>
662
<p>The event must have been allocated by GTK+, for instance, by <a class="elRef" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01570.html#ga96dfad10d760ddb38d90f2dd68649a8b">copy()</a>.</p>
663
<dl class="since_2_2"><dt><b><a class="el" href="since_2_2.html#_since_2_2000051">Since gtkmm 2.2:</a></b></dt><dd></dd></dl>
664
<dl><dt><b>Parameters:</b></dt><dd>
665
<table class="params">
666
<tr><td class="paramname">screen</td><td>A <a class="el" href="classGdk_1_1Screen.html" title="Object representing a physical screen Gdk::Screen objects are the GDK representation of a physical sc...">Gdk::Screen</a>. </td></tr>
673
<a class="anchor" id="aca840aa197d7ea9ea36c7e0061300607"></a><!-- doxytag: member="Gdk::Event::set_show_events" ref="aca840aa197d7ea9ea36c7e0061300607" args="(bool show_events)" -->
674
<div class="memitem">
675
<div class="memproto">
676
<table class="memname">
678
<td class="memname">static void Gdk::Event::set_show_events </td>
680
<td class="paramtype">bool </td>
681
<td class="paramname"><em>show_events</em></td><td>)</td>
682
<td><code> [static]</code></td>
688
<p>Sets whether a trace of received events is output. </p>
689
<p>Note that GTK+ must be compiled with debugging (that is, configured using the <option>--enable-debug</option> option) to use this option. </p>
690
<dl><dt><b>Parameters:</b></dt><dd>
691
<table class="params">
692
<tr><td class="paramname">show_events</td><td><code>true</code> to output event debugging information. </td></tr>
699
<a class="anchor" id="ac46208ba6a7b2f61f486997146728f4c"></a><!-- doxytag: member="Gdk::Event::swap" ref="ac46208ba6a7b2f61f486997146728f4c" args="(Event &other)" -->
700
<div class="memitem">
701
<div class="memproto">
702
<table class="memname">
704
<td class="memname">void Gdk::Event::swap </td>
706
<td class="paramtype"><a class="el" href="classGdk_1_1Event.html">Event</a>& </td>
707
<td class="paramname"><em>other</em></td><td>)</td>
716
<hr/><h2>Friends And Related Function Documentation</h2>
717
<a class="anchor" id="a5d74f5c6134933e244ca0bf21cdc4d91"></a><!-- doxytag: member="Gdk::Event::swap" ref="a5d74f5c6134933e244ca0bf21cdc4d91" args="(Event &lhs, Event &rhs)" -->
718
<div class="memitem">
719
<div class="memproto">
720
<table class="memname">
722
<td class="memname">void swap </td>
724
<td class="paramtype"><a class="el" href="classGdk_1_1Event.html">Event</a>& </td>
725
<td class="paramname"><em>lhs</em>, </td>
728
<td class="paramkey"></td>
730
<td class="paramtype"><a class="el" href="classGdk_1_1Event.html">Event</a>& </td>
731
<td class="paramname"><em>rhs</em> </td>
736
<td></td><td><code> [related]</code></td>
741
<dl><dt><b>Parameters:</b></dt><dd>
742
<table class="params">
743
<tr><td class="paramname">lhs</td><td>The left-hand side </td></tr>
744
<tr><td class="paramname">rhs</td><td>The right-hand side </td></tr>
751
<a class="anchor" id="a90bf6ff26dda59432c3ac822dde33098"></a><!-- doxytag: member="Gdk::Event::wrap" ref="a90bf6ff26dda59432c3ac822dde33098" args="(GdkEvent *object, bool take_copy=false)" -->
752
<div class="memitem">
753
<div class="memproto">
754
<table class="memname">
756
<td class="memname"><a class="el" href="classGdk_1_1Event.html">Gdk::Event</a> wrap </td>
758
<td class="paramtype">GdkEvent * </td>
759
<td class="paramname"><em>object</em>, </td>
762
<td class="paramkey"></td>
764
<td class="paramtype">bool </td>
765
<td class="paramname"><em>take_copy</em> = <code>false</code> </td>
770
<td></td><td><code> [related]</code></td>
776
<p>A <a class="elRef" href="../../../glibmm-2.4/reference/html/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. </p>
777
<dl><dt><b>Parameters:</b></dt><dd>
778
<table class="params">
779
<tr><td class="paramname">object</td><td>The C instance. </td></tr>
780
<tr><td class="paramname">take_copy</td><td>False if the result should take ownership of the C instance. True if it should take a new copy or ref. </td></tr>
784
<dl class="return"><dt><b>Returns:</b></dt><dd>A C++ instance that wraps this C instance. </dd></dl>
788
<hr/><h2>Member Data Documentation</h2>
789
<a class="anchor" id="a297866c4cc91dbe6cacb3236361301a9"></a><!-- doxytag: member="Gdk::Event::gobject_" ref="a297866c4cc91dbe6cacb3236361301a9" args="" -->
790
<div class="memitem">
791
<div class="memproto">
792
<table class="memname">
794
<td class="memname">GdkEvent* <a class="el" href="classGdk_1_1Event.html#a297866c4cc91dbe6cacb3236361301a9">Gdk::Event::gobject_</a><code> [protected]</code></td>
802
<hr/>The documentation for this class was generated from the following file:<ul>
803
<li>gdkmm/event.h</li>
806
<hr class="footer"/><address class="footer"><small>Generated on Fri Jul 8 2011 13:31:44 for gtkmm by 
807
<a href="http://www.doxygen.org/index.html">
808
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address>
added
removed
share/doc/gtkmm-2.4/reference/html/classGdk_1_1Event.html
