pango-layout-objects.html

linux

</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3170828"></a><h3>
<a name="pango-layout-get-font-description"></a>pango_layout_get_font_description ()</h3>
<a class="indexterm" name="id3170845"></a><pre class="programlisting">const <a href="pango-Fonts.html#PangoFontDescription">PangoFontDescription</a>* pango_layout_get_font_description
                                                        (<a href="pango-Layout-Objects.html#PangoLayout">PangoLayout</a> *layout);</pre>
<p>
Gets the font description 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 pointer to the layout's font description,
 or <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a> 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.

</td>
</tr>
</tbody>
</table></div>
<p class="since">Since  1.8
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3170936"></a><h3>
<a name="pango-layout-set-width"></a>pango_layout_set_width ()</h3>
<a class="indexterm" name="id3170949"></a><pre class="programlisting">void                pango_layout_set_width              (<a href="pango-Layout-Objects.html#PangoLayout">PangoLayout</a> *layout,
                                                         int width);</pre>
<p>
Sets the width to which the lines of the <a href="pango-Layout-Objects.html#PangoLayout"><span class="type">PangoLayout</span></a> should wrap.</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>width</code></em>&#160;:</span></td>
<td> the desired width in Pango units, or -1 to indicate that no
        wrapping should be performed.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3171038"></a><h3>
<a name="pango-layout-get-width"></a>pango_layout_get_width ()</h3>
<a class="indexterm" name="id3171051"></a><pre class="programlisting">int                 pango_layout_get_width              (<a href="pango-Layout-Objects.html#PangoLayout">PangoLayout</a> *layout);</pre>
<p>
Gets the width to which the lines of the <a href="pango-Layout-Objects.html#PangoLayout"><span class="type">PangoLayout</span></a> should wrap.</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 width, or -1 if no width set.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3171127"></a><h3>
<a name="pango-layout-set-wrap"></a>pango_layout_set_wrap ()</h3>
<a class="indexterm" name="id3171141"></a><pre class="programlisting">void                pango_layout_set_wrap               (<a href="pango-Layout-Objects.html#PangoLayout">PangoLayout</a> *layout,
                                                         <a href="pango-Layout-Objects.html#PangoWrapMode">PangoWrapMode</a> wrap);</pre>
<p>
Sets the wrap mode; the wrap mode only has effect if a width
is set on the layout with <a href="pango-Layout-Objects.html#pango-layout-set-width"><code class="function">pango_layout_set_width()</code></a>. To turn off wrapping,
set the width to -1.</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>wrap</code></em>&#160;:</span></td>
<td> the wrap mode
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3171233"></a><h3>
<a name="pango-layout-get-wrap"></a>pango_layout_get_wrap ()</h3>
<a class="indexterm" name="id3171247"></a><pre class="programlisting"><a href="pango-Layout-Objects.html#PangoWrapMode">PangoWrapMode</a>       pango_layout_get_wrap               (<a href="pango-Layout-Objects.html#PangoLayout">PangoLayout</a> *layout);</pre>
<p>
Gets the wrap mode for the layout.
</p>
<p>
Use <a href="pango-Layout-Objects.html#pango-layout-is-wrapped"><code class="function">pango_layout_is_wrapped()</code></a> to query whether any paragraphs
were actually wrapped.</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> active wrap mode.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3171331"></a><h3>
<a name="pango-layout-is-wrapped"></a>pango_layout_is_wrapped ()</h3>
<a class="indexterm" name="id3171346"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a>            pango_layout_is_wrapped             (<a href="pango-Layout-Objects.html#PangoLayout">PangoLayout</a> *layout);</pre>
<p>
Queries whether the layout had to wrap any paragraphs.
</p>
<p>
This returns <a
href="../glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a> if a positive width is set on <em class="parameter"><code>layout</code></em>,
ellipsization mode of <em class="parameter"><code>layout</code></em> is set to <a href="pango-Layout-Objects.html#PANGO-ELLIPSIZE-NONE:CAPS"><code class="literal">PANGO_ELLIPSIZE_NONE</code></a>,
and there are paragraphs exceeding the layout width that have
to be wrapped.</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
href="../glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a> if any paragraphs had to be wrapped, <a
href="../glib/glib-Standard-Macros.html#FALSE:CAPS"
><code class="literal">FALSE</code></a>
otherwise.

</td>
</tr>
</tbody>
</table></div>
<p class="since">Since  1.16
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3171482"></a><h3>
<a name="PangoWrapMode"></a>enum PangoWrapMode</h3>
<a class="indexterm" name="id3171495"></a><pre class="programlisting">typedef enum {
  PANGO_WRAP_WORD,
  PANGO_WRAP_CHAR,
  PANGO_WRAP_WORD_CHAR
} PangoWrapMode;
</pre>
<p>
A <a href="pango-Layout-Objects.html#PangoWrapMode"><span class="type">PangoWrapMode</span></a> describes how to wrap the lines of a <a href="pango-Layout-Objects.html#PangoLayout"><span class="type">PangoLayout</span></a> to the desired width.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><a name="PANGO-WRAP-WORD:CAPS"></a><code class="literal">PANGO_WRAP_WORD</code></span></td>
<td>wrap lines at word boundaries.
</td>
</tr>
<tr>
<td><span class="term"><a name="PANGO-WRAP-CHAR:CAPS"></a><code class="literal">PANGO_WRAP_CHAR</code></span></td>
<td>wrap lines at character boundaries.
</td>
</tr>
<tr>
<td><span class="term"><a name="PANGO-WRAP-WORD-CHAR:CAPS"></a><code class="literal">PANGO_WRAP_WORD_CHAR</code></span></td>
<td>wrap lines at word boundaries, but fall back to character boundaries if there is not 
enough space for a full word.

</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3171603"></a><h3>
<a name="PANGO-TYPE-WRAP-MODE:CAPS"></a>PANGO_TYPE_WRAP_MODE</h3>
<a class="indexterm" name="id3171617"></a><pre class="programlisting">#define PANGO_TYPE_WRAP_MODE (pango_wrap_mode_get_type())