text-attributes.xml

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

<refsect2>
<title><anchor id="pango-attr-font-desc-new" role="function"/>pango_attr_font_desc_new ()</title>
<indexterm><primary>pango_attr_font_desc_new</primary></indexterm><programlisting><link linkend="PangoAttribute">PangoAttribute</link>* pango_attr_font_desc_new    (const <link linkend="PangoFontDescription">PangoFontDescription</link> *desc);</programlisting>
<para>
Create a new font description attribute. This attribute
allows setting family, style, weight, variant, stretch,
and size simultaneously.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>desc</parameter>&nbsp;:</term>
<listitem><simpara> the font description
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>  the newly allocated <link linkend="PangoAttribute"><type>PangoAttribute</type></link>, which should be
              freed with <link linkend="pango-attribute-destroy"><function>pango_attribute_destroy()</function></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="pango-attr-foreground-new" role="function"/>pango_attr_foreground_new ()</title>
<indexterm><primary>pango_attr_foreground_new</primary></indexterm><programlisting><link linkend="PangoAttribute">PangoAttribute</link>* pango_attr_foreground_new   (<link linkend="guint16">guint16</link> red,
                                             <link linkend="guint16">guint16</link> green,
                                             <link linkend="guint16">guint16</link> blue);</programlisting>
<para>
Create a new foreground color attribute.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>red</parameter>&nbsp;:</term>
<listitem><simpara> the red value (ranging from 0 to 65535)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>green</parameter>&nbsp;:</term>
<listitem><simpara> the green value
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>blue</parameter>&nbsp;:</term>
<listitem><simpara> the blue value
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the newly allocated <link linkend="PangoAttribute"><type>PangoAttribute</type></link>, which should be
              freed with <link linkend="pango-attribute-destroy"><function>pango_attribute_destroy()</function></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="pango-attr-background-new" role="function"/>pango_attr_background_new ()</title>
<indexterm><primary>pango_attr_background_new</primary></indexterm><programlisting><link linkend="PangoAttribute">PangoAttribute</link>* pango_attr_background_new   (<link linkend="guint16">guint16</link> red,
                                             <link linkend="guint16">guint16</link> green,
                                             <link linkend="guint16">guint16</link> blue);</programlisting>
<para>
Create a new background color attribute.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>red</parameter>&nbsp;:</term>
<listitem><simpara> the red value (ranging from 0 to 65535)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>green</parameter>&nbsp;:</term>
<listitem><simpara> the green value
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>blue</parameter>&nbsp;:</term>
<listitem><simpara> the blue value
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the newly allocated <link linkend="PangoAttribute"><type>PangoAttribute</type></link>, which should be
              freed with <link linkend="pango-attribute-destroy"><function>pango_attribute_destroy()</function></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="pango-attr-strikethrough-new" role="function"/>pango_attr_strikethrough_new ()</title>
<indexterm><primary>pango_attr_strikethrough_new</primary></indexterm><programlisting><link linkend="PangoAttribute">PangoAttribute</link>* pango_attr_strikethrough_new
                                            (<link linkend="gboolean">gboolean</link> strikethrough);</programlisting>
<para>
Create a new strike-through attribute.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>strikethrough</parameter>&nbsp;:</term>
<listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the text should be struck-through.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the newly allocated <link linkend="PangoAttribute"><type>PangoAttribute</type></link>, which should be
              freed with <link linkend="pango-attribute-destroy"><function>pango_attribute_destroy()</function></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="pango-attr-strikethrough-color-new" role="function" condition="since:1.8"/>pango_attr_strikethrough_color_new ()</title>
<indexterm role="1.8"><primary>pango_attr_strikethrough_color_new</primary></indexterm><programlisting><link linkend="PangoAttribute">PangoAttribute</link>* pango_attr_strikethrough_color_new
                                            (<link linkend="guint16">guint16</link> red,
                                             <link linkend="guint16">guint16</link> green,
                                             <link linkend="guint16">guint16</link> blue);</programlisting>
<para>
Create a new strikethrough color attribute. This attribute
modifies the color of strikethrough lines. If not set, strikethrough
lines will use the foreground color.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>red</parameter>&nbsp;:</term>
<listitem><simpara> the red value (ranging from 0 to 65535)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>green</parameter>&nbsp;:</term>
<listitem><simpara> the green value
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>blue</parameter>&nbsp;:</term>
<listitem><simpara> the blue value
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the newly allocated <link linkend="PangoAttribute"><type>PangoAttribute</type></link>, which should be
              freed with <link linkend="pango-attribute-destroy"><function>pango_attribute_destroy()</function></link>.

</simpara></listitem></varlistentry>
</variablelist><para>Since  1.8
</para></refsect2>
<refsect2>
<title><anchor id="pango-attr-underline-new" role="function"/>pango_attr_underline_new ()</title>
<indexterm><primary>pango_attr_underline_new</primary></indexterm><programlisting><link linkend="PangoAttribute">PangoAttribute</link>* pango_attr_underline_new    (<link linkend="PangoUnderline">PangoUnderline</link> underline);</programlisting>
<para>
Create a new underline-style attribute.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>underline</parameter>&nbsp;:</term>
<listitem><simpara> the underline style.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the newly allocated <link linkend="PangoAttribute"><type>PangoAttribute</type></link>, which should be
              freed with <link linkend="pango-attribute-destroy"><function>pango_attribute_destroy()</function></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="pango-attr-underline-color-new" role="function" condition="since:1.8"/>pango_attr_underline_color_new ()</title>
<indexterm role="1.8"><primary>pango_attr_underline_color_new</primary></indexterm><programlisting><link linkend="PangoAttribute">PangoAttribute</link>* pango_attr_underline_color_new
                                            (<link linkend="guint16">guint16</link> red,
                                             <link linkend="guint16">guint16</link> green,
                                             <link linkend="guint16">guint16</link> blue);</programlisting>
<para>
Create a new underline color attribute. This attribute
modifies the color of underlines. If not set, underlines
will use the foreground color.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>red</parameter>&nbsp;:</term>
<listitem><simpara> the red value (ranging from 0 to 65535)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>green</parameter>&nbsp;:</term>
<listitem><simpara> the green value
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>blue</parameter>&nbsp;:</term>
<listitem><simpara> the blue value
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the newly allocated <link linkend="PangoAttribute"><type>PangoAttribute</type></link>, which should be
              freed with <link linkend="pango-attribute-destroy"><function>pango_attribute_destroy()</function></link>.

</simpara></listitem></varlistentry>
</variablelist><para>Since  1.8
</para></refsect2>
<refsect2>
<title><anchor id="PangoUnderline" role="enum"/>enum PangoUnderline</title>
<indexterm><primary>PangoUnderline</primary></indexterm><programlisting>typedef enum {
  PANGO_UNDERLINE_NONE,
  PANGO_UNDERLINE_SINGLE,
  PANGO_UNDERLINE_DOUBLE,
  PANGO_UNDERLINE_LOW,
  PANGO_UNDERLINE_ERROR
} PangoUnderline;
</programlisting>
<para>
the <link linkend="PangoUnderline"><type>PangoUnderline</type></link> enumeration is used to specify
whether text should be underlined, and if so, the type
of underlining.
</para><variablelist role="enum">
<varlistentry>
<term><anchor id="PANGO-UNDERLINE-NONE:CAPS" role="constant"/><literal>PANGO_UNDERLINE_NONE</literal></term>
<listitem><simpara>no underline should be drawn
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="PANGO-UNDERLINE-SINGLE:CAPS" role="constant"/><literal>PANGO_UNDERLINE_SINGLE</literal></term>
<listitem><simpara>a single underline should be drawn
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="PANGO-UNDERLINE-DOUBLE:CAPS" role="constant"/><literal>PANGO_UNDERLINE_DOUBLE</literal></term>
<listitem><simpara>a double underline should be drawn
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="PANGO-UNDERLINE-LOW:CAPS" role="constant"/><literal>PANGO_UNDERLINE_LOW</literal></term>
<listitem><simpara>a single underline should be drawn at a position
                      beneath the ink extents of the text being
                      underlined. This should be used only for underlining
                      single characters, such as for keyboard
                      accelerators. <link linkend="PANGO-UNDERLINE-SINGLE:CAPS"><literal>PANGO_UNDERLINE_SINGLE</literal></link> should
                      be used for extended portions of text.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="PANGO-UNDERLINE-ERROR:CAPS" role="constant"/><literal>PANGO_UNDERLINE_ERROR</literal></term>
<listitem><simpara>a wavy underline should be drawn below.
                      This underline is typically used to indicate
                      an error such as a possilble mispelling; in some
                      cases a contrasting color may automatically
                      be used. This type of underlining is available
                      since Pango 1.4.

</simpara></listitem>
</varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="PANGO-TYPE-UNDERLINE:CAPS" role="macro"/>PANGO_TYPE_UNDERLINE</title>
<indexterm><primary>PANGO_TYPE_UNDERLINE</primary></indexterm><programlisting>#define PANGO_TYPE_UNDERLINE (pango_underline_get_type())
</programlisting>
<para>
The <link linkend="GObject"><type>GObject</type></link> type for <link linkend="PangoUnderline"><type>PangoUnderline</type></link>.
</para></refsect2>
<refsect2>
<title><anchor id="pango-attr-shape-new" role="function"/>pango_attr_shape_new ()</title>
<indexterm><primary>pango_attr_shape_new</primary></indexterm><programlisting><link linkend="PangoAttribute">PangoAttribute</link>* pango_attr_shape_new        (const <link linkend="P