← Back to branch summary

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

« 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: 2012-03-14 13:47:20 UTC
  • mfrom: (1.1.36) (18.1.8 sid)
  • Revision ID: package-import@ubuntu.com-20120314134720-202sbjbu4a3z1fru
Tags: 3.3.90-0ubuntu1
https://launchpad.net/bugs/941755
https://launchpad.net/bugs/937709
* Sync with Debian experimental svn packaging (LP: #941755, #937709).
  Remaining changes:
  - debian/gnome-shell.gsettings-override: Update for Ubuntu defaults
  - debian/control.in: Recommend cups-pk-helper
  - debian/patches/10-make-NetworkManager-optional.patch: Disabled
  - Don't run dh-autoreconf

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/shell/html/shell-ShellApp.html
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 
2
<html>
 
3
<head>
 
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 
5
<title>ShellApp</title>
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
 
7
<link rel="home" href="index.html" title="Shell Reference Manual">
 
8
<link rel="up" href="ch02.html" title="Application tracking">
 
9
<link rel="prev" href="ch02.html" title="Application tracking">
 
10
<link rel="next" href="shell-ShellAppUsage.html" title="ShellAppUsage">
 
11
<meta name="generator" content="GTK-Doc V1.18.1 (XML mode)">
 
12
<link rel="stylesheet" href="style.css" type="text/css">
 
13
</head>
 
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
 
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
 
16
<tr valign="middle">
 
17
<td><a accesskey="p" href="ch02.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
18
<td><a accesskey="u" href="ch02.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
 
19
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
 
20
<th width="100%" align="center">Shell Reference Manual</th>
 
21
<td><a accesskey="n" href="shell-ShellAppUsage.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
 
22
</tr>
 
23
<tr><td colspan="5" class="shortcuts">
 
24
<a href="#shell-ShellApp.synopsis" class="shortcut">Top</a>
 
25
                   | 
 
26
                  <a href="#shell-ShellApp.description" class="shortcut">Description</a>
 
27
                   | 
 
28
                  <a href="#shell-ShellApp.object-hierarchy" class="shortcut">Object Hierarchy</a>
 
29
</td></tr>
 
30
</table>
 
31
<div class="refentry">
 
32
<a name="shell-ShellApp"></a><div class="titlepage"></div>
 
33
<div class="refnamediv"><table width="100%"><tr>
 
34
<td valign="top">
 
35
<h2><span class="refentrytitle"><a name="shell-ShellApp.top_of_page"></a>ShellApp</span></h2>
 
36
<p>ShellApp — Object representing an application</p>
 
37
</td>
 
38
<td valign="top" align="right"></td>
 
39
</tr></table></div>
 
40
<div class="refsynopsisdiv">
 
41
<a name="shell-ShellApp.synopsis"></a><h2>Synopsis</h2>
 
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>;
 
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><span class="type">guint32</span> 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><span class="type">guint32</span> 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
<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>,
 
57
                                                         <em class="parameter"><code><span class="type">int</span> size</code></em>);
 
58
<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>);
 
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
<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>,
 
61
                                                         <em class="parameter"><code><span class="type">int</span> size</code></em>);
 
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
<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>);
 
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
<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>);
 
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>);
 
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>);
 
68
<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>);
 
69
<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>,
 
70
                                                         <em class="parameter"><code><span class="type">MetaWorkspace</span> *workspace</code></em>);
 
71
<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>);
 
72
<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>,
 
73
                                                         <em class="parameter"><code><span class="type">guint</span> timestamp</code></em>,
 
74
                                                         <em class="parameter"><code><span class="type">GList</span> *uris</code></em>,
 
75
                                                         <em class="parameter"><code><span class="type">int</span> workspace</code></em>,
 
76
                                                         <em class="parameter"><code><span class="type">char</span> **startup_id</code></em>,
 
77
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
 
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>,
 
79
                                                         <em class="parameter"><code><span class="type">int</span> workspace</code></em>);
 
80
<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>);
 
81
<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>,
 
82
                                                         <em class="parameter"><code><span class="type">MetaWindow</span> *window</code></em>);
 
83
</pre>
 
84
</div>
 
85
<div class="refsect1">
 
86
<a name="shell-ShellApp.object-hierarchy"></a><h2>Object Hierarchy</h2>
 
87
<pre class="synopsis">
 
88
  GEnum
 
89
   +----ShellAppState
 
90
</pre>
 
91
</div>
 
92
<div class="refsect1">
 
93
<a name="shell-ShellApp.description"></a><h2>Description</h2>
 
94
<p>
 
95
This object wraps a <span class="type">GMenuTreeEntry</span>, providing methods and signals
 
96
primarily useful for running applications.
 
97
</p>
 
98
</div>
 
99
<div class="refsect1">
 
100
<a name="shell-ShellApp.details"></a><h2>Details</h2>
 
101
<div class="refsect2">
 
102
<a name="ShellAppAction"></a><h3>ShellAppAction</h3>
 
103
<pre class="programlisting">typedef struct _ShellAppAction ShellAppAction;</pre>
 
104
</div>
 
105
<hr>
 
106
<div class="refsect2">
 
107
<a name="ShellAppClass"></a><h3>struct ShellAppClass</h3>
 
108
<pre class="programlisting">struct ShellAppClass {
 
109
  GObjectClass parent_class;
 
110
};
 
111
</pre>
 
112
</div>
 
113
<hr>
 
114
<div class="refsect2">
 
115
<a name="ShellAppState-enum"></a><h3>enum ShellAppState</h3>
 
116
<pre class="programlisting">typedef enum {
 
117
  SHELL_APP_STATE_STOPPED,
 
118
  SHELL_APP_STATE_STARTING,
 
119
  SHELL_APP_STATE_RUNNING
 
120
} ShellAppState;
 
121
</pre>
 
122
</div>
 
123
<hr>
 
124
<div class="refsect2">
 
125
<a name="shell-app-activate"></a><h3>shell_app_activate ()</h3>
 
126
<pre class="programlisting"><span class="returnvalue">void</span>                shell_app_activate                  (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>);</pre>
 
127
<p>
 
128
Like <a class="link" href="shell-ShellApp.html#shell-app-activate-full" title="shell_app_activate_full ()"><code class="function">shell_app_activate_full()</code></a>, but using the default workspace and
 
129
event timestamp.
 
130
</p>
 
131
<div class="variablelist"><table border="0">
 
132
<col align="left" valign="top">
 
133
<tbody><tr>
 
134
<td><p><span class="term"><em class="parameter"><code>app</code></em> :</span></p></td>
 
135
<td>a <span class="type">ShellApp</span>
 
136
</td>
 
137
</tr></tbody>
 
138
</table></div>
 
139
</div>
 
140
<hr>
 
141
<div class="refsect2">
 
142
<a name="shell-app-activate-full"></a><h3>shell_app_activate_full ()</h3>
 
143
<pre class="programlisting"><span class="returnvalue">void</span>                shell_app_activate_full             (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>,
 
144
                                                         <em class="parameter"><code><span class="type">int</span> workspace</code></em>,
 
145
                                                         <em class="parameter"><code><span class="type">guint32</span> timestamp</code></em>);</pre>
 
146
<p>
 
147
Perform an appropriate default action for operating on this application,
 
148
dependent on its current state.  For example, if the application is not
 
149
currently running, launch it.  If it is running, activate the most
 
150
recently used NORMAL window (or if that window has a transient, the most
 
151
recently used transient for that window).
 
152
</p>
 
153
<div class="variablelist"><table border="0">
 
154
<col align="left" valign="top">
 
155
<tbody>
 
156
<tr>
 
157
<td><p><span class="term"><em class="parameter"><code>app</code></em> :</span></p></td>
 
158
<td>a <span class="type">ShellApp</span>
 
159
</td>
 
160
</tr>
 
161
<tr>
 
162
<td><p><span class="term"><em class="parameter"><code>workspace</code></em> :</span></p></td>
 
163
<td>launch on this workspace, or -1 for default. Ignored if
 
164
activating an existing window</td>
 
165
</tr>
 
166
<tr>
 
167
<td><p><span class="term"><em class="parameter"><code>timestamp</code></em> :</span></p></td>
 
168
<td>Event timestamp</td>
 
169
</tr>
 
170
</tbody>
 
171
</table></div>
 
172
</div>
 
173
<hr>
 
174
<div class="refsect2">
 
175
<a name="shell-app-activate-window"></a><h3>shell_app_activate_window ()</h3>
 
176
<pre class="programlisting"><span class="returnvalue">void</span>                shell_app_activate_window           (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>,
 
177
                                                         <em class="parameter"><code><span class="type">MetaWindow</span> *window</code></em>,
 
178
                                                         <em class="parameter"><code><span class="type">guint32</span> timestamp</code></em>);</pre>
 
179
<p>
 
180
Bring all windows for the given app to the foreground,
 
181
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/otaylor/gnome/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>,
 
182
the window with the most recent user time for the app
 
183
will be used.
 
184
</p>
 
185
<p>
 
186
This function has no effect if <em class="parameter"><code>app</code></em> is not currently running.
 
187
</p>
 
188
<div class="variablelist"><table border="0">
 
189
<col align="left" valign="top">
 
190
<tbody>
 
191
<tr>
 
192
<td><p><span class="term"><em class="parameter"><code>app</code></em> :</span></p></td>
 
193
<td>a <span class="type">ShellApp</span>
 
194
</td>
 
195
</tr>
 
196
<tr>
 
197
<td><p><span class="term"><em class="parameter"><code>window</code></em> :</span></p></td>
 
198
<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>
 
199
</td>
 
200
</tr>
 
201
<tr>
 
202
<td><p><span class="term"><em class="parameter"><code>timestamp</code></em> :</span></p></td>
 
203
<td>Event timestamp</td>
 
204
</tr>
 
205
</tbody>
 
206
</table></div>
 
207
</div>
 
208
<hr>
 
209
<div class="refsect2">
 
210
<a name="shell-app-compare"></a><h3>shell_app_compare ()</h3>
 
211
<pre class="programlisting"><span class="returnvalue">int</span>                 shell_app_compare                   (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>,
 
212
                                                         <em class="parameter"><code><span class="type">ShellApp</span> *other</code></em>);</pre>
 
213
<p>
 
214
Compare one <span class="type">ShellApp</span> instance to another, in the following way:
 
215
  - Running applications sort before not-running applications.
 
216
  - If one of them has visible windows and the other does not, the one
 
217
    with visible windows is first.
 
218
  - Finally, the application which the user interacted with most recently
 
219
    compares earlier.
 
220
</p>
 
221
<div class="variablelist"><table border="0">
 
222
<col align="left" valign="top">
 
223
<tbody><tr>
 
224
<td><p><span class="term"><em class="parameter"><code>other</code></em> :</span></p></td>
 
225
<td>A <span class="type">ShellApp</span>
 
226
</td>
 
227
</tr></tbody>
 
228
</table></div>
 
229
</div>
 
230
<hr>
 
231
<div class="refsect2">
 
232
<a name="shell-app-compare-by-name"></a><h3>shell_app_compare_by_name ()</h3>
 
233
<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>,
 
234
                                                         <em class="parameter"><code><span class="type">ShellApp</span> *other</code></em>);</pre>
 
235
<p>
 
236
Order two applications by name.
 
237
</p>
 
238
<div class="variablelist"><table border="0">
 
239
<col align="left" valign="top">
 
240
<tbody>
 
241
<tr>
 
242
<td><p><span class="term"><em class="parameter"><code>app</code></em> :</span></p></td>
 
243
<td>One app</td>
 
244
</tr>
 
245
<tr>
 
246
<td><p><span class="term"><em class="parameter"><code>other</code></em> :</span></p></td>
 
247
<td>The other app</td>
 
248
</tr>
 
249
<tr>
 
250
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
251
<td>-1, 0, or 1; suitable for use as a comparison function
 
252
for e.g. <code class="function">g_slist_sort()</code>
 
253
</td>
 
254
</tr>
 
255
</tbody>
 
256
</table></div>
 
257
</div>
 
258
<hr>
 
259
<div class="refsect2">
 
260
<a name="shell-app-create-icon-texture"></a><h3>shell_app_create_icon_texture ()</h3>
 
261
<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>,
 
262
                                                         <em class="parameter"><code><span class="type">int</span> size</code></em>);</pre>
 
263
<p>
 
264
Look up the icon for this application, and create a <span class="type">ClutterTexture</span>
 
265
for it at the given size.
 
266
</p>
 
267
<div class="variablelist"><table border="0">
 
268
<col align="left" valign="top">
 
269
<tbody><tr>
 
270
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
271
<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>
 
272
</td>
 
273
</tr></tbody>
 
274
</table></div>
 
275
</div>
 
276
<hr>
 
277
<div class="refsect2">
 
278
<a name="shell-app-get-app-info"></a><h3>shell_app_get_app_info ()</h3>
 
279
<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>
 
280
<div class="variablelist"><table border="0">
 
281
<col align="left" valign="top">
 
282
<tbody>
 
283
<tr>
 
284
<td><p><span class="term"><em class="parameter"><code>app</code></em> :</span></p></td>
 
285
<td>a <span class="type">ShellApp</span>
 
286
</td>
 
287
</tr>
 
288
<tr>
 
289
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
290
<td>The <span class="type">GDesktopAppInfo</span> for this app, or <a href="/home/otaylor/gnome/install/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>
 
291
</td>
 
292
</tr>
 
293
</tbody>
 
294
</table></div>
 
295
</div>
 
296
<hr>
 
297
<div class="refsect2">
 
298
<a name="shell-app-get-description"></a><h3>shell_app_get_description ()</h3>
 
299
<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>
 
300
</div>
 
301
<hr>
 
302
<div class="refsect2">
 
303
<a name="shell-app-get-faded-icon"></a><h3>shell_app_get_faded_icon ()</h3>
 
304
<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>,
 
305
                                                         <em class="parameter"><code><span class="type">int</span> size</code></em>);</pre>
 
306
<p>
 
307
Return an actor with a horizontally faded look.
 
308
</p>
 
309
<div class="variablelist"><table border="0">
 
310
<col align="left" valign="top">
 
311
<tbody>
 
312
<tr>
 
313
<td><p><span class="term"><em class="parameter"><code>app</code></em> :</span></p></td>
 
314
<td>A <span class="type">ShellApp</span>
 
315
</td>
 
316
</tr>
 
317
<tr>
 
318
<td><p><span class="term"><em class="parameter"><code>size</code></em> :</span></p></td>
 
319
<td>Size in pixels</td>
 
320
</tr>
 
321
<tr>
 
322
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
323
<td>A floating <span class="type">ClutterActor</span>, or <a href="/home/otaylor/gnome/install/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>
 
324
</td>
 
325
</tr>
 
326
</tbody>
 
327
</table></div>
 
328
</div>
 
329
<hr>
 
330
<div class="refsect2">
 
331
<a name="shell-app-get-id"></a><h3>shell_app_get_id ()</h3>
 
332
<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>
 
333
</div>
 
334
<hr>
 
335
<div class="refsect2">
 
336
<a name="shell-app-get-n-windows"></a><h3>shell_app_get_n_windows ()</h3>
 
337
<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>
 
338
</div>
 
339
<hr>
 
340
<div class="refsect2">
 
341
<a name="shell-app-get-name"></a><h3>shell_app_get_name ()</h3>
 
342
<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>
 
343
</div>
 
344
<hr>
 
345
<div class="refsect2">
 
346
<a name="shell-app-get-pids"></a><h3>shell_app_get_pids ()</h3>
 
347
<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>
 
348
<div class="variablelist"><table border="0">
 
349
<col align="left" valign="top">
 
350
<tbody>
 
351
<tr>
 
352
<td><p><span class="term"><em class="parameter"><code>app</code></em> :</span></p></td>
 
353
<td>a <span class="type">ShellApp</span>
 
354
</td>
 
355
</tr>
 
356
<tr>
 
357
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
358
<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>
 
359
</td>
 
360
</tr>
 
361
</tbody>
 
362
</table></div>
 
363
</div>
 
364
<hr>
 
365
<div class="refsect2">
 
366
<a name="shell-app-get-state"></a><h3>shell_app_get_state ()</h3>
 
367
<pre class="programlisting"><a class="link" href="shell-ShellApp.html#ShellAppState"><span class="returnvalue">ShellAppState</span></a>       shell_app_get_state                 (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>);</pre>
 
368
<div class="variablelist"><table border="0">
 
369
<col align="left" valign="top">
 
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"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
378
<td>State of the application</td>
 
379
</tr>
 
380
</tbody>
 
381
</table></div>
 
382
</div>
 
383
<hr>
 
384
<div class="refsect2">
 
385
<a name="shell-app-get-tree-entry"></a><h3>shell_app_get_tree_entry ()</h3>
 
386
<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>
 
387
<div class="variablelist"><table border="0">
 
388
<col align="left" valign="top">
 
389
<tbody>
 
390
<tr>
 
391
<td><p><span class="term"><em class="parameter"><code>app</code></em> :</span></p></td>
 
392
<td>a <span class="type">ShellApp</span>
 
393
</td>
 
394
</tr>
 
395
<tr>
 
396
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
397
<td>The <span class="type">GMenuTreeEntry</span> for this app, or <a href="/home/otaylor/gnome/install/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>
 
398
</td>
 
399
</tr>
 
400
</tbody>
 
401
</table></div>
 
402
</div>
 
403
<hr>
 
404
<div class="refsect2">
 
405
<a name="shell-app-get-windows"></a><h3>shell_app_get_windows ()</h3>
 
406
<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>
 
407
<p>
 
408
Get the toplevel, interesting windows which are associated with this
 
409
application.  The returned list will be sorted first by whether
 
410
they're on the active workspace, then by whether they're visible,
 
411
and finally by the time the user last interacted with them.
 
412
</p>
 
413
<div class="variablelist"><table border="0">
 
414
<col align="left" valign="top">
 
415
<tbody><tr>
 
416
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
417
<td>List of windows. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> MetaWindow]</span>
 
418
</td>
 
419
</tr></tbody>
 
420
</table></div>
 
421
</div>
 
422
<hr>
 
423
<div class="refsect2">
 
424
<a name="shell-app-is-on-workspace"></a><h3>shell_app_is_on_workspace ()</h3>
 
425
<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>,
 
426
                                                         <em class="parameter"><code><span class="type">MetaWorkspace</span> *workspace</code></em>);</pre>
 
427
</div>
 
428
<hr>
 
429
<div class="refsect2">
 
430
<a name="shell-app-is-window-backed"></a><h3>shell_app_is_window_backed ()</h3>
 
431
<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>
 
432
<p>
 
433
A window backed application is one which represents just an open
 
434
window, i.e. there's no .desktop file assocation, so we don't know
 
435
how to launch it again.
 
436
</p>
 
437
</div>
 
438
<hr>
 
439
<div class="refsect2">
 
440
<a name="shell-app-launch"></a><h3>shell_app_launch ()</h3>
 
441
<pre class="programlisting"><span class="returnvalue">gboolean</span>            shell_app_launch                    (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>,
 
442
                                                         <em class="parameter"><code><span class="type">guint</span> timestamp</code></em>,
 
443
                                                         <em class="parameter"><code><span class="type">GList</span> *uris</code></em>,
 
444
                                                         <em class="parameter"><code><span class="type">int</span> workspace</code></em>,
 
445
                                                         <em class="parameter"><code><span class="type">char</span> **startup_id</code></em>,
 
446
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
 
447
<div class="variablelist"><table border="0">
 
448
<col align="left" valign="top">
 
449
<tbody>
 
450
<tr>
 
451
<td><p><span class="term"><em class="parameter"><code>timestamp</code></em> :</span></p></td>
 
452
<td>Event timestamp, or 0 for current event timestamp</td>
 
453
</tr>
 
454
<tr>
 
455
<td><p><span class="term"><em class="parameter"><code>uris</code></em> :</span></p></td>
 
456
<td>List of uris to pass to application. <span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8]</span>
 
457
</td>
 
458
</tr>
 
459
<tr>
 
460
<td><p><span class="term"><em class="parameter"><code>workspace</code></em> :</span></p></td>
 
461
<td>Start on this workspace, or -1 for default</td>
 
462
</tr>
 
463
<tr>
 
464
<td><p><span class="term"><em class="parameter"><code>startup_id</code></em> :</span></p></td>
 
465
<td>Returned startup notification ID, or <a href="/home/otaylor/gnome/install/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>
 
466
</td>
 
467
</tr>
 
468
<tr>
 
469
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
 
470
<td>A <span class="type">GError</span>
 
471
</td>
 
472
</tr>
 
473
</tbody>
 
474
</table></div>
 
475
</div>
 
476
<hr>
 
477
<div class="refsect2">
 
478
<a name="shell-app-open-new-window"></a><h3>shell_app_open_new_window ()</h3>
 
479
<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>,
 
480
                                                         <em class="parameter"><code><span class="type">int</span> workspace</code></em>);</pre>
 
481
<p>
 
482
Request that the application create a new window.
 
483
</p>
 
484
<div class="variablelist"><table border="0">
 
485
<col align="left" valign="top">
 
486
<tbody>
 
487
<tr>
 
488
<td><p><span class="term"><em class="parameter"><code>app</code></em> :</span></p></td>
 
489
<td>a <span class="type">ShellApp</span>
 
490
</td>
 
491
</tr>
 
492
<tr>
 
493
<td><p><span class="term"><em class="parameter"><code>workspace</code></em> :</span></p></td>
 
494
<td>open on this workspace, or -1 for default</td>
 
495
</tr>
 
496
</tbody>
 
497
</table></div>
 
498
</div>
 
499
<hr>
 
500
<div class="refsect2">
 
501
<a name="shell-app-request-quit"></a><h3>shell_app_request_quit ()</h3>
 
502
<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>
 
503
<p>
 
504
Initiate an asynchronous request to quit this application.
 
505
The application may interact with the user, and the user
 
506
might cancel the quit request from the application UI.
 
507
</p>
 
508
<p>
 
509
This operation may not be supported for all applications.
 
510
</p>
 
511
<div class="variablelist"><table border="0">
 
512
<col align="left" valign="top">
 
513
<tbody>
 
514
<tr>
 
515
<td><p><span class="term"><em class="parameter"><code>app</code></em> :</span></p></td>
 
516
<td>A <span class="type">ShellApp</span>
 
517
</td>
 
518
</tr>
 
519
<tr>
 
520
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
521
<td>
 
522
<code class="literal">TRUE</code> if a quit request is supported for this application</td>
 
523
</tr>
 
524
</tbody>
 
525
</table></div>
 
526
</div>
 
527
<hr>
 
528
<div class="refsect2">
 
529
<a name="shell-app-update-window-actions"></a><h3>shell_app_update_window_actions ()</h3>
 
530
<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>,
 
531
                                                         <em class="parameter"><code><span class="type">MetaWindow</span> *window</code></em>);</pre>
 
532
</div>
 
533
</div>
 
534
</div>
 
535
<div class="footer">
 
536
<hr>
 
537
          Generated by GTK-Doc V1.18.1</div>
 
538
</body>
 
539
</html>
 
 
b'\\ No newline at end of file'