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
142
143
144
145
146
147
|
<refentry id="xmlroff-flow">
<refmeta>
<refentrytitle role="top_of_page" id="xmlroff-flow.top_of_page">flow</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>XMLROFF Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>flow</refname>
<refpurpose></refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="xmlroff-flow.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<anchor id="FoFlow"/>
<synopsis>
<link linkend="FoFlow-struct">FoFlow</link>;
<link linkend="FoFlowClass">FoFlowClass</link>;
<link linkend="FoFo">FoFo</link>* <link linkend="fo-flow-new">fo_flow_new</link> (void);
<link linkend="FoFo">FoFo</link>* <link linkend="fo-flow-get-region-master">fo_flow_get_region_master</link> (<link linkend="FoFo">FoFo</link> *fo_fo);
<link linkend="void">void</link> <link linkend="fo-flow-set-flow-name">fo_flow_set_flow_name</link> (<link linkend="FoFo">FoFo</link> *fo_fo,
<link linkend="FoProperty">FoProperty</link> *new_flow_name);
<link linkend="FoProperty">FoProperty</link>* <link linkend="fo-flow-get-flow-name">fo_flow_get_flow_name</link> (<link linkend="FoFo">FoFo</link> *fo_fo);
</synopsis>
</refsynopsisdiv>
<refsect1 id="xmlroff-flow.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="FoNode">FoNode</link>
+----<link linkend="FoFo">FoFo</link>
+----FoFlow
</synopsis>
</refsect1>
<refsect1 id="xmlroff-flow.properties" role="properties">
<title role="properties.title">Properties</title>
<synopsis>
"<link linkend="FoFlow--flow-name">flow-name</link>" <link linkend="FoProperty">FoProperty</link>* : Read
</synopsis>
</refsect1>
<refsect1 id="xmlroff-flow.description" role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 id="xmlroff-flow.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="FoFlow-struct" role="struct">
<title>FoFlow</title>
<indexterm zone="FoFlow-struct"><primary>FoFlow</primary></indexterm><programlisting>typedef struct _FoFlow FoFlow;</programlisting>
<para>
Instance of the 'flow' formatting object.</para>
<para>
</para></refsect2>
<refsect2 id="FoFlowClass" role="struct">
<title>FoFlowClass</title>
<indexterm zone="FoFlowClass"><primary>FoFlowClass</primary></indexterm><programlisting>typedef struct _FoFlowClass FoFlowClass;</programlisting>
<para>
Class structure for the 'flow' formatting object.</para>
<para>
</para></refsect2>
<refsect2 id="fo-flow-new" role="function">
<title>fo_flow_new ()</title>
<indexterm zone="fo-flow-new"><primary>fo_flow_new</primary></indexterm><programlisting><link linkend="FoFo">FoFo</link>* fo_flow_new (void);</programlisting>
<para>
Creates a new <link linkend="FoFlow"><type>FoFlow</type></link> initialized to default value.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the new <link linkend="FoFlow"><type>FoFlow</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-flow-get-region-master" role="function">
<title>fo_flow_get_region_master ()</title>
<indexterm zone="fo-flow-get-region-master"><primary>fo_flow_get_region_master</primary></indexterm><programlisting><link linkend="FoFo">FoFo</link>* fo_flow_get_region_master (<link linkend="FoFo">FoFo</link> *fo_fo);</programlisting>
<para>
Gets the <link linkend="region-master"><type>region_master</type></link> instance variable of <parameter>flow</parameter></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>fo_fo</parameter> :</term>
<listitem><simpara> The <parameter>FoFlow</parameter> object
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The "region_master" value
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-flow-set-flow-name" role="function">
<title>fo_flow_set_flow_name ()</title>
<indexterm zone="fo-flow-set-flow-name"><primary>fo_flow_set_flow_name</primary></indexterm><programlisting><link linkend="void">void</link> fo_flow_set_flow_name (<link linkend="FoFo">FoFo</link> *fo_fo,
<link linkend="FoProperty">FoProperty</link> *new_flow_name);</programlisting>
<para>
Sets the "flow-name" property of <parameter>fo_fo</parameter> to <parameter>new_flow_name</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>fo_fo</parameter> :</term>
<listitem><simpara> The <link linkend="FoFo"><type>FoFo</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>new_flow_name</parameter> :</term>
<listitem><simpara> The new "flow-name" property value.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-flow-get-flow-name" role="function">
<title>fo_flow_get_flow_name ()</title>
<indexterm zone="fo-flow-get-flow-name"><primary>fo_flow_get_flow_name</primary></indexterm><programlisting><link linkend="FoProperty">FoProperty</link>* fo_flow_get_flow_name (<link linkend="FoFo">FoFo</link> *fo_fo);</programlisting>
<para>
Gets the "flow-name" property of <parameter>fo_fo</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>fo_fo</parameter> :</term>
<listitem><simpara> The <parameter>FoFo</parameter> object.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The "flow-name" property value.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
<refsect1 id="xmlroff-flow.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="FoFlow--flow-name"><title>The <literal>"flow-name"</literal> property</title>
<indexterm zone="FoFlow--flow-name"><primary>FoFlow:flow-name</primary></indexterm><programlisting> "flow-name" <link linkend="FoProperty">FoProperty</link>* : Read</programlisting>
<para>Flow Name property.</para></refsect2>
</refsect1>
</refentry>
|
