39
39
</tr></table></div>
40
40
<div class="refsynopsisdiv">
41
41
<a name="shell-ShellApp.synopsis"></a><h2>Synopsis</h2>
42
<a name="ShellAppState"></a><pre class="synopsis">struct <a class="link" href="shell-ShellApp.html#ShellAppClass" title="struct ShellAppClass">ShellAppClass</a>;
42
<a name="ShellAppState"></a><pre class="synopsis"> <a class="link" href="shell-ShellApp.html#ShellAppAction" title="ShellAppAction">ShellAppAction</a>;
43
struct <a class="link" href="shell-ShellApp.html#ShellAppClass" title="struct ShellAppClass">ShellAppClass</a>;
43
44
enum <a class="link" href="shell-ShellApp.html#ShellAppState-enum" title="enum ShellAppState">ShellAppState</a>;
45
<span class="returnvalue">void</span> <a class="link" href="shell-ShellApp.html#shell-app-activate" title="shell_app_activate ()">shell_app_activate</a> (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>);
46
<span class="returnvalue">void</span> <a class="link" href="shell-ShellApp.html#shell-app-activate-full" title="shell_app_activate_full ()">shell_app_activate_full</a> (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>,
47
<em class="parameter"><code><span class="type">int</span> workspace</code></em>,
48
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> timestamp</code></em>);
49
<span class="returnvalue">void</span> <a class="link" href="shell-ShellApp.html#shell-app-activate-window" title="shell_app_activate_window ()">shell_app_activate_window</a> (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>,
50
<em class="parameter"><code><span class="type">MetaWindow</span> *window</code></em>,
51
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> timestamp</code></em>);
52
<span class="returnvalue">int</span> <a class="link" href="shell-ShellApp.html#shell-app-compare" title="shell_app_compare ()">shell_app_compare</a> (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>,
53
<em class="parameter"><code><span class="type">ShellApp</span> *other</code></em>);
54
<span class="returnvalue">int</span> <a class="link" href="shell-ShellApp.html#shell-app-compare-by-name" title="shell_app_compare_by_name ()">shell_app_compare_by_name</a> (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>,
55
<em class="parameter"><code><span class="type">ShellApp</span> *other</code></em>);
56
<a href="/usr/share/gtk-doc/html/clutter/ClutterActor.html"><span class="returnvalue">ClutterActor</span></a> * <a class="link" href="shell-ShellApp.html#shell-app-create-icon-texture" title="shell_app_create_icon_texture ()">shell_app_create_icon_texture</a> (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>,
57
<em class="parameter"><code><span class="type">int</span> size</code></em>);
58
<a href="http://library.gnome.org/devel/gio/unstable/gio-Desktop-file-based-GAppInfo.html#GDesktopAppInfo"><span class="returnvalue">GDesktopAppInfo</span></a> * <a class="link" href="shell-ShellApp.html#shell-app-get-app-info" title="shell_app_get_app_info ()">shell_app_get_app_info</a> (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>);
59
const <span class="returnvalue">char</span> * <a class="link" href="shell-ShellApp.html#shell-app-get-description" title="shell_app_get_description ()">shell_app_get_description</a> (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>);
60
<a href="/usr/share/gtk-doc/html/clutter/ClutterActor.html"><span class="returnvalue">ClutterActor</span></a> * <a class="link" href="shell-ShellApp.html#shell-app-get-faded-icon" title="shell_app_get_faded_icon ()">shell_app_get_faded_icon</a> (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>,
61
<em class="parameter"><code><span class="type">int</span> size</code></em>);
44
62
const <span class="returnvalue">char</span> * <a class="link" href="shell-ShellApp.html#shell-app-get-id" title="shell_app_get_id ()">shell_app_get_id</a> (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>);
63
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> <a class="link" href="shell-ShellApp.html#shell-app-get-n-windows" title="shell_app_get_n_windows ()">shell_app_get_n_windows</a> (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>);
64
const <span class="returnvalue">char</span> * <a class="link" href="shell-ShellApp.html#shell-app-get-name" title="shell_app_get_name ()">shell_app_get_name</a> (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>);
65
<a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> * <a class="link" href="shell-ShellApp.html#shell-app-get-pids" title="shell_app_get_pids ()">shell_app_get_pids</a> (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>);
66
<a class="link" href="shell-ShellApp.html#ShellAppState"><span class="returnvalue">ShellAppState</span></a> <a class="link" href="shell-ShellApp.html#shell-app-get-state" title="shell_app_get_state ()">shell_app_get_state</a> (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>);
45
67
<span class="returnvalue">GMenuTreeEntry</span> * <a class="link" href="shell-ShellApp.html#shell-app-get-tree-entry" title="shell_app_get_tree_entry ()">shell_app_get_tree_entry</a> (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>);
46
<span class="returnvalue">GDesktopAppInfo</span> * <a class="link" href="shell-ShellApp.html#shell-app-get-app-info" title="shell_app_get_app_info ()">shell_app_get_app_info</a> (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>);
47
<span class="returnvalue">ClutterActor</span> * <a class="link" href="shell-ShellApp.html#shell-app-create-icon-texture" title="shell_app_create_icon_texture ()">shell_app_create_icon_texture</a> (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>,
48
<em class="parameter"><code><span class="type">int</span> size</code></em>);
49
<span class="returnvalue">ClutterActor</span> * <a class="link" href="shell-ShellApp.html#shell-app-get-faded-icon" title="shell_app_get_faded_icon ()">shell_app_get_faded_icon</a> (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>,
50
<em class="parameter"><code><span class="type">int</span> size</code></em>);
51
const <span class="returnvalue">char</span> * <a class="link" href="shell-ShellApp.html#shell-app-get-name" title="shell_app_get_name ()">shell_app_get_name</a> (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>);
52
const <span class="returnvalue">char</span> * <a class="link" href="shell-ShellApp.html#shell-app-get-description" title="shell_app_get_description ()">shell_app_get_description</a> (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>);
53
<span class="returnvalue">gboolean</span> <a class="link" href="shell-ShellApp.html#shell-app-is-window-backed" title="shell_app_is_window_backed ()">shell_app_is_window_backed</a> (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>);
54
<span class="returnvalue">void</span> <a class="link" href="shell-ShellApp.html#shell-app-activate-window" title="shell_app_activate_window ()">shell_app_activate_window</a> (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>,
55
<em class="parameter"><code><span class="type">MetaWindow</span> *window</code></em>,
56
<em class="parameter"><code><span class="type">guint32</span> timestamp</code></em>);
57
<span class="returnvalue">void</span> <a class="link" href="shell-ShellApp.html#shell-app-activate" title="shell_app_activate ()">shell_app_activate</a> (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>);
58
<span class="returnvalue">void</span> <a class="link" href="shell-ShellApp.html#shell-app-activate-full" title="shell_app_activate_full ()">shell_app_activate_full</a> (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>,
68
<a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> * <a class="link" href="shell-ShellApp.html#shell-app-get-windows" title="shell_app_get_windows ()">shell_app_get_windows</a> (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>);
69
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="shell-ShellApp.html#shell-app-is-on-workspace" title="shell_app_is_on_workspace ()">shell_app_is_on_workspace</a> (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>,
70
<em class="parameter"><code><span class="type">MetaWorkspace</span> *workspace</code></em>);
71
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="shell-ShellApp.html#shell-app-is-window-backed" title="shell_app_is_window_backed ()">shell_app_is_window_backed</a> (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>);
72
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="shell-ShellApp.html#shell-app-launch" title="shell_app_launch ()">shell_app_launch</a> (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>,
73
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> timestamp</code></em>,
74
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> *uris</code></em>,
59
75
<em class="parameter"><code><span class="type">int</span> workspace</code></em>,
60
<em class="parameter"><code><span class="type">guint32</span> timestamp</code></em>);
76
<em class="parameter"><code><span class="type">char</span> **startup_id</code></em>,
77
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
61
78
<span class="returnvalue">void</span> <a class="link" href="shell-ShellApp.html#shell-app-open-new-window" title="shell_app_open_new_window ()">shell_app_open_new_window</a> (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>,
62
79
<em class="parameter"><code><span class="type">int</span> workspace</code></em>);
63
<a class="link" href="shell-ShellApp.html#ShellAppState"><span class="returnvalue">ShellAppState</span></a> <a class="link" href="shell-ShellApp.html#shell-app-get-state" title="shell_app_get_state ()">shell_app_get_state</a> (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>);
64
<span class="returnvalue">gboolean</span> <a class="link" href="shell-ShellApp.html#shell-app-request-quit" title="shell_app_request_quit ()">shell_app_request_quit</a> (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>);
65
<span class="returnvalue">guint</span> <a class="link" href="shell-ShellApp.html#shell-app-get-n-windows" title="shell_app_get_n_windows ()">shell_app_get_n_windows</a> (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>);
66
<span class="returnvalue">GSList</span> * <a class="link" href="shell-ShellApp.html#shell-app-get-windows" title="shell_app_get_windows ()">shell_app_get_windows</a> (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>);
67
<span class="returnvalue">GSList</span> * <a class="link" href="shell-ShellApp.html#shell-app-get-pids" title="shell_app_get_pids ()">shell_app_get_pids</a> (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>);
68
<span class="returnvalue">gboolean</span> <a class="link" href="shell-ShellApp.html#shell-app-is-on-workspace" title="shell_app_is_on_workspace ()">shell_app_is_on_workspace</a> (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>,
69
<em class="parameter"><code><span class="type">MetaWorkspace</span> *workspace</code></em>);
70
<span class="returnvalue">gboolean</span> <a class="link" href="shell-ShellApp.html#shell-app-launch" title="shell_app_launch ()">shell_app_launch</a> (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>,
71
<em class="parameter"><code><span class="type">guint</span> timestamp</code></em>,
72
<em class="parameter"><code><span class="type">GList</span> *uris</code></em>,
73
<em class="parameter"><code><span class="type">int</span> workspace</code></em>,
74
<em class="parameter"><code><span class="type">char</span> **startup_id</code></em>,
75
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
76
<span class="returnvalue">int</span> <a class="link" href="shell-ShellApp.html#shell-app-compare-by-name" title="shell_app_compare_by_name ()">shell_app_compare_by_name</a> (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>,
77
<em class="parameter"><code><span class="type">ShellApp</span> *other</code></em>);
78
<span class="returnvalue">int</span> <a class="link" href="shell-ShellApp.html#shell-app-compare" title="shell_app_compare ()">shell_app_compare</a> (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>,
79
<em class="parameter"><code><span class="type">ShellApp</span> *other</code></em>);
80
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="shell-ShellApp.html#shell-app-request-quit" title="shell_app_request_quit ()">shell_app_request_quit</a> (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>);
81
<span class="returnvalue">void</span> <a class="link" href="shell-ShellApp.html#shell-app-update-app-menu" title="shell_app_update_app_menu ()">shell_app_update_app_menu</a> (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>,
82
<em class="parameter"><code><span class="type">MetaWindow</span> *window</code></em>);
80
83
<span class="returnvalue">void</span> <a class="link" href="shell-ShellApp.html#shell-app-update-window-actions" title="shell_app_update_window_actions ()">shell_app_update_window_actions</a> (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>,
81
84
<em class="parameter"><code><span class="type">MetaWindow</span> *window</code></em>);
82
<span class="returnvalue">void</span> <a class="link" href="shell-ShellApp.html#shell-app-update-app-menu" title="shell_app_update_app_menu ()">shell_app_update_app_menu</a> (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>,
83
<em class="parameter"><code><span class="type">MetaWindow</span> *window</code></em>);
84
<a class="link" href="shell-ShellApp.html#ShellAppAction" title="ShellAppAction">ShellAppAction</a>;
87
87
<div class="refsect1">
116
121
SHELL_APP_STATE_RUNNING
119
<div class="variablelist"><table border="0" class="variablelist">
121
<col align="left" valign="top">
126
<td><p><a name="SHELL-APP-STATE-STOPPED:CAPS"></a><span class="term"><code class="literal">SHELL_APP_STATE_STOPPED</code></span></p></td>
130
<td><p><a name="SHELL-APP-STATE-STARTING:CAPS"></a><span class="term"><code class="literal">SHELL_APP_STATE_STARTING</code></span></p></td>
134
<td><p><a name="SHELL-APP-STATE-RUNNING:CAPS"></a><span class="term"><code class="literal">SHELL_APP_STATE_RUNNING</code></span></p></td>
141
<div class="refsect2">
142
<a name="shell-app-get-id"></a><h3>shell_app_get_id ()</h3>
143
<pre class="programlisting">const <span class="returnvalue">char</span> * shell_app_get_id (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>);</pre>
146
<div class="refsect2">
147
<a name="shell-app-get-tree-entry"></a><h3>shell_app_get_tree_entry ()</h3>
148
<pre class="programlisting"><span class="returnvalue">GMenuTreeEntry</span> * shell_app_get_tree_entry (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>);</pre>
149
<div class="variablelist"><table border="0" class="variablelist">
151
<col align="left" valign="top">
156
<td><p><span class="term"><em class="parameter"><code>app</code></em> :</span></p></td>
157
<td>a <span class="type">ShellApp</span>
161
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
162
<td>The <span class="type">GMenuTreeEntry</span> for this app, or <a href="/home/florian/opt/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> if backed by a window. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
169
<div class="refsect2">
170
<a name="shell-app-get-app-info"></a><h3>shell_app_get_app_info ()</h3>
171
<pre class="programlisting"><span class="returnvalue">GDesktopAppInfo</span> * shell_app_get_app_info (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>);</pre>
172
<div class="variablelist"><table border="0" class="variablelist">
174
<col align="left" valign="top">
179
<td><p><span class="term"><em class="parameter"><code>app</code></em> :</span></p></td>
180
<td>a <span class="type">ShellApp</span>
184
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
185
<td>The <span class="type">GDesktopAppInfo</span> for this app, or <a href="/home/florian/opt/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> if backed by a window. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
192
<div class="refsect2">
193
<a name="shell-app-create-icon-texture"></a><h3>shell_app_create_icon_texture ()</h3>
194
<pre class="programlisting"><span class="returnvalue">ClutterActor</span> * shell_app_create_icon_texture (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>,
195
<em class="parameter"><code><span class="type">int</span> size</code></em>);</pre>
197
Look up the icon for this application, and create a <span class="type">ClutterTexture</span>
198
for it at the given size.
200
<div class="variablelist"><table border="0" class="variablelist">
202
<col align="left" valign="top">
206
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
207
<td>A floating <span class="type">ClutterActor</span>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
213
<div class="refsect2">
214
<a name="shell-app-get-faded-icon"></a><h3>shell_app_get_faded_icon ()</h3>
215
<pre class="programlisting"><span class="returnvalue">ClutterActor</span> * shell_app_get_faded_icon (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>,
216
<em class="parameter"><code><span class="type">int</span> size</code></em>);</pre>
218
Return an actor with a horizontally faded look.
220
<div class="variablelist"><table border="0" class="variablelist">
222
<col align="left" valign="top">
227
<td><p><span class="term"><em class="parameter"><code>app</code></em> :</span></p></td>
228
<td>A <span class="type">ShellApp</span>
232
<td><p><span class="term"><em class="parameter"><code>size</code></em> :</span></p></td>
233
<td>Size in pixels</td>
236
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
237
<td>A floating <span class="type">ClutterActor</span>, or <a href="/home/florian/opt/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> if no icon. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
244
<div class="refsect2">
245
<a name="shell-app-get-name"></a><h3>shell_app_get_name ()</h3>
246
<pre class="programlisting">const <span class="returnvalue">char</span> * shell_app_get_name (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>);</pre>
249
<div class="refsect2">
250
<a name="shell-app-get-description"></a><h3>shell_app_get_description ()</h3>
251
<pre class="programlisting">const <span class="returnvalue">char</span> * shell_app_get_description (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>);</pre>
254
<div class="refsect2">
255
<a name="shell-app-is-window-backed"></a><h3>shell_app_is_window_backed ()</h3>
256
<pre class="programlisting"><span class="returnvalue">gboolean</span> shell_app_is_window_backed (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>);</pre>
258
A window backed application is one which represents just an open
259
window, i.e. there's no .desktop file assocation, so we don't know
260
how to launch it again.
264
<div class="refsect2">
265
<a name="shell-app-activate-window"></a><h3>shell_app_activate_window ()</h3>
266
<pre class="programlisting"><span class="returnvalue">void</span> shell_app_activate_window (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>,
267
<em class="parameter"><code><span class="type">MetaWindow</span> *window</code></em>,
268
<em class="parameter"><code><span class="type">guint32</span> timestamp</code></em>);</pre>
270
Bring all windows for the given app to the foreground,
271
but ensure that <em class="parameter"><code>window</code></em> is on top. If <em class="parameter"><code>window</code></em> is <a href="/home/florian/opt/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>,
272
the window with the most recent user time for the app
276
This function has no effect if <em class="parameter"><code>app</code></em> is not currently running.
278
<div class="variablelist"><table border="0" class="variablelist">
280
<col align="left" valign="top">
285
<td><p><span class="term"><em class="parameter"><code>app</code></em> :</span></p></td>
286
<td>a <span class="type">ShellApp</span>
290
<td><p><span class="term"><em class="parameter"><code>window</code></em> :</span></p></td>
291
<td>Window to be focused. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
295
<td><p><span class="term"><em class="parameter"><code>timestamp</code></em> :</span></p></td>
296
<td>Event timestamp</td>
302
126
<div class="refsect2">
358
182
<div class="refsect2">
359
<a name="shell-app-open-new-window"></a><h3>shell_app_open_new_window ()</h3>
360
<pre class="programlisting"><span class="returnvalue">void</span> shell_app_open_new_window (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>,
361
<em class="parameter"><code><span class="type">int</span> workspace</code></em>);</pre>
363
Request that the application create a new window.
365
<div class="variablelist"><table border="0" class="variablelist">
367
<col align="left" valign="top">
372
<td><p><span class="term"><em class="parameter"><code>app</code></em> :</span></p></td>
373
<td>a <span class="type">ShellApp</span>
377
<td><p><span class="term"><em class="parameter"><code>workspace</code></em> :</span></p></td>
378
<td>open on this workspace, or -1 for default</td>
183
<a name="shell-app-activate-window"></a><h3>shell_app_activate_window ()</h3>
184
<pre class="programlisting"><span class="returnvalue">void</span> shell_app_activate_window (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>,
185
<em class="parameter"><code><span class="type">MetaWindow</span> *window</code></em>,
186
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> timestamp</code></em>);</pre>
188
Bring all windows for the given app to the foreground,
189
but ensure that <em class="parameter"><code>window</code></em> is on top. If <em class="parameter"><code>window</code></em> is <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>,
190
the window with the most recent user time for the app
194
This function has no effect if <em class="parameter"><code>app</code></em> is not currently running.
196
<div class="variablelist"><table border="0" class="variablelist">
198
<col align="left" valign="top">
203
<td><p><span class="term"><em class="parameter"><code>app</code></em> :</span></p></td>
204
<td>a <span class="type">ShellApp</span>
208
<td><p><span class="term"><em class="parameter"><code>window</code></em> :</span></p></td>
209
<td>Window to be focused. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
213
<td><p><span class="term"><em class="parameter"><code>timestamp</code></em> :</span></p></td>
214
<td>Event timestamp</td>
220
<div class="refsect2">
221
<a name="shell-app-compare"></a><h3>shell_app_compare ()</h3>
222
<pre class="programlisting"><span class="returnvalue">int</span> shell_app_compare (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>,
223
<em class="parameter"><code><span class="type">ShellApp</span> *other</code></em>);</pre>
225
Compare one <span class="type">ShellApp</span> instance to another, in the following way:
226
- Running applications sort before not-running applications.
227
- If one of them has visible windows and the other does not, the one
228
with visible windows is first.
229
- Finally, the application which the user interacted with most recently
232
<div class="variablelist"><table border="0" class="variablelist">
234
<col align="left" valign="top">
238
<td><p><span class="term"><em class="parameter"><code>other</code></em> :</span></p></td>
239
<td>A <span class="type">ShellApp</span>
245
<div class="refsect2">
246
<a name="shell-app-compare-by-name"></a><h3>shell_app_compare_by_name ()</h3>
247
<pre class="programlisting"><span class="returnvalue">int</span> shell_app_compare_by_name (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>,
248
<em class="parameter"><code><span class="type">ShellApp</span> *other</code></em>);</pre>
250
Order two applications by name.
252
<div class="variablelist"><table border="0" class="variablelist">
254
<col align="left" valign="top">
259
<td><p><span class="term"><em class="parameter"><code>app</code></em> :</span></p></td>
263
<td><p><span class="term"><em class="parameter"><code>other</code></em> :</span></p></td>
264
<td>The other app</td>
267
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
268
<td>-1, 0, or 1; suitable for use as a comparison function
269
for e.g. <a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#g-slist-sort"><code class="function">g_slist_sort()</code></a>
276
<div class="refsect2">
277
<a name="shell-app-create-icon-texture"></a><h3>shell_app_create_icon_texture ()</h3>
278
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/clutter/ClutterActor.html"><span class="returnvalue">ClutterActor</span></a> * shell_app_create_icon_texture (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>,
279
<em class="parameter"><code><span class="type">int</span> size</code></em>);</pre>
281
Look up the icon for this application, and create a <a href="/usr/share/gtk-doc/html/clutter/ClutterTexture.html"><span class="type">ClutterTexture</span></a>
282
for it at the given size.
284
<div class="variablelist"><table border="0" class="variablelist">
286
<col align="left" valign="top">
290
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
291
<td>A floating <a href="/usr/share/gtk-doc/html/clutter/ClutterActor.html"><span class="type">ClutterActor</span></a>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
297
<div class="refsect2">
298
<a name="shell-app-get-app-info"></a><h3>shell_app_get_app_info ()</h3>
299
<pre class="programlisting"><a href="http://library.gnome.org/devel/gio/unstable/gio-Desktop-file-based-GAppInfo.html#GDesktopAppInfo"><span class="returnvalue">GDesktopAppInfo</span></a> * shell_app_get_app_info (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>);</pre>
300
<div class="variablelist"><table border="0" class="variablelist">
302
<col align="left" valign="top">
307
<td><p><span class="term"><em class="parameter"><code>app</code></em> :</span></p></td>
308
<td>a <span class="type">ShellApp</span>
312
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
313
<td>The <a href="http://library.gnome.org/devel/gio/unstable/gio-Desktop-file-based-GAppInfo.html#GDesktopAppInfo"><span class="type">GDesktopAppInfo</span></a> for this app, or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> if backed by a window. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
320
<div class="refsect2">
321
<a name="shell-app-get-description"></a><h3>shell_app_get_description ()</h3>
322
<pre class="programlisting">const <span class="returnvalue">char</span> * shell_app_get_description (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>);</pre>
325
<div class="refsect2">
326
<a name="shell-app-get-faded-icon"></a><h3>shell_app_get_faded_icon ()</h3>
327
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/clutter/ClutterActor.html"><span class="returnvalue">ClutterActor</span></a> * shell_app_get_faded_icon (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>,
328
<em class="parameter"><code><span class="type">int</span> size</code></em>);</pre>
330
Return an actor with a horizontally faded look.
332
<div class="variablelist"><table border="0" class="variablelist">
334
<col align="left" valign="top">
339
<td><p><span class="term"><em class="parameter"><code>app</code></em> :</span></p></td>
340
<td>A <span class="type">ShellApp</span>
344
<td><p><span class="term"><em class="parameter"><code>size</code></em> :</span></p></td>
345
<td>Size in pixels</td>
348
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
349
<td>A floating <a href="/usr/share/gtk-doc/html/clutter/ClutterActor.html"><span class="type">ClutterActor</span></a>, or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> if no icon. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
356
<div class="refsect2">
357
<a name="shell-app-get-id"></a><h3>shell_app_get_id ()</h3>
358
<pre class="programlisting">const <span class="returnvalue">char</span> * shell_app_get_id (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>);</pre>
361
<div class="refsect2">
362
<a name="shell-app-get-n-windows"></a><h3>shell_app_get_n_windows ()</h3>
363
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> shell_app_get_n_windows (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>);</pre>
366
<div class="refsect2">
367
<a name="shell-app-get-name"></a><h3>shell_app_get_name ()</h3>
368
<pre class="programlisting">const <span class="returnvalue">char</span> * shell_app_get_name (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>);</pre>
371
<div class="refsect2">
372
<a name="shell-app-get-pids"></a><h3>shell_app_get_pids ()</h3>
373
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> * shell_app_get_pids (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>);</pre>
374
<div class="variablelist"><table border="0" class="variablelist">
376
<col align="left" valign="top">
381
<td><p><span class="term"><em class="parameter"><code>app</code></em> :</span></p></td>
382
<td>a <span class="type">ShellApp</span>
386
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
387
<td>An unordered list of process identifers associated with this application. <span class="annotation">[<acronym title="Free data container after the code is done."><span class="acronym">transfer container</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> int]</span>
464
461
<div class="refsect2">
465
<a name="shell-app-get-pids"></a><h3>shell_app_get_pids ()</h3>
466
<pre class="programlisting"><span class="returnvalue">GSList</span> * shell_app_get_pids (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>);</pre>
467
<div class="variablelist"><table border="0" class="variablelist">
469
<col align="left" valign="top">
474
<td><p><span class="term"><em class="parameter"><code>app</code></em> :</span></p></td>
475
<td>a <span class="type">ShellApp</span>
479
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
480
<td>An unordered list of process identifers associated with this application. <span class="annotation">[<acronym title="Free data container after the code is done."><span class="acronym">transfer container</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> int]</span>
487
<div class="refsect2">
488
462
<a name="shell-app-is-on-workspace"></a><h3>shell_app_is_on_workspace ()</h3>
489
<pre class="programlisting"><span class="returnvalue">gboolean</span> shell_app_is_on_workspace (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>,
463
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> shell_app_is_on_workspace (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>,
490
464
<em class="parameter"><code><span class="type">MetaWorkspace</span> *workspace</code></em>);</pre>
493
467
<div class="refsect2">
468
<a name="shell-app-is-window-backed"></a><h3>shell_app_is_window_backed ()</h3>
469
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> shell_app_is_window_backed (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>);</pre>
471
A window backed application is one which represents just an open
472
window, i.e. there's no .desktop file assocation, so we don't know
473
how to launch it again.
477
<div class="refsect2">
494
478
<a name="shell-app-launch"></a><h3>shell_app_launch ()</h3>
495
<pre class="programlisting"><span class="returnvalue">gboolean</span> shell_app_launch (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>,
496
<em class="parameter"><code><span class="type">guint</span> timestamp</code></em>,
497
<em class="parameter"><code><span class="type">GList</span> *uris</code></em>,
479
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> shell_app_launch (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>,
480
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> timestamp</code></em>,
481
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> *uris</code></em>,
498
482
<em class="parameter"><code><span class="type">int</span> workspace</code></em>,
499
483
<em class="parameter"><code><span class="type">char</span> **startup_id</code></em>,
500
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
484
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
501
485
<div class="variablelist"><table border="0" class="variablelist">
503
487
<col align="left" valign="top">
521
505
<td><p><span class="term"><em class="parameter"><code>startup_id</code></em> :</span></p></td>
522
<td>Returned startup notification ID, or <a href="/home/florian/opt/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> if none. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
506
<td>Returned startup notification ID, or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> if none. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
526
510
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
527
<td>A <span class="type">GError</span>
534
<div class="refsect2">
535
<a name="shell-app-compare-by-name"></a><h3>shell_app_compare_by_name ()</h3>
536
<pre class="programlisting"><span class="returnvalue">int</span> shell_app_compare_by_name (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>,
537
<em class="parameter"><code><span class="type">ShellApp</span> *other</code></em>);</pre>
539
Order two applications by name.
541
<div class="variablelist"><table border="0" class="variablelist">
543
<col align="left" valign="top">
548
<td><p><span class="term"><em class="parameter"><code>app</code></em> :</span></p></td>
552
<td><p><span class="term"><em class="parameter"><code>other</code></em> :</span></p></td>
553
<td>The other app</td>
511
<td>A <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>
518
<div class="refsect2">
519
<a name="shell-app-open-new-window"></a><h3>shell_app_open_new_window ()</h3>
520
<pre class="programlisting"><span class="returnvalue">void</span> shell_app_open_new_window (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>,
521
<em class="parameter"><code><span class="type">int</span> workspace</code></em>);</pre>
523
Request that the application create a new window.
525
<div class="variablelist"><table border="0" class="variablelist">
527
<col align="left" valign="top">
532
<td><p><span class="term"><em class="parameter"><code>app</code></em> :</span></p></td>
533
<td>a <span class="type">ShellApp</span>
537
<td><p><span class="term"><em class="parameter"><code>workspace</code></em> :</span></p></td>
538
<td>open on this workspace, or -1 for default</td>
544
<div class="refsect2">
545
<a name="shell-app-request-quit"></a><h3>shell_app_request_quit ()</h3>
546
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> shell_app_request_quit (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>);</pre>
548
Initiate an asynchronous request to quit this application.
549
The application may interact with the user, and the user
550
might cancel the quit request from the application UI.
553
This operation may not be supported for all applications.
555
<div class="variablelist"><table border="0" class="variablelist">
557
<col align="left" valign="top">
562
<td><p><span class="term"><em class="parameter"><code>app</code></em> :</span></p></td>
563
<td>A <span class="type">ShellApp</span>
556
567
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
557
<td>-1, 0, or 1; suitable for use as a comparison function
558
for e.g. <code class="function">g_slist_sort()</code>
569
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if a quit request is supported for this application</td>
565
575
<div class="refsect2">
566
<a name="shell-app-compare"></a><h3>shell_app_compare ()</h3>
567
<pre class="programlisting"><span class="returnvalue">int</span> shell_app_compare (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>,
568
<em class="parameter"><code><span class="type">ShellApp</span> *other</code></em>);</pre>
570
Compare one <span class="type">ShellApp</span> instance to another, in the following way:
571
- Running applications sort before not-running applications.
572
- If one of them has visible windows and the other does not, the one
573
with visible windows is first.
574
- Finally, the application which the user interacted with most recently
577
<div class="variablelist"><table border="0" class="variablelist">
579
<col align="left" valign="top">
583
<td><p><span class="term"><em class="parameter"><code>other</code></em> :</span></p></td>
584
<td>A <span class="type">ShellApp</span>
576
<a name="shell-app-update-app-menu"></a><h3>shell_app_update_app_menu ()</h3>
577
<pre class="programlisting"><span class="returnvalue">void</span> shell_app_update_app_menu (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>,
578
<em class="parameter"><code><span class="type">MetaWindow</span> *window</code></em>);</pre>
590
581
<div class="refsect2">