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
|
<refentry id="xmlroff-root">
<refmeta>
<refentrytitle role="top_of_page" id="xmlroff-root.top_of_page">root</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>XMLROFF Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>root</refname>
<refpurpose>'root' formatting object</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="xmlroff-root.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<anchor id="FoRoot"/>
<synopsis>
<link linkend="FoRoot-struct">FoRoot</link>;
<link linkend="FoRootClass">FoRootClass</link>;
<link linkend="FoFo">FoFo</link>* <link linkend="fo-root-new">fo_root_new</link> (void);
<link linkend="FoProperty">FoProperty</link>* <link linkend="fo-root-get-media-usage">fo_root_get_media_usage</link> (<link linkend="FoFo">FoFo</link> *fo_fo);
<link linkend="void">void</link> <link linkend="fo-root-set-media-usage">fo_root_set_media_usage</link> (<link linkend="FoFo">FoFo</link> *fo_fo,
<link linkend="FoProperty">FoProperty</link> *new_media_usage);
</synopsis>
</refsynopsisdiv>
<refsect1 id="xmlroff-root.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>
+----FoRoot
</synopsis>
</refsect1>
<refsect1 id="xmlroff-root.properties" role="properties">
<title role="properties.title">Properties</title>
<synopsis>
"<link linkend="FoRoot--media-usage">media-usage</link>" <link linkend="FoProperty">FoProperty</link>* : Read
</synopsis>
</refsect1>
<refsect1 id="xmlroff-root.description" role="desc">
<title role="desc.title">Description</title>
<para>
Definition: <ulink url="http://www.w3.org/TR/xsl11/#fo_root">http://www.w3.org/TR/xsl11/#fo_root</ulink></para>
<para>
</para>
</refsect1>
<refsect1 id="xmlroff-root.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="FoRoot-struct" role="struct">
<title>FoRoot</title>
<indexterm zone="FoRoot-struct"><primary>FoRoot</primary></indexterm><programlisting>typedef struct _FoRoot FoRoot;</programlisting>
<para>
</para></refsect2>
<refsect2 id="FoRootClass" role="struct">
<title>FoRootClass</title>
<indexterm zone="FoRootClass"><primary>FoRootClass</primary></indexterm><programlisting>typedef struct _FoRootClass FoRootClass;</programlisting>
<para>
</para></refsect2>
<refsect2 id="fo-root-new" role="function">
<title>fo_root_new ()</title>
<indexterm zone="fo-root-new"><primary>fo_root_new</primary></indexterm><programlisting><link linkend="FoFo">FoFo</link>* fo_root_new (void);</programlisting>
<para>
Creates a new <link linkend="FoRoot"><type>FoRoot</type></link> initialized to default value.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the new <link linkend="FoRoot"><type>FoRoot</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-root-get-media-usage" role="function">
<title>fo_root_get_media_usage ()</title>
<indexterm zone="fo-root-get-media-usage"><primary>fo_root_get_media_usage</primary></indexterm><programlisting><link linkend="FoProperty">FoProperty</link>* fo_root_get_media_usage (<link linkend="FoFo">FoFo</link> *fo_fo);</programlisting>
<para>
Gets the "media-usage" property of <parameter>fo_fo</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><emphasis>Returns</emphasis> :</term><listitem><simpara> The "media-usage" property value.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-root-set-media-usage" role="function">
<title>fo_root_set_media_usage ()</title>
<indexterm zone="fo-root-set-media-usage"><primary>fo_root_set_media_usage</primary></indexterm><programlisting><link linkend="void">void</link> fo_root_set_media_usage (<link linkend="FoFo">FoFo</link> *fo_fo,
<link linkend="FoProperty">FoProperty</link> *new_media_usage);</programlisting>
<para>
Sets the "media-usage" property of <parameter>fo_fo</parameter> to <parameter>new_media_usage</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_media_usage</parameter> :</term>
<listitem><simpara> The new "media-usage" property value.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
<refsect1 id="xmlroff-root.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="FoRoot--media-usage"><title>The <literal>"media-usage"</literal> property</title>
<indexterm zone="FoRoot--media-usage"><primary>FoRoot:media-usage</primary></indexterm><programlisting> "media-usage" <link linkend="FoProperty">FoProperty</link>* : Read</programlisting>
<para>Media Usage property.</para></refsect2>
</refsect1>
</refentry>
|