~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): Tim Lunn
  • Date: 2013-02-21 11:55:19 UTC
  • mfrom: (1.1.48)
  • Revision ID: package-import@ubuntu.com-20130221115519-ds607jwrcatdfvse
Tags: 3.6.3.1-0ubuntu1
* New upstream release (LP: #1128804)
* debian/patches:
  - git_messagetray_fix_expansion.patch, Drop applied upstream

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.18 (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><span class="type">MetaWindow</span> *window</code></em>,
 
51
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> timestamp</code></em>);
 
52
<span class="returnvalue">int</span>                 <a class="link" href="shell-ShellApp.html#shell-app-compare" title="shell_app_compare ()">shell_app_compare</a>                   (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>,
 
53
                                                         <em class="parameter"><code><span class="type">ShellApp</span> *other</code></em>);
 
54
<span class="returnvalue">int</span>                 <a class="link" href="shell-ShellApp.html#shell-app-compare-by-name" title="shell_app_compare_by_name ()">shell_app_compare_by_name</a>           (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>,
 
55
                                                         <em class="parameter"><code><span class="type">ShellApp</span> *other</code></em>);
 
56
<a href="/usr/share/gtk-doc/html/clutter/ClutterActor.html"><span class="returnvalue">ClutterActor</span></a> *      <a class="link" href="shell-ShellApp.html#shell-app-create-icon-texture" title="shell_app_create_icon_texture ()">shell_app_create_icon_texture</a>       (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>,
 
57
                                                         <em class="parameter"><code><span class="type">int</span> size</code></em>);
 
58
<a href="http://library.gnome.org/devel/gio/unstable/gio-Desktop-file-based-GAppInfo.html#GDesktopAppInfo"><span class="returnvalue">GDesktopAppInfo</span></a> *   <a class="link" href="shell-ShellApp.html#shell-app-get-app-info" title="shell_app_get_app_info ()">shell_app_get_app_info</a>              (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>);
 
59
const <span class="returnvalue">char</span> *        <a class="link" href="shell-ShellApp.html#shell-app-get-description" title="shell_app_get_description ()">shell_app_get_description</a>           (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>);
 
60
<a href="/usr/share/gtk-doc/html/clutter/ClutterActor.html"><span class="returnvalue">ClutterActor</span></a> *      <a class="link" href="shell-ShellApp.html#shell-app-get-faded-icon" title="shell_app_get_faded_icon ()">shell_app_get_faded_icon</a>            (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>,
 
61
                                                         <em class="parameter"><code><span class="type">int</span> size</code></em>);
44
62
const <span class="returnvalue">char</span> *        <a class="link" href="shell-ShellApp.html#shell-app-get-id" title="shell_app_get_id ()">shell_app_get_id</a>                    (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>);
 
63
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <a class="link" href="shell-ShellApp.html#shell-app-get-n-windows" title="shell_app_get_n_windows ()">shell_app_get_n_windows</a>             (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>);
 
64
const <span class="returnvalue">char</span> *        <a class="link" href="shell-ShellApp.html#shell-app-get-name" title="shell_app_get_name ()">shell_app_get_name</a>                  (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>);
 
65
<a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> *            <a class="link" href="shell-ShellApp.html#shell-app-get-pids" title="shell_app_get_pids ()">shell_app_get_pids</a>                  (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>);
 
66
<a class="link" href="shell-ShellApp.html#ShellAppState"><span class="returnvalue">ShellAppState</span></a>       <a class="link" href="shell-ShellApp.html#shell-app-get-state" title="shell_app_get_state ()">shell_app_get_state</a>                 (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>);
45
67
<span class="returnvalue">GMenuTreeEntry</span> *    <a class="link" href="shell-ShellApp.html#shell-app-get-tree-entry" title="shell_app_get_tree_entry ()">shell_app_get_tree_entry</a>            (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>);
46
 
<span class="returnvalue">GDesktopAppInfo</span> *   <a class="link" href="shell-ShellApp.html#shell-app-get-app-info" title="shell_app_get_app_info ()">shell_app_get_app_info</a>              (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>);
47
 
<span class="returnvalue">ClutterActor</span> *      <a class="link" href="shell-ShellApp.html#shell-app-create-icon-texture" title="shell_app_create_icon_texture ()">shell_app_create_icon_texture</a>       (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>,
48
 
                                                         <em class="parameter"><code><span class="type">int</span> size</code></em>);
49
 
<span class="returnvalue">ClutterActor</span> *      <a class="link" href="shell-ShellApp.html#shell-app-get-faded-icon" title="shell_app_get_faded_icon ()">shell_app_get_faded_icon</a>            (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>,
50
 
                                                         <em class="parameter"><code><span class="type">int</span> size</code></em>);
51
 
const <span class="returnvalue">char</span> *        <a class="link" href="shell-ShellApp.html#shell-app-get-name" title="shell_app_get_name ()">shell_app_get_name</a>                  (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>);
52
 
const <span class="returnvalue">char</span> *        <a class="link" href="shell-ShellApp.html#shell-app-get-description" title="shell_app_get_description ()">shell_app_get_description</a>           (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>);
53
 
<span class="returnvalue">gboolean</span>            <a class="link" href="shell-ShellApp.html#shell-app-is-window-backed" title="shell_app_is_window_backed ()">shell_app_is_window_backed</a>          (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>);
54
 
<span class="returnvalue">void</span>                <a class="link" href="shell-ShellApp.html#shell-app-activate-window" title="shell_app_activate_window ()">shell_app_activate_window</a>           (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>,
55
 
                                                         <em class="parameter"><code><span class="type">MetaWindow</span> *window</code></em>,
56
 
                                                         <em class="parameter"><code><span class="type">guint32</span> timestamp</code></em>);
57
 
<span class="returnvalue">void</span>                <a class="link" href="shell-ShellApp.html#shell-app-activate" title="shell_app_activate ()">shell_app_activate</a>                  (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>);
58
 
<span class="returnvalue">void</span>                <a class="link" href="shell-ShellApp.html#shell-app-activate-full" title="shell_app_activate_full ()">shell_app_activate_full</a>             (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>,
 
68
<a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> *            <a class="link" href="shell-ShellApp.html#shell-app-get-windows" title="shell_app_get_windows ()">shell_app_get_windows</a>               (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>);
 
69
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="shell-ShellApp.html#shell-app-is-on-workspace" title="shell_app_is_on_workspace ()">shell_app_is_on_workspace</a>           (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>,
 
70
                                                         <em class="parameter"><code><span class="type">MetaWorkspace</span> *workspace</code></em>);
 
71
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="shell-ShellApp.html#shell-app-is-window-backed" title="shell_app_is_window_backed ()">shell_app_is_window_backed</a>          (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>);
 
72
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="shell-ShellApp.html#shell-app-launch" title="shell_app_launch ()">shell_app_launch</a>                    (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>,
 
73
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> timestamp</code></em>,
 
74
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> *uris</code></em>,
59
75
                                                         <em class="parameter"><code><span class="type">int</span> workspace</code></em>,
60
 
                                                         <em class="parameter"><code><span class="type">guint32</span> timestamp</code></em>);
 
76
                                                         <em class="parameter"><code><span class="type">char</span> **startup_id</code></em>,
 
77
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
61
78
<span class="returnvalue">void</span>                <a class="link" href="shell-ShellApp.html#shell-app-open-new-window" title="shell_app_open_new_window ()">shell_app_open_new_window</a>           (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>,
62
79
                                                         <em class="parameter"><code><span class="type">int</span> workspace</code></em>);
63
 
<a class="link" href="shell-ShellApp.html#ShellAppState"><span class="returnvalue">ShellAppState</span></a>       <a class="link" href="shell-ShellApp.html#shell-app-get-state" title="shell_app_get_state ()">shell_app_get_state</a>                 (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>);
64
 
<span class="returnvalue">gboolean</span>            <a class="link" href="shell-ShellApp.html#shell-app-request-quit" title="shell_app_request_quit ()">shell_app_request_quit</a>              (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>);
65
 
<span class="returnvalue">guint</span>               <a class="link" href="shell-ShellApp.html#shell-app-get-n-windows" title="shell_app_get_n_windows ()">shell_app_get_n_windows</a>             (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>);
66
 
<span class="returnvalue">GSList</span> *            <a class="link" href="shell-ShellApp.html#shell-app-get-windows" title="shell_app_get_windows ()">shell_app_get_windows</a>               (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>);
67
 
<span class="returnvalue">GSList</span> *            <a class="link" href="shell-ShellApp.html#shell-app-get-pids" title="shell_app_get_pids ()">shell_app_get_pids</a>                  (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>);
68
 
<span class="returnvalue">gboolean</span>            <a class="link" href="shell-ShellApp.html#shell-app-is-on-workspace" title="shell_app_is_on_workspace ()">shell_app_is_on_workspace</a>           (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>,
69
 
                                                         <em class="parameter"><code><span class="type">MetaWorkspace</span> *workspace</code></em>);
70
 
<span class="returnvalue">gboolean</span>            <a class="link" href="shell-ShellApp.html#shell-app-launch" title="shell_app_launch ()">shell_app_launch</a>                    (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>,
71
 
                                                         <em class="parameter"><code><span class="type">guint</span> timestamp</code></em>,
72
 
                                                         <em class="parameter"><code><span class="type">GList</span> *uris</code></em>,
73
 
                                                         <em class="parameter"><code><span class="type">int</span> workspace</code></em>,
74
 
                                                         <em class="parameter"><code><span class="type">char</span> **startup_id</code></em>,
75
 
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
76
 
<span class="returnvalue">int</span>                 <a class="link" href="shell-ShellApp.html#shell-app-compare-by-name" title="shell_app_compare_by_name ()">shell_app_compare_by_name</a>           (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>,
77
 
                                                         <em class="parameter"><code><span class="type">ShellApp</span> *other</code></em>);
78
 
<span class="returnvalue">int</span>                 <a class="link" href="shell-ShellApp.html#shell-app-compare" title="shell_app_compare ()">shell_app_compare</a>                   (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>,
79
 
                                                         <em class="parameter"><code><span class="type">ShellApp</span> *other</code></em>);
 
80
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="shell-ShellApp.html#shell-app-request-quit" title="shell_app_request_quit ()">shell_app_request_quit</a>              (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>);
 
81
<span class="returnvalue">void</span>                <a class="link" href="shell-ShellApp.html#shell-app-update-app-menu" title="shell_app_update_app_menu ()">shell_app_update_app_menu</a>           (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>,
 
82
                                                         <em class="parameter"><code><span class="type">MetaWindow</span> *window</code></em>);
80
83
<span class="returnvalue">void</span>                <a class="link" href="shell-ShellApp.html#shell-app-update-window-actions" title="shell_app_update_window_actions ()">shell_app_update_window_actions</a>     (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>,
81
84
                                                         <em class="parameter"><code><span class="type">MetaWindow</span> *window</code></em>);
82
 
<span class="returnvalue">void</span>                <a class="link" href="shell-ShellApp.html#shell-app-update-app-menu" title="shell_app_update_app_menu ()">shell_app_update_app_menu</a>           (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>,
83
 
                                                         <em class="parameter"><code><span class="type">MetaWindow</span> *window</code></em>);
84
 
                    <a class="link" href="shell-ShellApp.html#ShellAppAction" title="ShellAppAction">ShellAppAction</a>;
85
85
</pre>
86
86
</div>
87
87
<div class="refsect1">
101
101
<div class="refsect1">
102
102
<a name="shell-ShellApp.details"></a><h2>Details</h2>
103
103
<div class="refsect2">
 
104
<a name="ShellAppAction"></a><h3>ShellAppAction</h3>
 
105
<pre class="programlisting">typedef struct _ShellAppAction ShellAppAction;</pre>
 
106
</div>
 
107
<hr>
 
108
<div class="refsect2">
104
109
<a name="ShellAppClass"></a><h3>struct ShellAppClass</h3>
105
110
<pre class="programlisting">struct ShellAppClass {
106
111
  GObjectClass parent_class;
116
121
  SHELL_APP_STATE_RUNNING
117
122
} ShellAppState;
118
123
</pre>
119
 
<div class="variablelist"><table border="0" class="variablelist">
120
 
<colgroup>
121
 
<col align="left" valign="top">
122
 
<col>
123
 
</colgroup>
124
 
<tbody>
125
 
<tr>
126
 
<td><p><a name="SHELL-APP-STATE-STOPPED:CAPS"></a><span class="term"><code class="literal">SHELL_APP_STATE_STOPPED</code></span></p></td>
127
 
<td></td>
128
 
</tr>
129
 
<tr>
130
 
<td><p><a name="SHELL-APP-STATE-STARTING:CAPS"></a><span class="term"><code class="literal">SHELL_APP_STATE_STARTING</code></span></p></td>
131
 
<td></td>
132
 
</tr>
133
 
<tr>
134
 
<td><p><a name="SHELL-APP-STATE-RUNNING:CAPS"></a><span class="term"><code class="literal">SHELL_APP_STATE_RUNNING</code></span></p></td>
135
 
<td></td>
136
 
</tr>
137
 
</tbody>
138
 
</table></div>
139
 
</div>
140
 
<hr>
141
 
<div class="refsect2">
142
 
<a name="shell-app-get-id"></a><h3>shell_app_get_id ()</h3>
143
 
<pre class="programlisting">const <span class="returnvalue">char</span> *        shell_app_get_id                    (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>);</pre>
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 <a href="/home/florian/opt/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> if backed by a window. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
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 <a href="/home/florian/opt/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> if backed by a window. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
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 <a href="/home/florian/opt/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> if no icon. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
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><span class="type">MetaWindow</span> *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 <a href="/home/florian/opt/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>,
272
 
the window with the most recent user time for the app
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
124
</div>
301
125
<hr>
302
126
<div class="refsect2">
323
147
<a name="shell-app-activate-full"></a><h3>shell_app_activate_full ()</h3>
324
148
<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
149
                                                         <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>
 
150
                                                         <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
151
<p>
328
152
Perform an appropriate default action for operating on this application,
329
153
dependent on its current state.  For example, if the application is not
356
180
</div>
357
181
<hr>
358
182
<div class="refsect2">
359
 
<a name="shell-app-open-new-window"></a><h3>shell_app_open_new_window ()</h3>
360
 
<pre class="programlisting"><span class="returnvalue">void</span>                shell_app_open_new_window           (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>,
361
 
                                                         <em class="parameter"><code><span class="type">int</span> workspace</code></em>);</pre>
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>
 
183
<a name="shell-app-activate-window"></a><h3>shell_app_activate_window ()</h3>
 
184
<pre class="programlisting"><span class="returnvalue">void</span>                shell_app_activate_window           (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>,
 
185
                                                         <em class="parameter"><code><span class="type">MetaWindow</span> *window</code></em>,
 
186
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> timestamp</code></em>);</pre>
 
187
<p>
 
188
Bring all windows for the given app to the foreground,
 
189
but ensure that <em class="parameter"><code>window</code></em> is on top.  If <em class="parameter"><code>window</code></em> is <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>,
 
190
the window with the most recent user time for the app
 
191
will be used.
 
192
</p>
 
193
<p>
 
194
This function has no effect if <em class="parameter"><code>app</code></em> is not currently running.
 
195
</p>
 
196
<div class="variablelist"><table border="0" class="variablelist">
 
197
<colgroup>
 
198
<col align="left" valign="top">
 
199
<col>
 
200
</colgroup>
 
201
<tbody>
 
202
<tr>
 
203
<td><p><span class="term"><em class="parameter"><code>app</code></em> :</span></p></td>
 
204
<td>a <span class="type">ShellApp</span>
 
205
</td>
 
206
</tr>
 
207
<tr>
 
208
<td><p><span class="term"><em class="parameter"><code>window</code></em> :</span></p></td>
 
209
<td>Window to be focused. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 
210
</td>
 
211
</tr>
 
212
<tr>
 
213
<td><p><span class="term"><em class="parameter"><code>timestamp</code></em> :</span></p></td>
 
214
<td>Event timestamp</td>
 
215
</tr>
 
216
</tbody>
 
217
</table></div>
 
218
</div>
 
219
<hr>
 
220
<div class="refsect2">
 
221
<a name="shell-app-compare"></a><h3>shell_app_compare ()</h3>
 
222
<pre class="programlisting"><span class="returnvalue">int</span>                 shell_app_compare                   (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>,
 
223
                                                         <em class="parameter"><code><span class="type">ShellApp</span> *other</code></em>);</pre>
 
224
<p>
 
225
Compare one <span class="type">ShellApp</span> instance to another, in the following way:
 
226
  - Running applications sort before not-running applications.
 
227
  - If one of them has visible windows and the other does not, the one
 
228
    with visible windows is first.
 
229
  - Finally, the application which the user interacted with most recently
 
230
    compares earlier.
 
231
</p>
 
232
<div class="variablelist"><table border="0" class="variablelist">
 
233
<colgroup>
 
234
<col align="left" valign="top">
 
235
<col>
 
236
</colgroup>
 
237
<tbody><tr>
 
238
<td><p><span class="term"><em class="parameter"><code>other</code></em> :</span></p></td>
 
239
<td>A <span class="type">ShellApp</span>
 
240
</td>
 
241
</tr></tbody>
 
242
</table></div>
 
243
</div>
 
244
<hr>
 
245
<div class="refsect2">
 
246
<a name="shell-app-compare-by-name"></a><h3>shell_app_compare_by_name ()</h3>
 
247
<pre class="programlisting"><span class="returnvalue">int</span>                 shell_app_compare_by_name           (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>,
 
248
                                                         <em class="parameter"><code><span class="type">ShellApp</span> *other</code></em>);</pre>
 
249
<p>
 
250
Order two applications by name.
 
251
</p>
 
252
<div class="variablelist"><table border="0" class="variablelist">
 
253
<colgroup>
 
254
<col align="left" valign="top">
 
255
<col>
 
256
</colgroup>
 
257
<tbody>
 
258
<tr>
 
259
<td><p><span class="term"><em class="parameter"><code>app</code></em> :</span></p></td>
 
260
<td>One app</td>
 
261
</tr>
 
262
<tr>
 
263
<td><p><span class="term"><em class="parameter"><code>other</code></em> :</span></p></td>
 
264
<td>The other app</td>
 
265
</tr>
 
266
<tr>
 
267
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
268
<td>-1, 0, or 1; suitable for use as a comparison function
 
269
for e.g. <a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#g-slist-sort"><code class="function">g_slist_sort()</code></a>
 
270
</td>
 
271
</tr>
 
272
</tbody>
 
273
</table></div>
 
274
</div>
 
275
<hr>
 
276
<div class="refsect2">
 
277
<a name="shell-app-create-icon-texture"></a><h3>shell_app_create_icon_texture ()</h3>
 
278
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/clutter/ClutterActor.html"><span class="returnvalue">ClutterActor</span></a> *      shell_app_create_icon_texture       (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>,
 
279
                                                         <em class="parameter"><code><span class="type">int</span> size</code></em>);</pre>
 
280
<p>
 
281
Look up the icon for this application, and create a <a href="/usr/share/gtk-doc/html/clutter/ClutterTexture.html"><span class="type">ClutterTexture</span></a>
 
282
for it at the given size.
 
283
</p>
 
284
<div class="variablelist"><table border="0" class="variablelist">
 
285
<colgroup>
 
286
<col align="left" valign="top">
 
287
<col>
 
288
</colgroup>
 
289
<tbody><tr>
 
290
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
291
<td>A floating <a href="/usr/share/gtk-doc/html/clutter/ClutterActor.html"><span class="type">ClutterActor</span></a>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 
292
</td>
 
293
</tr></tbody>
 
294
</table></div>
 
295
</div>
 
296
<hr>
 
297
<div class="refsect2">
 
298
<a name="shell-app-get-app-info"></a><h3>shell_app_get_app_info ()</h3>
 
299
<pre class="programlisting"><a href="http://library.gnome.org/devel/gio/unstable/gio-Desktop-file-based-GAppInfo.html#GDesktopAppInfo"><span class="returnvalue">GDesktopAppInfo</span></a> *   shell_app_get_app_info              (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>);</pre>
 
300
<div class="variablelist"><table border="0" class="variablelist">
 
301
<colgroup>
 
302
<col align="left" valign="top">
 
303
<col>
 
304
</colgroup>
 
305
<tbody>
 
306
<tr>
 
307
<td><p><span class="term"><em class="parameter"><code>app</code></em> :</span></p></td>
 
308
<td>a <span class="type">ShellApp</span>
 
309
</td>
 
310
</tr>
 
311
<tr>
 
312
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
313
<td>The <a href="http://library.gnome.org/devel/gio/unstable/gio-Desktop-file-based-GAppInfo.html#GDesktopAppInfo"><span class="type">GDesktopAppInfo</span></a> for this app, or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> if backed by a window. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 
314
</td>
 
315
</tr>
 
316
</tbody>
 
317
</table></div>
 
318
</div>
 
319
<hr>
 
320
<div class="refsect2">
 
321
<a name="shell-app-get-description"></a><h3>shell_app_get_description ()</h3>
 
322
<pre class="programlisting">const <span class="returnvalue">char</span> *        shell_app_get_description           (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>);</pre>
 
323
</div>
 
324
<hr>
 
325
<div class="refsect2">
 
326
<a name="shell-app-get-faded-icon"></a><h3>shell_app_get_faded_icon ()</h3>
 
327
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/clutter/ClutterActor.html"><span class="returnvalue">ClutterActor</span></a> *      shell_app_get_faded_icon            (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>,
 
328
                                                         <em class="parameter"><code><span class="type">int</span> size</code></em>);</pre>
 
329
<p>
 
330
Return an actor with a horizontally faded look.
 
331
</p>
 
332
<div class="variablelist"><table border="0" class="variablelist">
 
333
<colgroup>
 
334
<col align="left" valign="top">
 
335
<col>
 
336
</colgroup>
 
337
<tbody>
 
338
<tr>
 
339
<td><p><span class="term"><em class="parameter"><code>app</code></em> :</span></p></td>
 
340
<td>A <span class="type">ShellApp</span>
 
341
</td>
 
342
</tr>
 
343
<tr>
 
344
<td><p><span class="term"><em class="parameter"><code>size</code></em> :</span></p></td>
 
345
<td>Size in pixels</td>
 
346
</tr>
 
347
<tr>
 
348
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
349
<td>A floating <a href="/usr/share/gtk-doc/html/clutter/ClutterActor.html"><span class="type">ClutterActor</span></a>, or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> if no icon. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 
350
</td>
 
351
</tr>
 
352
</tbody>
 
353
</table></div>
 
354
</div>
 
355
<hr>
 
356
<div class="refsect2">
 
357
<a name="shell-app-get-id"></a><h3>shell_app_get_id ()</h3>
 
358
<pre class="programlisting">const <span class="returnvalue">char</span> *        shell_app_get_id                    (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>);</pre>
 
359
</div>
 
360
<hr>
 
361
<div class="refsect2">
 
362
<a name="shell-app-get-n-windows"></a><h3>shell_app_get_n_windows ()</h3>
 
363
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               shell_app_get_n_windows             (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>);</pre>
 
364
</div>
 
365
<hr>
 
366
<div class="refsect2">
 
367
<a name="shell-app-get-name"></a><h3>shell_app_get_name ()</h3>
 
368
<pre class="programlisting">const <span class="returnvalue">char</span> *        shell_app_get_name                  (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>);</pre>
 
369
</div>
 
370
<hr>
 
371
<div class="refsect2">
 
372
<a name="shell-app-get-pids"></a><h3>shell_app_get_pids ()</h3>
 
373
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> *            shell_app_get_pids                  (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>);</pre>
 
374
<div class="variablelist"><table border="0" class="variablelist">
 
375
<colgroup>
 
376
<col align="left" valign="top">
 
377
<col>
 
378
</colgroup>
 
379
<tbody>
 
380
<tr>
 
381
<td><p><span class="term"><em class="parameter"><code>app</code></em> :</span></p></td>
 
382
<td>a <span class="type">ShellApp</span>
 
383
</td>
 
384
</tr>
 
385
<tr>
 
386
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
387
<td>An unordered list of process identifers associated with this application. <span class="annotation">[<acronym title="Free data container after the code is done."><span class="acronym">transfer container</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> int]</span>
 
388
</td>
379
389
</tr>
380
390
</tbody>
381
391
</table></div>
404
414
</div>
405
415
<hr>
406
416
<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>
 
417
<a name="shell-app-get-tree-entry"></a><h3>shell_app_get_tree_entry ()</h3>
 
418
<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
419
<div class="variablelist"><table border="0" class="variablelist">
418
420
<colgroup>
419
421
<col align="left" valign="top">
422
424
<tbody>
423
425
<tr>
424
426
<td><p><span class="term"><em class="parameter"><code>app</code></em> :</span></p></td>
425
 
<td>A <span class="type">ShellApp</span>
 
427
<td>a <span class="type">ShellApp</span>
426
428
</td>
427
429
</tr>
428
430
<tr>
429
431
<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>
 
432
<td>The <span class="type">GMenuTreeEntry</span> for this app, or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> if backed by a window. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 
433
</td>
432
434
</tr>
433
435
</tbody>
434
436
</table></div>
435
437
</div>
436
438
<hr>
437
439
<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
440
<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>
 
441
<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
442
<p>
446
443
Get the toplevel, interesting windows which are associated with this
447
444
application.  The returned list will be sorted first by whether
462
459
</div>
463
460
<hr>
464
461
<div class="refsect2">
465
 
<a name="shell-app-get-pids"></a><h3>shell_app_get_pids ()</h3>
466
 
<pre class="programlisting"><span class="returnvalue">GSList</span> *            shell_app_get_pids                  (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>);</pre>
467
 
<div class="variablelist"><table border="0" class="variablelist">
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
462
<a name="shell-app-is-on-workspace"></a><h3>shell_app_is_on_workspace ()</h3>
489
 
<pre class="programlisting"><span class="returnvalue">gboolean</span>            shell_app_is_on_workspace           (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>,
 
463
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            shell_app_is_on_workspace           (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>,
490
464
                                                         <em class="parameter"><code><span class="type">MetaWorkspace</span> *workspace</code></em>);</pre>
491
465
</div>
492
466
<hr>
493
467
<div class="refsect2">
 
468
<a name="shell-app-is-window-backed"></a><h3>shell_app_is_window_backed ()</h3>
 
469
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            shell_app_is_window_backed          (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>);</pre>
 
470
<p>
 
471
A window backed application is one which represents just an open
 
472
window, i.e. there's no .desktop file assocation, so we don't know
 
473
how to launch it again.
 
474
</p>
 
475
</div>
 
476
<hr>
 
477
<div class="refsect2">
494
478
<a name="shell-app-launch"></a><h3>shell_app_launch ()</h3>
495
 
<pre class="programlisting"><span class="returnvalue">gboolean</span>            shell_app_launch                    (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>,
496
 
                                                         <em class="parameter"><code><span class="type">guint</span> timestamp</code></em>,
497
 
                                                         <em class="parameter"><code><span class="type">GList</span> *uris</code></em>,
 
479
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            shell_app_launch                    (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>,
 
480
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> timestamp</code></em>,
 
481
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> *uris</code></em>,
498
482
                                                         <em class="parameter"><code><span class="type">int</span> workspace</code></em>,
499
483
                                                         <em class="parameter"><code><span class="type">char</span> **startup_id</code></em>,
500
 
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
 
484
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
501
485
<div class="variablelist"><table border="0" class="variablelist">
502
486
<colgroup>
503
487
<col align="left" valign="top">
519
503
</tr>
520
504
<tr>
521
505
<td><p><span class="term"><em class="parameter"><code>startup_id</code></em> :</span></p></td>
522
 
<td>Returned startup notification ID, or <a href="/home/florian/opt/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> if none. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
 
506
<td>Returned startup notification ID, or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> if none. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
523
507
</td>
524
508
</tr>
525
509
<tr>
526
510
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
527
 
<td>A <span class="type">GError</span>
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>
 
511
<td>A <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>
 
512
</td>
 
513
</tr>
 
514
</tbody>
 
515
</table></div>
 
516
</div>
 
517
<hr>
 
518
<div class="refsect2">
 
519
<a name="shell-app-open-new-window"></a><h3>shell_app_open_new_window ()</h3>
 
520
<pre class="programlisting"><span class="returnvalue">void</span>                shell_app_open_new_window           (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>,
 
521
                                                         <em class="parameter"><code><span class="type">int</span> workspace</code></em>);</pre>
 
522
<p>
 
523
Request that the application create a new window.
 
524
</p>
 
525
<div class="variablelist"><table border="0" class="variablelist">
 
526
<colgroup>
 
527
<col align="left" valign="top">
 
528
<col>
 
529
</colgroup>
 
530
<tbody>
 
531
<tr>
 
532
<td><p><span class="term"><em class="parameter"><code>app</code></em> :</span></p></td>
 
533
<td>a <span class="type">ShellApp</span>
 
534
</td>
 
535
</tr>
 
536
<tr>
 
537
<td><p><span class="term"><em class="parameter"><code>workspace</code></em> :</span></p></td>
 
538
<td>open on this workspace, or -1 for default</td>
 
539
</tr>
 
540
</tbody>
 
541
</table></div>
 
542
</div>
 
543
<hr>
 
544
<div class="refsect2">
 
545
<a name="shell-app-request-quit"></a><h3>shell_app_request_quit ()</h3>
 
546
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            shell_app_request_quit              (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>);</pre>
 
547
<p>
 
548
Initiate an asynchronous request to quit this application.
 
549
The application may interact with the user, and the user
 
550
might cancel the quit request from the application UI.
 
551
</p>
 
552
<p>
 
553
This operation may not be supported for all applications.
 
554
</p>
 
555
<div class="variablelist"><table border="0" class="variablelist">
 
556
<colgroup>
 
557
<col align="left" valign="top">
 
558
<col>
 
559
</colgroup>
 
560
<tbody>
 
561
<tr>
 
562
<td><p><span class="term"><em class="parameter"><code>app</code></em> :</span></p></td>
 
563
<td>A <span class="type">ShellApp</span>
 
564
</td>
554
565
</tr>
555
566
<tr>
556
567
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
557
 
<td>-1, 0, or 1; suitable for use as a comparison function
558
 
for e.g. <code class="function">g_slist_sort()</code>
559
 
</td>
 
568
<td>
 
569
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if a quit request is supported for this application</td>
560
570
</tr>
561
571
</tbody>
562
572
</table></div>
563
573
</div>
564
574
<hr>
565
575
<div class="refsect2">
566
 
<a name="shell-app-compare"></a><h3>shell_app_compare ()</h3>
567
 
<pre class="programlisting"><span class="returnvalue">int</span>                 shell_app_compare                   (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>,
568
 
                                                         <em class="parameter"><code><span class="type">ShellApp</span> *other</code></em>);</pre>
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>
 
576
<a name="shell-app-update-app-menu"></a><h3>shell_app_update_app_menu ()</h3>
 
577
<pre class="programlisting"><span class="returnvalue">void</span>                shell_app_update_app_menu           (<em class="parameter"><code><span class="type">ShellApp</span> *app</code></em>,
 
578
                                                         <em class="parameter"><code><span class="type">MetaWindow</span> *window</code></em>);</pre>
588
579
</div>
589
580
<hr>
590
581
<div class="refsect2">
592
583
<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
584
                                                         <em class="parameter"><code><span class="type">MetaWindow</span> *window</code></em>);</pre>
594
585
</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><span class="type">MetaWindow</span> *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
586
</div>
607
587
</div>
608
588
<div class="footer">
609
589
<hr>
610
 
          Generated by GTK-Doc V1.18.1</div>
 
590
          Generated by GTK-Doc V1.18</div>
611
591
</body>
612
592
</html>
 
 
b'\\ No newline at end of file'