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

« back to all changes in this revision

Viewing changes to doc/sgml/glade-init.sgml

  • Committer: Bazaar Package Importer
  • Author(s): Andreas Rottmann
  • Date: 2005-02-28 14:33:01 UTC
  • mfrom: (1.2.1 upstream) (2.1.1 warty)
  • Revision ID: james.westby@ubuntu.com-20050228143301-eroxclsw3tlhg20p
Tags: 1:2.4.2-2
Included manpage for libglade-convert (closes: #294254, thanks to
Margarita Manterola).

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
<refentry id="libglade-Libglade-Initialisation">
2
 
<refmeta>
3
 
<refentrytitle>Libglade Initialisation</refentrytitle>
4
 
<manvolnum>3</manvolnum>
5
 
<refmiscinfo>LIBGLADE Library</refmiscinfo>
6
 
</refmeta>
7
 
 
8
 
<refnamediv>
9
 
<refname>Libglade Initialisation</refname><refpurpose></refpurpose>
10
 
</refnamediv>
11
 
 
12
 
<refsynopsisdiv><title>Synopsis</title>
13
 
<synopsis>
14
 
 
15
 
#include &lt;glade/glade-init.h&gt;
16
 
 
17
 
 
18
 
void        <link linkend="glade-init">glade_init</link>                      (void);
19
 
void        <link linkend="glade-require">glade_require</link>                   (const <link linkend="gchar">gchar</link> *library);
20
 
void        <link linkend="glade-provide">glade_provide</link>                   (const <link linkend="gchar">gchar</link> *library);
21
 
 
22
 
</synopsis>
23
 
</refsynopsisdiv>
24
 
 
25
 
 
26
 
 
27
 
 
28
 
 
29
 
<refsect1>
30
 
<title>Description</title>
31
 
<para>
32
 
 
33
 
</para>
34
 
</refsect1>
35
 
 
36
 
<refsect1>
37
 
<title>Details</title>
38
 
<refsect2>
39
 
<title><anchor id="glade-init">glade_init ()</title>
40
 
<programlisting>void        glade_init                      (void);</programlisting>
41
 
<para>
42
 
It used to be necessary to call <link linkend="glade-init">glade_init</link>() before creating
43
 
GladeXML objects.  This is now no longer the case, as libglade will
44
 
be initialised on demand now.  Calling <link linkend="glade-init">glade_init</link>() manually will
45
 
not cause any problems though.</para>
46
 
<para>
47
 
 
48
 
</para></refsect2>
49
 
<refsect2>
50
 
<title><anchor id="glade-require">glade_require ()</title>
51
 
<programlisting>void        glade_require                   (const <link linkend="gchar">gchar</link> *library);</programlisting>
52
 
<para>
53
 
Ensure that a required library is available.  If it is not already
54
 
available, libglade will attempt to dynamically load a module that
55
 
contains the handlers for that library.</para>
56
 
<para>
57
 
 
58
 
</para><informaltable pgwide="1" frame="none" role="params">
59
 
<tgroup cols="2">
60
 
<colspec colwidth="2*">
61
 
<colspec colwidth="8*">
62
 
<tbody>
63
 
<row><entry align="right"><parameter>library</parameter>&nbsp;:</entry>
64
 
<entry> the required library
65
 
</entry></row>
66
 
</tbody></tgroup></informaltable></refsect2>
67
 
<refsect2>
68
 
<title><anchor id="glade-provide">glade_provide ()</title>
69
 
<programlisting>void        glade_provide                   (const <link linkend="gchar">gchar</link> *library);</programlisting>
70
 
<para>
71
 
This function should be called by a module to assert that it
72
 
provides wrappers for a particular library.  This should be called
73
 
by the <link linkend="register-widgets">register_widgets</link>() function of a libglade module so that it
74
 
isn't loaded twice, for instance.</para>
75
 
<para>
76
 
 
77
 
</para><informaltable pgwide="1" frame="none" role="params">
78
 
<tgroup cols="2">
79
 
<colspec colwidth="2*">
80
 
<colspec colwidth="8*">
81
 
<tbody>
82
 
<row><entry align="right"><parameter>library</parameter>&nbsp;:</entry>
83
 
<entry> the provided library
84
 
</entry></row>
85
 
</tbody></tgroup></informaltable></refsect2>
86
 
 
87
 
</refsect1>
88
 
 
89
 
 
90
 
 
91
 
 
92
 
</refentry>