← Back to branch summary

~ubuntu-branches/ubuntu/vivid/gnome-desktop3/vivid-proposed

« back to all changes in this revision

Viewing changes to docs/reference/gnome-desktop3/html/gnome-desktop3-gnome-bg.html

  • Committer: Bazaar Package Importer
  • Author(s): Robert Ancell
  • Date: 2011-04-11 10:52:59 UTC
  • mfrom: (1.2.7 upstream)
  • Revision ID: james.westby@ubuntu.com-20110411105259-hfckg71pp46uwaib
Tags: 3.0.0-0ubuntu1
New upstream release

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/gnome-desktop3/html/gnome-desktop3-gnome-bg.html
2
2
<html>
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
 
<title>gnome-bg</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
 
5
<title>GnomeBG</title>
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
7
7
<link rel="home" href="index.html" title="GNOME Desktop Library Reference Manual">
8
8
<link rel="up" href="background.html" title="Part II. Desktop Background">
9
9
<link rel="prev" href="background.html" title="Part II. Desktop Background">
10
10
<link rel="next" href="randr.html" title="Part III. Monitor Configuration">
11
 
<meta name="generator" content="GTK-Doc V1.17 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.16.1 (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">
34
34
<a name="gnome-desktop3-gnome-bg"></a><div class="titlepage"></div>
35
35
<div class="refnamediv"><table width="100%"><tr>
36
36
<td valign="top">
37
 
<h2><span class="refentrytitle"><a name="gnome-desktop3-gnome-bg.top_of_page"></a>gnome-bg</span></h2>
38
 
<p>gnome-bg</p>
 
37
<h2><span class="refentrytitle"><a name="gnome-desktop3-gnome-bg.top_of_page"></a>GnomeBG</span></h2>
 
38
<p>GnomeBG</p>
39
39
</td>
40
40
<td valign="top" align="right"></td>
41
41
</tr></table></div>
52
52
                                                         <em class="parameter"><code><span class="type">GDesktopBackgroundStyle</span> placement</code></em>);
53
53
<span class="returnvalue">void</span>                <a class="link" href="gnome-desktop3-gnome-bg.html#gnome-bg-set-color" title="gnome_bg_set_color ()">gnome_bg_set_color</a>                  (<em class="parameter"><code><a class="link" href="gnome-desktop3-gnome-bg.html#GnomeBG"><span class="type">GnomeBG</span></a> *bg</code></em>,
54
54
                                                         <em class="parameter"><code><span class="type">GDesktopBackgroundShading</span> type</code></em>,
55
 
                                                         <em class="parameter"><code><span class="type">GdkColor</span> *primary</code></em>,
56
 
                                                         <em class="parameter"><code><span class="type">GdkColor</span> *secondary</code></em>);
 
55
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gdk/gdk3-Colors.html#GdkColor"><span class="type">GdkColor</span></a> *primary</code></em>,
 
56
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gdk/gdk3-Colors.html#GdkColor"><span class="type">GdkColor</span></a> *secondary</code></em>);
57
57
<span class="returnvalue">void</span>                <a class="link" href="gnome-desktop3-gnome-bg.html#gnome-bg-set-draw-background" title="gnome_bg_set_draw_background ()">gnome_bg_set_draw_background</a>        (<em class="parameter"><code><a class="link" href="gnome-desktop3-gnome-bg.html#GnomeBG"><span class="type">GnomeBG</span></a> *bg</code></em>,
58
58
                                                         <em class="parameter"><code><span class="type">gboolean</span> draw_background</code></em>);
59
59
<span class="returnvalue">GDesktopBackgroundStyle</span>  <a class="link" href="gnome-desktop3-gnome-bg.html#gnome-bg-get-placement" title="gnome_bg_get_placement ()">gnome_bg_get_placement</a>         (<em class="parameter"><code><a class="link" href="gnome-desktop3-gnome-bg.html#GnomeBG"><span class="type">GnomeBG</span></a> *bg</code></em>);
60
60
<span class="returnvalue">gboolean</span>            <a class="link" href="gnome-desktop3-gnome-bg.html#gnome-bg-get-draw-background" title="gnome_bg_get_draw_background ()">gnome_bg_get_draw_background</a>        (<em class="parameter"><code><a class="link" href="gnome-desktop3-gnome-bg.html#GnomeBG"><span class="type">GnomeBG</span></a> *bg</code></em>);
61
61
<span class="returnvalue">void</span>                <a class="link" href="gnome-desktop3-gnome-bg.html#gnome-bg-get-color" title="gnome_bg_get_color ()">gnome_bg_get_color</a>                  (<em class="parameter"><code><a class="link" href="gnome-desktop3-gnome-bg.html#GnomeBG"><span class="type">GnomeBG</span></a> *bg</code></em>,
62
62
                                                         <em class="parameter"><code><span class="type">GDesktopBackgroundShading</span> *type</code></em>,
63
 
                                                         <em class="parameter"><code><span class="type">GdkColor</span> *primary</code></em>,
64
 
                                                         <em class="parameter"><code><span class="type">GdkColor</span> *secondary</code></em>);
 
63
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gdk/gdk3-Colors.html#GdkColor"><span class="type">GdkColor</span></a> *primary</code></em>,
 
64
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gdk/gdk3-Colors.html#GdkColor"><span class="type">GdkColor</span></a> *secondary</code></em>);
65
65
const <span class="returnvalue">gchar</span> *       <a class="link" href="gnome-desktop3-gnome-bg.html#gnome-bg-get-filename" title="gnome_bg_get_filename ()">gnome_bg_get_filename</a>               (<em class="parameter"><code><a class="link" href="gnome-desktop3-gnome-bg.html#GnomeBG"><span class="type">GnomeBG</span></a> *bg</code></em>);
66
66
<span class="returnvalue">void</span>                <a class="link" href="gnome-desktop3-gnome-bg.html#gnome-bg-draw" title="gnome_bg_draw ()">gnome_bg_draw</a>                       (<em class="parameter"><code><a class="link" href="gnome-desktop3-gnome-bg.html#GnomeBG"><span class="type">GnomeBG</span></a> *bg</code></em>,
67
67
                                                         <em class="parameter"><code><span class="type">GdkPixbuf</span> *dest</code></em>,
68
 
                                                         <em class="parameter"><code><span class="type">GdkScreen</span> *screen</code></em>,
 
68
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gdk/GdkScreen.html"><span class="type">GdkScreen</span></a> *screen</code></em>,
69
69
                                                         <em class="parameter"><code><span class="type">gboolean</span> is_root</code></em>);
70
 
<span class="returnvalue">cairo_surface_t</span> *   <a class="link" href="gnome-desktop3-gnome-bg.html#gnome-bg-create-surface" title="gnome_bg_create_surface ()">gnome_bg_create_surface</a>             (<em class="parameter"><code><a class="link" href="gnome-desktop3-gnome-bg.html#GnomeBG"><span class="type">GnomeBG</span></a> *bg</code></em>,
71
 
                                                         <em class="parameter"><code><span class="type">GdkWindow</span> *window</code></em>,
 
70
<a href="/gnome/usr/share/gtk-doc/html/cairo/cairo-cairo-surface-t.html#cairo-surface-t"><span class="returnvalue">cairo_surface_t</span></a> *   <a class="link" href="gnome-desktop3-gnome-bg.html#gnome-bg-create-surface" title="gnome_bg_create_surface ()">gnome_bg_create_surface</a>             (<em class="parameter"><code><a class="link" href="gnome-desktop3-gnome-bg.html#GnomeBG"><span class="type">GnomeBG</span></a> *bg</code></em>,
 
71
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gdk/gdk3-Windows.html#GdkWindow"><span class="type">GdkWindow</span></a> *window</code></em>,
72
72
                                                         <em class="parameter"><code><span class="type">int</span> width</code></em>,
73
73
                                                         <em class="parameter"><code><span class="type">int</span> height</code></em>,
74
74
                                                         <em class="parameter"><code><span class="type">gboolean</span> root</code></em>);
80
80
                                                         <em class="parameter"><code><span class="type">int</span> *height</code></em>);
81
81
<span class="returnvalue">GdkPixbuf</span> *         <a class="link" href="gnome-desktop3-gnome-bg.html#gnome-bg-create-thumbnail" title="gnome_bg_create_thumbnail ()">gnome_bg_create_thumbnail</a>           (<em class="parameter"><code><a class="link" href="gnome-desktop3-gnome-bg.html#GnomeBG"><span class="type">GnomeBG</span></a> *bg</code></em>,
82
82
                                                         <em class="parameter"><code><a class="link" href="GnomeDesktopThumbnailFactory.html" title="GnomeDesktopThumbnailFactory"><span class="type">GnomeDesktopThumbnailFactory</span></a> *factory</code></em>,
83
 
                                                         <em class="parameter"><code><span class="type">GdkScreen</span> *screen</code></em>,
 
83
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gdk/GdkScreen.html"><span class="type">GdkScreen</span></a> *screen</code></em>,
84
84
                                                         <em class="parameter"><code><span class="type">int</span> dest_width</code></em>,
85
85
                                                         <em class="parameter"><code><span class="type">int</span> dest_height</code></em>);
86
86
<span class="returnvalue">gboolean</span>            <a class="link" href="gnome-desktop3-gnome-bg.html#gnome-bg-is-dark" title="gnome_bg_is_dark ()">gnome_bg_is_dark</a>                    (<em class="parameter"><code><a class="link" href="gnome-desktop3-gnome-bg.html#GnomeBG"><span class="type">GnomeBG</span></a> *bg</code></em>,
90
90
<span class="returnvalue">gboolean</span>            <a class="link" href="gnome-desktop3-gnome-bg.html#gnome-bg-changes-with-time" title="gnome_bg_changes_with_time ()">gnome_bg_changes_with_time</a>          (<em class="parameter"><code><a class="link" href="gnome-desktop3-gnome-bg.html#GnomeBG"><span class="type">GnomeBG</span></a> *bg</code></em>);
91
91
<span class="returnvalue">GdkPixbuf</span> *         <a class="link" href="gnome-desktop3-gnome-bg.html#gnome-bg-create-frame-thumbnail" title="gnome_bg_create_frame_thumbnail ()">gnome_bg_create_frame_thumbnail</a>     (<em class="parameter"><code><a class="link" href="gnome-desktop3-gnome-bg.html#GnomeBG"><span class="type">GnomeBG</span></a> *bg</code></em>,
92
92
                                                         <em class="parameter"><code><a class="link" href="GnomeDesktopThumbnailFactory.html" title="GnomeDesktopThumbnailFactory"><span class="type">GnomeDesktopThumbnailFactory</span></a> *factory</code></em>,
93
 
                                                         <em class="parameter"><code><span class="type">GdkScreen</span> *screen</code></em>,
 
93
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gdk/GdkScreen.html"><span class="type">GdkScreen</span></a> *screen</code></em>,
94
94
                                                         <em class="parameter"><code><span class="type">int</span> dest_width</code></em>,
95
95
                                                         <em class="parameter"><code><span class="type">int</span> dest_height</code></em>,
96
96
                                                         <em class="parameter"><code><span class="type">int</span> frame_num</code></em>);
97
 
<span class="returnvalue">void</span>                <a class="link" href="gnome-desktop3-gnome-bg.html#gnome-bg-set-surface-as-root" title="gnome_bg_set_surface_as_root ()">gnome_bg_set_surface_as_root</a>        (<em class="parameter"><code><span class="type">GdkScreen</span> *screen</code></em>,
98
 
                                                         <em class="parameter"><code><span class="type">cairo_surface_t</span> *surface</code></em>);
 
97
<span class="returnvalue">void</span>                <a class="link" href="gnome-desktop3-gnome-bg.html#gnome-bg-set-surface-as-root" title="gnome_bg_set_surface_as_root ()">gnome_bg_set_surface_as_root</a>        (<em class="parameter"><code><a href="http://library.gnome.org/devel/gdk/GdkScreen.html"><span class="type">GdkScreen</span></a> *screen</code></em>,
 
98
                                                         <em class="parameter"><code><a href="/gnome/usr/share/gtk-doc/html/cairo/cairo-cairo-surface-t.html#cairo-surface-t"><span class="type">cairo_surface_t</span></a> *surface</code></em>);
99
99
<span class="returnvalue">GnomeBGCrossfade</span> *  <a class="link" href="gnome-desktop3-gnome-bg.html#gnome-bg-set-surface-as-root-with-crossfade" title="gnome_bg_set_surface_as_root_with_crossfade ()">gnome_bg_set_surface_as_root_with_crossfade</a>
100
 
                                                        (<em class="parameter"><code><span class="type">GdkScreen</span> *screen</code></em>,
101
 
                                                         <em class="parameter"><code><span class="type">cairo_surface_t</span> *surface</code></em>);
102
 
<span class="returnvalue">cairo_surface_t</span> *   <a class="link" href="gnome-desktop3-gnome-bg.html#gnome-bg-get-surface-from-root" title="gnome_bg_get_surface_from_root ()">gnome_bg_get_surface_from_root</a>      (<em class="parameter"><code><span class="type">GdkScreen</span> *screen</code></em>);
 
100
                                                        (<em class="parameter"><code><a href="http://library.gnome.org/devel/gdk/GdkScreen.html"><span class="type">GdkScreen</span></a> *screen</code></em>,
 
101
                                                         <em class="parameter"><code><a href="/gnome/usr/share/gtk-doc/html/cairo/cairo-cairo-surface-t.html#cairo-surface-t"><span class="type">cairo_surface_t</span></a> *surface</code></em>);
 
102
<a href="/gnome/usr/share/gtk-doc/html/cairo/cairo-cairo-surface-t.html#cairo-surface-t"><span class="returnvalue">cairo_surface_t</span></a> *   <a class="link" href="gnome-desktop3-gnome-bg.html#gnome-bg-get-surface-from-root" title="gnome_bg_get_surface_from_root ()">gnome_bg_get_surface_from_root</a>      (<em class="parameter"><code><a href="http://library.gnome.org/devel/gdk/GdkScreen.html"><span class="type">GdkScreen</span></a> *screen</code></em>);
103
103
                    <a class="link" href="gnome-desktop3-gnome-bg.html#GnomeBG-struct" title="GnomeBG">GnomeBG</a>;
104
104
                    <a class="link" href="gnome-desktop3-gnome-bg.html#GnomeBGClass" title="GnomeBGClass">GnomeBGClass</a>;
105
105
</pre>
107
107
<div class="refsect1">
108
108
<a name="gnome-desktop3-gnome-bg.object-hierarchy"></a><h2>Object Hierarchy</h2>
109
109
<pre class="synopsis">
110
 
  GObject
 
110
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
111
111
   +----GnomeBG
112
112
</pre>
113
113
</div>
114
114
<div class="refsect1">
115
115
<a name="gnome-desktop3-gnome-bg.signals"></a><h2>Signals</h2>
116
116
<pre class="synopsis">
117
 
  "<a class="link" href="gnome-desktop3-gnome-bg.html#GnomeBG-changed" title='The "changed" signal'>changed</a>"                                        : <code class="literal">Run Last</code>
118
 
  "<a class="link" href="gnome-desktop3-gnome-bg.html#GnomeBG-transitioned" title='The "transitioned" signal'>transitioned</a>"                                   : <code class="literal">Run Last</code>
 
117
  "<a class="link" href="gnome-desktop3-gnome-bg.html#GnomeBG-changed" title='The "changed" signal'>changed</a>"                                        : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
 
118
  "<a class="link" href="gnome-desktop3-gnome-bg.html#GnomeBG-transitioned" title='The "transitioned" signal'>transitioned</a>"                                   : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
119
119
</pre>
120
120
</div>
121
121
<div class="refsect1">
168
168
<a name="gnome-bg-set-color"></a><h3>gnome_bg_set_color ()</h3>
169
169
<pre class="programlisting"><span class="returnvalue">void</span>                gnome_bg_set_color                  (<em class="parameter"><code><a class="link" href="gnome-desktop3-gnome-bg.html#GnomeBG"><span class="type">GnomeBG</span></a> *bg</code></em>,
170
170
                                                         <em class="parameter"><code><span class="type">GDesktopBackgroundShading</span> type</code></em>,
171
 
                                                         <em class="parameter"><code><span class="type">GdkColor</span> *primary</code></em>,
172
 
                                                         <em class="parameter"><code><span class="type">GdkColor</span> *secondary</code></em>);</pre>
 
171
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gdk/gdk3-Colors.html#GdkColor"><span class="type">GdkColor</span></a> *primary</code></em>,
 
172
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gdk/gdk3-Colors.html#GdkColor"><span class="type">GdkColor</span></a> *secondary</code></em>);</pre>
173
173
<p>
174
174
</p>
175
175
</div>
200
200
<a name="gnome-bg-get-color"></a><h3>gnome_bg_get_color ()</h3>
201
201
<pre class="programlisting"><span class="returnvalue">void</span>                gnome_bg_get_color                  (<em class="parameter"><code><a class="link" href="gnome-desktop3-gnome-bg.html#GnomeBG"><span class="type">GnomeBG</span></a> *bg</code></em>,
202
202
                                                         <em class="parameter"><code><span class="type">GDesktopBackgroundShading</span> *type</code></em>,
203
 
                                                         <em class="parameter"><code><span class="type">GdkColor</span> *primary</code></em>,
204
 
                                                         <em class="parameter"><code><span class="type">GdkColor</span> *secondary</code></em>);</pre>
 
203
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gdk/gdk3-Colors.html#GdkColor"><span class="type">GdkColor</span></a> *primary</code></em>,
 
204
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gdk/gdk3-Colors.html#GdkColor"><span class="type">GdkColor</span></a> *secondary</code></em>);</pre>
205
205
<p>
206
206
</p>
207
207
</div>
217
217
<a name="gnome-bg-draw"></a><h3>gnome_bg_draw ()</h3>
218
218
<pre class="programlisting"><span class="returnvalue">void</span>                gnome_bg_draw                       (<em class="parameter"><code><a class="link" href="gnome-desktop3-gnome-bg.html#GnomeBG"><span class="type">GnomeBG</span></a> *bg</code></em>,
219
219
                                                         <em class="parameter"><code><span class="type">GdkPixbuf</span> *dest</code></em>,
220
 
                                                         <em class="parameter"><code><span class="type">GdkScreen</span> *screen</code></em>,
 
220
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gdk/GdkScreen.html"><span class="type">GdkScreen</span></a> *screen</code></em>,
221
221
                                                         <em class="parameter"><code><span class="type">gboolean</span> is_root</code></em>);</pre>
222
222
<p>
223
223
</p>
225
225
<hr>
226
226
<div class="refsect2">
227
227
<a name="gnome-bg-create-surface"></a><h3>gnome_bg_create_surface ()</h3>
228
 
<pre class="programlisting"><span class="returnvalue">cairo_surface_t</span> *   gnome_bg_create_surface             (<em class="parameter"><code><a class="link" href="gnome-desktop3-gnome-bg.html#GnomeBG"><span class="type">GnomeBG</span></a> *bg</code></em>,
229
 
                                                         <em class="parameter"><code><span class="type">GdkWindow</span> *window</code></em>,
 
228
<pre class="programlisting"><a href="/gnome/usr/share/gtk-doc/html/cairo/cairo-cairo-surface-t.html#cairo-surface-t"><span class="returnvalue">cairo_surface_t</span></a> *   gnome_bg_create_surface             (<em class="parameter"><code><a class="link" href="gnome-desktop3-gnome-bg.html#GnomeBG"><span class="type">GnomeBG</span></a> *bg</code></em>,
 
229
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gdk/gdk3-Windows.html#GdkWindow"><span class="type">GdkWindow</span></a> *window</code></em>,
230
230
                                                         <em class="parameter"><code><span class="type">int</span> width</code></em>,
231
231
                                                         <em class="parameter"><code><span class="type">int</span> height</code></em>,
232
232
                                                         <em class="parameter"><code><span class="type">gboolean</span> root</code></em>);</pre>
261
261
<a name="gnome-bg-create-thumbnail"></a><h3>gnome_bg_create_thumbnail ()</h3>
262
262
<pre class="programlisting"><span class="returnvalue">GdkPixbuf</span> *         gnome_bg_create_thumbnail           (<em class="parameter"><code><a class="link" href="gnome-desktop3-gnome-bg.html#GnomeBG"><span class="type">GnomeBG</span></a> *bg</code></em>,
263
263
                                                         <em class="parameter"><code><a class="link" href="GnomeDesktopThumbnailFactory.html" title="GnomeDesktopThumbnailFactory"><span class="type">GnomeDesktopThumbnailFactory</span></a> *factory</code></em>,
264
 
                                                         <em class="parameter"><code><span class="type">GdkScreen</span> *screen</code></em>,
 
264
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gdk/GdkScreen.html"><span class="type">GdkScreen</span></a> *screen</code></em>,
265
265
                                                         <em class="parameter"><code><span class="type">int</span> dest_width</code></em>,
266
266
                                                         <em class="parameter"><code><span class="type">int</span> dest_height</code></em>);</pre>
267
267
<div class="variablelist"><table border="0">
301
301
<a name="gnome-bg-create-frame-thumbnail"></a><h3>gnome_bg_create_frame_thumbnail ()</h3>
302
302
<pre class="programlisting"><span class="returnvalue">GdkPixbuf</span> *         gnome_bg_create_frame_thumbnail     (<em class="parameter"><code><a class="link" href="gnome-desktop3-gnome-bg.html#GnomeBG"><span class="type">GnomeBG</span></a> *bg</code></em>,
303
303
                                                         <em class="parameter"><code><a class="link" href="GnomeDesktopThumbnailFactory.html" title="GnomeDesktopThumbnailFactory"><span class="type">GnomeDesktopThumbnailFactory</span></a> *factory</code></em>,
304
 
                                                         <em class="parameter"><code><span class="type">GdkScreen</span> *screen</code></em>,
 
304
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gdk/GdkScreen.html"><span class="type">GdkScreen</span></a> *screen</code></em>,
305
305
                                                         <em class="parameter"><code><span class="type">int</span> dest_width</code></em>,
306
306
                                                         <em class="parameter"><code><span class="type">int</span> dest_height</code></em>,
307
307
                                                         <em class="parameter"><code><span class="type">int</span> frame_num</code></em>);</pre>
323
323
<hr>
324
324
<div class="refsect2">
325
325
<a name="gnome-bg-set-surface-as-root"></a><h3>gnome_bg_set_surface_as_root ()</h3>
326
 
<pre class="programlisting"><span class="returnvalue">void</span>                gnome_bg_set_surface_as_root        (<em class="parameter"><code><span class="type">GdkScreen</span> *screen</code></em>,
327
 
                                                         <em class="parameter"><code><span class="type">cairo_surface_t</span> *surface</code></em>);</pre>
 
326
<pre class="programlisting"><span class="returnvalue">void</span>                gnome_bg_set_surface_as_root        (<em class="parameter"><code><a href="http://library.gnome.org/devel/gdk/GdkScreen.html"><span class="type">GdkScreen</span></a> *screen</code></em>,
 
327
                                                         <em class="parameter"><code><a href="/gnome/usr/share/gtk-doc/html/cairo/cairo-cairo-surface-t.html#cairo-surface-t"><span class="type">cairo_surface_t</span></a> *surface</code></em>);</pre>
328
328
<p>
329
329
Set the root pixmap, and properties pointing to it. We
330
330
do this atomically with a server grab to make sure that
338
338
<tbody>
339
339
<tr>
340
340
<td><p><span class="term"><em class="parameter"><code>screen</code></em> :</span></p></td>
341
 
<td>the <span class="type">GdkScreen</span> to change root background on</td>
 
341
<td>the <a href="http://library.gnome.org/devel/gdk/GdkScreen.html"><span class="type">GdkScreen</span></a> to change root background on</td>
342
342
</tr>
343
343
<tr>
344
344
<td><p><span class="term"><em class="parameter"><code>surface</code></em> :</span></p></td>
345
 
<td>the <span class="type">cairo_surface_t</span> to set root background from.
 
345
<td>the <a href="/gnome/usr/share/gtk-doc/html/cairo/cairo-cairo-surface-t.html#cairo-surface-t"><span class="type">cairo_surface_t</span></a> to set root background from.
346
346
Must be an xlib surface backing a pixmap.</td>
347
347
</tr>
348
348
</tbody>
352
352
<div class="refsect2">
353
353
<a name="gnome-bg-set-surface-as-root-with-crossfade"></a><h3>gnome_bg_set_surface_as_root_with_crossfade ()</h3>
354
354
<pre class="programlisting"><span class="returnvalue">GnomeBGCrossfade</span> *  gnome_bg_set_surface_as_root_with_crossfade
355
 
                                                        (<em class="parameter"><code><span class="type">GdkScreen</span> *screen</code></em>,
356
 
                                                         <em class="parameter"><code><span class="type">cairo_surface_t</span> *surface</code></em>);</pre>
 
355
                                                        (<em class="parameter"><code><a href="http://library.gnome.org/devel/gdk/GdkScreen.html"><span class="type">GdkScreen</span></a> *screen</code></em>,
 
356
                                                         <em class="parameter"><code><a href="/gnome/usr/share/gtk-doc/html/cairo/cairo-cairo-surface-t.html#cairo-surface-t"><span class="type">cairo_surface_t</span></a> *surface</code></em>);</pre>
357
357
<p>
358
358
Set the root pixmap, and properties pointing to it.
359
359
This function differs from <a class="link" href="gnome-desktop3-gnome-bg.html#gnome-bg-set-surface-as-root" title="gnome_bg_set_surface_as_root ()"><code class="function">gnome_bg_set_surface_as_root()</code></a>
365
365
<tbody>
366
366
<tr>
367
367
<td><p><span class="term"><em class="parameter"><code>screen</code></em> :</span></p></td>
368
 
<td>the <span class="type">GdkScreen</span> to change root background on</td>
 
368
<td>the <a href="http://library.gnome.org/devel/gdk/GdkScreen.html"><span class="type">GdkScreen</span></a> to change root background on</td>
369
369
</tr>
370
370
<tr>
371
371
<td><p><span class="term"><em class="parameter"><code>surface</code></em> :</span></p></td>
382
382
<hr>
383
383
<div class="refsect2">
384
384
<a name="gnome-bg-get-surface-from-root"></a><h3>gnome_bg_get_surface_from_root ()</h3>
385
 
<pre class="programlisting"><span class="returnvalue">cairo_surface_t</span> *   gnome_bg_get_surface_from_root      (<em class="parameter"><code><span class="type">GdkScreen</span> *screen</code></em>);</pre>
 
385
<pre class="programlisting"><a href="/gnome/usr/share/gtk-doc/html/cairo/cairo-cairo-surface-t.html#cairo-surface-t"><span class="returnvalue">cairo_surface_t</span></a> *   gnome_bg_get_surface_from_root      (<em class="parameter"><code><a href="http://library.gnome.org/devel/gdk/GdkScreen.html"><span class="type">GdkScreen</span></a> *screen</code></em>);</pre>
386
386
<p>
387
387
This function queries the _XROOTPMAP_ID property from
388
388
the root window associated with <em class="parameter"><code>screen</code></em> to determine
395
395
<tbody>
396
396
<tr>
397
397
<td><p><span class="term"><em class="parameter"><code>screen</code></em> :</span></p></td>
398
 
<td>a <span class="type">GdkScreen</span>
 
398
<td>a <a href="http://library.gnome.org/devel/gdk/GdkScreen.html"><span class="type">GdkScreen</span></a>
399
399
</td>
400
400
</tr>
401
401
<tr>
402
402
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
403
 
<td>a <span class="type">cairo_surface_t</span> if successful or <code class="literal">NULL</code>
 
403
<td>a <a href="/gnome/usr/share/gtk-doc/html/cairo/cairo-cairo-surface-t.html#cairo-surface-t"><span class="type">cairo_surface_t</span></a> if successful or <a href="/gnome/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>
404
404
</td>
405
405
</tr>
406
406
</tbody>
426
426
<div class="refsect2">
427
427
<a name="GnomeBG-changed"></a><h3>The <code class="literal">"changed"</code> signal</h3>
428
428
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="gnome-desktop3-gnome-bg.html#GnomeBG"><span class="type">GnomeBG</span></a> *bg,
429
 
                                                        <span class="type">gpointer</span> user_data)      : <code class="literal">Run Last</code></pre>
 
429
                                                        <span class="type">gpointer</span> user_data)      : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
430
430
<p>
431
431
</p>
432
432
<div class="variablelist"><table border="0">
447
447
<div class="refsect2">
448
448
<a name="GnomeBG-transitioned"></a><h3>The <code class="literal">"transitioned"</code> signal</h3>
449
449
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="gnome-desktop3-gnome-bg.html#GnomeBG"><span class="type">GnomeBG</span></a> *bg,
450
 
                                                        <span class="type">gpointer</span> user_data)      : <code class="literal">Run Last</code></pre>
 
450
                                                        <span class="type">gpointer</span> user_data)      : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
451
451
<p>
452
452
</p>
453
453
<div class="variablelist"><table border="0">
468
468
</div>
469
469
<div class="footer">
470
470
<hr>
471
 
          Generated by GTK-Doc V1.17</div>
 
471
          Generated by GTK-Doc V1.16.1</div>
472
472
</body>
473
473
</html>
 
 
b'\\ No newline at end of file'