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
119
120
121
122
123
124
125
126
127
128
129
130
131
|
<refentry id="xmlroff-fo-libfo-module">
<refmeta>
<refentrytitle role="top_of_page" id="xmlroff-fo-libfo-module.top_of_page">fo-libfo-module</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>XMLROFF Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>fo-libfo-module</refname>
<refpurpose></refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="xmlroff-fo-libfo-module.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="FoLibfoModule">FoLibfoModule</link>;
<link linkend="FoLibfoModuleClass">FoLibfoModuleClass</link>;
<link linkend="gint">gint</link> <link linkend="fo-libfo-module-version-from-name">fo_libfo_module_version_from_name</link> (const <link linkend="gchar">gchar</link> *name);
const <link linkend="gchar">gchar</link>* <link linkend="fo-libfo-module-version-string-from-name">fo_libfo_module_version_string_from_name</link>
(const <link linkend="gchar">gchar</link> *name);
const <link linkend="LibfoVersionInfo">LibfoVersionInfo</link>* <link linkend="fo-libfo-module-version-info-from-name">fo_libfo_module_version_info_from_name</link>
(const <link linkend="gchar">gchar</link> *name);
</synopsis>
</refsynopsisdiv>
<refsect1 id="xmlroff-fo-libfo-module.description" role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 id="xmlroff-fo-libfo-module.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="FoLibfoModule" role="struct">
<title>FoLibfoModule</title>
<indexterm zone="FoLibfoModule"><primary>FoLibfoModule</primary></indexterm><programlisting>typedef struct {
FoObject module_instance;
} FoLibfoModule;
</programlisting>
<para>
</para></refsect2>
<refsect2 id="FoLibfoModuleClass" role="struct">
<title>FoLibfoModuleClass</title>
<indexterm zone="FoLibfoModuleClass"><primary>FoLibfoModuleClass</primary></indexterm><programlisting>typedef struct {
FoObjectClass module_class;
gint (*version) (void);
const gchar* (*version_string) (void);
const LibfoVersionInfo * (*version_info) (void);
} FoLibfoModuleClass;
</programlisting>
<para>
</para></refsect2>
<refsect2 id="fo-libfo-module-version-from-name" role="function">
<title>fo_libfo_module_version_from_name ()</title>
<indexterm zone="fo-libfo-module-version-from-name"><primary>fo_libfo_module_version_from_name</primary></indexterm><programlisting><link linkend="gint">gint</link> fo_libfo_module_version_from_name (const <link linkend="gchar">gchar</link> *name);</programlisting>
<para>
Gets the runtime version of the library underlying the
<link linkend="FoLibfoModule"><type>FoLibfoModule</type></link> implementation.
</para>
<para>
This function just returns what the underlying library provides, if
anything, so version numbers can only meaningfully be compared
against version numbers of the same library implementation.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>name</parameter> :</term>
<listitem><simpara> Registered <link linkend="FoObject"><type>FoObject</type></link> type name, e.g., "FoDocCairo"
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Library version, or 0 if the underlying library does not
make its version number available at runtime
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-libfo-module-version-string-from-name" role="function">
<title>fo_libfo_module_version_string_from_name ()</title>
<indexterm zone="fo-libfo-module-version-string-from-name"><primary>fo_libfo_module_version_string_from_name</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* fo_libfo_module_version_string_from_name
(const <link linkend="gchar">gchar</link> *name);</programlisting>
<para>
Gets the runtime version of the library underlying the
<link linkend="FoLibfoModule"><type>FoLibfoModule</type></link> implementation as a human-readable string.
</para>
<para>
The string is likely to be of the form "X.Y.Z", e.g., "1.0.0", but
this function just returns what the underlying library provides, so
nothing is guaranteed.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>name</parameter> :</term>
<listitem><simpara> Registered <link linkend="FoObject"><type>FoObject</type></link> type name, e.g., "FoDocCairo"
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Library version, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if the underlying library does
not make its version number available at runtime
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-libfo-module-version-info-from-name" role="function">
<title>fo_libfo_module_version_info_from_name ()</title>
<indexterm zone="fo-libfo-module-version-info-from-name"><primary>fo_libfo_module_version_info_from_name</primary></indexterm><programlisting>const <link linkend="LibfoVersionInfo">LibfoVersionInfo</link>* fo_libfo_module_version_info_from_name
(const <link linkend="gchar">gchar</link> *name);</programlisting>
<para>
Gets the <link linkend="LibfoVersionInfo"><type>LibfoVersionInfo</type></link> for</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>name</parameter> :</term>
<listitem><simpara> Registered <link linkend="FoObject"><type>FoObject</type></link> type name, e.g., "FoDocCairo"
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
