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 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229
|
<refentry id="FoAreaLayout">
<refmeta>
<refentrytitle role="top_of_page" id="FoAreaLayout.top_of_page">FoAreaLayout</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>XMLROFF Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>FoAreaLayout</refname>
<refpurpose></refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="FoAreaLayout.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="FoAreaLayout-struct">FoAreaLayout</link>;
<link linkend="FoAreaLayoutClass">FoAreaLayoutClass</link>;
<link linkend="FoArea">FoArea</link>* <link linkend="fo-area-layout-new">fo_area_layout_new</link> (void);
<link linkend="FoArea">FoArea</link>* <link linkend="fo-area-layout-new-with-layout">fo_area_layout_new_with_layout</link> (<link linkend="FoLayout">FoLayout</link> *layout);
<link linkend="void">void</link> <link linkend="fo-area-layout-set-layout">fo_area_layout_set_layout</link> (<link linkend="FoArea">FoArea</link> *fo_area_layout,
<link linkend="FoLayout">FoLayout</link> *new_layout);
<link linkend="FoLayout">FoLayout</link>* <link linkend="fo-area-layout-get-layout">fo_area_layout_get_layout</link> (<link linkend="FoArea">FoArea</link> *fo_area_layout);
<link linkend="void">void</link> <link linkend="fo-area-layout-set-line-first">fo_area_layout_set_line_first</link> (<link linkend="FoArea">FoArea</link> *fo_area_layout,
<link linkend="guint">guint</link> new_line_first);
<link linkend="guint">guint</link> <link linkend="fo-area-layout-get-line-first">fo_area_layout_get_line_first</link> (<link linkend="FoArea">FoArea</link> *fo_area_layout);
<link linkend="void">void</link> <link linkend="fo-area-layout-set-line-last">fo_area_layout_set_line_last</link> (<link linkend="FoArea">FoArea</link> *fo_area_layout,
<link linkend="guint">guint</link> new_line_last);
<link linkend="guint">guint</link> <link linkend="fo-area-layout-get-line-last">fo_area_layout_get_line_last</link> (<link linkend="FoArea">FoArea</link> *fo_area_layout);
<link linkend="gdouble">gdouble</link> <link linkend="fo-area-layout-get-line-height">fo_area_layout_get_line_height</link> (<link linkend="FoArea">FoArea</link> *fo_area_layout,
<link linkend="gint">gint</link> line_number);
</synopsis>
</refsynopsisdiv>
<refsect1 id="FoAreaLayout.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="FoArea">FoArea</link>
+----<link linkend="FoAreaArea">FoAreaArea</link>
+----FoAreaLayout
</synopsis>
</refsect1>
<refsect1 id="FoAreaLayout.properties" role="properties">
<title role="properties.title">Properties</title>
<synopsis>
"<link linkend="FoAreaLayout--layout">layout</link>" <link linkend="gpointer">gpointer</link> : Read / Write
</synopsis>
</refsect1>
<refsect1 id="FoAreaLayout.description" role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 id="FoAreaLayout.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="FoAreaLayout-struct" role="struct">
<title>FoAreaLayout</title>
<indexterm zone="FoAreaLayout-struct"><primary>FoAreaLayout</primary></indexterm><programlisting>typedef struct _FoAreaLayout FoAreaLayout;</programlisting>
<para>
</para></refsect2>
<refsect2 id="FoAreaLayoutClass" role="struct">
<title>FoAreaLayoutClass</title>
<indexterm zone="FoAreaLayoutClass"><primary>FoAreaLayoutClass</primary></indexterm><programlisting>typedef struct _FoAreaLayoutClass FoAreaLayoutClass;</programlisting>
<para>
</para></refsect2>
<refsect2 id="fo-area-layout-new" role="function">
<title>fo_area_layout_new ()</title>
<indexterm zone="fo-area-layout-new"><primary>fo_area_layout_new</primary></indexterm><programlisting><link linkend="FoArea">FoArea</link>* fo_area_layout_new (void);</programlisting>
<para>
Creates a new <link linkend="FoAreaLayout"><type>FoAreaLayout</type></link> initialized to default value.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the new <link linkend="FoAreaLayout"><type>FoAreaLayout</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-area-layout-new-with-layout" role="function">
<title>fo_area_layout_new_with_layout ()</title>
<indexterm zone="fo-area-layout-new-with-layout"><primary>fo_area_layout_new_with_layout</primary></indexterm><programlisting><link linkend="FoArea">FoArea</link>* fo_area_layout_new_with_layout (<link linkend="FoLayout">FoLayout</link> *layout);</programlisting>
<para>
Creates a new <link linkend="FoAreaLayout"><type>FoAreaLayout</type></link> initialized with <parameter>layout</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>layout</parameter> :</term>
<listitem><simpara> <link linkend="FoLayout"><type>FoLayout</type></link> used by the new <link linkend="FoAreaLayout"><type>FoAreaLayout</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the new <link linkend="FoAreaLayout"><type>FoAreaLayout</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-area-layout-set-layout" role="function">
<title>fo_area_layout_set_layout ()</title>
<indexterm zone="fo-area-layout-set-layout"><primary>fo_area_layout_set_layout</primary></indexterm><programlisting><link linkend="void">void</link> fo_area_layout_set_layout (<link linkend="FoArea">FoArea</link> *fo_area_layout,
<link linkend="FoLayout">FoLayout</link> *new_layout);</programlisting>
<para>
Sets the <link linkend="layout"><type>layout</type></link> property of <parameter>area_area</parameter> to <parameter>new_layout</parameter></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>fo_area_layout</parameter> :</term>
<listitem><simpara> The <link linkend="FoAreaLayout"><type>FoAreaLayout</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>new_layout</parameter> :</term>
<listitem><simpara> The new "layout" property value
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-area-layout-get-layout" role="function">
<title>fo_area_layout_get_layout ()</title>
<indexterm zone="fo-area-layout-get-layout"><primary>fo_area_layout_get_layout</primary></indexterm><programlisting><link linkend="FoLayout">FoLayout</link>* fo_area_layout_get_layout (<link linkend="FoArea">FoArea</link> *fo_area_layout);</programlisting>
<para>
Gets the <link linkend="layout"><type>layout</type></link> property of <parameter>area_layout</parameter></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>fo_area_layout</parameter> :</term>
<listitem><simpara> The <link linkend="FoAreaLayout"><type>FoAreaLayout</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The "layout" property value
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-area-layout-set-line-first" role="function">
<title>fo_area_layout_set_line_first ()</title>
<indexterm zone="fo-area-layout-set-line-first"><primary>fo_area_layout_set_line_first</primary></indexterm><programlisting><link linkend="void">void</link> fo_area_layout_set_line_first (<link linkend="FoArea">FoArea</link> *fo_area_layout,
<link linkend="guint">guint</link> new_line_first);</programlisting>
<para>
Sets the <link linkend="line-first"><type>line-first</type></link> property of <parameter>area_area</parameter> to <parameter>new_line_first</parameter></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>fo_area_layout</parameter> :</term>
<listitem><simpara> The <link linkend="FoAreaLayout"><type>FoAreaLayout</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>new_line_first</parameter> :</term>
<listitem><simpara> The new "line_first" property value
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-area-layout-get-line-first" role="function">
<title>fo_area_layout_get_line_first ()</title>
<indexterm zone="fo-area-layout-get-line-first"><primary>fo_area_layout_get_line_first</primary></indexterm><programlisting><link linkend="guint">guint</link> fo_area_layout_get_line_first (<link linkend="FoArea">FoArea</link> *fo_area_layout);</programlisting>
<para>
Gets the <link linkend="line-first"><type>line-first</type></link> property of <parameter>area_layout</parameter></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>fo_area_layout</parameter> :</term>
<listitem><simpara> The <link linkend="FoAreaLayout"><type>FoAreaLayout</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The "line_first" property value
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-area-layout-set-line-last" role="function">
<title>fo_area_layout_set_line_last ()</title>
<indexterm zone="fo-area-layout-set-line-last"><primary>fo_area_layout_set_line_last</primary></indexterm><programlisting><link linkend="void">void</link> fo_area_layout_set_line_last (<link linkend="FoArea">FoArea</link> *fo_area_layout,
<link linkend="guint">guint</link> new_line_last);</programlisting>
<para>
Sets the <link linkend="line-last"><type>line-last</type></link> property of <parameter>fo_area_layout</parameter> to <parameter>new_line_last</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>fo_area_layout</parameter> :</term>
<listitem><simpara> The <link linkend="FoAreaLayout"><type>FoAreaLayout</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>new_line_last</parameter> :</term>
<listitem><simpara> The new "line_last" property value.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-area-layout-get-line-last" role="function">
<title>fo_area_layout_get_line_last ()</title>
<indexterm zone="fo-area-layout-get-line-last"><primary>fo_area_layout_get_line_last</primary></indexterm><programlisting><link linkend="guint">guint</link> fo_area_layout_get_line_last (<link linkend="FoArea">FoArea</link> *fo_area_layout);</programlisting>
<para>
Gets the <link linkend="line-last"><type>line-last</type></link> property of <parameter>fo_area_layout</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>fo_area_layout</parameter> :</term>
<listitem><simpara> The <link linkend="FoAreaLayout"><type>FoAreaLayout</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The "line_last" property value.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-area-layout-get-line-height" role="function">
<title>fo_area_layout_get_line_height ()</title>
<indexterm zone="fo-area-layout-get-line-height"><primary>fo_area_layout_get_line_height</primary></indexterm><programlisting><link linkend="gdouble">gdouble</link> fo_area_layout_get_line_height (<link linkend="FoArea">FoArea</link> *fo_area_layout,
<link linkend="gint">gint</link> line_number);</programlisting>
<para>
Get the height of line <parameter>line_number</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>fo_area_layout</parameter> :</term>
<listitem><simpara> <link linkend="FoArea"><type>FoArea</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>line_number</parameter> :</term>
<listitem><simpara> Number of the line for which to get the height.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The line height in points.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
<refsect1 id="FoAreaLayout.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="FoAreaLayout--layout"><title>The <literal>"layout"</literal> property</title>
<indexterm zone="FoAreaLayout--layout"><primary>FoAreaLayout:layout</primary></indexterm><programlisting> "layout" <link linkend="gpointer">gpointer</link> : Read / Write</programlisting>
<para>FoLayout layout of formatted text of block.</para></refsect2>
</refsect1>
</refentry>
|