layout.xml

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

<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>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>

<refsynopsisdiv id="pango-Layout-Objects.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<anchor id="PangoLayout"/>
<synopsis>
                    <link linkend="PangoLayout-struct">PangoLayout</link>;
                    <link linkend="PangoLayoutIter">PangoLayoutIter</link>;
<link linkend="PangoLayout">PangoLayout</link>*        <link linkend="pango-layout-new">pango_layout_new</link>                    (<link linkend="PangoContext">PangoContext</link> *context);
<link linkend="PangoLayout">PangoLayout</link>*        <link linkend="pango-layout-copy">pango_layout_copy</link>                   (<link linkend="PangoLayout">PangoLayout</link> *src);
<link linkend="PangoContext">PangoContext</link>*       <link linkend="pango-layout-get-context">pango_layout_get_context</link>            (<link linkend="PangoLayout">PangoLayout</link> *layout);
<link linkend="void">void</link>                <link linkend="pango-layout-context-changed">pango_layout_context_changed</link>        (<link linkend="PangoLayout">PangoLayout</link> *layout);
<link linkend="void">void</link>                <link linkend="pango-layout-set-text">pango_layout_set_text</link>               (<link linkend="PangoLayout">PangoLayout</link> *layout,
                                                         const <link linkend="char">char</link> *text,
                                                         <link linkend="int">int</link> length);
const <link linkend="char">char</link>*         <link linkend="pango-layout-get-text">pango_layout_get_text</link>               (<link linkend="PangoLayout">PangoLayout</link> *layout);
<link linkend="void">void</link>                <link linkend="pango-layout-set-markup">pango_layout_set_markup</link>             (<link linkend="PangoLayout">PangoLayout</link> *layout,
                                                         const <link linkend="char">char</link> *markup,
                                                         <link linkend="int">int</link> length);
<link linkend="void">void</link>                <link linkend="pango-layout-set-markup-with-accel">pango_layout_set_markup_with_accel</link>  (<link linkend="PangoLayout">PangoLayout</link> *layout,
                                                         const <link linkend="char">char</link> *markup,
                                                         <link linkend="int">int</link> length,
                                                         <link linkend="gunichar">gunichar</link> accel_marker,
                                                         <link linkend="gunichar">gunichar</link> *accel_char);
<link linkend="void">void</link>                <link linkend="pango-layout-set-attributes">pango_layout_set_attributes</link>         (<link linkend="PangoLayout">PangoLayout</link> *layout,
                                                         <link linkend="PangoAttrList">PangoAttrList</link> *attrs);
<link linkend="PangoAttrList">PangoAttrList</link>*      <link linkend="pango-layout-get-attributes">pango_layout_get_attributes</link>         (<link linkend="PangoLayout">PangoLayout</link> *layout);
<link linkend="void">void</link>                <link linkend="pango-layout-set-font-description">pango_layout_set_font_description</link>   (<link linkend="PangoLayout">PangoLayout</link> *layout,
                                                         const <link linkend="PangoFontDescription">PangoFontDescription</link> *desc);
const <link linkend="PangoFontDescription">PangoFontDescription</link>* <link linkend="pango-layout-get-font-description">pango_layout_get_font_description</link>
                                                        (<link linkend="PangoLayout">PangoLayout</link> *layout);
<link linkend="void">void</link>                <link linkend="pango-layout-set-width">pango_layout_set_width</link>              (<link linkend="PangoLayout">PangoLayout</link> *layout,
                                                         <link linkend="int">int</link> width);
<link linkend="int">int</link>                 <link linkend="pango-layout-get-width">pango_layout_get_width</link>              (<link linkend="PangoLayout">PangoLayout</link> *layout);
<link linkend="void">void</link>                <link linkend="pango-layout-set-height">pango_layout_set_height</link>             (<link linkend="PangoLayout">PangoLayout</link> *layout,
                                                         <link linkend="int">int</link> height);
<link linkend="int">int</link>                 <link linkend="pango-layout-get-height">pango_layout_get_height</link>             (<link linkend="PangoLayout">PangoLayout</link> *layout);
<link linkend="void">void</link>                <link linkend="pango-layout-set-wrap">pango_layout_set_wrap</link>               (<link linkend="PangoLayout">PangoLayout</link> *layout,
                                                         <link linkend="PangoWrapMode">PangoWrapMode</link> wrap);
<link linkend="PangoWrapMode">PangoWrapMode</link>       <link linkend="pango-layout-get-wrap">pango_layout_get_wrap</link>               (<link linkend="PangoLayout">PangoLayout</link> *layout);
<link linkend="gboolean">gboolean</link>            <link linkend="pango-layout-is-wrapped">pango_layout_is_wrapped</link>             (<link linkend="PangoLayout">PangoLayout</link> *layout);
enum                <link linkend="PangoWrapMode">PangoWrapMode</link>;
#define             <link linkend="PANGO-TYPE-WRAP-MODE:CAPS">PANGO_TYPE_WRAP_MODE</link>
<link linkend="void">void</link>                <link linkend="pango-layout-set-ellipsize">pango_layout_set_ellipsize</link>          (<link linkend="PangoLayout">PangoLayout</link> *layout,
                                                         <link linkend="PangoEllipsizeMode">PangoEllipsizeMode</link> ellipsize);
<link linkend="PangoEllipsizeMode">PangoEllipsizeMode</link>  <link linkend="pango-layout-get-ellipsize">pango_layout_get_ellipsize</link>          (<link linkend="PangoLayout">PangoLayout</link> *layout);
<link linkend="gboolean">gboolean</link>            <link linkend="pango-layout-is-ellipsized">pango_layout_is_ellipsized</link>          (<link linkend="PangoLayout">PangoLayout</link> *layout);
enum                <link linkend="PangoEllipsizeMode">PangoEllipsizeMode</link>;
#define             <link linkend="PANGO-TYPE-ELLIPSIZE-MODE:CAPS">PANGO_TYPE_ELLIPSIZE_MODE</link>
<link linkend="void">void</link>                <link linkend="pango-layout-set-indent">pango_layout_set_indent</link>             (<link linkend="PangoLayout">PangoLayout</link> *layout,
                                                         <link linkend="int">int</link> indent);
<link linkend="int">int</link>                 <link linkend="pango-layout-get-indent">pango_layout_get_indent</link>             (<link linkend="PangoLayout">PangoLayout</link> *layout);
<link linkend="int">int</link>                 <link linkend="pango-layout-get-spacing">pango_layout_get_spacing</link>            (<link linkend="PangoLayout">PangoLayout</link> *layout);
<link linkend="void">void</link>                <link linkend="pango-layout-set-spacing">pango_layout_set_spacing</link>            (<link linkend="PangoLayout">PangoLayout</link> *layout,
                                                         <link linkend="int">int</link> spacing);
<link linkend="void">void</link>                <link linkend="pango-layout-set-justify">pango_layout_set_justify</link>            (<link linkend="PangoLayout">PangoLayout</link> *layout,
                                                         <link linkend="gboolean">gboolean</link> justify);
<link linkend="gboolean">gboolean</link>            <link linkend="pango-layout-get-justify">pango_layout_get_justify</link>            (<link linkend="PangoLayout">PangoLayout</link> *layout);
<link linkend="void">void</link>                <link linkend="pango-layout-set-auto-dir">pango_layout_set_auto_dir</link>           (<link linkend="PangoLayout">PangoLayout</link> *layout,
                                                         <link linkend="gboolean">gboolean</link> auto_dir);
<link linkend="gboolean">gboolean</link>            <link linkend="pango-layout-get-auto-dir">pango_layout_get_auto_dir</link>           (<link linkend="PangoLayout">PangoLayout</link> *layout);
<link linkend="void">void</link>                <link linkend="pango-layout-set-alignment">pango_layout_set_alignment</link>          (<link linkend="PangoLayout">PangoLayout</link> *layout,
                                                         <link linkend="PangoAlignment">PangoAlignment</link> alignment);
<link linkend="PangoAlignment">PangoAlignment</link>      <link linkend="pango-layout-get-alignment">pango_layout_get_alignment</link>          (<link linkend="PangoLayout">PangoLayout</link> *layout);
<link linkend="void">void</link>                <link linkend="pango-layout-set-tabs">pango_layout_set_tabs</link>               (<link linkend="PangoLayout">PangoLayout</link> *layout,
                                                         <link linkend="PangoTabArray">PangoTabArray</link> *tabs);
<link linkend="PangoTabArray">PangoTabArray</link>*      <link linkend="pango-layout-get-tabs">pango_layout_get_tabs</link>               (<link linkend="PangoLayout">PangoLayout</link> *layout);
<link linkend="void">void</link>                <link linkend="pango-layout-set-single-paragraph-mode">pango_layout_set_single_paragraph_mode</link>
                                                        (<link linkend="PangoLayout">PangoLayout</link> *layout,
                                                         <link linkend="gboolean">gboolean</link> setting);
<link linkend="gboolean">gboolean</link>            <link linkend="pango-layout-get-single-paragraph-mode">pango_layout_get_single_paragraph_mode</link>
                                                        (<link linkend="PangoLayout">PangoLayout</link> *layout);
enum                <link linkend="PangoAlignment">PangoAlignment</link>;
#define             <link linkend="PANGO-TYPE-ALIGNMENT:CAPS">PANGO_TYPE_ALIGNMENT</link>
<link linkend="int">int</link>                 <link linkend="pango-layout-get-unknown-glyphs-count">pango_layout_get_unknown_glyphs_count</link>
                                                        (<link linkend="PangoLayout">PangoLayout</link> *layout);
<link linkend="void">void</link>                <link linkend="pango-layout-get-log-attrs">pango_layout_get_log_attrs</link>          (<link linkend="PangoLayout">PangoLayout</link> *layout,
                                                         <link linkend="PangoLogAttr">PangoLogAttr</link> **attrs,
                                                         <link linkend="gint">gint</link> *n_attrs);
<link linkend="void">void</link>                <link linkend="pango-layout-index-to-pos">pango_layout_index_to_pos</link>           (<link linkend="PangoLayout">PangoLayout</link> *layout,
                                                         <link linkend="int">int</link> index_,
                                                         <link linkend="PangoRectangle">PangoRectangle</link> *pos);
<link linkend="void">void</link>                <link linkend="pango-layout-index-to-line-x">pango_layout_index_to_line_x</link>        (<link linkend="PangoLayout">PangoLayout</link> *layout,
                                                         <link linkend="int">int</link> index_,
                                                         <link linkend="gboolean">gboolean</link> trailing,
                                                         <link linkend="int">int</link> *line,
                                                         <link linkend="int">int</link> *x_pos);
<link linkend="gboolean">gboolean</link>            <link linkend="pango-layout-xy-to-index">pango_layout_xy_to_index</link>            (<link linkend="PangoLayout">PangoLayout</link> *layout,
                                                         <link linkend="int">int</link> x,
                                                         <link linkend="int">int</link> y,
                                                         <link linkend="int">int</link> *index_,
                                                         <link linkend="int">int</link> *trailing);
<link linkend="void">void</link>                <link linkend="pango-layout-get-cursor-pos">pango_layout_get_cursor_pos</link>         (<link linkend="PangoLayout">PangoLayout</link> *layout,
                                                         <link linkend="int">int</link> index_,
                                                         <link linkend="PangoRectangle">PangoRectangle</link> *strong_pos,
                                                         <link linkend="PangoRectangle">PangoRectangle</link> *weak_pos);
<link linkend="void">void</link>                <link linkend="pango-layout-move-cursor-visually">pango_layout_move_cursor_visually</link>   (<link linkend="PangoLayout">PangoLayout</link> *layout,
                                                         <link linkend="gboolean">gboolean</link> strong,
                                                         <link linkend="int">int</link> old_index,
                                                         <link linkend="int">int</link> old_trailing,
                                                         <link linkend="int">int</link> direction,
                                                         <link linkend="int">int</link> *new_index,
                                                         <link linkend="int">int</link> *new_trailing);
<link linkend="void">void</link>                <link linkend="pango-layout-get-extents">pango_layout_get_extents</link>            (<link linkend="PangoLayout">PangoLayout</link> *layout,
                                                         <link linkend="PangoRectangle">PangoRectangle</link> *ink_rect,
                                                         <link linkend="PangoRectangle">PangoRectangle</link> *logical_rect);
<link linkend="void">void</link>                <link linkend="pango-layout-get-pixel-extents">pango_layout_get_pixel_extents</link>      (<link linkend="PangoLayout">PangoLayout</link> *layout,
                                                         <link linkend="PangoRectangle">PangoRectangle</link> *ink_rect,
                                                         <link linkend="PangoRectangle">PangoRectangle</link> *logical_rect);
<link linkend="void">void</link>                <link linkend="pango-layout-get-size">pango_layout_get_size</link>               (<link linkend="PangoLayout">PangoLayout</link> *layout,
                                                         <link linkend="int">int</link> *width,
                                                         <link linkend="int">int</link> *height);
<link linkend="void">void</link>                <link linkend="pango-layout-get-pixel-size">pango_layout_get_pixel_size</link>         (<link linkend="PangoLayout">PangoLayout</link> *layout,
                                                         <link linkend="int">int</link> *width,
                                                         <link linkend="int">int</link> *height);
<link linkend="int">int</link>                 <link linkend="pango-layout-get-line-count">pango_layout_get_line_count</link>         (<link linkend="PangoLayout">PangoLayout</link> *layout);
<link linkend="PangoLayoutLine">PangoLayoutLine</link>*    <link linkend="pango-layout-get-line">pango_layout_get_line</link>               (<link linkend="PangoLayout">PangoLayout</link> *layout,
                                                         <link linkend="int">int</link> line);
<link linkend="PangoLayoutLine">PangoLayoutLine</link>*    <link linkend="pango-layout-get-line-readonly">pango_layout_get_line_readonly</link>      (<link linkend="PangoLayout">PangoLayout</link> *layout,
                                                         <link linkend="int">int</link> line);
<link linkend="GSList">GSList</link>*             <link linkend="pango-layout-get-lines">pango_layout_get_lines</link>              (<link linkend="PangoLayout">PangoLayout</link> *layout);
<link linkend="GSList">GSList</link>*             <link linkend="pango-layout-get-lines-readonly">pango_layout_get_lines_readonly</link>     (<link linkend="PangoLayout">PangoLayout</link> *layout);
<link linkend="PangoLayoutIter">PangoLayoutIter</link>*    <link linkend="pango-layout-get-iter">pango_layout_get_iter</link>               (<link linkend="PangoLayout">PangoLayout</link> *layout);
<link linkend="PangoLayoutIter">PangoLayoutIter</link>*    <link linkend="pango-layout-iter-copy">pango_layout_iter_copy</link>              (<link linkend="PangoLayoutIter">PangoLayoutIter</link> *iter);
<link linkend="void">void</link>                <link linkend="pango-layout-iter-free">pango_layout_iter_free</link>              (<link linkend="PangoLayoutIter">PangoLayoutIter</link> *iter);
<link linkend="gboolean">gboolean</link>            <link linkend="pango-layout-iter-next-run">pango_layout_iter_next_run</link>          (<link linkend="PangoLayoutIter">PangoLayoutIter</link> *iter);
<link linkend="gboolean">gboolean</link>            <link linkend="pango-layout-iter-next-char">pango_layout_iter_next_char</link>         (<link linkend="PangoLayoutIter">PangoLayoutIter</link> *iter);
<link linkend="gboolean">gboolean</link>            <link linkend="pango-layout-iter-next-cluster">pango_layout_iter_next_cluster</link>      (<link linkend="PangoLayoutIter">PangoLayoutIter</link> *iter);
<link linkend="gboolean">gboolean</link>            <link linkend="pango-layout-iter-next-line">pango_layout_iter_next_line</link>         (<link linkend="PangoLayoutIter">PangoLayoutIter</link> *iter);
<link linkend="gboolean">gboolean</link>            <link linkend="pango-layout-iter-at-last-line">pango_layout_iter_at_last_line</link>      (<link linkend="PangoLayoutIter">PangoLayoutIter</link> *iter);
<link linkend="int">int</link>                 <link linkend="pango-layout-iter-get-index">pango_layout_iter_get_index</link>         (<link linkend="PangoLayoutIter">PangoLayoutIter</link> *iter);
<link linkend="int">int</link>                 <link linkend="pango-layout-iter-get-baseline">pango_layout_iter_get_baseline</link>      (<link linkend="PangoLayoutIter">PangoLayoutIter</link> *iter);
<link linkend="PangoLayoutRun">PangoLayoutRun</link>*     <link linkend="pango-layout-iter-get-run">pango_layout_iter_get_run</link>           (<link linkend="PangoLayoutIter">PangoLayoutIter</link> *iter);
<link linkend="PangoLayoutRun">PangoLayoutRun</link>*     <link linkend="pango-layout-iter-get-run-readonly">pango_layout_iter_get_run_readonly</link>  (<link linkend="PangoLayoutIter">PangoLayoutIter</link> *iter);
<link linkend="PangoLayoutLine">PangoLayoutLine</link>*    <link linkend="pango-layout-iter-get-line">pango_layout_iter_get_line</link>          (<link linkend="PangoLayoutIter">PangoLayoutIter</link> *iter);
<link linkend="PangoLayoutLine">PangoLayoutLine</link>*    <link linkend="pango-layout-iter-get-line-readonly">pango_layout_iter_get_line_readonly</link> (<link linkend="PangoLayoutIter">PangoLayoutIter</link> *iter);
<link linkend="PangoLayout">PangoLayout</link>*        <link linkend="pango-layout-iter-get-layout">pango_layout_iter_get_layout</link>        (<link linkend="PangoLayoutIter">PangoLayoutIter</link> *iter);
<link linkend="void">void</link>                <link linkend="pango-layout-iter-get-char-extents">pango_layout_iter_get_char_extents</link>  (<link linkend="PangoLayoutIter">PangoLayoutIter</link> *iter,
                                                         <link linkend="PangoRectangle">PangoRectangle</link> *logical_rect);
<link linkend="void">void</link>                <link linkend="pango-layout-iter-get-cluster-extents">pango_layout_iter_get_cluster_extents</link>
                                                        (<link linkend="PangoLayoutIter">PangoLayoutIter</link> *iter,
                                                         <link linkend="PangoRectangle">PangoRectangle</link> *ink_rect,
                                                         <link linkend="PangoRectangle">PangoRectangle</link> *logical_rect);
<link linkend="void">void</link>                <link linkend="pango-layout-iter-get-run-extents">pango_layout_iter_get_run_extents</link>   (<link linkend="PangoLayoutIter">PangoLayoutIter</link> *iter,
                                                         <link linkend="PangoRectangle">PangoRectangle</link> *ink_rect,
                                                         <link linkend="PangoRectangle">PangoRectangle</link> *logical_rect);
<link linkend="void">void</link>                <link linkend="pango-layout-iter-get-line-yrange">pango_layout_iter_get_line_yrange</link>   (<link linkend="PangoLayoutIter">PangoLayoutIter</link> *iter,
                                                         <link linkend="int">int</link> *y0_,
                                                         <link linkend="int">int</link> *y1_);
<link linkend="void">void</link>                <link linkend="pango-layout-iter-get-line-extents">pango_layout_iter_get_line_extents</link>  (<link linkend="PangoLayoutIter">PangoLayoutIter</link> *iter,
                                                         <link linkend="PangoRectangle">PangoRectangle</link> *ink_rect,
                                                         <link linkend="PangoRectangle">PangoRectangle</link> *logical_rect);
<link linkend="void">void</link>                <link linkend="pango-layout-iter-get-layout-extents">pango_layout_iter_get_layout_extents</link>
                                                        (<link linkend="PangoLayoutIter">PangoLayoutIter</link> *iter,
                                                         <link linkend="PangoRectangle">PangoRectangle</link> *ink_rect,
                                                         <link linkend="PangoRectangle">PangoRectangle</link> *logical_rect);

                    <link linkend="PangoLayoutLine">PangoLayoutLine</link>;
typedef             <link linkend="PangoLayoutRun">PangoLayoutRun</link>;
<link linkend="PangoLayoutLine">PangoLayoutLine</link>*    <link linkend="pango-layout-line-ref">pango_layout_line_ref</link>               (<link linkend="PangoLayoutLine">PangoLayoutLine</link> *line);
<link linkend="void">void</link>                <link linkend="pango-layout-line-unref">pango_layout_line_unref</link>             (<link linkend="PangoLayoutLine">PangoLayoutLine</link> *line);
<link linkend="void">void</link>                <link linkend="pango-layout-line-get-extents">pango_layout_line_get_extents</link>       (<link linkend="PangoLayoutLine">PangoLayoutLine</link> *line,
                                                         <link linkend="PangoRectangle">PangoRectangle</link> *ink_rect,
                                                         <link linkend="PangoRectangle">PangoRectangle</link> *logical_rect);
<link linkend="void">void</link>                <link linkend="pango-layout-line-get-pixel-extents">pango_layout_line_get_pixel_extents</link> (<link linkend="PangoLayoutLine">PangoLayoutLine</link> *layout_line,