1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279
|
<?xml version="1.0" standalone="no"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="class-gdkdisplaymanager">
<refnamediv>
<refname>gtk.gdk.DisplayManager</refname>
<refpurpose>maintains a list of all open <link
linkend="class-gdkdisplay"><classname>gtk.gdk.Display</classname></link>
objects</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
<classsynopsis language="python">
<ooclass><classname>gtk.gdk.DisplayManager</classname></ooclass>
<ooclass><classname><link linkend="class-gobject">gobject.GObject</link></classname></ooclass>
<methodsynopsis language="python">
<methodname><link linkend="method-gdkdisplaymanager--get-default-display">get_default_display</link></methodname>
<methodparam></methodparam> </methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gdkdisplaymanager--set-default-display">set_default_display</link></methodname>
<methodparam><parameter role="keyword">display</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gdkdisplaymanager--list-displays">list_displays</link></methodname>
<methodparam></methodparam> </methodsynopsis>
</classsynopsis>
<programlisting>
<emphasis role="bold">Functions</emphasis>
<methodsynopsis language="python">
<methodname><link linkend="function-gdk--display-manager-get">gtk.gdk.display_manager_get</link></methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
</refsect1>
<refsect1>
<title>Ancestry</title>
<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
+-- <link linkend="class-gdkdisplaymanager">gtk.gdk.DisplayManager</link>
</synopsis>
</refsect1>
<refsect1>
<title>Properties</title>
<blockquote role="properties">
<informaltable pgwide="1" frame="none">
<tgroup cols="3">
<colspec column="1" colwidth="1in"/>
<colspec column="2" colwidth="1in"/>
<colspec column="3" colwidth="4in"/>
<tbody>
<row valign="top">
<entry>"default-display"</entry>
<entry>Read-Write</entry>
<entry>The default <link
linkend="class-gdkdisplay"><classname>gtk.gdk.Display</classname></link>. Available
in GTK+ 2.2 and above.</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</blockquote>
</refsect1>
<refsect1>
<title>Signal Prototypes</title>
<variablelist>
<varlistentry>
<term>"<link linkend="signal-gdkdisplaymanager--display-opened">display-opened</link>"</term>
<listitem>
<methodsynopsis language="python"><methodname>callback</methodname>
<methodparam><parameter>displaymanager</parameter></methodparam>
<methodparam><parameter>display</parameter></methodparam>
<methodparam><parameter>user_param1</parameter></methodparam>
<methodparam><parameter>...</parameter></methodparam>
</methodsynopsis>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Description</title>
<note>
<para>This object is available in PyGTK 2.2 and above.</para>
</note>
<para>The <link
linkend="class-gdkdisplaymanager"><classname>gtk.gdk.DisplayManager</classname></link>
is a singleton object that offers notification when displays appear or
disappear or the default display changes. The global <link
linkend="class-gdkdisplaymanager"><classname>gtk.gdk.DisplayManager</classname></link>
object is returned from the <link
linkend="function-gdk--display-manager-get"><function>gtk.gdk.display_manager_get</function>()</link>
function.</para>
</refsect1>
<refsect1>
<title>Methods</title>
<refsect2 id="method-gdkdisplaymanager--get-default-display">
<title>gtk.gdk.DisplayManager.get_default_display</title>
<programlisting><methodsynopsis language="python">
<methodname>get_default_display</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>a <link
linkend="class-gdkdisplay"><classname>gtk.gdk.Display</classname></link>,
or <literal>None</literal> if there is no default
display.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.2 and above.</para>
</note>
<para>The <methodname>get_default_display</methodname>() method
returns the default <link
linkend="class-gdkdisplay"><classname>gtk.gdk.Display</classname></link>.</para>
</refsect2>
<refsect2 id="method-gdkdisplaymanager--set-default-display">
<title>gtk.gdk.DisplayManager.set_default_display</title>
<programlisting><methodsynopsis language="python">
<methodname>set_default_display</methodname>
<methodparam><parameter role="keyword">display</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">display</parameter> :</term>
<listitem><simpara>a <link
linkend="class-gdkdisplay"><classname>gtk.gdk.Display</classname></link></simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.2 and above.</para>
</note>
<para>The <methodname>set_default_display</methodname>() method sets
the <link
linkend="class-gdkdisplay"><classname>gtk.gdk.Display</classname></link>
specified by <parameter>display</parameter> as the default display.</para>
</refsect2>
<refsect2 id="method-gdkdisplaymanager--list-displays">
<title>gtk.gdk.DisplayManager.list_displays</title>
<programlisting><methodsynopsis language="python">
<methodname>list_displays</methodname>
<methodparam></methodparam> </methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>a list containing <link
linkend="class-gdkdisplay"><classname>gtk.gdk.Display</classname></link>
objects.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.2 and above.</para>
</note>
<para>The <methodname>list_displays</methodname>() method returns a
list containing all currently open displays.</para>
</refsect2>
</refsect1>
<refsect1>
<title>Functions</title>
<refsect2 id="function-gdk--display-manager-get">
<title>gtk.gdk.display_manager_get</title>
<programlisting><methodsynopsis language="python">
<methodname>gtk.gdk.display_manager_get</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term> <listitem><simpara>
the singleton <link
linkend="class-gdkdisplaymanager"><classname>gtk.gdk.DisplayManager</classname></link>
object.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This function is available in PyGTK 2.2 and above.</para>
</note>
<para>The <methodname>gtk.gdk.display_manager_get</methodname>()
method returns the global <link
linkend="class-gdkdisplaymanager"><classname>gtk.gdk.DisplayManager</classname></link>
singleton.</para>
</refsect2>
</refsect1>
<refsect1>
<title>Signals</title>
<refsect2 id="signal-gdkdisplaymanager--display-opened">
<title>The "display-opened" gtk.gdk.DisplayManager Signal</title>
<programlisting><methodsynopsis language="python">
<methodname>callback</methodname>
<methodparam><parameter>displaymanager</parameter></methodparam>
<methodparam><parameter>display</parameter></methodparam>
<methodparam><parameter>user_param1</parameter></methodparam>
<methodparam><parameter>...</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter>displaymanager</parameter> :</term>
<listitem><simpara>the displaymanager that received the
signal</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>display</parameter> :</term>
<listitem><simpara>the display that was opened</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>user_param1</parameter> :</term>
<listitem><simpara>the first user parameter (if any) specified
with the <link
linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
method</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>...</parameter> :</term>
<listitem><simpara>additional user parameters (if
any)</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This signal is available in GTK+ 2.2 and above.</para>
</note>
<para>The "display-opened" signal is emitted when display is
opened.</para>
</refsect2>
</refsect1>
</refentry>
|