← Back to branch summary

~ubuntu-branches/debian/sid/gnome-shell/sid

« back to all changes in this revision

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

  • Committer: Package Import Robot
  • Author(s): Emilio Pozuelo Monfort, Petr Salinger, Emilio Pozuelo Monfort
  • Date: 2013-10-13 17:47:35 UTC
  • mfrom: (1.2.17) (18.1.41 experimental)
  • Revision ID: package-import@ubuntu.com-20131013174735-2npsu0w5wk0e6vgb
Tags: 3.8.4-4
http://bugs.debian.org/726099
[ Petr Salinger ]
* Restrict dependency on gir1.2-nmgtk-1.0 to linux-any (Closes: #726099)

[ Emilio Pozuelo Monfort ]
* Upload to unstable.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/shell/html/shell-ShellGlobal.html
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>ShellGlobal</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.77.1">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
7
7
<link rel="home" href="index.html" title="Shell Reference Manual">
8
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)">
 
9
<link rel="prev" href="gdbus-org.gnome.Shell.SearchProvider2.html" title="org.gnome.Shell.SearchProvider2">
 
10
<link rel="next" href="shell-shell-keybinding-modes.html" title="shell-keybinding-modes">
 
11
<meta name="generator" content="GTK-Doc V1.19 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
</head>
14
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
16
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>
 
17
<td><a accesskey="p" href="gdbus-org.gnome.Shell.SearchProvider2.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18
18
<td><a accesskey="u" href="ch06.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19
19
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20
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>
 
21
<td><a accesskey="n" href="shell-shell-keybinding-modes.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
22
22
</tr>
23
23
<tr><td colspan="5" class="shortcuts">
24
24
<a href="#shell-ShellGlobal.synopsis" class="shortcut">Top</a>
39
39
</tr></table></div>
40
40
<div class="refsynopsisdiv">
41
41
<a name="shell-ShellGlobal.synopsis"></a><h2>Synopsis</h2>
42
 
<a name="ShellStageInputMode"></a><a name="ShellCursor"></a><a name="ShellSessionType"></a><pre class="synopsis">struct              <a class="link" href="shell-ShellGlobal.html#ShellGlobalClass" title="struct ShellGlobalClass">ShellGlobalClass</a>;
 
42
<a name="ShellCursor"></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><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> 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#ShellStageInputMode-enum" title="enum ShellStageInputMode">ShellStageInputMode</a>;
 
47
<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-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>,
 
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
                                                         <em class="parameter"><code><a href="http://developer.gnome.org/meta/MetaPlugin.html#MetaModalOptions"><span class="type">MetaModalOptions</span></a> options</code></em>);
 
50
<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>);
 
51
<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>,
 
52
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> id</code></em>);
 
53
<a href="http://library.gnome.org/devel/gio/unstable/GAppInfo.html#GAppLaunchContext"><span class="returnvalue">GAppLaunchContext</span></a> * <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>
 
54
                                                        (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>);
 
55
<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>,
 
56
                                                         <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>);
 
57
<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>);
43
58
<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>);
44
 
<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>);
45
 
<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>);
46
 
<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>);
47
 
<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>);
48
 
<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>);
49
 
<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>);
50
 
<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>);
51
 
<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>,
52
 
                                                         <em class="parameter"><code><span class="type">guint32</span> timestamp</code></em>,
53
 
                                                         <em class="parameter"><code><span class="type">MetaModalOptions</span> options</code></em>);
54
 
<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>,
55
 
                                                         <em class="parameter"><code><span class="type">guint32</span> timestamp</code></em>);
56
 
enum                <a class="link" href="shell-ShellGlobal.html#ShellStageInputMode-enum" title="enum ShellStageInputMode">ShellStageInputMode</a>;
57
 
<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>,
58
 
                                                         <em class="parameter"><code><a class="link" href="shell-ShellGlobal.html#ShellStageInputMode"><span class="type">ShellStageInputMode</span></a> mode</code></em>);
59
 
<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>,
60
 
                                                         <em class="parameter"><code><span class="type">GSList</span> *rectangles</code></em>);
61
 
enum                <a class="link" href="shell-ShellGlobal.html#ShellCursor-enum" title="enum ShellCursor">ShellCursor</a>;
62
 
<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>,
63
 
                                                         <em class="parameter"><code><a class="link" href="shell-ShellGlobal.html#ShellCursor"><span class="type">ShellCursor</span></a> type</code></em>);
64
 
<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>);
65
 
<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>,
66
 
                                                         <em class="parameter"><code><span class="type">int</span> x1</code></em>,
67
 
                                                         <em class="parameter"><code><span class="type">int</span> y1</code></em>,
68
 
                                                         <em class="parameter"><code><span class="type">int</span> x2</code></em>,
69
 
                                                         <em class="parameter"><code><span class="type">int</span> y2</code></em>,
70
 
                                                         <em class="parameter"><code><span class="type">int</span> directions</code></em>);
71
 
<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>
72
 
                                                        (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>,
73
 
                                                         <em class="parameter"><code><span class="type">guint32</span> barrier</code></em>);
74
 
<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>,
75
 
                                                         <em class="parameter"><code><span class="type">int</span> *x</code></em>,
76
 
                                                         <em class="parameter"><code><span class="type">int</span> *y</code></em>,
77
 
                                                         <em class="parameter"><code><span class="type">ClutterModifierType</span> *mods</code></em>);
78
 
<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>);
79
 
<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>);
80
 
                    <a class="link" href="shell-ShellGlobal.html#ShellMemoryInfo" title="ShellMemoryInfo">ShellMemoryInfo</a>;
 
59
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a>             <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>);
 
60
<a href="http://developer.gnome.org/meta/MetaDisplay.html"><span class="returnvalue">MetaDisplay</span></a> *       <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>);
 
61
<a href="http://developer.gnome.org/gdk/GdkScreen.html"><span class="returnvalue">GdkScreen</span></a> *         <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>);
81
62
<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>,
82
63
                                                         <em class="parameter"><code><a class="link" href="shell-ShellGlobal.html#ShellMemoryInfo" title="ShellMemoryInfo"><span class="type">ShellMemoryInfo</span></a> *meminfo</code></em>);
83
 
<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>);
84
 
<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>);
85
 
<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>);
86
 
<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>,
87
 
                                                         <em class="parameter"><code><a class="link" href="shell-ShellGlobal.html#ShellLeisureFunction" title="ShellLeisureFunction ()"><span class="type">ShellLeisureFunction</span></a> func</code></em>,
88
 
                                                         <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>,
89
 
                                                         <em class="parameter"><code><span class="type">GDestroyNotify</span> notify</code></em>);
90
 
<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>);
91
 
<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>
92
 
                                                        (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>);
93
 
<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>,
94
 
                                                         <em class="parameter"><code><span class="type">guint</span> id</code></em>,
95
 
                                                         <em class="parameter"><code>const <span class="type">char</span> *name</code></em>);
96
 
<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>,
97
 
                                                         <em class="parameter"><code><span class="type">guint</span> id</code></em>);
 
64
<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>,
 
65
                                                         <em class="parameter"><code><span class="type">int</span> *x</code></em>,
 
66
                                                         <em class="parameter"><code><span class="type">int</span> *y</code></em>,
 
67
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/clutter/clutter-Events.html#ClutterModifierType"><span class="type">ClutterModifierType</span></a> *mods</code></em>);
 
68
<a href="http://developer.gnome.org/meta/MetaScreen.html"><span class="returnvalue">MetaScreen</span></a> *        <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>);
 
69
const <span class="returnvalue">char</span> *        <a class="link" href="shell-ShellGlobal.html#shell-global-get-session-mode" title="shell_global_get_session_mode ()">shell_global_get_session_mode</a>       (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>);
 
70
<a href="http://library.gnome.org/devel/gio/unstable/GSettings.html"><span class="returnvalue">GSettings</span></a> *         <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>);
 
71
<a href="/usr/share/gtk-doc/html/clutter/ClutterStage.html"><span class="returnvalue">ClutterStage</span></a> *      <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>);
 
72
<a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *             <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>);
 
73
<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>);
98
74
<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>,
99
75
                                                         <em class="parameter"><code>const <span class="type">char</span> *msg</code></em>,
100
76
                                                         <em class="parameter"><code>const <span class="type">char</span> *details</code></em>);
101
 
<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>);
 
77
<span class="returnvalue">void</span>                <a class="link" href="shell-ShellGlobal.html#shell-global-play-sound-file" title="shell_global_play_sound_file ()">shell_global_play_sound_file</a>        (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>,
 
78
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> id</code></em>,
 
79
                                                         <em class="parameter"><code>const <span class="type">char</span> *file_name</code></em>,
 
80
                                                         <em class="parameter"><code>const <span class="type">char</span> *description</code></em>,
 
81
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/clutter/clutter-Events.html#ClutterEvent"><span class="type">ClutterEvent</span></a> *for_event</code></em>);
 
82
<span class="returnvalue">void</span>                <a class="link" href="shell-ShellGlobal.html#shell-global-play-sound-file-full" title="shell_global_play_sound_file_full ()">shell_global_play_sound_file_full</a>   (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>,
 
83
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> id</code></em>,
 
84
                                                         <em class="parameter"><code>const <span class="type">char</span> *file_name</code></em>,
 
85
                                                         <em class="parameter"><code>const <span class="type">char</span> *description</code></em>,
 
86
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/clutter/clutter-Events.html#ClutterEvent"><span class="type">ClutterEvent</span></a> *for_event</code></em>,
 
87
                                                         <em class="parameter"><code>const <span class="type">char</span> *application_id</code></em>,
 
88
                                                         <em class="parameter"><code>const <span class="type">char</span> *application_name</code></em>);
 
89
<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>,
 
90
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> id</code></em>,
 
91
                                                         <em class="parameter"><code>const <span class="type">char</span> *name</code></em>,
 
92
                                                         <em class="parameter"><code>const <span class="type">char</span> *description</code></em>,
 
93
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/clutter/clutter-Events.html#ClutterEvent"><span class="type">ClutterEvent</span></a> *for_event</code></em>);
 
94
<span class="returnvalue">void</span>                <a class="link" href="shell-ShellGlobal.html#shell-global-play-theme-sound-full" title="shell_global_play_theme_sound_full ()">shell_global_play_theme_sound_full</a>  (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>,
 
95
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> id</code></em>,
 
96
                                                         <em class="parameter"><code>const <span class="type">char</span> *name</code></em>,
 
97
                                                         <em class="parameter"><code>const <span class="type">char</span> *description</code></em>,
 
98
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/clutter/clutter-Events.html#ClutterEvent"><span class="type">ClutterEvent</span></a> *for_event</code></em>,
 
99
                                                         <em class="parameter"><code>const <span class="type">char</span> *application_id</code></em>,
 
100
                                                         <em class="parameter"><code>const <span class="type">char</span> *application_name</code></em>);
102
101
<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>);
103
 
<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>);
104
 
enum                <a class="link" href="shell-ShellGlobal.html#ShellSessionType-enum" title="enum ShellSessionType">ShellSessionType</a>;
105
 
<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>);
 
102
<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>,
 
103
                                                         <em class="parameter"><code><a class="link" href="shell-ShellGlobal.html#ShellLeisureFunction" title="ShellLeisureFunction ()"><span class="type">ShellLeisureFunction</span></a> func</code></em>,
 
104
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>,
 
105
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> notify</code></em>);
 
106
<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>,
 
107
                                                         <em class="parameter"><code><a class="link" href="shell-ShellGlobal.html#ShellCursor"><span class="type">ShellCursor</span></a> type</code></em>);
 
108
<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>,
 
109
                                                         <em class="parameter"><code><a class="link" href="shell-ShellGlobal.html#ShellStageInputMode"><span class="type">ShellStageInputMode</span></a> mode</code></em>);
 
110
<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>,
 
111
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> *rectangles</code></em>);
 
112
<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>);
 
113
<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
114
</pre>
107
115
</div>
108
116
<div class="refsect1">
109
117
<a name="shell-ShellGlobal.object-hierarchy"></a><h2>Object Hierarchy</h2>
110
118
<pre class="synopsis">
111
119
  GEnum
 
120
   +----ShellCursor
 
121
</pre>
 
122
<pre class="synopsis">
 
123
  GEnum
112
124
   +----ShellStageInputMode
113
125
</pre>
114
 
<pre class="synopsis">
115
 
  GEnum
116
 
   +----ShellCursor
117
 
</pre>
118
 
<pre class="synopsis">
119
 
  GEnum
120
 
   +----ShellSessionType
121
 
</pre>
122
126
</div>
123
127
<div class="refsect1">
124
128
<a name="shell-ShellGlobal.description"></a><h2>Description</h2>
126
130
<div class="refsect1">
127
131
<a name="shell-ShellGlobal.details"></a><h2>Details</h2>
128
132
<div class="refsect2">
 
133
<a name="ShellCursor-enum"></a><h3>enum ShellCursor</h3>
 
134
<pre class="programlisting">typedef enum {
 
135
  SHELL_CURSOR_DND_IN_DRAG,
 
136
  SHELL_CURSOR_DND_UNSUPPORTED_TARGET,
 
137
  SHELL_CURSOR_DND_MOVE,
 
138
  SHELL_CURSOR_DND_COPY,
 
139
  SHELL_CURSOR_POINTING_HAND,
 
140
  SHELL_CURSOR_CROSSHAIR
 
141
} ShellCursor;
 
142
</pre>
 
143
<div class="variablelist"><table border="0" class="variablelist">
 
144
<colgroup>
 
145
<col align="left" valign="top">
 
146
<col>
 
147
</colgroup>
 
148
<tbody>
 
149
<tr>
 
150
<td><p><a name="SHELL-CURSOR-DND-IN-DRAG:CAPS"></a><span class="term"><code class="literal">SHELL_CURSOR_DND_IN_DRAG</code></span></p></td>
 
151
<td></td>
 
152
</tr>
 
153
<tr>
 
154
<td><p><a name="SHELL-CURSOR-DND-UNSUPPORTED-TARGET:CAPS"></a><span class="term"><code class="literal">SHELL_CURSOR_DND_UNSUPPORTED_TARGET</code></span></p></td>
 
155
<td></td>
 
156
</tr>
 
157
<tr>
 
158
<td><p><a name="SHELL-CURSOR-DND-MOVE:CAPS"></a><span class="term"><code class="literal">SHELL_CURSOR_DND_MOVE</code></span></p></td>
 
159
<td></td>
 
160
</tr>
 
161
<tr>
 
162
<td><p><a name="SHELL-CURSOR-DND-COPY:CAPS"></a><span class="term"><code class="literal">SHELL_CURSOR_DND_COPY</code></span></p></td>
 
163
<td></td>
 
164
</tr>
 
165
<tr>
 
166
<td><p><a name="SHELL-CURSOR-POINTING-HAND:CAPS"></a><span class="term"><code class="literal">SHELL_CURSOR_POINTING_HAND</code></span></p></td>
 
167
<td></td>
 
168
</tr>
 
169
<tr>
 
170
<td><p><a name="SHELL-CURSOR-CROSSHAIR:CAPS"></a><span class="term"><code class="literal">SHELL_CURSOR_CROSSHAIR</code></span></p></td>
 
171
<td></td>
 
172
</tr>
 
173
</tbody>
 
174
</table></div>
 
175
</div>
 
176
<hr>
 
177
<div class="refsect2">
129
178
<a name="ShellGlobalClass"></a><h3>struct ShellGlobalClass</h3>
130
179
<pre class="programlisting">struct ShellGlobalClass {
131
180
  GObjectClass parent_class;
134
183
</div>
135
184
<hr>
136
185
<div class="refsect2">
137
 
<a name="shell-global-get"></a><h3>shell_global_get ()</h3>
138
 
<pre class="programlisting"><span class="returnvalue">ShellGlobal</span> *       shell_global_get                    (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
139
 
<p>
140
 
Gets the singleton global object that represents the desktop.
141
 
</p>
142
 
<div class="variablelist"><table border="0" class="variablelist">
143
 
<colgroup>
144
 
<col align="left" valign="top">
145
 
<col>
146
 
</colgroup>
147
 
<tbody><tr>
148
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
149
 
<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>
150
 
</td>
151
 
</tr></tbody>
152
 
</table></div>
153
 
</div>
154
 
<hr>
155
 
<div class="refsect2">
156
 
<a name="shell-global-get-stage"></a><h3>shell_global_get_stage ()</h3>
157
 
<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>
158
 
<div class="variablelist"><table border="0" class="variablelist">
159
 
<colgroup>
160
 
<col align="left" valign="top">
161
 
<col>
162
 
</colgroup>
163
 
<tbody><tr>
164
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
165
 
<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>
166
 
</td>
167
 
</tr></tbody>
168
 
</table></div>
169
 
</div>
170
 
<hr>
171
 
<div class="refsect2">
172
 
<a name="shell-global-get-screen"></a><h3>shell_global_get_screen ()</h3>
173
 
<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>
174
 
<div class="variablelist"><table border="0" class="variablelist">
175
 
<colgroup>
176
 
<col align="left" valign="top">
177
 
<col>
178
 
</colgroup>
179
 
<tbody><tr>
180
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
181
 
<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>
182
 
</td>
183
 
</tr></tbody>
184
 
</table></div>
185
 
</div>
186
 
<hr>
187
 
<div class="refsect2">
188
 
<a name="shell-global-get-gdk-screen"></a><h3>shell_global_get_gdk_screen ()</h3>
189
 
<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>
190
 
<div class="variablelist"><table border="0" class="variablelist">
191
 
<colgroup>
192
 
<col align="left" valign="top">
193
 
<col>
194
 
</colgroup>
195
 
<tbody><tr>
196
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
197
 
<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>
198
 
</td>
199
 
</tr></tbody>
200
 
</table></div>
201
 
</div>
202
 
<hr>
203
 
<div class="refsect2">
204
 
<a name="shell-global-get-display"></a><h3>shell_global_get_display ()</h3>
205
 
<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>
206
 
<div class="variablelist"><table border="0" class="variablelist">
207
 
<colgroup>
208
 
<col align="left" valign="top">
209
 
<col>
210
 
</colgroup>
211
 
<tbody><tr>
212
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
213
 
<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>
214
 
</td>
215
 
</tr></tbody>
216
 
</table></div>
217
 
</div>
218
 
<hr>
219
 
<div class="refsect2">
220
 
<a name="shell-global-get-window-actors"></a><h3>shell_global_get_window_actors ()</h3>
221
 
<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>
222
 
<p>
223
 
Gets the list of <span class="type">MetaWindowActor</span> for the plugin's screen
224
 
</p>
225
 
<div class="variablelist"><table border="0" class="variablelist">
226
 
<colgroup>
227
 
<col align="left" valign="top">
228
 
<col>
229
 
</colgroup>
230
 
<tbody><tr>
231
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
232
 
<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>
233
 
</td>
234
 
</tr></tbody>
235
 
</table></div>
236
 
</div>
237
 
<hr>
238
 
<div class="refsect2">
239
 
<a name="shell-global-get-settings"></a><h3>shell_global_get_settings ()</h3>
240
 
<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>
241
 
<p>
242
 
Get the global GSettings instance.
243
 
</p>
244
 
<div class="variablelist"><table border="0" class="variablelist">
245
 
<colgroup>
246
 
<col align="left" valign="top">
247
 
<col>
248
 
</colgroup>
249
 
<tbody>
250
 
<tr>
251
 
<td><p><span class="term"><em class="parameter"><code>global</code></em> :</span></p></td>
252
 
<td>A <span class="type">ShellGlobal</span>
253
 
</td>
254
 
</tr>
255
 
<tr>
256
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
257
 
<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>
258
 
</td>
259
 
</tr>
260
 
</tbody>
261
 
</table></div>
262
 
</div>
263
 
<hr>
264
 
<div class="refsect2">
265
 
<a name="shell-global-get-current-time"></a><h3>shell_global_get_current_time ()</h3>
266
 
<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>
267
 
<div class="variablelist"><table border="0" class="variablelist">
268
 
<colgroup>
269
 
<col align="left" valign="top">
270
 
<col>
271
 
</colgroup>
272
 
<tbody>
273
 
<tr>
274
 
<td><p><span class="term"><em class="parameter"><code>global</code></em> :</span></p></td>
275
 
<td>A <span class="type">ShellGlobal</span>
276
 
</td>
277
 
</tr>
278
 
<tr>
279
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
280
 
<td>the current X server time from the current Clutter, Gdk, or X
281
 
event. If called from outside an event handler, this may return
282
 
<code class="literal">Clutter</code>.CURRENT_TIME (aka 0), or it may return a slightly
283
 
out-of-date timestamp.</td>
 
186
<a name="ShellLeisureFunction"></a><h3>ShellLeisureFunction ()</h3>
 
187
<pre class="programlisting"><span class="returnvalue">void</span>                (*ShellLeisureFunction)             (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);</pre>
 
188
</div>
 
189
<hr>
 
190
<div class="refsect2">
 
191
<a name="ShellMemoryInfo"></a><h3>ShellMemoryInfo</h3>
 
192
<pre class="programlisting">typedef struct {
 
193
  guint glibc_uordblks;
 
194
 
 
195
  guint js_bytes;
 
196
 
 
197
  guint gjs_boxed;
 
198
  guint gjs_gobject;
 
199
  guint gjs_function;
 
200
  guint gjs_closure;
 
201
 
 
202
  /* 32 bit to avoid js conversion problems with 64 bit */
 
203
  guint  last_gc_seconds_ago;
 
204
} ShellMemoryInfo;
 
205
</pre>
 
206
</div>
 
207
<hr>
 
208
<div class="refsect2">
 
209
<a name="ShellStageInputMode-enum"></a><h3>enum ShellStageInputMode</h3>
 
210
<pre class="programlisting">typedef enum {
 
211
  SHELL_STAGE_INPUT_MODE_NONREACTIVE,
 
212
  SHELL_STAGE_INPUT_MODE_NORMAL,
 
213
  SHELL_STAGE_INPUT_MODE_FOCUSED,
 
214
  SHELL_STAGE_INPUT_MODE_FULLSCREEN
 
215
} ShellStageInputMode;
 
216
</pre>
 
217
<div class="variablelist"><table border="0" class="variablelist">
 
218
<colgroup>
 
219
<col align="left" valign="top">
 
220
<col>
 
221
</colgroup>
 
222
<tbody>
 
223
<tr>
 
224
<td><p><a name="SHELL-STAGE-INPUT-MODE-NONREACTIVE:CAPS"></a><span class="term"><code class="literal">SHELL_STAGE_INPUT_MODE_NONREACTIVE</code></span></p></td>
 
225
<td></td>
 
226
</tr>
 
227
<tr>
 
228
<td><p><a name="SHELL-STAGE-INPUT-MODE-NORMAL:CAPS"></a><span class="term"><code class="literal">SHELL_STAGE_INPUT_MODE_NORMAL</code></span></p></td>
 
229
<td></td>
 
230
</tr>
 
231
<tr>
 
232
<td><p><a name="SHELL-STAGE-INPUT-MODE-FOCUSED:CAPS"></a><span class="term"><code class="literal">SHELL_STAGE_INPUT_MODE_FOCUSED</code></span></p></td>
 
233
<td></td>
 
234
</tr>
 
235
<tr>
 
236
<td><p><a name="SHELL-STAGE-INPUT-MODE-FULLSCREEN:CAPS"></a><span class="term"><code class="literal">SHELL_STAGE_INPUT_MODE_FULLSCREEN</code></span></p></td>
 
237
<td></td>
284
238
</tr>
285
239
</tbody>
286
240
</table></div>
288
242
<hr>
289
243
<div class="refsect2">
290
244
<a name="shell-global-begin-modal"></a><h3>shell_global_begin_modal ()</h3>
291
 
<pre class="programlisting"><span class="returnvalue">gboolean</span>            shell_global_begin_modal            (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>,
292
 
                                                         <em class="parameter"><code><span class="type">guint32</span> timestamp</code></em>,
293
 
                                                         <em class="parameter"><code><span class="type">MetaModalOptions</span> options</code></em>);</pre>
 
245
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            shell_global_begin_modal            (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>,
 
246
                                                         <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>,
 
247
                                                         <em class="parameter"><code><a href="http://developer.gnome.org/meta/MetaPlugin.html#MetaModalOptions"><span class="type">MetaModalOptions</span></a> options</code></em>);</pre>
294
248
<p>
295
249
Grabs the keyboard and mouse to the stage window. The stage will
296
250
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>
312
266
<tr>
313
267
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
314
268
<td>
315
 
<code class="literal">TRUE</code> if we succesfully entered the mode. <code class="literal">FALSE</code> if we couldn't
 
269
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if we succesfully entered the mode. <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if we couldn't
316
270
enter the mode. Failure may occur because an application has the pointer
317
271
or keyboard grabbed, because Mutter is in a mode itself like moving a
318
272
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>
323
277
</div>
324
278
<hr>
325
279
<div class="refsect2">
 
280
<a name="shell-global-begin-work"></a><h3>shell_global_begin_work ()</h3>
 
281
<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>
 
282
<p>
 
283
Marks that we are currently doing work. This is used to to track
 
284
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>.
 
285
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
 
286
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>.
 
287
</p>
 
288
<div class="variablelist"><table border="0" class="variablelist">
 
289
<colgroup>
 
290
<col align="left" valign="top">
 
291
<col>
 
292
</colgroup>
 
293
<tbody><tr>
 
294
<td><p><span class="term"><em class="parameter"><code>global</code></em> :</span></p></td>
 
295
<td>the <span class="type">ShellGlobal</span>
 
296
</td>
 
297
</tr></tbody>
 
298
</table></div>
 
299
</div>
 
300
<hr>
 
301
<div class="refsect2">
 
302
<a name="shell-global-cancel-theme-sound"></a><h3>shell_global_cancel_theme_sound ()</h3>
 
303
<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>,
 
304
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> id</code></em>);</pre>
 
305
<p>
 
306
Cancels a sound notification.
 
307
</p>
 
308
<div class="variablelist"><table border="0" class="variablelist">
 
309
<colgroup>
 
310
<col align="left" valign="top">
 
311
<col>
 
312
</colgroup>
 
313
<tbody>
 
314
<tr>
 
315
<td><p><span class="term"><em class="parameter"><code>global</code></em> :</span></p></td>
 
316
<td>the <span class="type">ShellGlobal</span>
 
317
</td>
 
318
</tr>
 
319
<tr>
 
320
<td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td>
 
321
<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>
 
322
</td>
 
323
</tr>
 
324
</tbody>
 
325
</table></div>
 
326
</div>
 
327
<hr>
 
328
<div class="refsect2">
 
329
<a name="shell-global-create-app-launch-context"></a><h3>shell_global_create_app_launch_context ()</h3>
 
330
<pre class="programlisting"><a href="http://library.gnome.org/devel/gio/unstable/GAppInfo.html#GAppLaunchContext"><span class="returnvalue">GAppLaunchContext</span></a> * shell_global_create_app_launch_context
 
331
                                                        (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>);</pre>
 
332
<p>
 
333
Create a <a href="http://library.gnome.org/devel/gio/unstable/GAppInfo.html#GAppLaunchContext"><span class="type">GAppLaunchContext</span></a> set up with the correct timestamp, and
 
334
targeted to activate on the current workspace.
 
335
</p>
 
336
<div class="variablelist"><table border="0" class="variablelist">
 
337
<colgroup>
 
338
<col align="left" valign="top">
 
339
<col>
 
340
</colgroup>
 
341
<tbody>
 
342
<tr>
 
343
<td><p><span class="term"><em class="parameter"><code>global</code></em> :</span></p></td>
 
344
<td>A <span class="type">ShellGlobal</span>
 
345
</td>
 
346
</tr>
 
347
<tr>
 
348
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
349
<td>A new <a href="http://library.gnome.org/devel/gio/unstable/GAppInfo.html#GAppLaunchContext"><span class="type">GAppLaunchContext</span></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
 
350
</td>
 
351
</tr>
 
352
</tbody>
 
353
</table></div>
 
354
</div>
 
355
<hr>
 
356
<div class="refsect2">
326
357
<a name="shell-global-end-modal"></a><h3>shell_global_end_modal ()</h3>
327
358
<pre class="programlisting"><span class="returnvalue">void</span>                shell_global_end_modal              (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>,
328
 
                                                         <em class="parameter"><code><span class="type">guint32</span> timestamp</code></em>);</pre>
 
359
                                                         <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>
329
360
<p>
330
361
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>.
331
362
</p>
343
374
</div>
344
375
<hr>
345
376
<div class="refsect2">
346
 
<a name="ShellStageInputMode-enum"></a><h3>enum ShellStageInputMode</h3>
347
 
<pre class="programlisting">typedef enum {
348
 
  SHELL_STAGE_INPUT_MODE_NONREACTIVE,
349
 
  SHELL_STAGE_INPUT_MODE_NORMAL,
350
 
  SHELL_STAGE_INPUT_MODE_FOCUSED,
351
 
  SHELL_STAGE_INPUT_MODE_FULLSCREEN
352
 
} ShellStageInputMode;
353
 
</pre>
354
 
</div>
355
 
<hr>
356
 
<div class="refsect2">
357
 
<a name="shell-global-set-stage-input-mode"></a><h3>shell_global_set_stage_input_mode ()</h3>
358
 
<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>,
359
 
                                                         <em class="parameter"><code><a class="link" href="shell-ShellGlobal.html#ShellStageInputMode"><span class="type">ShellStageInputMode</span></a> mode</code></em>);</pre>
360
 
<p>
361
 
Sets the input mode of the stage; when <em class="parameter"><code>mode</code></em> is
362
 
<code class="literal">SHELL_STAGE_INPUT_MODE_NONREACTIVE</code>, then the stage does not absorb
363
 
any clicks, but just passes them through to underlying windows.
364
 
When it is <code class="literal">SHELL_STAGE_INPUT_MODE_NORMAL</code>, then the stage accepts
365
 
clicks in the region defined by
366
 
<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
367
 
outside that region. When it is <code class="literal">SHELL_STAGE_INPUT_MODE_FULLSCREEN</code>,
368
 
the stage absorbs all input.
369
 
</p>
370
 
<p>
371
 
When the input mode is <code class="literal">SHELL_STAGE_INPUT_MODE_FOCUSED</code>, the pointer
372
 
is handled as with <code class="literal">SHELL_STAGE_INPUT_MODE_NORMAL</code>, but additionally
373
 
the stage window has the keyboard focus. If the stage loses the
374
 
focus (eg, because the user clicked into a window) the input mode
375
 
will revert to <code class="literal">SHELL_STAGE_INPUT_MODE_NORMAL</code>.
376
 
</p>
377
 
<p>
378
 
Note that whenever a mutter-internal Gtk widget has a pointer grab,
379
 
the shell behaves as though it was in
380
 
<code class="literal">SHELL_STAGE_INPUT_MODE_NONREACTIVE</code>, to ensure that the widget gets
381
 
any clicks it is expecting.
382
 
</p>
383
 
<div class="variablelist"><table border="0" class="variablelist">
384
 
<colgroup>
385
 
<col align="left" valign="top">
386
 
<col>
387
 
</colgroup>
388
 
<tbody>
389
 
<tr>
390
 
<td><p><span class="term"><em class="parameter"><code>global</code></em> :</span></p></td>
391
 
<td>the <span class="type">ShellGlobal</span>
392
 
</td>
393
 
</tr>
394
 
<tr>
395
 
<td><p><span class="term"><em class="parameter"><code>mode</code></em> :</span></p></td>
396
 
<td>the stage input mode</td>
397
 
</tr>
398
 
</tbody>
399
 
</table></div>
400
 
</div>
401
 
<hr>
402
 
<div class="refsect2">
403
 
<a name="shell-global-set-stage-input-region"></a><h3>shell_global_set_stage_input_region ()</h3>
404
 
<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>,
405
 
                                                         <em class="parameter"><code><span class="type">GSList</span> *rectangles</code></em>);</pre>
406
 
<p>
407
 
Sets the area of the stage that is responsive to mouse clicks when
408
 
the stage mode is <code class="literal">SHELL_STAGE_INPUT_MODE_NORMAL</code> (but does not change the
409
 
current stage mode).
410
 
</p>
411
 
<div class="variablelist"><table border="0" class="variablelist">
412
 
<colgroup>
413
 
<col align="left" valign="top">
414
 
<col>
415
 
</colgroup>
416
 
<tbody>
417
 
<tr>
418
 
<td><p><span class="term"><em class="parameter"><code>global</code></em> :</span></p></td>
419
 
<td>the <span class="type">ShellGlobal</span>
420
 
</td>
421
 
</tr>
422
 
<tr>
423
 
<td><p><span class="term"><em class="parameter"><code>rectangles</code></em> :</span></p></td>
424
 
<td>a list of <span class="type">MetaRectangle</span>
425
 
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>
426
 
</td>
427
 
</tr>
428
 
</tbody>
429
 
</table></div>
430
 
</div>
431
 
<hr>
432
 
<div class="refsect2">
433
 
<a name="ShellCursor-enum"></a><h3>enum ShellCursor</h3>
434
 
<pre class="programlisting">typedef enum {
435
 
  SHELL_CURSOR_DND_IN_DRAG,
436
 
  SHELL_CURSOR_DND_UNSUPPORTED_TARGET,
437
 
  SHELL_CURSOR_DND_MOVE,
438
 
  SHELL_CURSOR_DND_COPY,
439
 
  SHELL_CURSOR_POINTING_HAND
440
 
} ShellCursor;
441
 
</pre>
442
 
</div>
443
 
<hr>
444
 
<div class="refsect2">
445
 
<a name="shell-global-set-cursor"></a><h3>shell_global_set_cursor ()</h3>
446
 
<pre class="programlisting"><span class="returnvalue">void</span>                shell_global_set_cursor             (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>,
447
 
                                                         <em class="parameter"><code><a class="link" href="shell-ShellGlobal.html#ShellCursor"><span class="type">ShellCursor</span></a> type</code></em>);</pre>
448
 
<p>
449
 
Set the cursor on the stage window.
450
 
</p>
451
 
<div class="variablelist"><table border="0" class="variablelist">
452
 
<colgroup>
453
 
<col align="left" valign="top">
454
 
<col>
455
 
</colgroup>
456
 
<tbody>
457
 
<tr>
458
 
<td><p><span class="term"><em class="parameter"><code>global</code></em> :</span></p></td>
459
 
<td>A <span class="type">ShellGlobal</span>
460
 
</td>
461
 
</tr>
462
 
<tr>
463
 
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
464
 
<td>the type of the cursor</td>
465
 
</tr>
466
 
</tbody>
467
 
</table></div>
468
 
</div>
469
 
<hr>
470
 
<div class="refsect2">
471
 
<a name="shell-global-unset-cursor"></a><h3>shell_global_unset_cursor ()</h3>
472
 
<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>
473
 
<p>
474
 
Unset the cursor on the stage window.
475
 
</p>
476
 
<div class="variablelist"><table border="0" class="variablelist">
477
 
<colgroup>
478
 
<col align="left" valign="top">
479
 
<col>
480
 
</colgroup>
481
 
<tbody><tr>
482
 
<td><p><span class="term"><em class="parameter"><code>global</code></em> :</span></p></td>
483
 
<td>A <span class="type">ShellGlobal</span>
484
 
</td>
485
 
</tr></tbody>
486
 
</table></div>
487
 
</div>
488
 
<hr>
489
 
<div class="refsect2">
490
 
<a name="shell-global-create-pointer-barrier"></a><h3>shell_global_create_pointer_barrier ()</h3>
491
 
<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>,
492
 
                                                         <em class="parameter"><code><span class="type">int</span> x1</code></em>,
493
 
                                                         <em class="parameter"><code><span class="type">int</span> y1</code></em>,
494
 
                                                         <em class="parameter"><code><span class="type">int</span> x2</code></em>,
495
 
                                                         <em class="parameter"><code><span class="type">int</span> y2</code></em>,
496
 
                                                         <em class="parameter"><code><span class="type">int</span> directions</code></em>);</pre>
497
 
<p>
498
 
If supported by X creates a pointer barrier.
499
 
</p>
500
 
<div class="variablelist"><table border="0" class="variablelist">
501
 
<colgroup>
502
 
<col align="left" valign="top">
503
 
<col>
504
 
</colgroup>
505
 
<tbody>
506
 
<tr>
507
 
<td><p><span class="term"><em class="parameter"><code>global</code></em> :</span></p></td>
508
 
<td>a <span class="type">ShellGlobal</span>
509
 
</td>
510
 
</tr>
511
 
<tr>
512
 
<td><p><span class="term"><em class="parameter"><code>x1</code></em> :</span></p></td>
513
 
<td>left X coordinate</td>
514
 
</tr>
515
 
<tr>
516
 
<td><p><span class="term"><em class="parameter"><code>y1</code></em> :</span></p></td>
517
 
<td>top Y coordinate</td>
518
 
</tr>
519
 
<tr>
520
 
<td><p><span class="term"><em class="parameter"><code>x2</code></em> :</span></p></td>
521
 
<td>right X coordinate</td>
522
 
</tr>
523
 
<tr>
524
 
<td><p><span class="term"><em class="parameter"><code>y2</code></em> :</span></p></td>
525
 
<td>bottom Y coordinate</td>
526
 
</tr>
527
 
<tr>
528
 
<td><p><span class="term"><em class="parameter"><code>directions</code></em> :</span></p></td>
529
 
<td>The directions we're allowed to pass through</td>
530
 
</tr>
531
 
<tr>
532
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
533
 
<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>
534
 
</td>
535
 
</tr>
536
 
</tbody>
537
 
</table></div>
538
 
</div>
539
 
<hr>
540
 
<div class="refsect2">
541
 
<a name="shell-global-destroy-pointer-barrier"></a><h3>shell_global_destroy_pointer_barrier ()</h3>
542
 
<pre class="programlisting"><span class="returnvalue">void</span>                shell_global_destroy_pointer_barrier
543
 
                                                        (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>,
544
 
                                                         <em class="parameter"><code><span class="type">guint32</span> barrier</code></em>);</pre>
545
 
<p>
546
 
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>.
547
 
</p>
548
 
<div class="variablelist"><table border="0" class="variablelist">
549
 
<colgroup>
550
 
<col align="left" valign="top">
551
 
<col>
552
 
</colgroup>
553
 
<tbody>
554
 
<tr>
555
 
<td><p><span class="term"><em class="parameter"><code>global</code></em> :</span></p></td>
556
 
<td>a <span class="type">ShellGlobal</span>
557
 
</td>
558
 
</tr>
559
 
<tr>
560
 
<td><p><span class="term"><em class="parameter"><code>barrier</code></em> :</span></p></td>
561
 
<td>a pointer barrier</td>
562
 
</tr>
563
 
</tbody>
 
377
<a name="shell-global-end-work"></a><h3>shell_global_end_work ()</h3>
 
378
<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>
 
379
<p>
 
380
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>.
 
381
If no other work is ongoing and functions have been added with
 
382
<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
 
383
opportunity.
 
384
</p>
 
385
<div class="variablelist"><table border="0" class="variablelist">
 
386
<colgroup>
 
387
<col align="left" valign="top">
 
388
<col>
 
389
</colgroup>
 
390
<tbody><tr>
 
391
<td><p><span class="term"><em class="parameter"><code>global</code></em> :</span></p></td>
 
392
<td>the <span class="type">ShellGlobal</span>
 
393
</td>
 
394
</tr></tbody>
 
395
</table></div>
 
396
</div>
 
397
<hr>
 
398
<div class="refsect2">
 
399
<a name="shell-global-get"></a><h3>shell_global_get ()</h3>
 
400
<pre class="programlisting"><span class="returnvalue">ShellGlobal</span> *       shell_global_get                    (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 
401
<p>
 
402
Gets the singleton global object that represents the desktop.
 
403
</p>
 
404
<div class="variablelist"><table border="0" class="variablelist">
 
405
<colgroup>
 
406
<col align="left" valign="top">
 
407
<col>
 
408
</colgroup>
 
409
<tbody><tr>
 
410
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
411
<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>
 
412
</td>
 
413
</tr></tbody>
 
414
</table></div>
 
415
</div>
 
416
<hr>
 
417
<div class="refsect2">
 
418
<a name="shell-global-get-current-time"></a><h3>shell_global_get_current_time ()</h3>
 
419
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a>             shell_global_get_current_time       (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>);</pre>
 
420
<div class="variablelist"><table border="0" class="variablelist">
 
421
<colgroup>
 
422
<col align="left" valign="top">
 
423
<col>
 
424
</colgroup>
 
425
<tbody>
 
426
<tr>
 
427
<td><p><span class="term"><em class="parameter"><code>global</code></em> :</span></p></td>
 
428
<td>A <span class="type">ShellGlobal</span>
 
429
</td>
 
430
</tr>
 
431
<tr>
 
432
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
433
<td>the current X server time from the current Clutter, Gdk, or X
 
434
event. If called from outside an event handler, this may return
 
435
<code class="literal">Clutter</code>.CURRENT_TIME (aka 0), or it may return a slightly
 
436
out-of-date timestamp.</td>
 
437
</tr>
 
438
</tbody>
 
439
</table></div>
 
440
</div>
 
441
<hr>
 
442
<div class="refsect2">
 
443
<a name="shell-global-get-display"></a><h3>shell_global_get_display ()</h3>
 
444
<pre class="programlisting"><a href="http://developer.gnome.org/meta/MetaDisplay.html"><span class="returnvalue">MetaDisplay</span></a> *       shell_global_get_display            (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>);</pre>
 
445
<div class="variablelist"><table border="0" class="variablelist">
 
446
<colgroup>
 
447
<col align="left" valign="top">
 
448
<col>
 
449
</colgroup>
 
450
<tbody><tr>
 
451
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
452
<td>The default <a href="http://developer.gnome.org/meta/MetaDisplay.html"><span class="type">MetaDisplay</span></a>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 
453
</td>
 
454
</tr></tbody>
 
455
</table></div>
 
456
</div>
 
457
<hr>
 
458
<div class="refsect2">
 
459
<a name="shell-global-get-gdk-screen"></a><h3>shell_global_get_gdk_screen ()</h3>
 
460
<pre class="programlisting"><a href="http://developer.gnome.org/gdk/GdkScreen.html"><span class="returnvalue">GdkScreen</span></a> *         shell_global_get_gdk_screen         (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>);</pre>
 
461
<div class="variablelist"><table border="0" class="variablelist">
 
462
<colgroup>
 
463
<col align="left" valign="top">
 
464
<col>
 
465
</colgroup>
 
466
<tbody><tr>
 
467
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
468
<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>
 
469
</td>
 
470
</tr></tbody>
 
471
</table></div>
 
472
</div>
 
473
<hr>
 
474
<div class="refsect2">
 
475
<a name="shell-global-get-memory-info"></a><h3>shell_global_get_memory_info ()</h3>
 
476
<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>,
 
477
                                                         <em class="parameter"><code><a class="link" href="shell-ShellGlobal.html#ShellMemoryInfo" title="ShellMemoryInfo"><span class="type">ShellMemoryInfo</span></a> *meminfo</code></em>);</pre>
 
478
<p>
 
479
Load process-global data about memory usage.
 
480
</p>
 
481
<div class="variablelist"><table border="0" class="variablelist">
 
482
<colgroup>
 
483
<col align="left" valign="top">
 
484
<col>
 
485
</colgroup>
 
486
<tbody><tr>
 
487
<td><p><span class="term"><em class="parameter"><code>meminfo</code></em> :</span></p></td>
 
488
<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>
 
489
</td>
 
490
</tr></tbody>
564
491
</table></div>
565
492
</div>
566
493
<hr>
569
496
<pre class="programlisting"><span class="returnvalue">void</span>                shell_global_get_pointer            (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>,
570
497
                                                         <em class="parameter"><code><span class="type">int</span> *x</code></em>,
571
498
                                                         <em class="parameter"><code><span class="type">int</span> *y</code></em>,
572
 
                                                         <em class="parameter"><code><span class="type">ClutterModifierType</span> *mods</code></em>);</pre>
 
499
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/clutter/clutter-Events.html#ClutterModifierType"><span class="type">ClutterModifierType</span></a> *mods</code></em>);</pre>
573
500
<p>
574
501
Gets the pointer coordinates and current modifier key state.
575
 
This is a wrapper around <code class="function">gdk_display_get_pointer()</code> that strips
 
502
This is a wrapper around <a href="http://developer.gnome.org/gdk/GdkDisplay.html#gdk-display-get-pointer"><code class="function">gdk_display_get_pointer()</code></a> that strips
576
503
out any un-declared modifier flags, to make gjs happy; see
577
504
https://bugzilla.gnome.org/show_bug.cgi?id=597292.
578
505
</p>
607
534
</div>
608
535
<hr>
609
536
<div class="refsect2">
610
 
<a name="shell-global-gc"></a><h3>shell_global_gc ()</h3>
611
 
<pre class="programlisting"><span class="returnvalue">void</span>                shell_global_gc                     (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>);</pre>
612
 
<p>
613
 
Start a garbage collection process.  For more information, see
614
 
https://developer.mozilla.org/En/JS_GC
615
 
</p>
616
 
<div class="variablelist"><table border="0" class="variablelist">
617
 
<colgroup>
618
 
<col align="left" valign="top">
619
 
<col>
620
 
</colgroup>
621
 
<tbody><tr>
622
 
<td><p><span class="term"><em class="parameter"><code>global</code></em> :</span></p></td>
623
 
<td>A <span class="type">ShellGlobal</span>
624
 
</td>
625
 
</tr></tbody>
626
 
</table></div>
627
 
</div>
628
 
<hr>
629
 
<div class="refsect2">
630
 
<a name="shell-global-maybe-gc"></a><h3>shell_global_maybe_gc ()</h3>
631
 
<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>
632
 
<p>
633
 
Start a garbage collection process when it would free up enough memory
634
 
to be worth the amount of time it would take
635
 
https://developer.mozilla.org/en/SpiderMonkey/JSAPI_Reference/JS_MaybeGC
636
 
</p>
637
 
<div class="variablelist"><table border="0" class="variablelist">
638
 
<colgroup>
639
 
<col align="left" valign="top">
640
 
<col>
641
 
</colgroup>
642
 
<tbody><tr>
643
 
<td><p><span class="term"><em class="parameter"><code>global</code></em> :</span></p></td>
644
 
<td>A <span class="type">ShellGlobal</span>
645
 
</td>
646
 
</tr></tbody>
647
 
</table></div>
648
 
</div>
649
 
<hr>
650
 
<div class="refsect2">
651
 
<a name="ShellMemoryInfo"></a><h3>ShellMemoryInfo</h3>
652
 
<pre class="programlisting">typedef struct {
653
 
  guint glibc_uordblks;
654
 
 
655
 
  guint js_bytes;
656
 
 
657
 
  guint gjs_boxed;
658
 
  guint gjs_gobject;
659
 
  guint gjs_function;
660
 
  guint gjs_closure;
661
 
 
662
 
  /* 32 bit to avoid js conversion problems with 64 bit */
663
 
  guint  last_gc_seconds_ago;
664
 
} ShellMemoryInfo;
665
 
</pre>
666
 
</div>
667
 
<hr>
668
 
<div class="refsect2">
669
 
<a name="shell-global-get-memory-info"></a><h3>shell_global_get_memory_info ()</h3>
670
 
<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>,
671
 
                                                         <em class="parameter"><code><a class="link" href="shell-ShellGlobal.html#ShellMemoryInfo" title="ShellMemoryInfo"><span class="type">ShellMemoryInfo</span></a> *meminfo</code></em>);</pre>
672
 
<p>
673
 
Load process-global data about memory usage.
674
 
</p>
675
 
<div class="variablelist"><table border="0" class="variablelist">
676
 
<colgroup>
677
 
<col align="left" valign="top">
678
 
<col>
679
 
</colgroup>
680
 
<tbody><tr>
681
 
<td><p><span class="term"><em class="parameter"><code>meminfo</code></em> :</span></p></td>
682
 
<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>
683
 
</td>
684
 
</tr></tbody>
685
 
</table></div>
686
 
</div>
687
 
<hr>
688
 
<div class="refsect2">
689
 
<a name="shell-global-begin-work"></a><h3>shell_global_begin_work ()</h3>
690
 
<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>
691
 
<p>
692
 
Marks that we are currently doing work. This is used to to track
693
 
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>.
694
 
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
695
 
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>.
696
 
</p>
697
 
<div class="variablelist"><table border="0" class="variablelist">
698
 
<colgroup>
699
 
<col align="left" valign="top">
700
 
<col>
701
 
</colgroup>
702
 
<tbody><tr>
703
 
<td><p><span class="term"><em class="parameter"><code>global</code></em> :</span></p></td>
704
 
<td>the <span class="type">ShellGlobal</span>
705
 
</td>
706
 
</tr></tbody>
707
 
</table></div>
708
 
</div>
709
 
<hr>
710
 
<div class="refsect2">
711
 
<a name="shell-global-end-work"></a><h3>shell_global_end_work ()</h3>
712
 
<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>
713
 
<p>
714
 
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>.
715
 
If no other work is ongoing and functions have been added with
716
 
<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
717
 
opportunity.
718
 
</p>
719
 
<div class="variablelist"><table border="0" class="variablelist">
720
 
<colgroup>
721
 
<col align="left" valign="top">
722
 
<col>
723
 
</colgroup>
724
 
<tbody><tr>
725
 
<td><p><span class="term"><em class="parameter"><code>global</code></em> :</span></p></td>
726
 
<td>the <span class="type">ShellGlobal</span>
727
 
</td>
728
 
</tr></tbody>
729
 
</table></div>
730
 
</div>
731
 
<hr>
732
 
<div class="refsect2">
733
 
<a name="ShellLeisureFunction"></a><h3>ShellLeisureFunction ()</h3>
734
 
<pre class="programlisting"><span class="returnvalue">void</span>                (*ShellLeisureFunction)             (<em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre>
 
537
<a name="shell-global-get-screen"></a><h3>shell_global_get_screen ()</h3>
 
538
<pre class="programlisting"><a href="http://developer.gnome.org/meta/MetaScreen.html"><span class="returnvalue">MetaScreen</span></a> *        shell_global_get_screen             (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>);</pre>
 
539
<div class="variablelist"><table border="0" class="variablelist">
 
540
<colgroup>
 
541
<col align="left" valign="top">
 
542
<col>
 
543
</colgroup>
 
544
<tbody><tr>
 
545
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
546
<td>The default <a href="http://developer.gnome.org/meta/MetaScreen.html"><span class="type">MetaScreen</span></a>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 
547
</td>
 
548
</tr></tbody>
 
549
</table></div>
 
550
</div>
 
551
<hr>
 
552
<div class="refsect2">
 
553
<a name="shell-global-get-session-mode"></a><h3>shell_global_get_session_mode ()</h3>
 
554
<pre class="programlisting">const <span class="returnvalue">char</span> *        shell_global_get_session_mode       (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>);</pre>
 
555
</div>
 
556
<hr>
 
557
<div class="refsect2">
 
558
<a name="shell-global-get-settings"></a><h3>shell_global_get_settings ()</h3>
 
559
<pre class="programlisting"><a href="http://library.gnome.org/devel/gio/unstable/GSettings.html"><span class="returnvalue">GSettings</span></a> *         shell_global_get_settings           (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>);</pre>
 
560
<p>
 
561
Get the global GSettings instance.
 
562
</p>
 
563
<div class="variablelist"><table border="0" class="variablelist">
 
564
<colgroup>
 
565
<col align="left" valign="top">
 
566
<col>
 
567
</colgroup>
 
568
<tbody>
 
569
<tr>
 
570
<td><p><span class="term"><em class="parameter"><code>global</code></em> :</span></p></td>
 
571
<td>A <span class="type">ShellGlobal</span>
 
572
</td>
 
573
</tr>
 
574
<tr>
 
575
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
576
<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>
 
577
</td>
 
578
</tr>
 
579
</tbody>
 
580
</table></div>
 
581
</div>
 
582
<hr>
 
583
<div class="refsect2">
 
584
<a name="shell-global-get-stage"></a><h3>shell_global_get_stage ()</h3>
 
585
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/clutter/ClutterStage.html"><span class="returnvalue">ClutterStage</span></a> *      shell_global_get_stage              (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>);</pre>
 
586
<div class="variablelist"><table border="0" class="variablelist">
 
587
<colgroup>
 
588
<col align="left" valign="top">
 
589
<col>
 
590
</colgroup>
 
591
<tbody><tr>
 
592
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
593
<td>The default <a href="/usr/share/gtk-doc/html/clutter/ClutterStage.html"><span class="type">ClutterStage</span></a>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 
594
</td>
 
595
</tr></tbody>
 
596
</table></div>
 
597
</div>
 
598
<hr>
 
599
<div class="refsect2">
 
600
<a name="shell-global-get-window-actors"></a><h3>shell_global_get_window_actors ()</h3>
 
601
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *             shell_global_get_window_actors      (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>);</pre>
 
602
<p>
 
603
Gets the list of <a href="http://developer.gnome.org/meta/MetaWindowActor.html"><span class="type">MetaWindowActor</span></a> for the plugin's screen
 
604
</p>
 
605
<div class="variablelist"><table border="0" class="variablelist">
 
606
<colgroup>
 
607
<col align="left" valign="top">
 
608
<col>
 
609
</colgroup>
 
610
<tbody><tr>
 
611
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
612
<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>
 
613
</td>
 
614
</tr></tbody>
 
615
</table></div>
 
616
</div>
 
617
<hr>
 
618
<div class="refsect2">
 
619
<a name="shell-global-init-xdnd"></a><h3>shell_global_init_xdnd ()</h3>
 
620
<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>
 
621
<p>
 
622
Enables tracking of Xdnd events
 
623
</p>
 
624
<div class="variablelist"><table border="0" class="variablelist">
 
625
<colgroup>
 
626
<col align="left" valign="top">
 
627
<col>
 
628
</colgroup>
 
629
<tbody><tr>
 
630
<td><p><span class="term"><em class="parameter"><code>global</code></em> :</span></p></td>
 
631
<td>the <span class="type">ShellGlobal</span>
 
632
</td>
 
633
</tr></tbody>
 
634
</table></div>
 
635
</div>
 
636
<hr>
 
637
<div class="refsect2">
 
638
<a name="shell-global-notify-error"></a><h3>shell_global_notify_error ()</h3>
 
639
<pre class="programlisting"><span class="returnvalue">void</span>                shell_global_notify_error           (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>,
 
640
                                                         <em class="parameter"><code>const <span class="type">char</span> *msg</code></em>,
 
641
                                                         <em class="parameter"><code>const <span class="type">char</span> *details</code></em>);</pre>
 
642
<p>
 
643
Show a system error notification.  Use this function
 
644
when a user-initiated action results in a non-fatal problem
 
645
from causes that may not be under system control.  For
 
646
example, an application crash.
 
647
</p>
 
648
<div class="variablelist"><table border="0" class="variablelist">
 
649
<colgroup>
 
650
<col align="left" valign="top">
 
651
<col>
 
652
</colgroup>
 
653
<tbody>
 
654
<tr>
 
655
<td><p><span class="term"><em class="parameter"><code>global</code></em> :</span></p></td>
 
656
<td>a <span class="type">ShellGlobal</span>
 
657
</td>
 
658
</tr>
 
659
<tr>
 
660
<td><p><span class="term"><em class="parameter"><code>msg</code></em> :</span></p></td>
 
661
<td>Error message</td>
 
662
</tr>
 
663
<tr>
 
664
<td><p><span class="term"><em class="parameter"><code>details</code></em> :</span></p></td>
 
665
<td>Error details</td>
 
666
</tr>
 
667
</tbody>
 
668
</table></div>
 
669
</div>
 
670
<hr>
 
671
<div class="refsect2">
 
672
<a name="shell-global-play-sound-file"></a><h3>shell_global_play_sound_file ()</h3>
 
673
<pre class="programlisting"><span class="returnvalue">void</span>                shell_global_play_sound_file        (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>,
 
674
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> id</code></em>,
 
675
                                                         <em class="parameter"><code>const <span class="type">char</span> *file_name</code></em>,
 
676
                                                         <em class="parameter"><code>const <span class="type">char</span> *description</code></em>,
 
677
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/clutter/clutter-Events.html#ClutterEvent"><span class="type">ClutterEvent</span></a> *for_event</code></em>);</pre>
 
678
<p>
 
679
Like <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>, but with an explicit path
 
680
instead of a themed sound.
 
681
</p>
 
682
<div class="variablelist"><table border="0" class="variablelist">
 
683
<colgroup>
 
684
<col align="left" valign="top">
 
685
<col>
 
686
</colgroup>
 
687
<tbody>
 
688
<tr>
 
689
<td><p><span class="term"><em class="parameter"><code>global</code></em> :</span></p></td>
 
690
<td>the <span class="type">ShellGlobal</span>
 
691
</td>
 
692
</tr>
 
693
<tr>
 
694
<td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td>
 
695
<td>an id, used to cancel later (0 if not needed)</td>
 
696
</tr>
 
697
<tr>
 
698
<td><p><span class="term"><em class="parameter"><code>file_name</code></em> :</span></p></td>
 
699
<td>the file name to play</td>
 
700
</tr>
 
701
<tr>
 
702
<td><p><span class="term"><em class="parameter"><code>description</code></em> :</span></p></td>
 
703
<td>the localized description of the event that triggered this alert</td>
 
704
</tr>
 
705
<tr>
 
706
<td><p><span class="term"><em class="parameter"><code>for_event</code></em> :</span></p></td>
 
707
<td>a <a href="/usr/share/gtk-doc/html/clutter/clutter-Events.html#ClutterEvent"><span class="type">ClutterEvent</span></a> in response to which the sound is played. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 
708
</td>
 
709
</tr>
 
710
</tbody>
 
711
</table></div>
 
712
</div>
 
713
<hr>
 
714
<div class="refsect2">
 
715
<a name="shell-global-play-sound-file-full"></a><h3>shell_global_play_sound_file_full ()</h3>
 
716
<pre class="programlisting"><span class="returnvalue">void</span>                shell_global_play_sound_file_full   (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>,
 
717
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> id</code></em>,
 
718
                                                         <em class="parameter"><code>const <span class="type">char</span> *file_name</code></em>,
 
719
                                                         <em class="parameter"><code>const <span class="type">char</span> *description</code></em>,
 
720
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/clutter/clutter-Events.html#ClutterEvent"><span class="type">ClutterEvent</span></a> *for_event</code></em>,
 
721
                                                         <em class="parameter"><code>const <span class="type">char</span> *application_id</code></em>,
 
722
                                                         <em class="parameter"><code>const <span class="type">char</span> *application_name</code></em>);</pre>
 
723
<p>
 
724
Like <a class="link" href="shell-ShellGlobal.html#shell-global-play-theme-sound-full" title="shell_global_play_theme_sound_full ()"><code class="function">shell_global_play_theme_sound_full()</code></a>, but with an explicit path
 
725
instead of a themed sound.
 
726
</p>
 
727
<div class="variablelist"><table border="0" class="variablelist">
 
728
<colgroup>
 
729
<col align="left" valign="top">
 
730
<col>
 
731
</colgroup>
 
732
<tbody>
 
733
<tr>
 
734
<td><p><span class="term"><em class="parameter"><code>global</code></em> :</span></p></td>
 
735
<td>the <span class="type">ShellGlobal</span>
 
736
</td>
 
737
</tr>
 
738
<tr>
 
739
<td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td>
 
740
<td>an id, used to cancel later (0 if not needed)</td>
 
741
</tr>
 
742
<tr>
 
743
<td><p><span class="term"><em class="parameter"><code>file_name</code></em> :</span></p></td>
 
744
<td>the file name to play</td>
 
745
</tr>
 
746
<tr>
 
747
<td><p><span class="term"><em class="parameter"><code>description</code></em> :</span></p></td>
 
748
<td>the localized description of the event that triggered this alert</td>
 
749
</tr>
 
750
<tr>
 
751
<td><p><span class="term"><em class="parameter"><code>for_event</code></em> :</span></p></td>
 
752
<td>a <a href="/usr/share/gtk-doc/html/clutter/clutter-Events.html#ClutterEvent"><span class="type">ClutterEvent</span></a> in response to which the sound is played. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 
753
</td>
 
754
</tr>
 
755
<tr>
 
756
<td><p><span class="term"><em class="parameter"><code>application_id</code></em> :</span></p></td>
 
757
<td>application on behalf of which the sound is played</td>
 
758
</tr>
 
759
</tbody>
 
760
</table></div>
 
761
</div>
 
762
<hr>
 
763
<div class="refsect2">
 
764
<a name="shell-global-play-theme-sound"></a><h3>shell_global_play_theme_sound ()</h3>
 
765
<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>,
 
766
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> id</code></em>,
 
767
                                                         <em class="parameter"><code>const <span class="type">char</span> *name</code></em>,
 
768
                                                         <em class="parameter"><code>const <span class="type">char</span> *description</code></em>,
 
769
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/clutter/clutter-Events.html#ClutterEvent"><span class="type">ClutterEvent</span></a> *for_event</code></em>);</pre>
 
770
<p>
 
771
Plays a simple sound picked according to Freedesktop sound theme.
 
772
Really just a workaround for libcanberra not being introspected.
 
773
</p>
 
774
<div class="variablelist"><table border="0" class="variablelist">
 
775
<colgroup>
 
776
<col align="left" valign="top">
 
777
<col>
 
778
</colgroup>
 
779
<tbody>
 
780
<tr>
 
781
<td><p><span class="term"><em class="parameter"><code>global</code></em> :</span></p></td>
 
782
<td>the <span class="type">ShellGlobal</span>
 
783
</td>
 
784
</tr>
 
785
<tr>
 
786
<td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td>
 
787
<td>an id, used to cancel later (0 if not needed)</td>
 
788
</tr>
 
789
<tr>
 
790
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
 
791
<td>the sound name</td>
 
792
</tr>
 
793
<tr>
 
794
<td><p><span class="term"><em class="parameter"><code>for_event</code></em> :</span></p></td>
 
795
<td>a <a href="/usr/share/gtk-doc/html/clutter/clutter-Events.html#ClutterEvent"><span class="type">ClutterEvent</span></a> in response to which the sound is played. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 
796
</td>
 
797
</tr>
 
798
</tbody>
 
799
</table></div>
 
800
</div>
 
801
<hr>
 
802
<div class="refsect2">
 
803
<a name="shell-global-play-theme-sound-full"></a><h3>shell_global_play_theme_sound_full ()</h3>
 
804
<pre class="programlisting"><span class="returnvalue">void</span>                shell_global_play_theme_sound_full  (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>,
 
805
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> id</code></em>,
 
806
                                                         <em class="parameter"><code>const <span class="type">char</span> *name</code></em>,
 
807
                                                         <em class="parameter"><code>const <span class="type">char</span> *description</code></em>,
 
808
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/clutter/clutter-Events.html#ClutterEvent"><span class="type">ClutterEvent</span></a> *for_event</code></em>,
 
809
                                                         <em class="parameter"><code>const <span class="type">char</span> *application_id</code></em>,
 
810
                                                         <em class="parameter"><code>const <span class="type">char</span> *application_name</code></em>);</pre>
 
811
<p>
 
812
Plays a simple sound picked according to Freedesktop sound theme.
 
813
Really just a workaround for libcanberra not being introspected.
 
814
</p>
 
815
<div class="variablelist"><table border="0" class="variablelist">
 
816
<colgroup>
 
817
<col align="left" valign="top">
 
818
<col>
 
819
</colgroup>
 
820
<tbody>
 
821
<tr>
 
822
<td><p><span class="term"><em class="parameter"><code>global</code></em> :</span></p></td>
 
823
<td>the <span class="type">ShellGlobal</span>
 
824
</td>
 
825
</tr>
 
826
<tr>
 
827
<td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td>
 
828
<td>an id, used to cancel later (0 if not needed)</td>
 
829
</tr>
 
830
<tr>
 
831
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
 
832
<td>the sound name</td>
 
833
</tr>
 
834
<tr>
 
835
<td><p><span class="term"><em class="parameter"><code>description</code></em> :</span></p></td>
 
836
<td>the localized description of the event that triggered this alert</td>
 
837
</tr>
 
838
<tr>
 
839
<td><p><span class="term"><em class="parameter"><code>for_event</code></em> :</span></p></td>
 
840
<td>a <a href="/usr/share/gtk-doc/html/clutter/clutter-Events.html#ClutterEvent"><span class="type">ClutterEvent</span></a> in response to which the sound is played. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 
841
</td>
 
842
</tr>
 
843
<tr>
 
844
<td><p><span class="term"><em class="parameter"><code>application_id</code></em> :</span></p></td>
 
845
<td>application on behalf of which the sound is played</td>
 
846
</tr>
 
847
</tbody>
 
848
</table></div>
 
849
</div>
 
850
<hr>
 
851
<div class="refsect2">
 
852
<a name="shell-global-reexec-self"></a><h3>shell_global_reexec_self ()</h3>
 
853
<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>
 
854
<p>
 
855
Restart the current process.  Only intended for development purposes.
 
856
</p>
 
857
<div class="variablelist"><table border="0" class="variablelist">
 
858
<colgroup>
 
859
<col align="left" valign="top">
 
860
<col>
 
861
</colgroup>
 
862
<tbody><tr>
 
863
<td><p><span class="term"><em class="parameter"><code>global</code></em> :</span></p></td>
 
864
<td>A <span class="type">ShellGlobal</span>
 
865
</td>
 
866
</tr></tbody>
 
867
</table></div>
735
868
</div>
736
869
<hr>
737
870
<div class="refsect2">
738
871
<a name="shell-global-run-at-leisure"></a><h3>shell_global_run_at_leisure ()</h3>
739
872
<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>,
740
873
                                                         <em class="parameter"><code><a class="link" href="shell-ShellGlobal.html#ShellLeisureFunction" title="ShellLeisureFunction ()"><span class="type">ShellLeisureFunction</span></a> func</code></em>,
741
 
                                                         <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>,
742
 
                                                         <em class="parameter"><code><span class="type">GDestroyNotify</span> notify</code></em>);</pre>
 
874
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>,
 
875
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> notify</code></em>);</pre>
743
876
<p>
744
877
Schedules a function to be called the next time the shell is idle.
745
878
Idle means here no animations, no redrawing, and no ongoing background
787
920
</div>
788
921
<hr>
789
922
<div class="refsect2">
 
923
<a name="shell-global-set-cursor"></a><h3>shell_global_set_cursor ()</h3>
 
924
<pre class="programlisting"><span class="returnvalue">void</span>                shell_global_set_cursor             (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>,
 
925
                                                         <em class="parameter"><code><a class="link" href="shell-ShellGlobal.html#ShellCursor"><span class="type">ShellCursor</span></a> type</code></em>);</pre>
 
926
<p>
 
927
Set the cursor on the stage window.
 
928
</p>
 
929
<div class="variablelist"><table border="0" class="variablelist">
 
930
<colgroup>
 
931
<col align="left" valign="top">
 
932
<col>
 
933
</colgroup>
 
934
<tbody>
 
935
<tr>
 
936
<td><p><span class="term"><em class="parameter"><code>global</code></em> :</span></p></td>
 
937
<td>A <span class="type">ShellGlobal</span>
 
938
</td>
 
939
</tr>
 
940
<tr>
 
941
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
 
942
<td>the type of the cursor</td>
 
943
</tr>
 
944
</tbody>
 
945
</table></div>
 
946
</div>
 
947
<hr>
 
948
<div class="refsect2">
 
949
<a name="shell-global-set-stage-input-mode"></a><h3>shell_global_set_stage_input_mode ()</h3>
 
950
<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>,
 
951
                                                         <em class="parameter"><code><a class="link" href="shell-ShellGlobal.html#ShellStageInputMode"><span class="type">ShellStageInputMode</span></a> mode</code></em>);</pre>
 
952
<p>
 
953
Sets the input mode of the stage; when <em class="parameter"><code>mode</code></em> is
 
954
<a class="link" href="shell-ShellGlobal.html#SHELL-STAGE-INPUT-MODE-NONREACTIVE:CAPS"><code class="literal">SHELL_STAGE_INPUT_MODE_NONREACTIVE</code></a>, then the stage does not absorb
 
955
any clicks, but just passes them through to underlying windows.
 
956
When it is <a class="link" href="shell-ShellGlobal.html#SHELL-STAGE-INPUT-MODE-NORMAL:CAPS"><code class="literal">SHELL_STAGE_INPUT_MODE_NORMAL</code></a>, then the stage accepts
 
957
clicks in the region defined by
 
958
<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
 
959
outside that region. When it is <a class="link" href="shell-ShellGlobal.html#SHELL-STAGE-INPUT-MODE-FULLSCREEN:CAPS"><code class="literal">SHELL_STAGE_INPUT_MODE_FULLSCREEN</code></a>,
 
960
the stage absorbs all input.
 
961
</p>
 
962
<p>
 
963
When the input mode is <a class="link" href="shell-ShellGlobal.html#SHELL-STAGE-INPUT-MODE-FOCUSED:CAPS"><code class="literal">SHELL_STAGE_INPUT_MODE_FOCUSED</code></a>, the pointer
 
964
is handled as with <a class="link" href="shell-ShellGlobal.html#SHELL-STAGE-INPUT-MODE-NORMAL:CAPS"><code class="literal">SHELL_STAGE_INPUT_MODE_NORMAL</code></a>, but additionally
 
965
the stage window has the keyboard focus. If the stage loses the
 
966
focus (eg, because the user clicked into a window) the input mode
 
967
will revert to <a class="link" href="shell-ShellGlobal.html#SHELL-STAGE-INPUT-MODE-NORMAL:CAPS"><code class="literal">SHELL_STAGE_INPUT_MODE_NORMAL</code></a>.
 
968
</p>
 
969
<p>
 
970
Note that whenever a mutter-internal Gtk widget has a pointer grab,
 
971
the shell behaves as though it was in
 
972
<a class="link" href="shell-ShellGlobal.html#SHELL-STAGE-INPUT-MODE-NONREACTIVE:CAPS"><code class="literal">SHELL_STAGE_INPUT_MODE_NONREACTIVE</code></a>, to ensure that the widget gets
 
973
any clicks it is expecting.
 
974
</p>
 
975
<div class="variablelist"><table border="0" class="variablelist">
 
976
<colgroup>
 
977
<col align="left" valign="top">
 
978
<col>
 
979
</colgroup>
 
980
<tbody>
 
981
<tr>
 
982
<td><p><span class="term"><em class="parameter"><code>global</code></em> :</span></p></td>
 
983
<td>the <span class="type">ShellGlobal</span>
 
984
</td>
 
985
</tr>
 
986
<tr>
 
987
<td><p><span class="term"><em class="parameter"><code>mode</code></em> :</span></p></td>
 
988
<td>the stage input mode</td>
 
989
</tr>
 
990
</tbody>
 
991
</table></div>
 
992
</div>
 
993
<hr>
 
994
<div class="refsect2">
 
995
<a name="shell-global-set-stage-input-region"></a><h3>shell_global_set_stage_input_region ()</h3>
 
996
<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>,
 
997
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> *rectangles</code></em>);</pre>
 
998
<p>
 
999
Sets the area of the stage that is responsive to mouse clicks when
 
1000
the stage mode is <a class="link" href="shell-ShellGlobal.html#SHELL-STAGE-INPUT-MODE-NORMAL:CAPS"><code class="literal">SHELL_STAGE_INPUT_MODE_NORMAL</code></a> (but does not change the
 
1001
current stage mode).
 
1002
</p>
 
1003
<div class="variablelist"><table border="0" class="variablelist">
 
1004
<colgroup>
 
1005
<col align="left" valign="top">
 
1006
<col>
 
1007
</colgroup>
 
1008
<tbody>
 
1009
<tr>
 
1010
<td><p><span class="term"><em class="parameter"><code>global</code></em> :</span></p></td>
 
1011
<td>the <span class="type">ShellGlobal</span>
 
1012
</td>
 
1013
</tr>
 
1014
<tr>
 
1015
<td><p><span class="term"><em class="parameter"><code>rectangles</code></em> :</span></p></td>
 
1016
<td>a list of <a href="http://developer.gnome.org/meta/MetaRectangle.html"><span class="type">MetaRectangle</span></a>
 
1017
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>
 
1018
</td>
 
1019
</tr>
 
1020
</tbody>
 
1021
</table></div>
 
1022
</div>
 
1023
<hr>
 
1024
<div class="refsect2">
790
1025
<a name="shell-global-sync-pointer"></a><h3>shell_global_sync_pointer ()</h3>
791
1026
<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>
792
1027
<p>
808
1043
</div>
809
1044
<hr>
810
1045
<div class="refsect2">
811
 
<a name="shell-global-create-app-launch-context"></a><h3>shell_global_create_app_launch_context ()</h3>
812
 
<pre class="programlisting"><span class="returnvalue">GAppLaunchContext</span> * shell_global_create_app_launch_context
813
 
                                                        (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>);</pre>
814
 
<p>
815
 
Create a <span class="type">GAppLaunchContext</span> set up with the correct timestamp, and
816
 
targeted to activate on the current workspace.
817
 
</p>
818
 
<div class="variablelist"><table border="0" class="variablelist">
819
 
<colgroup>
820
 
<col align="left" valign="top">
821
 
<col>
822
 
</colgroup>
823
 
<tbody>
824
 
<tr>
825
 
<td><p><span class="term"><em class="parameter"><code>global</code></em> :</span></p></td>
826
 
<td>A <span class="type">ShellGlobal</span>
827
 
</td>
828
 
</tr>
829
 
<tr>
830
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
831
 
<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>
832
 
</td>
833
 
</tr>
834
 
</tbody>
835
 
</table></div>
836
 
</div>
837
 
<hr>
838
 
<div class="refsect2">
839
 
<a name="shell-global-play-theme-sound"></a><h3>shell_global_play_theme_sound ()</h3>
840
 
<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>,
841
 
                                                         <em class="parameter"><code><span class="type">guint</span> id</code></em>,
842
 
                                                         <em class="parameter"><code>const <span class="type">char</span> *name</code></em>);</pre>
843
 
<p>
844
 
Plays a simple sound picked according to Freedesktop sound theme.
845
 
Really just a workaround for libcanberra not being introspected.
846
 
</p>
847
 
<div class="variablelist"><table border="0" class="variablelist">
848
 
<colgroup>
849
 
<col align="left" valign="top">
850
 
<col>
851
 
</colgroup>
852
 
<tbody>
853
 
<tr>
854
 
<td><p><span class="term"><em class="parameter"><code>global</code></em> :</span></p></td>
855
 
<td>the <span class="type">ShellGlobal</span>
856
 
</td>
857
 
</tr>
858
 
<tr>
859
 
<td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td>
860
 
<td>an id, used to cancel later (0 if not needed)</td>
861
 
</tr>
862
 
<tr>
863
 
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
864
 
<td>the sound name</td>
865
 
</tr>
866
 
</tbody>
867
 
</table></div>
868
 
</div>
869
 
<hr>
870
 
<div class="refsect2">
871
 
<a name="shell-global-cancel-theme-sound"></a><h3>shell_global_cancel_theme_sound ()</h3>
872
 
<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>,
873
 
                                                         <em class="parameter"><code><span class="type">guint</span> id</code></em>);</pre>
874
 
<p>
875
 
Cancels a sound notification.
876
 
</p>
877
 
<div class="variablelist"><table border="0" class="variablelist">
878
 
<colgroup>
879
 
<col align="left" valign="top">
880
 
<col>
881
 
</colgroup>
882
 
<tbody>
883
 
<tr>
884
 
<td><p><span class="term"><em class="parameter"><code>global</code></em> :</span></p></td>
885
 
<td>the <span class="type">ShellGlobal</span>
886
 
</td>
887
 
</tr>
888
 
<tr>
889
 
<td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td>
890
 
<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>
891
 
</td>
892
 
</tr>
893
 
</tbody>
894
 
</table></div>
895
 
</div>
896
 
<hr>
897
 
<div class="refsect2">
898
 
<a name="shell-global-notify-error"></a><h3>shell_global_notify_error ()</h3>
899
 
<pre class="programlisting"><span class="returnvalue">void</span>                shell_global_notify_error           (<em class="parameter"><code><span class="type">ShellGlobal</span> *global</code></em>,
900
 
                                                         <em class="parameter"><code>const <span class="type">char</span> *msg</code></em>,
901
 
                                                         <em class="parameter"><code>const <span class="type">char</span> *details</code></em>);</pre>
902
 
<p>
903
 
Show a system error notification.  Use this function
904
 
when a user-initiated action results in a non-fatal problem
905
 
from causes that may not be under system control.  For
906
 
example, an application crash.
907
 
</p>
908
 
<div class="variablelist"><table border="0" class="variablelist">
909
 
<colgroup>
910
 
<col align="left" valign="top">
911
 
<col>
912
 
</colgroup>
913
 
<tbody>
914
 
<tr>
915
 
<td><p><span class="term"><em class="parameter"><code>global</code></em> :</span></p></td>
916
 
<td>a <span class="type">ShellGlobal</span>
917
 
</td>
918
 
</tr>
919
 
<tr>
920
 
<td><p><span class="term"><em class="parameter"><code>msg</code></em> :</span></p></td>
921
 
<td>Error message</td>
922
 
</tr>
923
 
<tr>
924
 
<td><p><span class="term"><em class="parameter"><code>details</code></em> :</span></p></td>
925
 
<td>Error details</td>
926
 
</tr>
927
 
</tbody>
928
 
</table></div>
929
 
</div>
930
 
<hr>
931
 
<div class="refsect2">
932
 
<a name="shell-global-init-xdnd"></a><h3>shell_global_init_xdnd ()</h3>
933
 
<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>
934
 
<p>
935
 
Enables tracking of Xdnd events
936
 
</p>
937
 
<div class="variablelist"><table border="0" class="variablelist">
938
 
<colgroup>
939
 
<col align="left" valign="top">
940
 
<col>
941
 
</colgroup>
942
 
<tbody><tr>
943
 
<td><p><span class="term"><em class="parameter"><code>global</code></em> :</span></p></td>
944
 
<td>the <span class="type">ShellGlobal</span>
945
 
</td>
946
 
</tr></tbody>
947
 
</table></div>
948
 
</div>
949
 
<hr>
950
 
<div class="refsect2">
951
 
<a name="shell-global-reexec-self"></a><h3>shell_global_reexec_self ()</h3>
952
 
<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>
953
 
<p>
954
 
Restart the current process.  Only intended for development purposes.
955
 
</p>
956
 
<div class="variablelist"><table border="0" class="variablelist">
957
 
<colgroup>
958
 
<col align="left" valign="top">
959
 
<col>
960
 
</colgroup>
961
 
<tbody><tr>
962
 
<td><p><span class="term"><em class="parameter"><code>global</code></em> :</span></p></td>
963
 
<td>A <span class="type">ShellGlobal</span>
964
 
</td>
965
 
</tr></tbody>
966
 
</table></div>
967
 
</div>
968
 
<hr>
969
 
<div class="refsect2">
970
 
<a name="shell-global-launch-calendar-server"></a><h3>shell_global_launch_calendar_server ()</h3>
971
 
<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>
972
 
<p>
973
 
Launch the gnome-shell-calendar-server helper.
974
 
</p>
975
 
<div class="variablelist"><table border="0" class="variablelist">
976
 
<colgroup>
977
 
<col align="left" valign="top">
978
 
<col>
979
 
</colgroup>
980
 
<tbody><tr>
981
 
<td><p><span class="term"><em class="parameter"><code>global</code></em> :</span></p></td>
982
 
<td>The <span class="type">ShellGlobal</span>.</td>
983
 
</tr></tbody>
984
 
</table></div>
985
 
</div>
986
 
<hr>
987
 
<div class="refsect2">
988
 
<a name="ShellSessionType-enum"></a><h3>enum ShellSessionType</h3>
989
 
<pre class="programlisting">typedef enum {
990
 
  SHELL_SESSION_USER,
991
 
  SHELL_SESSION_GDM
992
 
} ShellSessionType;
993
 
</pre>
994
 
</div>
995
 
<hr>
996
 
<div class="refsect2">
997
 
<a name="shell-global-get-session-type"></a><h3>shell_global_get_session_type ()</h3>
998
 
<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>
999
 
<p>
1000
 
Gets the type of session gnome-shell provides.
1001
 
</p>
1002
 
<p>
1003
 
The type determines what UI elements are displayed,
1004
 
what keybindings work, and generally how the shell
1005
 
behaves.
1006
 
</p>
1007
 
<p>
1008
 
A session type of <span class="type">SHELL_SESSION_USER</span> means gnome-shell
1009
 
will enable the activities overview, status menu, run dialog,
1010
 
etc. This is the default.
1011
 
</p>
1012
 
<p>
1013
 
A session type of <span class="type">SHELL_SESSION_GDM</span> means gnome-shell
1014
 
will enable a login dialog and run in a more confined
1015
 
way. This type is suitable for the display manager.
1016
 
</p>
1017
 
<div class="variablelist"><table border="0" class="variablelist">
1018
 
<colgroup>
1019
 
<col align="left" valign="top">
1020
 
<col>
1021
 
</colgroup>
1022
 
<tbody>
1023
 
<tr>
1024
 
<td><p><span class="term"><em class="parameter"><code>global</code></em> :</span></p></td>
1025
 
<td>The <span class="type">ShellGlobal</span>.</td>
1026
 
</tr>
1027
 
<tr>
1028
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1029
 
<td>the type of session gnome-shell is providing.</td>
1030
 
</tr>
1031
 
</tbody>
 
1046
<a name="shell-global-unset-cursor"></a><h3>shell_global_unset_cursor ()</h3>
 
1047
<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>
 
1048
<p>
 
1049
Unset the cursor on the stage window.
 
1050
</p>
 
1051
<div class="variablelist"><table border="0" class="variablelist">
 
1052
<colgroup>
 
1053
<col align="left" valign="top">
 
1054
<col>
 
1055
</colgroup>
 
1056
<tbody><tr>
 
1057
<td><p><span class="term"><em class="parameter"><code>global</code></em> :</span></p></td>
 
1058
<td>A <span class="type">ShellGlobal</span>
 
1059
</td>
 
1060
</tr></tbody>
1032
1061
</table></div>
1033
1062
</div>
1034
1063
</div>
1035
1064
</div>
1036
1065
<div class="footer">
1037
1066
<hr>
1038
 
          Generated by GTK-Doc V1.18.1</div>
 
1067
          Generated by GTK-Doc V1.19</div>
1039
1068
</body>
1040
1069
</html>
 
 
b'\\ No newline at end of file'