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
132
133
134
135
136
|
<refentry id="FoName">
<refmeta>
<refentrytitle role="top_of_page" id="FoName.top_of_page">FoName</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>XMLROFF Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>FoName</refname>
<refpurpose></refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="FoName.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="FoName-struct">FoName</link>;
<link linkend="FoNameClass">FoNameClass</link>;
<link linkend="FoDatatype">FoDatatype</link>* <link linkend="fo-name-new">fo_name_new</link> (void);
<link linkend="FoDatatype">FoDatatype</link>* <link linkend="fo-name-new-with-value">fo_name_new_with_value</link> (const <link linkend="gchar">gchar</link> *value);
<link linkend="gchar">gchar</link>* <link linkend="fo-name-get-value">fo_name_get_value</link> (<link linkend="FoDatatype">FoDatatype</link> *name);
<link linkend="FoDatatype">FoDatatype</link>* <link linkend="fo-name-get-name-empty">fo_name_get_name_empty</link> (void);
</synopsis>
</refsynopsisdiv>
<refsect1 id="FoName.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----<link linkend="FoObject">FoObject</link>
+----<link linkend="FoDatatype">FoDatatype</link>
+----FoName
</synopsis>
</refsect1>
<refsect1 id="FoName.properties" role="properties">
<title role="properties.title">Properties</title>
<synopsis>
"<link linkend="FoName--value">value</link>" <link linkend="gchar">gchar</link>* : Read / Write / Construct Only
</synopsis>
</refsect1>
<refsect1 id="FoName.description" role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 id="FoName.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="FoName-struct" role="struct">
<title>FoName</title>
<indexterm zone="FoName-struct"><primary>FoName</primary></indexterm><programlisting>typedef struct _FoName FoName;</programlisting>
<para>
</para></refsect2>
<refsect2 id="FoNameClass" role="struct">
<title>FoNameClass</title>
<indexterm zone="FoNameClass"><primary>FoNameClass</primary></indexterm><programlisting>typedef struct _FoNameClass FoNameClass;</programlisting>
<para>
</para></refsect2>
<refsect2 id="fo-name-new" role="function">
<title>fo_name_new ()</title>
<indexterm zone="fo-name-new"><primary>fo_name_new</primary></indexterm><programlisting><link linkend="FoDatatype">FoDatatype</link>* fo_name_new (void);</programlisting>
<para>
Creates a new <link linkend="FoName"><type>FoName</type></link> initialized to default value.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the new <link linkend="FoName"><type>FoName</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-name-new-with-value" role="function">
<title>fo_name_new_with_value ()</title>
<indexterm zone="fo-name-new-with-value"><primary>fo_name_new_with_value</primary></indexterm><programlisting><link linkend="FoDatatype">FoDatatype</link>* fo_name_new_with_value (const <link linkend="gchar">gchar</link> *value);</programlisting>
<para>
Creates a new <link linkend="FoName"><type>FoName</type></link> set to <parameter>value</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>value</parameter> :</term>
<listitem><simpara> Value of the new <link linkend="FoName"><type>FoName</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The new <link linkend="FoName"><type>FoName</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-name-get-value" role="function">
<title>fo_name_get_value ()</title>
<indexterm zone="fo-name-get-value"><primary>fo_name_get_value</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* fo_name_get_value (<link linkend="FoDatatype">FoDatatype</link> *name);</programlisting>
<para>
Get the value of <parameter>name</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>name</parameter> :</term>
<listitem><simpara> <link linkend="FoName"><type>FoName</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> String value of <parameter>name</parameter>. String must be freed by caller.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-name-get-name-empty" role="function">
<title>fo_name_get_name_empty ()</title>
<indexterm zone="fo-name-get-name-empty"><primary>fo_name_get_name_empty</primary></indexterm><programlisting><link linkend="FoDatatype">FoDatatype</link>* fo_name_get_name_empty (void);</programlisting>
<para>
Get an <link linkend="FoName"><type>FoName</type></link> with the well-known value of an empty string.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The <link linkend="FoName"><type>FoName</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
<refsect1 id="FoName.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="FoName--value"><title>The <literal>"value"</literal> property</title>
<indexterm zone="FoName--value"><primary>FoName:value</primary></indexterm><programlisting> "value" <link linkend="gchar">gchar</link>* : Read / Write / Construct Only</programlisting>
<para>Name value.</para><para>Default value: NULL</para>
</refsect2>
</refsect1>
</refentry>
|
