File: class-gdkdisplaymanager.html

package info (click to toggle)
python-gtk2-doc 2.5.2-1
links: PTS
area: main
in suites: sarge
size: 8,304 kB
ctags: 3,741
sloc: makefile: 38
file content (29 lines) | stat: -rw-r--r-- 12,811 bytes
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>gtk.gdk.DisplayManager</title><meta name="generator" content="DocBook XSL Stylesheets V1.65.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="previous" href="class-gdkdisplay.html" title="gtk.gdk.Display"><link rel="next" href="class-gdkdragcontext.html" title="gtk.gdk.DragContext"></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.DisplayManager</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gdkdisplay.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-gdkdragcontext.html">Next</a></td></tr></table><hr></div><div class="refentry" lang="en"><a name="class-gdkdisplaymanager"></a><div class="titlepage"><div></div><div></div></div><div class="refnamediv"><h2>gtk.gdk.DisplayManager</h2><p>gtk.gdk.DisplayManager &#8212; maintains a list of all open <a href="class-gdkdisplay.html" title="gtk.gdk.Display"><tt class="classname">gtk.gdk.Display</tt></a>
objects</p></div><div class="refsect1" lang="en"><a name="id2989884"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.gdk.DisplayManager</span></span>(<span class="ooclass"><span class="classname"><a href="class-gobject.html" title="gobject.GObject">gobject.GObject</a></span></span>):
<code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkdisplaymanager.html#method-gdkdisplaymanager--get-default-display" title="gtk.gdk.DisplayManager.get_default_display">get_default_display</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkdisplaymanager.html#method-gdkdisplaymanager--set-default-display" title="gtk.gdk.DisplayManager.set_default_display">set_default_display</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>display</tt></b></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkdisplaymanager.html#method-gdkdisplaymanager--list-displays" title="gtk.gdk.DisplayManager.list_displays">list_displays</a></span>(<span class="methodparam"></span>)</code><br></pre></td></tr></table><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting">
<span class="bold"><b>Functions</b></span>

<code class="methodsynopsis">    def <span class="methodname"><a href="class-gdkdisplaymanager.html#function-gdk--display-manager-get" title="gtk.gdk.display_manager_get">gtk.gdk.display_manager_get</a></span>(<span class="methodparam"></span>)</code></pre></td></tr></table></div><div class="refsect1" lang="en"><a name="id3005151"></a><h2>Ancestry</h2><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="synopsis">+-- <a href="class-gobject.html" title="gobject.GObject">gobject.GObject</a>
  +-- <a href="class-gdkdisplaymanager.html" title="gtk.gdk.DisplayManager">gtk.gdk.DisplayManager</a>
</pre></td></tr></table></div><div class="refsect1" lang="en"><a name="id2923483"></a><h2>Properties</h2><div class="blockquote"><table width="100%" border="0" bgcolor="#E0E0E0"><tr><td valign="top"><div class="informaltable"><table width="100%" border="0"><colgroup><col><col><col></colgroup><tbody><tr valign="top"><td valign="top">"default-display"</td><td valign="top">Read-Write</td><td valign="top">The default <a href="class-gdkdisplay.html" title="gtk.gdk.Display"><tt class="classname">gtk.gdk.Display</tt></a>. Available
in GTK+ 2.2 and above.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" lang="en"><a name="id2961939"></a><h2>Signal Prototypes</h2><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term">"<a href="class-gdkdisplaymanager.html#signal-gdkdisplaymanager--display-opened" title='The "display-opened" gtk.gdk.DisplayManager Signal'>display-opened</a>"</span></td><td><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><i class="parameter"><tt>displaymanager</tt></i></span></span>, <span class="methodparam"><span class="parameter"><i class="parameter"><tt>display</tt></i></span></span>, <span class="methodparam"><span class="parameter"><i class="parameter"><tt>user_param1</tt></i></span></span>, <span class="methodparam"><span class="parameter"><i class="parameter"><tt>...</tt></i></span></span>)</code></td></tr></tbody></table></div><div class="refsect1" lang="en"><a name="id3085475"></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>The <a href="class-gdkdisplaymanager.html" title="gtk.gdk.DisplayManager"><tt class="classname">gtk.gdk.DisplayManager</tt></a>
 is a singleton object that offers notification when displays appear or
 disappear or the default display changes. The global <a href="class-gdkdisplaymanager.html" title="gtk.gdk.DisplayManager"><tt class="classname">gtk.gdk.DisplayManager</tt></a>
 object is returned from the <a href="class-gdkdisplaymanager.html#function-gdk--display-manager-get" title="gtk.gdk.display_manager_get"><tt class="function">gtk.gdk.display_manager_get</tt>()</a>
 function.</p></div><div class="refsect1" lang="en"><a name="id3006855"></a><h2>Methods</h2><div class="refsect2" lang="en"><a name="method-gdkdisplaymanager--get-default-display"></a><h3>gtk.gdk.DisplayManager.get_default_display</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">get_default_display</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>a <a href="class-gdkdisplay.html" title="gtk.gdk.Display"><tt class="classname">gtk.gdk.Display</tt></a>,
	  or <tt class="literal">None</tt> if there is no default
	  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.2 and above.</p></div><p>The <tt class="methodname">get_default_display</tt>() method
returns the default <a href="class-gdkdisplay.html" title="gtk.gdk.Display"><tt class="classname">gtk.gdk.Display</tt></a>.</p></div><div class="refsect2" lang="en"><a name="method-gdkdisplaymanager--set-default-display"></a><h3>gtk.gdk.DisplayManager.set_default_display</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">set_default_display</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>display</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>display</tt></b>:</span></td><td>a <a href="class-gdkdisplay.html" title="gtk.gdk.Display"><tt class="classname">gtk.gdk.Display</tt></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 <tt class="methodname">set_default_display</tt>() method sets
the <a href="class-gdkdisplay.html" title="gtk.gdk.Display"><tt class="classname">gtk.gdk.Display</tt></a>
specified by <i class="parameter"><tt>display</tt></i> as the default display.</p></div><div class="refsect2" lang="en"><a name="method-gdkdisplaymanager--list-displays"></a><h3>gtk.gdk.DisplayManager.list_displays</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">list_displays</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>a list containing <a href="class-gdkdisplay.html" title="gtk.gdk.Display"><tt class="classname">gtk.gdk.Display</tt></a>
	  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 <tt class="methodname">list_displays</tt>() method returns a
list containing all currently open displays.</p></div></div><div class="refsect1" lang="en"><a name="id2937612"></a><h2>Functions</h2><div class="refsect2" lang="en"><a name="function-gdk--display-manager-get"></a><h3>gtk.gdk.display_manager_get</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">gtk.gdk.display_manager_get</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>
	  the singleton <a href="class-gdkdisplaymanager.html" title="gtk.gdk.DisplayManager"><tt class="classname">gtk.gdk.DisplayManager</tt></a>
	  object.</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 <tt class="methodname">gtk.gdk.display_manager_get</tt>()
method returns the global <a href="class-gdkdisplaymanager.html" title="gtk.gdk.DisplayManager"><tt class="classname">gtk.gdk.DisplayManager</tt></a>
singleton.</p></div></div><div class="refsect1" lang="en"><a name="id2860697"></a><h2>Signals</h2><div class="refsect2" lang="en"><a name="signal-gdkdisplaymanager--display-opened"></a><h3>The "display-opened" gtk.gdk.DisplayManager Signal</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><i class="parameter"><tt>displaymanager</tt></i></span></span>, <span class="methodparam"><span class="parameter"><i class="parameter"><tt>display</tt></i></span></span>, <span class="methodparam"><span class="parameter"><i class="parameter"><tt>user_param1</tt></i></span></span>, <span class="methodparam"><span class="parameter"><i class="parameter"><tt>...</tt></i></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><i class="parameter"><tt>displaymanager</tt></i>:</span></td><td>the displaymanager that received the
signal</td></tr><tr><td><span class="term"><i class="parameter"><tt>display</tt></i>:</span></td><td>the display that was opened</td></tr><tr><td><span class="term"><i class="parameter"><tt>user_param1</tt></i>:</span></td><td>the first user parameter (if any) specified
with the <a href="class-gobject.html#method-gobject--connect" title="gobject.GObject.connect"><tt class="methodname">connect</tt>()</a>
method</td></tr><tr><td><span class="term"><i class="parameter"><tt>...</tt></i>:</span></td><td>additional user parameters (if
any)</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This signal is available in GTK+ 2.2 and above.</p></div><p>The "display-opened" signal is emitted when  display is
opened.</p></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="class-gdkdisplay.html">Prev</a></td><td width="20%" align="center"><a accesskey="u" href="gdk-class-reference.html">Up</a></td><td width="40%" align="right"><a accesskey="n" href="class-gdkdragcontext.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">gtk.gdk.Display</td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top">gtk.gdk.DragContext</td></tr></table></div></body></html>