main.xml

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

<refentry id="pango-Text-Processing">
<refmeta>
<refentrytitle role="top_of_page" id="pango-Text-Processing.top_of_page">Rendering</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>PANGO Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>Rendering</refname>
<refpurpose>Functions to run the rendering pipeline</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>

<refsynopsisdiv id="pango-Text-Processing.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<anchor id="PangoContext"/>
<synopsis>
                    <link linkend="PangoContext-struct">PangoContext</link>;
                    <link linkend="PangoItem">PangoItem</link>;
                    <link linkend="PangoAnalysis">PangoAnalysis</link>;
#define             <link linkend="PANGO-ANALYSIS-FLAG-CENTERED-BASELINE:CAPS">PANGO_ANALYSIS_FLAG_CENTERED_BASELINE</link>
enum                <link linkend="PangoDirection">PangoDirection</link>;
#define             <link linkend="PANGO-TYPE-DIRECTION:CAPS">PANGO_TYPE_DIRECTION</link>

<link linkend="GList">GList</link>*              <link linkend="pango-itemize">pango_itemize</link>                       (<link linkend="PangoContext">PangoContext</link> *context,
                                                         const <link linkend="char">char</link> *text,
                                                         <link linkend="int">int</link> start_index,
                                                         <link linkend="int">int</link> length,
                                                         <link linkend="PangoAttrList">PangoAttrList</link> *attrs,
                                                         <link linkend="PangoAttrIterator">PangoAttrIterator</link> *cached_iter);
<link linkend="GList">GList</link>*              <link linkend="pango-itemize-with-base-dir">pango_itemize_with_base_dir</link>         (<link linkend="PangoContext">PangoContext</link> *context,
                                                         <link linkend="PangoDirection">PangoDirection</link> base_dir,
                                                         const <link linkend="char">char</link> *text,
                                                         <link linkend="int">int</link> start_index,
                                                         <link linkend="int">int</link> length,
                                                         <link linkend="PangoAttrList">PangoAttrList</link> *attrs,
                                                         <link linkend="PangoAttrIterator">PangoAttrIterator</link> *cached_iter);
<link linkend="void">void</link>                <link linkend="pango-item-free">pango_item_free</link>                     (<link linkend="PangoItem">PangoItem</link> *item);
<link linkend="PangoItem">PangoItem</link>*          <link linkend="pango-item-copy">pango_item_copy</link>                     (<link linkend="PangoItem">PangoItem</link> *item);
<link linkend="PangoItem">PangoItem</link>*          <link linkend="pango-item-new">pango_item_new</link>                      (void);
<link linkend="PangoItem">PangoItem</link>*          <link linkend="pango-item-split">pango_item_split</link>                    (<link linkend="PangoItem">PangoItem</link> *orig,
                                                         <link linkend="int">int</link> split_index,
                                                         <link linkend="int">int</link> split_offset);
<link linkend="GList">GList</link>*              <link linkend="pango-reorder-items">pango_reorder_items</link>                 (<link linkend="GList">GList</link> *logical_items);

<link linkend="PangoContext">PangoContext</link>*       <link linkend="pango-context-new">pango_context_new</link>                   (void);
<link linkend="void">void</link>                <link linkend="pango-context-set-font-map">pango_context_set_font_map</link>          (<link linkend="PangoContext">PangoContext</link> *context,
                                                         <link linkend="PangoFontMap">PangoFontMap</link> *font_map);
<link linkend="PangoFontMap">PangoFontMap</link>*       <link linkend="pango-context-get-font-map">pango_context_get_font_map</link>          (<link linkend="PangoContext">PangoContext</link> *context);
<link linkend="PangoFontDescription">PangoFontDescription</link>* <link linkend="pango-context-get-font-description">pango_context_get_font_description</link>
                                                        (<link linkend="PangoContext">PangoContext</link> *context);
<link linkend="void">void</link>                <link linkend="pango-context-set-font-description">pango_context_set_font_description</link>  (<link linkend="PangoContext">PangoContext</link> *context,
                                                         const <link linkend="PangoFontDescription">PangoFontDescription</link> *desc);
<link linkend="PangoLanguage">PangoLanguage</link>*      <link linkend="pango-context-get-language">pango_context_get_language</link>          (<link linkend="PangoContext">PangoContext</link> *context);
<link linkend="void">void</link>                <link linkend="pango-context-set-language">pango_context_set_language</link>          (<link linkend="PangoContext">PangoContext</link> *context,
                                                         <link linkend="PangoLanguage">PangoLanguage</link> *language);
<link linkend="PangoDirection">PangoDirection</link>      <link linkend="pango-context-get-base-dir">pango_context_get_base_dir</link>          (<link linkend="PangoContext">PangoContext</link> *context);
<link linkend="void">void</link>                <link linkend="pango-context-set-base-dir">pango_context_set_base_dir</link>          (<link linkend="PangoContext">PangoContext</link> *context,
                                                         <link linkend="PangoDirection">PangoDirection</link> direction);
<link linkend="PangoGravity">PangoGravity</link>        <link linkend="pango-context-get-base-gravity">pango_context_get_base_gravity</link>      (<link linkend="PangoContext">PangoContext</link> *context);
<link linkend="void">void</link>                <link linkend="pango-context-set-base-gravity">pango_context_set_base_gravity</link>      (<link linkend="PangoContext">PangoContext</link> *context,
                                                         <link linkend="PangoGravity">PangoGravity</link> gravity);
<link linkend="PangoGravity">PangoGravity</link>        <link linkend="pango-context-get-gravity">pango_context_get_gravity</link>           (<link linkend="PangoContext">PangoContext</link> *context);
<link linkend="PangoGravityHint">PangoGravityHint</link>    <link linkend="pango-context-get-gravity-hint">pango_context_get_gravity_hint</link>      (<link linkend="PangoContext">PangoContext</link> *context);
<link linkend="void">void</link>                <link linkend="pango-context-set-gravity-hint">pango_context_set_gravity_hint</link>      (<link linkend="PangoContext">PangoContext</link> *context,
                                                         <link linkend="PangoGravityHint">PangoGravityHint</link> hint);
const <link linkend="PangoMatrix">PangoMatrix</link>*  <link linkend="pango-context-get-matrix">pango_context_get_matrix</link>            (<link linkend="PangoContext">PangoContext</link> *context);
<link linkend="void">void</link>                <link linkend="pango-context-set-matrix">pango_context_set_matrix</link>            (<link linkend="PangoContext">PangoContext</link> *context,
                                                         const <link linkend="PangoMatrix">PangoMatrix</link> *matrix);
<link linkend="PangoFont">PangoFont</link>*          <link linkend="pango-context-load-font">pango_context_load_font</link>             (<link linkend="PangoContext">PangoContext</link> *context,
                                                         const <link linkend="PangoFontDescription">PangoFontDescription</link> *desc);
<link linkend="PangoFontset">PangoFontset</link>*       <link linkend="pango-context-load-fontset">pango_context_load_fontset</link>          (<link linkend="PangoContext">PangoContext</link> *context,
                                                         const <link linkend="PangoFontDescription">PangoFontDescription</link> *desc,
                                                         <link linkend="PangoLanguage">PangoLanguage</link> *language);
<link linkend="PangoFontMetrics">PangoFontMetrics</link>*   <link linkend="pango-context-get-metrics">pango_context_get_metrics</link>           (<link linkend="PangoContext">PangoContext</link> *context,
                                                         const <link linkend="PangoFontDescription">PangoFontDescription</link> *desc,
                                                         <link linkend="PangoLanguage">PangoLanguage</link> *language);
<link linkend="void">void</link>                <link linkend="pango-context-list-families">pango_context_list_families</link>         (<link linkend="PangoContext">PangoContext</link> *context,
                                                         <link linkend="PangoFontFamily">PangoFontFamily</link> ***families,
                                                         <link linkend="int">int</link> *n_families);

<link linkend="gboolean">gboolean</link>            <link linkend="pango-get-mirror-char">pango_get_mirror_char</link>               (<link linkend="gunichar">gunichar</link> ch,
                                                         <link linkend="gunichar">gunichar</link> *mirrored_ch);
<link linkend="PangoDirection">PangoDirection</link>      <link linkend="pango-unichar-direction">pango_unichar_direction</link>             (<link linkend="gunichar">gunichar</link> ch);
<link linkend="PangoDirection">PangoDirection</link>      <link linkend="pango-find-base-dir">pango_find_base_dir</link>                 (const <link linkend="gchar">gchar</link> *text,
                                                         <link linkend="gint">gint</link> length);


<link linkend="void">void</link>                <link linkend="pango-break">pango_break</link>                         (const <link linkend="gchar">gchar</link> *text,
                                                         <link linkend="int">int</link> length,
                                                         <link linkend="PangoAnalysis">PangoAnalysis</link> *analysis,
                                                         <link linkend="PangoLogAttr">PangoLogAttr</link> *attrs,
                                                         <link linkend="int">int</link> attrs_len);
<link linkend="void">void</link>                <link linkend="pango-get-log-attrs">pango_get_log_attrs</link>                 (const <link linkend="char">char</link> *text,
                                                         <link linkend="int">int</link> length,
                                                         <link linkend="int">int</link> level,
                                                         <link linkend="PangoLanguage">PangoLanguage</link> *language,
                                                         <link linkend="PangoLogAttr">PangoLogAttr</link> *log_attrs,
                                                         <link linkend="int">int</link> attrs_len);
<link linkend="void">void</link>                <link linkend="pango-find-paragraph-boundary">pango_find_paragraph_boundary</link>       (const <link linkend="gchar">gchar</link> *text,
                                                         <link linkend="gint">gint</link> length,
                                                         <link linkend="gint">gint</link> *paragraph_delimiter_index,
                                                         <link linkend="gint">gint</link> *next_paragraph_start);
<link linkend="void">void</link>                <link linkend="pango-default-break">pango_default_break</link>                 (const <link linkend="gchar">gchar</link> *text,
                                                         <link linkend="int">int</link> length,
                                                         <link linkend="PangoAnalysis">PangoAnalysis</link> *analysis,
                                                         <link linkend="PangoLogAttr">PangoLogAttr</link> *attrs,
                                                         <link linkend="int">int</link> attrs_len);
                    <link linkend="PangoLogAttr">PangoLogAttr</link>;

<link linkend="void">void</link>                <link linkend="pango-shape">pango_shape</link>                         (const <link linkend="gchar">gchar</link> *text,
                                                         <link linkend="gint">gint</link> length,
                                                         const <link linkend="PangoAnalysis">PangoAnalysis</link> *analysis,
                                                         <link linkend="PangoGlyphString">PangoGlyphString</link> *glyphs);
</synopsis>
</refsynopsisdiv>

<refsect1 id="pango-Text-Processing.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
  <link linkend="GObject">GObject</link>
   +----PangoContext
</synopsis>

</refsect1>








<refsect1 id="pango-Text-Processing.description" role="desc">
<title role="desc.title">Description</title>
<para>
The Pango rendering pipeline takes a string of
Unicode characters and converts it into glyphs.
The functions described in this section accomplish
various steps of this process.
</para>
</refsect1>

<refsect1 id="pango-Text-Processing.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="PangoContext-struct" role="struct">
<title>PangoContext</title>
<indexterm zone="PangoContext-struct"><primary>PangoContext</primary></indexterm><programlisting>typedef struct _PangoContext PangoContext;</programlisting>
<para>
The <link linkend="PangoContext"><type>PangoContext</type></link> structure stores global information
used to control the itemization process. 
</para></refsect2>
<refsect2 id="PangoItem" role="struct">
<title>PangoItem</title>
<indexterm zone="PangoItem"><primary>PangoItem</primary></indexterm><programlisting>typedef struct {
  gint offset;
  gint length;
  gint num_chars;
  PangoAnalysis analysis;
} PangoItem;
</programlisting>
<para>
The <link linkend="PangoItem"><type>PangoItem</type></link> structure stores information about
a segment of text. It contains the following fields:
</para><variablelist role="struct">
<varlistentry>
<term><link linkend="gint">gint</link>&nbsp;<structfield>offset</structfield>;</term>
<listitem><simpara>the offset of the segment from the beginning of the
         string in bytes.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><link linkend="gint">gint</link>&nbsp;<structfield>length</structfield>;</term>
<listitem><simpara>the length of the segment in bytes.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><link linkend="gint">gint</link>&nbsp;<structfield>num_chars</structfield>;</term>
<listitem><simpara>the length of the segment in characters.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><link linkend="PangoAnalysis">PangoAnalysis</link>&nbsp;<structfield>analysis</structfield>;</term>
<listitem><simpara>the properties of the segment.

</simpara></listitem>
</varlistentry>
</variablelist></refsect2>
<refsect2 id="PangoAnalysis" role="struct">
<title>PangoAnalysis</title>
<indexterm zone="PangoAnalysis"><primary>PangoAnalysis</primary></indexterm><programlisting>typedef struct {
  PangoEngineShape *shape_engine;
  PangoEngineLang  *lang_engine;
  PangoFont *font;