pango-layout-objects.html

linux

<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>layout</code></em>&#160;:</span></td>
<td> a <a href="pango-Layout-Objects.html#PangoLayout"><span class="type">PangoLayout</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>text</code></em>&#160;:</span></td>
<td> a valid UTF-8 string
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>length</code></em>&#160;:</span></td>
<td> maximum length of <em class="parameter"><code>text</code></em>, 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 <em class="parameter"><code>length</code></em> is
         positive.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3170050"></a><h3>
<a name="pango-layout-get-text"></a>pango_layout_get_text ()</h3>
<a class="indexterm" name="id3170064"></a><pre class="programlisting">const char*         pango_layout_get_text               (<a href="pango-Layout-Objects.html#PangoLayout">PangoLayout</a> *layout);</pre>
<p>
Gets the text in the layout. The returned text should not
be freed or modified.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>layout</code></em>&#160;:</span></td>
<td> a <a href="pango-Layout-Objects.html#PangoLayout"><span class="type">PangoLayout</span></a>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> the text in the <em class="parameter"><code>layout</code></em>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3170140"></a><h3>
<a name="pango-layout-set-markup"></a>pango_layout_set_markup ()</h3>
<a class="indexterm" name="id3170153"></a><pre class="programlisting">void                pango_layout_set_markup             (<a href="pango-Layout-Objects.html#PangoLayout">PangoLayout</a> *layout,
                                                         const char *markup,
                                                         int length);</pre>
<p>
Same as <a href="pango-Layout-Objects.html#pango-layout-set-markup-with-accel"><code class="function">pango_layout_set_markup_with_accel()</code></a>, but
the markup text isn't scanned for accelerators.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>layout</code></em>&#160;:</span></td>
<td> a <a href="pango-Layout-Objects.html#PangoLayout"><span class="type">PangoLayout</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>markup</code></em>&#160;:</span></td>
<td> marked-up text
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>length</code></em>&#160;:</span></td>
<td> length of marked-up text in bytes, or -1 if <em class="parameter"><code>markup</code></em> is
nul-terminated
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3170273"></a><h3>
<a name="pango-layout-set-markup-with-accel"></a>pango_layout_set_markup_with_accel ()</h3>
<a class="indexterm" name="id3170287"></a><pre class="programlisting">void                pango_layout_set_markup_with_accel  (<a href="pango-Layout-Objects.html#PangoLayout">PangoLayout</a> *layout,
                                                         const char *markup,
                                                         int length,
                                                         <a
href="../glib/glib-Unicode-Manipulation.html#gunichar"
>gunichar</a> accel_marker,
                                                         <a
href="../glib/glib-Unicode-Manipulation.html#gunichar"
>gunichar</a> *accel_char);</pre>
<p>
Sets the layout text and attribute list from marked-up text (see
<a href="PangoMarkupFormat.html" title="Text Attribute Markup">markup format</a>). Replaces
the current text and attribute list.
</p>
<p>
If <em class="parameter"><code>accel_marker</code></em> is nonzero, the given character will mark the
character following it as an accelerator. For example, <em class="parameter"><code>accel_marker</code></em>
might be an ampersand or underscore. All characters marked
as an accelerator will receive a <a href="pango-Text-Attributes.html#PANGO-UNDERLINE-LOW:CAPS"><code class="literal">PANGO_UNDERLINE_LOW</code></a> attribute,
and the first character so marked will be returned in <em class="parameter"><code>accel_char</code></em>.
Two <em class="parameter"><code>accel_marker</code></em> characters following each other produce a single
literal <em class="parameter"><code>accel_marker</code></em> character.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>layout</code></em>&#160;:</span></td>
<td> a <a href="pango-Layout-Objects.html#PangoLayout"><span class="type">PangoLayout</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>markup</code></em>&#160;:</span></td>
<td> marked-up text
(see <a href="PangoMarkupFormat.html" title="Text Attribute Markup">markup format</a>)
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>length</code></em>&#160;:</span></td>
<td> length of marked-up text in bytes, or -1 if <em class="parameter"><code>markup</code></em> is
nul-terminated
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>accel_marker</code></em>&#160;:</span></td>
<td> marker for accelerators in the text
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>accel_char</code></em>&#160;:</span></td>
<td> return location for first located accelerator, or <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3170514"></a><h3>
<a name="pango-layout-set-attributes"></a>pango_layout_set_attributes ()</h3>
<a class="indexterm" name="id3170528"></a><pre class="programlisting">void                pango_layout_set_attributes         (<a href="pango-Layout-Objects.html#PangoLayout">PangoLayout</a> *layout,
                                                         <a href="pango-Text-Attributes.html#PangoAttrList">PangoAttrList</a> *attrs);</pre>
<p>
Sets the text attributes for a layout object.
References <em class="parameter"><code>attrs</code></em>, so the caller can unref its reference.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>layout</code></em>&#160;:</span></td>
<td> a <a href="pango-Layout-Objects.html#PangoLayout"><span class="type">PangoLayout</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>attrs</code></em>&#160;:</span></td>
<td> a <a href="pango-Text-Attributes.html#PangoAttrList"><span class="type">PangoAttrList</span></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3170623"></a><h3>
<a name="pango-layout-get-attributes"></a>pango_layout_get_attributes ()</h3>
<a class="indexterm" name="id3170636"></a><pre class="programlisting"><a href="pango-Text-Attributes.html#PangoAttrList">PangoAttrList</a>*      pango_layout_get_attributes         (<a href="pango-Layout-Objects.html#PangoLayout">PangoLayout</a> *layout);</pre>
<p>
Gets the attribute list for the layout, if any.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>layout</code></em>&#160;:</span></td>
<td> a <a href="pango-Layout-Objects.html#PangoLayout"><span class="type">PangoLayout</span></a>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> a <a href="pango-Text-Attributes.html#PangoAttrList"><span class="type">PangoAttrList</span></a>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3170712"></a><h3>
<a name="pango-layout-set-font-description"></a>pango_layout_set_font_description ()</h3>
<a class="indexterm" name="id3170727"></a><pre class="programlisting">void                pango_layout_set_font_description   (<a href="pango-Layout-Objects.html#PangoLayout">PangoLayout</a> *layout,
                                                         const <a href="pango-Fonts.html#PangoFontDescription">PangoFontDescription</a> *desc);</pre>
<p>
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.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>layout</code></em>&#160;:</span></td>
<td> a <a href="pango-Layout-Objects.html#PangoLayout"><span class="type">PangoLayout</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>desc</code></em>&#160;:</span></td>
<td> the new <a href="pango-Fonts.html#PangoFontDescription"><span class="type">PangoFontDescription</span></a>, or <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a> to unset the
       current font description
</td>
</tr>
</tbody>