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
|
<refentry id="xmlroff-FoImage">
<refmeta>
<refentrytitle role="top_of_page" id="xmlroff-FoImage.top_of_page">FoImage</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>XMLROFF Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>FoImage</refname>
<refpurpose></refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="xmlroff-FoImage.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="FoImage">FoImage</link>;
<link linkend="FoImageClass">FoImageClass</link>;
<link linkend="FoImage">FoImage</link>* <link linkend="fo-image-new">fo_image_new</link> (void);
<link linkend="FoImage">FoImage</link>* <link linkend="fo-image-new-from-uri">fo_image_new_from_uri</link> (const <link linkend="gchar">gchar</link> *uri,
const <link linkend="gchar">gchar</link> *base);
const <link linkend="gchar">gchar</link>* <link linkend="fo-image-get-uri">fo_image_get_uri</link> (<link linkend="FoImage">FoImage</link> *fo_image);
<link linkend="FoDatatype">FoDatatype</link>* <link linkend="fo-image-get-width">fo_image_get_width</link> (const <link linkend="FoImage">FoImage</link> *fo_image);
<link linkend="FoDatatype">FoDatatype</link>* <link linkend="fo-image-get-height">fo_image_get_height</link> (const <link linkend="FoImage">FoImage</link> *fo_image);
</synopsis>
</refsynopsisdiv>
<refsect1 id="xmlroff-FoImage.description" role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 id="xmlroff-FoImage.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="FoImage" role="struct">
<title>FoImage</title>
<indexterm zone="FoImage"><primary>FoImage</primary></indexterm><programlisting>typedef struct _FoImage FoImage;</programlisting>
<para>
</para></refsect2>
<refsect2 id="FoImageClass" role="struct">
<title>FoImageClass</title>
<indexterm zone="FoImageClass"><primary>FoImageClass</primary></indexterm><programlisting>typedef struct _FoImageClass FoImageClass;</programlisting>
<para>
</para></refsect2>
<refsect2 id="fo-image-new" role="function">
<title>fo_image_new ()</title>
<indexterm zone="fo-image-new"><primary>fo_image_new</primary></indexterm><programlisting><link linkend="FoImage">FoImage</link>* fo_image_new (void);</programlisting>
<para>
Creates a new <link linkend="FoImage"><type>FoImage</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the newly created <link linkend="FoImage"><type>FoImage</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-image-new-from-uri" role="function">
<title>fo_image_new_from_uri ()</title>
<indexterm zone="fo-image-new-from-uri"><primary>fo_image_new_from_uri</primary></indexterm><programlisting><link linkend="FoImage">FoImage</link>* fo_image_new_from_uri (const <link linkend="gchar">gchar</link> *uri,
const <link linkend="gchar">gchar</link> *base);</programlisting>
<para>
Creates a new <link linkend="FoImage"><type>FoImage</type></link> from the resource at <parameter>uri</parameter>.
</para>
<para>
If <parameter>uri</parameter> is a relative URI, it is resolved relative to <parameter>base</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>uri</parameter> :</term>
<listitem><simpara> URI of image.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>base</parameter> :</term>
<listitem><simpara> Base URI for resolving relative URI <parameter>uri</parameter> values.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the newly created <link linkend="FoImageo"><type>FoImageo</type></link> or <link linkend="NULL:CAPS"><type>NULL</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-image-get-uri" role="function">
<title>fo_image_get_uri ()</title>
<indexterm zone="fo-image-get-uri"><primary>fo_image_get_uri</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* fo_image_get_uri (<link linkend="FoImage">FoImage</link> *fo_image);</programlisting>
<para>
Get the URI in <parameter>fo_image</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>fo_image</parameter> :</term>
<listitem><simpara> <link linkend="FoImage"><type>FoImage</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> URI of image to make <parameter>fo_image</parameter>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-image-get-width" role="function">
<title>fo_image_get_width ()</title>
<indexterm zone="fo-image-get-width"><primary>fo_image_get_width</primary></indexterm><programlisting><link linkend="FoDatatype">FoDatatype</link>* fo_image_get_width (const <link linkend="FoImage">FoImage</link> *fo_image);</programlisting>
<para>
Gets the intrinsic width of <parameter>fo_image</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>fo_image</parameter> :</term>
<listitem><simpara> <link linkend="FoImage"><type>FoImage</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The intrinsic width of <parameter>fo_image</parameter>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-image-get-height" role="function">
<title>fo_image_get_height ()</title>
<indexterm zone="fo-image-get-height"><primary>fo_image_get_height</primary></indexterm><programlisting><link linkend="FoDatatype">FoDatatype</link>* fo_image_get_height (const <link linkend="FoImage">FoImage</link> *fo_image);</programlisting>
<para>
Gets the intrinsic height of <parameter>fo_image</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>fo_image</parameter> :</term>
<listitem><simpara> <link linkend="FoImage"><type>FoImage</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The intrinsic height of <parameter>fo_image</parameter>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|