~ubuntu-branches/ubuntu/maverick/pango1.0/maverick-proposed

#define             <a class="link" href="pango-Text-Processing.html#PANGO-TYPE-DIRECTION--CAPS" title="PANGO_TYPE_DIRECTION">PANGO_TYPE_DIRECTION</a>

 

<a

>GList</a> *             <a class="link" href="pango-Text-Processing.html#pango-itemize" title="pango_itemize ()">pango_itemize</a>                       (<a class="link" href="pango-Text-Processing.html#PangoContext">PangoContext</a> *context,

                                                         const char *text,

                                                         int start_index,

                                                         <a class="link" href="pango-Text-Attributes.html#PangoAttrList" title="PangoAttrList">PangoAttrList</a> *attrs,

                                                         <a class="link" href="pango-Text-Attributes.html#PangoAttrIterator" title="PangoAttrIterator">PangoAttrIterator</a> *cached_iter);

<a

>GList</a> *             <a class="link" href="pango-Text-Processing.html#pango-itemize-with-base-dir" title="pango_itemize_with_base_dir ()">pango_itemize_with_base_dir</a>         (<a class="link" href="pango-Text-Processing.html#PangoContext">PangoContext</a> *context,

                                                         <a class="link" href="pango-Bidirectional-Text.html#PangoDirection" title="enum PangoDirection">PangoDirection</a> base_dir,

                                                         const char *text,

                                                         int split_index,

                                                         int split_offset);

<a

>GList</a> *             <a class="link" href="pango-Text-Processing.html#pango-reorder-items" title="pango_reorder_items ()">pango_reorder_items</a>                 (<a

>GList</a> *logical_items);

 

<a class="link" href="pango-Text-Processing.html#PangoContext">PangoContext</a> *      <a class="link" href="pango-Text-Processing.html#pango-context-new" title="pango_context_new ()">pango_context_new</a>                   (void);

 

 

void                <a class="link" href="pango-Text-Processing.html#pango-break" title="pango_break ()">pango_break</a>                         (const <a

>gchar</a> *text,

                                                         int length,

                                                         <a class="link" href="pango-Text-Processing.html#PangoAnalysis" title="PangoAnalysis">PangoAnalysis</a> *analysis,

                                                         <a class="link" href="pango-Text-Processing.html#PangoLogAttr" title="PangoLogAttr">PangoLogAttr</a> *log_attrs,

                                                         int attrs_len);

void                <a class="link" href="pango-Text-Processing.html#pango-find-paragraph-boundary" title="pango_find_paragraph_boundary ()">pango_find_paragraph_boundary</a>       (const <a

>gchar</a> *text,

                                                         <a

>gint</a> length,

                                                         <a

>gint</a> *paragraph_delimiter_index,

                                                         <a

>gint</a> *next_paragraph_start);

void                <a class="link" href="pango-Text-Processing.html#pango-default-break" title="pango_default_break ()">pango_default_break</a>                 (const <a

>gchar</a> *text,

                                                         int length,

                                                         <a class="link" href="pango-Text-Processing.html#PangoAnalysis" title="PangoAnalysis">PangoAnalysis</a> *analysis,

                    <a class="link" href="pango-Text-Processing.html#PangoLogAttr" title="PangoLogAttr">PangoLogAttr</a>;

 

void                <a class="link" href="pango-Text-Processing.html#pango-shape" title="pango_shape ()">pango_shape</a>                         (const <a

>gchar</a> *text,

                                                         <a

>gint</a> length,

                                                         const <a class="link" href="pango-Text-Processing.html#PangoAnalysis" title="PangoAnalysis">PangoAnalysis</a> *analysis,

                                                         <a class="link" href="pango-Glyph-Storage.html#PangoGlyphString" title="PangoGlyphString">PangoGlyphString</a> *glyphs);

<a name="pango-Text-Processing.object-hierarchy"></a><h2>Object Hierarchy</h2>

<pre class="synopsis">

  <a

>GObject</a>

   +----PangoContext

</pre>

<tbody>

<tr>

<td><p><span class="term"><a

>gint</a> <em class="structfield"><code>offset</code></em>;</span></p></td>

<td>the offset of the segment from the beginning of the

         string in bytes.

</tr>

<tr>

<td><p><span class="term"><a

>gint</a> <em class="structfield"><code>length</code></em>;</span></p></td>

<td>the length of the segment in bytes.

</td>

</tr>

<tr>

<td><p><span class="term"><a

>gint</a> <em class="structfield"><code>num_chars</code></em>;</span></p></td>

<td>the length of the segment in characters.

</td>

</tr>

<tr>

<td><p><span class="term"><a

>guint8</a> <em class="structfield"><code>level</code></em>;</span></p></td>

<td>the bidirectional level for this segment.

</td>

</tr>

<tr>

<td><p><span class="term"><a

>guint8</a> <em class="structfield"><code>gravity</code></em>;</span></p></td>

<td>the glyph orientation for this segment (A <a class="link" href="pango-Vertical-Text.html#PangoGravity" title="enum PangoGravity"><span class="type">PangoGravity</span></a>).

</td>

</tr>

<tr>

<td><p><span class="term"><a

>guint8</a> <em class="structfield"><code>flags</code></em>;</span></p></td>

<td>boolean flags for this segment (currently only one) (Since: 1.16).

</td>

</tr>

<tr>

<td><p><span class="term"><a

>guint8</a> <em class="structfield"><code>script</code></em>;</span></p></td>

<td>the detected script for this segment (A <a class="link" href="pango-Scripts-and-Languages.html#PangoScript" title="enum PangoScript"><span class="type">PangoScript</span></a>) (Since: 1.18).

</td>

</tr>

<tr>

<td><p><span class="term"><a

>GSList</a> *<em class="structfield"><code>extra_attrs</code></em>;</span></p></td>

<td>extra attributes for this segment.

</td>

</pre>

<p>

The <a

><span class="type">GObject</span></a> type for <a class="link" href="pango-Bidirectional-Text.html#PangoDirection" title="enum PangoDirection"><span class="type">PangoDirection</span></a>.

</p>

</div>

<div class="refsect2" lang="en">

<a name="pango-itemize"></a><h3>pango_itemize ()</h3>

<pre class="programlisting"><a

>GList</a> *             pango_itemize                       (<a class="link" href="pango-Text-Processing.html#PangoContext">PangoContext</a> *context,

                                                         const char *text,

                                                         int start_index,

<tr>

<td><p><span class="term"><em class="parameter"><code>cached_iter</code></em> :</span></p></td>

<td>      Cached attribute iterator, or <a

><code class="literal">NULL</code></a>

</td>

</tr>

<tr>

<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>

<td> a <a

><span class="type">GList</span></a> of <a class="link" href="pango-Text-Processing.html#PangoItem" title="PangoItem"><span class="type">PangoItem</span></a> structures.

</td>

</tr>

<div class="refsect2" lang="en">

<a name="pango-itemize-with-base-dir"></a><h3>pango_itemize_with_base_dir ()</h3>

<pre class="programlisting"><a

>GList</a> *             pango_itemize_with_base_dir         (<a class="link" href="pango-Text-Processing.html#PangoContext">PangoContext</a> *context,

                                                         <a class="link" href="pango-Bidirectional-Text.html#PangoDirection" title="enum PangoDirection">PangoDirection</a> base_dir,

                                                         const char *text,

<tr>

<td><p><span class="term"><em class="parameter"><code>cached_iter</code></em> :</span></p></td>

<td>      Cached attribute iterator, or <a

><code class="literal">NULL</code></a>

</td>

</tr>

<tr>

<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>

<td> a <a

><span class="type">GList</span></a> of <a class="link" href="pango-Text-Processing.html#PangoItem" title="PangoItem"><span class="type">PangoItem</span></a> structures.  The items should be

freed using <a class="link" href="pango-Text-Processing.html#pango-item-free" title="pango_item_free ()"><code class="function">pango_item_free()</code></a> probably in combination with <a

><code class="function">g_list_foreach()</code></a>,

and the list itself using <a

><code class="function">g_list_free()</code></a>.

 

</td>

<tbody><tr>

<td><p><span class="term"><em class="parameter"><code>item</code></em> :</span></p></td>

<td> a <a class="link" href="pango-Text-Processing.html#PangoItem" title="PangoItem"><span class="type">PangoItem</span></a>, may be <a

><code class="literal">NULL</code></a>

</td>

</tr></tbody>

<tr>

<td><p><span class="term"><em class="parameter"><code>item</code></em> :</span></p></td>

<td> a <a class="link" href="pango-Text-Processing.html#PangoItem" title="PangoItem"><span class="type">PangoItem</span></a>, may be <a

><code class="literal">NULL</code></a>

</td>

</tr>

<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>

<td> the newly allocated <a class="link" href="pango-Text-Processing.html#PangoItem" title="PangoItem"><span class="type">PangoItem</span></a>, which should

              be freed with <a class="link" href="pango-Text-Processing.html#pango-item-free" title="pango_item_free ()"><code class="function">pango_item_free()</code></a>, or <a

><code class="literal">NULL</code></a> if

              <em class="parameter"><code>item</code></em> was NULL.

</td>

<div class="refsect2" lang="en">

<a name="pango-reorder-items"></a><h3>pango_reorder_items ()</h3>

<pre class="programlisting"><a

>GList</a> *             pango_reorder_items                 (<a

>GList</a> *logical_items);</pre>

<p>

From a list of items in logical order and the associated

<tr>

<td><p><span class="term"><em class="parameter"><code>logical_items</code></em> :</span></p></td>

<td>  a <a

><span class="type">GList</span></a> of <a class="link" href="pango-Text-Processing.html#PangoItem" title="PangoItem"><span class="type">PangoItem</span></a> in logical order.

</td>

</tr>

<tr>

<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>

<td> a <a

><span class="type">GList</span></a> of <a class="link" href="pango-Text-Processing.html#PangoItem" title="PangoItem"><span class="type">PangoItem</span></a> structures in visual order.

 

(Please open a bug if you use this function.

<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>

<td> the newly allocated <a class="link" href="pango-Text-Processing.html#PangoContext"><span class="type">PangoContext</span></a>, which should

              be freed with <a

><code class="function">g_object_unref()</code></a>.

</td>

</tr></tbody>

<tr>

<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>

<td> the matrix, or <a

><code class="literal">NULL</code></a> if no matrix has been set

 (which is the same as the identity matrix). The returned

 matrix is owned by Pango and must not be modified or

<tr>

<td><p><span class="term"><em class="parameter"><code>matrix</code></em> :</span></p></td>

<td> a <a class="link" href="pango-Glyph-Storage.html#PangoMatrix" title="PangoMatrix"><span class="type">PangoMatrix</span></a>, or <a

><code class="literal">NULL</code></a> to unset any existing matrix.

 (No matrix set is the same as setting the identity matrix.)

</td>

<tr>

<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>

<td> the font loaded, or <a

><code class="literal">NULL</code></a> if no font matched.

</td>

</tr>

<tr>

<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>

<td> the fontset, or <a

><code class="literal">NULL</code></a> if no font matched.

</td>

</tr>

<tr>

<td><p><span class="term"><em class="parameter"><code>desc</code></em> :</span></p></td>

<td> a <a class="link" href="pango-Fonts.html#PangoFontDescription" title="PangoFontDescription"><span class="type">PangoFontDescription</span></a> structure.  <a

><code class="literal">NULL</code></a> means that the font

              description from the context will be used.

</td>

<td><p><span class="term"><em class="parameter"><code>language</code></em> :</span></p></td>

<td> language tag used to determine which script to get the metrics

           for. <a

><code class="literal">NULL</code></a> means that the language tag from the context will

           be used. If no language tag is set on the context, metrics

           for the default language (as determined by

<td><p><span class="term"><em class="parameter"><code>families</code></em> :</span></p></td>

<td> location to store a pointer to an array of <a class="link" href="pango-Fonts.html#PangoFontFamily"><span class="type">PangoFontFamily</span></a> *.

           This array should be freed with <a

><code class="function">g_free()</code></a>.

</td>

</tr>

<div class="refsect2" lang="en">

<a name="pango-break"></a><h3>pango_break ()</h3>

<pre class="programlisting">void                pango_break                         (const <a

>gchar</a> *text,

                                                         int length,

                                                         <a class="link" href="pango-Text-Processing.html#PangoAnalysis" title="PangoAnalysis">PangoAnalysis</a> *analysis,

<div class="refsect2" lang="en">

<a name="pango-find-paragraph-boundary"></a><h3>pango_find_paragraph_boundary ()</h3>

<pre class="programlisting">void                pango_find_paragraph_boundary       (const <a

>gchar</a> *text,

                                                         <a

>gint</a> length,

                                                         <a

>gint</a> *paragraph_delimiter_index,

                                                         <a

>gint</a> *next_paragraph_start);</pre>

<p>

Locates a paragraph boundary in <em class="parameter"><code>text</code></em>. A boundary is caused by

<div class="refsect2" lang="en">

<a name="pango-default-break"></a><h3>pango_default_break ()</h3>

<pre class="programlisting">void                pango_default_break                 (const <a

>gchar</a> *text,

                                                         int length,

                                                         <a class="link" href="pango-Text-Processing.html#PangoAnalysis" title="PangoAnalysis">PangoAnalysis</a> *analysis,

engine overrides it. Normally you should use <a class="link" href="pango-Text-Processing.html#pango-break" title="pango_break ()"><code class="function">pango_break()</code></a>

instead. Unlike <a class="link" href="pango-Text-Processing.html#pango-break" title="pango_break ()"><code class="function">pango_break()</code></a>,

<em class="parameter"><code>analysis</code></em> can be <a

><code class="literal">NULL</code></a>, but only do that if you know what

you're doing. If you need an analysis to pass to <a class="link" href="pango-Text-Processing.html#pango-break" title="pango_break ()"><code class="function">pango_break()</code></a>,

you need to <a class="link" href="pango-Text-Processing.html#pango-itemize" title="pango_itemize ()"><code class="function">pango_itemize()</code></a>.  In most cases however you should

<tbody>

<tr>

<td><p><span class="term"><a

>guint</a> <em class="structfield"><code>is_line_break</code></em> : 1;</span></p></td>

<td>if set, can break line in front of character

</td>

</tr>

<tr>

<td><p><span class="term"><a

>guint</a> <em class="structfield"><code>is_mandatory_break</code></em> : 1;</span></p></td>

<td>if set, must break line in front of character

</td>

</tr>

<tr>

<td><p><span class="term"><a

>guint</a> <em class="structfield"><code>is_char_break</code></em> : 1;</span></p></td>

<td>if set, can break here when doing character wrapping

</td>

</tr>

<tr>

<td><p><span class="term"><a

>guint</a> <em class="structfield"><code>is_white</code></em> : 1;</span></p></td>

<td>is whitespace character

</td>

</tr>

<tr>

<td><p><span class="term"><a

>guint</a> <em class="structfield"><code>is_cursor_position</code></em> : 1;</span></p></td>

<td>if set, cursor can appear in front of character.

        i.e. this is a grapheme boundary, or the first character

</tr>

<tr>

<td><p><span class="term"><a

>guint</a> <em class="structfield"><code>is_word_start</code></em> : 1;</span></p></td>

<td>is first character in a word

</td>

</tr>

<tr>

<td><p><span class="term"><a

>guint</a> <em class="structfield"><code>is_word_end</code></em> : 1;</span></p></td>

<td>is first non-word char after a word

        Note that in degenerate cases, you could have both <em class="parameter"><code>is_word_start</code></em>

</tr>

<tr>

<td><p><span class="term"><a

>guint</a> <em class="structfield"><code>is_sentence_boundary</code></em> : 1;</span></p></td>

<td>is a sentence boundary.

        There are two ways to divide sentences. The first assigns all

</tr>

<tr>

<td><p><span class="term"><a

>guint</a> <em class="structfield"><code>is_sentence_start</code></em> : 1;</span></p></td>

<td>is first character in a sentence

</td>

</tr>

<tr>

<td><p><span class="term"><a

>guint</a> <em class="structfield"><code>is_sentence_end</code></em> : 1;</span></p></td>

<td>is first char after a sentence.

        Note that in degenerate cases, you could have both <em class="parameter"><code>is_sentence_start</code></em>

</tr>

<tr>

<td><p><span class="term"><a

>guint</a> <em class="structfield"><code>backspace_deletes_character</code></em> : 1;</span></p></td>

<td>if set, backspace deletes one character

                              rather than the entire grapheme cluster. This

</tr>

<tr>

<td><p><span class="term"><a

>guint</a> <em class="structfield"><code>is_expandable_space</code></em> : 1;</span></p></td>

<td>is a whitespace character that can possibly be

                      expanded for justification purposes. (Since: 1.18)

</tr>

<tr>

<td><p><span class="term"><a

>guint</a> <em class="structfield"><code>is_word_boundary</code></em> : 1;</span></p></td>

<td>is a word boundary.

        More specifically, means that this is not a position in the middle

<div class="refsect2" lang="en">

<a name="pango-shape"></a><h3>pango_shape ()</h3>

<pre class="programlisting">void                pango_shape                         (const <a

>gchar</a> *text,

                                                         <a

>gint</a> length,

                                                         const <a class="link" href="pango-Text-Processing.html#PangoAnalysis" title="PangoAnalysis">PangoAnalysis</a> *analysis,

                                                         <a class="link" href="pango-Glyph-Storage.html#PangoGlyphString" title="PangoGlyphString">PangoGlyphString</a> *glyphs);</pre>