← 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-ShellGlobal.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-ShellGlobal.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>ShellGlobal</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="ch06.html" title="Integration helpers and utilities">
 
9
<link rel="prev" href="ch06.html" title="Integration helpers and utilities">
 
10
<link rel="next" href="shell-ShellWM.html" title="ShellWM">
 
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="ch06.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
18
<td><a accesskey="u" href="ch06.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-ShellWM.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-ShellGlobal.synopsis" class="shortcut">Top</a>
 
25
                   | 
 
26
                  <a href="#shell-ShellGlobal.description" class="shortcut">Description</a>
 
27
                   | 
 
28
                  <a href="#shell-ShellGlobal.object-hierarchy" class="shortcut">Object Hierarchy</a>
 
29
</td></tr>
 
30
</table>
 
31
<div class="refentry">
 
32
<a name="shell-ShellGlobal"></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-ShellGlobal.top_of_page"></a>ShellGlobal</span></h2>
 
36
<p>ShellGlobal</p>
 
37
</td>
 
38
<td valign="top" align="right"></td>
 
39
</tr></table></div>
 
40
<div class="refsynopsisdiv">
 
41
<a name="shell-ShellGlobal.synopsis"></a><h2>Synopsis</h2>
 
42
<a name="ShellCursor"></a><a name="ShellSessionType"></a><a name="ShellStageInputMode"></a><pre class="synopsis">enum                <a class="link" href="shell-ShellGlobal.html#ShellCursor-enum" title="enum ShellCursor">ShellCursor</a>;
 
43
struct              <a class="link" href="shell-ShellGlobal.html#ShellGlobalClass" title="struct ShellGlobalClass">ShellGlobalClass</a>;
 
44
<span class="returnvalue">void</span>                (<a class="link" href="shell-ShellGlobal.html#ShellLeisureFunction" title="ShellLeisureFunction ()">*ShellLeisureFunction</a>)             (<em class="parameter"><code><span class="type">gpointer</span> data</code></em>);
 
45
                    <a class="link" href="shell-ShellGlobal.html#ShellMemoryInfo" title="ShellMemoryInfo">ShellMemoryInfo</a>;
 
46
enum                <a class="link" href="shell-ShellGlobal.html#ShellSessionType-enum" title="enum ShellSessionType">ShellSessionType</a>;
 
47
enum                <a class="link" href="shell-ShellGlobal.html#ShellStageInputMode-enum" title="enum ShellStageInputMode">ShellStageInputMode</a>;
 
48
<span class="returnvalue">gboolean</span>            <a class="link" href="shell-ShellGlobal.html#shell-global-begin-modal" title="shell_global_begin_modal ()">shell_global_begin_modal</a>            (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>,
 
49
                                                         <em class="parameter"><code><span class="type">guint32</span> timestamp</code></em>,
 
50
                                                         <em class="parameter"><code><span class="type">MetaModalOptions</span> options</code></em>);
 
51
<span class="returnvalue">void</span>                <a class="link" href="shell-ShellGlobal.html#shell-global-begin-work" title="shell_global_begin_work ()">shell_global_begin_work</a>             (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>);
 
52
<span class="returnvalue">void</span>                <a class="link" href="shell-ShellGlobal.html#shell-global-cancel-theme-sound" title="shell_global_cancel_theme_sound ()">shell_global_cancel_theme_sound</a>     (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>,
 
53
                                                         <em class="parameter"><code><span class="type">guint</span> id</code></em>);
 
54
<span class="returnvalue">GAppLaunchContext</span> * <a class="link" href="shell-ShellGlobal.html#shell-global-create-app-launch-context" title="shell_global_create_app_launch_context ()">shell_global_create_app_launch_context</a>
 
55
                                                        (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>);
 
56
<span class="returnvalue">guint32</span>             <a class="link" href="shell-ShellGlobal.html#shell-global-create-pointer-barrier" title="shell_global_create_pointer_barrier ()">shell_global_create_pointer_barrier</a> (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>,
 
57
                                                         <em class="parameter"><code><span class="type">int</span> x1</code></em>,
 
58
                                                         <em class="parameter"><code><span class="type">int</span> y1</code></em>,
 
59
                                                         <em class="parameter"><code><span class="type">int</span> x2</code></em>,
 
60
                                                         <em class="parameter"><code><span class="type">int</span> y2</code></em>,
 
61
                                                         <em class="parameter"><code><span class="type">int</span> directions</code></em>);
 
62
<span class="returnvalue">void</span>                <a class="link" href="shell-ShellGlobal.html#shell-global-destroy-pointer-barrier" title="shell_global_destroy_pointer_barrier ()">shell_global_destroy_pointer_barrier</a>
 
63
                                                        (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>,
 
64
                                                         <em class="parameter"><code><span class="type">guint32</span> barrier</code></em>);
 
65
<span class="returnvalue">void</span>                <a class="link" href="shell-ShellGlobal.html#shell-global-end-modal" title="shell_global_end_modal ()">shell_global_end_modal</a>              (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>,
 
66
                                                         <em class="parameter"><code><span class="type">guint32</span> timestamp</code></em>);
 
67
<span class="returnvalue">void</span>                <a class="link" href="shell-ShellGlobal.html#shell-global-end-work" title="shell_global_end_work ()">shell_global_end_work</a>               (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>);
 
68
<span class="returnvalue">void</span>                <a class="link" href="shell-ShellGlobal.html#shell-global-gc" title="shell_global_gc ()">shell_global_gc</a>                     (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>);
 
69
<span class="returnvalue">ShellGlobal</span> *       <a class="link" href="shell-ShellGlobal.html#shell-global-get" title="shell_global_get ()">shell_global_get</a>                    (<em class="parameter"><code><span class="type">void</span></code></em>);
 
70
<span class="returnvalue">guint32</span>             <a class="link" href="shell-ShellGlobal.html#shell-global-get-current-time" title="shell_global_get_current_time ()">shell_global_get_current_time</a>       (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>);
 
71
<span class="returnvalue">MetaDisplay</span> *       <a class="link" href="shell-ShellGlobal.html#shell-global-get-display" title="shell_global_get_display ()">shell_global_get_display</a>            (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>);
 
72
<span class="returnvalue">GdkScreen</span> *         <a class="link" href="shell-ShellGlobal.html#shell-global-get-gdk-screen" title="shell_global_get_gdk_screen ()">shell_global_get_gdk_screen</a>         (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>);
 
73
<span class="returnvalue">void</span>                <a class="link" href="shell-ShellGlobal.html#shell-global-get-memory-info" title="shell_global_get_memory_info ()">shell_global_get_memory_info</a>        (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>,
 
74
                                                         <em class="parameter"><code><a class="link" href="shell-ShellGlobal.html#ShellMemoryInfo" title="ShellMemoryInfo"><span class="type">ShellMemoryInfo</span></a> *meminfo</code></em>);
 
75
<span class="returnvalue">void</span>                <a class="link" href="shell-ShellGlobal.html#shell-global-get-pointer" title="shell_global_get_pointer ()">shell_global_get_pointer</a>            (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>,
 
76
                                                         <em class="parameter"><code><span class="type">int</span> *x</code></em>,
 
77
                                                         <em class="parameter"><code><span class="type">int</span> *y</code></em>,
 
78
                                                         <em class="parameter"><code><span class="type">ClutterModifierType</span> *mods</code></em>);
 
79
<span class="returnvalue">MetaScreen</span> *        <a class="link" href="shell-ShellGlobal.html#shell-global-get-screen" title="shell_global_get_screen ()">shell_global_get_screen</a>             (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>);
 
80
<a class="link" href="shell-ShellGlobal.html#ShellSessionType"><span class="returnvalue">ShellSessionType</span></a>    <a class="link" href="shell-ShellGlobal.html#shell-global-get-session-type" title="shell_global_get_session_type ()">shell_global_get_session_type</a>       (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>);
 
81
<span class="returnvalue">GSettings</span> *         <a class="link" href="shell-ShellGlobal.html#shell-global-get-settings" title="shell_global_get_settings ()">shell_global_get_settings</a>           (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>);
 
82
<span class="returnvalue">ClutterStage</span> *      <a class="link" href="shell-ShellGlobal.html#shell-global-get-stage" title="shell_global_get_stage ()">shell_global_get_stage</a>              (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>);
 
83
<span class="returnvalue">GList</span> *             <a class="link" href="shell-ShellGlobal.html#shell-global-get-window-actors" title="shell_global_get_window_actors ()">shell_global_get_window_actors</a>      (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>);
 
84
<span class="returnvalue">void</span>                <a class="link" href="shell-ShellGlobal.html#shell-global-init-xdnd" title="shell_global_init_xdnd ()">shell_global_init_xdnd</a>              (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>);
 
85
<span class="returnvalue">void</span>                <a class="link" href="shell-ShellGlobal.html#shell-global-launch-calendar-server" title="shell_global_launch_calendar_server ()">shell_global_launch_calendar_server</a> (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>);
 
86
<span class="returnvalue">void</span>                <a class="link" href="shell-ShellGlobal.html#shell-global-maybe-gc" title="shell_global_maybe_gc ()">shell_global_maybe_gc</a>               (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>);
 
87
<span class="returnvalue">void</span>                <a class="link" href="shell-ShellGlobal.html#shell-global-notify-error" title="shell_global_notify_error ()">shell_global_notify_error</a>           (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>,
 
88
                                                         <em class="parameter"><code>const <span class="type">char</span> *msg</code></em>,
 
89
                                                         <em class="parameter"><code>const <span class="type">char</span> *details</code></em>);
 
90
<span class="returnvalue">void</span>                <a class="link" href="shell-ShellGlobal.html#shell-global-play-theme-sound" title="shell_global_play_theme_sound ()">shell_global_play_theme_sound</a>       (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>,
 
91
                                                         <em class="parameter"><code><span class="type">guint</span> id</code></em>,
 
92
                                                         <em class="parameter"><code>const <span class="type">char</span> *name</code></em>);
 
93
<span class="returnvalue">void</span>                <a class="link" href="shell-ShellGlobal.html#shell-global-reexec-self" title="shell_global_reexec_self ()">shell_global_reexec_self</a>            (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>);
 
94
<span class="returnvalue">void</span>                <a class="link" href="shell-ShellGlobal.html#shell-global-run-at-leisure" title="shell_global_run_at_leisure ()">shell_global_run_at_leisure</a>         (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>,
 
95
                                                         <em class="parameter"><code><a class="link" href="shell-ShellGlobal.html#ShellLeisureFunction" title="ShellLeisureFunction ()"><span class="type">ShellLeisureFunction</span></a> func</code></em>,
 
96
                                                         <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>,
 
97
                                                         <em class="parameter"><code><span class="type">GDestroyNotify</span> notify</code></em>);
 
98
<span class="returnvalue">void</span>                <a class="link" href="shell-ShellGlobal.html#shell-global-set-cursor" title="shell_global_set_cursor ()">shell_global_set_cursor</a>             (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>,
 
99
                                                         <em class="parameter"><code><a class="link" href="shell-ShellGlobal.html#ShellCursor"><span class="type">ShellCursor</span></a> type</code></em>);
 
100
<span class="returnvalue">void</span>                <a class="link" href="shell-ShellGlobal.html#shell-global-set-stage-input-mode" title="shell_global_set_stage_input_mode ()">shell_global_set_stage_input_mode</a>   (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>,
 
101
                                                         <em class="parameter"><code><a class="link" href="shell-ShellGlobal.html#ShellStageInputMode"><span class="type">ShellStageInputMode</span></a> mode</code></em>);
 
102
<span class="returnvalue">void</span>                <a class="link" href="shell-ShellGlobal.html#shell-global-set-stage-input-region" title="shell_global_set_stage_input_region ()">shell_global_set_stage_input_region</a> (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>,
 
103
                                                         <em class="parameter"><code><span class="type">GSList</span> *rectangles</code></em>);
 
104
<span class="returnvalue">void</span>                <a class="link" href="shell-ShellGlobal.html#shell-global-sync-pointer" title="shell_global_sync_pointer ()">shell_global_sync_pointer</a>           (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>);
 
105
<span class="returnvalue">void</span>                <a class="link" href="shell-ShellGlobal.html#shell-global-unset-cursor" title="shell_global_unset_cursor ()">shell_global_unset_cursor</a>           (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>);
 
106
</pre>
 
107
</div>
 
108
<div class="refsect1">
 
109
<a name="shell-ShellGlobal.object-hierarchy"></a><h2>Object Hierarchy</h2>
 
110
<pre class="synopsis">
 
111
  GEnum
 
112
   +----ShellCursor
 
113
</pre>
 
114
<pre class="synopsis">
 
115
  GEnum
 
116
   +----ShellSessionType
 
117
</pre>
 
118
<pre class="synopsis">
 
119
  GEnum
 
120
   +----ShellStageInputMode
 
121
</pre>
 
122
</div>
 
123
<div class="refsect1">
 
124
<a name="shell-ShellGlobal.description"></a><h2>Description</h2>
 
125
</div>
 
126
<div class="refsect1">
 
127
<a name="shell-ShellGlobal.details"></a><h2>Details</h2>
 
128
<div class="refsect2">
 
129
<a name="ShellCursor-enum"></a><h3>enum ShellCursor</h3>
 
130
<pre class="programlisting">typedef enum {
 
131
  SHELL_CURSOR_DND_IN_DRAG,
 
132
  SHELL_CURSOR_DND_UNSUPPORTED_TARGET,
 
133
  SHELL_CURSOR_DND_MOVE,
 
134
  SHELL_CURSOR_DND_COPY,
 
135
  SHELL_CURSOR_POINTING_HAND
 
136
} ShellCursor;
 
137
</pre>
 
138
</div>
 
139
<hr>
 
140
<div class="refsect2">
 
141
<a name="ShellGlobalClass"></a><h3>struct ShellGlobalClass</h3>
 
142
<pre class="programlisting">struct ShellGlobalClass {
 
143
  GObjectClass parent_class;
 
144
};
 
145
</pre>
 
146
</div>
 
147
<hr>
 
148
<div class="refsect2">
 
149
<a name="ShellLeisureFunction"></a><h3>ShellLeisureFunction ()</h3>
 
150
<pre class="programlisting"><span class="returnvalue">void</span>                (*ShellLeisureFunction)             (<em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre>
 
151
</div>
 
152
<hr>
 
153
<div class="refsect2">
 
154
<a name="ShellMemoryInfo"></a><h3>ShellMemoryInfo</h3>
 
155
<pre class="programlisting">typedef struct {
 
156
  guint glibc_uordblks;
 
157
 
 
158
  guint js_bytes;
 
159
 
 
160
  guint gjs_boxed;
 
161
  guint gjs_gobject;
 
162
  guint gjs_function;
 
163
  guint gjs_closure;
 
164
 
 
165
  /* 32 bit to avoid js conversion problems with 64 bit */
 
166
  guint  last_gc_seconds_ago;
 
167
} ShellMemoryInfo;
 
168
</pre>
 
169
</div>
 
170
<hr>
 
171
<div class="refsect2">
 
172
<a name="ShellSessionType-enum"></a><h3>enum ShellSessionType</h3>
 
173
<pre class="programlisting">typedef enum {
 
174
  SHELL_SESSION_USER,
 
175
  SHELL_SESSION_GDM
 
176
} ShellSessionType;
 
177
</pre>
 
178
</div>
 
179
<hr>
 
180
<div class="refsect2">
 
181
<a name="ShellStageInputMode-enum"></a><h3>enum ShellStageInputMode</h3>
 
182
<pre class="programlisting">typedef enum {
 
183
  SHELL_STAGE_INPUT_MODE_NONREACTIVE,
 
184
  SHELL_STAGE_INPUT_MODE_NORMAL,
 
185
  SHELL_STAGE_INPUT_MODE_FOCUSED,
 
186
  SHELL_STAGE_INPUT_MODE_FULLSCREEN
 
187
} ShellStageInputMode;
 
188
</pre>
 
189
</div>
 
190
<hr>
 
191
<div class="refsect2">
 
192
<a name="shell-global-begin-modal"></a><h3>shell_global_begin_modal ()</h3>
 
193
<pre class="programlisting"><span class="returnvalue">gboolean</span>            shell_global_begin_modal            (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>,
 
194
                                                         <em class="parameter"><code><span class="type">guint32</span> timestamp</code></em>,
 
195
                                                         <em class="parameter"><code><span class="type">MetaModalOptions</span> options</code></em>);</pre>
 
196
<p>
 
197
Grabs the keyboard and mouse to the stage window. The stage will
 
198
receive all keyboard and mouse events until <a class="link" href="shell-ShellGlobal.html#shell-global-end-modal" title="shell_global_end_modal ()"><code class="function">shell_global_end_modal()</code></a>
 
199
is called. This is used to implement "modes" for the shell, such as the
 
200
overview mode or the "looking glass" debug overlay, that block
 
201
application and normal key shortcuts.
 
202
</p>
 
203
<div class="variablelist"><table border="0">
 
204
<col align="left" valign="top">
 
205
<tbody>
 
206
<tr>
 
207
<td><p><span class="term"><em class="parameter"><code>global</code></em> :</span></p></td>
 
208
<td>a <span class="type">ShellGlobal</span>
 
209
</td>
 
210
</tr>
 
211
<tr>
 
212
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
213
<td>
 
214
<code class="literal">TRUE</code> if we succesfully entered the mode. <code class="literal">FALSE</code> if we couldn't
 
215
enter the mode. Failure may occur because an application has the pointer
 
216
or keyboard grabbed, because Mutter is in a mode itself like moving a
 
217
window or alt-Tab window selection, or because <a class="link" href="shell-ShellGlobal.html#shell-global-begin-modal" title="shell_global_begin_modal ()"><code class="function">shell_global_begin_modal()</code></a>
 
218
was previouly called.</td>
 
219
</tr>
 
220
</tbody>
 
221
</table></div>
 
222
</div>
 
223
<hr>
 
224
<div class="refsect2">
 
225
<a name="shell-global-begin-work"></a><h3>shell_global_begin_work ()</h3>
 
226
<pre class="programlisting"><span class="returnvalue">void</span>                shell_global_begin_work             (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>);</pre>
 
227
<p>
 
228
Marks that we are currently doing work. This is used to to track
 
229
whether we are busy for the purposes of <a class="link" href="shell-ShellGlobal.html#shell-global-run-at-leisure" title="shell_global_run_at_leisure ()"><code class="function">shell_global_run_at_leisure()</code></a>.
 
230
A count is kept and <a class="link" href="shell-ShellGlobal.html#shell-global-end-work" title="shell_global_end_work ()"><code class="function">shell_global_end_work()</code></a> must be called exactly
 
231
as many times as <a class="link" href="shell-ShellGlobal.html#shell-global-begin-work" title="shell_global_begin_work ()"><code class="function">shell_global_begin_work()</code></a>.
 
232
</p>
 
233
<div class="variablelist"><table border="0">
 
234
<col align="left" valign="top">
 
235
<tbody><tr>
 
236
<td><p><span class="term"><em class="parameter"><code>global</code></em> :</span></p></td>
 
237
<td>the <span class="type">ShellGlobal</span>
 
238
</td>
 
239
</tr></tbody>
 
240
</table></div>
 
241
</div>
 
242
<hr>
 
243
<div class="refsect2">
 
244
<a name="shell-global-cancel-theme-sound"></a><h3>shell_global_cancel_theme_sound ()</h3>
 
245
<pre class="programlisting"><span class="returnvalue">void</span>                shell_global_cancel_theme_sound     (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>,
 
246
                                                         <em class="parameter"><code><span class="type">guint</span> id</code></em>);</pre>
 
247
<p>
 
248
Cancels a sound notification.
 
249
</p>
 
250
<div class="variablelist"><table border="0">
 
251
<col align="left" valign="top">
 
252
<tbody>
 
253
<tr>
 
254
<td><p><span class="term"><em class="parameter"><code>global</code></em> :</span></p></td>
 
255
<td>the <span class="type">ShellGlobal</span>
 
256
</td>
 
257
</tr>
 
258
<tr>
 
259
<td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td>
 
260
<td>the id previously passed to <a class="link" href="shell-ShellGlobal.html#shell-global-play-theme-sound" title="shell_global_play_theme_sound ()"><code class="function">shell_global_play_theme_sound()</code></a>
 
261
</td>
 
262
</tr>
 
263
</tbody>
 
264
</table></div>
 
265
</div>
 
266
<hr>
 
267
<div class="refsect2">
 
268
<a name="shell-global-create-app-launch-context"></a><h3>shell_global_create_app_launch_context ()</h3>
 
269
<pre class="programlisting"><span class="returnvalue">GAppLaunchContext</span> * shell_global_create_app_launch_context
 
270
                                                        (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>);</pre>
 
271
<p>
 
272
Create a <span class="type">GAppLaunchContext</span> set up with the correct timestamp, and
 
273
targeted to activate on the current workspace.
 
274
</p>
 
275
<div class="variablelist"><table border="0">
 
276
<col align="left" valign="top">
 
277
<tbody>
 
278
<tr>
 
279
<td><p><span class="term"><em class="parameter"><code>global</code></em> :</span></p></td>
 
280
<td>A <span class="type">ShellGlobal</span>
 
281
</td>
 
282
</tr>
 
283
<tr>
 
284
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
285
<td>A new <span class="type">GAppLaunchContext</span>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
 
286
</td>
 
287
</tr>
 
288
</tbody>
 
289
</table></div>
 
290
</div>
 
291
<hr>
 
292
<div class="refsect2">
 
293
<a name="shell-global-create-pointer-barrier"></a><h3>shell_global_create_pointer_barrier ()</h3>
 
294
<pre class="programlisting"><span class="returnvalue">guint32</span>             shell_global_create_pointer_barrier (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>,
 
295
                                                         <em class="parameter"><code><span class="type">int</span> x1</code></em>,
 
296
                                                         <em class="parameter"><code><span class="type">int</span> y1</code></em>,
 
297
                                                         <em class="parameter"><code><span class="type">int</span> x2</code></em>,
 
298
                                                         <em class="parameter"><code><span class="type">int</span> y2</code></em>,
 
299
                                                         <em class="parameter"><code><span class="type">int</span> directions</code></em>);</pre>
 
300
<p>
 
301
If supported by X creates a pointer barrier.
 
302
</p>
 
303
<div class="variablelist"><table border="0">
 
304
<col align="left" valign="top">
 
305
<tbody>
 
306
<tr>
 
307
<td><p><span class="term"><em class="parameter"><code>global</code></em> :</span></p></td>
 
308
<td>a <span class="type">ShellGlobal</span>
 
309
</td>
 
310
</tr>
 
311
<tr>
 
312
<td><p><span class="term"><em class="parameter"><code>x1</code></em> :</span></p></td>
 
313
<td>left X coordinate</td>
 
314
</tr>
 
315
<tr>
 
316
<td><p><span class="term"><em class="parameter"><code>y1</code></em> :</span></p></td>
 
317
<td>top Y coordinate</td>
 
318
</tr>
 
319
<tr>
 
320
<td><p><span class="term"><em class="parameter"><code>x2</code></em> :</span></p></td>
 
321
<td>right X coordinate</td>
 
322
</tr>
 
323
<tr>
 
324
<td><p><span class="term"><em class="parameter"><code>y2</code></em> :</span></p></td>
 
325
<td>bottom Y coordinate</td>
 
326
</tr>
 
327
<tr>
 
328
<td><p><span class="term"><em class="parameter"><code>directions</code></em> :</span></p></td>
 
329
<td>The directions we're allowed to pass through</td>
 
330
</tr>
 
331
<tr>
 
332
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
333
<td>value you can pass to <a class="link" href="shell-ShellGlobal.html#shell-global-destroy-pointer-barrier" title="shell_global_destroy_pointer_barrier ()"><code class="function">shell_global_destroy_pointer_barrier()</code></a>
 
334
</td>
 
335
</tr>
 
336
</tbody>
 
337
</table></div>
 
338
</div>
 
339
<hr>
 
340
<div class="refsect2">
 
341
<a name="shell-global-destroy-pointer-barrier"></a><h3>shell_global_destroy_pointer_barrier ()</h3>
 
342
<pre class="programlisting"><span class="returnvalue">void</span>                shell_global_destroy_pointer_barrier
 
343
                                                        (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>,
 
344
                                                         <em class="parameter"><code><span class="type">guint32</span> barrier</code></em>);</pre>
 
345
<p>
 
346
Destroys the <em class="parameter"><code>barrier</code></em> created by <a class="link" href="shell-ShellGlobal.html#shell-global-create-pointer-barrier" title="shell_global_create_pointer_barrier ()"><code class="function">shell_global_create_pointer_barrier()</code></a>.
 
347
</p>
 
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>global</code></em> :</span></p></td>
 
353
<td>a <span class="type">ShellGlobal</span>
 
354
</td>
 
355
</tr>
 
356
<tr>
 
357
<td><p><span class="term"><em class="parameter"><code>barrier</code></em> :</span></p></td>
 
358
<td>a pointer barrier</td>
 
359
</tr>
 
360
</tbody>
 
361
</table></div>
 
362
</div>
 
363
<hr>
 
364
<div class="refsect2">
 
365
<a name="shell-global-end-modal"></a><h3>shell_global_end_modal ()</h3>
 
366
<pre class="programlisting"><span class="returnvalue">void</span>                shell_global_end_modal              (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>,
 
367
                                                         <em class="parameter"><code><span class="type">guint32</span> timestamp</code></em>);</pre>
 
368
<p>
 
369
Undoes the effect of <a class="link" href="shell-ShellGlobal.html#shell-global-begin-modal" title="shell_global_begin_modal ()"><code class="function">shell_global_begin_modal()</code></a>.
 
370
</p>
 
371
<div class="variablelist"><table border="0">
 
372
<col align="left" valign="top">
 
373
<tbody><tr>
 
374
<td><p><span class="term"><em class="parameter"><code>global</code></em> :</span></p></td>
 
375
<td>a <span class="type">ShellGlobal</span>
 
376
</td>
 
377
</tr></tbody>
 
378
</table></div>
 
379
</div>
 
380
<hr>
 
381
<div class="refsect2">
 
382
<a name="shell-global-end-work"></a><h3>shell_global_end_work ()</h3>
 
383
<pre class="programlisting"><span class="returnvalue">void</span>                shell_global_end_work               (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>);</pre>
 
384
<p>
 
385
Marks the end of work that we started with <a class="link" href="shell-ShellGlobal.html#shell-global-begin-work" title="shell_global_begin_work ()"><code class="function">shell_global_begin_work()</code></a>.
 
386
If no other work is ongoing and functions have been added with
 
387
<a class="link" href="shell-ShellGlobal.html#shell-global-run-at-leisure" title="shell_global_run_at_leisure ()"><code class="function">shell_global_run_at_leisure()</code></a>, they will be run at the next
 
388
opportunity.
 
389
</p>
 
390
<div class="variablelist"><table border="0">
 
391
<col align="left" valign="top">
 
392
<tbody><tr>
 
393
<td><p><span class="term"><em class="parameter"><code>global</code></em> :</span></p></td>
 
394
<td>the <span class="type">ShellGlobal</span>
 
395
</td>
 
396
</tr></tbody>
 
397
</table></div>
 
398
</div>
 
399
<hr>
 
400
<div class="refsect2">
 
401
<a name="shell-global-gc"></a><h3>shell_global_gc ()</h3>
 
402
<pre class="programlisting"><span class="returnvalue">void</span>                shell_global_gc                     (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>);</pre>
 
403
<p>
 
404
Start a garbage collection process.  For more information, see
 
405
https://developer.mozilla.org/En/JS_GC
 
406
</p>
 
407
<div class="variablelist"><table border="0">
 
408
<col align="left" valign="top">
 
409
<tbody><tr>
 
410
<td><p><span class="term"><em class="parameter"><code>global</code></em> :</span></p></td>
 
411
<td>A <span class="type">ShellGlobal</span>
 
412
</td>
 
413
</tr></tbody>
 
414
</table></div>
 
415
</div>
 
416
<hr>
 
417
<div class="refsect2">
 
418
<a name="shell-global-get"></a><h3>shell_global_get ()</h3>
 
419
<pre class="programlisting"><span class="returnvalue">ShellGlobal</span> *       shell_global_get                    (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 
420
<p>
 
421
Gets the singleton global object that represents the desktop.
 
422
</p>
 
423
<div class="variablelist"><table border="0">
 
424
<col align="left" valign="top">
 
425
<tbody><tr>
 
426
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
427
<td>the singleton global object. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 
428
</td>
 
429
</tr></tbody>
 
430
</table></div>
 
431
</div>
 
432
<hr>
 
433
<div class="refsect2">
 
434
<a name="shell-global-get-current-time"></a><h3>shell_global_get_current_time ()</h3>
 
435
<pre class="programlisting"><span class="returnvalue">guint32</span>             shell_global_get_current_time       (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>);</pre>
 
436
<div class="variablelist"><table border="0">
 
437
<col align="left" valign="top">
 
438
<tbody>
 
439
<tr>
 
440
<td><p><span class="term"><em class="parameter"><code>global</code></em> :</span></p></td>
 
441
<td>A <span class="type">ShellGlobal</span>
 
442
</td>
 
443
</tr>
 
444
<tr>
 
445
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
446
<td>the current X server time from the current Clutter, Gdk, or X
 
447
event. If called from outside an event handler, this may return
 
448
<code class="literal">Clutter</code>.CURRENT_TIME (aka 0), or it may return a slightly
 
449
out-of-date timestamp.</td>
 
450
</tr>
 
451
</tbody>
 
452
</table></div>
 
453
</div>
 
454
<hr>
 
455
<div class="refsect2">
 
456
<a name="shell-global-get-display"></a><h3>shell_global_get_display ()</h3>
 
457
<pre class="programlisting"><span class="returnvalue">MetaDisplay</span> *       shell_global_get_display            (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>);</pre>
 
458
<div class="variablelist"><table border="0">
 
459
<col align="left" valign="top">
 
460
<tbody><tr>
 
461
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
462
<td>The default <span class="type">MetaDisplay</span>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 
463
</td>
 
464
</tr></tbody>
 
465
</table></div>
 
466
</div>
 
467
<hr>
 
468
<div class="refsect2">
 
469
<a name="shell-global-get-gdk-screen"></a><h3>shell_global_get_gdk_screen ()</h3>
 
470
<pre class="programlisting"><span class="returnvalue">GdkScreen</span> *         shell_global_get_gdk_screen         (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>);</pre>
 
471
<div class="variablelist"><table border="0">
 
472
<col align="left" valign="top">
 
473
<tbody><tr>
 
474
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
475
<td>Gdk screen object for the shell. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 
476
</td>
 
477
</tr></tbody>
 
478
</table></div>
 
479
</div>
 
480
<hr>
 
481
<div class="refsect2">
 
482
<a name="shell-global-get-memory-info"></a><h3>shell_global_get_memory_info ()</h3>
 
483
<pre class="programlisting"><span class="returnvalue">void</span>                shell_global_get_memory_info        (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>,
 
484
                                                         <em class="parameter"><code><a class="link" href="shell-ShellGlobal.html#ShellMemoryInfo" title="ShellMemoryInfo"><span class="type">ShellMemoryInfo</span></a> *meminfo</code></em>);</pre>
 
485
<p>
 
486
Load process-global data about memory usage.
 
487
</p>
 
488
<div class="variablelist"><table border="0">
 
489
<col align="left" valign="top">
 
490
<tbody><tr>
 
491
<td><p><span class="term"><em class="parameter"><code>meminfo</code></em> :</span></p></td>
 
492
<td>Output location for memory information. <span class="annotation">[<acronym title="Out parameter, where caller must allocate storage."><span class="acronym">out caller-allocates</span></acronym>]</span>
 
493
</td>
 
494
</tr></tbody>
 
495
</table></div>
 
496
</div>
 
497
<hr>
 
498
<div class="refsect2">
 
499
<a name="shell-global-get-pointer"></a><h3>shell_global_get_pointer ()</h3>
 
500
<pre class="programlisting"><span class="returnvalue">void</span>                shell_global_get_pointer            (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>,
 
501
                                                         <em class="parameter"><code><span class="type">int</span> *x</code></em>,
 
502
                                                         <em class="parameter"><code><span class="type">int</span> *y</code></em>,
 
503
                                                         <em class="parameter"><code><span class="type">ClutterModifierType</span> *mods</code></em>);</pre>
 
504
<p>
 
505
Gets the pointer coordinates and current modifier key state.
 
506
This is a wrapper around <code class="function">gdk_display_get_pointer()</code> that strips
 
507
out any un-declared modifier flags, to make gjs happy; see
 
508
https://bugzilla.gnome.org/show_bug.cgi?id=597292.
 
509
</p>
 
510
<div class="variablelist"><table border="0">
 
511
<col align="left" valign="top">
 
512
<tbody>
 
513
<tr>
 
514
<td><p><span class="term"><em class="parameter"><code>global</code></em> :</span></p></td>
 
515
<td>the <span class="type">ShellGlobal</span>
 
516
</td>
 
517
</tr>
 
518
<tr>
 
519
<td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
 
520
<td>the X coordinate of the pointer, in global coordinates. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
 
521
</td>
 
522
</tr>
 
523
<tr>
 
524
<td><p><span class="term"><em class="parameter"><code>y</code></em> :</span></p></td>
 
525
<td>the Y coordinate of the pointer, in global coordinates. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
 
526
</td>
 
527
</tr>
 
528
<tr>
 
529
<td><p><span class="term"><em class="parameter"><code>mods</code></em> :</span></p></td>
 
530
<td>the current set of modifier keys that are pressed down. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
 
531
</td>
 
532
</tr>
 
533
</tbody>
 
534
</table></div>
 
535
</div>
 
536
<hr>
 
537
<div class="refsect2">
 
538
<a name="shell-global-get-screen"></a><h3>shell_global_get_screen ()</h3>
 
539
<pre class="programlisting"><span class="returnvalue">MetaScreen</span> *        shell_global_get_screen             (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>);</pre>
 
540
<div class="variablelist"><table border="0">
 
541
<col align="left" valign="top">
 
542
<tbody><tr>
 
543
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
544
<td>The default <span class="type">MetaScreen</span>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 
545
</td>
 
546
</tr></tbody>
 
547
</table></div>
 
548
</div>
 
549
<hr>
 
550
<div class="refsect2">
 
551
<a name="shell-global-get-session-type"></a><h3>shell_global_get_session_type ()</h3>
 
552
<pre class="programlisting"><a class="link" href="shell-ShellGlobal.html#ShellSessionType"><span class="returnvalue">ShellSessionType</span></a>    shell_global_get_session_type       (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>);</pre>
 
553
<p>
 
554
Gets the type of session gnome-shell provides.
 
555
</p>
 
556
<p>
 
557
The type determines what UI elements are displayed,
 
558
what keybindings work, and generally how the shell
 
559
behaves.
 
560
</p>
 
561
<p>
 
562
A session type of <span class="type">SHELL_SESSION_USER</span> means gnome-shell
 
563
will enable the activities overview, status menu, run dialog,
 
564
etc. This is the default.
 
565
</p>
 
566
<p>
 
567
A session type of <span class="type">SHELL_SESSION_GDM</span> means gnome-shell
 
568
will enable a login dialog and run in a more confined
 
569
way. This type is suitable for the display manager.
 
570
</p>
 
571
<div class="variablelist"><table border="0">
 
572
<col align="left" valign="top">
 
573
<tbody>
 
574
<tr>
 
575
<td><p><span class="term"><em class="parameter"><code>global</code></em> :</span></p></td>
 
576
<td>The <span class="type">ShellGlobal</span>.</td>
 
577
</tr>
 
578
<tr>
 
579
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
580
<td>the type of session gnome-shell is providing.</td>
 
581
</tr>
 
582
</tbody>
 
583
</table></div>
 
584
</div>
 
585
<hr>
 
586
<div class="refsect2">
 
587
<a name="shell-global-get-settings"></a><h3>shell_global_get_settings ()</h3>
 
588
<pre class="programlisting"><span class="returnvalue">GSettings</span> *         shell_global_get_settings           (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>);</pre>
 
589
<p>
 
590
Get the global GSettings instance.
 
591
</p>
 
592
<div class="variablelist"><table border="0">
 
593
<col align="left" valign="top">
 
594
<tbody>
 
595
<tr>
 
596
<td><p><span class="term"><em class="parameter"><code>global</code></em> :</span></p></td>
 
597
<td>A <span class="type">ShellGlobal</span>
 
598
</td>
 
599
</tr>
 
600
<tr>
 
601
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
602
<td>The GSettings object. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 
603
</td>
 
604
</tr>
 
605
</tbody>
 
606
</table></div>
 
607
</div>
 
608
<hr>
 
609
<div class="refsect2">
 
610
<a name="shell-global-get-stage"></a><h3>shell_global_get_stage ()</h3>
 
611
<pre class="programlisting"><span class="returnvalue">ClutterStage</span> *      shell_global_get_stage              (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>);</pre>
 
612
<div class="variablelist"><table border="0">
 
613
<col align="left" valign="top">
 
614
<tbody><tr>
 
615
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
616
<td>The default <span class="type">ClutterStage</span>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 
617
</td>
 
618
</tr></tbody>
 
619
</table></div>
 
620
</div>
 
621
<hr>
 
622
<div class="refsect2">
 
623
<a name="shell-global-get-window-actors"></a><h3>shell_global_get_window_actors ()</h3>
 
624
<pre class="programlisting"><span class="returnvalue">GList</span> *             shell_global_get_window_actors      (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>);</pre>
 
625
<p>
 
626
Gets the list of <span class="type">MetaWindowActor</span> for the plugin's screen
 
627
</p>
 
628
<div class="variablelist"><table border="0">
 
629
<col align="left" valign="top">
 
630
<tbody><tr>
 
631
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
632
<td>the list of windows. <span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> Meta.WindowActor][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 
633
</td>
 
634
</tr></tbody>
 
635
</table></div>
 
636
</div>
 
637
<hr>
 
638
<div class="refsect2">
 
639
<a name="shell-global-init-xdnd"></a><h3>shell_global_init_xdnd ()</h3>
 
640
<pre class="programlisting"><span class="returnvalue">void</span>                shell_global_init_xdnd              (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>);</pre>
 
641
<p>
 
642
Enables tracking of Xdnd events
 
643
</p>
 
644
<div class="variablelist"><table border="0">
 
645
<col align="left" valign="top">
 
646
<tbody><tr>
 
647
<td><p><span class="term"><em class="parameter"><code>global</code></em> :</span></p></td>
 
648
<td>the <span class="type">ShellGlobal</span>
 
649
</td>
 
650
</tr></tbody>
 
651
</table></div>
 
652
</div>
 
653
<hr>
 
654
<div class="refsect2">
 
655
<a name="shell-global-launch-calendar-server"></a><h3>shell_global_launch_calendar_server ()</h3>
 
656
<pre class="programlisting"><span class="returnvalue">void</span>                shell_global_launch_calendar_server (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>);</pre>
 
657
<p>
 
658
Launch the gnome-shell-calendar-server helper.
 
659
</p>
 
660
<div class="variablelist"><table border="0">
 
661
<col align="left" valign="top">
 
662
<tbody><tr>
 
663
<td><p><span class="term"><em class="parameter"><code>global</code></em> :</span></p></td>
 
664
<td>The <span class="type">ShellGlobal</span>.</td>
 
665
</tr></tbody>
 
666
</table></div>
 
667
</div>
 
668
<hr>
 
669
<div class="refsect2">
 
670
<a name="shell-global-maybe-gc"></a><h3>shell_global_maybe_gc ()</h3>
 
671
<pre class="programlisting"><span class="returnvalue">void</span>                shell_global_maybe_gc               (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>);</pre>
 
672
<p>
 
673
Start a garbage collection process when it would free up enough memory
 
674
to be worth the amount of time it would take
 
675
https://developer.mozilla.org/en/SpiderMonkey/JSAPI_Reference/JS_MaybeGC
 
676
</p>
 
677
<div class="variablelist"><table border="0">
 
678
<col align="left" valign="top">
 
679
<tbody><tr>
 
680
<td><p><span class="term"><em class="parameter"><code>global</code></em> :</span></p></td>
 
681
<td>A <span class="type">ShellGlobal</span>
 
682
</td>
 
683
</tr></tbody>
 
684
</table></div>
 
685
</div>
 
686
<hr>
 
687
<div class="refsect2">
 
688
<a name="shell-global-notify-error"></a><h3>shell_global_notify_error ()</h3>
 
689
<pre class="programlisting"><span class="returnvalue">void</span>                shell_global_notify_error           (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>,
 
690
                                                         <em class="parameter"><code>const <span class="type">char</span> *msg</code></em>,
 
691
                                                         <em class="parameter"><code>const <span class="type">char</span> *details</code></em>);</pre>
 
692
<p>
 
693
Show a system error notification.  Use this function
 
694
when a user-initiated action results in a non-fatal problem
 
695
from causes that may not be under system control.  For
 
696
example, an application crash.
 
697
</p>
 
698
<div class="variablelist"><table border="0">
 
699
<col align="left" valign="top">
 
700
<tbody>
 
701
<tr>
 
702
<td><p><span class="term"><em class="parameter"><code>global</code></em> :</span></p></td>
 
703
<td>a <span class="type">ShellGlobal</span>
 
704
</td>
 
705
</tr>
 
706
<tr>
 
707
<td><p><span class="term"><em class="parameter"><code>msg</code></em> :</span></p></td>
 
708
<td>Error message</td>
 
709
</tr>
 
710
<tr>
 
711
<td><p><span class="term"><em class="parameter"><code>details</code></em> :</span></p></td>
 
712
<td>Error details</td>
 
713
</tr>
 
714
</tbody>
 
715
</table></div>
 
716
</div>
 
717
<hr>
 
718
<div class="refsect2">
 
719
<a name="shell-global-play-theme-sound"></a><h3>shell_global_play_theme_sound ()</h3>
 
720
<pre class="programlisting"><span class="returnvalue">void</span>                shell_global_play_theme_sound       (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>,
 
721
                                                         <em class="parameter"><code><span class="type">guint</span> id</code></em>,
 
722
                                                         <em class="parameter"><code>const <span class="type">char</span> *name</code></em>);</pre>
 
723
<p>
 
724
Plays a simple sound picked according to Freedesktop sound theme.
 
725
Really just a workaround for libcanberra not being introspected.
 
726
</p>
 
727
<div class="variablelist"><table border="0">
 
728
<col align="left" valign="top">
 
729
<tbody>
 
730
<tr>
 
731
<td><p><span class="term"><em class="parameter"><code>global</code></em> :</span></p></td>
 
732
<td>the <span class="type">ShellGlobal</span>
 
733
</td>
 
734
</tr>
 
735
<tr>
 
736
<td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td>
 
737
<td>an id, used to cancel later (0 if not needed)</td>
 
738
</tr>
 
739
<tr>
 
740
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
 
741
<td>the sound name</td>
 
742
</tr>
 
743
</tbody>
 
744
</table></div>
 
745
</div>
 
746
<hr>
 
747
<div class="refsect2">
 
748
<a name="shell-global-reexec-self"></a><h3>shell_global_reexec_self ()</h3>
 
749
<pre class="programlisting"><span class="returnvalue">void</span>                shell_global_reexec_self            (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>);</pre>
 
750
<p>
 
751
Restart the current process.  Only intended for development purposes.
 
752
</p>
 
753
<div class="variablelist"><table border="0">
 
754
<col align="left" valign="top">
 
755
<tbody><tr>
 
756
<td><p><span class="term"><em class="parameter"><code>global</code></em> :</span></p></td>
 
757
<td>A <span class="type">ShellGlobal</span>
 
758
</td>
 
759
</tr></tbody>
 
760
</table></div>
 
761
</div>
 
762
<hr>
 
763
<div class="refsect2">
 
764
<a name="shell-global-run-at-leisure"></a><h3>shell_global_run_at_leisure ()</h3>
 
765
<pre class="programlisting"><span class="returnvalue">void</span>                shell_global_run_at_leisure         (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>,
 
766
                                                         <em class="parameter"><code><a class="link" href="shell-ShellGlobal.html#ShellLeisureFunction" title="ShellLeisureFunction ()"><span class="type">ShellLeisureFunction</span></a> func</code></em>,
 
767
                                                         <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>,
 
768
                                                         <em class="parameter"><code><span class="type">GDestroyNotify</span> notify</code></em>);</pre>
 
769
<p>
 
770
Schedules a function to be called the next time the shell is idle.
 
771
Idle means here no animations, no redrawing, and no ongoing background
 
772
work. Since there is currently no way to hook into the Clutter master
 
773
clock and know when is running, the implementation here is somewhat
 
774
approximation. Animations done through the shell's Tweener module will
 
775
be handled properly, but other animations may be detected as terminating
 
776
early if they can be drawn fast enough so that the event loop goes idle
 
777
between frames.
 
778
</p>
 
779
<p>
 
780
The intent of this function is for performance measurement runs
 
781
where a number of actions should be run serially and each action is
 
782
timed individually. Using this function for other purposes will
 
783
interfere with the ability to use it for performance measurement so
 
784
should be avoided.
 
785
</p>
 
786
<div class="variablelist"><table border="0">
 
787
<col align="left" valign="top">
 
788
<tbody>
 
789
<tr>
 
790
<td><p><span class="term"><em class="parameter"><code>global</code></em> :</span></p></td>
 
791
<td>the <span class="type">ShellGlobal</span>
 
792
</td>
 
793
</tr>
 
794
<tr>
 
795
<td><p><span class="term"><em class="parameter"><code>func</code></em> :</span></p></td>
 
796
<td>function to call at leisure</td>
 
797
</tr>
 
798
<tr>
 
799
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 
800
<td>data to pass to <em class="parameter"><code>func</code></em>
 
801
</td>
 
802
</tr>
 
803
<tr>
 
804
<td><p><span class="term"><em class="parameter"><code>notify</code></em> :</span></p></td>
 
805
<td>function to call to free <em class="parameter"><code>user_data</code></em>
 
806
</td>
 
807
</tr>
 
808
</tbody>
 
809
</table></div>
 
810
</div>
 
811
<hr>
 
812
<div class="refsect2">
 
813
<a name="shell-global-set-cursor"></a><h3>shell_global_set_cursor ()</h3>
 
814
<pre class="programlisting"><span class="returnvalue">void</span>                shell_global_set_cursor             (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>,
 
815
                                                         <em class="parameter"><code><a class="link" href="shell-ShellGlobal.html#ShellCursor"><span class="type">ShellCursor</span></a> type</code></em>);</pre>
 
816
<p>
 
817
Set the cursor on the stage window.
 
818
</p>
 
819
<div class="variablelist"><table border="0">
 
820
<col align="left" valign="top">
 
821
<tbody>
 
822
<tr>
 
823
<td><p><span class="term"><em class="parameter"><code>global</code></em> :</span></p></td>
 
824
<td>A <span class="type">ShellGlobal</span>
 
825
</td>
 
826
</tr>
 
827
<tr>
 
828
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
 
829
<td>the type of the cursor</td>
 
830
</tr>
 
831
</tbody>
 
832
</table></div>
 
833
</div>
 
834
<hr>
 
835
<div class="refsect2">
 
836
<a name="shell-global-set-stage-input-mode"></a><h3>shell_global_set_stage_input_mode ()</h3>
 
837
<pre class="programlisting"><span class="returnvalue">void</span>                shell_global_set_stage_input_mode   (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>,
 
838
                                                         <em class="parameter"><code><a class="link" href="shell-ShellGlobal.html#ShellStageInputMode"><span class="type">ShellStageInputMode</span></a> mode</code></em>);</pre>
 
839
<p>
 
840
Sets the input mode of the stage; when <em class="parameter"><code>mode</code></em> is
 
841
<code class="literal">SHELL_STAGE_INPUT_MODE_NONREACTIVE</code>, then the stage does not absorb
 
842
any clicks, but just passes them through to underlying windows.
 
843
When it is <code class="literal">SHELL_STAGE_INPUT_MODE_NORMAL</code>, then the stage accepts
 
844
clicks in the region defined by
 
845
<a class="link" href="shell-ShellGlobal.html#shell-global-set-stage-input-region" title="shell_global_set_stage_input_region ()"><code class="function">shell_global_set_stage_input_region()</code></a> but passes through clicks
 
846
outside that region. When it is <code class="literal">SHELL_STAGE_INPUT_MODE_FULLSCREEN</code>,
 
847
the stage absorbs all input.
 
848
</p>
 
849
<p>
 
850
When the input mode is <code class="literal">SHELL_STAGE_INPUT_MODE_FOCUSED</code>, the pointer
 
851
is handled as with <code class="literal">SHELL_STAGE_INPUT_MODE_NORMAL</code>, but additionally
 
852
the stage window has the keyboard focus. If the stage loses the
 
853
focus (eg, because the user clicked into a window) the input mode
 
854
will revert to <code class="literal">SHELL_STAGE_INPUT_MODE_NORMAL</code>.
 
855
</p>
 
856
<p>
 
857
Note that whenever a mutter-internal Gtk widget has a pointer grab,
 
858
the shell behaves as though it was in
 
859
<code class="literal">SHELL_STAGE_INPUT_MODE_NONREACTIVE</code>, to ensure that the widget gets
 
860
any clicks it is expecting.
 
861
</p>
 
862
<div class="variablelist"><table border="0">
 
863
<col align="left" valign="top">
 
864
<tbody>
 
865
<tr>
 
866
<td><p><span class="term"><em class="parameter"><code>global</code></em> :</span></p></td>
 
867
<td>the <span class="type">ShellGlobal</span>
 
868
</td>
 
869
</tr>
 
870
<tr>
 
871
<td><p><span class="term"><em class="parameter"><code>mode</code></em> :</span></p></td>
 
872
<td>the stage input mode</td>
 
873
</tr>
 
874
</tbody>
 
875
</table></div>
 
876
</div>
 
877
<hr>
 
878
<div class="refsect2">
 
879
<a name="shell-global-set-stage-input-region"></a><h3>shell_global_set_stage_input_region ()</h3>
 
880
<pre class="programlisting"><span class="returnvalue">void</span>                shell_global_set_stage_input_region (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>,
 
881
                                                         <em class="parameter"><code><span class="type">GSList</span> *rectangles</code></em>);</pre>
 
882
<p>
 
883
Sets the area of the stage that is responsive to mouse clicks when
 
884
the stage mode is <code class="literal">SHELL_STAGE_INPUT_MODE_NORMAL</code> (but does not change the
 
885
current stage mode).
 
886
</p>
 
887
<div class="variablelist"><table border="0">
 
888
<col align="left" valign="top">
 
889
<tbody>
 
890
<tr>
 
891
<td><p><span class="term"><em class="parameter"><code>global</code></em> :</span></p></td>
 
892
<td>the <span class="type">ShellGlobal</span>
 
893
</td>
 
894
</tr>
 
895
<tr>
 
896
<td><p><span class="term"><em class="parameter"><code>rectangles</code></em> :</span></p></td>
 
897
<td>a list of <span class="type">MetaRectangle</span>
 
898
describing the input region. <span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> Meta.Rectangle]</span>
 
899
</td>
 
900
</tr>
 
901
</tbody>
 
902
</table></div>
 
903
</div>
 
904
<hr>
 
905
<div class="refsect2">
 
906
<a name="shell-global-sync-pointer"></a><h3>shell_global_sync_pointer ()</h3>
 
907
<pre class="programlisting"><span class="returnvalue">void</span>                shell_global_sync_pointer           (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>);</pre>
 
908
<p>
 
909
Ensures that clutter is aware of the current pointer position,
 
910
causing enter and leave events to be emitted if the pointer moved
 
911
behind our back (ie, during a pointer grab).
 
912
</p>
 
913
<div class="variablelist"><table border="0">
 
914
<col align="left" valign="top">
 
915
<tbody><tr>
 
916
<td><p><span class="term"><em class="parameter"><code>global</code></em> :</span></p></td>
 
917
<td>the <span class="type">ShellGlobal</span>
 
918
</td>
 
919
</tr></tbody>
 
920
</table></div>
 
921
</div>
 
922
<hr>
 
923
<div class="refsect2">
 
924
<a name="shell-global-unset-cursor"></a><h3>shell_global_unset_cursor ()</h3>
 
925
<pre class="programlisting"><span class="returnvalue">void</span>                shell_global_unset_cursor           (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>);</pre>
 
926
<p>
 
927
Unset the cursor on the stage window.
 
928
</p>
 
929
<div class="variablelist"><table border="0">
 
930
<col align="left" valign="top">
 
931
<tbody><tr>
 
932
<td><p><span class="term"><em class="parameter"><code>global</code></em> :</span></p></td>
 
933
<td>A <span class="type">ShellGlobal</span>
 
934
</td>
 
935
</tr></tbody>
 
936
</table></div>
 
937
</div>
 
938
</div>
 
939
</div>
 
940
<div class="footer">
 
941
<hr>
 
942
          Generated by GTK-Doc V1.18.1</div>
 
943
</body>
 
944
</html>
 
 
b'\\ No newline at end of file'