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
|
<?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-gdkapplaunchcontext">
<refnamediv>
<refname>gtk.gdk.AppLaunchContext</refname>
<refpurpose>Startup notification for applications.</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
<classsynopsis language="python">
<ooclass><classname>gtk.gdk.AppLaunchContext</classname></ooclass>
<ooclass><classname><link linkend="class-gioapplaunchcontext">gio.AppLaunchContext</link></classname></ooclass>
<methodsynopsis language="python">
<methodname><link linkend="method-gdkapplaunchcontext--set-desktop">set_desktop</link></methodname>
<methodparam><parameter role="keyword">desktop</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gdkapplaunchcontext--set-display">set_display</link></methodname>
<methodparam><parameter role="keyword">display</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gdkapplaunchcontext--set-icon">set_icon</link></methodname>
<methodparam><parameter role="keyword">icon</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gdkapplaunchcontext--set-icon-name">set_icon_name</link></methodname>
<methodparam><parameter role="keyword">icon_name</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gdkapplaunchcontext--set-screen">set_screen</link></methodname>
<methodparam><parameter role="keyword">screen</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gdkapplaunchcontext--set-timestamp">set_timestamp</link></methodname>
<methodparam><parameter role="keyword">timestamp</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
</refsect1>
<refsect1>
<title>Ancestry</title>
<synopsis>+-- <link linkend="class-gioapplaunchcontext">gio.AppLaunchContext</link>
+-- <link linkend="class-gdkapplaunchcontext">gtk.gdk.AppLaunchContext</link>
</synopsis>
</refsect1>
<refsect1>
<title>Description</title>
<para>
The <link linkend="class-gdkapplaunchcontext"><classname>gtk.gdk.AppLaunchContext</classname></link>
is an implementation of <link linkend="class-gioapplaunchcontext">gio.AppLaunchContext</link>
that handles launching an application in a graphical context. It provides startup notification
and allows to launch applications on a specific screen or workspace.
</para>
</refsect1>
<refsect1>
<title>Methods</title>
<refsect2 id="method-gdkapplaunchcontext--set-display">
<title>gtk.gdk.AppLaunchContext.set_display</title>
<programlisting><methodsynopsis language="python">
<methodname>set_display</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter>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.14 and above.</para>
</note>
<para>
The <methodname>set_display</methodname>() method sets the display
on which applications will be launched when using this context. See also
<methodname><link linkend="method-gdkapplaunchcontext--set-screen">set_screen</link></methodname>.
</para>
</refsect2>
<refsect2 id="method-gdkapplaunchcontext--set-desktop">
<title>gtk.gdk.AppLaunchContext.set_desktop</title>
<programlisting><methodsynopsis language="python">
<methodname>set_desktop</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter>desktop</parameter> :</term>
<listitem><simpara>the number of a workspace, or -1
</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.14 and above.</para>
</note>
<para>
The <methodname>set_desktop</methodname>() method sets the workspace
on which applications will be launched when using this context when
running under a window manager that supports multiple workspaces, as
described in the Extended Window Manager Hints.
</para>
<para>
When the workspace is not specified or desktop is set to -1, it is
up to the window manager to pick one, typically it will be the current workspace.
</para>
</refsect2>
<refsect2 id="method-gdkapplaunchcontext--set-icon">
<title>gtk.gdk.AppLaunchContext.set_icon</title>
<programlisting><methodsynopsis language="python">
<methodname>set_icon</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter>icon</parameter> :</term>
<listitem><simpara>a
<link linkend="class-gioicon"><classname>gio.Icon</classname></link>,
or <literal>None</literal>.
</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.14 and above.</para>
</note>
<para>
The <methodname>set_icon</methodname>() method sets the icon for
applications that are launched with this context. See also
<methodname><link linkend="method-gdkapplaunchcontext--set-icon-name">set_icon_name</link></methodname>.
</para>
</refsect2>
<refsect2 id="method-gdkapplaunchcontext--set-icon-name">
<title>gtk.gdk.AppLaunchContext.set_icon_name</title>
<programlisting><methodsynopsis language="python">
<methodname>set_icon_name</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter>icon_name</parameter> :</term>
<listitem><simpara>an icon name, or <literal>None</literal>.
</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.14 and above.</para>
</note>
<para>
The <methodname>set_icon_name</methodname>() method sets the icon
for applications that are launched with this context. The icon_name
will be interpreted in the same way as the Icon field in desktop files. See also
<methodname><link linkend="method-gdkapplaunchcontext--set-icon">set_icon</link></methodname>.
</para>
<para>
If both icon and icon_name are set, the icon_name takes priority.
If neither icon or icon_name is set, the icon is taken from either the
file that is passed to launched application or from the
<link linkend="class-gioappinfo"><classname>gio.AppInfo</classname></link>
for the launched application itself.
</para>
</refsect2>
<refsect2 id="method-gdkapplaunchcontext--set-timestamp">
<title>gtk.gdk.AppLaunchContext.set_timestamp</title>
<programlisting><methodsynopsis language="python">
<methodname>set_timestamp</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter>timestamp</parameter> :</term>
<listitem><simpara>a timestamp
</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.14 and above.</para>
</note>
<para>
The <methodname>set_timestamp</methodname>() method sets the timestamp of
context. The timestamp should ideally be taken from the event that triggered the launch.
</para>
<para>
Window managers can use this information to avoid moving the focus
to the newly launched application when the user is busy typing in
another window. This is also known as 'focus stealing prevention'.
</para>
</refsect2>
</refsect1>
</refentry>
|