<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>gtkmm 2.4: Gdk::Event Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head>
<body bgcolor="#ffffff">
<table border="0" width="100%">
<tr>
<td width="10%" height="40"><img src="../../images/gtkmm_logo.gif" alt="logo" border="0" width="100%" height="100%"/></td>
<td width="90%" height="40"><img src="../../images/top.gif" alt="top" width="100%" height="40"/></td>
</tr>
</table>
<center>
<a class="qindex" href="../../index.html">Main Page</a>
<a href="group__Widgets.html">Widgets</a>
<a class="qindex" href="namespaces.html"> Namespaces</a>
<a href="../../tutorial/html/index.html"> Book</a>
</center>
<hr width="100%"/>
<!-- begin main content -->
<div id="content">
<!-- Generated by Doxygen 1.5.1 -->
<div class="nav">
<a class="el" href="namespaceGdk.html">Gdk</a>::<a class="el" href="classGdk_1_1Event.html">Event</a></div>
<h1>Gdk::Event Class Reference</h1><!-- doxytag: class="Gdk::Event" --><a href="classGdk_1_1Event-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1Event.html#130915030025da8d1653506122c84385">Event</a> (const <a class="el" href="classGdk_1_1Event.html">Event</a>& other)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1Event.html#f5f1d2094cb30b218c337c29e0764925">Event</a> (GdkEvent* gobject, bool make_a_copy=true)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1Event.html#e03c66bcd189f44073891575592b7677">Event</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1Event.html#bed7f8b9ced371c8e8b1c916a7c47722">get_axis</a> (<a class="el" href="group__gdkmmEnums.html#ga3ef1fe9ccf3e0e884578dba5a63feb7">AxisUse</a> axis_use, double& value) const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Extract the axis value for a particular axis use from an event structure. <a href="#bed7f8b9ced371c8e8b1c916a7c47722"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1Event.html#05b416dae7ad93a219327effa54403d6">get_coords</a> (double& x_win, double& y_win) const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Extract the event window relative x/y coordinates from an event. <a href="#05b416dae7ad93a219327effa54403d6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1Event.html#d20a2a0364904da7b76961d26f40ccc9">get_root_coords</a> (double& x_root, double& y_root) const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Extract the root window relative x/y coordinates from an event. <a href="#d20a2a0364904da7b76961d26f40ccc9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/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#1f48a362a0804ff114554520f7b2bb6b">get_screen</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return value: the screen for the event. <a href="#1f48a362a0804ff114554520f7b2bb6b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/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#1a0386cc3586fc098ddb5feabc37226e">get_screen</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return value: the screen for the event. <a href="#1a0386cc3586fc098ddb5feabc37226e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1Event.html#dcd60bfd108f761e7f52505eefddf7e7">get_state</a> (<a class="el" href="group__gdkmmEnums.html#g734c2979005c87dbe51223a0128cdd97">ModifierType</a>& state) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">If the event contains a "state" field, puts that field in <em>state</em> . <a href="#dcd60bfd108f761e7f52505eefddf7e7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">guint32 </td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1Event.html#5f06613499bc659170283484e16efe45">get_time</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">returns Gdk::CURRENT_TIME. <a href="#5f06613499bc659170283484e16efe45"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const GdkEvent* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1Event.html#b66103b209e0776d0da1ecf0534dc789">gobj</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C instance. <a href="#b66103b209e0776d0da1ecf0534dc789"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">GdkEvent* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1Event.html#21a5ddedef8a375f19412ce2d6c37d90">gobj</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C instance. <a href="#21a5ddedef8a375f19412ce2d6c37d90"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">GdkEvent* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1Event.html#0dcaccb518bd45efd3311acfce5354b3">gobj_copy</a> () const</td></tr>
<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="#0dcaccb518bd45efd3311acfce5354b3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap 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#bd217b33d80155460a6c5d6339f914bc">operator=</a> (const <a class="el" href="classGdk_1_1Event.html">Event</a>& other)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1Event.html#7e9830470be83a7206db3a8c5436ef08">put</a> ()</td></tr>
<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="#7e9830470be83a7206db3a8c5436ef08"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1Event.html#0c11543ac2e244bcc98ffe5011732902">send_client_message</a> (const <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/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#bc645cff9ee57146245d4a5b4da7abac">NativeWindow</a> winid)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1Event.html#47dcee1faab7a5c7b84561de153008c2">send_client_message</a> (<a class="el" href="namespaceGdk.html#bc645cff9ee57146245d4a5b4da7abac">NativeWindow</a> winid)</td></tr>
<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">Gdk::Display</a>. <a href="#47dcee1faab7a5c7b84561de153008c2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1Event.html#2fc30fd4d95b4bf9f8f8a7f731fbba08">set_screen</a> (const <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGdk_1_1Screen.html">Screen</a>>& screen)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the screen for <em>event</em> to <em>screen</em> . <a href="#2fc30fd4d95b4bf9f8f8a7f731fbba08"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1Event.html#c46208ba6a7b2f61f486997146728f4c">swap</a> (<a class="el" href="classGdk_1_1Event.html">Event</a>& other)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1Event.html#ff6e2fdbf97ab2bd759b64652a86d8b2">~Event</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1Event.html#d3844a1151ae6549af4ac19f7abd41dd">events_pending</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Checks if any events are ready to be processed for any display. <a href="#d3844a1151ae6549af4ac19f7abd41dd"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap 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#eac82b61cdde5e8e6477f1835a5095de">get</a> ()</td></tr>
<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="#eac82b61cdde5e8e6477f1835a5095de"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap 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#9a282af82acec6d3b6d233503cb85691">get_graphics_expose</a> (const <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGdk_1_1Window.html">Window</a>>& window)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Waits for a GraphicsExpose or NoExpose event from the X server. <a href="#9a282af82acec6d3b6d233503cb85691"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1Event.html#c4498a06c7bdf8804f91af934e5d2b7a">get_show_events</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets whether event debugging output is enabled. <a href="#c4498a06c7bdf8804f91af934e5d2b7a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap 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#b3a63d0588191feb265efb712c46f411">peek</a> ()</td></tr>
<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="#b3a63d0588191feb265efb712c46f411"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1Event.html#ca840aa197d7ea9ea36c7e0061300607">set_show_events</a> (bool show_events)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets whether a trace of received events is output. <a href="#ca840aa197d7ea9ea36c7e0061300607"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">GdkEvent* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1Event.html#297866c4cc91dbe6cacb3236361301a9">gobject_</a></td></tr>
<tr><td colspan="2"><br><h2>Related Functions</h2></td></tr>
<tr><td colspan="2">(Note that these are not member functions.) <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGdk_1_1Event.html#5d74f5c6134933e244ca0bf21cdc4d91">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>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>lhs</em> </td><td>The left-hand side </td></tr>
</table>
</dl>
<a href="#5d74f5c6134933e244ca0bf21cdc4d91"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap 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#90bf6ff26dda59432c3ac822dde33098">wrap</a> (GdkEvent* object, bool take_copy=false)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/namespaceGlib.html#671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. <a href="#90bf6ff26dda59432c3ac822dde33098"></a><br></td></tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="e03c66bcd189f44073891575592b7677"></a><!-- doxytag: member="Gdk::Event::Event" ref="e03c66bcd189f44073891575592b7677" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Gdk::Event::Event </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="f5f1d2094cb30b218c337c29e0764925"></a><!-- doxytag: member="Gdk::Event::Event" ref="f5f1d2094cb30b218c337c29e0764925" args="(GdkEvent *gobject, bool make_a_copy=true)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Gdk::Event::Event </td>
<td>(</td>
<td class="paramtype">GdkEvent * </td>
<td class="paramname"> <em>gobject</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>make_a_copy</em> = <code>true</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [explicit]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="130915030025da8d1653506122c84385"></a><!-- doxytag: member="Gdk::Event::Event" ref="130915030025da8d1653506122c84385" args="(const Event &other)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Gdk::Event::Event </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classGdk_1_1Event.html">Event</a>& </td>
<td class="paramname"> <em>other</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="ff6e2fdbf97ab2bd759b64652a86d8b2"></a><!-- doxytag: member="Gdk::Event::~Event" ref="ff6e2fdbf97ab2bd759b64652a86d8b2" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Gdk::Event::~Event </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="d3844a1151ae6549af4ac19f7abd41dd"></a><!-- doxytag: member="Gdk::Event::events_pending" ref="d3844a1151ae6549af4ac19f7abd41dd" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static bool Gdk::Event::events_pending </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Checks if any events are ready to be processed for any display.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd><code>true</code> if any events are pending. </dd></dl>
</div>
</div><p>
<a class="anchor" name="eac82b61cdde5e8e6477f1835a5095de"></a><!-- doxytag: member="Gdk::Event::get" ref="eac82b61cdde5e8e6477f1835a5095de" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classGdk_1_1Event.html">Event</a> Gdk::Event::get </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<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>
See <a class="el" href="classGdk_1_1Display.html#71ef8186ac0ebce17ab869eb77f5e9e7">Gdk::Display::get_event()</a>. <dl class="return" compact><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 gdk_event_free(). </dd></dl>
</div>
</div><p>
<a class="anchor" name="bed7f8b9ced371c8e8b1c916a7c47722"></a><!-- doxytag: member="Gdk::Event::get_axis" ref="bed7f8b9ced371c8e8b1c916a7c47722" args="(AxisUse axis_use, double &value) const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Gdk::Event::get_axis </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__gdkmmEnums.html#ga3ef1fe9ccf3e0e884578dba5a63feb7">AxisUse</a> </td>
<td class="paramname"> <em>axis_use</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double & </td>
<td class="paramname"> <em>value</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Extract the axis value for a particular axis use from an event structure.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>axis_use</em> </td><td>The axis use to look for. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>Location to store the value found. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd><code>true</code> if the specified axis was found, otherwise <code>false</code>. </dd></dl>
</div>
</div><p>
<a class="anchor" name="05b416dae7ad93a219327effa54403d6"></a><!-- doxytag: member="Gdk::Event::get_coords" ref="05b416dae7ad93a219327effa54403d6" args="(double &x_win, double &y_win) const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Gdk::Event::get_coords </td>
<td>(</td>
<td class="paramtype">double & </td>
<td class="paramname"> <em>x_win</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double & </td>
<td class="paramname"> <em>y_win</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Extract the event window relative x/y coordinates from an event.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>x_win</em> </td><td>Location to put event window x coordinate. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>y_win</em> </td><td>Location to put event window y coordinate. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd><code>true</code> if the event delivered event window coordinates. </dd></dl>
</div>
</div><p>
<a class="anchor" name="9a282af82acec6d3b6d233503cb85691"></a><!-- doxytag: member="Gdk::Event::get_graphics_expose" ref="9a282af82acec6d3b6d233503cb85691" args="(const Glib::RefPtr< Window > &window)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classGdk_1_1Event.html">Event</a> Gdk::Event::get_graphics_expose </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGdk_1_1Window.html">Window</a>>& </td>
<td class="paramname"> <em>window</em> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Waits for a GraphicsExpose or NoExpose event from the X server.
<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. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>window</em> </td><td>The <a class="el" href="classGdk_1_1Window.html">Gdk::Window</a> to wait for the events for. </td></tr>
</table>
</dl>
<dl class="return" compact><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>
</div>
</div><p>
<a class="anchor" name="d20a2a0364904da7b76961d26f40ccc9"></a><!-- doxytag: member="Gdk::Event::get_root_coords" ref="d20a2a0364904da7b76961d26f40ccc9" args="(double &x_root, double &y_root) const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Gdk::Event::get_root_coords </td>
<td>(</td>
<td class="paramtype">double & </td>
<td class="paramname"> <em>x_root</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double & </td>
<td class="paramname"> <em>y_root</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Extract the root window relative x/y coordinates from an event.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>x_root</em> </td><td>Location to put root window x coordinate. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>y_root</em> </td><td>Location to put root window y coordinate. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd><code>true</code> if the event delivered root window coordinates. </dd></dl>
</div>
</div><p>
<a class="anchor" name="1f48a362a0804ff114554520f7b2bb6b"></a><!-- doxytag: member="Gdk::Event::get_screen" ref="1f48a362a0804ff114554520f7b2bb6b" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/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>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return value: the screen for the event.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The screen for the event</dd></dl>
<dl compact><dt><b><a class="el" href="newin2p2s.html#_newin2p2s000050">Since gtkmm 2.2:</a></b></dt><dd></dd></dl>
</div>
</div><p>
<a class="anchor" name="1a0386cc3586fc098ddb5feabc37226e"></a><!-- doxytag: member="Gdk::Event::get_screen" ref="1a0386cc3586fc098ddb5feabc37226e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGdk_1_1Screen.html">Screen</a>> Gdk::Event::get_screen </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return value: the screen for the event.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The screen for the event</dd></dl>
<dl compact><dt><b><a class="el" href="newin2p2s.html#_newin2p2s000049">Since gtkmm 2.2:</a></b></dt><dd></dd></dl>
</div>
</div><p>
<a class="anchor" name="c4498a06c7bdf8804f91af934e5d2b7a"></a><!-- doxytag: member="Gdk::Event::get_show_events" ref="c4498a06c7bdf8804f91af934e5d2b7a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static bool Gdk::Event::get_show_events </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Gets whether event debugging output is enabled.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd><code>true</code> if event debugging output is enabled. </dd></dl>
</div>
</div><p>
<a class="anchor" name="dcd60bfd108f761e7f52505eefddf7e7"></a><!-- doxytag: member="Gdk::Event::get_state" ref="dcd60bfd108f761e7f52505eefddf7e7" args="(ModifierType &state) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Gdk::Event::get_state </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__gdkmmEnums.html#g734c2979005c87dbe51223a0128cdd97">ModifierType</a>& </td>
<td class="paramname"> <em>state</em> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
If the event contains a "state" field, puts that field in <em>state</em> .
<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. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>state</em> </td><td>Return location for state. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd><code>true</code> if there was a state field in the event. </dd></dl>
</div>
</div><p>
<a class="anchor" name="5f06613499bc659170283484e16efe45"></a><!-- doxytag: member="Gdk::Event::get_time" ref="5f06613499bc659170283484e16efe45" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">guint32 Gdk::Event::get_time </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
returns Gdk::CURRENT_TIME.
<p>
If <em>event</em> is <code>0</code>, returns Gdk::CURRENT_TIME. Return value: time stamp field from <em>event</em> <dl class="return" compact><dt><b>Returns:</b></dt><dd>Time stamp field from <em>event</em> . </dd></dl>
</div>
</div><p>
<a class="anchor" name="b66103b209e0776d0da1ecf0534dc789"></a><!-- doxytag: member="Gdk::Event::gobj" ref="b66103b209e0776d0da1ecf0534dc789" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const GdkEvent* Gdk::Event::gobj </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Provides access to the underlying C instance.
<p>
</div>
</div><p>
<a class="anchor" name="21a5ddedef8a375f19412ce2d6c37d90"></a><!-- doxytag: member="Gdk::Event::gobj" ref="21a5ddedef8a375f19412ce2d6c37d90" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GdkEvent* Gdk::Event::gobj </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Provides access to the underlying C instance.
<p>
</div>
</div><p>
<a class="anchor" name="0dcaccb518bd45efd3311acfce5354b3"></a><!-- doxytag: member="Gdk::Event::gobj_copy" ref="0dcaccb518bd45efd3311acfce5354b3" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GdkEvent* Gdk::Event::gobj_copy </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Provides access to the underlying C instance. The caller is responsible for freeing it. Use when directly setting fields in structs.
<p>
</div>
</div><p>
<a class="anchor" name="bd217b33d80155460a6c5d6339f914bc"></a><!-- doxytag: member="Gdk::Event::operator=" ref="bd217b33d80155460a6c5d6339f914bc" args="(const Event &other)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classGdk_1_1Event.html">Event</a>& Gdk::Event::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classGdk_1_1Event.html">Event</a>& </td>
<td class="paramname"> <em>other</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="b3a63d0588191feb265efb712c46f411"></a><!-- doxytag: member="Gdk::Event::peek" ref="b3a63d0588191feb265efb712c46f411" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classGdk_1_1Event.html">Event</a> Gdk::Event::peek </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
If there is an event waiting in the event queue of some open display, returns a copy of it.
<p>
See <a class="el" href="classGdk_1_1Display.html#3b7ad20b7a23a50c3b5b48482deac281">Gdk::Display::peek_event()</a>. <dl class="return" compact><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 gdk_event_free(). </dd></dl>
</div>
</div><p>
<a class="anchor" name="7e9830470be83a7206db3a8c5436ef08"></a><!-- doxytag: member="Gdk::Event::put" ref="7e9830470be83a7206db3a8c5436ef08" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gdk::Event::put </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<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>
See <a class="el" href="classGdk_1_1Display.html#faca03c9f4b869fdd127c298869f948b">Gdk::Display::put_event()</a>.
</div>
</div><p>
<a class="anchor" name="0c11543ac2e244bcc98ffe5011732902"></a><!-- doxytag: member="Gdk::Event::send_client_message" ref="0c11543ac2e244bcc98ffe5011732902" args="(const Glib::RefPtr< Display > &display, NativeWindow winid)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Gdk::Event::send_client_message </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGdk_1_1Display.html">Display</a>>& </td>
<td class="paramname"> <em>display</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceGdk.html#bc645cff9ee57146245d4a5b4da7abac">NativeWindow</a> </td>
<td class="paramname"> <em>winid</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="47dcee1faab7a5c7b84561de153008c2"></a><!-- doxytag: member="Gdk::Event::send_client_message" ref="47dcee1faab7a5c7b84561de153008c2" args="(NativeWindow winid)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Gdk::Event::send_client_message </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceGdk.html#bc645cff9ee57146245d4a5b4da7abac">NativeWindow</a> </td>
<td class="paramname"> <em>winid</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sends an X ClientMessage event to a given window (which must be on the default <a class="el" href="classGdk_1_1Display.html">Gdk::Display</a>.
<p>
) This could be used for communicating between different applications, though the amount of data is limited to 20 bytes. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>winid</em> </td><td>The window to send the X ClientMessage event to. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Non-zero on success. </dd></dl>
</div>
</div><p>
<a class="anchor" name="2fc30fd4d95b4bf9f8f8a7f731fbba08"></a><!-- doxytag: member="Gdk::Event::set_screen" ref="2fc30fd4d95b4bf9f8f8a7f731fbba08" args="(const Glib::RefPtr< Screen > &screen)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gdk::Event::set_screen </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGdk_1_1Screen.html">Screen</a>>& </td>
<td class="paramname"> <em>screen</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets the screen for <em>event</em> to <em>screen</em> .
<p>
The event must have been allocated by GTK+, for instance, by gdk_event_copy().<p>
<dl compact><dt><b><a class="el" href="newin2p2s.html#_newin2p2s000048">Since gtkmm 2.2:</a></b></dt><dd></dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>screen</em> </td><td>A <a class="el" href="classGdk_1_1Screen.html">Gdk::Screen</a>. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="ca840aa197d7ea9ea36c7e0061300607"></a><!-- doxytag: member="Gdk::Event::set_show_events" ref="ca840aa197d7ea9ea36c7e0061300607" args="(bool show_events)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void Gdk::Event::set_show_events </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>show_events</em> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets whether a trace of received events is output.
<p>
Note that GTK+ must be compiled with debugging (that is, configured using the <option>--enable-debug</option> option) to use this option. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>show_events</em> </td><td><code>true</code> to output event debugging information. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="c46208ba6a7b2f61f486997146728f4c"></a><!-- doxytag: member="Gdk::Event::swap" ref="c46208ba6a7b2f61f486997146728f4c" args="(Event &other)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gdk::Event::swap </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classGdk_1_1Event.html">Event</a>& </td>
<td class="paramname"> <em>other</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Friends And Related Function Documentation</h2>
<a class="anchor" name="5d74f5c6134933e244ca0bf21cdc4d91"></a><!-- doxytag: member="Gdk::Event::swap" ref="5d74f5c6134933e244ca0bf21cdc4d91" args="(Event &lhs, Event &rhs)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void swap </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classGdk_1_1Event.html">Event</a>& </td>
<td class="paramname"> <em>lhs</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classGdk_1_1Event.html">Event</a>& </td>
<td class="paramname"> <em>rhs</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [related]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>lhs</em> </td><td>The left-hand side </td></tr>
</table>
</dl>
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>rhs</em> </td><td>The right-hand side </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="90bf6ff26dda59432c3ac822dde33098"></a><!-- doxytag: member="Gdk::Event::wrap" ref="90bf6ff26dda59432c3ac822dde33098" args="(GdkEvent *object, bool take_copy=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classGdk_1_1Event.html">Gdk::Event</a> wrap </td>
<td>(</td>
<td class="paramtype">GdkEvent * </td>
<td class="paramname"> <em>object</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>take_copy</em> = <code>false</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [related]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
A <a class="elRef" doxygen="glibmm_doxygen_tags:../../../../glibmm-2.4/docs/reference/html/" href="../../../../glibmm-2.4/docs/reference/html/namespaceGlib.html#671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>object</em> </td><td>The C instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>take_copy</em> </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>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A C++ instance that wraps this C instance. </dd></dl>
</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="297866c4cc91dbe6cacb3236361301a9"></a><!-- doxytag: member="Gdk::Event::gobject_" ref="297866c4cc91dbe6cacb3236361301a9" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GdkEvent* <a class="el" href="classGdk_1_1Event.html#297866c4cc91dbe6cacb3236361301a9">Gdk::Event::gobject_</a><code> [protected]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="event_8h.html">event.h</a></ul>
</div>
<!-- end main content -->
<hr><address><small>
Generated for gtkmm 2.4 by <a href="http://www.doxygen.org/index.html">
Doxygen</a> 1.5.1 © 1997-2001</small></address>
</body>
</html>
distrib
>
Mandriva
>
2008.1
>
x86_64
>
media
>
main-release
>
by-pkgid
>
9411cff4bc6d4e61b29ae81cd24665af
>
files
>
149
