<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="GnomeBG">
<refmeta>
<refentrytitle role="top_of_page" id="GnomeBG.top_of_page">GnomeBG</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>
  GNOME-DESKTOP3 Library
</refmiscinfo>
</refmeta>
<refnamediv>
<refname>GnomeBG</refname>
<refpurpose></refpurpose>
</refnamediv>

<refsynopsisdiv id="GnomeBG.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>

<synopsis>
#include &lt;libgnomeui/gnome-bg.h&gt;

                    <link linkend="GnomeBG-struct">GnomeBG</link>;
enum                <link linkend="GnomeBGColorType">GnomeBGColorType</link>;
enum                <link linkend="GnomeBGPlacement">GnomeBGPlacement</link>;
#define             <link linkend="GNOME-BG-KEY-DIR:CAPS">GNOME_BG_KEY_DIR</link>
<link linkend="GnomeBG"><returnvalue>GnomeBG</returnvalue></link> *           <link linkend="gnome-bg-new">gnome_bg_new</link>                        (<parameter><type>void</type></parameter>);
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="gnome-bg-load-from-preferences">gnome_bg_load_from_preferences</link>      (<parameter><link linkend="GnomeBG"><type>GnomeBG</type></link> *bg</parameter>,
                                                         <parameter><link linkend="GConfClient"><type>GConfClient</type></link> *client</parameter>);
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="gnome-bg-save-to-preferences">gnome_bg_save_to_preferences</link>        (<parameter><link linkend="GnomeBG"><type>GnomeBG</type></link> *bg</parameter>,
                                                         <parameter><link linkend="GConfClient"><type>GConfClient</type></link> *client</parameter>);
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="gnome-bg-set-filename">gnome_bg_set_filename</link>               (<parameter><link linkend="GnomeBG"><type>GnomeBG</type></link> *bg</parameter>,
                                                         <parameter>const <link linkend="char"><type>char</type></link> *filename</parameter>);
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="gnome-bg-set-placement">gnome_bg_set_placement</link>              (<parameter><link linkend="GnomeBG"><type>GnomeBG</type></link> *bg</parameter>,
                                                         <parameter><link linkend="GnomeBGPlacement"><type>GnomeBGPlacement</type></link> placement</parameter>);
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="gnome-bg-set-color">gnome_bg_set_color</link>                  (<parameter><link linkend="GnomeBG"><type>GnomeBG</type></link> *bg</parameter>,
                                                         <parameter><link linkend="GnomeBGColorType"><type>GnomeBGColorType</type></link> type</parameter>,
                                                         <parameter><link linkend="GdkColor"><type>GdkColor</type></link> *primary</parameter>,
                                                         <parameter><link linkend="GdkColor"><type>GdkColor</type></link> *secondary</parameter>);
const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> *       <link linkend="gnome-bg-get-filename">gnome_bg_get_filename</link>               (<parameter><link linkend="GnomeBG"><type>GnomeBG</type></link> *bg</parameter>);
<link linkend="GnomeBGPlacement"><returnvalue>GnomeBGPlacement</returnvalue></link>    <link linkend="gnome-bg-get-placement">gnome_bg_get_placement</link>              (<parameter><link linkend="GnomeBG"><type>GnomeBG</type></link> *bg</parameter>);
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="gnome-bg-get-color">gnome_bg_get_color</link>                  (<parameter><link linkend="GnomeBG"><type>GnomeBG</type></link> *bg</parameter>,
                                                         <parameter><link linkend="GnomeBGColorType"><type>GnomeBGColorType</type></link> *type</parameter>,
                                                         <parameter><link linkend="GdkColor"><type>GdkColor</type></link> *primary</parameter>,
                                                         <parameter><link linkend="GdkColor"><type>GdkColor</type></link> *secondary</parameter>);
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="gnome-bg-draw">gnome_bg_draw</link>                       (<parameter><link linkend="GnomeBG"><type>GnomeBG</type></link> *bg</parameter>,
                                                         <parameter><link linkend="GdkPixbuf"><type>GdkPixbuf</type></link> *dest</parameter>,
                                                         <parameter><link linkend="GdkScreen"><type>GdkScreen</type></link> *screen</parameter>,
                                                         <parameter><link linkend="gboolean"><type>gboolean</type></link> is_root</parameter>);
<link linkend="GdkPixmap"><returnvalue>GdkPixmap</returnvalue></link> *         <link linkend="gnome-bg-create-pixmap">gnome_bg_create_pixmap</link>              (<parameter><link linkend="GnomeBG"><type>GnomeBG</type></link> *bg</parameter>,
                                                         <parameter><link linkend="GdkWindow"><type>GdkWindow</type></link> *window</parameter>,
                                                         <parameter><link linkend="int"><type>int</type></link> width</parameter>,
                                                         <parameter><link linkend="int"><type>int</type></link> height</parameter>,
                                                         <parameter><link linkend="gboolean"><type>gboolean</type></link> root</parameter>);
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="gnome-bg-get-image-size">gnome_bg_get_image_size</link>             (<parameter><link linkend="GnomeBG"><type>GnomeBG</type></link> *bg</parameter>,
                                                         <parameter><link linkend="GnomeDesktopThumbnailFactory"><type>GnomeDesktopThumbnailFactory</type></link> *factory</parameter>,
                                                         <parameter><link linkend="int"><type>int</type></link> best_width</parameter>,
                                                         <parameter><link linkend="int"><type>int</type></link> best_height</parameter>,
                                                         <parameter><link linkend="int"><type>int</type></link> *width</parameter>,
                                                         <parameter><link linkend="int"><type>int</type></link> *height</parameter>);
<link linkend="GdkPixbuf"><returnvalue>GdkPixbuf</returnvalue></link> *         <link linkend="gnome-bg-create-thumbnail">gnome_bg_create_thumbnail</link>           (<parameter><link linkend="GnomeBG"><type>GnomeBG</type></link> *bg</parameter>,
                                                         <parameter><link linkend="GnomeDesktopThumbnailFactory"><type>GnomeDesktopThumbnailFactory</type></link> *factory</parameter>,
                                                         <parameter><link linkend="GdkScreen"><type>GdkScreen</type></link> *screen</parameter>,
                                                         <parameter><link linkend="int"><type>int</type></link> dest_width</parameter>,
                                                         <parameter><link linkend="int"><type>int</type></link> dest_height</parameter>);
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="gnome-bg-is-dark">gnome_bg_is_dark</link>                    (<parameter><link linkend="GnomeBG"><type>GnomeBG</type></link> *bg</parameter>,
                                                         <parameter><link linkend="int"><type>int</type></link> dest_width</parameter>,
                                                         <parameter><link linkend="int"><type>int</type></link> dest_height</parameter>);
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="gnome-bg-set-pixmap-as-root">gnome_bg_set_pixmap_as_root</link>         (<parameter><link linkend="GdkScreen"><type>GdkScreen</type></link> *screen</parameter>,
                                                         <parameter><link linkend="GdkPixmap"><type>GdkPixmap</type></link> *pixmap</parameter>);
</synopsis>
</refsynopsisdiv>
<refsect1 id="GnomeBG.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
  <link linkend="GObject">GObject</link>
   +----GnomeBG
</synopsis>
</refsect1>
<refsect1 id="GnomeBG.signals" role="signal_proto">
<title role="signal_proto.title">Signals</title>
<synopsis>
  &quot;<link linkend="GnomeBG-changed">changed</link>&quot;                                        : Run Last
  &quot;<link linkend="GnomeBG-transitioned">transitioned</link>&quot;                                   : Run Last
</synopsis>
</refsect1>

<refsect1 id="GnomeBG.description" role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 id="GnomeBG.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="GnomeBG-struct" role="struct">
<title>GnomeBG</title>
<indexterm zone="GnomeBG-struct"><primary>GnomeBG</primary></indexterm>
<programlisting>typedef struct _GnomeBG GnomeBG;</programlisting>
<para>
</para></refsect2>
<refsect2 id="GnomeBGColorType" role="enum">
<title>enum GnomeBGColorType</title>
<indexterm zone="GnomeBGColorType"><primary>GnomeBGColorType</primary></indexterm>
<programlisting>typedef enum {
	GNOME_BG_COLOR_SOLID,
	GNOME_BG_COLOR_H_GRADIENT,
	GNOME_BG_COLOR_V_GRADIENT
} GnomeBGColorType;
</programlisting>
<para>
</para></refsect2>
<refsect2 id="GnomeBGPlacement" role="enum">
<title>enum GnomeBGPlacement</title>
<indexterm zone="GnomeBGPlacement"><primary>GnomeBGPlacement</primary></indexterm>
<programlisting>typedef enum {
	GNOME_BG_PLACEMENT_TILED,
	GNOME_BG_PLACEMENT_ZOOMED,
	GNOME_BG_PLACEMENT_CENTERED,
	GNOME_BG_PLACEMENT_SCALED,
	GNOME_BG_PLACEMENT_FILL_SCREEN,
	GNOME_BG_PLACEMENT_SPANNED
} GnomeBGPlacement;
</programlisting>
<para>
</para></refsect2>
<refsect2 id="GNOME-BG-KEY-DIR:CAPS" role="macro">
<title>GNOME_BG_KEY_DIR</title>
<indexterm zone="GNOME-BG-KEY-DIR:CAPS"><primary>GNOME_BG_KEY_DIR</primary></indexterm>
<programlisting>#define GNOME_BG_KEY_DIR "/desktop/gnome/background"
</programlisting>
<para>
</para></refsect2>
<refsect2 id="gnome-bg-new" role="function">
<title>gnome_bg_new ()</title>
<indexterm zone="gnome-bg-new"><primary>gnome_bg_new</primary></indexterm>
<programlisting><link linkend="GnomeBG"><returnvalue>GnomeBG</returnvalue></link> *           gnome_bg_new                        (<parameter><type>void</type></parameter>);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gnome-bg-load-from-preferences" role="function">
<title>gnome_bg_load_from_preferences ()</title>
<indexterm zone="gnome-bg-load-from-preferences"><primary>gnome_bg_load_from_preferences</primary></indexterm>
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                gnome_bg_load_from_preferences      (<parameter><link linkend="GnomeBG"><type>GnomeBG</type></link> *bg</parameter>,
                                                         <parameter><link linkend="GConfClient"><type>GConfClient</type></link> *client</parameter>);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>bg</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>client</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gnome-bg-save-to-preferences" role="function">
<title>gnome_bg_save_to_preferences ()</title>
<indexterm zone="gnome-bg-save-to-preferences"><primary>gnome_bg_save_to_preferences</primary></indexterm>
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                gnome_bg_save_to_preferences        (<parameter><link linkend="GnomeBG"><type>GnomeBG</type></link> *bg</parameter>,
                                                         <parameter><link linkend="GConfClient"><type>GConfClient</type></link> *client</parameter>);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>bg</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>client</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gnome-bg-set-filename" role="function">
<title>gnome_bg_set_filename ()</title>
<indexterm zone="gnome-bg-set-filename"><primary>gnome_bg_set_filename</primary></indexterm>
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                gnome_bg_set_filename               (<parameter><link linkend="GnomeBG"><type>GnomeBG</type></link> *bg</parameter>,
                                                         <parameter>const <link linkend="char"><type>char</type></link> *filename</parameter>);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>bg</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>filename</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gnome-bg-set-placement" role="function">
<title>gnome_bg_set_placement ()</title>
<indexterm zone="gnome-bg-set-placement"><primary>gnome_bg_set_placement</primary></indexterm>
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                gnome_bg_set_placement              (<parameter><link linkend="GnomeBG"><type>GnomeBG</type></link> *bg</parameter>,
                                                         <parameter><link linkend="GnomeBGPlacement"><type>GnomeBGPlacement</type></link> placement</parameter>);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>bg</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>placement</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gnome-bg-set-color" role="function">
<title>gnome_bg_set_color ()</title>
<indexterm zone="gnome-bg-set-color"><primary>gnome_bg_set_color</primary></indexterm>
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                gnome_bg_set_color                  (<parameter><link linkend="GnomeBG"><type>GnomeBG</type></link> *bg</parameter>,
                                                         <parameter><link linkend="GnomeBGColorType"><type>GnomeBGColorType</type></link> type</parameter>,
                                                         <parameter><link linkend="GdkColor"><type>GdkColor</type></link> *primary</parameter>,
                                                         <parameter><link linkend="GdkColor"><type>GdkColor</type></link> *secondary</parameter>);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>bg</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>type</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>primary</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>secondary</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gnome-bg-get-filename" role="function">
<title>gnome_bg_get_filename ()</title>
<indexterm zone="gnome-bg-get-filename"><primary>gnome_bg_get_filename</primary></indexterm>
<programlisting>const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> *       gnome_bg_get_filename               (<parameter><link linkend="GnomeBG"><type>GnomeBG</type></link> *bg</parameter>);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>bg</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gnome-bg-get-placement" role="function">
<title>gnome_bg_get_placement ()</title>
<indexterm zone="gnome-bg-get-placement"><primary>gnome_bg_get_placement</primary></indexterm>
<programlisting><link linkend="GnomeBGPlacement"><returnvalue>GnomeBGPlacement</returnvalue></link>    gnome_bg_get_placement              (<parameter><link linkend="GnomeBG"><type>GnomeBG</type></link> *bg</parameter>);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>bg</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gnome-bg-get-color" role="function">
<title>gnome_bg_get_color ()</title>
<indexterm zone="gnome-bg-get-color"><primary>gnome_bg_get_color</primary></indexterm>
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                gnome_bg_get_color                  (<parameter><link linkend="GnomeBG"><type>GnomeBG</type></link> *bg</parameter>,
                                                         <parameter><link linkend="GnomeBGColorType"><type>GnomeBGColorType</type></link> *type</parameter>,
                                                         <parameter><link linkend="GdkColor"><type>GdkColor</type></link> *primary</parameter>,
                                                         <parameter><link linkend="GdkColor"><type>GdkColor</type></link> *secondary</parameter>);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>bg</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>type</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>primary</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>secondary</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gnome-bg-draw" role="function">
<title>gnome_bg_draw ()</title>
<indexterm zone="gnome-bg-draw"><primary>gnome_bg_draw</primary></indexterm>
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                gnome_bg_draw                       (<parameter><link linkend="GnomeBG"><type>GnomeBG</type></link> *bg</parameter>,
                                                         <parameter><link linkend="GdkPixbuf"><type>GdkPixbuf</type></link> *dest</parameter>,
                                                         <parameter><link linkend="GdkScreen"><type>GdkScreen</type></link> *screen</parameter>,
                                                         <parameter><link linkend="gboolean"><type>gboolean</type></link> is_root</parameter>);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>bg</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>dest</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>screen</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>is_root</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gnome-bg-create-pixmap" role="function">
<title>gnome_bg_create_pixmap ()</title>
<indexterm zone="gnome-bg-create-pixmap"><primary>gnome_bg_create_pixmap</primary></indexterm>
<programlisting><link linkend="GdkPixmap"><returnvalue>GdkPixmap</returnvalue></link> *         gnome_bg_create_pixmap              (<parameter><link linkend="GnomeBG"><type>GnomeBG</type></link> *bg</parameter>,
                                                         <parameter><link linkend="GdkWindow"><type>GdkWindow</type></link> *window</parameter>,
                                                         <parameter><link linkend="int"><type>int</type></link> width</parameter>,
                                                         <parameter><link linkend="int"><type>int</type></link> height</parameter>,
                                                         <parameter><link linkend="gboolean"><type>gboolean</type></link> root</parameter>);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>bg</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>window</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>width</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>height</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>root</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gnome-bg-get-image-size" role="function">
<title>gnome_bg_get_image_size ()</title>
<indexterm zone="gnome-bg-get-image-size"><primary>gnome_bg_get_image_size</primary></indexterm>
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            gnome_bg_get_image_size             (<parameter><link linkend="GnomeBG"><type>GnomeBG</type></link> *bg</parameter>,
                                                         <parameter><link linkend="GnomeDesktopThumbnailFactory"><type>GnomeDesktopThumbnailFactory</type></link> *factory</parameter>,
                                                         <parameter><link linkend="int"><type>int</type></link> best_width</parameter>,
                                                         <parameter><link linkend="int"><type>int</type></link> best_height</parameter>,
                                                         <parameter><link linkend="int"><type>int</type></link> *width</parameter>,
                                                         <parameter><link linkend="int"><type>int</type></link> *height</parameter>);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>bg</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>factory</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>best_width</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>best_height</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>width</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>height</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gnome-bg-create-thumbnail" role="function">
<title>gnome_bg_create_thumbnail ()</title>
<indexterm zone="gnome-bg-create-thumbnail"><primary>gnome_bg_create_thumbnail</primary></indexterm>
<programlisting><link linkend="GdkPixbuf"><returnvalue>GdkPixbuf</returnvalue></link> *         gnome_bg_create_thumbnail           (<parameter><link linkend="GnomeBG"><type>GnomeBG</type></link> *bg</parameter>,
                                                         <parameter><link linkend="GnomeDesktopThumbnailFactory"><type>GnomeDesktopThumbnailFactory</type></link> *factory</parameter>,
                                                         <parameter><link linkend="GdkScreen"><type>GdkScreen</type></link> *screen</parameter>,
                                                         <parameter><link linkend="int"><type>int</type></link> dest_width</parameter>,
                                                         <parameter><link linkend="int"><type>int</type></link> dest_height</parameter>);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>bg</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>factory</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>screen</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>dest_width</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>dest_height</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gnome-bg-is-dark" role="function">
<title>gnome_bg_is_dark ()</title>
<indexterm zone="gnome-bg-is-dark"><primary>gnome_bg_is_dark</primary></indexterm>
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            gnome_bg_is_dark                    (<parameter><link linkend="GnomeBG"><type>GnomeBG</type></link> *bg</parameter>,
                                                         <parameter><link linkend="int"><type>int</type></link> dest_width</parameter>,
                                                         <parameter><link linkend="int"><type>int</type></link> dest_height</parameter>);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>bg</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>dest_width</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>dest_height</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gnome-bg-set-pixmap-as-root" role="function">
<title>gnome_bg_set_pixmap_as_root ()</title>
<indexterm zone="gnome-bg-set-pixmap-as-root"><primary>gnome_bg_set_pixmap_as_root</primary></indexterm>
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                gnome_bg_set_pixmap_as_root         (<parameter><link linkend="GdkScreen"><type>GdkScreen</type></link> *screen</parameter>,
                                                         <parameter><link linkend="GdkPixmap"><type>GdkPixmap</type></link> *pixmap</parameter>);</programlisting>
<para>
Set the root pixmap, and properties pointing to it. We
do this atomically with a server grab to make sure that
we won't leak the pixmap if somebody else it setting
it at the same time. (This assumes that they follow the
same conventions we do).  <parameter>pixmap</parameter> should come from a call
to <link linkend="gnome-bg-create-pixmap"><function>gnome_bg_create_pixmap()</function></link>.
</para><variablelist role="params">
<varlistentry><term><parameter>screen</parameter>&#160;:</term>
<listitem><simpara>the <link linkend="GdkScreen"><type>GdkScreen</type></link> to change root background on
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>pixmap</parameter>&#160;:</term>
<listitem><simpara>the <link linkend="GdkPixmap"><type>GdkPixmap</type></link> to set root background from
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>
<refsect1 id="GnomeBG.signal-details" role="signals">
<title role="signals.title">Signal Details</title>
<refsect2 id="GnomeBG-changed" role="signal"><title>The <literal>&quot;changed&quot;</literal> signal</title>
<indexterm zone="GnomeBG-changed"><primary>GnomeBG::changed</primary></indexterm>
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                user_function                      (<link linkend="GnomeBG"><type>GnomeBG</type></link> *bg,
                                                        <link linkend="gpointer"><type>gpointer</type></link> user_data)      : Run Last</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>bg</parameter>&#160;:</term>
<listitem><simpara>the object which received the signal.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2 id="GnomeBG-transitioned" role="signal"><title>The <literal>&quot;transitioned&quot;</literal> signal</title>
<indexterm zone="GnomeBG-transitioned"><primary>GnomeBG::transitioned</primary></indexterm>
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                user_function                      (<link linkend="GnomeBG"><type>GnomeBG</type></link> *bg,
                                                        <link linkend="gpointer"><type>gpointer</type></link> user_data)      : Run Last</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>bg</parameter>&#160;:</term>
<listitem><simpara>the object which received the signal.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>

</refentry>
