<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
  "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
[
<!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
<!ENTITY version SYSTEM "version.xml">
]>
<refentry id="pango-Layout-Objects">
<refmeta>
<refentrytitle role="top_of_page" id="pango-Layout-Objects.top_of_page">Layout Objects</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>PANGO Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>Layout Objects</refname>
<refpurpose>High-level layout driver objects</refpurpose>
</refnamediv>

<refsect1 id="pango-Layout-Objects.functions" role="functions_proto">
<title role="functions_proto.title">Functions</title>
<informaltable pgwide="1" frame="none">
<tgroup cols="2">
<colspec colname="functions_proto_type" colwidth="150px"/>
<colspec colname="functions_proto_name"/>
<tbody>
<row><entry role="function_type"><link linkend="PangoLayout"><returnvalue>PangoLayout</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="pango-layout-new">pango_layout_new</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="PangoLayout"><returnvalue>PangoLayout</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="pango-layout-copy">pango_layout_copy</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="PangoContext"><returnvalue>PangoContext</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="pango-layout-get-context">pango_layout_get_context</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="pango-layout-context-changed">pango_layout_context_changed</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="guint"><returnvalue>guint</returnvalue></link>
</entry><entry role="function_name"><link linkend="pango-layout-get-serial">pango_layout_get_serial</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="pango-layout-set-text">pango_layout_set_text</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type">const <link linkend="char"><returnvalue>char</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="pango-layout-get-text">pango_layout_get_text</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gint"><returnvalue>gint</returnvalue></link>
</entry><entry role="function_name"><link linkend="pango-layout-get-character-count">pango_layout_get_character_count</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="pango-layout-set-markup">pango_layout_set_markup</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="pango-layout-set-markup-with-accel">pango_layout_set_markup_with_accel</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="pango-layout-set-attributes">pango_layout_set_attributes</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="PangoAttrList"><returnvalue>PangoAttrList</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="pango-layout-get-attributes">pango_layout_get_attributes</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="pango-layout-set-font-description">pango_layout_set_font_description</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type">const <link linkend="PangoFontDescription"><returnvalue>PangoFontDescription</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="pango-layout-get-font-description">pango_layout_get_font_description</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="pango-layout-set-width">pango_layout_set_width</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="int"><returnvalue>int</returnvalue></link>
</entry><entry role="function_name"><link linkend="pango-layout-get-width">pango_layout_get_width</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="pango-layout-set-height">pango_layout_set_height</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="int"><returnvalue>int</returnvalue></link>
</entry><entry role="function_name"><link linkend="pango-layout-get-height">pango_layout_get_height</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="pango-layout-set-wrap">pango_layout_set_wrap</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="PangoWrapMode"><returnvalue>PangoWrapMode</returnvalue></link>
</entry><entry role="function_name"><link linkend="pango-layout-get-wrap">pango_layout_get_wrap</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="pango-layout-is-wrapped">pango_layout_is_wrapped</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="pango-layout-set-ellipsize">pango_layout_set_ellipsize</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="PangoEllipsizeMode"><returnvalue>PangoEllipsizeMode</returnvalue></link>
</entry><entry role="function_name"><link linkend="pango-layout-get-ellipsize">pango_layout_get_ellipsize</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="pango-layout-is-ellipsized">pango_layout_is_ellipsized</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="pango-layout-set-indent">pango_layout_set_indent</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="int"><returnvalue>int</returnvalue></link>
</entry><entry role="function_name"><link linkend="pango-layout-get-indent">pango_layout_get_indent</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="int"><returnvalue>int</returnvalue></link>
</entry><entry role="function_name"><link linkend="pango-layout-get-spacing">pango_layout_get_spacing</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="pango-layout-set-spacing">pango_layout_set_spacing</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="pango-layout-set-line-spacing">pango_layout_set_line_spacing</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="float"><returnvalue>float</returnvalue></link>
</entry><entry role="function_name"><link linkend="pango-layout-get-line-spacing">pango_layout_get_line_spacing</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="pango-layout-set-justify">pango_layout_set_justify</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="pango-layout-get-justify">pango_layout_get_justify</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="pango-layout-set-auto-dir">pango_layout_set_auto_dir</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="pango-layout-get-auto-dir">pango_layout_get_auto_dir</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="PangoDirection"><returnvalue>PangoDirection</returnvalue></link>
</entry><entry role="function_name"><link linkend="pango-layout-get-direction">pango_layout_get_direction</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="pango-layout-set-alignment">pango_layout_set_alignment</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="PangoAlignment"><returnvalue>PangoAlignment</returnvalue></link>
</entry><entry role="function_name"><link linkend="pango-layout-get-alignment">pango_layout_get_alignment</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="pango-layout-set-tabs">pango_layout_set_tabs</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="PangoTabArray"><returnvalue>PangoTabArray</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="pango-layout-get-tabs">pango_layout_get_tabs</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="pango-layout-set-single-paragraph-mode">pango_layout_set_single_paragraph_mode</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="pango-layout-get-single-paragraph-mode">pango_layout_get_single_paragraph_mode</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="int"><returnvalue>int</returnvalue></link>
</entry><entry role="function_name"><link linkend="pango-layout-get-unknown-glyphs-count">pango_layout_get_unknown_glyphs_count</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="pango-layout-get-log-attrs">pango_layout_get_log_attrs</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type">const <link linkend="PangoLogAttr"><returnvalue>PangoLogAttr</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="pango-layout-get-log-attrs-readonly">pango_layout_get_log_attrs_readonly</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="pango-layout-index-to-pos">pango_layout_index_to_pos</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="pango-layout-index-to-line-x">pango_layout_index_to_line_x</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="pango-layout-xy-to-index">pango_layout_xy_to_index</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="pango-layout-get-cursor-pos">pango_layout_get_cursor_pos</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="pango-layout-move-cursor-visually">pango_layout_move_cursor_visually</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="pango-layout-get-extents">pango_layout_get_extents</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="pango-layout-get-pixel-extents">pango_layout_get_pixel_extents</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="pango-layout-get-size">pango_layout_get_size</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="pango-layout-get-pixel-size">pango_layout_get_pixel_size</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="int"><returnvalue>int</returnvalue></link>
</entry><entry role="function_name"><link linkend="pango-layout-get-baseline">pango_layout_get_baseline</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="int"><returnvalue>int</returnvalue></link>
</entry><entry role="function_name"><link linkend="pango-layout-get-line-count">pango_layout_get_line_count</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="PangoLayoutLine"><returnvalue>PangoLayoutLine</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="pango-layout-get-line">pango_layout_get_line</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="PangoLayoutLine"><returnvalue>PangoLayoutLine</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="pango-layout-get-line-readonly">pango_layout_get_line_readonly</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="GSList"><returnvalue>GSList</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="pango-layout-get-lines">pango_layout_get_lines</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="GSList"><returnvalue>GSList</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="pango-layout-get-lines-readonly">pango_layout_get_lines_readonly</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="PangoLayoutIter"><returnvalue>PangoLayoutIter</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="pango-layout-get-iter">pango_layout_get_iter</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="PangoLayoutIter"><returnvalue>PangoLayoutIter</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="pango-layout-iter-copy">pango_layout_iter_copy</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="pango-layout-iter-free">pango_layout_iter_free</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="pango-layout-iter-next-run">pango_layout_iter_next_run</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="pango-layout-iter-next-char">pango_layout_iter_next_char</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="pango-layout-iter-next-cluster">pango_layout_iter_next_cluster</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="pango-layout-iter-next-line">pango_layout_iter_next_line</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="pango-layout-iter-at-last-line">pango_layout_iter_at_last_line</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="int"><returnvalue>int</returnvalue></link>
</entry><entry role="function_name"><link linkend="pango-layout-iter-get-index">pango_layout_iter_get_index</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="int"><returnvalue>int</returnvalue></link>
</entry><entry role="function_name"><link linkend="pango-layout-iter-get-baseline">pango_layout_iter_get_baseline</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="PangoLayoutRun"><returnvalue>PangoLayoutRun</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="pango-layout-iter-get-run">pango_layout_iter_get_run</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="PangoLayoutRun"><returnvalue>PangoLayoutRun</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="pango-layout-iter-get-run-readonly">pango_layout_iter_get_run_readonly</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="PangoLayoutLine"><returnvalue>PangoLayoutLine</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="pango-layout-iter-get-line">pango_layout_iter_get_line</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="PangoLayoutLine"><returnvalue>PangoLayoutLine</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="pango-layout-iter-get-line-readonly">pango_layout_iter_get_line_readonly</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="PangoLayout"><returnvalue>PangoLayout</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="pango-layout-iter-get-layout">pango_layout_iter_get_layout</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="pango-layout-iter-get-char-extents">pango_layout_iter_get_char_extents</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="pango-layout-iter-get-cluster-extents">pango_layout_iter_get_cluster_extents</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="pango-layout-iter-get-run-extents">pango_layout_iter_get_run_extents</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="pango-layout-iter-get-line-yrange">pango_layout_iter_get_line_yrange</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="pango-layout-iter-get-line-extents">pango_layout_iter_get_line_extents</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="pango-layout-iter-get-layout-extents">pango_layout_iter_get_layout_extents</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>

<row><entry role="function_type"><link linkend="PangoLayoutLine"><returnvalue>PangoLayoutLine</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="pango-layout-line-ref">pango_layout_line_ref</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="pango-layout-line-unref">pango_layout_line_unref</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="pango-layout-line-get-extents">pango_layout_line_get_extents</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="pango-layout-line-get-pixel-extents">pango_layout_line_get_pixel_extents</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="pango-layout-line-index-to-x">pango_layout_line_index_to_x</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="pango-layout-line-x-to-index">pango_layout_line_x_to_index</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="pango-layout-line-get-x-ranges">pango_layout_line_get_x_ranges</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="pango-layout-line-get-height">pango_layout_line_get_height</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<anchor id="PangoLayout"/><anchor id="PangoLayoutIter"/><anchor id="PangoLayoutLine"/><refsect1 id="pango-Layout-Objects.other" role="other_proto">
<title role="other_proto.title">Types and Values</title>
<informaltable pgwide="1" frame="none">
<tgroup cols="2">
<colspec colname="other_proto_type" colwidth="150px"/>
<colspec colname="other_proto_name"/>
<tbody>
<row><entry role="datatype_keyword"></entry><entry role="function_name"><link linkend="PangoLayout-struct">PangoLayout</link></entry></row>
<row><entry role="datatype_keyword"></entry><entry role="function_name"><link linkend="PangoLayoutIter-struct">PangoLayoutIter</link></entry></row>
<row><entry role="datatype_keyword">enum</entry><entry role="function_name"><link linkend="PangoWrapMode">PangoWrapMode</link></entry></row>
<row><entry role="datatype_keyword">enum</entry><entry role="function_name"><link linkend="PangoEllipsizeMode">PangoEllipsizeMode</link></entry></row>
<row><entry role="datatype_keyword">enum</entry><entry role="function_name"><link linkend="PangoAlignment">PangoAlignment</link></entry></row>

<row><entry role="datatype_keyword">struct</entry><entry role="function_name"><link linkend="PangoLayoutLine-struct">PangoLayoutLine</link></entry></row>
<row><entry role="typedef_keyword">typedef</entry><entry role="function_name"><link linkend="PangoLayoutRun">PangoLayoutRun</link></entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="pango-Layout-Objects.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<screen>    <link linkend="GBoxed">GBoxed</link>
    <phrase role="lineart">&#9500;&#9472;&#9472;</phrase> PangoLayoutIter
    <phrase role="lineart">&#9584;&#9472;&#9472;</phrase> PangoLayoutLine
    <link linkend="GEnum">GEnum</link>
    <phrase role="lineart">&#9500;&#9472;&#9472;</phrase> PangoAlignment
    <phrase role="lineart">&#9500;&#9472;&#9472;</phrase> PangoEllipsizeMode
    <phrase role="lineart">&#9584;&#9472;&#9472;</phrase> PangoWrapMode
    <link linkend="GObject">GObject</link>
    <phrase role="lineart">&#9584;&#9472;&#9472;</phrase> PangoLayout
</screen>
</refsect1>


<refsect1 id="pango-Layout-Objects.description" role="desc">
<title role="desc.title">Description</title>
<para>While complete access to the layout capabilities of Pango is provided
using the detailed interfaces for itemization and shaping, using
that functionality directly involves writing a fairly large amount
of code. The objects and functions in this section provide a
high-level driver for formatting entire paragraphs of text
at once. This includes paragraph-level functionality such as
line-breaking, justification, alignment and ellipsization.</para>

</refsect1>
<refsect1 id="pango-Layout-Objects.functions_details" role="details">
<title role="details.title">Functions</title>
<refsect2 id="pango-layout-new" role="function">
<title>pango_layout_new&#160;()</title>
<indexterm zone="pango-layout-new"><primary>pango_layout_new</primary></indexterm>
<programlisting language="C"><link linkend="PangoLayout"><returnvalue>PangoLayout</returnvalue></link>&#160;*
pango_layout_new (<parameter><link linkend="PangoContext"><type>PangoContext</type></link> *context</parameter>);</programlisting>
<para>Create a new <link linkend="PangoLayout"><type>PangoLayout</type></link> object with attributes initialized to
default values for a particular <link linkend="PangoContext"><type>PangoContext</type></link>.</para>
<refsect3 id="pango-layout-new.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>context</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoContext"><type>PangoContext</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="pango-layout-new.returns" role="returns">
<title>Returns</title>
<para> the newly allocated <link linkend="PangoLayout"><type>PangoLayout</type></link>, with a reference
count of one, which should be freed with
<link linkend="g-object-unref"><function>g_object_unref()</function></link>.</para>
</refsect3></refsect2>
<refsect2 id="pango-layout-copy" role="function">
<title>pango_layout_copy&#160;()</title>
<indexterm zone="pango-layout-copy"><primary>pango_layout_copy</primary></indexterm>
<programlisting language="C"><link linkend="PangoLayout"><returnvalue>PangoLayout</returnvalue></link>&#160;*
pango_layout_copy (<parameter><link linkend="PangoLayout"><type>PangoLayout</type></link> *src</parameter>);</programlisting>
<para>Does a deep copy-by-value of the <parameter>src</parameter>
 layout. The attribute list,
tab array, and text from the original layout are all copied by
value.</para>
<refsect3 id="pango-layout-copy.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>src</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayout"><type>PangoLayout</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="pango-layout-copy.returns" role="returns">
<title>Returns</title>
<para>the newly allocated <link linkend="PangoLayout"><type>PangoLayout</type></link>,
with a reference count of one, which should be freed
with <link linkend="g-object-unref"><function>g_object_unref()</function></link>. </para>
<para><emphasis role="annotation">[<acronym>transfer full</acronym>]</emphasis></para>
</refsect3></refsect2>
<refsect2 id="pango-layout-get-context" role="function">
<title>pango_layout_get_context&#160;()</title>
<indexterm zone="pango-layout-get-context"><primary>pango_layout_get_context</primary></indexterm>
<programlisting language="C"><link linkend="PangoContext"><returnvalue>PangoContext</returnvalue></link>&#160;*
pango_layout_get_context (<parameter><link linkend="PangoLayout"><type>PangoLayout</type></link> *layout</parameter>);</programlisting>
<para>Retrieves the <link linkend="PangoContext"><type>PangoContext</type></link> used for this layout.</para>
<refsect3 id="pango-layout-get-context.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>layout</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayout"><type>PangoLayout</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="pango-layout-get-context.returns" role="returns">
<title>Returns</title>
<para>the <link linkend="PangoContext"><type>PangoContext</type></link> for the layout.
This does not have an additional refcount added, so if you want to
keep a copy of this around, you must reference it yourself. </para>
<para><emphasis role="annotation">[<acronym>transfer none</acronym>]</emphasis></para>
</refsect3></refsect2>
<refsect2 id="pango-layout-context-changed" role="function">
<title>pango_layout_context_changed&#160;()</title>
<indexterm zone="pango-layout-context-changed"><primary>pango_layout_context_changed</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
pango_layout_context_changed (<parameter><link linkend="PangoLayout"><type>PangoLayout</type></link> *layout</parameter>);</programlisting>
<para>Forces recomputation of any state in the <link linkend="PangoLayout"><type>PangoLayout</type></link> that
might depend on the layout's context. This function should
be called if you make changes to the context subsequent
to creating the layout.</para>
<refsect3 id="pango-layout-context-changed.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>layout</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayout"><type>PangoLayout</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="pango-layout-get-serial" role="function" condition="since:1.32.4">
<title>pango_layout_get_serial&#160;()</title>
<indexterm zone="pango-layout-get-serial" role="1.32.4"><primary>pango_layout_get_serial</primary></indexterm>
<programlisting language="C"><link linkend="guint"><returnvalue>guint</returnvalue></link>
pango_layout_get_serial (<parameter><link linkend="PangoLayout"><type>PangoLayout</type></link> *layout</parameter>);</programlisting>
<para>Returns the current serial number of <parameter>layout</parameter>
.  The serial number is
initialized to an small number  larger than zero when a new layout
is created and is increased whenever the layout is changed using any
of the setter functions, or the <link linkend="PangoContext"><type>PangoContext</type></link> it uses has changed.
The serial may wrap, but will never have the value 0. Since it
can wrap, never compare it with "less than", always use "not equals".</para>
<para>This can be used to automatically detect changes to a <link linkend="PangoLayout"><type>PangoLayout</type></link>, and
is useful for example to decide whether a layout needs redrawing.
To force the serial to be increased, use <link linkend="pango-layout-context-changed"><function>pango_layout_context_changed()</function></link>.</para>
<refsect3 id="pango-layout-get-serial.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>layout</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayout"><type>PangoLayout</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="pango-layout-get-serial.returns" role="returns">
<title>Returns</title>
<para> The current serial number of <parameter>layout</parameter>
.</para>
</refsect3><para role="since">Since: <link linkend="api-index-1.32.4">1.32.4</link></para></refsect2>
<refsect2 id="pango-layout-set-text" role="function">
<title>pango_layout_set_text&#160;()</title>
<indexterm zone="pango-layout-set-text"><primary>pango_layout_set_text</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
pango_layout_set_text (<parameter><link linkend="PangoLayout"><type>PangoLayout</type></link> *layout</parameter>,
                       <parameter>const <link linkend="char"><type>char</type></link> *text</parameter>,
                       <parameter><link linkend="int"><type>int</type></link> length</parameter>);</programlisting>
<para>Sets the text of the layout.</para>
<para>This function validates <parameter>text</parameter>
 and renders invalid UTF-8
with a placeholder glyph.</para>
<para>Note that if you have used <link linkend="pango-layout-set-markup"><function>pango_layout_set_markup()</function></link> or
<link linkend="pango-layout-set-markup-with-accel"><function>pango_layout_set_markup_with_accel()</function></link> on <parameter>layout</parameter>
 before, you may
want to call <link linkend="pango-layout-set-attributes"><function>pango_layout_set_attributes()</function></link> to clear the attributes
set on the layout from the markup as this function does not clear
attributes.</para>
<refsect3 id="pango-layout-set-text.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>layout</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayout"><type>PangoLayout</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>text</para></entry>
<entry role="parameter_description"><para>the text</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>length</para></entry>
<entry role="parameter_description"><para>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.</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="pango-layout-get-text" role="function">
<title>pango_layout_get_text&#160;()</title>
<indexterm zone="pango-layout-get-text"><primary>pango_layout_get_text</primary></indexterm>
<programlisting language="C">const <link linkend="char"><returnvalue>char</returnvalue></link>&#160;*
pango_layout_get_text (<parameter><link linkend="PangoLayout"><type>PangoLayout</type></link> *layout</parameter>);</programlisting>
<para>Gets the text in the layout. The returned text should not
be freed or modified.</para>
<refsect3 id="pango-layout-get-text.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>layout</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayout"><type>PangoLayout</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="pango-layout-get-text.returns" role="returns">
<title>Returns</title>
<para> the text in the <parameter>layout</parameter>
.</para>
</refsect3></refsect2>
<refsect2 id="pango-layout-get-character-count" role="function" condition="since:1.30">
<title>pango_layout_get_character_count&#160;()</title>
<indexterm zone="pango-layout-get-character-count" role="1.30"><primary>pango_layout_get_character_count</primary></indexterm>
<programlisting language="C"><link linkend="gint"><returnvalue>gint</returnvalue></link>
pango_layout_get_character_count (<parameter><link linkend="PangoLayout"><type>PangoLayout</type></link> *layout</parameter>);</programlisting>
<para>Returns the number of Unicode characters in the
the text of <parameter>layout</parameter>
.</para>
<refsect3 id="pango-layout-get-character-count.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>layout</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayout"><type>PangoLayout</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="pango-layout-get-character-count.returns" role="returns">
<title>Returns</title>
<para> the number of Unicode characters
in the text of <parameter>layout</parameter>
</para>
</refsect3><para role="since">Since: <link linkend="api-index-1.30">1.30</link></para></refsect2>
<refsect2 id="pango-layout-set-markup" role="function">
<title>pango_layout_set_markup&#160;()</title>
<indexterm zone="pango-layout-set-markup"><primary>pango_layout_set_markup</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
pango_layout_set_markup (<parameter><link linkend="PangoLayout"><type>PangoLayout</type></link> *layout</parameter>,
                         <parameter>const <link linkend="char"><type>char</type></link> *markup</parameter>,
                         <parameter><link linkend="int"><type>int</type></link> length</parameter>);</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>
<refsect3 id="pango-layout-set-markup.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>layout</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayout"><type>PangoLayout</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>markup</para></entry>
<entry role="parameter_description"><para>marked-up text</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>length</para></entry>
<entry role="parameter_description"><para>length of marked-up text in bytes, or -1 if <parameter>markup</parameter>
is
null-terminated</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="pango-layout-set-markup-with-accel" role="function">
<title>pango_layout_set_markup_with_accel&#160;()</title>
<indexterm zone="pango-layout-set-markup-with-accel"><primary>pango_layout_set_markup_with_accel</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
pango_layout_set_markup_with_accel (<parameter><link linkend="PangoLayout"><type>PangoLayout</type></link> *layout</parameter>,
                                    <parameter>const <link linkend="char"><type>char</type></link> *markup</parameter>,
                                    <parameter><link linkend="int"><type>int</type></link> length</parameter>,
                                    <parameter><link linkend="gunichar"><type>gunichar</type></link> accel_marker</parameter>,
                                    <parameter><link linkend="gunichar"><type>gunichar</type></link> *accel_char</parameter>);</programlisting>
<para>Sets the layout text and attribute list from marked-up text (see</para>
<link linkend="PangoMarkupFormat">markup format</link>). Replaces
<para>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>
<refsect3 id="pango-layout-set-markup-with-accel.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>layout</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayout"><type>PangoLayout</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>markup</para></entry>
<entry role="parameter_description"><para>marked-up text
(see <link linkend="PangoMarkupFormat">markup format</link>)</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>length</para></entry>
<entry role="parameter_description"><para>length of marked-up text in bytes, or -1 if <parameter>markup</parameter>
is
null-terminated</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>accel_marker</para></entry>
<entry role="parameter_description"><para>marker for accelerators in the text</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>accel_char</para></entry>
<entry role="parameter_description"><para>return location
for first located accelerator, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>out caller-allocates</acronym>][<acronym>allow-none</acronym>]</emphasis></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="pango-layout-set-attributes" role="function">
<title>pango_layout_set_attributes&#160;()</title>
<indexterm zone="pango-layout-set-attributes"><primary>pango_layout_set_attributes</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
pango_layout_set_attributes (<parameter><link linkend="PangoLayout"><type>PangoLayout</type></link> *layout</parameter>,
                             <parameter><link linkend="PangoAttrList"><type>PangoAttrList</type></link> *attrs</parameter>);</programlisting>
<para>Sets the text attributes for a layout object.
References <parameter>attrs</parameter>
, so the caller can unref its reference.</para>
<refsect3 id="pango-layout-set-attributes.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>layout</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayout"><type>PangoLayout</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>attrs</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoAttrList"><type>PangoAttrList</type></link>, can be <link linkend="NULL:CAPS"><literal>NULL</literal></link>. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>allow-none</acronym>][<acronym>transfer none</acronym>]</emphasis></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="pango-layout-get-attributes" role="function">
<title>pango_layout_get_attributes&#160;()</title>
<indexterm zone="pango-layout-get-attributes"><primary>pango_layout_get_attributes</primary></indexterm>
<programlisting language="C"><link linkend="PangoAttrList"><returnvalue>PangoAttrList</returnvalue></link>&#160;*
pango_layout_get_attributes (<parameter><link linkend="PangoLayout"><type>PangoLayout</type></link> *layout</parameter>);</programlisting>
<para>Gets the attribute list for the layout, if any.</para>
<refsect3 id="pango-layout-get-attributes.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>layout</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayout"><type>PangoLayout</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="pango-layout-get-attributes.returns" role="returns">
<title>Returns</title>
<para>a <link linkend="PangoAttrList"><type>PangoAttrList</type></link> or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
if none was set. </para>
<para><emphasis role="annotation">[<acronym>transfer none</acronym>][<acronym>nullable</acronym>]</emphasis></para>
</refsect3></refsect2>
<refsect2 id="pango-layout-set-font-description" role="function">
<title>pango_layout_set_font_description&#160;()</title>
<indexterm zone="pango-layout-set-font-description"><primary>pango_layout_set_font_description</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
pango_layout_set_font_description (<parameter><link linkend="PangoLayout"><type>PangoLayout</type></link> *layout</parameter>,
                                   <parameter>const <link linkend="PangoFontDescription"><type>PangoFontDescription</type></link> *desc</parameter>);</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>
<refsect3 id="pango-layout-set-font-description.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>layout</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayout"><type>PangoLayout</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>desc</para></entry>
<entry role="parameter_description"><para>the new <link linkend="PangoFontDescription"><type>PangoFontDescription</type></link>, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> to unset the
current font description. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>allow-none</acronym>]</emphasis></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="pango-layout-get-font-description" role="function" condition="since:1.8">
<title>pango_layout_get_font_description&#160;()</title>
<indexterm zone="pango-layout-get-font-description" role="1.8"><primary>pango_layout_get_font_description</primary></indexterm>
<programlisting language="C">const <link linkend="PangoFontDescription"><returnvalue>PangoFontDescription</returnvalue></link>&#160;*
pango_layout_get_font_description (<parameter><link linkend="PangoLayout"><type>PangoLayout</type></link> *layout</parameter>);</programlisting>
<para>Gets the font description for the layout, if any.</para>
<refsect3 id="pango-layout-get-font-description.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>layout</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayout"><type>PangoLayout</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="pango-layout-get-font-description.returns" role="returns">
<title>Returns</title>
<para>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. </para>
<para><emphasis role="annotation">[<acronym>nullable</acronym>]</emphasis></para>
</refsect3><para role="since">Since: <link linkend="api-index-1.8">1.8</link></para></refsect2>
<refsect2 id="pango-layout-set-width" role="function">
<title>pango_layout_set_width&#160;()</title>
<indexterm zone="pango-layout-set-width"><primary>pango_layout_set_width</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
pango_layout_set_width (<parameter><link linkend="PangoLayout"><type>PangoLayout</type></link> *layout</parameter>,
                        <parameter><link linkend="int"><type>int</type></link> width</parameter>);</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>
<refsect3 id="pango-layout-set-width.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>layout</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayout"><type>PangoLayout</type></link>.</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>width</para></entry>
<entry role="parameter_description"><para>the desired width in Pango units, or -1 to indicate that no
wrapping or ellipsization should be performed.</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="pango-layout-get-width" role="function">
<title>pango_layout_get_width&#160;()</title>
<indexterm zone="pango-layout-get-width"><primary>pango_layout_get_width</primary></indexterm>
<programlisting language="C"><link linkend="int"><returnvalue>int</returnvalue></link>
pango_layout_get_width (<parameter><link linkend="PangoLayout"><type>PangoLayout</type></link> *layout</parameter>);</programlisting>
<para>Gets the width to which the lines of the <link linkend="PangoLayout"><type>PangoLayout</type></link> should wrap.</para>
<refsect3 id="pango-layout-get-width.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>layout</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayout"><type>PangoLayout</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="pango-layout-get-width.returns" role="returns">
<title>Returns</title>
<para> the width in Pango units, or -1 if no width set.</para>
</refsect3></refsect2>
<refsect2 id="pango-layout-set-height" role="function" condition="since:1.20">
<title>pango_layout_set_height&#160;()</title>
<indexterm zone="pango-layout-set-height" role="1.20"><primary>pango_layout_set_height</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
pango_layout_set_height (<parameter><link linkend="PangoLayout"><type>PangoLayout</type></link> *layout</parameter>,
                         <parameter><link linkend="int"><type>int</type></link> height</parameter>);</programlisting>
<para>Sets the height to which the <link linkend="PangoLayout"><type>PangoLayout</type></link> should be ellipsized at.  There
are two different behaviors, based on whether <parameter>height</parameter>
 is positive or
negative.</para>
<para>If <parameter>height</parameter>
 is positive, it will be the maximum height of the layout.  Only
lines would be shown that would fit, and if there is any text omitted,
an ellipsis added.  At least one line is included in each paragraph regardless
of how small the height value is.  A value of zero will render exactly one
line for the entire layout.</para>
<para>If <parameter>height</parameter>
 is negative, it will be the (negative of) maximum number of lines per
paragraph.  That is, the total number of lines shown may well be more than
this value if the layout contains multiple paragraphs of text.
The default value of -1 means that first line of each paragraph is ellipsized.
This behvaior may be changed in the future to act per layout instead of per
paragraph.  File a bug against pango at <ulink
url="http://bugzilla.gnome.org/">http://bugzilla.gnome.org/</ulink> if your
code relies on this behavior.</para>
<para>Height setting only has effect if a positive width is set on
<parameter>layout</parameter>
 and ellipsization mode of <parameter>layout</parameter>
 is not <link linkend="PANGO-ELLIPSIZE-NONE:CAPS"><literal>PANGO_ELLIPSIZE_NONE</literal></link>.
The behavior is undefined if a height other than -1 is set and
ellipsization mode is set to <link linkend="PANGO-ELLIPSIZE-NONE:CAPS"><literal>PANGO_ELLIPSIZE_NONE</literal></link>, and may change in the
future.</para>
<refsect3 id="pango-layout-set-height.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>layout</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayout"><type>PangoLayout</type></link>.</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>height</para></entry>
<entry role="parameter_description"><para>the desired height of the layout in Pango units if positive,
or desired number of lines if negative.</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><para role="since">Since: <link linkend="api-index-1.20">1.20</link></para></refsect2>
<refsect2 id="pango-layout-get-height" role="function" condition="since:1.20">
<title>pango_layout_get_height&#160;()</title>
<indexterm zone="pango-layout-get-height" role="1.20"><primary>pango_layout_get_height</primary></indexterm>
<programlisting language="C"><link linkend="int"><returnvalue>int</returnvalue></link>
pango_layout_get_height (<parameter><link linkend="PangoLayout"><type>PangoLayout</type></link> *layout</parameter>);</programlisting>
<para>Gets the height of layout used for ellipsization.  See
<link linkend="pango-layout-set-height"><function>pango_layout_set_height()</function></link> for details.</para>
<refsect3 id="pango-layout-get-height.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>layout</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayout"><type>PangoLayout</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="pango-layout-get-height.returns" role="returns">
<title>Returns</title>
<para> the height, in Pango units if positive, or
number of lines if negative.</para>
</refsect3><para role="since">Since: <link linkend="api-index-1.20">1.20</link></para></refsect2>
<refsect2 id="pango-layout-set-wrap" role="function">
<title>pango_layout_set_wrap&#160;()</title>
<indexterm zone="pango-layout-set-wrap"><primary>pango_layout_set_wrap</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
pango_layout_set_wrap (<parameter><link linkend="PangoLayout"><type>PangoLayout</type></link> *layout</parameter>,
                       <parameter><link linkend="PangoWrapMode"><type>PangoWrapMode</type></link> wrap</parameter>);</programlisting>
<para>Sets the wrap mode; the wrap mode only has effect if a width
is set on the layout with <link linkend="pango-layout-set-width"><function>pango_layout_set_width()</function></link>.
To turn off wrapping, set the width to -1.</para>
<refsect3 id="pango-layout-set-wrap.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>layout</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayout"><type>PangoLayout</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>wrap</para></entry>
<entry role="parameter_description"><para>the wrap mode</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="pango-layout-get-wrap" role="function">
<title>pango_layout_get_wrap&#160;()</title>
<indexterm zone="pango-layout-get-wrap"><primary>pango_layout_get_wrap</primary></indexterm>
<programlisting language="C"><link linkend="PangoWrapMode"><returnvalue>PangoWrapMode</returnvalue></link>
pango_layout_get_wrap (<parameter><link linkend="PangoLayout"><type>PangoLayout</type></link> *layout</parameter>);</programlisting>
<para>Gets the wrap mode for the layout.</para>
<para>Use <link linkend="pango-layout-is-wrapped"><function>pango_layout_is_wrapped()</function></link> to query whether any paragraphs
were actually wrapped.</para>
<refsect3 id="pango-layout-get-wrap.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>layout</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayout"><type>PangoLayout</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="pango-layout-get-wrap.returns" role="returns">
<title>Returns</title>
<para> active wrap mode.</para>
</refsect3></refsect2>
<refsect2 id="pango-layout-is-wrapped" role="function" condition="since:1.16">
<title>pango_layout_is_wrapped&#160;()</title>
<indexterm zone="pango-layout-is-wrapped" role="1.16"><primary>pango_layout_is_wrapped</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
pango_layout_is_wrapped (<parameter><link linkend="PangoLayout"><type>PangoLayout</type></link> *layout</parameter>);</programlisting>
<para>Queries whether the layout had to wrap any paragraphs.</para>
<para>This returns <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if a positive width is set on <parameter>layout</parameter>
,
ellipsization mode of <parameter>layout</parameter>
 is set to <link linkend="PANGO-ELLIPSIZE-NONE:CAPS"><literal>PANGO_ELLIPSIZE_NONE</literal></link>,
and there are paragraphs exceeding the layout width that have
to be wrapped.</para>
<refsect3 id="pango-layout-is-wrapped.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>layout</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayout"><type>PangoLayout</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="pango-layout-is-wrapped.returns" role="returns">
<title>Returns</title>
<para> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if any paragraphs had to be wrapped, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link>
otherwise.</para>
</refsect3><para role="since">Since: <link linkend="api-index-1.16">1.16</link></para></refsect2>
<refsect2 id="pango-layout-set-ellipsize" role="function" condition="since:1.6">
<title>pango_layout_set_ellipsize&#160;()</title>
<indexterm zone="pango-layout-set-ellipsize" role="1.6"><primary>pango_layout_set_ellipsize</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
pango_layout_set_ellipsize (<parameter><link linkend="PangoLayout"><type>PangoLayout</type></link> *layout</parameter>,
                            <parameter><link linkend="PangoEllipsizeMode"><type>PangoEllipsizeMode</type></link> ellipsize</parameter>);</programlisting>
<para>Sets the type of ellipsization being performed for <parameter>layout</parameter>
.
Depending on the ellipsization mode <parameter>ellipsize</parameter>
 text is
removed from the start, middle, or end of text so they
fit within the width and height of layout set with
<link linkend="pango-layout-set-width"><function>pango_layout_set_width()</function></link> and <link linkend="pango-layout-set-height"><function>pango_layout_set_height()</function></link>.</para>
<para>If the layout contains characters such as newlines that
force it to be layed out in multiple paragraphs, then whether
each paragraph is ellipsized separately or the entire layout
is ellipsized as a whole depends on the set height of the layout.
See <link linkend="pango-layout-set-height"><function>pango_layout_set_height()</function></link> for details.</para>
<refsect3 id="pango-layout-set-ellipsize.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>layout</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayout"><type>PangoLayout</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>ellipsize</para></entry>
<entry role="parameter_description"><para>the new ellipsization mode for <parameter>layout</parameter>
</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><para role="since">Since: <link linkend="api-index-1.6">1.6</link></para></refsect2>
<refsect2 id="pango-layout-get-ellipsize" role="function" condition="since:1.6">
<title>pango_layout_get_ellipsize&#160;()</title>
<indexterm zone="pango-layout-get-ellipsize" role="1.6"><primary>pango_layout_get_ellipsize</primary></indexterm>
<programlisting language="C"><link linkend="PangoEllipsizeMode"><returnvalue>PangoEllipsizeMode</returnvalue></link>
pango_layout_get_ellipsize (<parameter><link linkend="PangoLayout"><type>PangoLayout</type></link> *layout</parameter>);</programlisting>
<para>Gets the type of ellipsization being performed for <parameter>layout</parameter>
.
See <link linkend="pango-layout-set-ellipsize"><function>pango_layout_set_ellipsize()</function></link></para>
<refsect3 id="pango-layout-get-ellipsize.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>layout</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayout"><type>PangoLayout</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="pango-layout-get-ellipsize.returns" role="returns">
<title>Returns</title>
<para> the current ellipsization mode for <parameter>layout</parameter>
.</para>
<para>Use <link linkend="pango-layout-is-ellipsized"><function>pango_layout_is_ellipsized()</function></link> to query whether any paragraphs
were actually ellipsized.</para>
</refsect3><para role="since">Since: <link linkend="api-index-1.6">1.6</link></para></refsect2>
<refsect2 id="pango-layout-is-ellipsized" role="function" condition="since:1.16">
<title>pango_layout_is_ellipsized&#160;()</title>
<indexterm zone="pango-layout-is-ellipsized" role="1.16"><primary>pango_layout_is_ellipsized</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
pango_layout_is_ellipsized (<parameter><link linkend="PangoLayout"><type>PangoLayout</type></link> *layout</parameter>);</programlisting>
<para>Queries whether the layout had to ellipsize any paragraphs.</para>
<para>This returns <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the ellipsization mode for <parameter>layout</parameter>

is not <link linkend="PANGO-ELLIPSIZE-NONE:CAPS"><literal>PANGO_ELLIPSIZE_NONE</literal></link>, a positive width is set on <parameter>layout</parameter>
,
and there are paragraphs exceeding that width that have to be
ellipsized.</para>
<refsect3 id="pango-layout-is-ellipsized.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>layout</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayout"><type>PangoLayout</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="pango-layout-is-ellipsized.returns" role="returns">
<title>Returns</title>
<para> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if any paragraphs had to be ellipsized, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link>
otherwise.</para>
</refsect3><para role="since">Since: <link linkend="api-index-1.16">1.16</link></para></refsect2>
<refsect2 id="pango-layout-set-indent" role="function">
<title>pango_layout_set_indent&#160;()</title>
<indexterm zone="pango-layout-set-indent"><primary>pango_layout_set_indent</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
pango_layout_set_indent (<parameter><link linkend="PangoLayout"><type>PangoLayout</type></link> *layout</parameter>,
                         <parameter><link linkend="int"><type>int</type></link> indent</parameter>);</programlisting>
<para>Sets the width in Pango units to indent each paragraph. A negative value
of <parameter>indent</parameter>
 will produce a hanging indentation. That is, the first line will
have the full width, and subsequent lines will be indented by the
absolute value of <parameter>indent</parameter>
.</para>
<para>The indent setting is ignored if layout alignment is set to
<link linkend="PANGO-ALIGN-CENTER:CAPS"><literal>PANGO_ALIGN_CENTER</literal></link>.</para>
<refsect3 id="pango-layout-set-indent.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>layout</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayout"><type>PangoLayout</type></link>.</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>indent</para></entry>
<entry role="parameter_description"><para>the amount by which to indent.</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="pango-layout-get-indent" role="function">
<title>pango_layout_get_indent&#160;()</title>
<indexterm zone="pango-layout-get-indent"><primary>pango_layout_get_indent</primary></indexterm>
<programlisting language="C"><link linkend="int"><returnvalue>int</returnvalue></link>
pango_layout_get_indent (<parameter><link linkend="PangoLayout"><type>PangoLayout</type></link> *layout</parameter>);</programlisting>
<para>Gets the paragraph indent width in Pango units. A negative value
indicates a hanging indentation.</para>
<refsect3 id="pango-layout-get-indent.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>layout</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayout"><type>PangoLayout</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="pango-layout-get-indent.returns" role="returns">
<title>Returns</title>
<para> the indent in Pango units.</para>
</refsect3></refsect2>
<refsect2 id="pango-layout-get-spacing" role="function">
<title>pango_layout_get_spacing&#160;()</title>
<indexterm zone="pango-layout-get-spacing"><primary>pango_layout_get_spacing</primary></indexterm>
<programlisting language="C"><link linkend="int"><returnvalue>int</returnvalue></link>
pango_layout_get_spacing (<parameter><link linkend="PangoLayout"><type>PangoLayout</type></link> *layout</parameter>);</programlisting>
<para>Gets the amount of spacing between the lines of the layout.</para>
<refsect3 id="pango-layout-get-spacing.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>layout</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayout"><type>PangoLayout</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="pango-layout-get-spacing.returns" role="returns">
<title>Returns</title>
<para> the spacing in Pango units.</para>
</refsect3></refsect2>
<refsect2 id="pango-layout-set-spacing" role="function">
<title>pango_layout_set_spacing&#160;()</title>
<indexterm zone="pango-layout-set-spacing"><primary>pango_layout_set_spacing</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
pango_layout_set_spacing (<parameter><link linkend="PangoLayout"><type>PangoLayout</type></link> *layout</parameter>,
                          <parameter><link linkend="int"><type>int</type></link> spacing</parameter>);</programlisting>
<para>Sets the amount of spacing in Pango unit between
the lines of the layout. When placing lines with
spacing, Pango arranges things so that</para>
<para>line2.top = line1.bottom + spacing</para>
<para>Note: Since 1.44, Pango defaults to using the
line height (as determined by the font) for placing
lines. The <parameter>spacing</parameter>
 set with this function is only
taken into account when the line-height factor is
set to zero with <link linkend="pango-layout-set-line-spacing"><function>pango_layout_set_line_spacing()</function></link>.</para>
<refsect3 id="pango-layout-set-spacing.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>layout</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayout"><type>PangoLayout</type></link>.</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>spacing</para></entry>
<entry role="parameter_description"><para>the amount of spacing</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="pango-layout-set-line-spacing" role="function" condition="since:1.44">
<title>pango_layout_set_line_spacing&#160;()</title>
<indexterm zone="pango-layout-set-line-spacing" role="1.44"><primary>pango_layout_set_line_spacing</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
pango_layout_set_line_spacing (<parameter><link linkend="PangoLayout"><type>PangoLayout</type></link> *layout</parameter>,
                               <parameter><link linkend="float"><type>float</type></link> factor</parameter>);</programlisting>
<para>Sets a factor for line spacing.
Typical values are: 0, 1, 1.5, 2.
The default values is 0.</para>
<para>If <parameter>factor</parameter>
 is non-zero, lines are placed
so that</para>
<para>baseline2 = baseline1 + factor * height2</para>
<para>where height2 is the line height of the
second line (as determined by the font(s)).
In this case, the spacing set with
<link linkend="pango-layout-set-spacing"><function>pango_layout_set_spacing()</function></link> is ignored.</para>
<para>If <parameter>factor</parameter>
 is zero, spacing is applied as
before.</para>
<refsect3 id="pango-layout-set-line-spacing.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>layout</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayout"><type>PangoLayout</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>factor</para></entry>
<entry role="parameter_description"><para>the new line spacing factor</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><para role="since">Since: <link linkend="api-index-1.44">1.44</link></para></refsect2>
<refsect2 id="pango-layout-get-line-spacing" role="function" condition="since:1.44">
<title>pango_layout_get_line_spacing&#160;()</title>
<indexterm zone="pango-layout-get-line-spacing" role="1.44"><primary>pango_layout_get_line_spacing</primary></indexterm>
<programlisting language="C"><link linkend="float"><returnvalue>float</returnvalue></link>
pango_layout_get_line_spacing (<parameter><link linkend="PangoLayout"><type>PangoLayout</type></link> *layout</parameter>);</programlisting>
<para>Gets the value that has been
set with <link linkend="pango-layout-set-line-spacing"><function>pango_layout_set_line_spacing()</function></link>.</para>
<refsect3 id="pango-layout-get-line-spacing.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>layout</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayout"><type>PangoLayout</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><para role="since">Since: <link linkend="api-index-1.44">1.44</link></para></refsect2>
<refsect2 id="pango-layout-set-justify" role="function">
<title>pango_layout_set_justify&#160;()</title>
<indexterm zone="pango-layout-set-justify"><primary>pango_layout_set_justify</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
pango_layout_set_justify (<parameter><link linkend="PangoLayout"><type>PangoLayout</type></link> *layout</parameter>,
                          <parameter><link linkend="gboolean"><type>gboolean</type></link> justify</parameter>);</programlisting>
<para>Sets whether each complete line should be stretched to
fill the entire width of the layout. This stretching is typically
done by adding whitespace, but for some scripts (such as Arabic),
the justification may be done in more complex ways, like extending
the characters.</para>
<para>Note that this setting is not implemented and so is ignored in Pango
older than 1.18.</para>
<refsect3 id="pango-layout-set-justify.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>layout</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayout"><type>PangoLayout</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>justify</para></entry>
<entry role="parameter_description"><para>whether the lines in the layout should be justified.</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="pango-layout-get-justify" role="function">
<title>pango_layout_get_justify&#160;()</title>
<indexterm zone="pango-layout-get-justify"><primary>pango_layout_get_justify</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
pango_layout_get_justify (<parameter><link linkend="PangoLayout"><type>PangoLayout</type></link> *layout</parameter>);</programlisting>
<para>Gets whether each complete line should be stretched to fill the entire
width of the layout.</para>
<refsect3 id="pango-layout-get-justify.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>layout</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayout"><type>PangoLayout</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="pango-layout-get-justify.returns" role="returns">
<title>Returns</title>
<para> the justify.</para>
</refsect3></refsect2>
<refsect2 id="pango-layout-set-auto-dir" role="function" condition="since:1.4">
<title>pango_layout_set_auto_dir&#160;()</title>
<indexterm zone="pango-layout-set-auto-dir" role="1.4"><primary>pango_layout_set_auto_dir</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
pango_layout_set_auto_dir (<parameter><link linkend="PangoLayout"><type>PangoLayout</type></link> *layout</parameter>,
                           <parameter><link linkend="gboolean"><type>gboolean</type></link> auto_dir</parameter>);</programlisting>
<para>Sets whether to calculate the bidirectional base direction
for the layout according to the contents of the layout;
when this flag is on (the default), then paragraphs in
   <parameter>layout</parameter>
 that begin with strong right-to-left characters
(Arabic and Hebrew principally), will have right-to-left
layout, paragraphs with letters from other scripts will
have left-to-right layout. Paragraphs with only neutral
characters get their direction from the surrounding paragraphs.</para>
<para>When <link linkend="FALSE:CAPS"><literal>FALSE</literal></link>, the choice between left-to-right and
right-to-left layout is done according to the base direction
of the layout's <link linkend="PangoContext"><type>PangoContext</type></link>. (See <link linkend="pango-context-set-base-dir"><function>pango_context_set_base_dir()</function></link>).</para>
<para>When the auto-computed direction of a paragraph differs from the
base direction of the context, the interpretation of
<link linkend="PANGO-ALIGN-LEFT:CAPS"><literal>PANGO_ALIGN_LEFT</literal></link> and <link linkend="PANGO-ALIGN-RIGHT:CAPS"><literal>PANGO_ALIGN_RIGHT</literal></link> are swapped.</para>
<refsect3 id="pango-layout-set-auto-dir.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>layout</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayout"><type>PangoLayout</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>auto_dir</para></entry>
<entry role="parameter_description"><para>if <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>, compute the bidirectional base direction
from the layout's contents.</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><para role="since">Since: <link linkend="api-index-1.4">1.4</link></para></refsect2>
<refsect2 id="pango-layout-get-auto-dir" role="function" condition="since:1.4">
<title>pango_layout_get_auto_dir&#160;()</title>
<indexterm zone="pango-layout-get-auto-dir" role="1.4"><primary>pango_layout_get_auto_dir</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
pango_layout_get_auto_dir (<parameter><link linkend="PangoLayout"><type>PangoLayout</type></link> *layout</parameter>);</programlisting>
<para>Gets whether to calculate the bidirectional base direction
for the layout according to the contents of the layout.
See <link linkend="pango-layout-set-auto-dir"><function>pango_layout_set_auto_dir()</function></link>.</para>
<refsect3 id="pango-layout-get-auto-dir.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>layout</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayout"><type>PangoLayout</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="pango-layout-get-auto-dir.returns" role="returns">
<title>Returns</title>
<para> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the bidirectional base direction
is computed from the layout's contents, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise.</para>
</refsect3><para role="since">Since: <link linkend="api-index-1.4">1.4</link></para></refsect2>
<refsect2 id="pango-layout-get-direction" role="function" condition="since:1.46">
<title>pango_layout_get_direction&#160;()</title>
<indexterm zone="pango-layout-get-direction" role="1.46"><primary>pango_layout_get_direction</primary></indexterm>
<programlisting language="C"><link linkend="PangoDirection"><returnvalue>PangoDirection</returnvalue></link>
pango_layout_get_direction (<parameter><link linkend="PangoLayout"><type>PangoLayout</type></link> *layout</parameter>,
                            <parameter><link linkend="int"><type>int</type></link> index</parameter>);</programlisting>
<para>Gets the text direction at the given character
position in <parameter>layout</parameter>
.</para>
<refsect3 id="pango-layout-get-direction.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>layout</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayout"><type>PangoLayout</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>index</para></entry>
<entry role="parameter_description"><para>the byte index of the char</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="pango-layout-get-direction.returns" role="returns">
<title>Returns</title>
<para> the text direction at <parameter>index</parameter>
</para>
</refsect3><para role="since">Since: <link linkend="api-index-1.46">1.46</link></para></refsect2>
<refsect2 id="pango-layout-set-alignment" role="function">
<title>pango_layout_set_alignment&#160;()</title>
<indexterm zone="pango-layout-set-alignment"><primary>pango_layout_set_alignment</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
pango_layout_set_alignment (<parameter><link linkend="PangoLayout"><type>PangoLayout</type></link> *layout</parameter>,
                            <parameter><link linkend="PangoAlignment"><type>PangoAlignment</type></link> alignment</parameter>);</programlisting>
<para>Sets the alignment for the layout: how partial lines are
positioned within the horizontal space available.</para>
<refsect3 id="pango-layout-set-alignment.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>layout</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayout"><type>PangoLayout</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>alignment</para></entry>
<entry role="parameter_description"><para>the alignment</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="pango-layout-get-alignment" role="function">
<title>pango_layout_get_alignment&#160;()</title>
<indexterm zone="pango-layout-get-alignment"><primary>pango_layout_get_alignment</primary></indexterm>
<programlisting language="C"><link linkend="PangoAlignment"><returnvalue>PangoAlignment</returnvalue></link>
pango_layout_get_alignment (<parameter><link linkend="PangoLayout"><type>PangoLayout</type></link> *layout</parameter>);</programlisting>
<para>Gets the alignment for the layout: how partial lines are
positioned within the horizontal space available.</para>
<refsect3 id="pango-layout-get-alignment.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>layout</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayout"><type>PangoLayout</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="pango-layout-get-alignment.returns" role="returns">
<title>Returns</title>
<para> the alignment.</para>
</refsect3></refsect2>
<refsect2 id="pango-layout-set-tabs" role="function">
<title>pango_layout_set_tabs&#160;()</title>
<indexterm zone="pango-layout-set-tabs"><primary>pango_layout_set_tabs</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
pango_layout_set_tabs (<parameter><link linkend="PangoLayout"><type>PangoLayout</type></link> *layout</parameter>,
                       <parameter><link linkend="PangoTabArray"><type>PangoTabArray</type></link> *tabs</parameter>);</programlisting>
<para>Sets the tabs to use for <parameter>layout</parameter>
, overriding the default tabs
(by default, tabs are every 8 spaces). If <parameter>tabs</parameter>
 is <link linkend="NULL:CAPS"><literal>NULL</literal></link>, the default
tabs are reinstated. <parameter>tabs</parameter>
 is copied into the layout; you must
free your copy of <parameter>tabs</parameter>
 yourself.</para>
<refsect3 id="pango-layout-set-tabs.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>layout</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayout"><type>PangoLayout</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>tabs</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoTabArray"><type>PangoTabArray</type></link>, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>allow-none</acronym>]</emphasis></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="pango-layout-get-tabs" role="function">
<title>pango_layout_get_tabs&#160;()</title>
<indexterm zone="pango-layout-get-tabs"><primary>pango_layout_get_tabs</primary></indexterm>
<programlisting language="C"><link linkend="PangoTabArray"><returnvalue>PangoTabArray</returnvalue></link>&#160;*
pango_layout_get_tabs (<parameter><link linkend="PangoLayout"><type>PangoLayout</type></link> *layout</parameter>);</programlisting>
<para>Gets the current <link linkend="PangoTabArray"><type>PangoTabArray</type></link> used by this layout. If no
<link linkend="PangoTabArray"><type>PangoTabArray</type></link> has been set, then the default tabs are in use
and <link linkend="NULL:CAPS"><literal>NULL</literal></link> is returned. Default tabs are every 8 spaces.
The return value should be freed with <link linkend="pango-tab-array-free"><function>pango_tab_array_free()</function></link>.</para>
<refsect3 id="pango-layout-get-tabs.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>layout</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayout"><type>PangoLayout</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="pango-layout-get-tabs.returns" role="returns">
<title>Returns</title>
<para>a copy of the tabs for this layout, or
<link linkend="NULL:CAPS"><literal>NULL</literal></link>. </para>
<para><emphasis role="annotation">[<acronym>nullable</acronym>]</emphasis></para>
</refsect3></refsect2>
<refsect2 id="pango-layout-set-single-paragraph-mode" role="function">
<title>pango_layout_set_single_paragraph_mode&#160;()</title>
<indexterm zone="pango-layout-set-single-paragraph-mode"><primary>pango_layout_set_single_paragraph_mode</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
pango_layout_set_single_paragraph_mode
                               (<parameter><link linkend="PangoLayout"><type>PangoLayout</type></link> *layout</parameter>,
                                <parameter><link linkend="gboolean"><type>gboolean</type></link> setting</parameter>);</programlisting>
<para>If <parameter>setting</parameter>
 is <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>, do not treat newlines and similar characters
as paragraph separators; instead, keep all text in a single paragraph,
and display a glyph for paragraph separator characters. Used when
you want to allow editing of newlines on a single text line.</para>
<refsect3 id="pango-layout-set-single-paragraph-mode.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>layout</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayout"><type>PangoLayout</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>setting</para></entry>
<entry role="parameter_description"><para>new setting</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="pango-layout-get-single-paragraph-mode" role="function">
<title>pango_layout_get_single_paragraph_mode&#160;()</title>
<indexterm zone="pango-layout-get-single-paragraph-mode"><primary>pango_layout_get_single_paragraph_mode</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
pango_layout_get_single_paragraph_mode
                               (<parameter><link linkend="PangoLayout"><type>PangoLayout</type></link> *layout</parameter>);</programlisting>
<para>Obtains the value set by <link linkend="pango-layout-set-single-paragraph-mode"><function>pango_layout_set_single_paragraph_mode()</function></link>.</para>
<refsect3 id="pango-layout-get-single-paragraph-mode.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>layout</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayout"><type>PangoLayout</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="pango-layout-get-single-paragraph-mode.returns" role="returns">
<title>Returns</title>
<para> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the layout does not break paragraphs at
paragraph separator characters, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise.</para>
</refsect3></refsect2>
<refsect2 id="pango-layout-get-unknown-glyphs-count" role="function" condition="since:1.16">
<title>pango_layout_get_unknown_glyphs_count&#160;()</title>
<indexterm zone="pango-layout-get-unknown-glyphs-count" role="1.16"><primary>pango_layout_get_unknown_glyphs_count</primary></indexterm>
<programlisting language="C"><link linkend="int"><returnvalue>int</returnvalue></link>
pango_layout_get_unknown_glyphs_count (<parameter><link linkend="PangoLayout"><type>PangoLayout</type></link> *layout</parameter>);</programlisting>
<para>Counts the number unknown glyphs in <parameter>layout</parameter>
.  That is, zero if
glyphs for all characters in the layout text were found, or more
than zero otherwise.</para>
<para>This function can be used to determine if there are any fonts
available to render all characters in a certain string, or when
used in combination with <link linkend="PANGO-ATTR-FALLBACK:CAPS"><literal>PANGO_ATTR_FALLBACK</literal></link>, to check if a
certain font supports all the characters in the string.</para>
<refsect3 id="pango-layout-get-unknown-glyphs-count.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>layout</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayout"><type>PangoLayout</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="pango-layout-get-unknown-glyphs-count.returns" role="returns">
<title>Returns</title>
<para> The number of unknown glyphs in <parameter>layout</parameter>
.</para>
</refsect3><para role="since">Since: <link linkend="api-index-1.16">1.16</link></para></refsect2>
<refsect2 id="pango-layout-get-log-attrs" role="function">
<title>pango_layout_get_log_attrs&#160;()</title>
<indexterm zone="pango-layout-get-log-attrs"><primary>pango_layout_get_log_attrs</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
pango_layout_get_log_attrs (<parameter><link linkend="PangoLayout"><type>PangoLayout</type></link> *layout</parameter>,
                            <parameter><link linkend="PangoLogAttr"><type>PangoLogAttr</type></link> **attrs</parameter>,
                            <parameter><link linkend="gint"><type>gint</type></link> *n_attrs</parameter>);</programlisting>
<para>Retrieves an array of logical attributes for each character in
the <parameter>layout</parameter>
.</para>
<refsect3 id="pango-layout-get-log-attrs.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>layout</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayout"><type>PangoLayout</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>attrs</para></entry>
<entry role="parameter_description"><para>location to store a pointer to an array of logical attributes
This value must be freed with <link linkend="g-free"><function>g_free()</function></link>. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>out</acronym>][<acronym>array</acronym> length=n_attrs][<acronym>transfer container</acronym>]</emphasis></entry></row>
<row><entry role="parameter_name"><para>n_attrs</para></entry>
<entry role="parameter_description"><para>location to store the number of the attributes in the
array. (The stored value will be one more than the total number
of characters in the layout, since there need to be attributes
corresponding to both the position before the first character
and the position after the last character.). </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>out</acronym>]</emphasis></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="pango-layout-get-log-attrs-readonly" role="function" condition="since:1.30">
<title>pango_layout_get_log_attrs_readonly&#160;()</title>
<indexterm zone="pango-layout-get-log-attrs-readonly" role="1.30"><primary>pango_layout_get_log_attrs_readonly</primary></indexterm>
<programlisting language="C">const <link linkend="PangoLogAttr"><returnvalue>PangoLogAttr</returnvalue></link>&#160;*
pango_layout_get_log_attrs_readonly (<parameter><link linkend="PangoLayout"><type>PangoLayout</type></link> *layout</parameter>,
                                     <parameter><link linkend="gint"><type>gint</type></link> *n_attrs</parameter>);</programlisting>
<para>Retrieves an array of logical attributes for each character in
the <parameter>layout</parameter>
.</para>
<para>This is a faster alternative to <link linkend="pango-layout-get-log-attrs"><function>pango_layout_get_log_attrs()</function></link>.
The returned array is part of <parameter>layout</parameter>
 and must not be modified.
Modifying the layout will invalidate the returned array.</para>
<para>The number of attributes returned in <parameter>n_attrs</parameter>
 will be one more
than the total number of characters in the layout, since there
need to be attributes corresponding to both the position before
the first character and the position after the last character.</para>
<refsect3 id="pango-layout-get-log-attrs-readonly.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>layout</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayout"><type>PangoLayout</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>n_attrs</para></entry>
<entry role="parameter_description"><para>location to store the number of the attributes in
the array. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>out</acronym>]</emphasis></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="pango-layout-get-log-attrs-readonly.returns" role="returns">
<title>Returns</title>
<para>an array of logical attributes. </para>
<para><emphasis role="annotation">[<acronym>array</acronym> length=n_attrs]</emphasis></para>
</refsect3><para role="since">Since: <link linkend="api-index-1.30">1.30</link></para></refsect2>
<refsect2 id="pango-layout-index-to-pos" role="function">
<title>pango_layout_index_to_pos&#160;()</title>
<indexterm zone="pango-layout-index-to-pos"><primary>pango_layout_index_to_pos</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
pango_layout_index_to_pos (<parameter><link linkend="PangoLayout"><type>PangoLayout</type></link> *layout</parameter>,
                           <parameter><link linkend="int"><type>int</type></link> index_</parameter>,
                           <parameter><link linkend="PangoRectangle"><type>PangoRectangle</type></link> *pos</parameter>);</programlisting>
<para>Converts from an index within a <link linkend="PangoLayout"><type>PangoLayout</type></link> to the onscreen position
corresponding to the grapheme at that index, which is represented
as rectangle.  Note that <literal>pos->x</literal> is always the leading
edge of the grapheme and <literal>pos->x + pos->width</literal> the trailing
edge of the grapheme. If the directionality of the grapheme is right-to-left,
then <literal>pos->width</literal> will be negative.</para>
<refsect3 id="pango-layout-index-to-pos.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>layout</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayout"><type>PangoLayout</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>index_</para></entry>
<entry role="parameter_description"><para>byte index within <parameter>layout</parameter>
</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>pos</para></entry>
<entry role="parameter_description"><para>rectangle in which to store the position of the grapheme. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>out</acronym>]</emphasis></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="pango-layout-index-to-line-x" role="function">
<title>pango_layout_index_to_line_x&#160;()</title>
<indexterm zone="pango-layout-index-to-line-x"><primary>pango_layout_index_to_line_x</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
pango_layout_index_to_line_x (<parameter><link linkend="PangoLayout"><type>PangoLayout</type></link> *layout</parameter>,
                              <parameter><link linkend="int"><type>int</type></link> index_</parameter>,
                              <parameter><link linkend="gboolean"><type>gboolean</type></link> trailing</parameter>,
                              <parameter><link linkend="int"><type>int</type></link> *line</parameter>,
                              <parameter><link linkend="int"><type>int</type></link> *x_pos</parameter>);</programlisting>
<para>Converts from byte <parameter>index_</parameter>
 within the <parameter>layout</parameter>
 to line and X position.
(X position is measured from the left edge of the line)</para>
<refsect3 id="pango-layout-index-to-line-x.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>layout</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayout"><type>PangoLayout</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>index_</para></entry>
<entry role="parameter_description"><para>the byte index of a grapheme within the layout.</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>trailing</para></entry>
<entry role="parameter_description"><para>an integer indicating the edge of the grapheme to retrieve the
position of. If &gt; 0, the trailing edge of the grapheme, if 0,
the leading of the grapheme.</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>line</para></entry>
<entry role="parameter_description"><para>location to store resulting line index. (which will
between 0 and pango_layout_get_line_count(layout) - 1), or <link linkend="NULL:CAPS"><literal>NULL</literal></link>. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>out</acronym>][<acronym>allow-none</acronym>]</emphasis></entry></row>
<row><entry role="parameter_name"><para>x_pos</para></entry>
<entry role="parameter_description"><para>location to store resulting position within line
(<link linkend="PANGO-SCALE:CAPS"><literal>PANGO_SCALE</literal></link> units per device unit), or <link linkend="NULL:CAPS"><literal>NULL</literal></link>. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>out</acronym>][<acronym>allow-none</acronym>]</emphasis></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="pango-layout-xy-to-index" role="function">
<title>pango_layout_xy_to_index&#160;()</title>
<indexterm zone="pango-layout-xy-to-index"><primary>pango_layout_xy_to_index</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
pango_layout_xy_to_index (<parameter><link linkend="PangoLayout"><type>PangoLayout</type></link> *layout</parameter>,
                          <parameter><link linkend="int"><type>int</type></link> x</parameter>,
                          <parameter><link linkend="int"><type>int</type></link> y</parameter>,
                          <parameter><link linkend="int"><type>int</type></link> *index_</parameter>,
                          <parameter><link linkend="int"><type>int</type></link> *trailing</parameter>);</programlisting>
<para>Converts from X and Y position within a layout to the byte
index to the character at that logical position. If the
Y position is not inside the layout, the closest position is chosen
(the position will be clamped inside the layout). If the
X position is not within the layout, then the start or the
end of the line is chosen as described for <link linkend="pango-layout-line-x-to-index"><function>pango_layout_line_x_to_index()</function></link>.
If either the X or Y positions were not inside the layout, then the
function returns <link linkend="FALSE:CAPS"><literal>FALSE</literal></link>; on an exact hit, it returns <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>.</para>
<refsect3 id="pango-layout-xy-to-index.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>layout</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayout"><type>PangoLayout</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>x</para></entry>
<entry role="parameter_description"><para>the X offset (in Pango units)
from the left edge of the layout.</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>y</para></entry>
<entry role="parameter_description"><para>the Y offset (in Pango units)
from the top edge of the layout</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>index_</para></entry>
<entry role="parameter_description"><para>location to store calculated byte index. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>out</acronym>]</emphasis></entry></row>
<row><entry role="parameter_name"><para>trailing</para></entry>
<entry role="parameter_description"><para>location to store a integer indicating where
in the grapheme the user clicked. It will either
be zero, or the number of characters in the
grapheme. 0 represents the leading edge of the grapheme. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>out</acronym>]</emphasis></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="pango-layout-xy-to-index.returns" role="returns">
<title>Returns</title>
<para> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the coordinates were inside text, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise.</para>
</refsect3></refsect2>
<refsect2 id="pango-layout-get-cursor-pos" role="function">
<title>pango_layout_get_cursor_pos&#160;()</title>
<indexterm zone="pango-layout-get-cursor-pos"><primary>pango_layout_get_cursor_pos</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
pango_layout_get_cursor_pos (<parameter><link linkend="PangoLayout"><type>PangoLayout</type></link> *layout</parameter>,
                             <parameter><link linkend="int"><type>int</type></link> index_</parameter>,
                             <parameter><link linkend="PangoRectangle"><type>PangoRectangle</type></link> *strong_pos</parameter>,
                             <parameter><link linkend="PangoRectangle"><type>PangoRectangle</type></link> *weak_pos</parameter>);</programlisting>
<para>Given an index within a layout, determines the positions that of the
strong and weak cursors if the insertion point is at that
index. The position of each cursor is stored as a zero-width
rectangle. The strong cursor location is the location where
characters of the directionality equal to the base direction of the
layout are inserted.  The weak cursor location is the location
where characters of the directionality opposite to the base
direction of the layout are inserted.</para>
<refsect3 id="pango-layout-get-cursor-pos.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>layout</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayout"><type>PangoLayout</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>index_</para></entry>
<entry role="parameter_description"><para>the byte index of the cursor</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>strong_pos</para></entry>
<entry role="parameter_description"><para>location to store the strong cursor position
(may be <link linkend="NULL:CAPS"><literal>NULL</literal></link>). </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>out</acronym>][<acronym>allow-none</acronym>]</emphasis></entry></row>
<row><entry role="parameter_name"><para>weak_pos</para></entry>
<entry role="parameter_description"><para>location to store the weak cursor position (may be <link linkend="NULL:CAPS"><literal>NULL</literal></link>). </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>out</acronym>][<acronym>allow-none</acronym>]</emphasis></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="pango-layout-move-cursor-visually" role="function">
<title>pango_layout_move_cursor_visually&#160;()</title>
<indexterm zone="pango-layout-move-cursor-visually"><primary>pango_layout_move_cursor_visually</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
pango_layout_move_cursor_visually (<parameter><link linkend="PangoLayout"><type>PangoLayout</type></link> *layout</parameter>,
                                   <parameter><link linkend="gboolean"><type>gboolean</type></link> strong</parameter>,
                                   <parameter><link linkend="int"><type>int</type></link> old_index</parameter>,
                                   <parameter><link linkend="int"><type>int</type></link> old_trailing</parameter>,
                                   <parameter><link linkend="int"><type>int</type></link> direction</parameter>,
                                   <parameter><link linkend="int"><type>int</type></link> *new_index</parameter>,
                                   <parameter><link linkend="int"><type>int</type></link> *new_trailing</parameter>);</programlisting>
<para>Computes a new cursor position from an old position and
a count of positions to move visually. If <parameter>direction</parameter>
 is positive,
then the new strong cursor position will be one position
to the right of the old cursor position. If <parameter>direction</parameter>
 is negative,
then the new strong cursor position will be one position
to the left of the old cursor position.</para>
<para>In the presence of bidirectional text, the correspondence
between logical and visual order will depend on the direction
of the current run, and there may be jumps when the cursor
is moved off of the end of a run.</para>
<para>Motion here is in cursor positions, not in characters, so a
single call to <link linkend="pango-layout-move-cursor-visually"><function>pango_layout_move_cursor_visually()</function></link> may move the
cursor over multiple characters when multiple characters combine
to form a single grapheme.</para>
<refsect3 id="pango-layout-move-cursor-visually.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>layout</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayout"><type>PangoLayout</type></link>.</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>strong</para></entry>
<entry role="parameter_description"><para>whether the moving cursor is the strong cursor or the
weak cursor. The strong cursor is the cursor corresponding
to text insertion in the base direction for the layout.</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>old_index</para></entry>
<entry role="parameter_description"><para>the byte index of the grapheme for the old index</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>old_trailing</para></entry>
<entry role="parameter_description"><para>if 0, the cursor was at the leading edge of the
grapheme indicated by <parameter>old_index</parameter>
, if &gt; 0, the cursor
was at the trailing edge.</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>direction</para></entry>
<entry role="parameter_description"><para>direction to move cursor. A negative
value indicates motion to the left.</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>new_index</para></entry>
<entry role="parameter_description"><para>location to store the new cursor byte index. A value of -1
indicates that the cursor has been moved off the beginning
of the layout. A value of <link linkend="G-MAXINT:CAPS"><literal>G_MAXINT</literal></link> indicates that
the cursor has been moved off the end of the layout. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>out</acronym>]</emphasis></entry></row>
<row><entry role="parameter_name"><para>new_trailing</para></entry>
<entry role="parameter_description"><para>number of characters to move forward from the
location returned for <parameter>new_index</parameter>
to get the position
where the cursor should be displayed. This allows
distinguishing the position at the beginning of one
line from the position at the end of the preceding
line. <parameter>new_index</parameter>
is always on the line where the
cursor should be displayed. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>out</acronym>]</emphasis></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="pango-layout-get-extents" role="function">
<title>pango_layout_get_extents&#160;()</title>
<indexterm zone="pango-layout-get-extents"><primary>pango_layout_get_extents</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
pango_layout_get_extents (<parameter><link linkend="PangoLayout"><type>PangoLayout</type></link> *layout</parameter>,
                          <parameter><link linkend="PangoRectangle"><type>PangoRectangle</type></link> *ink_rect</parameter>,
                          <parameter><link linkend="PangoRectangle"><type>PangoRectangle</type></link> *logical_rect</parameter>);</programlisting>
<para>Computes the logical and ink extents of <parameter>layout</parameter>
. Logical extents
are usually what you want for positioning things.  Note that both extents
may have non-zero x and y.  You may want to use those to offset where you
render the layout.  Not doing that is a very typical bug that shows up as
right-to-left layouts not being correctly positioned in a layout with
a set width.</para>
<para>The extents are given in layout coordinates and in Pango units; layout
coordinates begin at the top left corner of the layout.</para>
<refsect3 id="pango-layout-get-extents.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>layout</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayout"><type>PangoLayout</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>ink_rect</para></entry>
<entry role="parameter_description"><para>rectangle used to store the extents of the
layout as drawn or <link linkend="NULL:CAPS"><literal>NULL</literal></link> to indicate that the result is
not needed. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>out</acronym>][<acronym>allow-none</acronym>]</emphasis></entry></row>
<row><entry role="parameter_name"><para>logical_rect</para></entry>
<entry role="parameter_description"><para>rectangle used to store the logical
extents of the layout or <link linkend="NULL:CAPS"><literal>NULL</literal></link> to indicate that the
result is not needed. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>out</acronym>][<acronym>allow-none</acronym>]</emphasis></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="pango-layout-get-pixel-extents" role="function">
<title>pango_layout_get_pixel_extents&#160;()</title>
<indexterm zone="pango-layout-get-pixel-extents"><primary>pango_layout_get_pixel_extents</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
pango_layout_get_pixel_extents (<parameter><link linkend="PangoLayout"><type>PangoLayout</type></link> *layout</parameter>,
                                <parameter><link linkend="PangoRectangle"><type>PangoRectangle</type></link> *ink_rect</parameter>,
                                <parameter><link linkend="PangoRectangle"><type>PangoRectangle</type></link> *logical_rect</parameter>);</programlisting>
<para>Computes the logical and ink extents of <parameter>layout</parameter>
 in device units.
This function just calls <link linkend="pango-layout-get-extents"><function>pango_layout_get_extents()</function></link> followed by
two <link linkend="pango-extents-to-pixels"><function>pango_extents_to_pixels()</function></link> calls, rounding <parameter>ink_rect</parameter>
 and <parameter>logical_rect</parameter>

such that the rounded rectangles fully contain the unrounded one (that is,
passes them as first argument to <link linkend="pango-extents-to-pixels"><function>pango_extents_to_pixels()</function></link>).</para>
<refsect3 id="pango-layout-get-pixel-extents.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>layout</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayout"><type>PangoLayout</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>ink_rect</para></entry>
<entry role="parameter_description"><para>rectangle used to store the extents of the
layout as drawn or <link linkend="NULL:CAPS"><literal>NULL</literal></link> to indicate that the result is
not needed. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>out</acronym>][<acronym>allow-none</acronym>]</emphasis></entry></row>
<row><entry role="parameter_name"><para>logical_rect</para></entry>
<entry role="parameter_description"><para>rectangle used to store the logical
extents of the layout or <link linkend="NULL:CAPS"><literal>NULL</literal></link> to indicate that the
result is not needed. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>out</acronym>][<acronym>allow-none</acronym>]</emphasis></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="pango-layout-get-size" role="function">
<title>pango_layout_get_size&#160;()</title>
<indexterm zone="pango-layout-get-size"><primary>pango_layout_get_size</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
pango_layout_get_size (<parameter><link linkend="PangoLayout"><type>PangoLayout</type></link> *layout</parameter>,
                       <parameter><link linkend="int"><type>int</type></link> *width</parameter>,
                       <parameter><link linkend="int"><type>int</type></link> *height</parameter>);</programlisting>
<para>Determines the logical width and height of a <link linkend="PangoLayout"><type>PangoLayout</type></link>
in Pango units (device units scaled by <link linkend="PANGO-SCALE:CAPS"><literal>PANGO_SCALE</literal></link>). This
is simply a convenience function around <link linkend="pango-layout-get-extents"><function>pango_layout_get_extents()</function></link>.</para>
<refsect3 id="pango-layout-get-size.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>layout</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayout"><type>PangoLayout</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>width</para></entry>
<entry role="parameter_description"><para>location to store the logical width, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>out</acronym>][<acronym>allow-none</acronym>]</emphasis></entry></row>
<row><entry role="parameter_name"><para>height</para></entry>
<entry role="parameter_description"><para>location to store the logical height, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>out</acronym>][<acronym>allow-none</acronym>]</emphasis></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="pango-layout-get-pixel-size" role="function">
<title>pango_layout_get_pixel_size&#160;()</title>
<indexterm zone="pango-layout-get-pixel-size"><primary>pango_layout_get_pixel_size</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
pango_layout_get_pixel_size (<parameter><link linkend="PangoLayout"><type>PangoLayout</type></link> *layout</parameter>,
                             <parameter><link linkend="int"><type>int</type></link> *width</parameter>,
                             <parameter><link linkend="int"><type>int</type></link> *height</parameter>);</programlisting>
<para>Determines the logical width and height of a <link linkend="PangoLayout"><type>PangoLayout</type></link>
in device units. (<link linkend="pango-layout-get-size"><function>pango_layout_get_size()</function></link> returns the width
and height scaled by <link linkend="PANGO-SCALE:CAPS"><literal>PANGO_SCALE</literal></link>.) This
is simply a convenience function around
<link linkend="pango-layout-get-pixel-extents"><function>pango_layout_get_pixel_extents()</function></link>.</para>
<refsect3 id="pango-layout-get-pixel-size.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>layout</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayout"><type>PangoLayout</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>width</para></entry>
<entry role="parameter_description"><para>location to store the logical width, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>out</acronym>][<acronym>allow-none</acronym>]</emphasis></entry></row>
<row><entry role="parameter_name"><para>height</para></entry>
<entry role="parameter_description"><para>location to store the logical height, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>out</acronym>][<acronym>allow-none</acronym>]</emphasis></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="pango-layout-get-baseline" role="function" condition="since:1.22">
<title>pango_layout_get_baseline&#160;()</title>
<indexterm zone="pango-layout-get-baseline" role="1.22"><primary>pango_layout_get_baseline</primary></indexterm>
<programlisting language="C"><link linkend="int"><returnvalue>int</returnvalue></link>
pango_layout_get_baseline (<parameter><link linkend="PangoLayout"><type>PangoLayout</type></link> *layout</parameter>);</programlisting>
<para>Gets the Y position of baseline of the first line in <parameter>layout</parameter>
.</para>
<refsect3 id="pango-layout-get-baseline.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>layout</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayout"><type>PangoLayout</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="pango-layout-get-baseline.returns" role="returns">
<title>Returns</title>
<para> baseline of first line, from top of <parameter>layout</parameter>
.</para>
</refsect3><para role="since">Since: <link linkend="api-index-1.22">1.22</link></para></refsect2>
<refsect2 id="pango-layout-get-line-count" role="function">
<title>pango_layout_get_line_count&#160;()</title>
<indexterm zone="pango-layout-get-line-count"><primary>pango_layout_get_line_count</primary></indexterm>
<programlisting language="C"><link linkend="int"><returnvalue>int</returnvalue></link>
pango_layout_get_line_count (<parameter><link linkend="PangoLayout"><type>PangoLayout</type></link> *layout</parameter>);</programlisting>
<para>Retrieves the count of lines for the <parameter>layout</parameter>
.</para>
<refsect3 id="pango-layout-get-line-count.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>layout</para></entry>
<entry role="parameter_description"><para><link linkend="PangoLayout"><type>PangoLayout</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="pango-layout-get-line-count.returns" role="returns">
<title>Returns</title>
<para> the line count.</para>
</refsect3></refsect2>
<refsect2 id="pango-layout-get-line" role="function">
<title>pango_layout_get_line&#160;()</title>
<indexterm zone="pango-layout-get-line"><primary>pango_layout_get_line</primary></indexterm>
<programlisting language="C"><link linkend="PangoLayoutLine"><returnvalue>PangoLayoutLine</returnvalue></link>&#160;*
pango_layout_get_line (<parameter><link linkend="PangoLayout"><type>PangoLayout</type></link> *layout</parameter>,
                       <parameter><link linkend="int"><type>int</type></link> line</parameter>);</programlisting>
<para>Retrieves a particular line from a <link linkend="PangoLayout"><type>PangoLayout</type></link>.</para>
<para>Use the faster <link linkend="pango-layout-get-line-readonly"><function>pango_layout_get_line_readonly()</function></link> if you do not plan
to modify the contents of the line (glyphs, glyph widths, etc.).</para>
<refsect3 id="pango-layout-get-line.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>layout</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayout"><type>PangoLayout</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>line</para></entry>
<entry role="parameter_description"><para>the index of a line, which must be between 0 and
<literal>pango_layout_get_line_count(layout) - 1</literal>, inclusive.</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="pango-layout-get-line.returns" role="returns">
<title>Returns</title>
<para>the requested
<link linkend="PangoLayoutLine"><type>PangoLayoutLine</type></link>, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if the index is out of
range. This layout line can be ref'ed and retained,
but will become invalid if changes are made to the
<link linkend="PangoLayout"><type>PangoLayout</type></link>. </para>
<para><emphasis role="annotation">[<acronym>transfer none</acronym>][<acronym>nullable</acronym>]</emphasis></para>
</refsect3></refsect2>
<refsect2 id="pango-layout-get-line-readonly" role="function" condition="since:1.16">
<title>pango_layout_get_line_readonly&#160;()</title>
<indexterm zone="pango-layout-get-line-readonly" role="1.16"><primary>pango_layout_get_line_readonly</primary></indexterm>
<programlisting language="C"><link linkend="PangoLayoutLine"><returnvalue>PangoLayoutLine</returnvalue></link>&#160;*
pango_layout_get_line_readonly (<parameter><link linkend="PangoLayout"><type>PangoLayout</type></link> *layout</parameter>,
                                <parameter><link linkend="int"><type>int</type></link> line</parameter>);</programlisting>
<para>Retrieves a particular line from a <link linkend="PangoLayout"><type>PangoLayout</type></link>.</para>
<para>This is a faster alternative to <link linkend="pango-layout-get-line"><function>pango_layout_get_line()</function></link>,
but the user is not expected
to modify the contents of the line (glyphs, glyph widths, etc.).</para>
<refsect3 id="pango-layout-get-line-readonly.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>layout</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayout"><type>PangoLayout</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>line</para></entry>
<entry role="parameter_description"><para>the index of a line, which must be between 0 and
<literal>pango_layout_get_line_count(layout) - 1</literal>, inclusive.</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="pango-layout-get-line-readonly.returns" role="returns">
<title>Returns</title>
<para>the requested
<link linkend="PangoLayoutLine"><type>PangoLayoutLine</type></link>, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if the index is out of
range. This layout line can be ref'ed and retained,
but will become invalid if changes are made to the
<link linkend="PangoLayout"><type>PangoLayout</type></link>.  No changes should be made to the line. </para>
<para><emphasis role="annotation">[<acronym>transfer none</acronym>][<acronym>nullable</acronym>]</emphasis></para>
</refsect3><para role="since">Since: <link linkend="api-index-1.16">1.16</link></para></refsect2>
<refsect2 id="pango-layout-get-lines" role="function">
<title>pango_layout_get_lines&#160;()</title>
<indexterm zone="pango-layout-get-lines"><primary>pango_layout_get_lines</primary></indexterm>
<programlisting language="C"><link linkend="GSList"><returnvalue>GSList</returnvalue></link>&#160;*
pango_layout_get_lines (<parameter><link linkend="PangoLayout"><type>PangoLayout</type></link> *layout</parameter>);</programlisting>
<para>Returns the lines of the <parameter>layout</parameter>
 as a list.</para>
<para>Use the faster <link linkend="pango-layout-get-lines-readonly"><function>pango_layout_get_lines_readonly()</function></link> if you do not plan
to modify the contents of the lines (glyphs, glyph widths, etc.).</para>
<refsect3 id="pango-layout-get-lines.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>layout</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayout"><type>PangoLayout</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="pango-layout-get-lines.returns" role="returns">
<title>Returns</title>
<para>a <link linkend="GSList"><type>GSList</type></link> containing
the lines in the layout. This points to internal data of the <link linkend="PangoLayout"><type>PangoLayout</type></link>
and must be used with care. It will become invalid on any change to the layout's
text or properties. </para>
<para><emphasis role="annotation">[<acronym>element-type</acronym> Pango.LayoutLine][<acronym>transfer none</acronym>]</emphasis></para>
</refsect3></refsect2>
<refsect2 id="pango-layout-get-lines-readonly" role="function" condition="since:1.16">
<title>pango_layout_get_lines_readonly&#160;()</title>
<indexterm zone="pango-layout-get-lines-readonly" role="1.16"><primary>pango_layout_get_lines_readonly</primary></indexterm>
<programlisting language="C"><link linkend="GSList"><returnvalue>GSList</returnvalue></link>&#160;*
pango_layout_get_lines_readonly (<parameter><link linkend="PangoLayout"><type>PangoLayout</type></link> *layout</parameter>);</programlisting>
<para>Returns the lines of the <parameter>layout</parameter>
 as a list.</para>
<para>This is a faster alternative to <link linkend="pango-layout-get-lines"><function>pango_layout_get_lines()</function></link>,
but the user is not expected
to modify the contents of the lines (glyphs, glyph widths, etc.).</para>
<refsect3 id="pango-layout-get-lines-readonly.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>layout</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayout"><type>PangoLayout</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="pango-layout-get-lines-readonly.returns" role="returns">
<title>Returns</title>
<para>a <link linkend="GSList"><type>GSList</type></link> containing
the lines in the layout. This points to internal data of the <link linkend="PangoLayout"><type>PangoLayout</type></link> and
must be used with care. It will become invalid on any change to the layout's
text or properties.  No changes should be made to the lines. </para>
<para><emphasis role="annotation">[<acronym>element-type</acronym> Pango.LayoutLine][<acronym>transfer none</acronym>]</emphasis></para>
</refsect3><para role="since">Since: <link linkend="api-index-1.16">1.16</link></para></refsect2>
<refsect2 id="pango-layout-get-iter" role="function">
<title>pango_layout_get_iter&#160;()</title>
<indexterm zone="pango-layout-get-iter"><primary>pango_layout_get_iter</primary></indexterm>
<programlisting language="C"><link linkend="PangoLayoutIter"><returnvalue>PangoLayoutIter</returnvalue></link>&#160;*
pango_layout_get_iter (<parameter><link linkend="PangoLayout"><type>PangoLayout</type></link> *layout</parameter>);</programlisting>
<para>Returns an iterator to iterate over the visual extents of the layout.</para>
<refsect3 id="pango-layout-get-iter.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>layout</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayout"><type>PangoLayout</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="pango-layout-get-iter.returns" role="returns">
<title>Returns</title>
<para> the new <link linkend="PangoLayoutIter"><type>PangoLayoutIter</type></link> that should be freed using
<link linkend="pango-layout-iter-free"><function>pango_layout_iter_free()</function></link>.</para>
</refsect3></refsect2>
<refsect2 id="pango-layout-iter-copy" role="function" condition="since:1.20">
<title>pango_layout_iter_copy&#160;()</title>
<indexterm zone="pango-layout-iter-copy" role="1.20"><primary>pango_layout_iter_copy</primary></indexterm>
<programlisting language="C"><link linkend="PangoLayoutIter"><returnvalue>PangoLayoutIter</returnvalue></link>&#160;*
pango_layout_iter_copy (<parameter><link linkend="PangoLayoutIter"><type>PangoLayoutIter</type></link> *iter</parameter>);</programlisting>
<para>Copies a <link linkend="PangoLayoutIter"><type>PangoLayoutIter</type></link>.</para>
<refsect3 id="pango-layout-iter-copy.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayoutIter"><type>PangoLayoutIter</type></link>, may be <link linkend="NULL:CAPS"><literal>NULL</literal></link>. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>nullable</acronym>]</emphasis></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="pango-layout-iter-copy.returns" role="returns">
<title>Returns</title>
<para>the newly allocated <link linkend="PangoLayoutIter"><type>PangoLayoutIter</type></link>,
which should be freed with <link linkend="pango-layout-iter-free"><function>pango_layout_iter_free()</function></link>,
or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if <parameter>iter</parameter>
was <link linkend="NULL:CAPS"><literal>NULL</literal></link>. </para>
<para><emphasis role="annotation">[<acronym>nullable</acronym>]</emphasis></para>
</refsect3><para role="since">Since: <link linkend="api-index-1.20">1.20</link></para></refsect2>
<refsect2 id="pango-layout-iter-free" role="function">
<title>pango_layout_iter_free&#160;()</title>
<indexterm zone="pango-layout-iter-free"><primary>pango_layout_iter_free</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
pango_layout_iter_free (<parameter><link linkend="PangoLayoutIter"><type>PangoLayoutIter</type></link> *iter</parameter>);</programlisting>
<para>Frees an iterator that's no longer in use.</para>
<refsect3 id="pango-layout-iter-free.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayoutIter"><type>PangoLayoutIter</type></link>, may be <link linkend="NULL:CAPS"><literal>NULL</literal></link>. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>nullable</acronym>]</emphasis></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="pango-layout-iter-next-run" role="function">
<title>pango_layout_iter_next_run&#160;()</title>
<indexterm zone="pango-layout-iter-next-run"><primary>pango_layout_iter_next_run</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
pango_layout_iter_next_run (<parameter><link linkend="PangoLayoutIter"><type>PangoLayoutIter</type></link> *iter</parameter>);</programlisting>
<para>Moves <parameter>iter</parameter>
 forward to the next run in visual order. If <parameter>iter</parameter>
 was
already at the end of the layout, returns <link linkend="FALSE:CAPS"><literal>FALSE</literal></link>.</para>
<refsect3 id="pango-layout-iter-next-run.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayoutIter"><type>PangoLayoutIter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="pango-layout-iter-next-run.returns" role="returns">
<title>Returns</title>
<para> whether motion was possible.</para>
</refsect3></refsect2>
<refsect2 id="pango-layout-iter-next-char" role="function">
<title>pango_layout_iter_next_char&#160;()</title>
<indexterm zone="pango-layout-iter-next-char"><primary>pango_layout_iter_next_char</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
pango_layout_iter_next_char (<parameter><link linkend="PangoLayoutIter"><type>PangoLayoutIter</type></link> *iter</parameter>);</programlisting>
<para>Moves <parameter>iter</parameter>
 forward to the next character in visual order. If <parameter>iter</parameter>
 was already at
the end of the layout, returns <link linkend="FALSE:CAPS"><literal>FALSE</literal></link>.</para>
<refsect3 id="pango-layout-iter-next-char.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayoutIter"><type>PangoLayoutIter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="pango-layout-iter-next-char.returns" role="returns">
<title>Returns</title>
<para> whether motion was possible.</para>
</refsect3></refsect2>
<refsect2 id="pango-layout-iter-next-cluster" role="function">
<title>pango_layout_iter_next_cluster&#160;()</title>
<indexterm zone="pango-layout-iter-next-cluster"><primary>pango_layout_iter_next_cluster</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
pango_layout_iter_next_cluster (<parameter><link linkend="PangoLayoutIter"><type>PangoLayoutIter</type></link> *iter</parameter>);</programlisting>
<para>Moves <parameter>iter</parameter>
 forward to the next cluster in visual order. If <parameter>iter</parameter>

was already at the end of the layout, returns <link linkend="FALSE:CAPS"><literal>FALSE</literal></link>.</para>
<refsect3 id="pango-layout-iter-next-cluster.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayoutIter"><type>PangoLayoutIter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="pango-layout-iter-next-cluster.returns" role="returns">
<title>Returns</title>
<para> whether motion was possible.</para>
</refsect3></refsect2>
<refsect2 id="pango-layout-iter-next-line" role="function">
<title>pango_layout_iter_next_line&#160;()</title>
<indexterm zone="pango-layout-iter-next-line"><primary>pango_layout_iter_next_line</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
pango_layout_iter_next_line (<parameter><link linkend="PangoLayoutIter"><type>PangoLayoutIter</type></link> *iter</parameter>);</programlisting>
<para>Moves <parameter>iter</parameter>
 forward to the start of the next line. If <parameter>iter</parameter>
 is
already on the last line, returns <link linkend="FALSE:CAPS"><literal>FALSE</literal></link>.</para>
<refsect3 id="pango-layout-iter-next-line.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayoutIter"><type>PangoLayoutIter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="pango-layout-iter-next-line.returns" role="returns">
<title>Returns</title>
<para> whether motion was possible.</para>
</refsect3></refsect2>
<refsect2 id="pango-layout-iter-at-last-line" role="function">
<title>pango_layout_iter_at_last_line&#160;()</title>
<indexterm zone="pango-layout-iter-at-last-line"><primary>pango_layout_iter_at_last_line</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
pango_layout_iter_at_last_line (<parameter><link linkend="PangoLayoutIter"><type>PangoLayoutIter</type></link> *iter</parameter>);</programlisting>
<para>Determines whether <parameter>iter</parameter>
 is on the last line of the layout.</para>
<refsect3 id="pango-layout-iter-at-last-line.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayoutIter"><type>PangoLayoutIter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="pango-layout-iter-at-last-line.returns" role="returns">
<title>Returns</title>
<para> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>iter</parameter>
is on the last line.</para>
</refsect3></refsect2>
<refsect2 id="pango-layout-iter-get-index" role="function">
<title>pango_layout_iter_get_index&#160;()</title>
<indexterm zone="pango-layout-iter-get-index"><primary>pango_layout_iter_get_index</primary></indexterm>
<programlisting language="C"><link linkend="int"><returnvalue>int</returnvalue></link>
pango_layout_iter_get_index (<parameter><link linkend="PangoLayoutIter"><type>PangoLayoutIter</type></link> *iter</parameter>);</programlisting>
<para>Gets the current byte index. Note that iterating forward by char
moves in visual order, not logical order, so indexes may not be
sequential. Also, the index may be equal to the length of the text
in the layout, if on the <link linkend="NULL:CAPS"><literal>NULL</literal></link> run (see <link linkend="pango-layout-iter-get-run"><function>pango_layout_iter_get_run()</function></link>).</para>
<refsect3 id="pango-layout-iter-get-index.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayoutIter"><type>PangoLayoutIter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="pango-layout-iter-get-index.returns" role="returns">
<title>Returns</title>
<para> current byte index.</para>
</refsect3></refsect2>
<refsect2 id="pango-layout-iter-get-baseline" role="function">
<title>pango_layout_iter_get_baseline&#160;()</title>
<indexterm zone="pango-layout-iter-get-baseline"><primary>pango_layout_iter_get_baseline</primary></indexterm>
<programlisting language="C"><link linkend="int"><returnvalue>int</returnvalue></link>
pango_layout_iter_get_baseline (<parameter><link linkend="PangoLayoutIter"><type>PangoLayoutIter</type></link> *iter</parameter>);</programlisting>
<para>Gets the Y position of the current line's baseline, in layout
coordinates (origin at top left of the entire layout).</para>
<refsect3 id="pango-layout-iter-get-baseline.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayoutIter"><type>PangoLayoutIter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="pango-layout-iter-get-baseline.returns" role="returns">
<title>Returns</title>
<para> baseline of current line.</para>
</refsect3></refsect2>
<refsect2 id="pango-layout-iter-get-run" role="function">
<title>pango_layout_iter_get_run&#160;()</title>
<indexterm zone="pango-layout-iter-get-run"><primary>pango_layout_iter_get_run</primary></indexterm>
<programlisting language="C"><link linkend="PangoLayoutRun"><returnvalue>PangoLayoutRun</returnvalue></link>&#160;*
pango_layout_iter_get_run (<parameter><link linkend="PangoLayoutIter"><type>PangoLayoutIter</type></link> *iter</parameter>);</programlisting>
<para>Gets the current run. When iterating by run, at the end of each
line, there's a position with a <link linkend="NULL:CAPS"><literal>NULL</literal></link> run, so this function can return
<link linkend="NULL:CAPS"><literal>NULL</literal></link>. The <link linkend="NULL:CAPS"><literal>NULL</literal></link> run at the end of each line ensures that all lines have
at least one run, even lines consisting of only a newline.</para>
<para>Use the faster <link linkend="pango-layout-iter-get-run-readonly"><function>pango_layout_iter_get_run_readonly()</function></link> if you do not plan
to modify the contents of the run (glyphs, glyph widths, etc.).</para>
<refsect3 id="pango-layout-iter-get-run.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayoutIter"><type>PangoLayoutIter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="pango-layout-iter-get-run.returns" role="returns">
<title>Returns</title>
<para>the current run. </para>
<para><emphasis role="annotation">[<acronym>transfer none</acronym>][<acronym>nullable</acronym>]</emphasis></para>
</refsect3></refsect2>
<refsect2 id="pango-layout-iter-get-run-readonly" role="function" condition="since:1.16">
<title>pango_layout_iter_get_run_readonly&#160;()</title>
<indexterm zone="pango-layout-iter-get-run-readonly" role="1.16"><primary>pango_layout_iter_get_run_readonly</primary></indexterm>
<programlisting language="C"><link linkend="PangoLayoutRun"><returnvalue>PangoLayoutRun</returnvalue></link>&#160;*
pango_layout_iter_get_run_readonly (<parameter><link linkend="PangoLayoutIter"><type>PangoLayoutIter</type></link> *iter</parameter>);</programlisting>
<para>Gets the current run. When iterating by run, at the end of each
line, there's a position with a <link linkend="NULL:CAPS"><literal>NULL</literal></link> run, so this function can return
<link linkend="NULL:CAPS"><literal>NULL</literal></link>. The <link linkend="NULL:CAPS"><literal>NULL</literal></link> run at the end of each line ensures that all lines have
at least one run, even lines consisting of only a newline.</para>
<para>This is a faster alternative to <link linkend="pango-layout-iter-get-run"><function>pango_layout_iter_get_run()</function></link>,
but the user is not expected
to modify the contents of the run (glyphs, glyph widths, etc.).</para>
<refsect3 id="pango-layout-iter-get-run-readonly.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayoutIter"><type>PangoLayoutIter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="pango-layout-iter-get-run-readonly.returns" role="returns">
<title>Returns</title>
<para>the current run, that
should not be modified. </para>
<para><emphasis role="annotation">[<acronym>transfer none</acronym>][<acronym>nullable</acronym>]</emphasis></para>
</refsect3><para role="since">Since: <link linkend="api-index-1.16">1.16</link></para></refsect2>
<refsect2 id="pango-layout-iter-get-line" role="function">
<title>pango_layout_iter_get_line&#160;()</title>
<indexterm zone="pango-layout-iter-get-line"><primary>pango_layout_iter_get_line</primary></indexterm>
<programlisting language="C"><link linkend="PangoLayoutLine"><returnvalue>PangoLayoutLine</returnvalue></link>&#160;*
pango_layout_iter_get_line (<parameter><link linkend="PangoLayoutIter"><type>PangoLayoutIter</type></link> *iter</parameter>);</programlisting>
<para>Gets the current line.</para>
<para>Use the faster <link linkend="pango-layout-iter-get-line-readonly"><function>pango_layout_iter_get_line_readonly()</function></link> if you do not plan
to modify the contents of the line (glyphs, glyph widths, etc.).</para>
<refsect3 id="pango-layout-iter-get-line.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayoutIter"><type>PangoLayoutIter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="pango-layout-iter-get-line.returns" role="returns">
<title>Returns</title>
<para>the current line. </para>
<para><emphasis role="annotation">[<acronym>transfer none</acronym>]</emphasis></para>
</refsect3></refsect2>
<refsect2 id="pango-layout-iter-get-line-readonly" role="function" condition="since:1.16">
<title>pango_layout_iter_get_line_readonly&#160;()</title>
<indexterm zone="pango-layout-iter-get-line-readonly" role="1.16"><primary>pango_layout_iter_get_line_readonly</primary></indexterm>
<programlisting language="C"><link linkend="PangoLayoutLine"><returnvalue>PangoLayoutLine</returnvalue></link>&#160;*
pango_layout_iter_get_line_readonly (<parameter><link linkend="PangoLayoutIter"><type>PangoLayoutIter</type></link> *iter</parameter>);</programlisting>
<para>Gets the current line for read-only access.</para>
<para>This is a faster alternative to <link linkend="pango-layout-iter-get-line"><function>pango_layout_iter_get_line()</function></link>,
but the user is not expected
to modify the contents of the line (glyphs, glyph widths, etc.).</para>
<refsect3 id="pango-layout-iter-get-line-readonly.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayoutIter"><type>PangoLayoutIter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="pango-layout-iter-get-line-readonly.returns" role="returns">
<title>Returns</title>
<para>the current line, that should not be
modified. </para>
<para><emphasis role="annotation">[<acronym>transfer none</acronym>]</emphasis></para>
</refsect3><para role="since">Since: <link linkend="api-index-1.16">1.16</link></para></refsect2>
<refsect2 id="pango-layout-iter-get-layout" role="function" condition="since:1.20">
<title>pango_layout_iter_get_layout&#160;()</title>
<indexterm zone="pango-layout-iter-get-layout" role="1.20"><primary>pango_layout_iter_get_layout</primary></indexterm>
<programlisting language="C"><link linkend="PangoLayout"><returnvalue>PangoLayout</returnvalue></link>&#160;*
pango_layout_iter_get_layout (<parameter><link linkend="PangoLayoutIter"><type>PangoLayoutIter</type></link> *iter</parameter>);</programlisting>
<para>Gets the layout associated with a <link linkend="PangoLayoutIter"><type>PangoLayoutIter</type></link>.</para>
<refsect3 id="pango-layout-iter-get-layout.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayoutIter"><type>PangoLayoutIter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="pango-layout-iter-get-layout.returns" role="returns">
<title>Returns</title>
<para>the layout associated with <parameter>iter</parameter>
. </para>
<para><emphasis role="annotation">[<acronym>transfer none</acronym>]</emphasis></para>
</refsect3><para role="since">Since: <link linkend="api-index-1.20">1.20</link></para></refsect2>
<refsect2 id="pango-layout-iter-get-char-extents" role="function">
<title>pango_layout_iter_get_char_extents&#160;()</title>
<indexterm zone="pango-layout-iter-get-char-extents"><primary>pango_layout_iter_get_char_extents</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
pango_layout_iter_get_char_extents (<parameter><link linkend="PangoLayoutIter"><type>PangoLayoutIter</type></link> *iter</parameter>,
                                    <parameter><link linkend="PangoRectangle"><type>PangoRectangle</type></link> *logical_rect</parameter>);</programlisting>
<para>Gets the extents of the current character, in layout coordinates
(origin is the top left of the entire layout). Only logical extents
can sensibly be obtained for characters; ink extents make sense only
down to the level of clusters.</para>
<refsect3 id="pango-layout-iter-get-char-extents.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayoutIter"><type>PangoLayoutIter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>logical_rect</para></entry>
<entry role="parameter_description"><para>rectangle to fill with
logical extents. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>out caller-allocates</acronym>]</emphasis></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="pango-layout-iter-get-cluster-extents" role="function">
<title>pango_layout_iter_get_cluster_extents&#160;()</title>
<indexterm zone="pango-layout-iter-get-cluster-extents"><primary>pango_layout_iter_get_cluster_extents</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
pango_layout_iter_get_cluster_extents (<parameter><link linkend="PangoLayoutIter"><type>PangoLayoutIter</type></link> *iter</parameter>,
                                       <parameter><link linkend="PangoRectangle"><type>PangoRectangle</type></link> *ink_rect</parameter>,
                                       <parameter><link linkend="PangoRectangle"><type>PangoRectangle</type></link> *logical_rect</parameter>);</programlisting>
<para>Gets the extents of the current cluster, in layout coordinates
(origin is the top left of the entire layout).</para>
<refsect3 id="pango-layout-iter-get-cluster-extents.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayoutIter"><type>PangoLayoutIter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>ink_rect</para></entry>
<entry role="parameter_description"><para>rectangle to fill with ink extents, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>out</acronym>][<acronym>allow-none</acronym>]</emphasis></entry></row>
<row><entry role="parameter_name"><para>logical_rect</para></entry>
<entry role="parameter_description"><para>rectangle to fill with logical extents, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>out</acronym>][<acronym>allow-none</acronym>]</emphasis></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="pango-layout-iter-get-run-extents" role="function">
<title>pango_layout_iter_get_run_extents&#160;()</title>
<indexterm zone="pango-layout-iter-get-run-extents"><primary>pango_layout_iter_get_run_extents</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
pango_layout_iter_get_run_extents (<parameter><link linkend="PangoLayoutIter"><type>PangoLayoutIter</type></link> *iter</parameter>,
                                   <parameter><link linkend="PangoRectangle"><type>PangoRectangle</type></link> *ink_rect</parameter>,
                                   <parameter><link linkend="PangoRectangle"><type>PangoRectangle</type></link> *logical_rect</parameter>);</programlisting>
<para>Gets the extents of the current run in layout coordinates
(origin is the top left of the entire layout).</para>
<refsect3 id="pango-layout-iter-get-run-extents.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayoutIter"><type>PangoLayoutIter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>ink_rect</para></entry>
<entry role="parameter_description"><para>rectangle to fill with ink extents, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>out</acronym>][<acronym>allow-none</acronym>]</emphasis></entry></row>
<row><entry role="parameter_name"><para>logical_rect</para></entry>
<entry role="parameter_description"><para>rectangle to fill with logical extents, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>out</acronym>][<acronym>allow-none</acronym>]</emphasis></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="pango-layout-iter-get-line-yrange" role="function">
<title>pango_layout_iter_get_line_yrange&#160;()</title>
<indexterm zone="pango-layout-iter-get-line-yrange"><primary>pango_layout_iter_get_line_yrange</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
pango_layout_iter_get_line_yrange (<parameter><link linkend="PangoLayoutIter"><type>PangoLayoutIter</type></link> *iter</parameter>,
                                   <parameter><link linkend="int"><type>int</type></link> *y0_</parameter>,
                                   <parameter><link linkend="int"><type>int</type></link> *y1_</parameter>);</programlisting>
<para>Divides the vertical space in the <link linkend="PangoLayout"><type>PangoLayout</type></link> being iterated over
between the lines in the layout, and returns the space belonging to
the current line.  A line's range includes the line's logical
extents, plus half of the spacing above and below the line, if
<link linkend="pango-layout-set-spacing"><function>pango_layout_set_spacing()</function></link> has been called to set layout spacing.
The Y positions are in layout coordinates (origin at top left of the
entire layout).</para>
<para>Note: Since 1.44, Pango uses line heights for placing lines,
and there may be gaps between the ranges returned by this
function.</para>
<refsect3 id="pango-layout-iter-get-line-yrange.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayoutIter"><type>PangoLayoutIter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>y0_</para></entry>
<entry role="parameter_description"><para>start of line, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>out</acronym>][<acronym>allow-none</acronym>]</emphasis></entry></row>
<row><entry role="parameter_name"><para>y1_</para></entry>
<entry role="parameter_description"><para>end of line, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>out</acronym>][<acronym>allow-none</acronym>]</emphasis></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="pango-layout-iter-get-line-extents" role="function">
<title>pango_layout_iter_get_line_extents&#160;()</title>
<indexterm zone="pango-layout-iter-get-line-extents"><primary>pango_layout_iter_get_line_extents</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
pango_layout_iter_get_line_extents (<parameter><link linkend="PangoLayoutIter"><type>PangoLayoutIter</type></link> *iter</parameter>,
                                    <parameter><link linkend="PangoRectangle"><type>PangoRectangle</type></link> *ink_rect</parameter>,
                                    <parameter><link linkend="PangoRectangle"><type>PangoRectangle</type></link> *logical_rect</parameter>);</programlisting>
<para>Obtains the extents of the current line. <parameter>ink_rect</parameter>
 or <parameter>logical_rect</parameter>

can be <link linkend="NULL:CAPS"><literal>NULL</literal></link> if you aren't interested in them. Extents are in layout
coordinates (origin is the top-left corner of the entire
<link linkend="PangoLayout"><type>PangoLayout</type></link>).  Thus the extents returned by this function will be
the same width/height but not at the same x/y as the extents
returned from <link linkend="pango-layout-line-get-extents"><function>pango_layout_line_get_extents()</function></link>.</para>
<refsect3 id="pango-layout-iter-get-line-extents.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayoutIter"><type>PangoLayoutIter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>ink_rect</para></entry>
<entry role="parameter_description"><para>rectangle to fill with ink extents, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>out</acronym>][<acronym>allow-none</acronym>]</emphasis></entry></row>
<row><entry role="parameter_name"><para>logical_rect</para></entry>
<entry role="parameter_description"><para>rectangle to fill with logical extents, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>out</acronym>][<acronym>allow-none</acronym>]</emphasis></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="pango-layout-iter-get-layout-extents" role="function">
<title>pango_layout_iter_get_layout_extents&#160;()</title>
<indexterm zone="pango-layout-iter-get-layout-extents"><primary>pango_layout_iter_get_layout_extents</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
pango_layout_iter_get_layout_extents (<parameter><link linkend="PangoLayoutIter"><type>PangoLayoutIter</type></link> *iter</parameter>,
                                      <parameter><link linkend="PangoRectangle"><type>PangoRectangle</type></link> *ink_rect</parameter>,
                                      <parameter><link linkend="PangoRectangle"><type>PangoRectangle</type></link> *logical_rect</parameter>);</programlisting>
<para>Obtains the extents of the <link linkend="PangoLayout"><type>PangoLayout</type></link> being iterated
over. <parameter>ink_rect</parameter>
 or <parameter>logical_rect</parameter>
 can be <link linkend="NULL:CAPS"><literal>NULL</literal></link> if you
aren't interested in them.</para>
<refsect3 id="pango-layout-iter-get-layout-extents.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>iter</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayoutIter"><type>PangoLayoutIter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>ink_rect</para></entry>
<entry role="parameter_description"><para>rectangle to fill with ink extents,
or <link linkend="NULL:CAPS"><literal>NULL</literal></link>. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>out</acronym>][<acronym>allow-none</acronym>]</emphasis></entry></row>
<row><entry role="parameter_name"><para>logical_rect</para></entry>
<entry role="parameter_description"><para>rectangle to fill with logical
extents, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>out</acronym>][<acronym>allow-none</acronym>]</emphasis></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="pango-layout-line-ref" role="function" condition="since:1.10">
<title>pango_layout_line_ref&#160;()</title>
<indexterm zone="pango-layout-line-ref" role="1.10"><primary>pango_layout_line_ref</primary></indexterm>
<programlisting language="C"><link linkend="PangoLayoutLine"><returnvalue>PangoLayoutLine</returnvalue></link>&#160;*
pango_layout_line_ref (<parameter><link linkend="PangoLayoutLine"><type>PangoLayoutLine</type></link> *line</parameter>);</programlisting>
<para>Increase the reference count of a <link linkend="PangoLayoutLine"><type>PangoLayoutLine</type></link> by one.</para>
<refsect3 id="pango-layout-line-ref.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>line</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayoutLine"><type>PangoLayoutLine</type></link>, may be <link linkend="NULL:CAPS"><literal>NULL</literal></link>. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>nullable</acronym>]</emphasis></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="pango-layout-line-ref.returns" role="returns">
<title>Returns</title>
<para> the line passed in.</para>
</refsect3><para role="since">Since: <link linkend="api-index-1.10">1.10</link></para></refsect2>
<refsect2 id="pango-layout-line-unref" role="function">
<title>pango_layout_line_unref&#160;()</title>
<indexterm zone="pango-layout-line-unref"><primary>pango_layout_line_unref</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
pango_layout_line_unref (<parameter><link linkend="PangoLayoutLine"><type>PangoLayoutLine</type></link> *line</parameter>);</programlisting>
<para>Decrease the reference count of a <link linkend="PangoLayoutLine"><type>PangoLayoutLine</type></link> by one.
If the result is zero, the line and all associated memory
will be freed.</para>
<refsect3 id="pango-layout-line-unref.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>line</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayoutLine"><type>PangoLayoutLine</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="pango-layout-line-get-extents" role="function">
<title>pango_layout_line_get_extents&#160;()</title>
<indexterm zone="pango-layout-line-get-extents"><primary>pango_layout_line_get_extents</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
pango_layout_line_get_extents (<parameter><link linkend="PangoLayoutLine"><type>PangoLayoutLine</type></link> *line</parameter>,
                               <parameter><link linkend="PangoRectangle"><type>PangoRectangle</type></link> *ink_rect</parameter>,
                               <parameter><link linkend="PangoRectangle"><type>PangoRectangle</type></link> *logical_rect</parameter>);</programlisting>
<para>Computes the logical and ink extents of a layout line. See
<link linkend="pango-font-get-glyph-extents"><function>pango_font_get_glyph_extents()</function></link> for details about the interpretation
of the rectangles.</para>
<refsect3 id="pango-layout-line-get-extents.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>line</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayoutLine"><type>PangoLayoutLine</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>ink_rect</para></entry>
<entry role="parameter_description"><para>rectangle used to store the extents of
the glyph string as drawn, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>out</acronym>][<acronym>allow-none</acronym>]</emphasis></entry></row>
<row><entry role="parameter_name"><para>logical_rect</para></entry>
<entry role="parameter_description"><para>rectangle used to store the logical
extents of the glyph string, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>out</acronym>][<acronym>allow-none</acronym>]</emphasis></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="pango-layout-line-get-pixel-extents" role="function">
<title>pango_layout_line_get_pixel_extents&#160;()</title>
<indexterm zone="pango-layout-line-get-pixel-extents"><primary>pango_layout_line_get_pixel_extents</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
pango_layout_line_get_pixel_extents (<parameter><link linkend="PangoLayoutLine"><type>PangoLayoutLine</type></link> *layout_line</parameter>,
                                     <parameter><link linkend="PangoRectangle"><type>PangoRectangle</type></link> *ink_rect</parameter>,
                                     <parameter><link linkend="PangoRectangle"><type>PangoRectangle</type></link> *logical_rect</parameter>);</programlisting>
<para>Computes the logical and ink extents of <parameter>layout_line</parameter>
 in device units.
This function just calls <link linkend="pango-layout-line-get-extents"><function>pango_layout_line_get_extents()</function></link> followed by
two <link linkend="pango-extents-to-pixels"><function>pango_extents_to_pixels()</function></link> calls, rounding <parameter>ink_rect</parameter>
 and <parameter>logical_rect</parameter>

such that the rounded rectangles fully contain the unrounded one (that is,
passes them as first argument to <link linkend="pango-extents-to-pixels"><function>pango_extents_to_pixels()</function></link>).</para>
<refsect3 id="pango-layout-line-get-pixel-extents.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>layout_line</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayoutLine"><type>PangoLayoutLine</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>ink_rect</para></entry>
<entry role="parameter_description"><para>rectangle used to store the extents of
the glyph string as drawn, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>out</acronym>][<acronym>allow-none</acronym>]</emphasis></entry></row>
<row><entry role="parameter_name"><para>logical_rect</para></entry>
<entry role="parameter_description"><para>rectangle used to store the logical
extents of the glyph string, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>out</acronym>][<acronym>allow-none</acronym>]</emphasis></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="pango-layout-line-index-to-x" role="function">
<title>pango_layout_line_index_to_x&#160;()</title>
<indexterm zone="pango-layout-line-index-to-x"><primary>pango_layout_line_index_to_x</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
pango_layout_line_index_to_x (<parameter><link linkend="PangoLayoutLine"><type>PangoLayoutLine</type></link> *line</parameter>,
                              <parameter><link linkend="int"><type>int</type></link> index_</parameter>,
                              <parameter><link linkend="gboolean"><type>gboolean</type></link> trailing</parameter>,
                              <parameter><link linkend="int"><type>int</type></link> *x_pos</parameter>);</programlisting>
<para>Converts an index within a line to a X position.</para>
<refsect3 id="pango-layout-line-index-to-x.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>line</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayoutLine"><type>PangoLayoutLine</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>index_</para></entry>
<entry role="parameter_description"><para>byte offset of a grapheme within the layout</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>trailing</para></entry>
<entry role="parameter_description"><para>an integer indicating the edge of the grapheme to retrieve
the position of. If &gt; 0, the trailing edge of the grapheme,
if 0, the leading of the grapheme.</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>x_pos</para></entry>
<entry role="parameter_description"><para>location to store the x_offset (in Pango unit). </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>out</acronym>]</emphasis></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="pango-layout-line-x-to-index" role="function">
<title>pango_layout_line_x_to_index&#160;()</title>
<indexterm zone="pango-layout-line-x-to-index"><primary>pango_layout_line_x_to_index</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
pango_layout_line_x_to_index (<parameter><link linkend="PangoLayoutLine"><type>PangoLayoutLine</type></link> *line</parameter>,
                              <parameter><link linkend="int"><type>int</type></link> x_pos</parameter>,
                              <parameter><link linkend="int"><type>int</type></link> *index_</parameter>,
                              <parameter><link linkend="int"><type>int</type></link> *trailing</parameter>);</programlisting>
<para>Converts from x offset to the byte index of the corresponding
character within the text of the layout. If <parameter>x_pos</parameter>
 is outside the line,
<parameter>index_</parameter>
 and <parameter>trailing</parameter>
 will point to the very first or very last position
in the line. This determination is based on the resolved direction
of the paragraph; for example, if the resolved direction is
right-to-left, then an X position to the right of the line (after it)
results in 0 being stored in <parameter>index_</parameter>
 and <parameter>trailing</parameter>
. An X position to the
left of the line results in <parameter>index_</parameter>
 pointing to the (logical) last
grapheme in the line and <parameter>trailing</parameter>
 being set to the number of characters
in that grapheme. The reverse is true for a left-to-right line.</para>
<refsect3 id="pango-layout-line-x-to-index.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>line</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayoutLine"><type>PangoLayoutLine</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>x_pos</para></entry>
<entry role="parameter_description"><para>the X offset (in Pango units)
from the left edge of the line.</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>index_</para></entry>
<entry role="parameter_description"><para>location to store calculated byte index for
the grapheme in which the user clicked. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>out</acronym>]</emphasis></entry></row>
<row><entry role="parameter_name"><para>trailing</para></entry>
<entry role="parameter_description"><para>location to store an integer indicating where
in the grapheme the user clicked. It will either
be zero, or the number of characters in the
grapheme. 0 represents the leading edge of the grapheme. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>out</acronym>]</emphasis></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="pango-layout-line-x-to-index.returns" role="returns">
<title>Returns</title>
<para> <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> if <parameter>x_pos</parameter>
was outside the line, <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if inside</para>
</refsect3></refsect2>
<refsect2 id="pango-layout-line-get-x-ranges" role="function">
<title>pango_layout_line_get_x_ranges&#160;()</title>
<indexterm zone="pango-layout-line-get-x-ranges"><primary>pango_layout_line_get_x_ranges</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
pango_layout_line_get_x_ranges (<parameter><link linkend="PangoLayoutLine"><type>PangoLayoutLine</type></link> *line</parameter>,
                                <parameter><link linkend="int"><type>int</type></link> start_index</parameter>,
                                <parameter><link linkend="int"><type>int</type></link> end_index</parameter>,
                                <parameter><link linkend="int"><type>int</type></link> **ranges</parameter>,
                                <parameter><link linkend="int"><type>int</type></link> *n_ranges</parameter>);</programlisting>
<para>Gets a list of visual ranges corresponding to a given logical range.
This list is not necessarily minimal - there may be consecutive
ranges which are adjacent. The ranges will be sorted from left to
right. The ranges are with respect to the left edge of the entire
layout, not with respect to the line.</para>
<refsect3 id="pango-layout-line-get-x-ranges.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>line</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayoutLine"><type>PangoLayoutLine</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>start_index</para></entry>
<entry role="parameter_description"><para>Start byte index of the logical range. If this value
is less than the start index for the line, then
the first range will extend all the way to the leading
edge of the layout. Otherwise it will start at the
leading edge of the first character.</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>end_index</para></entry>
<entry role="parameter_description"><para>Ending byte index of the logical range. If this value
is greater than the end index for the line, then
the last range will extend all the way to the trailing
edge of the layout. Otherwise, it will end at the
trailing edge of the last character.</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>ranges</para></entry>
<entry role="parameter_description"><para>location to store a pointer to an array of ranges.
The array will be of length <literal>2*n_ranges</literal>,
with each range starting at <literal>(*ranges)[2*n]</literal>
and of width <literal>(*ranges)[2*n + 1] - (*ranges)[2*n]</literal>.
This array must be freed with <link linkend="g-free"><function>g_free()</function></link>. The coordinates are relative
to the layout and are in Pango units. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>out</acronym>][<acronym>array</acronym> length=n_ranges][<acronym>transfer full</acronym>]</emphasis></entry></row>
<row><entry role="parameter_name"><para>n_ranges</para></entry>
<entry role="parameter_description"><para>The number of ranges stored in <parameter>ranges</parameter>
.</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="pango-layout-line-get-height" role="function" condition="since:1.44">
<title>pango_layout_line_get_height&#160;()</title>
<indexterm zone="pango-layout-line-get-height" role="1.44"><primary>pango_layout_line_get_height</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
pango_layout_line_get_height (<parameter><link linkend="PangoLayoutLine"><type>PangoLayoutLine</type></link> *line</parameter>,
                              <parameter><link linkend="int"><type>int</type></link> *height</parameter>);</programlisting>
<para>Computes the height of the line, ie the distance between
this and the previous lines baseline.</para>
<refsect3 id="pango-layout-line-get-height.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>line</para></entry>
<entry role="parameter_description"><para>a <link linkend="PangoLayoutLine"><type>PangoLayoutLine</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>height</para></entry>
<entry role="parameter_description"><para>return location for the line height. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>out</acronym>][<acronym>allow-none</acronym>]</emphasis></entry></row>
</tbody></tgroup></informaltable>
</refsect3><para role="since">Since: <link linkend="api-index-1.44">1.44</link></para></refsect2>

</refsect1>
<refsect1 id="pango-Layout-Objects.other_details" role="details">
<title role="details.title">Types and Values</title>
<refsect2 id="PangoLayout-struct" role="struct">
<title>PangoLayout</title>
<indexterm zone="PangoLayout-struct"><primary>PangoLayout</primary></indexterm>
<programlisting language="C">typedef struct _PangoLayout PangoLayout;</programlisting>
<para>The <link linkend="PangoLayout"><type>PangoLayout</type></link> structure represents an entire paragraph
of text. It is initialized with a <link linkend="PangoContext"><type>PangoContext</type></link>, UTF-8 string
and set of attributes for that string. Once that is done, the
set of formatted lines can be extracted from the object,
the layout can be rendered, and conversion between logical
character positions within the layout's text, and the physical
position of the resulting glyphs can be made.</para>
<para>There are also a number of parameters to adjust the formatting
of a <link linkend="PangoLayout"><type>PangoLayout</type></link>, which are illustrated in <xref linkend="parameters"/>.
It is possible, as well, to ignore the 2-D setup, and simply
treat the results of a <link linkend="PangoLayout"><type>PangoLayout</type></link> as a list of lines.</para>
<figure id="parameters">
<title>Adjustable parameters (on the left) and font metrics (on the right) for a PangoLayout</title>
<graphic fileref="layout.png" format="PNG"></graphic>
</figure>
<para>The <link linkend="PangoLayout"><type>PangoLayout</type></link> structure is opaque, and has no user-visible
fields.</para>
</refsect2>
<refsect2 id="PangoLayoutIter-struct" role="struct">
<title>PangoLayoutIter</title>
<indexterm zone="PangoLayoutIter-struct"><primary>PangoLayoutIter</primary></indexterm>
<programlisting language="C">typedef struct _PangoLayoutIter PangoLayoutIter;</programlisting>
<para>A <link linkend="PangoLayoutIter"><type>PangoLayoutIter</type></link> structure can be used to
iterate over the visual extents of a <link linkend="PangoLayout"><type>PangoLayout</type></link>.</para>
<para>The <link linkend="PangoLayoutIter"><type>PangoLayoutIter</type></link> structure is opaque, and
has no user-visible fields.</para>
</refsect2>
<refsect2 id="PangoWrapMode" role="enum">
<title>enum PangoWrapMode</title>
<indexterm zone="PangoWrapMode"><primary>PangoWrapMode</primary></indexterm>
<para>A <link linkend="PangoWrapMode"><type>PangoWrapMode</type></link> describes how to wrap the lines of a <link linkend="PangoLayout"><type>PangoLayout</type></link> to the desired width.</para>
<refsect3 id="PangoWrapMode.members" role="enum_members">
<title>Members</title>
<informaltable role="enum_members_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="enum_members_name" colwidth="300px"/>
<colspec colname="enum_members_description"/>
<colspec colname="enum_members_annotations" colwidth="200px"/>
<tbody>
<row role="constant"><entry role="enum_member_name"><para id="PANGO-WRAP-WORD:CAPS">PANGO_WRAP_WORD</para></entry>
<entry role="enum_member_description"><para>wrap lines at word boundaries.</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
<row role="constant"><entry role="enum_member_name"><para id="PANGO-WRAP-CHAR:CAPS">PANGO_WRAP_CHAR</para></entry>
<entry role="enum_member_description"><para>wrap lines at character boundaries.</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
<row role="constant"><entry role="enum_member_name"><para id="PANGO-WRAP-WORD-CHAR:CAPS">PANGO_WRAP_WORD_CHAR</para></entry>
<entry role="enum_member_description"><para>wrap lines at word boundaries, but fall back to character boundaries if there is not
enough space for a full word.</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="PangoEllipsizeMode" role="enum">
<title>enum PangoEllipsizeMode</title>
<indexterm zone="PangoEllipsizeMode"><primary>PangoEllipsizeMode</primary></indexterm>
<para>The <link linkend="PangoEllipsizeMode"><type>PangoEllipsizeMode</type></link> type describes what sort of (if any)
ellipsization should be applied to a line of text. In
the ellipsization process characters are removed from the
text in order to make it fit to a given width and replaced
with an ellipsis.</para>
<refsect3 id="PangoEllipsizeMode.members" role="enum_members">
<title>Members</title>
<informaltable role="enum_members_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="enum_members_name" colwidth="300px"/>
<colspec colname="enum_members_description"/>
<colspec colname="enum_members_annotations" colwidth="200px"/>
<tbody>
<row role="constant"><entry role="enum_member_name"><para id="PANGO-ELLIPSIZE-NONE:CAPS">PANGO_ELLIPSIZE_NONE</para></entry>
<entry role="enum_member_description"><para>No ellipsization</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
<row role="constant"><entry role="enum_member_name"><para id="PANGO-ELLIPSIZE-START:CAPS">PANGO_ELLIPSIZE_START</para></entry>
<entry role="enum_member_description"><para>Omit characters at the start of the text</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
<row role="constant"><entry role="enum_member_name"><para id="PANGO-ELLIPSIZE-MIDDLE:CAPS">PANGO_ELLIPSIZE_MIDDLE</para></entry>
<entry role="enum_member_description"><para>Omit characters in the middle of the text</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
<row role="constant"><entry role="enum_member_name"><para id="PANGO-ELLIPSIZE-END:CAPS">PANGO_ELLIPSIZE_END</para></entry>
<entry role="enum_member_description"><para>Omit characters at the end of the text</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="PangoAlignment" role="enum">
<title>enum PangoAlignment</title>
<indexterm zone="PangoAlignment"><primary>PangoAlignment</primary></indexterm>
<para>A <link linkend="PangoAlignment"><type>PangoAlignment</type></link> describes how to align the lines of a <link linkend="PangoLayout"><type>PangoLayout</type></link> within the
available space. If the <link linkend="PangoLayout"><type>PangoLayout</type></link> is set to justify
using <link linkend="pango-layout-set-justify"><function>pango_layout_set_justify()</function></link>, this only has effect for partial lines.</para>
<refsect3 id="PangoAlignment.members" role="enum_members">
<title>Members</title>
<informaltable role="enum_members_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="enum_members_name" colwidth="300px"/>
<colspec colname="enum_members_description"/>
<colspec colname="enum_members_annotations" colwidth="200px"/>
<tbody>
<row role="constant"><entry role="enum_member_name"><para id="PANGO-ALIGN-LEFT:CAPS">PANGO_ALIGN_LEFT</para></entry>
<entry role="enum_member_description"><para>Put all available space on the right</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
<row role="constant"><entry role="enum_member_name"><para id="PANGO-ALIGN-CENTER:CAPS">PANGO_ALIGN_CENTER</para></entry>
<entry role="enum_member_description"><para>Center the line within the available space</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
<row role="constant"><entry role="enum_member_name"><para id="PANGO-ALIGN-RIGHT:CAPS">PANGO_ALIGN_RIGHT</para></entry>
<entry role="enum_member_description"><para>Put all available space on the left</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="PangoLayoutLine-struct" role="struct">
<title>struct PangoLayoutLine</title>
<indexterm zone="PangoLayoutLine-struct"><primary>PangoLayoutLine</primary></indexterm>
<programlisting language="C">struct PangoLayoutLine {
  PangoLayout *layout;
  gint         start_index;     /* start of line as byte index into layout-&gt;text */
  gint         length;		/* length of line in bytes */
  GSList      *runs;
  guint        is_paragraph_start : 1;  /* TRUE if this is the first line of the paragraph */
  guint        resolved_dir : 3;  /* Resolved PangoDirection of line */
};
</programlisting>
<para>The <link linkend="PangoLayoutLine"><type>PangoLayoutLine</type></link> structure represents one of the lines resulting
from laying out a paragraph via <link linkend="PangoLayout"><type>PangoLayout</type></link>. <link linkend="PangoLayoutLine"><type>PangoLayoutLine</type></link>
structures are obtained by calling <link linkend="pango-layout-get-line"><function>pango_layout_get_line()</function></link> and
are only valid until the text, attributes, or settings of the
parent <link linkend="PangoLayout"><type>PangoLayout</type></link> are modified.</para>
<para>Routines for rendering PangoLayout objects are provided in
code specific to each rendering system.</para>
<refsect3 id="PangoLayoutLine.members" role="struct_members">
<title>Members</title>
<informaltable role="struct_members_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="struct_members_name" colwidth="300px"/>
<colspec colname="struct_members_description"/>
<colspec colname="struct_members_annotations" colwidth="200px"/>
<tbody>
<row role="member"><entry role="struct_member_name"><para><link linkend="PangoLayout"><type>PangoLayout</type></link>&#160;*<structfield id="PangoLayoutLine-struct.layout">layout</structfield>;</para></entry>
<entry role="struct_member_description"><para>the layout this line belongs to, might be <link linkend="NULL:CAPS"><literal>NULL</literal></link>. </para></entry>
<entry role="struct_member_annotations"><emphasis role="annotation">[<acronym>allow-none</acronym>]</emphasis></entry>
</row>
<row role="member"><entry role="struct_member_name"><para><link linkend="gint"><type>gint</type></link>&#160;<structfield id="PangoLayoutLine-struct.start-index">start_index</structfield>;</para></entry>
<entry role="struct_member_description"><para>start of line as byte index into layout->text</para></entry>
<entry role="struct_member_annotations"></entry>
</row>
<row role="member"><entry role="struct_member_name"><para><link linkend="gint"><type>gint</type></link>&#160;<structfield id="PangoLayoutLine-struct.length">length</structfield>;</para></entry>
<entry role="struct_member_description"><para>length of line in bytes</para></entry>
<entry role="struct_member_annotations"></entry>
</row>
<row role="member"><entry role="struct_member_name"><para><link linkend="GSList"><type>GSList</type></link>&#160;*<structfield id="PangoLayoutLine-struct.runs">runs</structfield>;</para></entry>
<entry role="struct_member_description"><para>list of runs in the
line, from left to right. </para></entry>
<entry role="struct_member_annotations"><emphasis role="annotation">[<acronym>allow-none</acronym>][<acronym>element-type</acronym> Pango.LayoutRun]</emphasis></entry>
</row>
<row role="member"><entry role="struct_member_name"><para><link linkend="guint"><type>guint</type></link>&#160;<structfield id="PangoLayoutLine-struct.is-paragraph-start">is_paragraph_start</structfield>&#160;:&#160;1;</para></entry>
<entry role="struct_member_description"><para><link linkend="TRUE:CAPS"><type>TRUE</type></link> if this is the first line of the paragraph</para></entry>
<entry role="struct_member_annotations"></entry>
</row>
<row role="member"><entry role="struct_member_name"><para><link linkend="guint"><type>guint</type></link>&#160;<structfield id="PangoLayoutLine-struct.resolved-dir">resolved_dir</structfield>&#160;:&#160;3;</para></entry>
<entry role="struct_member_description"><para><link linkend="Resolved"><type>Resolved</type></link> PangoDirection of line</para></entry>
<entry role="struct_member_annotations"></entry>
</row>
</tbody></tgroup></informaltable>
</refsect3>
</refsect2>
<refsect2 id="PangoLayoutRun" role="typedef">
<title>PangoLayoutRun</title>
<indexterm zone="PangoLayoutRun"><primary>PangoLayoutRun</primary></indexterm>
<programlisting language="C">typedef PangoGlyphItem PangoLayoutRun;
</programlisting>
<para>The <link linkend="PangoLayoutRun"><type>PangoLayoutRun</type></link> structure represents a single run within
a <link linkend="PangoLayoutLine"><type>PangoLayoutLine</type></link>; it is simply an alternate name for
<link linkend="PangoGlyphItem"><type>PangoGlyphItem</type></link>.
See the <link linkend="PangoGlyphItem"><type>PangoGlyphItem</type></link> docs for details on the fields.</para>
</refsect2>

</refsect1>

</refentry>
