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
137
138
139
140
141
|
<refentry id="FoString">
<refmeta>
<refentrytitle role="top_of_page" id="FoString.top_of_page">FoString</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>XMLROFF Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>FoString</refname>
<refpurpose></refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="FoString.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="FoString-struct">FoString</link>;
<link linkend="FoStringClass">FoStringClass</link>;
<link linkend="FoDatatype">FoDatatype</link>* <link linkend="fo-string-new">fo_string_new</link> (void);
<link linkend="FoDatatype">FoDatatype</link>* <link linkend="fo-string-new-with-value">fo_string_new_with_value</link> (const <link linkend="gchar">gchar</link> *value);
<link linkend="gchar">gchar</link>* <link linkend="fo-string-get-value">fo_string_get_value</link> (<link linkend="FoDatatype">FoDatatype</link> *string);
<link linkend="FoDatatype">FoDatatype</link>* <link linkend="fo-string-get-string-one">fo_string_get_string_one</link> (void);
</synopsis>
</refsynopsisdiv>
<refsect1 id="FoString.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>
+----FoString
</synopsis>
</refsect1>
<refsect1 id="FoString.properties" role="properties">
<title role="properties.title">Properties</title>
<synopsis>
"<link linkend="FoString--value">value</link>" <link linkend="gchar">gchar</link>* : Read / Write / Construct Only
</synopsis>
</refsect1>
<refsect1 id="FoString.description" role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 id="FoString.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="FoString-struct" role="struct">
<title>FoString</title>
<indexterm zone="FoString-struct"><primary>FoString</primary></indexterm><programlisting>typedef struct _FoString FoString;</programlisting>
<para>
</para></refsect2>
<refsect2 id="FoStringClass" role="struct">
<title>FoStringClass</title>
<indexterm zone="FoStringClass"><primary>FoStringClass</primary></indexterm><programlisting>typedef struct _FoStringClass FoStringClass;</programlisting>
<para>
</para></refsect2>
<refsect2 id="fo-string-new" role="function">
<title>fo_string_new ()</title>
<indexterm zone="fo-string-new"><primary>fo_string_new</primary></indexterm><programlisting><link linkend="FoDatatype">FoDatatype</link>* fo_string_new (void);</programlisting>
<para>
Creates a new <link linkend="FoString"><type>FoString</type></link> initialized to default value.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the new <link linkend="FoString"><type>FoString</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-string-new-with-value" role="function">
<title>fo_string_new_with_value ()</title>
<indexterm zone="fo-string-new-with-value"><primary>fo_string_new_with_value</primary></indexterm><programlisting><link linkend="FoDatatype">FoDatatype</link>* fo_string_new_with_value (const <link linkend="gchar">gchar</link> *value);</programlisting>
<para>
Creates a new <link linkend="FoString"><type>FoString</type></link> set to <parameter>value</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>value</parameter> :</term>
<listitem><simpara> String of the new <link linkend="FoString"><type>FoString</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The new <link linkend="FoString"><type>FoString</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-string-get-value" role="function">
<title>fo_string_get_value ()</title>
<indexterm zone="fo-string-get-value"><primary>fo_string_get_value</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* fo_string_get_value (<link linkend="FoDatatype">FoDatatype</link> *string);</programlisting>
<para>
Get the value of <parameter>string</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>string</parameter> :</term>
<listitem><simpara> <link linkend="FoString"><type>FoString</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Numeric value of <parameter>string</parameter>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-string-get-string-one" role="function">
<title>fo_string_get_string_one ()</title>
<indexterm zone="fo-string-get-string-one"><primary>fo_string_get_string_one</primary></indexterm><programlisting><link linkend="FoDatatype">FoDatatype</link>* fo_string_get_string_one (void);</programlisting>
<para>
Create and return an <link linkend="FoString"><type>FoString</type></link> with the well-known value "1".
</para>
<para>
This saves creation of multiple <link linkend="FoString"><type>FoString</type></link> objects that all have the
value "1".</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="FoString"><type>FoString</type></link> with value "1".
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
<refsect1 id="FoString.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="FoString--value"><title>The <literal>"value"</literal> property</title>
<indexterm zone="FoString--value"><primary>FoString:value</primary></indexterm><programlisting> "value" <link linkend="gchar">gchar</link>* : Read / Write / Construct Only</programlisting>
<para>String value.</para><para>Default value: NULL</para>
</refsect2>
</refsect1>
</refentry>
|
