~ubuntu-branches/ubuntu/precise/libglade2/precise-proposed

<?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="libglade-Libglade-Initialisation">

<refmeta>

<refentrytitle>Libglade Initialisation</refentrytitle>

<manvolnum>3</manvolnum>

<refmiscinfo>LIBGLADE Library</refmiscinfo>

</refmeta>

 

<refnamediv>

<refname>Libglade Initialisation</refname><refpurpose>Routines used to initialise libglade.</refpurpose>

</refnamediv>

 

<refsynopsisdiv><title>Synopsis</title>

 

<synopsis>

 

#include &lt;glade/glade-init.h&gt;

 

 

<link linkend="void">void</link>        <link linkend="glade-init">glade_init</link>                      (void);

<link linkend="void">void</link>        <link linkend="glade-require">glade_require</link>                   (const <link linkend="gchar">gchar</link> *library);

<link linkend="void">void</link>        <link linkend="glade-provide">glade_provide</link>                   (const <link linkend="gchar">gchar</link> *library);

 

</synopsis>

</refsynopsisdiv>

 

 

 

 

 

 

 

 

 

<refsect1>

<title>Description</title>

<para>

These routines are used to initialise libglade, and to load addon modules

that recognise extra widget sets.  The <filename>glade_init</filename>

routine must be called before any libglade routines are used, and the

<filename>glade_load_module</filename> routine would be used to load

extra modules.

</para>

</refsect1>

 

<refsect1>

<title>Details</title>

<refsect2>

<title><anchor id="glade-init"/>glade_init ()</title>

<indexterm><primary>glade_init</primary></indexterm><programlisting><link linkend="void">void</link>        glade_init                      (void);</programlisting>

<para>

It used to be necessary to call <link linkend="glade-init"><function>glade_init()</function></link> before creating

GladeXML objects.  This is now no longer the case, as libglade will

be initialised on demand now.  Calling <link linkend="glade-init"><function>glade_init()</function></link> manually will

not cause any problems though.</para>

<para>

 

</para></refsect2>

<refsect2>

<title><anchor id="glade-require"/>glade_require ()</title>

<indexterm><primary>glade_require</primary></indexterm><programlisting><link linkend="void">void</link>        glade_require                   (const <link linkend="gchar">gchar</link> *library);</programlisting>

<para>

Ensure that a required library is available.  If it is not already

available, libglade will attempt to dynamically load a module that

contains the handlers for that library.</para>

<para>

 

</para><variablelist role="params">

<varlistentry><term><parameter>library</parameter>&nbsp;:</term>

<listitem><simpara> the required library

</simpara></listitem></varlistentry>

</variablelist></refsect2>

<refsect2>

<title><anchor id="glade-provide"/>glade_provide ()</title>

<indexterm><primary>glade_provide</primary></indexterm><programlisting><link linkend="void">void</link>        glade_provide                   (const <link linkend="gchar">gchar</link> *library);</programlisting>

<para>

This function should be called by a module to assert that it

provides wrappers for a particular library.  This should be called

by the <link linkend="register-widgets"><function>register_widgets()</function></link> function of a libglade module so that it

isn't loaded twice, for instance.</para>

<para>

 

</para><variablelist role="params">

<varlistentry><term><parameter>library</parameter>&nbsp;:</term>

<listitem><simpara> the provided library

</simpara></listitem></varlistentry>

</variablelist></refsect2>

 

</refsect1>

 

 

 

 

</refentry>