pango-layout-objects.html

linux

</pre>
<p>
The <a
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
><span class="type">GObject</span></a> type for <a href="pango-Layout-Objects.html#PangoWrapMode"><span class="type">PangoWrapMode</span></a>.
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3171649"></a><h3>
<a name="pango-layout-set-ellipsize"></a>pango_layout_set_ellipsize ()</h3>
<a class="indexterm" name="id3171665"></a><pre class="programlisting">void                pango_layout_set_ellipsize          (<a href="pango-Layout-Objects.html#PangoLayout">PangoLayout</a> *layout,
                                                         <a href="pango-Layout-Objects.html#PangoEllipsizeMode">PangoEllipsizeMode</a> ellipsize);</pre>
<p>
Sets the type of ellipsization being performed for <em class="parameter"><code>layout</code></em>.
Depending on the ellipsization mode <em class="parameter"><code>ellipsize</code></em> text is
removed from the start, middle, or end of lines so they
fit within the width of layout set with <a href="pango-Layout-Objects.html#pango-layout-set-width"><code class="function">pango_layout_set_width()</code></a>.
</p>
<p>
If the layout contains characters such as newlines that
force it to be layed out in multiple lines, then each line
is ellipsized separately.</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>ellipsize</code></em>&#160;:</span></td>
<td> the new ellipsization mode for <em class="parameter"><code>layout</code></em>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since  1.6
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3171789"></a><h3>
<a name="pango-layout-get-ellipsize"></a>pango_layout_get_ellipsize ()</h3>
<a class="indexterm" name="id3171804"></a><pre class="programlisting"><a href="pango-Layout-Objects.html#PangoEllipsizeMode">PangoEllipsizeMode</a>  pango_layout_get_ellipsize          (<a href="pango-Layout-Objects.html#PangoLayout">PangoLayout</a> *layout);</pre>
<p>
Gets the type of ellipsization being performed for <em class="parameter"><code>layout</code></em>.
See <a href="pango-Layout-Objects.html#pango-layout-set-ellipsize"><code class="function">pango_layout_set_ellipsize()</code></a></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 current ellipsization mode for <em class="parameter"><code>layout</code></em>.

Use <a href="pango-Layout-Objects.html#pango-layout-is-ellipsized"><code class="function">pango_layout_is_ellipsized()</code></a> to query whether any paragraphs
were actually ellipsized.

</td>
</tr>
</tbody>
</table></div>
<p class="since">Since  1.6
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3171914"></a><h3>
<a name="pango-layout-is-ellipsized"></a>pango_layout_is_ellipsized ()</h3>
<a class="indexterm" name="id3171930"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a>            pango_layout_is_ellipsized          (<a href="pango-Layout-Objects.html#PangoLayout">PangoLayout</a> *layout);</pre>
<p>
Queries whether the layout had to ellipsize any paragraphs.
</p>
<p>
This returns <a
href="../glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a> if the ellipsization mode for <em class="parameter"><code>layout</code></em>
is not <a href="pango-Layout-Objects.html#PANGO-ELLIPSIZE-NONE:CAPS"><code class="literal">PANGO_ELLIPSIZE_NONE</code></a>, a positive width is set on <em class="parameter"><code>layout</code></em>,
and there are paragraphs exceeding that width that have to be
ellipsized.</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 ellipsized, <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="id3172065"></a><h3>
<a name="PangoEllipsizeMode"></a>enum PangoEllipsizeMode</h3>
<a class="indexterm" name="id3172078"></a><pre class="programlisting">typedef enum {
  PANGO_ELLIPSIZE_NONE,
  PANGO_ELLIPSIZE_START,
  PANGO_ELLIPSIZE_MIDDLE,
  PANGO_ELLIPSIZE_END
} PangoEllipsizeMode;
</pre>
<p>
The <a href="pango-Layout-Objects.html#PangoEllipsizeMode"><span class="type">PangoEllipsizeMode</span></a> type describes what sort of (if any)
ellipsization should be applied to a line of text. In
the ellipsization process characters are removed from the
text in order to make it fit to a given width and replaced
with an ellipsis.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><a name="PANGO-ELLIPSIZE-NONE:CAPS"></a><code class="literal">PANGO_ELLIPSIZE_NONE</code></span></td>
<td> No ellipsization
</td>
</tr>
<tr>
<td><span class="term"><a name="PANGO-ELLIPSIZE-START:CAPS"></a><code class="literal">PANGO_ELLIPSIZE_START</code></span></td>
<td> Omit characters at the start of the text
</td>
</tr>
<tr>
<td><span class="term"><a name="PANGO-ELLIPSIZE-MIDDLE:CAPS"></a><code class="literal">PANGO_ELLIPSIZE_MIDDLE</code></span></td>
<td> Omit characters in the middle of the text
</td>
</tr>
<tr>
<td><span class="term"><a name="PANGO-ELLIPSIZE-END:CAPS"></a><code class="literal">PANGO_ELLIPSIZE_END</code></span></td>
<td> Omit characters at the end of the text
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3172207"></a><h3>
<a name="PANGO-TYPE-ELLIPSIZE-MODE:CAPS"></a>PANGO_TYPE_ELLIPSIZE_MODE</h3>
<a class="indexterm" name="id3172221"></a><pre class="programlisting">#define PANGO_TYPE_ELLIPSIZE_MODE (pango_ellipsize_mode_get_type())
</pre>
<p>
The <a
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
><span class="type">GObject</span></a> type for <a href="pango-Layout-Objects.html#PangoEllipsizeMode"><span class="type">PangoEllipsizeMode</span></a>.
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3172253"></a><h3>
<a name="pango-layout-set-indent"></a>pango_layout_set_indent ()</h3>
<a class="indexterm" name="id3172266"></a><pre class="programlisting">void                pango_layout_set_indent             (<a href="pango-Layout-Objects.html#PangoLayout">PangoLayout</a> *layout,
                                                         int indent);</pre>
<p>
Sets the width in Pango units to indent each paragraph. A negative value
of <em class="parameter"><code>indent</code></em> will produce a hanging indentation. That is, the first line will
have the full width, and subsequent lines will be indented by the
absolute value of <em class="parameter"><code>indent</code></em>.</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>indent</code></em>&#160;:</span></td>
<td> the amount by which to indent.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3172360"></a><h3>
<a name="pango-layout-get-indent"></a>pango_layout_get_indent ()</h3>
<a class="indexterm" name="id3172373"></a><pre class="programlisting">int                 pango_layout_get_indent             (<a href="pango-Layout-Objects.html#PangoLayout">PangoLayout</a> *layout);</pre>
<p>
Gets the paragraph indent width in Pango units. A negative value
indicates a hanging indentation.</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 indent.
</td>
</tr>