File: fo-tblr.xml

package info (click to toggle)
xmlroff 0.6.2-1.1
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 36,456 kB
  • sloc: ansic: 178,247; xml: 109,155; sh: 8,973; makefile: 1,331; perl: 30
file content (161 lines) | stat: -rw-r--r-- 8,643 bytes parent folder | download | duplicates (4)
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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
<refentry id="xmlroff-FoTblr">
<refmeta>
<refentrytitle role="top_of_page" id="xmlroff-FoTblr.top_of_page">FoTblr</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>XMLROFF Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>FoTblr</refname>
<refpurpose></refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>

<refsynopsisdiv id="xmlroff-FoTblr.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>

<synopsis>
                    <link linkend="FoTblr">FoTblr</link>;
                    <link linkend="FoTblrClass">FoTblrClass</link>;
<link linkend="FoDatatype">FoDatatype</link>*         <link linkend="fo-tblr-new">fo_tblr_new</link>                         (void);
<link linkend="FoDatatype">FoDatatype</link>*         <link linkend="fo-tblr-new-from-values">fo_tblr_new_from_values</link>             (<link linkend="FoDatatype">FoDatatype</link> *top,
                                                         <link linkend="FoDatatype">FoDatatype</link> *bottom,
                                                         <link linkend="FoDatatype">FoDatatype</link> *left,
                                                         <link linkend="FoDatatype">FoDatatype</link> *right);
<link linkend="FoDatatype">FoDatatype</link>*         <link linkend="fo-tblr-get-top">fo_tblr_get_top</link>                     (<link linkend="FoDatatype">FoDatatype</link> *datatype);
<link linkend="FoDatatype">FoDatatype</link>*         <link linkend="fo-tblr-get-bottom">fo_tblr_get_bottom</link>                  (<link linkend="FoDatatype">FoDatatype</link> *datatype);
<link linkend="FoDatatype">FoDatatype</link>*         <link linkend="fo-tblr-get-left">fo_tblr_get_left</link>                    (<link linkend="FoDatatype">FoDatatype</link> *datatype);
<link linkend="FoDatatype">FoDatatype</link>*         <link linkend="fo-tblr-get-right">fo_tblr_get_right</link>                   (<link linkend="FoDatatype">FoDatatype</link> *datatype);
</synopsis>
</refsynopsisdiv>









<refsect1 id="xmlroff-FoTblr.description" role="desc">
<title role="desc.title">Description</title>
<para>

</para>
</refsect1>

<refsect1 id="xmlroff-FoTblr.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="FoTblr" role="struct">
<title>FoTblr</title>
<indexterm zone="FoTblr"><primary>FoTblr</primary></indexterm><programlisting>typedef struct _FoTblr FoTblr;</programlisting>
<para>

</para></refsect2>
<refsect2 id="FoTblrClass" role="struct">
<title>FoTblrClass</title>
<indexterm zone="FoTblrClass"><primary>FoTblrClass</primary></indexterm><programlisting>typedef struct _FoTblrClass FoTblrClass;</programlisting>
<para>

</para></refsect2>
<refsect2 id="fo-tblr-new" role="function">
<title>fo_tblr_new ()</title>
<indexterm zone="fo-tblr-new"><primary>fo_tblr_new</primary></indexterm><programlisting><link linkend="FoDatatype">FoDatatype</link>*         fo_tblr_new                         (void);</programlisting>
<para>
Creates a new <link linkend="FoTblr"><type>FoTblr</type></link> initialized to default value.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the new <link linkend="FoTblr"><type>FoTblr</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-tblr-new-from-values" role="function">
<title>fo_tblr_new_from_values ()</title>
<indexterm zone="fo-tblr-new-from-values"><primary>fo_tblr_new_from_values</primary></indexterm><programlisting><link linkend="FoDatatype">FoDatatype</link>*         fo_tblr_new_from_values             (<link linkend="FoDatatype">FoDatatype</link> *top,
                                                         <link linkend="FoDatatype">FoDatatype</link> *bottom,
                                                         <link linkend="FoDatatype">FoDatatype</link> *left,
                                                         <link linkend="FoDatatype">FoDatatype</link> *right);</programlisting>
<para>
Creates a new <link linkend="FoTblr"><type>FoTblr</type></link> with top, bottom, left and right
components set to provided values.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>top</parameter>&nbsp;:</term>
<listitem><simpara>    <link linkend="FoDatatype"><type>FoDatatype</type></link> to use as top value
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>bottom</parameter>&nbsp;:</term>
<listitem><simpara> <link linkend="FoDatatype"><type>FoDatatype</type></link> to use as bottom value
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>left</parameter>&nbsp;:</term>
<listitem><simpara>   <link linkend="FoDatatype"><type>FoDatatype</type></link> to use as left value
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>right</parameter>&nbsp;:</term>
<listitem><simpara>  <link linkend="FoDatatype"><type>FoDatatype</type></link> to use as right value
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> New <link linkend="FoTblr"><type>FoTblr</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-tblr-get-top" role="function">
<title>fo_tblr_get_top ()</title>
<indexterm zone="fo-tblr-get-top"><primary>fo_tblr_get_top</primary></indexterm><programlisting><link linkend="FoDatatype">FoDatatype</link>*         fo_tblr_get_top                     (<link linkend="FoDatatype">FoDatatype</link> *datatype);</programlisting>
<para>
Gets the top component value of <parameter>datatype</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>datatype</parameter>&nbsp;:</term>
<listitem><simpara> <link linkend="FoTblr"><type>FoTblr</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The top value of <parameter>datatype</parameter>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-tblr-get-bottom" role="function">
<title>fo_tblr_get_bottom ()</title>
<indexterm zone="fo-tblr-get-bottom"><primary>fo_tblr_get_bottom</primary></indexterm><programlisting><link linkend="FoDatatype">FoDatatype</link>*         fo_tblr_get_bottom                  (<link linkend="FoDatatype">FoDatatype</link> *datatype);</programlisting>
<para>
Gets the .bottom component value of <parameter>datatype</parameter></para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>datatype</parameter>&nbsp;:</term>
<listitem><simpara> <link linkend="FoTblr"><type>FoTblr</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The bottom value of <parameter>datatype</parameter>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-tblr-get-left" role="function">
<title>fo_tblr_get_left ()</title>
<indexterm zone="fo-tblr-get-left"><primary>fo_tblr_get_left</primary></indexterm><programlisting><link linkend="FoDatatype">FoDatatype</link>*         fo_tblr_get_left                    (<link linkend="FoDatatype">FoDatatype</link> *datatype);</programlisting>
<para>
Gets the .left component value of <parameter>datatype</parameter></para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>datatype</parameter>&nbsp;:</term>
<listitem><simpara> <link linkend="FoTblr"><type>FoTblr</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The left value of <parameter>datatype</parameter>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-tblr-get-right" role="function">
<title>fo_tblr_get_right ()</title>
<indexterm zone="fo-tblr-get-right"><primary>fo_tblr_get_right</primary></indexterm><programlisting><link linkend="FoDatatype">FoDatatype</link>*         fo_tblr_get_right                   (<link linkend="FoDatatype">FoDatatype</link> *datatype);</programlisting>
<para>
Gets the .right component value of <parameter>datatype</parameter></para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>datatype</parameter>&nbsp;:</term>
<listitem><simpara> <link linkend="FoTblr"><type>FoTblr</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The right value of <parameter>datatype</parameter>
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>




</refentry>