opentype.xml

Pango is a library for layout and rendering of text, with an emphasis on internationalization. Pang

<listitem><simpara>Fourth character.


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="PANGO-OT-TAG-MAKE-FROM-STRING:CAPS" role="macro">
<title>PANGO_OT_TAG_MAKE_FROM_STRING()</title>
<indexterm zone="PANGO-OT-TAG-MAKE-FROM-STRING:CAPS"><primary>PANGO_OT_TAG_MAKE_FROM_STRING</primary></indexterm><programlisting>#define             PANGO_OT_TAG_MAKE_FROM_STRING(s)</programlisting>
<para>
Creates a <link linkend="PangoOTTag"><type>PangoOTTag</type></link> from a string. The string should be at least
four characters long (pad with space characters if needed), and need
not be nul-terminated.  This is a convenience wrapper around
<link linkend="PANGO-OT-TAG-MAKE:CAPS"><function>PANGO_OT_TAG_MAKE()</function></link>, but cannot be used in certain situations, for
example, as a switch expression, as it dereferences pointers.
</para><variablelist role="params">
<varlistentry><term><parameter>s</parameter>&nbsp;:</term>
<listitem><simpara>The string representation of the tag.


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="PANGO-OT-ALL-GLYPHS:CAPS" role="macro" condition="since:1.16">
<title>PANGO_OT_ALL_GLYPHS</title>
<indexterm zone="PANGO-OT-ALL-GLYPHS:CAPS" role="1.16"><primary>PANGO_OT_ALL_GLYPHS</primary></indexterm><programlisting>#define PANGO_OT_ALL_GLYPHS			((guint) 0xFFFF)
</programlisting>
<para>
This is used as the property bit in <link linkend="pango-ot-ruleset-add-feature"><function>pango_ot_ruleset_add_feature()</function></link> when a
feature should be applied to all glyphs.
</para><para role="since">Since 1.16


</para></refsect2>
<refsect2 id="PANGO-OT-NO-FEATURE:CAPS" role="macro" condition="since:1.18">
<title>PANGO_OT_NO_FEATURE</title>
<indexterm zone="PANGO-OT-NO-FEATURE:CAPS" role="1.18"><primary>PANGO_OT_NO_FEATURE</primary></indexterm><programlisting>#define PANGO_OT_NO_FEATURE			((guint) 0xFFFF)
</programlisting>
<para>
This is used as a feature index that represent no feature, that is, should be
skipped.  It may be returned as feature index by <link linkend="pango-ot-info-find-feature"><function>pango_ot_info_find_feature()</function></link>
if the feature is not found, and <link linkend="pango-ot-rulset-add-feature"><function>pango_ot_rulset_add_feature()</function></link> function
automatically skips this value, so no special handling is required by the
user.
</para><para role="since">Since 1.18


</para></refsect2>
<refsect2 id="PANGO-OT-NO-SCRIPT:CAPS" role="macro" condition="since:1.18">
<title>PANGO_OT_NO_SCRIPT</title>
<indexterm zone="PANGO-OT-NO-SCRIPT:CAPS" role="1.18"><primary>PANGO_OT_NO_SCRIPT</primary></indexterm><programlisting>#define PANGO_OT_NO_SCRIPT			((guint) 0xFFFF)
</programlisting>
<para>
This is used as a script index that represent no script, that is, when the
requested script was not found, and a default ('DFLT') script was not found
either.  It may be returned as script index by <link linkend="pango-ot-info-find-script"><function>pango_ot_info_find_script()</function></link>
if the script or a default script are not found, all other functions
taking a script index essentially return if the input script index is
this value, so no special handling is required by the user.
</para><para role="since">Since 1.18


</para></refsect2>
<refsect2 id="PANGO-OT-DEFAULT-LANGUAGE:CAPS" role="macro" condition="since:1.16">
<title>PANGO_OT_DEFAULT_LANGUAGE</title>
<indexterm zone="PANGO-OT-DEFAULT-LANGUAGE:CAPS" role="1.16"><primary>PANGO_OT_DEFAULT_LANGUAGE</primary></indexterm><programlisting>#define PANGO_OT_DEFAULT_LANGUAGE		((guint) 0xFFFF)
</programlisting>
<para>
This is used as the language index in <link linkend="pango-ot-info-find-feature"><function>pango_ot_info_find_feature()</function></link> when
the default language system of the script is desired.

It is also returned by <link linkend="pango-ot-info-find-language"><function>pango_ot_info_find_language()</function></link> if the requested language
is not found, or the requested language tag was PANGO_OT_TAG_DEFAULT_LANGUAGE.
The end result is that one can always call <link linkend="pango-ot-tag-from-language"><function>pango_ot_tag_from_language()</function></link>
followed by <link linkend="pango-ot-info-find-language"><function>pango_ot_info_find_language()</function></link> and pass the result to
<link linkend="pango-ot-info-find-feature"><function>pango_ot_info_find_feature()</function></link> without having to worry about falling back to
default language system explicitly.
</para><para role="since">Since 1.16


</para></refsect2>
<refsect2 id="PANGO-OT-TAG-DEFAULT-LANGUAGE:CAPS" role="macro" condition="since:1.18">
<title>PANGO_OT_TAG_DEFAULT_LANGUAGE</title>
<indexterm zone="PANGO-OT-TAG-DEFAULT-LANGUAGE:CAPS" role="1.18"><primary>PANGO_OT_TAG_DEFAULT_LANGUAGE</primary></indexterm><programlisting>#define PANGO_OT_TAG_DEFAULT_LANGUAGE		PANGO_OT_TAG_MAKE ('d', 'f', 'l', 't')
</programlisting>
<para>
This is a <link linkend="PangoOTTag"><type>PangoOTTag</type></link> representing a special language tag 'dflt'.  It is
returned as language tag by <link linkend="pango-ot-tag-from-language"><function>pango_ot_tag_from_language()</function></link> if the requested
language is not found.  It is safe to pass this value to
<link linkend="pango-ot-info-find-language"><function>pango_ot_info_find_language()</function></link> as that function falls back to returning default
language-system if the requested language tag is not found.
</para><para role="since">Since 1.18


</para></refsect2>
<refsect2 id="PANGO-OT-TAG-DEFAULT-SCRIPT:CAPS" role="macro" condition="since:1.18">
<title>PANGO_OT_TAG_DEFAULT_SCRIPT</title>
<indexterm zone="PANGO-OT-TAG-DEFAULT-SCRIPT:CAPS" role="1.18"><primary>PANGO_OT_TAG_DEFAULT_SCRIPT</primary></indexterm><programlisting>#define PANGO_OT_TAG_DEFAULT_SCRIPT		PANGO_OT_TAG_MAKE ('D', 'F', 'L', 'T')
</programlisting>
<para>
This is a <link linkend="PangoOTTag"><type>PangoOTTag</type></link> representing the special script tag 'DFLT'.  It is
returned as script tag by <link linkend="pango-ot-tag-from-script"><function>pango_ot_tag_from_script()</function></link> if the requested script
is not found.
</para><para role="since">Since 1.18


</para></refsect2>
<refsect2 id="pango-ot-info-get" role="function" condition="since:1.2">
<title>pango_ot_info_get ()</title>
<indexterm zone="pango-ot-info-get" role="1.2"><primary>pango_ot_info_get</primary></indexterm><programlisting><link linkend="PangoOTInfo">PangoOTInfo</link>*        pango_ot_info_get                   (<link linkend="FT-Face">FT_Face</link> face);</programlisting>
<para>
Returns the <link linkend="PangoOTInfo"><type>PangoOTInfo</type></link> structure for the given FreeType font face.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>face</parameter>&nbsp;:</term>
<listitem><simpara> a <type>FT_Face</type>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the <link linkend="PangoOTInfo"><type>PangoOTInfo</type></link> for <parameter>face</parameter>. This object will have
the same lifetime as <parameter>face</parameter>.

</simpara></listitem></varlistentry>
</variablelist><para role="since">Since  1.2
</para></refsect2>
<refsect2 id="pango-ot-info-find-script" role="function">
<title>pango_ot_info_find_script ()</title>
<indexterm zone="pango-ot-info-find-script"><primary>pango_ot_info_find_script</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            pango_ot_info_find_script           (<link linkend="PangoOTInfo">PangoOTInfo</link> *info,
                                                         <link linkend="PangoOTTableType">PangoOTTableType</link> table_type,
                                                         <link linkend="PangoOTTag">PangoOTTag</link> script_tag,
                                                         <link linkend="guint">guint</link> *script_index);</programlisting>
<para>
Finds the index of a script.  If not found, tries to find the 'DFLT'
and then 'dflt' scripts and return the index of that in <parameter>script_index</parameter>.
If none of those is found either, <link linkend="PANGO-OT-NO-SCRIPT:CAPS"><literal>PANGO_OT_NO_SCRIPT</literal></link> is placed in
<parameter>script_index</parameter>.
</para>
<para>
All other functions taking an input script_index parameter know
how to handle <link linkend="PANGO-OT-NO-SCRIPT:CAPS"><literal>PANGO_OT_NO_SCRIPT</literal></link>, so one can ignore the return
value of this function completely and proceed, to enjoy the automatic
fallback to the 'DFLT'/'dflt' script.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>info</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="PangoOTInfo"><type>PangoOTInfo</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>table_type</parameter>&nbsp;:</term>
<listitem><simpara> the table type to obtain information about.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>script_tag</parameter>&nbsp;:</term>
<listitem><simpara> the tag of the script to find.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>script_index</parameter>&nbsp;:</term>
<listitem><simpara> location to store the index of the script, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the script was found.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="pango-ot-info-find-language" role="function">
<title>pango_ot_info_find_language ()</title>
<indexterm zone="pango-ot-info-find-language"><primary>pango_ot_info_find_language</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            pango_ot_info_find_language         (<link linkend="PangoOTInfo">PangoOTInfo</link> *info,
                                                         <link linkend="PangoOTTableType">PangoOTTableType</link> table_type,
                                                         <link linkend="guint">guint</link> script_index,
                                                         <link linkend="PangoOTTag">PangoOTTag</link> language_tag,
                                                         <link linkend="guint">guint</link> *language_index,
                                                         <link linkend="guint">guint</link> *required_feature_index);</programlisting>
<para>
Finds the index of a language and its required feature index.
If the language is not found, sets <parameter>language_index</parameter> to
PANGO_OT_DEFAULT_LANGUAGE and the required feature of the default language
system is returned in required_feature_index.  For best compatibility with
some fonts, also searches the language system tag 'dflt' before falling
back to the default language system, but that is transparent to the user.
The user can simply ignore the return value of this function to
automatically fall back to the default language system.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>info</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="PangoOTInfo"><type>PangoOTInfo</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>table_type</parameter>&nbsp;:</term>
<listitem><simpara> the table type to obtain information about.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>script_index</parameter>&nbsp;:</term>
<listitem><simpara> the index of the script whose languages are searched.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>language_tag</parameter>&nbsp;:</term>
<listitem><simpara> the tag of the language to find.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>language_index</parameter>&nbsp;:</term>
<listitem><simpara> location to store the index of the language, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>.