1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
|
<refentry id="libgda-libgda">
<refmeta>
<refentrytitle role="top_of_page" id="libgda-libgda.top_of_page">libgda</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGDA Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>libgda</refname>
<refpurpose>Library initialization</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="libgda-libgda.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="void">void</link> <link linkend="gda-init">gda_init</link> (const <link linkend="gchar">gchar</link> *app_id,
const <link linkend="gchar">gchar</link> *version,
<link linkend="gint">gint</link> nargs,
<link linkend="gchar">gchar</link> *args[]);
<link linkend="void">void</link> (<link linkend="GdaInitFunc">*GdaInitFunc</link>) (<link linkend="gpointer">gpointer</link> user_data);
<link linkend="void">void</link> <link linkend="gda-main-run">gda_main_run</link> (<link linkend="GdaInitFunc">GdaInitFunc</link> init_func,
<link linkend="gpointer">gpointer</link> user_data);
<link linkend="void">void</link> <link linkend="gda-main-quit">gda_main_quit</link> (void);
</synopsis>
</refsynopsisdiv>
<refsect1 id="libgda-libgda.description" role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 id="libgda-libgda.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="gda-init" role="function">
<title>gda_init ()</title>
<indexterm zone="gda-init"><primary>gda_init</primary></indexterm><programlisting><link linkend="void">void</link> gda_init (const <link linkend="gchar">gchar</link> *app_id,
const <link linkend="gchar">gchar</link> *version,
<link linkend="gint">gint</link> nargs,
<link linkend="gchar">gchar</link> *args[]);</programlisting>
<para>
Initializes the GDA library.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>app_id</parameter> :</term>
<listitem><simpara> name of the program.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>version</parameter> :</term>
<listitem><simpara> revision number of the program.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>nargs</parameter> :</term>
<listitem><simpara> number of arguments, usually argc from <link linkend="main"><function>main()</function></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>args</parameter> :</term>
<listitem><simpara> list of arguments, usually argv from <link linkend="main"><function>main()</function></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="GdaInitFunc" role="function">
<title>GdaInitFunc ()</title>
<indexterm zone="GdaInitFunc"><primary>GdaInitFunc</primary></indexterm><programlisting><link linkend="void">void</link> (*GdaInitFunc) (<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gda-main-run" role="function">
<title>gda_main_run ()</title>
<indexterm zone="gda-main-run"><primary>gda_main_run</primary></indexterm><programlisting><link linkend="void">void</link> gda_main_run (<link linkend="GdaInitFunc">GdaInitFunc</link> init_func,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>
Runs the GDA main loop, which is nothing more than the Bonobo main
loop, but with internally added stuff specific for applications using
libgda.
</para>
<para>
You can specify a function to be called after everything has been correctly
initialized (that is, for initializing your own stuff).</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>init_func</parameter> :</term>
<listitem><simpara> function to be called when everything has been initialized.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara> data to be passed to the init function.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gda-main-quit" role="function">
<title>gda_main_quit ()</title>
<indexterm zone="gda-main-quit"><primary>gda_main_quit</primary></indexterm><programlisting><link linkend="void">void</link> gda_main_quit (void);</programlisting>
<para>
Exits the main loop.</para>
<para>
</para></refsect2>
</refsect1>
</refentry>
|
