<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" >
<head><meta content="text/html;charset=&quot;utf-8&quot;" http-equiv="Content-type"/><link href="faldoc.css" rel="stylesheet" type="text/css"/><title> - Class GdkEvent</title></head><body class="faldoc"><ul class="navi_top"><li class="top"><a href="index.html">Top: Table of contents</a></li>
<li class="up"><a href="gtk.html">Up: The Falcon GTK Binding module</a></li>
<li class="prev"><a href="gtk_GdkDrawable.html">Previous: Class GdkDrawable</a></li>
<li class="next"><a href="gtk_GdkEventButton.html">Next: Class GdkEventButton</a></li>
<li class="clear"></li>
</ul><div id="page_body"><h1><span class="toc_number">10.10</span>Class GdkEvent</h1><p class="brief">Functions for handling events from the window system </p>
<pre class="prototype">Class GdkEvent( type )</pre>
<table class="prototype">
<tbody><tr class="param"><td class="name">type</td><td class="content"> a GdkEventType </td></tr>
</tbody>
</table>
<p>Creates a new event of the given type. All fields are set to 0. </p>
<table class="members">
<tbody><tr class="member_type"><td class="member_type" colspan="2">Properties</td></tr>
<tr><td><a href="#send_event">send_event</a></td><td> TRUE if the event was sent explicitly (e.</td></tr>
<tr><td><a href="#type">type</a></td><td> the type of the event (GdkEventType).</td></tr>
<tr><td><a href="#window">window</a></td><td> TODO the window which received the event.</td></tr>
</tbody>
<tbody><tr class="member_type"><td class="member_type" colspan="2">Methods</td></tr>
<tr><td><a href="#copy">copy</a></td><td>Copies a GdkEvent, copying or incrementing the reference count of the resources associated with it (e.g. GdkWindow's and strings). </td></tr>
<tr><td><a href="#events_pending">events_pending</a></td><td>Checks if any events are ready to be processed for any display. </td></tr>
<tr><td><a href="#get">get</a></td><td>Checks all open displays for a GdkEvent to process, to be processed on, fetching events from the windowing system if necessary. </td></tr>
<tr><td><a href="#get_axis">get_axis</a></td><td>Extract the axis value for a particular axis use from an event structure. </td></tr>
<tr><td><a href="#get_coords">get_coords</a></td><td>Extract the event window relative x/y coordinates from an event. </td></tr>
<tr><td><a href="#get_real_event">get_real_event</a></td><td>Get a copy of the event cast to its real derived-type. </td></tr>
<tr><td><a href="#get_root_coords">get_root_coords</a></td><td>Extract the root window relative x/y coordinates from an event. </td></tr>
<tr><td><a href="#get_show_events">get_show_events</a></td><td>Gets whether event debugging output is enabled. </td></tr>
<tr><td><a href="#get_state">get_state</a></td><td>If the event contains a "state" field, returns it. Otherwise returns an empty state (0). </td></tr>
<tr><td><a href="#get_time">get_time</a></td><td>Returns the time stamp from event, if there is one; otherwise returns GDK_CURRENT_TIME. </td></tr>
<tr><td><a href="#peek">peek</a></td><td>If there is an event waiting in the event queue of some open display, returns it. </td></tr>
<tr><td><a href="#put">put</a></td><td>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 NULL. </td></tr>
<tr><td><a href="#set_show_events">set_show_events</a></td><td>Sets whether a trace of received events is output. </td></tr>
</tbody>
</table>
<h2>Properties</h2><h3><a name="send_event">send_event</a></h3><p class="brief"> TRUE if the event was sent explicitly (e.</p>
<p> TRUE if the event was sent explicitly (e.g. using XSendEvent). </p>
<h3><a name="type">type</a></h3><p class="brief"> the type of the event (GdkEventType).</p>
<p> the type of the event (GdkEventType). </p>
<h3><a name="window">window</a></h3><p class="brief"> TODO the window which received the event.</p>
<p> TODO the window which received the event. </p>
<h2>Methods</h2><h3><a name="copy">copy</a></h3><p class="brief">Copies a GdkEvent, copying or incrementing the reference count of the resources associated with it (e.g. GdkWindow's and strings). </p>
<pre class="prototype">GdkEvent.copy()</pre>
<table class="prototype">
<tbody><tr class="return"><td class="name">Return</td><td class="content">a copy of the event. </td></tr>
</tbody>
</table>
<h3><a name="events_pending">events_pending</a></h3><p class="brief">Checks if any events are ready to be processed for any display. </p>
<pre class="prototype">GdkEvent.events_pending()</pre>
<table class="prototype">
<tbody><tr class="return"><td class="name">Return</td><td class="content">TRUE if any events are pending. </td></tr>
</tbody>
</table>
<h3><a name="get">get</a></h3><p class="brief">Checks all open displays for a GdkEvent to process, to be processed on, fetching events from the windowing system if necessary. </p>
<pre class="prototype">GdkEvent.get()</pre>
<table class="prototype">
<tbody><tr class="return"><td class="name">Return</td><td class="content">the next GdkEvent to be processed, or NULL if no events are pending. </td></tr>
</tbody>
</table>
<p>See gdk_display_get_event(). </p>
<h3><a name="get_axis">get_axis</a></h3><p class="brief">Extract the axis value for a particular axis use from an event structure. </p>
<pre class="prototype">GdkEvent.get_axis( axis_use )</pre>
<table class="prototype">
<tbody><tr class="param"><td class="name">axis_use</td><td class="content"> the axis use to look for (GdkAxisUse). </td></tr>
<tr class="return"><td class="name">Return</td><td class="content">the value found or nil if the specified axis was not found. </td></tr>
</tbody>
</table>
<h3><a name="get_coords">get_coords</a></h3><p class="brief">Extract the event window relative x/y coordinates from an event. </p>
<pre class="prototype">GdkEvent.get_coords()</pre>
<table class="prototype">
<tbody><tr class="return"><td class="name">Return</td><td class="content">an array ( window x coordinate, window y coordinate ), or nil if the event did not deliver event window coordinates. </td></tr>
</tbody>
</table>
<h3><a name="get_real_event">get_real_event</a></h3><p class="brief">Get a copy of the event cast to its real derived-type. </p>
<pre class="prototype">GdkEvent.get_real_event()</pre>
<table class="prototype">
<tbody><tr class="return"><td class="name">Return</td><td class="content">one of the Gdk event types. </td></tr>
</tbody>
</table>
<p class='note'><b>Note:</b> This is Falcon specific. </p>
<p>In classes already derived from GdkEvent, this is of course not of much use. </p>
<h3><a name="get_root_coords">get_root_coords</a></h3><p class="brief">Extract the root window relative x/y coordinates from an event. </p>
<pre class="prototype">GdkEvent.get_root_coords()</pre>
<table class="prototype">
<tbody><tr class="return"><td class="name">Return</td><td class="content">an array ( window x coordinate, window y coordinate ), or nil if the event did not deliver root window coordinates </td></tr>
</tbody>
</table>
<h3><a name="get_show_events">get_show_events</a></h3><p class="brief">Gets whether event debugging output is enabled. </p>
<pre class="prototype">GdkEvent.get_show_events()</pre>
<table class="prototype">
<tbody><tr class="return"><td class="name">Return</td><td class="content">TRUE if event debugging output is enabled. </td></tr>
</tbody>
</table>
<h3><a name="get_state">get_state</a></h3><p class="brief">If the event contains a "state" field, returns it. Otherwise returns an empty state (0). </p>
<pre class="prototype">GdkEvent.get_state()</pre>
<table class="prototype">
<tbody><tr class="return"><td class="name">Return</td><td class="content">the state (GdkModifierType). </td></tr>
</tbody>
</table>
<h3><a name="get_time">get_time</a></h3><p class="brief">Returns the time stamp from event, if there is one; otherwise returns GDK_CURRENT_TIME. </p>
<pre class="prototype">GdkEvent.get_time()</pre>
<table class="prototype">
<tbody><tr class="return"><td class="name">Return</td><td class="content">time stamp field from event </td></tr>
</tbody>
</table>
<h3><a name="peek">peek</a></h3><p class="brief">If there is an event waiting in the event queue of some open display, returns it. </p>
<pre class="prototype">GdkEvent.peek()</pre>
<table class="prototype">
<tbody><tr class="return"><td class="name">Return</td><td class="content">the first GdkEvent on some event queue, or NULL if no events are in any queues. </td></tr>
</tbody>
</table>
<p>See gdk_display_peek_event(). </p>
<h3><a name="put">put</a></h3><p class="brief">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 NULL. </p>
<pre class="prototype">GdkEvent.put()</pre>
<p>See gdk_display_put_event(). </p>
<h3><a name="set_show_events">set_show_events</a></h3><p class="brief">Sets whether a trace of received events is output. </p>
<pre class="prototype">GdkEvent.set_show_events( show_events )</pre>
<table class="prototype">
<tbody><tr class="param"><td class="name">show_events</td><td class="content"> TRUE to output event debugging information. </td></tr>
</tbody>
</table>
<p>Note that GTK+ must be compiled with debugging (that is, configured using the --enable-debug option) to use this option. </p>
</div><ul class="navi_bottom"><li class="top"><a href="index.html">Top: Table of contents</a></li>
<li class="up"><a href="gtk.html">Up: The Falcon GTK Binding module</a></li>
<li class="prev"><a href="gtk_GdkDrawable.html">Previous: Class GdkDrawable</a></li>
<li class="next"><a href="gtk_GdkEventButton.html">Next: Class GdkEventButton</a></li>
<li class="clear"></li>
</ul><div class="signature">Made with <a href="faldoc 3.0">http://www.falconpl.org</a></div></body></html>
