<?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 GdkDisplay</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_GdkCursor.html">Previous: Class GdkCursor</a></li>
<li class="next"><a href="gtk_GdkDragContext.html">Next: Class GdkDragContext</a></li>
<li class="clear"></li>
</ul><div id="page_body"><h1><span class="toc_number">10.7</span>Class GdkDisplay</h1><p class="brief">An opaque structure representing an offscreen drawable of depth 1. </p>
<pre class="prototype">Class GdkDisplay( display_name )</pre>
<table class="prototype">
<tbody><tr class="param"><td class="name">display_name</td><td class="content"> the name of the display to open </td></tr>
</tbody>
</table>
<p>GdkDisplay objects purpose are two fold: </p>
<p>- To grab/ungrab keyboard focus and mouse pointer <ul><li>To manage and provide information about the GdkScreen(s) available for this GdkDisplay </li></ul></p>
<p>GdkDisplay objects are the GDK representation of the X Display which can be described as a workstation consisting of a keyboard a pointing device (such as a mouse) and one or more screens. It is used to open and keep track of various GdkScreen objects currently instanciated by the application. It is also used to grab and release the keyboard and the mouse pointer. </p>
<table class="members">
<tbody><tr class="member_type"><td class="member_type" colspan="2">Methods</td></tr>
<tr><td><a href="#beep">beep</a></td><td>Emits a short beep on display </td></tr>
<tr><td><a href="#close">close</a></td><td>Closes the connection to the windowing system for the given display, and cleans up associated resources. </td></tr>
<tr><td><a href="#device_is_grabbed">device_is_grabbed</a></td><td>Returns TRUE if there is an ongoing grab on device for display. </td></tr>
<tr><td><a href="#flush">flush</a></td><td>Flushes any requests queued for the windowing system. </td></tr>
<tr><td><a href="#get_default">get_default</a></td><td>Gets the default GdkDisplay. </td></tr>
<tr><td><a href="#get_default_screen">get_default_screen</a></td><td>Get the default GdkScreen for display. </td></tr>
<tr><td><a href="#get_n_screens">get_n_screens</a></td><td>Gets the number of screen managed by the display. </td></tr>
<tr><td><a href="#get_name">get_name</a></td><td>Gets the name of the display. </td></tr>
<tr><td><a href="#get_screen">get_screen</a></td><td>Returns a screen object for one of the screens of the display. </td></tr>
<tr><td><a href="#keyboard_ungrab">keyboard_ungrab</a></td><td>Release any keyboard grab </td></tr>
<tr><td><a href="#pointer_is_grabbed">pointer_is_grabbed</a></td><td>Test if the pointer is grabbed. </td></tr>
<tr><td><a href="#pointer_ungrab">pointer_ungrab</a></td><td>Release any pointer grab. </td></tr>
<tr><td><a href="#signal_closed">signal_closed</a></td><td>The closed signal is emitted when the connection to the windowing system for display is closed. </td></tr>
<tr><td><a href="#signal_opened">signal_opened</a></td><td>The opened signal is emitted when the connection to the windowing system for display is opened. </td></tr>
<tr><td><a href="#sync">sync</a></td><td>Flushes any requests queued for the windowing system and waits until all requests have been handled. </td></tr>
</tbody>
</table>
<h2>Methods</h2><h3><a name="beep">beep</a></h3><p class="brief">Emits a short beep on display </p>
<pre class="prototype">GdkDisplay.beep()</pre>
<h3><a name="close">close</a></h3><p class="brief">Closes the connection to the windowing system for the given display, and cleans up associated resources. </p>
<pre class="prototype">GdkDisplay.close()</pre>
<h3><a name="device_is_grabbed">device_is_grabbed</a></h3><p class="brief">Returns TRUE if there is an ongoing grab on device for display. </p>
<pre class="prototype">GdkDisplay.device_is_grabbed( device )</pre>
<table class="prototype">
<tbody><tr class="param"><td class="name">device</td><td class="content"> a GdkDevice </td></tr>
<tr class="return"><td class="name">Return</td><td class="content">TRUE if there is a grab in effect for device. </td></tr>
</tbody>
</table>
<p class='note'><b>Note:</b> This method is currently <b>NOT</b> implemented. </p>
<h3><a name="flush">flush</a></h3><p class="brief">Flushes any requests queued for the windowing system. </p>
<pre class="prototype">GdkDisplay.flush()</pre>
<p>This happens automatically when the main loop blocks waiting for new events, but if your application is drawing without returning control to the main loop, you may need to call this function explicitely. A common case where this function needs to be called is when an application is executing drawing commands from a thread other than the thread where the main loop is running. </p>
<p>This is most useful for X11. On windowing systems where requests are handled synchronously, this function will do nothing. </p>
<h3><a name="get_default">get_default</a></h3><p class="brief">Gets the default GdkDisplay. </p>
<pre class="prototype">GdkDisplay.get_default()</pre>
<table class="prototype">
<tbody><tr class="return"><td class="name">Return</td><td class="content">a GdkDisplay, or NULL if there is no default display. </td></tr>
</tbody>
</table>
<p>This is a convenience function for gdk_display_manager_get_default_display (gdk_display_manager_get()). </p>
<h3><a name="get_default_screen">get_default_screen</a></h3><p class="brief">Get the default GdkScreen for display. </p>
<pre class="prototype">GdkDisplay.get_default_screen()</pre>
<table class="prototype">
<tbody><tr class="return"><td class="name">Return</td><td class="content">the default GdkScreen object for display </td></tr>
</tbody>
</table>
<h3><a name="get_n_screens">get_n_screens</a></h3><p class="brief">Gets the number of screen managed by the display. </p>
<pre class="prototype">GdkDisplay.get_n_screens()</pre>
<table class="prototype">
<tbody><tr class="return"><td class="name">Return</td><td class="content">number of screens. </td></tr>
</tbody>
</table>
<h3><a name="get_name">get_name</a></h3><p class="brief">Gets the name of the display. </p>
<pre class="prototype">GdkDisplay.get_name()</pre>
<table class="prototype">
<tbody><tr class="return"><td class="name">Return</td><td class="content">a string representing the display name. </td></tr>
</tbody>
</table>
<h3><a name="get_screen">get_screen</a></h3><p class="brief">Returns a screen object for one of the screens of the display. </p>
<pre class="prototype">GdkDisplay.get_screen( screen_num )</pre>
<table class="prototype">
<tbody><tr class="param"><td class="name">screen_num</td><td class="content"> the screen number </td></tr>
<tr class="return"><td class="name">Return</td><td class="content">the GdkScreen object </td></tr>
</tbody>
</table>
<h3><a name="keyboard_ungrab">keyboard_ungrab</a></h3><p class="brief">Release any keyboard grab </p>
<pre class="prototype">GdkDisplay.keyboard_ungrab( time )</pre>
<table class="prototype">
<tbody><tr class="param"><td class="name">time</td><td class="content"> a timestap (e.g GDK_CURRENT_TIME). </td></tr>
</tbody>
</table>
<p>Warning: gdk_display_keyboard_ungrab has been deprecated since version 3.0 and should not be used in newly-written code. Use gdk_device_ungrab(), together with gdk_device_grab() instead. </p>
<h3><a name="pointer_is_grabbed">pointer_is_grabbed</a></h3><p class="brief">Test if the pointer is grabbed. </p>
<pre class="prototype">GdkDisplay.pointer_is_grabbed()</pre>
<table class="prototype">
<tbody><tr class="return"><td class="name">Return</td><td class="content">TRUE if an active X pointer grab is in effect </td></tr>
</tbody>
</table>
<p>Warning: gdk_display_pointer_is_grabbed has been deprecated since version 3.0 and should not be used in newly-written code. Use gdk_display_device_is_grabbed() instead. </p>
<h3><a name="pointer_ungrab">pointer_ungrab</a></h3><p class="brief">Release any pointer grab. </p>
<pre class="prototype">GdkDisplay.pointer_ungrab( time )</pre>
<table class="prototype">
<tbody><tr class="param"><td class="name">time</td><td class="content"> a timestamp (e.g. GDK_CURRENT_TIME). </td></tr>
</tbody>
</table>
<p>Warning: gdk_display_pointer_ungrab has been deprecated since version 3.0 and should not be used in newly-written code. Use gdk_device_ungrab(), together with gdk_device_grab() instead </p>
<h3><a name="signal_closed">signal_closed</a></h3><p class="brief">The closed signal is emitted when the connection to the windowing system for display is closed. </p>
<pre class="prototype">GdkDisplay.signal_closed()</pre>
<h3><a name="signal_opened">signal_opened</a></h3><p class="brief">The opened signal is emitted when the connection to the windowing system for display is opened. </p>
<pre class="prototype">GdkDisplay.signal_opened()</pre>
<h3><a name="sync">sync</a></h3><p class="brief">Flushes any requests queued for the windowing system and waits until all requests have been handled. </p>
<pre class="prototype">GdkDisplay.sync()</pre>
<p>This is often used for making sure that the display is synchronized with the current state of the program. Calling gdk_display_sync() before gdk_error_trap_pop() makes sure that any errors generated from earlier requests are handled before the error trap is removed. </p>
<p>This is most useful for X11. On windowing systems where requests are handled synchronously, this function will do nothing. </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_GdkCursor.html">Previous: Class GdkCursor</a></li>
<li class="next"><a href="gtk_GdkDragContext.html">Next: Class GdkDragContext</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>
