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
|
<refentry id="FoInlineFoIface">
<refmeta>
<refentrytitle role="top_of_page" id="FoInlineFoIface.top_of_page">FoInlineFoIface</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>XMLROFF Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>FoInlineFoIface</refname>
<refpurpose></refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="FoInlineFoIface.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
#define <link linkend="FO-INLINE-FO-IFACE:CAPS">FO_INLINE_FO_IFACE</link> (obj)
<link linkend="FoInlineFo">FoInlineFo</link>;
<link linkend="FoInlineFoIface-struct">FoInlineFoIface</link>;
<link linkend="void">void</link> <link linkend="fo-inline-fo-get-text-attr-list">fo_inline_fo_get_text_attr_list</link> (<link linkend="FoFo">FoFo</link> *fo_inline_fo,
<link linkend="FoDoc">FoDoc</link> *fo_doc,
<link linkend="GString">GString</link> *text,
<link linkend="GList">GList</link> **attr_glist,
<link linkend="guint">guint</link> debug_level);
<link linkend="gboolean">gboolean</link> <link linkend="fo-inline-fo-is-linefeed">fo_inline_fo_is_linefeed</link> (const <link linkend="gchar">gchar</link> *string);
<link linkend="gboolean">gboolean</link> <link linkend="fo-inline-fo-is-non-linefeed-white-space">fo_inline_fo_is_non_linefeed_white_space</link>
(const <link linkend="gchar">gchar</link> *string);
<link linkend="gboolean">gboolean</link> <link linkend="fo-inline-fo-is-white-space">fo_inline_fo_is_white_space</link> (const <link linkend="gchar">gchar</link> *string);
</synopsis>
</refsynopsisdiv>
<refsect1 id="FoInlineFoIface.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GInterface">GInterface</link>
+----FoInlineFoIface
</synopsis>
</refsect1>
<refsect1 id="FoInlineFoIface.prerequisites" role="prerequisites">
<title role="prerequisites.title">Prerequisites</title>
<para>
FoInlineFoIface requires
<link linkend="FoFo">FoFo</link>.</para>
</refsect1>
<refsect1 id="FoInlineFoIface.implementations" role="implementations">
<title role="implementations.title">Known Implementations</title>
<para>
FoInlineFoIface is implemented by
<link linkend="FoInlineContainer">FoInlineContainer</link>, <link linkend="FoBasicLink">FoBasicLink</link>, <link linkend="FoLeader">FoLeader</link>, <link linkend="FoInstreamForeignObject">FoInstreamForeignObject</link>, <link linkend="FoPageNumber">FoPageNumber</link>, <link linkend="FoText">FoText</link>, <link linkend="FoExternalGraphic">FoExternalGraphic</link>, <link linkend="FoMultiToggle">FoMultiToggle</link>, <link linkend="FoPageNumberCitation">FoPageNumberCitation</link>, <link linkend="FoFootnote">FoFootnote</link>, <link linkend="FoInline">FoInline</link>, <link linkend="FoBidiOverride">FoBidiOverride</link>, <link linkend="FoCharacter">FoCharacter</link> and <link linkend="FoWrapperInline">FoWrapperInline</link>.</para>
</refsect1>
<refsect1 id="FoInlineFoIface.description" role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 id="FoInlineFoIface.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="FO-INLINE-FO-IFACE:CAPS" role="macro">
<title>FO_INLINE_FO_IFACE()</title>
<indexterm zone="FO-INLINE-FO-IFACE:CAPS"><primary>FO_INLINE_FO_IFACE</primary></indexterm><programlisting>#define FO_INLINE_FO_IFACE(obj) (G_TYPE_CHECK_CLASS_CAST ((obj), FO_TYPE_INLINE_FO, FoInlineFoIface))
</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>obj</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="FoInlineFo" role="struct">
<title>FoInlineFo</title>
<indexterm zone="FoInlineFo"><primary>FoInlineFo</primary></indexterm><programlisting>typedef struct _FoInlineFo FoInlineFo;</programlisting>
<para>
</para></refsect2>
<refsect2 id="FoInlineFoIface-struct" role="struct">
<title>FoInlineFoIface</title>
<indexterm zone="FoInlineFoIface-struct"><primary>FoInlineFoIface</primary></indexterm><programlisting>typedef struct _FoInlineFoIface FoInlineFoIface;</programlisting>
<para>
</para></refsect2>
<refsect2 id="fo-inline-fo-get-text-attr-list" role="function">
<title>fo_inline_fo_get_text_attr_list ()</title>
<indexterm zone="fo-inline-fo-get-text-attr-list"><primary>fo_inline_fo_get_text_attr_list</primary></indexterm><programlisting><link linkend="void">void</link> fo_inline_fo_get_text_attr_list (<link linkend="FoFo">FoFo</link> *fo_inline_fo,
<link linkend="FoDoc">FoDoc</link> *fo_doc,
<link linkend="GString">GString</link> *text,
<link linkend="GList">GList</link> **attr_glist,
<link linkend="guint">guint</link> debug_level);</programlisting>
<para>
Gets the text of the inline FO and its associated list of Pango attributes</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>fo_inline_fo</parameter> :</term>
<listitem><simpara> The <parameter>FoInlineFo</parameter> object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>fo_doc</parameter> :</term>
<listitem><simpara> The <link linkend="FoDoc"><type>FoDoc</type></link> that will render <parameter>fo_inline_fo</parameter>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>text</parameter> :</term>
<listitem><simpara> The text of the inline FO
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>attr_glist</parameter> :</term>
<listitem><simpara> The list of Pango attributes for the inline FO
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>debug_level</parameter> :</term>
<listitem><simpara> Debug level
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-inline-fo-is-linefeed" role="function">
<title>fo_inline_fo_is_linefeed ()</title>
<indexterm zone="fo-inline-fo-is-linefeed"><primary>fo_inline_fo_is_linefeed</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> fo_inline_fo_is_linefeed (const <link linkend="gchar">gchar</link> *string);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>string</parameter> :</term>
<listitem><simpara> the string
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if the current character is a linefeed character,
otherwise FALSE
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-inline-fo-is-non-linefeed-white-space" role="function">
<title>fo_inline_fo_is_non_linefeed_white_space ()</title>
<indexterm zone="fo-inline-fo-is-non-linefeed-white-space"><primary>fo_inline_fo_is_non_linefeed_white_space</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> fo_inline_fo_is_non_linefeed_white_space
(const <link linkend="gchar">gchar</link> *string);</programlisting>
<para>
From http://www.w3.org/TR/xml/<link linkend="sec-common-syn"><type>sec-common-syn</type></link>
</para>
<para>
[3] S ::= (<link linkend="x20"><type>x20</type></link> | <link linkend="x9"><type>x9</type></link> | <link linkend="xD"><type>xD</type></link> | <link linkend="xA"><type>xA</type></link>)+</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>string</parameter> :</term>
<listitem><simpara> the string
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if the current character is an white space character,
otherwise FALSE
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="fo-inline-fo-is-white-space" role="function">
<title>fo_inline_fo_is_white_space ()</title>
<indexterm zone="fo-inline-fo-is-white-space"><primary>fo_inline_fo_is_white_space</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> fo_inline_fo_is_white_space (const <link linkend="gchar">gchar</link> *string);</programlisting>
<para>
From http://www.w3.org/TR/xml/<link linkend="sec-common-syn"><type>sec-common-syn</type></link>
</para>
<para>
[3] S ::= (<link linkend="x20"><type>x20</type></link> | <link linkend="x9"><type>x9</type></link> | <link linkend="xD"><type>xD</type></link> | <link linkend="xA"><type>xA</type></link>)+</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>string</parameter> :</term>
<listitem><simpara> the string
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if the current character is an white space character,
otherwise FALSE
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|