utils.xml

GTK+-2.0源码之pango-1.15.6.tar.gz

</simpara></listitem></varlistentry>
<varlistentry><term><parameter>out</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GString"><type>GString</type></link> into which to write the result
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> if a parse error occurred.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="pango-scan-int" role="function"/>pango_scan_int ()</title>
<indexterm><primary>pango_scan_int</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    pango_scan_int                  (const <link linkend="char">char</link> **pos,
                                             <link linkend="int">int</link> *out);</programlisting>
<para>
Scans an integer.
Leading white space is skipped.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>pos</parameter>&nbsp;:</term>
<listitem><simpara> in/out string position
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>out</parameter>&nbsp;:</term>
<listitem><simpara> an int into which to write the result
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> if a parse error occurred.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="pango-config-key-get" role="function"/>pango_config_key_get ()</title>
<indexterm><primary>pango_config_key_get</primary></indexterm><programlisting><link linkend="char">char</link>*       pango_config_key_get            (const <link linkend="char">char</link> *key);</programlisting>
<para>
Looks up a key in the Pango config database
(pseudo-win.ini style, read from $sysconfdir/pango/pangorc,
 ~/.pangorc, and getenv (PANGO_RC_FILE).)</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>key</parameter>&nbsp;:</term>
<listitem><simpara> Key to look up, in the form "SECTION/KEY".
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the value, if found, otherwise <link linkend="NULL:CAPS"><literal>NULL</literal></link>. The value is a
newly-allocated string and must be freed with <link linkend="g-free"><function>g_free()</function></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="pango-lookup-aliases" role="function"/>pango_lookup_aliases ()</title>
<indexterm><primary>pango_lookup_aliases</primary></indexterm><programlisting><link linkend="void">void</link>        pango_lookup_aliases            (const <link linkend="char">char</link> *fontname,
                                             <link linkend="char">char</link> ***families,
                                             <link linkend="int">int</link> *n_families);</programlisting>
<para>
Look up all user defined aliases for the alias <parameter>fontname</parameter>.
The resulting font family names will be stored in <parameter>families</parameter>,
and the number of families in <parameter>n_families</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>fontname</parameter>&nbsp;:</term>
<listitem><simpara> an ascii string
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>families</parameter>&nbsp;:</term>
<listitem><simpara> will be set to an array of font family names.
   this array is owned by pango and should not be freed.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>n_families</parameter>&nbsp;:</term>
<listitem><simpara> will be set to the length of the <parameter>families</parameter> array.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="pango-parse-enum" role="function" condition="since:1.16"/>pango_parse_enum ()</title>
<indexterm role="1.16"><primary>pango_parse_enum</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    pango_parse_enum                (<link linkend="GType">GType</link> type,
                                             const <link linkend="char">char</link> *str,
                                             <link linkend="int">int</link> *value,
                                             <link linkend="gboolean">gboolean</link> warn,
                                             <link linkend="char">char</link> **possible_values);</programlisting>
<para>
Parses an enum type and stored the result in <parameter>value</parameter>.
</para>
<para>
If <parameter>str</parameter> does not match the nick name of any of the possible values for the
enum, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> is returned, a warning is issued if <parameter>warn</parameter> is <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>, and a
string representing the list of possible values is stored in
<parameter>possible_values</parameter>.  The list is slash-separated, eg.
"none/start/middle/end".  If failed and <parameter>possible_values</parameter> is not <link linkend="NULL:CAPS"><literal>NULL</literal></link>,
returned string should be freed using <link linkend="g-free"><function>g_free()</function></link>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>type</parameter>&nbsp;:</term>
<listitem><simpara> enum type to parse, eg. <link linkend="PANGO-TYPE-ELLIPSIZE-MODE:CAPS"><literal>PANGO_TYPE_ELLIPSIZE_MODE</literal></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>str</parameter>&nbsp;:</term>
<listitem><simpara> string to parse.  May be <link linkend="NULL:CAPS"><literal>NULL</literal></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value</parameter>&nbsp;:</term>
<listitem><simpara> integer to store the result in, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>warn</parameter>&nbsp;:</term>
<listitem><simpara> if <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>, issue a <link linkend="g-warning"><function>g_warning()</function></link> on bad input.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>possible_values</parameter>&nbsp;:</term>
<listitem><simpara> place to store list of possible values on failure, 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 <parameter>str</parameter> was successfully parsed.

</simpara></listitem></varlistentry>
</variablelist><para>Since  1.16
</para></refsect2>
<refsect2>
<title><anchor id="pango-parse-style" role="function"/>pango_parse_style ()</title>
<indexterm><primary>pango_parse_style</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    pango_parse_style               (const <link linkend="char">char</link> *str,
                                             <link linkend="PangoStyle">PangoStyle</link> *style,
                                             <link linkend="gboolean">gboolean</link> warn);</programlisting>
<para>
Parses a font style. The allowed values are "normal",
"italic" and "oblique", case variations being
ignored.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>str</parameter>&nbsp;:</term>
<listitem><simpara> a string to parse.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>style</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="PangoStyle"><type>PangoStyle</type></link> to store the result in.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>warn</parameter>&nbsp;:</term>
<listitem><simpara> if <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>, issue a <link linkend="g-warning"><function>g_warning()</function></link> on bad input.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>str</parameter> was successfully parsed.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="pango-parse-variant" role="function"/>pango_parse_variant ()</title>
<indexterm><primary>pango_parse_variant</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    pango_parse_variant             (const <link linkend="char">char</link> *str,
                                             <link linkend="PangoVariant">PangoVariant</link> *variant,
                                             <link linkend="gboolean">gboolean</link> warn);</programlisting>
<para>
Parses a font variant. The allowed values are "normal"
and "smallcaps" or "small_caps", case variations being
ignored.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>str</parameter>&nbsp;:</term>
<listitem><simpara> a string to parse.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>variant</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="PangoVariant"><type>PangoVariant</type></link> to store the result in.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>warn</parameter>&nbsp;:</term>
<listitem><simpara> if <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>, issue a <link linkend="g-warning"><function>g_warning()</function></link> on bad input.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>str</parameter> was successfully parsed.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="pango-parse-weight" role="function"/>pango_parse_weight ()</title>
<indexterm><primary>pango_parse_weight</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    pango_parse_weight              (const <link linkend="char">char</link> *str,
                                             <link linkend="PangoWeight">PangoWeight</link> *weight,
                                             <link linkend="gboolean">gboolean</link> warn);</programlisting>
<para>
Parses a font weight. The allowed values are "heavy",
"ultrabold", "bold", "normal", "light", "ultraleight"
and integers. Case variations are ignored.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>str</parameter>&nbsp;:</term>
<listitem><simpara> a string to parse.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>weight</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="PangoWeight"><type>PangoWeight</type></link> to store the result in.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>warn</parameter>&nbsp;:</term>
<listitem><simpara> if <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>, issue a <link linkend="g-warning"><function>g_warning()</function></link> on bad input.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>str</parameter> was successfully parsed.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="pango-parse-stretch" role="function"/>pango_parse_stretch ()</title>
<indexterm><primary>pango_parse_stretch</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    pango_parse_stretch             (const <link linkend="char">char</link> *str,
                                             <link linkend="PangoStretch">PangoStretch</link> *stretch,
                                             <link linkend="gboolean">gboolean</link> warn);</programlisting>
<para>
Parses a font stretch. The allowed values are
"ultra_condensed", "extra_condensed", "condensed",
"semi_condensed", "normal", "semi_expanded", "expanded",
"extra_expanded" and "ultra_expanded". Case variations are
ignored and the '_' characters may be omitted.</para>