~ubuntu-branches/ubuntu/trusty/gnome-shell/trusty

« back to all changes in this revision

Viewing changes to docs/reference/shell/html/shell-ShellApp.html

  • Committer: Package Import Robot
  • Author(s): Jeremy Bicha
  • Date: 2013-07-31 21:29:20 UTC
  • mfrom: (1.1.51)
  • Revision ID: package-import@ubuntu.com-20130731212920-mz92zheiqgq2ggd1
Tags: 3.8.4-0ubuntu1
* New upstream release.
* debian/patches/git-dont-crash-for-unstaged-widgets.patch:
  - Dropped, applied in new version

Show diffs side-by-side

added added

removed removed

Lines of Context:
8
8
<link rel="up" href="ch02.html" title="Application tracking">
9
9
<link rel="prev" href="ch02.html" title="Application tracking">
10
10
<link rel="next" href="shell-ShellAppUsage.html" title="ShellAppUsage">
11
 
<meta name="generator" content="GTK-Doc V1.18.1 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.19 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
</head>
14
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
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><a href="http://developer.gnome.org/meta/MetaWindow.html"><span class="type">MetaWindow</span></a> *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>,
 
62
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/clutter/clutter-General.html#ClutterTextDirection"><span class="type">ClutterTextDirection</span></a> direction</code></em>);
44
63
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>);
 
64
<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>);
 
65
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>);
 
66
<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>);
 
67
<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
68
<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><a href="http://developer.gnome.org/meta/MetaWindow.html"><span class="type">MetaWindow</span></a> *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>,
 
69
<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>);
 
70
<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>,
 
71
                                                         <em class="parameter"><code><a href="http://developer.gnome.org/meta/MetaWorkspace.html"><span class="type">MetaWorkspace</span></a> *workspace</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-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>);
 
73
<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>,
 
74
                                                         <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>,
 
75
                                                         <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
76
                                                         <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>);
 
77
                                                         <em class="parameter"><code><span class="type">char</span> **startup_id</code></em>,
 
78
                                                         <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
79
<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
80
                                                         <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><a href="http://developer.gnome.org/meta/MetaWorkspace.html"><span class="type">MetaWorkspace</span></a> *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>);
 
81
<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>);
 
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><a href="http://developer.gnome.org/meta/MetaWindow.html"><span class="type">MetaWindow</span></a> *window</code></em>);
80
84
<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
85
                                                         <em class="parameter"><code><a href="http://developer.gnome.org/meta/MetaWindow.html"><span class="type">MetaWindow</span></a> *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><a href="http://developer.gnome.org/meta/MetaWindow.html"><span class="type">MetaWindow</span></a> *window</code></em>);
84
 
                    <a class="link" href="shell-ShellApp.html#ShellAppAction" title="ShellAppAction">ShellAppAction</a>;
85
86
</pre>
86
87
</div>
87
88
<div class="refsect1">
101
102
<div class="refsect1">
102
103
<a name="shell-ShellApp.details"></a><h2>Details</h2>
103
104
<div class="refsect2">
 
105
<a name="ShellAppAction"></a><h3>ShellAppAction</h3>
 
106
<pre class="programlisting">typedef struct _ShellAppAction ShellAppAction;</pre>
 
107
</div>
 
108
<hr>
 
109
<div class="refsect2">
104
110
<a name="ShellAppClass"></a><h3>struct ShellAppClass</h3>
105
111
<pre class="programlisting">struct ShellAppClass {
106
112
  GObjectClass parent_class;
139
145
</div>
140
146
<hr>
141
147
<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>
144
 
</div>
145
 
<hr>
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">
150
 
<colgroup>
151
 
<col align="left" valign="top">
152
 
<col>
153
 
</colgroup>
154
 
<tbody>
155
 
<tr>
156
 
<td><p><span class="term"><em class="parameter"><code>app</code></em> :</span></p></td>
157
 
<td>a <span class="type">ShellApp</span>
158
 
</td>
159
 
</tr>
160
 
<tr>
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 <code class="literal">NULL</code> 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>
163
 
</td>
164
 
</tr>
165
 
</tbody>
166
 
</table></div>
167
 
</div>
168
 
<hr>
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">
173
 
<colgroup>
174
 
<col align="left" valign="top">
175
 
<col>
176
 
</colgroup>
177
 
<tbody>
178
 
<tr>
179
 
<td><p><span class="term"><em class="parameter"><code>app</code></em> :</span></p></td>
180
 
<td>a <span class="type">ShellApp</span>
181
 
</td>
182
 
</tr>
183
 
<tr>
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 <code class="literal">NULL</code> 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>
186
 
</td>
187
 
</tr>
188
 
</tbody>
189
 
</table></div>
190
 
</div>
191
 
<hr>
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>
196
 
<p>
197
 
Look up the icon for this application, and create a <span class="type">ClutterTexture</span>
198
 
for it at the given size.
199
 
</p>
200
 
<div class="variablelist"><table border="0" class="variablelist">
201
 
<colgroup>
202
 
<col align="left" valign="top">
203
 
<col>
204
 
</colgroup>
205
 
<tbody><tr>
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>
208
 
</td>
209
 
</tr></tbody>
210
 
</table></div>
211
 
</div>
212
 
<hr>
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>
217
 
<p>
218
 
Return an actor with a horizontally faded look.
219
 
</p>
220
 
<div class="variablelist"><table border="0" class="variablelist">
221
 
<colgroup>
222
 
<col align="left" valign="top">
223
 
<col>
224
 
</colgroup>
225
 
<tbody>
226
 
<tr>
227
 
<td><p><span class="term"><em class="parameter"><code>app</code></em> :</span></p></td>
228
 
<td>A <span class="type">ShellApp</span>
229
 
</td>
230
 
</tr>
231
 
<tr>
232
 
<td><p><span class="term"><em class="parameter"><code>size</code></em> :</span></p></td>
233
 
<td>Size in pixels</td>
234
 
</tr>
235
 
<tr>
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 <code class="literal">NULL</code> 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>
238
 
</td>
239
 
</tr>
240
 
</tbody>
241
 
</table></div>
242
 
</div>
243
 
<hr>
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>
247
 
</div>
248
 
<hr>
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>
252
 
</div>
253
 
<hr>
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>
257
 
<p>
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.
261
 
</p>
262
 
</div>
263
 
<hr>
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><a href="http://developer.gnome.org/meta/MetaWindow.html"><span class="type">MetaWindow</span></a> *window</code></em>,
268
 
                                                         <em class="parameter"><code><span class="type">guint32</span> timestamp</code></em>);</pre>
269
 
<p>
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 <code class="literal">NULL</code>,
272
 
the window with the most recent user time for the app
273
 
will be used.
274
 
</p>
275
 
<p>
276
 
This function has no effect if <em class="parameter"><code>app</code></em> is not currently running.
277
 
</p>
278
 
<div class="variablelist"><table border="0" class="variablelist">
279
 
<colgroup>
280
 
<col align="left" valign="top">
281
 
<col>
282
 
</colgroup>
283
 
<tbody>
284
 
<tr>
285
 
<td><p><span class="term"><em class="parameter"><code>app</code></em> :</span></p></td>
286
 
<td>a <span class="type">ShellApp</span>
287
 
</td>
288
 
</tr>
289
 
<tr>
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>
292
 
</td>
293
 
</tr>
294
 
<tr>
295
 
<td><p><span class="term"><em class="parameter"><code>timestamp</code></em> :</span></p></td>
296
 
<td>Event timestamp</td>
297
 
</tr>
298
 
</tbody>
299
 
</table></div>
300
 
</div>
301
 
<hr>
302
 
<div class="refsect2">
303
148
<a name="shell-app-activate"></a><h3>shell_app_activate ()</h3>
304
149
<pre class="programlisting"><span class="returnvalue">void</span>                shell_app_activate                  (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>);</pre>
305
150
<p>
323
168
<a name="shell-app-activate-full"></a><h3>shell_app_activate_full ()</h3>
324
169
<pre class="programlisting"><span class="returnvalue">void</span>                shell_app_activate_full             (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>,
325
170
                                                         <em class="parameter"><code><span class="type">int</span> workspace</code></em>,
326
 
                                                         <em class="parameter"><code><span class="type">guint32</span> timestamp</code></em>);</pre>
 
171
                                                         <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>
327
172
<p>
328
173
Perform an appropriate default action for operating on this application,
329
174
dependent on its current state.  For example, if the application is not
356
201
</div>
357
202
<hr>
358
203
<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>
362
 
<p>
363
 
Request that the application create a new window.
364
 
</p>
365
 
<div class="variablelist"><table border="0" class="variablelist">
366
 
<colgroup>
367
 
<col align="left" valign="top">
368
 
<col>
369
 
</colgroup>
370
 
<tbody>
371
 
<tr>
372
 
<td><p><span class="term"><em class="parameter"><code>app</code></em> :</span></p></td>
373
 
<td>a <span class="type">ShellApp</span>
374
 
</td>
375
 
</tr>
376
 
<tr>
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>
 
204
<a name="shell-app-activate-window"></a><h3>shell_app_activate_window ()</h3>
 
205
<pre class="programlisting"><span class="returnvalue">void</span>                shell_app_activate_window           (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>,
 
206
                                                         <em class="parameter"><code><a href="http://developer.gnome.org/meta/MetaWindow.html"><span class="type">MetaWindow</span></a> *window</code></em>,
 
207
                                                         <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>
 
208
<p>
 
209
Bring all windows for the given app to the foreground,
 
210
but ensure that <em class="parameter"><code>window</code></em> is on top.  If <em class="parameter"><code>window</code></em> is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>,
 
211
the window with the most recent user time for the app
 
212
will be used.
 
213
</p>
 
214
<p>
 
215
This function has no effect if <em class="parameter"><code>app</code></em> is not currently running.
 
216
</p>
 
217
<div class="variablelist"><table border="0" class="variablelist">
 
218
<colgroup>
 
219
<col align="left" valign="top">
 
220
<col>
 
221
</colgroup>
 
222
<tbody>
 
223
<tr>
 
224
<td><p><span class="term"><em class="parameter"><code>app</code></em> :</span></p></td>
 
225
<td>a <span class="type">ShellApp</span>
 
226
</td>
 
227
</tr>
 
228
<tr>
 
229
<td><p><span class="term"><em class="parameter"><code>window</code></em> :</span></p></td>
 
230
<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>
 
231
</td>
 
232
</tr>
 
233
<tr>
 
234
<td><p><span class="term"><em class="parameter"><code>timestamp</code></em> :</span></p></td>
 
235
<td>Event timestamp</td>
 
236
</tr>
 
237
</tbody>
 
238
</table></div>
 
239
</div>
 
240
<hr>
 
241
<div class="refsect2">
 
242
<a name="shell-app-compare"></a><h3>shell_app_compare ()</h3>
 
243
<pre class="programlisting"><span class="returnvalue">int</span>                 shell_app_compare                   (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>,
 
244
                                                         <em class="parameter"><code><span class="type">ShellApp</span> *other</code></em>);</pre>
 
245
<p>
 
246
Compare one <span class="type">ShellApp</span> instance to another, in the following way:
 
247
  - Running applications sort before not-running applications.
 
248
  - If one of them has visible windows and the other does not, the one
 
249
    with visible windows is first.
 
250
  - Finally, the application which the user interacted with most recently
 
251
    compares earlier.
 
252
</p>
 
253
<div class="variablelist"><table border="0" class="variablelist">
 
254
<colgroup>
 
255
<col align="left" valign="top">
 
256
<col>
 
257
</colgroup>
 
258
<tbody><tr>
 
259
<td><p><span class="term"><em class="parameter"><code>other</code></em> :</span></p></td>
 
260
<td>A <span class="type">ShellApp</span>
 
261
</td>
 
262
</tr></tbody>
 
263
</table></div>
 
264
</div>
 
265
<hr>
 
266
<div class="refsect2">
 
267
<a name="shell-app-compare-by-name"></a><h3>shell_app_compare_by_name ()</h3>
 
268
<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>,
 
269
                                                         <em class="parameter"><code><span class="type">ShellApp</span> *other</code></em>);</pre>
 
270
<p>
 
271
Order two applications by name.
 
272
</p>
 
273
<div class="variablelist"><table border="0" class="variablelist">
 
274
<colgroup>
 
275
<col align="left" valign="top">
 
276
<col>
 
277
</colgroup>
 
278
<tbody>
 
279
<tr>
 
280
<td><p><span class="term"><em class="parameter"><code>app</code></em> :</span></p></td>
 
281
<td>One app</td>
 
282
</tr>
 
283
<tr>
 
284
<td><p><span class="term"><em class="parameter"><code>other</code></em> :</span></p></td>
 
285
<td>The other app</td>
 
286
</tr>
 
287
<tr>
 
288
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
289
<td>-1, 0, or 1; suitable for use as a comparison function
 
290
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>
 
291
</td>
 
292
</tr>
 
293
</tbody>
 
294
</table></div>
 
295
</div>
 
296
<hr>
 
297
<div class="refsect2">
 
298
<a name="shell-app-create-icon-texture"></a><h3>shell_app_create_icon_texture ()</h3>
 
299
<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>,
 
300
                                                         <em class="parameter"><code><span class="type">int</span> size</code></em>);</pre>
 
301
<p>
 
302
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>
 
303
for it at the given size.
 
304
</p>
 
305
<div class="variablelist"><table border="0" class="variablelist">
 
306
<colgroup>
 
307
<col align="left" valign="top">
 
308
<col>
 
309
</colgroup>
 
310
<tbody><tr>
 
311
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
312
<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>
 
313
</td>
 
314
</tr></tbody>
 
315
</table></div>
 
316
</div>
 
317
<hr>
 
318
<div class="refsect2">
 
319
<a name="shell-app-get-app-info"></a><h3>shell_app_get_app_info ()</h3>
 
320
<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>
 
321
<div class="variablelist"><table border="0" class="variablelist">
 
322
<colgroup>
 
323
<col align="left" valign="top">
 
324
<col>
 
325
</colgroup>
 
326
<tbody>
 
327
<tr>
 
328
<td><p><span class="term"><em class="parameter"><code>app</code></em> :</span></p></td>
 
329
<td>a <span class="type">ShellApp</span>
 
330
</td>
 
331
</tr>
 
332
<tr>
 
333
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
334
<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="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.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>
 
335
</td>
 
336
</tr>
 
337
</tbody>
 
338
</table></div>
 
339
</div>
 
340
<hr>
 
341
<div class="refsect2">
 
342
<a name="shell-app-get-description"></a><h3>shell_app_get_description ()</h3>
 
343
<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>
 
344
</div>
 
345
<hr>
 
346
<div class="refsect2">
 
347
<a name="shell-app-get-faded-icon"></a><h3>shell_app_get_faded_icon ()</h3>
 
348
<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>,
 
349
                                                         <em class="parameter"><code><span class="type">int</span> size</code></em>,
 
350
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/clutter/clutter-General.html#ClutterTextDirection"><span class="type">ClutterTextDirection</span></a> direction</code></em>);</pre>
 
351
<p>
 
352
Return an actor with a horizontally faded look.
 
353
</p>
 
354
<div class="variablelist"><table border="0" class="variablelist">
 
355
<colgroup>
 
356
<col align="left" valign="top">
 
357
<col>
 
358
</colgroup>
 
359
<tbody>
 
360
<tr>
 
361
<td><p><span class="term"><em class="parameter"><code>app</code></em> :</span></p></td>
 
362
<td>A <span class="type">ShellApp</span>
 
363
</td>
 
364
</tr>
 
365
<tr>
 
366
<td><p><span class="term"><em class="parameter"><code>size</code></em> :</span></p></td>
 
367
<td>Size in pixels</td>
 
368
</tr>
 
369
<tr>
 
370
<td><p><span class="term"><em class="parameter"><code>direction</code></em> :</span></p></td>
 
371
<td>Whether to fade on the left or right</td>
 
372
</tr>
 
373
<tr>
 
374
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
375
<td>A floating <a href="/usr/share/gtk-doc/html/clutter/ClutterActor.html"><span class="type">ClutterActor</span></a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.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>
 
376
</td>
 
377
</tr>
 
378
</tbody>
 
379
</table></div>
 
380
</div>
 
381
<hr>
 
382
<div class="refsect2">
 
383
<a name="shell-app-get-id"></a><h3>shell_app_get_id ()</h3>
 
384
<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>
 
385
</div>
 
386
<hr>
 
387
<div class="refsect2">
 
388
<a name="shell-app-get-n-windows"></a><h3>shell_app_get_n_windows ()</h3>
 
389
<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>
 
390
</div>
 
391
<hr>
 
392
<div class="refsect2">
 
393
<a name="shell-app-get-name"></a><h3>shell_app_get_name ()</h3>
 
394
<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>
 
395
</div>
 
396
<hr>
 
397
<div class="refsect2">
 
398
<a name="shell-app-get-pids"></a><h3>shell_app_get_pids ()</h3>
 
399
<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>
 
400
<div class="variablelist"><table border="0" class="variablelist">
 
401
<colgroup>
 
402
<col align="left" valign="top">
 
403
<col>
 
404
</colgroup>
 
405
<tbody>
 
406
<tr>
 
407
<td><p><span class="term"><em class="parameter"><code>app</code></em> :</span></p></td>
 
408
<td>a <span class="type">ShellApp</span>
 
409
</td>
 
410
</tr>
 
411
<tr>
 
412
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
413
<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>
 
414
</td>
379
415
</tr>
380
416
</tbody>
381
417
</table></div>
404
440
</div>
405
441
<hr>
406
442
<div class="refsect2">
407
 
<a name="shell-app-request-quit"></a><h3>shell_app_request_quit ()</h3>
408
 
<pre class="programlisting"><span class="returnvalue">gboolean</span>            shell_app_request_quit              (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>);</pre>
409
 
<p>
410
 
Initiate an asynchronous request to quit this application.
411
 
The application may interact with the user, and the user
412
 
might cancel the quit request from the application UI.
413
 
</p>
414
 
<p>
415
 
This operation may not be supported for all applications.
416
 
</p>
 
443
<a name="shell-app-get-tree-entry"></a><h3>shell_app_get_tree_entry ()</h3>
 
444
<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>
417
445
<div class="variablelist"><table border="0" class="variablelist">
418
446
<colgroup>
419
447
<col align="left" valign="top">
422
450
<tbody>
423
451
<tr>
424
452
<td><p><span class="term"><em class="parameter"><code>app</code></em> :</span></p></td>
425
 
<td>A <span class="type">ShellApp</span>
 
453
<td>a <span class="type">ShellApp</span>
426
454
</td>
427
455
</tr>
428
456
<tr>
429
457
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
430
 
<td>
431
 
<code class="literal">TRUE</code> if a quit request is supported for this application</td>
 
458
<td>The <span class="type">GMenuTreeEntry</span> for this app, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.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>
 
459
</td>
432
460
</tr>
433
461
</tbody>
434
462
</table></div>
435
463
</div>
436
464
<hr>
437
465
<div class="refsect2">
438
 
<a name="shell-app-get-n-windows"></a><h3>shell_app_get_n_windows ()</h3>
439
 
<pre class="programlisting"><span class="returnvalue">guint</span>               shell_app_get_n_windows             (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>);</pre>
440
 
</div>
441
 
<hr>
442
 
<div class="refsect2">
443
466
<a name="shell-app-get-windows"></a><h3>shell_app_get_windows ()</h3>
444
 
<pre class="programlisting"><span class="returnvalue">GSList</span> *            shell_app_get_windows               (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>);</pre>
 
467
<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_windows               (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>);</pre>
445
468
<p>
446
469
Get the toplevel, interesting windows which are associated with this
447
470
application.  The returned list will be sorted first by whether
462
485
</div>
463
486
<hr>
464
487
<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">
468
 
<colgroup>
469
 
<col align="left" valign="top">
470
 
<col>
471
 
</colgroup>
472
 
<tbody>
473
 
<tr>
474
 
<td><p><span class="term"><em class="parameter"><code>app</code></em> :</span></p></td>
475
 
<td>a <span class="type">ShellApp</span>
476
 
</td>
477
 
</tr>
478
 
<tr>
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>
481
 
</td>
482
 
</tr>
483
 
</tbody>
484
 
</table></div>
485
 
</div>
486
 
<hr>
487
 
<div class="refsect2">
488
488
<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>,
 
489
<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
490
                                                         <em class="parameter"><code><a href="http://developer.gnome.org/meta/MetaWorkspace.html"><span class="type">MetaWorkspace</span></a> *workspace</code></em>);</pre>
491
491
</div>
492
492
<hr>
493
493
<div class="refsect2">
 
494
<a name="shell-app-is-window-backed"></a><h3>shell_app_is_window_backed ()</h3>
 
495
<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>
 
496
<p>
 
497
A window backed application is one which represents just an open
 
498
window, i.e. there's no .desktop file assocation, so we don't know
 
499
how to launch it again.
 
500
</p>
 
501
</div>
 
502
<hr>
 
503
<div class="refsect2">
494
504
<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>,
 
505
<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>,
 
506
                                                         <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>,
 
507
                                                         <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
508
                                                         <em class="parameter"><code><span class="type">int</span> workspace</code></em>,
499
509
                                                         <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>
 
510
                                                         <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
511
<div class="variablelist"><table border="0" class="variablelist">
502
512
<colgroup>
503
513
<col align="left" valign="top">
519
529
</tr>
520
530
<tr>
521
531
<td><p><span class="term"><em class="parameter"><code>startup_id</code></em> :</span></p></td>
522
 
<td>Returned startup notification ID, or <code class="literal">NULL</code> if none. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
 
532
<td>Returned startup notification ID, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.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>
523
533
</td>
524
534
</tr>
525
535
<tr>
526
536
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
527
 
<td>A <span class="type">GError</span>
528
 
</td>
529
 
</tr>
530
 
</tbody>
531
 
</table></div>
532
 
</div>
533
 
<hr>
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>
538
 
<p>
539
 
Order two applications by name.
540
 
</p>
541
 
<div class="variablelist"><table border="0" class="variablelist">
542
 
<colgroup>
543
 
<col align="left" valign="top">
544
 
<col>
545
 
</colgroup>
546
 
<tbody>
547
 
<tr>
548
 
<td><p><span class="term"><em class="parameter"><code>app</code></em> :</span></p></td>
549
 
<td>One app</td>
550
 
</tr>
551
 
<tr>
552
 
<td><p><span class="term"><em class="parameter"><code>other</code></em> :</span></p></td>
553
 
<td>The other app</td>
 
537
<td>A <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>
 
538
</td>
 
539
</tr>
 
540
</tbody>
 
541
</table></div>
 
542
</div>
 
543
<hr>
 
544
<div class="refsect2">
 
545
<a name="shell-app-open-new-window"></a><h3>shell_app_open_new_window ()</h3>
 
546
<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>,
 
547
                                                         <em class="parameter"><code><span class="type">int</span> workspace</code></em>);</pre>
 
548
<p>
 
549
Request that the application create a new window.
 
550
</p>
 
551
<div class="variablelist"><table border="0" class="variablelist">
 
552
<colgroup>
 
553
<col align="left" valign="top">
 
554
<col>
 
555
</colgroup>
 
556
<tbody>
 
557
<tr>
 
558
<td><p><span class="term"><em class="parameter"><code>app</code></em> :</span></p></td>
 
559
<td>a <span class="type">ShellApp</span>
 
560
</td>
 
561
</tr>
 
562
<tr>
 
563
<td><p><span class="term"><em class="parameter"><code>workspace</code></em> :</span></p></td>
 
564
<td>open on this workspace, or -1 for default</td>
 
565
</tr>
 
566
</tbody>
 
567
</table></div>
 
568
</div>
 
569
<hr>
 
570
<div class="refsect2">
 
571
<a name="shell-app-request-quit"></a><h3>shell_app_request_quit ()</h3>
 
572
<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>
 
573
<p>
 
574
Initiate an asynchronous request to quit this application.
 
575
The application may interact with the user, and the user
 
576
might cancel the quit request from the application UI.
 
577
</p>
 
578
<p>
 
579
This operation may not be supported for all applications.
 
580
</p>
 
581
<div class="variablelist"><table border="0" class="variablelist">
 
582
<colgroup>
 
583
<col align="left" valign="top">
 
584
<col>
 
585
</colgroup>
 
586
<tbody>
 
587
<tr>
 
588
<td><p><span class="term"><em class="parameter"><code>app</code></em> :</span></p></td>
 
589
<td>A <span class="type">ShellApp</span>
 
590
</td>
554
591
</tr>
555
592
<tr>
556
593
<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>
559
 
</td>
 
594
<td>
 
595
<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>
560
596
</tr>
561
597
</tbody>
562
598
</table></div>
563
599
</div>
564
600
<hr>
565
601
<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>
569
 
<p>
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
575
 
    compares earlier.
576
 
</p>
577
 
<div class="variablelist"><table border="0" class="variablelist">
578
 
<colgroup>
579
 
<col align="left" valign="top">
580
 
<col>
581
 
</colgroup>
582
 
<tbody><tr>
583
 
<td><p><span class="term"><em class="parameter"><code>other</code></em> :</span></p></td>
584
 
<td>A <span class="type">ShellApp</span>
585
 
</td>
586
 
</tr></tbody>
587
 
</table></div>
 
602
<a name="shell-app-update-app-menu"></a><h3>shell_app_update_app_menu ()</h3>
 
603
<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>,
 
604
                                                         <em class="parameter"><code><a href="http://developer.gnome.org/meta/MetaWindow.html"><span class="type">MetaWindow</span></a> *window</code></em>);</pre>
588
605
</div>
589
606
<hr>
590
607
<div class="refsect2">
592
609
<pre class="programlisting"><span class="returnvalue">void</span>                shell_app_update_window_actions     (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>,
593
610
                                                         <em class="parameter"><code><a href="http://developer.gnome.org/meta/MetaWindow.html"><span class="type">MetaWindow</span></a> *window</code></em>);</pre>
594
611
</div>
595
 
<hr>
596
 
<div class="refsect2">
597
 
<a name="shell-app-update-app-menu"></a><h3>shell_app_update_app_menu ()</h3>
598
 
<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>,
599
 
                                                         <em class="parameter"><code><a href="http://developer.gnome.org/meta/MetaWindow.html"><span class="type">MetaWindow</span></a> *window</code></em>);</pre>
600
 
</div>
601
 
<hr>
602
 
<div class="refsect2">
603
 
<a name="ShellAppAction"></a><h3>ShellAppAction</h3>
604
 
<pre class="programlisting">typedef struct _ShellAppAction ShellAppAction;</pre>
605
 
</div>
606
612
</div>
607
613
</div>
608
614
<div class="footer">
609
615
<hr>
610
 
          Generated by GTK-Doc V1.18.1</div>
 
616
          Generated by GTK-Doc V1.19</div>
611
617
</body>
612
618
</html>
 
 
b'\\ No newline at end of file'