layout.xml

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

</simpara></listitem></varlistentry>
<varlistentry><term><parameter>length</parameter>&nbsp;:</term>
<listitem><simpara> maximum length of <parameter>text</parameter>, in bytes. -1 indicates that
         the string is nul-terminated and the length should be
         calculated.  The text will also be truncated on
         encountering a nul-termination even when <parameter>length</parameter> is
         positive.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="pango-layout-get-text" role="function">
<title>pango_layout_get_text ()</title>
<indexterm zone="pango-layout-get-text"><primary>pango_layout_get_text</primary></indexterm><programlisting>const <link linkend="char">char</link>*         pango_layout_get_text               (<link linkend="PangoLayout">PangoLayout</link> *layout);</programlisting>
<para>
Gets the text in the layout. The returned text should not
be freed or modified.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>layout</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="PangoLayout"><type>PangoLayout</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the text in the <parameter>layout</parameter>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="pango-layout-set-markup" role="function">
<title>pango_layout_set_markup ()</title>
<indexterm zone="pango-layout-set-markup"><primary>pango_layout_set_markup</primary></indexterm><programlisting><link linkend="void">void</link>                pango_layout_set_markup             (<link linkend="PangoLayout">PangoLayout</link> *layout,
                                                         const <link linkend="char">char</link> *markup,
                                                         <link linkend="int">int</link> length);</programlisting>
<para>
Same as <link linkend="pango-layout-set-markup-with-accel"><function>pango_layout_set_markup_with_accel()</function></link>, but
the markup text isn't scanned for accelerators.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>layout</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="PangoLayout"><type>PangoLayout</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>markup</parameter>&nbsp;:</term>
<listitem><simpara> marked-up text
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>length</parameter>&nbsp;:</term>
<listitem><simpara> length of marked-up text in bytes, or -1 if <parameter>markup</parameter> is
nul-terminated
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="pango-layout-set-markup-with-accel" role="function">
<title>pango_layout_set_markup_with_accel ()</title>
<indexterm zone="pango-layout-set-markup-with-accel"><primary>pango_layout_set_markup_with_accel</primary></indexterm><programlisting><link linkend="void">void</link>                pango_layout_set_markup_with_accel  (<link linkend="PangoLayout">PangoLayout</link> *layout,
                                                         const <link linkend="char">char</link> *markup,
                                                         <link linkend="int">int</link> length,
                                                         <link linkend="gunichar">gunichar</link> accel_marker,
                                                         <link linkend="gunichar">gunichar</link> *accel_char);</programlisting>
<para>
Sets the layout text and attribute list from marked-up text (see
<link linkend="PangoMarkupFormat">markup format</link>). Replaces
the current text and attribute list.
</para>
<para>
If <parameter>accel_marker</parameter> is nonzero, the given character will mark the
character following it as an accelerator. For example, <parameter>accel_marker</parameter>
might be an ampersand or underscore. All characters marked
as an accelerator will receive a <link linkend="PANGO-UNDERLINE-LOW:CAPS"><literal>PANGO_UNDERLINE_LOW</literal></link> attribute,
and the first character so marked will be returned in <parameter>accel_char</parameter>.
Two <parameter>accel_marker</parameter> characters following each other produce a single
literal <parameter>accel_marker</parameter> character.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>layout</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="PangoLayout"><type>PangoLayout</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>markup</parameter>&nbsp;:</term>
<listitem><simpara> marked-up text
(see <link linkend="PangoMarkupFormat">markup format</link>)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>length</parameter>&nbsp;:</term>
<listitem><simpara> length of marked-up text in bytes, or -1 if <parameter>markup</parameter> is
nul-terminated
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>accel_marker</parameter>&nbsp;:</term>
<listitem><simpara> marker for accelerators in the text
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>accel_char</parameter>&nbsp;:</term>
<listitem><simpara> return location for first located accelerator, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="pango-layout-set-attributes" role="function">
<title>pango_layout_set_attributes ()</title>
<indexterm zone="pango-layout-set-attributes"><primary>pango_layout_set_attributes</primary></indexterm><programlisting><link linkend="void">void</link>                pango_layout_set_attributes         (<link linkend="PangoLayout">PangoLayout</link> *layout,
                                                         <link linkend="PangoAttrList">PangoAttrList</link> *attrs);</programlisting>
<para>
Sets the text attributes for a layout object.
References <parameter>attrs</parameter>, so the caller can unref its reference.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>layout</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="PangoLayout"><type>PangoLayout</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>attrs</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="PangoAttrList"><type>PangoAttrList</type></link>, can be <link linkend="NULL:CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="pango-layout-get-attributes" role="function">
<title>pango_layout_get_attributes ()</title>
<indexterm zone="pango-layout-get-attributes"><primary>pango_layout_get_attributes</primary></indexterm><programlisting><link linkend="PangoAttrList">PangoAttrList</link>*      pango_layout_get_attributes         (<link linkend="PangoLayout">PangoLayout</link> *layout);</programlisting>
<para>
Gets the attribute list for the layout, if any.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>layout</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="PangoLayout"><type>PangoLayout</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a <link linkend="PangoAttrList"><type>PangoAttrList</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="pango-layout-set-font-description" role="function">
<title>pango_layout_set_font_description ()</title>
<indexterm zone="pango-layout-set-font-description"><primary>pango_layout_set_font_description</primary></indexterm><programlisting><link linkend="void">void</link>                pango_layout_set_font_description   (<link linkend="PangoLayout">PangoLayout</link> *layout,
                                                         const <link linkend="PangoFontDescription">PangoFontDescription</link> *desc);</programlisting>
<para>
Sets the default font description for the layout. If no font
description is set on the layout, the font description from
the layout's context is used.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>layout</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="PangoLayout"><type>PangoLayout</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>desc</parameter>&nbsp;:</term>
<listitem><simpara> the new <link linkend="PangoFontDescription"><type>PangoFontDescription</type></link>, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> to unset the
       current font description
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="pango-layout-get-font-description" role="function" condition="since:1.8">
<title>pango_layout_get_font_description ()</title>
<indexterm zone="pango-layout-get-font-description" role="1.8"><primary>pango_layout_get_font_description</primary></indexterm><programlisting>const <link linkend="PangoFontDescription">PangoFontDescription</link>* pango_layout_get_font_description
                                                        (<link linkend="PangoLayout">PangoLayout</link> *layout);</programlisting>
<para>
Gets the font description for the layout, if any.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>layout</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="PangoLayout"><type>PangoLayout</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a pointer to the layout's font description,
 or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if the font description from the layout's
 context is inherited. This value is owned by the layout
 and must not be modified or freed.

</simpara></listitem></varlistentry>
</variablelist><para role="since">Since  1.8
</para></refsect2>
<refsect2 id="pango-layout-set-width" role="function">
<title>pango_layout_set_width ()</title>
<indexterm zone="pango-layout-set-width"><primary>pango_layout_set_width</primary></indexterm><programlisting><link linkend="void">void</link>                pango_layout_set_width              (<link linkend="PangoLayout">PangoLayout</link> *layout,
                                                         <link linkend="int">int</link> width);</programlisting>
<para>
Sets the width to which the lines of the <link linkend="PangoLayout"><type>PangoLayout</type></link> should wrap or
ellipsized.  The default value is -1: no width set.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>layout</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="PangoLayout"><type>PangoLayout</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>width</parameter>&nbsp;:</term>
<listitem><simpara> the desired width in Pango units, or -1 to indicate that no
        wrapping or ellipsization should be performed.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="pango-layout-get-width" role="function">