1
<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>gtk.gdk.Display</title><link rel="stylesheet" href="style.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.73.2"><link rel="start" href="index.html" title="PyGTK 2.0 Reference Manual"><link rel="up" href="gdk-class-reference.html" title="The gtk.gdk Class Reference"><link rel="prev" href="class-gdkdevice.html" title="gtk.gdk.Device"><link rel="next" href="class-gdkdisplaymanager.html" title="gtk.gdk.DisplayManager"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">gtk.gdk.Display</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gdkdevice.html">Prev</a> </td><th width="60%" align="center">The gtk.gdk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-gdkdisplaymanager.html">Next</a></td></tr></table><hr></div><div class="refentry" lang="en"><a name="class-gdkdisplay"></a><div class="titlepage"></div><div class="refnamediv"><h2>gtk.gdk.Display</h2><p>gtk.gdk.Display — controls the keyboard/mouse pointer grabs and a set of <a class="link" href="class-gdkscreen.html" title="gtk.gdk.Screen"><code class="classname">gtk.gdk.Screen</code></a>
2
objects</p></div><div class="refsect1" lang="en"><a name="id2686666"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.gdk.Display</span></span>(<span class="ooclass"><span class="classname"><PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK></span></span>):
1
<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>gtk.gdk.Display</title><link rel="stylesheet" href="style.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.75.1"><link rel="home" href="index.html" title="PyGTK 2.0 Reference Manual"><link rel="up" href="gdk-class-reference.html" title="The gtk.gdk Class Reference"><link rel="prev" href="class-gdkdevice.html" title="gtk.gdk.Device"><link rel="next" href="class-gdkdisplaymanager.html" title="gtk.gdk.DisplayManager"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">gtk.gdk.Display</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gdkdevice.html">Prev</a> </td><th width="60%" align="center">The gtk.gdk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-gdkdisplaymanager.html">Next</a></td></tr></table><hr></div><div class="refentry" title="gtk.gdk.Display"><a name="class-gdkdisplay"></a><div class="titlepage"></div><div class="refnamediv"><h2>gtk.gdk.Display</h2><p>gtk.gdk.Display — controls the keyboard/mouse pointer grabs and a set of <a class="link" href="class-gdkscreen.html" title="gtk.gdk.Screen"><code class="classname">gtk.gdk.Screen</code></a>
2
objects</p></div><div class="refsect1" title="Synopsis"><a name="id3158891"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.gdk.Display</span></span>(<span class="ooclass"><span class="classname"><PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK></span></span>):
3
3
<code class="constructorsynopsis"> <span class="methodname"><a class="link" href="class-gdkdisplay.html#constructor-gdkdisplay" title="Constructor">gtk.gdk.Display</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>display_name</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gdkdisplay.html#method-gdkdisplay--get-name" title="gtk.gdk.Display.get_name">get_name</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gdkdisplay.html#method-gdkdisplay--get-n-screens" title="gtk.gdk.Display.get_n_screens">get_n_screens</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gdkdisplay.html#method-gdkdisplay--get-screen" title="gtk.gdk.Display.get_screen">get_screen</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>screen_num</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gdkdisplay.html#method-gdkdisplay--get-default-screen" title="gtk.gdk.Display.get_default_screen">get_default_screen</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gdkdisplay.html#method-gdkdisplay--pointer-ungrab" title="gtk.gdk.Display.pointer_ungrab">pointer_ungrab</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>time_</code></strong></span><span class="initializer">=0L</span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gdkdisplay.html#method-gdkdisplay--keyboard-ungrab" title="gtk.gdk.Display.keyboard_ungrab">keyboard_ungrab</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>time_</code></strong></span><span class="initializer">=0L</span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gdkdisplay.html#method-gdkdisplay--pointer-is-grabbed" title="gtk.gdk.Display.pointer_is_grabbed">pointer_is_grabbed</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gdkdisplay.html#method-gdkdisplay--beep" title="gtk.gdk.Display.beep">beep</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gdkdisplay.html#method-gdkdisplay--sync" title="gtk.gdk.Display.sync">sync</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gdkdisplay.html#method-gdkdisplay--close" title="gtk.gdk.Display.close">close</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gdkdisplay.html#method-gdkdisplay--list-devices" title="gtk.gdk.Display.list_devices">list_devices</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gdkdisplay.html#method-gdkdisplay--get-event" title="gtk.gdk.Display.get_event">get_event</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gdkdisplay.html#method-gdkdisplay--peek-event" title="gtk.gdk.Display.peek_event">peek_event</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gdkdisplay.html#method-gdkdisplay--put-event" title="gtk.gdk.Display.put_event">put_event</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>event</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gdkdisplay.html#method-gdkdisplay--set-double-click-time" title="gtk.gdk.Display.set_double_click_time">set_double_click_time</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>msec</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gdkdisplay.html#method-gdkdisplay--get-core-pointer" title="gtk.gdk.Display.get_core_pointer">get_core_pointer</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gdkdisplay.html#method-gdkdisplay--get-pointer" title="gtk.gdk.Display.get_pointer">get_pointer</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gdkdisplay.html#method-gdkdisplay--get-window-at-pointer" title="gtk.gdk.Display.get_window_at_pointer">get_window_at_pointer</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gdkdisplay.html#method-gdkdisplay--flush" title="gtk.gdk.Display.flush">flush</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gdkdisplay.html#method-gdkdisplay--set-double-click-distance" title="gtk.gdk.Display.set_double_click_distance">set_double_click_distance</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>distance</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gdkdisplay.html#method-gdkdisplay--supports-cursor-alpha" title="gtk.gdk.Display.supports_cursor_alpha">supports_composite</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gdkdisplay.html#method-gdkdisplay--supports-cursor-alpha" title="gtk.gdk.Display.supports_cursor_alpha">supports_cursor_alpha</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gdkdisplay.html#method-gdkdisplay--supports-cursor-color" title="gtk.gdk.Display.supports_cursor_color">supports_cursor_color</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gdkdisplay.html#method-gdkdisplay--get-default-cursor-size" title="gtk.gdk.Display.get_default_cursor_size">get_default_cursor_size</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gdkdisplay.html#method-gdkdisplay--get-maximal-cursor-size" title="gtk.gdk.Display.get_maximal_cursor_size">get_maximal_cursor_size</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gdkdisplay.html#method-gdkdisplay--get-default-group" title="gtk.gdk.Display.get_default_group">get_default_group</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gdkdisplay.html#method-gdkdisplay--supports-selection-notification" title="gtk.gdk.Display.supports_selection_notification">supports_selection_notification</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gdkdisplay.html#method-gdkdisplay--supports-clipboard-persistence" title="gtk.gdk.Display.supports_clipboard_persistence">supports_clipboard_persistence</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gdkdisplay.html#method-gdkdisplay--request-selection-notification" title="gtk.gdk.Display.request_selection_notification">request_selection_notification</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>selection</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gdkdisplay.html#method-gdkdisplay--store-clipboard" title="gtk.gdk.Display.store_clipboard">store_clipboard</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>clipboard_window</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>time_</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>targets</code></strong></span></span>)</code><br></pre></td></tr></table><pre class="programlisting">
4
4
<span class="bold"><strong>Functions</strong></span>
6
<code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gdkdisplay.html#function-gdk--display-get-default" title="gtk.gdk.display_get_default">gtk.gdk.display_get_default</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code></code></strong></span></span>)</code></pre></div><div class="refsect1" lang="en"><a name="id2843112"></a><h2>Ancestry</h2><pre class="synopsis">+-- <PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK>
6
<code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gdkdisplay.html#function-gdk--display-get-default" title="gtk.gdk.display_get_default">gtk.gdk.display_get_default</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code></code></strong></span></span>)</code></pre></div><div class="refsect1" title="Ancestry"><a name="id3074172"></a><h2>Ancestry</h2><pre class="synopsis">+-- <PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK>
7
7
+-- <a class="link" href="class-gdkdisplay.html" title="gtk.gdk.Display">gtk.gdk.Display</a>
8
</pre></div><div class="refsect1" lang="en"><a name="id2768451"></a><h2>Signal Prototypes</h2><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term">"<a class="link" href="class-gdkdisplay.html#signal-gdkdisplay--closed" title='The "closed" gtk.gdk.Display Signal'>closed</a>"</span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>widget</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>is_error</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr></tbody></table></div><div class="refsect1" lang="en"><a name="id2857270"></a><h2>Description</h2><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This object is available in PyGTK 2.2 and above.</p></div><p><a class="link" href="class-gdkdisplay.html" title="gtk.gdk.Display"><code class="classname">gtk.gdk.Display</code></a> objects provide two capabilities:</p><div class="itemizedlist"><ul type="disc"><li>To grab/ungrab keyboard focus and mouse pointer</li><li>To manage and provide information about the <a class="link" href="class-gdkscreen.html" title="gtk.gdk.Screen"><code class="classname">gtk.gdk.Screen</code></a>)
8
</pre></div><div class="refsect1" title="Signal Prototypes"><a name="id3064088"></a><h2>Signal Prototypes</h2><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term">"<a class="link" href="class-gdkdisplay.html#signal-gdkdisplay--closed" title='The "closed" gtk.gdk.Display Signal'>closed</a>"</span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>widget</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>is_error</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr></tbody></table></div><div class="refsect1" title="Description"><a name="id3059229"></a><h2>Description</h2><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This object is available in PyGTK 2.2 and above.</p></div><p><a class="link" href="class-gdkdisplay.html" title="gtk.gdk.Display"><code class="classname">gtk.gdk.Display</code></a> objects provide two capabilities:</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">To grab/ungrab keyboard focus and mouse pointer</li><li class="listitem">To manage and provide information about the <a class="link" href="class-gdkscreen.html" title="gtk.gdk.Screen"><code class="classname">gtk.gdk.Screen</code></a>)
9
9
objects available for this <a class="link" href="class-gdkdisplay.html" title="gtk.gdk.Display"><code class="classname">gtk.gdk.Display</code></a></li></ul></div><p><a class="link" href="class-gdkdisplay.html" title="gtk.gdk.Display"><code class="classname">gtk.gdk.Display</code></a>
10
10
objects are the <code class="literal">GDK</code> representation of the X Display which
11
11
can be described as a workstation consisting of a keyboard, a pointing
12
12
device (such as a mouse) and one or more screens. It is used to open and
13
13
keep track of various <a class="link" href="class-gdkscreen.html" title="gtk.gdk.Screen"><code class="classname">gtk.gdk.Screen</code></a>
14
14
objects currently instantiated by the application. It is also used to grab
15
and release the keyboard and the mouse pointer.</p></div><div class="refsect1" lang="en"><a name="constructor-gdkdisplay"></a><h2>Constructor</h2><pre class="programlisting"><code class="constructorsynopsis"> <span class="methodname">gtk.gdk.Display</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>display_name</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>display_name</code></strong> :</span></p></td><td>the name of the display to
15
and release the keyboard and the mouse pointer.</p></div><div class="refsect1" title="Constructor"><a name="constructor-gdkdisplay"></a><h2>Constructor</h2><pre class="programlisting"><code class="constructorsynopsis"> <span class="methodname">gtk.gdk.Display</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>display_name</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>display_name</code></strong> :</span></p></td><td>the name of the display to
16
16
open</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a
17
17
<a class="link" href="class-gdkdisplay.html" title="gtk.gdk.Display"><code class="classname">gtk.gdk.Display</code></a>,
18
18
or <code class="literal">None</code> if the display could not be
19
opened.</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This constructor is available in PyGTK 2.2 and above.</p></div><p>Opens the display with the name specified by
19
opened.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This constructor is available in PyGTK 2.2 and above.</p></div><p>Opens the display with the name specified by
20
20
<em class="parameter"><code>display_name</code></em> and returns a <a class="link" href="class-gdkdisplay.html" title="gtk.gdk.Display"><code class="classname">gtk.gdk.Display</code></a>
21
object wrapping the display..</p></div><div class="refsect1" lang="en"><a name="id2837859"></a><h2>Methods</h2><div class="refsect2" lang="en"><a name="method-gdkdisplay--get-name"></a><h3>gtk.gdk.Display.get_name</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_name</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a
22
string representing the display name.</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.2 and above.</p></div><p>The <code class="methodname">get_name</code>() method returns the name
23
of the display.</p></div><div class="refsect2" lang="en"><a name="method-gdkdisplay--get-n-screens"></a><h3>gtk.gdk.Display.get_n_screens</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_n_screens</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the number of display
24
screens.</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.2 and above.</p></div><p>The <code class="methodname">get_n_screens</code>() method returns the
25
number of screens managed by the display.</p></div><div class="refsect2" lang="en"><a name="method-gdkdisplay--get-screen"></a><h3>gtk.gdk.Display.get_screen</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_screen</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>screen_num</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>screen_num</code></strong> :</span></p></td><td>the screen number</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the <a class="link" href="class-gdkscreen.html" title="gtk.gdk.Screen"><code class="classname">gtk.gdk.Screen</code></a>
26
object</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.2 and above.</p></div><p>The <code class="methodname">get_screen</code>() method returns a <a class="link" href="class-gdkscreen.html" title="gtk.gdk.Screen"><code class="classname">gtk.gdk.Screen</code></a>
27
object for one of the screens of the display.</p></div><div class="refsect2" lang="en"><a name="method-gdkdisplay--get-default-screen"></a><h3>gtk.gdk.Display.get_default_screen</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_default_screen</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the default <a class="link" href="class-gdkscreen.html" title="gtk.gdk.Screen"><code class="classname">gtk.gdk.Screen</code></a>
28
object for <em class="parameter"><code>display</code></em></td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.2 and above.</p></div><p>The <code class="methodname">get_default_screen</code>() method returns
21
object wrapping the display..</p></div><div class="refsect1" title="Methods"><a name="id3098294"></a><h2>Methods</h2><div class="refsect2" title="gtk.gdk.Display.get_name"><a name="method-gdkdisplay--get-name"></a><h3>gtk.gdk.Display.get_name</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_name</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a
22
string representing the display name.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.2 and above.</p></div><p>The <code class="methodname">get_name</code>() method returns the name
23
of the display.</p></div><div class="refsect2" title="gtk.gdk.Display.get_n_screens"><a name="method-gdkdisplay--get-n-screens"></a><h3>gtk.gdk.Display.get_n_screens</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_n_screens</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the number of display
24
screens.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.2 and above.</p></div><p>The <code class="methodname">get_n_screens</code>() method returns the
25
number of screens managed by the display.</p></div><div class="refsect2" title="gtk.gdk.Display.get_screen"><a name="method-gdkdisplay--get-screen"></a><h3>gtk.gdk.Display.get_screen</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_screen</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>screen_num</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>screen_num</code></strong> :</span></p></td><td>the screen number</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the <a class="link" href="class-gdkscreen.html" title="gtk.gdk.Screen"><code class="classname">gtk.gdk.Screen</code></a>
26
object</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.2 and above.</p></div><p>The <code class="methodname">get_screen</code>() method returns a <a class="link" href="class-gdkscreen.html" title="gtk.gdk.Screen"><code class="classname">gtk.gdk.Screen</code></a>
27
object for one of the screens of the display.</p></div><div class="refsect2" title="gtk.gdk.Display.get_default_screen"><a name="method-gdkdisplay--get-default-screen"></a><h3>gtk.gdk.Display.get_default_screen</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_default_screen</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the default <a class="link" href="class-gdkscreen.html" title="gtk.gdk.Screen"><code class="classname">gtk.gdk.Screen</code></a>
28
object for <em class="parameter"><code>display</code></em></td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.2 and above.</p></div><p>The <code class="methodname">get_default_screen</code>() method returns
29
29
the default <a class="link" href="class-gdkscreen.html" title="gtk.gdk.Screen"><code class="classname">gtk.gdk.Screen</code></a> for
30
the display</p></div><div class="refsect2" lang="en"><a name="method-gdkdisplay--pointer-ungrab"></a><h3>gtk.gdk.Display.pointer_ungrab</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">pointer_ungrab</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>time_</code></strong></span><span class="initializer">=0L</span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>time_</code></strong> :</span></p></td><td>a timestamp or 0L for the current
31
time.</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.2 and above.</p></div><p>The <code class="methodname">pointer_ungrab</code>() method releases
32
any pointer grab held by the display.</p></div><div class="refsect2" lang="en"><a name="method-gdkdisplay--keyboard-ungrab"></a><h3>gtk.gdk.Display.keyboard_ungrab</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">keyboard_ungrab</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>time_</code></strong></span><span class="initializer">=0L</span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>time_</code></strong> :</span></p></td><td>a timestamp or 0L for the current
33
time.</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.2 and above.</p></div><p>The <code class="methodname">keyboard_ungrab</code>() method
34
releases any keyboard grab held by the display.</p></div><div class="refsect2" lang="en"><a name="method-gdkdisplay--pointer-is-grabbed"></a><h3>gtk.gdk.Display.pointer_is_grabbed</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">pointer_is_grabbed</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td><code class="literal">True</code> if an active X pointer
35
grab is in effect</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.2 and above.</p></div><p>The <code class="methodname">pointer_is_grabbed</code>() method returns
36
<code class="literal">True</code> if the pointer is grabbed.</p></div><div class="refsect2" lang="en"><a name="method-gdkdisplay--beep"></a><h3>gtk.gdk.Display.beep</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">beep</span>(<span class="methodparam"></span>)</code></pre><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.2 and above.</p></div><p>The <code class="methodname">beep</code>() method
37
emits a short beep on the display.</p></div><div class="refsect2" lang="en"><a name="method-gdkdisplay--sync"></a><h3>gtk.gdk.Display.sync</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">sync</span>(<span class="methodparam"></span>)</code></pre><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.2 and above.</p></div><p>The <code class="methodname">sync</code>() method flushes any requests
30
the display</p></div><div class="refsect2" title="gtk.gdk.Display.pointer_ungrab"><a name="method-gdkdisplay--pointer-ungrab"></a><h3>gtk.gdk.Display.pointer_ungrab</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">pointer_ungrab</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>time_</code></strong></span><span class="initializer">=0L</span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>time_</code></strong> :</span></p></td><td>a timestamp or 0L for the current
31
time.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.2 and above.</p></div><p>The <code class="methodname">pointer_ungrab</code>() method releases
32
any pointer grab held by the display.</p></div><div class="refsect2" title="gtk.gdk.Display.keyboard_ungrab"><a name="method-gdkdisplay--keyboard-ungrab"></a><h3>gtk.gdk.Display.keyboard_ungrab</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">keyboard_ungrab</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>time_</code></strong></span><span class="initializer">=0L</span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>time_</code></strong> :</span></p></td><td>a timestamp or 0L for the current
33
time.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.2 and above.</p></div><p>The <code class="methodname">keyboard_ungrab</code>() method
34
releases any keyboard grab held by the display.</p></div><div class="refsect2" title="gtk.gdk.Display.pointer_is_grabbed"><a name="method-gdkdisplay--pointer-is-grabbed"></a><h3>gtk.gdk.Display.pointer_is_grabbed</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">pointer_is_grabbed</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td><code class="literal">True</code> if an active X pointer
35
grab is in effect</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.2 and above.</p></div><p>The <code class="methodname">pointer_is_grabbed</code>() method returns
36
<code class="literal">True</code> if the pointer is grabbed.</p></div><div class="refsect2" title="gtk.gdk.Display.beep"><a name="method-gdkdisplay--beep"></a><h3>gtk.gdk.Display.beep</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">beep</span>(<span class="methodparam"></span>)</code></pre><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.2 and above.</p></div><p>The <code class="methodname">beep</code>() method
37
emits a short beep on the display.</p></div><div class="refsect2" title="gtk.gdk.Display.sync"><a name="method-gdkdisplay--sync"></a><h3>gtk.gdk.Display.sync</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">sync</span>(<span class="methodparam"></span>)</code></pre><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.2 and above.</p></div><p>The <code class="methodname">sync</code>() method flushes any requests
38
38
queued for the windowing system and waits until all requests have been
39
39
handled. This is often used for making sure that the display is synchronized
40
40
with the current state of the program. This is most useful for X11. On
41
41
windowing systems where requests are handled synchronously, this method will
42
do nothing.</p></div><div class="refsect2" lang="en"><a name="method-gdkdisplay--close"></a><h3>gtk.gdk.Display.close</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">close</span>(<span class="methodparam"></span>)</code></pre><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.2 and above.</p></div><p>The <code class="methodname">close</code>() method closes the
42
do nothing.</p></div><div class="refsect2" title="gtk.gdk.Display.close"><a name="method-gdkdisplay--close"></a><h3>gtk.gdk.Display.close</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">close</span>(<span class="methodparam"></span>)</code></pre><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.2 and above.</p></div><p>The <code class="methodname">close</code>() method closes the
43
43
connection to the windowing system for the given display, and cleans up
44
associated resources.</p></div><div class="refsect2" lang="en"><a name="method-gdkdisplay--list-devices"></a><h3>gtk.gdk.Display.list_devices</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">list_devices</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a list of <a class="link" href="class-gdkdevice.html" title="gtk.gdk.Device"><code class="classname">gtk.gdk.Device</code></a>
45
objects.</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.2 and above.</p></div><p>The <code class="methodname">list_devices</code>() method returns the
46
list of available input devices attached to the display.</p></div><div class="refsect2" lang="en"><a name="method-gdkdisplay--get-event"></a><h3>gtk.gdk.Display.get_event</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_event</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the next <a class="link" href="class-gdkevent.html" title="gtk.gdk.Event"><code class="classname">gtk.gdk.Event</code></a>
44
associated resources.</p></div><div class="refsect2" title="gtk.gdk.Display.list_devices"><a name="method-gdkdisplay--list-devices"></a><h3>gtk.gdk.Display.list_devices</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">list_devices</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a list of <a class="link" href="class-gdkdevice.html" title="gtk.gdk.Device"><code class="classname">gtk.gdk.Device</code></a>
45
objects.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.2 and above.</p></div><p>The <code class="methodname">list_devices</code>() method returns the
46
list of available input devices attached to the display.</p></div><div class="refsect2" title="gtk.gdk.Display.get_event"><a name="method-gdkdisplay--get-event"></a><h3>gtk.gdk.Display.get_event</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_event</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the next <a class="link" href="class-gdkevent.html" title="gtk.gdk.Event"><code class="classname">gtk.gdk.Event</code></a>
47
47
to be processed, or <code class="literal">None</code> if no events are
48
pending..</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.2 and above.</p></div><p>The <code class="methodname">get_event</code>() method returns the next
48
pending..</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.2 and above.</p></div><p>The <code class="methodname">get_event</code>() method returns the next
49
49
<a class="link" href="class-gdkevent.html" title="gtk.gdk.Event"><code class="classname">gtk.gdk.Event</code></a>
50
50
to be processed for the display, fetching events from the windowing system
51
51
if necessary. The returned <a class="link" href="class-gdkevent.html" title="gtk.gdk.Event"><code class="classname">gtk.gdk.Event</code></a> should
52
52
be freed with the <a class="link" href="class-gdkevent.html#method-gdkevent--free" title="gtk.gdk.Event.free"><code class="methodname">gtk.gdk.Event.free()</code></a>
53
method </p></div><div class="refsect2" lang="en"><a name="method-gdkdisplay--peek-event"></a><h3>gtk.gdk.Display.peek_event</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">peek_event</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a copy of the first <a class="link" href="class-gdkevent.html" title="gtk.gdk.Event"><code class="classname">gtk.gdk.Event</code></a>
53
method </p></div><div class="refsect2" title="gtk.gdk.Display.peek_event"><a name="method-gdkdisplay--peek-event"></a><h3>gtk.gdk.Display.peek_event</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">peek_event</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a copy of the first <a class="link" href="class-gdkevent.html" title="gtk.gdk.Event"><code class="classname">gtk.gdk.Event</code></a>
54
54
on the event queue, or <code class="literal">None</code> if no events are in
55
the queue.</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.2 and above.</p></div><p>The <code class="methodname">peek_event</code>() method returns a copy
55
the queue.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.2 and above.</p></div><p>The <code class="methodname">peek_event</code>() method returns a copy
56
56
of the first <a class="link" href="class-gdkevent.html" title="gtk.gdk.Event"><code class="classname">gtk.gdk.Event</code></a> in the
57
57
the display's event queue, without removing the event from the queue. (Note
58
58
that this method will not get more events from the windowing system. It only
59
59
checks the events that have already been moved to the <code class="literal">GDK</code>
60
60
event queue.) The returned <a class="link" href="class-gdkevent.html" title="gtk.gdk.Event"><code class="classname">gtk.gdk.Event</code></a> should
61
be freed with <a class="link" href="class-gdkevent.html#method-gdkevent--free" title="gtk.gdk.Event.free"><code class="methodname">gtk.gdk.Event.free()</code></a>.</p></div><div class="refsect2" lang="en"><a name="method-gdkdisplay--put-event"></a><h3>gtk.gdk.Display.put_event</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">put_event</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>event</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>event</code></strong> :</span></p></td><td>a <a class="link" href="class-gdkevent.html" title="gtk.gdk.Event"><code class="classname">gtk.gdk.Event</code></a>.</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.2 and above.</p></div><p>The <code class="methodname">put_event</code>() method appends a copy
62
of the given event onto the front of the event queue for the display.</p></div><div class="refsect2" lang="en"><a name="method-gdkdisplay--set-double-click-time"></a><h3>gtk.gdk.Display.set_double_click_time</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_double_click_time</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>msec</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>msec</code></strong> :</span></p></td><td>the double click time in milliseconds
63
(thousandths of a second)</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.2 and above.</p></div><p>The <code class="methodname">set_double_click_time</code>() method sets
61
be freed with <a class="link" href="class-gdkevent.html#method-gdkevent--free" title="gtk.gdk.Event.free"><code class="methodname">gtk.gdk.Event.free()</code></a>.</p></div><div class="refsect2" title="gtk.gdk.Display.put_event"><a name="method-gdkdisplay--put-event"></a><h3>gtk.gdk.Display.put_event</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">put_event</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>event</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>event</code></strong> :</span></p></td><td>a <a class="link" href="class-gdkevent.html" title="gtk.gdk.Event"><code class="classname">gtk.gdk.Event</code></a>.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.2 and above.</p></div><p>The <code class="methodname">put_event</code>() method appends a copy
62
of the given event onto the front of the event queue for the display.</p></div><div class="refsect2" title="gtk.gdk.Display.set_double_click_time"><a name="method-gdkdisplay--set-double-click-time"></a><h3>gtk.gdk.Display.set_double_click_time</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_double_click_time</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>msec</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>msec</code></strong> :</span></p></td><td>the double click time in milliseconds
63
(thousandths of a second)</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.2 and above.</p></div><p>The <code class="methodname">set_double_click_time</code>() method sets
64
64
the double click time (two clicks within this time interval count as a
65
65
double click and result in a <code class="literal">gtk.gdk._2BUTTON_PRESS</code>
66
66
event). Applications should <span class="emphasis"><em>not</em></span> set this, it is a
67
global user-configured setting.</p></div><div class="refsect2" lang="en"><a name="method-gdkdisplay--get-core-pointer"></a><h3>gtk.gdk.Display.get_core_pointer</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_core_pointer</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the core pointer device</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.2 and above.</p></div><p>The <code class="methodname">get_core_pointer</code>() method returns
68
the core pointer device for the given display</p></div><div class="refsect2" lang="en"><a name="method-gdkdisplay--get-pointer"></a><h3>gtk.gdk.Display.get_pointer</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_pointer</span>()</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a 4-tuple containing the screen that the cursor
67
global user-configured setting.</p></div><div class="refsect2" title="gtk.gdk.Display.get_core_pointer"><a name="method-gdkdisplay--get-core-pointer"></a><h3>gtk.gdk.Display.get_core_pointer</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_core_pointer</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the core pointer device</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.2 and above.</p></div><p>The <code class="methodname">get_core_pointer</code>() method returns
68
the core pointer device for the given display</p></div><div class="refsect2" title="gtk.gdk.Display.get_pointer"><a name="method-gdkdisplay--get-pointer"></a><h3>gtk.gdk.Display.get_pointer</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_pointer</span>()</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a 4-tuple containing the screen that the cursor
69
69
is on, the root window X and Y coordinates of the pointer and the
70
current modifier mask</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.2 and above.</p></div><p>The <code class="methodname">get_pointer</code>() method returns a
70
current modifier mask</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.2 and above.</p></div><p>The <code class="methodname">get_pointer</code>() method returns a
71
71
4-tuple containing the <a class="link" href="class-gdkscreen.html" title="gtk.gdk.Screen"><code class="classname">gtk.gdk.Screen</code></a> that
72
72
the pointer is on, the current location coordinates of the pointer and the
73
73
current modifier mask for the display. The returned modifier mask is a
74
combination of the <a class="xref" href="gdk-constants.html#gdk-modifier-constants" title="GDK Modifier Constants">GDK Modifier Constants</a>.</p></div><div class="refsect2" lang="en"><a name="method-gdkdisplay--get-window-at-pointer"></a><h3>gtk.gdk.Display.get_window_at_pointer</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_window_at_pointer</span>()</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a 3-tuple containing the <a class="link" href="class-gdkwindow.html" title="gtk.gdk.Window"><code class="classname">gtk.gdk.Window</code></a>
74
combination of the <a class="xref" href="gdk-constants.html#gdk-modifier-constants" title="GDK Modifier Constants">GDK Modifier Constants</a>.</p></div><div class="refsect2" title="gtk.gdk.Display.get_window_at_pointer"><a name="method-gdkdisplay--get-window-at-pointer"></a><h3>gtk.gdk.Display.get_window_at_pointer</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_window_at_pointer</span>()</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a 3-tuple containing the <a class="link" href="class-gdkwindow.html" title="gtk.gdk.Window"><code class="classname">gtk.gdk.Window</code></a>
75
75
under the mouse pointer and the x and y coordinates of the window
76
origin</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.2 and above.</p></div><p>The <code class="methodname">get_window_at_pointer</code>() method
76
origin</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.2 and above.</p></div><p>The <code class="methodname">get_window_at_pointer</code>() method
77
77
returns a 3-tuple containing the <a class="link" href="class-gdkwindow.html" title="gtk.gdk.Window"><code class="classname">gtk.gdk.Window</code></a>
78
78
underneath the mouse pointer and the location of that window's
79
79
origin. Returns <code class="literal">None</code> if the window under the mouse
80
80
pointer is not known to <code class="literal">GDK</code> (for example, belongs to
81
another application).</p></div><div class="refsect2" lang="en"><a name="method-gdkdisplay--flush"></a><h3>gtk.gdk.Display.flush</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">flush</span>(<span class="methodparam"></span>)</code></pre><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">flush</code>() method flushes any requests
81
another application).</p></div><div class="refsect2" title="gtk.gdk.Display.flush"><a name="method-gdkdisplay--flush"></a><h3>gtk.gdk.Display.flush</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">flush</span>(<span class="methodparam"></span>)</code></pre><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">flush</code>() method flushes any requests
82
82
queued for the windowing system; this happens automatically when the main
83
83
loop blocks waiting for new events, but if your application is drawing
84
84
without returning control to the main loop, you may need to call this method
85
85
explicitly. A common case where this method needs to be called is when an
86
86
application is executing drawing commands from a thread other than the
87
87
thread where the main loop is running.</p><p>This is most useful for X11. On windowing systems where requests
88
are handled synchronously, this method will do nothing.</p></div><div class="refsect2" lang="en"><a name="method-gdkdisplay--set-double-click-distance"></a><h3>gtk.gdk.Display.set_double_click_distance</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_double_click_distance</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>distance</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>distance</code></strong> :</span></p></td><td>the distance in pixels</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">set_double_click_distance</code>() method
88
are handled synchronously, this method will do nothing.</p></div><div class="refsect2" title="gtk.gdk.Display.set_double_click_distance"><a name="method-gdkdisplay--set-double-click-distance"></a><h3>gtk.gdk.Display.set_double_click_distance</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_double_click_distance</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>distance</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>distance</code></strong> :</span></p></td><td>the distance in pixels</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">set_double_click_distance</code>() method
89
89
sets the double click distance (two clicks within this distance count as a
90
90
double click and result in a <code class="literal">gtk.gdk.2BUTTON_PRESS</code>
91
91
event). See the <a class="link" href="class-gdkdisplay.html#method-gdkdisplay--set-double-click-time" title="gtk.gdk.Display.set_double_click_time"><code class="methodname">set_double_click_time()</code></a>
92
92
method for more information. Applications should <span class="emphasis"><em>not</em></span>
93
set this, it is a global user-configured setting.</p></div><div class="refsect2" lang="en"><a name="method-gdkdisplay--supports-composite"></a><h3>gtk.gdk.Display.supports_composite</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">supports_composite</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td><code class="literal">True</code> if windows may be composited.</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.12 and above.</p></div><p>The <code class="methodname">supports_composite</code>() method
93
set this, it is a global user-configured setting.</p></div><div class="refsect2" title="gtk.gdk.Display.supports_composite"><a name="method-gdkdisplay--supports-composite"></a><h3>gtk.gdk.Display.supports_composite</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">supports_composite</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td><code class="literal">True</code> if windows may be composited.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.12 and above.</p></div><p>The <code class="methodname">supports_composite</code>() method
94
94
returns <code class="literal">True</code> if <PYGTKDOCLINK HREF="method-gdkwindow--set-composite">
95
95
<code class="methodname">gtk.gdk.Window.set_composite</code></PYGTKDOCLINK>() can be used to redirect
96
96
drawing on the window using compositing.
98
98
Currently this only works on X11 with XComposite and XDamage extensions available.
99
</p></div><div class="refsect2" lang="en"><a name="method-gdkdisplay--supports-cursor-alpha"></a><h3>gtk.gdk.Display.supports_cursor_alpha</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">supports_cursor_alpha</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td><code class="literal">True</code> if cursors can have
100
alpha channels.</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">supports_cursor_alpha</code>() method
99
</p></div><div class="refsect2" title="gtk.gdk.Display.supports_cursor_alpha"><a name="method-gdkdisplay--supports-cursor-alpha"></a><h3>gtk.gdk.Display.supports_cursor_alpha</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">supports_cursor_alpha</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td><code class="literal">True</code> if cursors can have
100
alpha channels.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">supports_cursor_alpha</code>() method
101
101
returns <code class="literal">True</code> if cursors can use an 8bit alpha channel on
102
102
the display. Otherwise, cursors are restricted to bilevel alpha (i.e. a
103
mask).</p></div><div class="refsect2" lang="en"><a name="method-gdkdisplay--supports-cursor-color"></a><h3>gtk.gdk.Display.supports_cursor_color</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">supports_cursor_color</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td><code class="literal">True</code> if cursors can have
104
multiple colors.</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">supports_cursor_color</code>() method
103
mask).</p></div><div class="refsect2" title="gtk.gdk.Display.supports_cursor_color"><a name="method-gdkdisplay--supports-cursor-color"></a><h3>gtk.gdk.Display.supports_cursor_color</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">supports_cursor_color</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td><code class="literal">True</code> if cursors can have
104
multiple colors.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">supports_cursor_color</code>() method
105
105
returns <code class="literal">True</code> if multicolored cursors are supported on the
106
106
display. Otherwise, cursors have only a foreground and a background
107
color.</p></div><div class="refsect2" lang="en"><a name="method-gdkdisplay--get-default-cursor-size"></a><h3>gtk.gdk.Display.get_default_cursor_size</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_default_cursor_size</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the default cursor size.</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">get_default_cursor_size</code>() method
108
returns the default size to use for cursors on the display.</p></div><div class="refsect2" lang="en"><a name="method-gdkdisplay--get-maximal-cursor-size"></a><h3>gtk.gdk.Display.get_maximal_cursor_size</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_maximal_cursor_size</span>()</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a 2-tuple containing the maximal cursor width
109
and height</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">get_maximal_cursor_size</code>() method
107
color.</p></div><div class="refsect2" title="gtk.gdk.Display.get_default_cursor_size"><a name="method-gdkdisplay--get-default-cursor-size"></a><h3>gtk.gdk.Display.get_default_cursor_size</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_default_cursor_size</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the default cursor size.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">get_default_cursor_size</code>() method
108
returns the default size to use for cursors on the display.</p></div><div class="refsect2" title="gtk.gdk.Display.get_maximal_cursor_size"><a name="method-gdkdisplay--get-maximal-cursor-size"></a><h3>gtk.gdk.Display.get_maximal_cursor_size</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_maximal_cursor_size</span>()</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a 2-tuple containing the maximal cursor width
109
and height</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">get_maximal_cursor_size</code>() method
110
110
returns a 2-tuple containing the maximum width and height to use for cursors
111
on the display.</p></div><div class="refsect2" lang="en"><a name="method-gdkdisplay--get-default-group"></a><h3>gtk.gdk.Display.get_default_group</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_default_group</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>The default group leader window for the
112
display</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">get_default_group</code>() method returns
111
on the display.</p></div><div class="refsect2" title="gtk.gdk.Display.get_default_group"><a name="method-gdkdisplay--get-default-group"></a><h3>gtk.gdk.Display.get_default_group</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_default_group</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>The default group leader window for the
112
display</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">get_default_group</code>() method returns
113
113
the default group leader window for all toplevel windows on the
114
114
display. This window is implicitly created by <code class="literal">GDK</code>. See
115
115
the <a class="link" href="class-gdkwindow.html#method-gdkwindow--set-group" title="gtk.gdk.Window.set_group"><code class="methodname">gtk.gdk.Window.set_group()</code></a>
116
method for more information.</p></div><div class="refsect2" lang="en"><a name="method-gdkdisplay--supports-selection-notification"></a><h3>gtk.gdk.Display.supports_selection_notification</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_default_group</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td><code class="literal">True</code> if
116
method for more information.</p></div><div class="refsect2" title="gtk.gdk.Display.supports_selection_notification"><a name="method-gdkdisplay--supports-selection-notification"></a><h3>gtk.gdk.Display.supports_selection_notification</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_default_group</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td><code class="literal">True</code> if
117
117
<code class="literal">gtk.gdk.EventOwnerChange</code> events will be
118
sent.</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.6 and above.</p></div><p>The <code class="methodname">supports_selection_notification</code>()
118
sent.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.6 and above.</p></div><p>The <code class="methodname">supports_selection_notification</code>()
119
119
method returns <code class="literal">True</code> if
120
120
<code class="literal">gtk.gdk.EventOwnerChange</code> events will be sent when the
121
owner of a selection changes.</p></div><div class="refsect2" lang="en"><a name="method-gdkdisplay--supports-clipboard-persistence"></a><h3>gtk.gdk.Display.supports_clipboard_persistence</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">supports_clipboard_persistence</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td><code class="literal">True</code> if the display
122
supports clipboard persistence.</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.6 and above.</p></div><p>The <code class="methodname">supports_clipboard_persistence</code>()
121
owner of a selection changes.</p></div><div class="refsect2" title="gtk.gdk.Display.supports_clipboard_persistence"><a name="method-gdkdisplay--supports-clipboard-persistence"></a><h3>gtk.gdk.Display.supports_clipboard_persistence</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">supports_clipboard_persistence</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td><code class="literal">True</code> if the display
122
supports clipboard persistence.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.6 and above.</p></div><p>The <code class="methodname">supports_clipboard_persistence</code>()
123
123
method Returns whether the specified display supports clipboard persistence;
124
124
i.e. if it's possible to store the clipboard data after an application has
125
quit. On X11 this checks if a clipboard daemon is running.</p></div><div class="refsect2" lang="en"><a name="method-gdkdisplay--request-selection-notification"></a><h3>gtk.gdk.Display.request_selection_notification</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">request_selection_notification</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>selection</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>selection</code></strong> :</span></p></td><td>The string (or <a class="link" href="class-gdkatom.html" title="gtk.gdk.Atom"><code class="classname">gtk.gdk.Atom</code></a>) naming
125
quit. On X11 this checks if a clipboard daemon is running.</p></div><div class="refsect2" title="gtk.gdk.Display.request_selection_notification"><a name="method-gdkdisplay--request-selection-notification"></a><h3>gtk.gdk.Display.request_selection_notification</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">request_selection_notification</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>selection</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>selection</code></strong> :</span></p></td><td>The string (or <a class="link" href="class-gdkatom.html" title="gtk.gdk.Atom"><code class="classname">gtk.gdk.Atom</code></a>) naming
126
126
the selection for which ownership change notification is
127
requested</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.6 and above.</p></div><p>The <code class="methodname">request_selection_notification</code>()
127
requested</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.6 and above.</p></div><p>The <code class="methodname">request_selection_notification</code>()
128
128
method requests that <code class="literal">gtk.gdk.EventOwnerChange</code> events will
129
129
be sent for changes in ownership of the atom specified by
130
<em class="parameter"><code>selection</code></em>.</p></div><div class="refsect2" lang="en"><a name="method-gdkdisplay--store-clipboard"></a><h3>gtk.gdk.Display.store_clipboard</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">store_clipboard</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>clipboard_window</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>time</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>targets</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>clipboard_window</code></strong> :</span></p></td><td> a <a class="link" href="class-gdkwindow.html" title="gtk.gdk.Window"><code class="classname">gtk.gdk.Window</code></a>
130
<em class="parameter"><code>selection</code></em>.</p></div><div class="refsect2" title="gtk.gdk.Display.store_clipboard"><a name="method-gdkdisplay--store-clipboard"></a><h3>gtk.gdk.Display.store_clipboard</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">store_clipboard</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>clipboard_window</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>time</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>targets</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>clipboard_window</code></strong> :</span></p></td><td> a <a class="link" href="class-gdkwindow.html" title="gtk.gdk.Window"><code class="classname">gtk.gdk.Window</code></a>
131
131
belonging to the clipboard owner</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>time</code></strong> :</span></p></td><td>a timestamp</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>targets</code></strong> :</span></p></td><td>a list of targets that should be saved, or
132
132
<code class="literal">None</code> if all available targets should be
133
saved.</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.6 and above.</p></div><p>The <code class="methodname">store_clipboard</code>() method issues a
133
saved.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.6 and above.</p></div><p>The <code class="methodname">store_clipboard</code>() method issues a
134
134
request to the the clipboard manager to store the clipboard data. On X11,
135
135
this is a special program that works according to the freedesktop clipboard
136
specification, available at <a class="ulink" href="http://www.freedesktop.org/Standards/clipboard-manager-spec" target="_top">http://www.freedesktop.org/Standards/clipboard-manager-spec</a>.</p></div></div><div class="refsect1" lang="en"><a name="id2849120"></a><h2>Functions</h2><div class="refsect2" lang="en"><a name="function-gdk--display-get-default"></a><h3>gtk.gdk.display_get_default</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.gdk.display_get_default</span>()</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a <a class="link" href="class-gdkdisplay.html" title="gtk.gdk.Display"><code class="classname">gtk.gdk.Display</code></a>,
136
specification, available at <a class="ulink" href="http://www.freedesktop.org/Standards/clipboard-manager-spec" target="_top">http://www.freedesktop.org/Standards/clipboard-manager-spec</a>.</p></div></div><div class="refsect1" title="Functions"><a name="id3073936"></a><h2>Functions</h2><div class="refsect2" title="gtk.gdk.display_get_default"><a name="function-gdk--display-get-default"></a><h3>gtk.gdk.display_get_default</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.gdk.display_get_default</span>()</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a <a class="link" href="class-gdkdisplay.html" title="gtk.gdk.Display"><code class="classname">gtk.gdk.Display</code></a>,
137
137
or <code class="literal">None</code> if there is no default
138
display.</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This function is available in PyGTK 2.2 and above.</p></div><p>The <code class="function">gtk.gdk.display_get_default</code>() function
138
display.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This function is available in PyGTK 2.2 and above.</p></div><p>The <code class="function">gtk.gdk.display_get_default</code>() function
139
139
returns the default <a class="link" href="class-gdkdisplay.html" title="gtk.gdk.Display"><code class="classname">gtk.gdk.Display</code></a>. This
140
140
is a convenience function for:</p><pre class="programlisting">
141
141
display_manager = gtk.gdk.display_manager_get()
142
142
display = display.manager.get_default_display()
143
</pre></div></div><div class="refsect1" lang="en"><a name="id2950003"></a><h2>Signals</h2><div class="refsect2" lang="en"><a name="signal-gdkdisplay--closed"></a><h3>The "closed" gtk.gdk.Display Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>display</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>is_error</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><em class="parameter"><code>display</code></em> :</span></p></td><td>the display that received the
143
</pre></div></div><div class="refsect1" title="Signals"><a name="id3091614"></a><h2>Signals</h2><div class="refsect2" title='The "closed" gtk.gdk.Display Signal'><a name="signal-gdkdisplay--closed"></a><h3>The "closed" gtk.gdk.Display Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>display</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>is_error</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><em class="parameter"><code>display</code></em> :</span></p></td><td>the display that received the
144
144
signal</td></tr><tr><td><p><span class="term"><em class="parameter"><code>is_error</code></em> :</span></p></td><td><code class="literal">True</code> if the display was
145
145
closed due to an error</td></tr><tr><td><p><span class="term"><em class="parameter"><code>user_param1</code></em> :</span></p></td><td>the first user parameter (if any) specified
146
146
with the <PYGTKDOCLINK HREF="method-gobject--connect"><code class="methodname">connect</code>()</PYGTKDOCLINK>