<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Pango::LayoutLine class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head>
<body bgcolor="#ffffff">
<table border="0" width="100%">
<tr>
<td width="10%" height="40"><img src="../../images/gtkmm_logo.gif" alt="logo" border="0" width="100%" height="100%"/></td>
<td width="90%" height="40"><img src="../../images/top.gif" alt="top" width="100%" height="40"/></td>
</tr>
</table>
<center>
<a class="qindex" href="../../index.html">Main Page</a>
<a href="group__Widgets.html">Widgets</a>
<a class="qindex" href="namespaces.html"> Namespaces</a>
<a href="../../tutorial/html/index.html"> Book</a>
</center>
<hr width="100%"/>
<!-- Generated by Doxygen 1.3-rc1 -->
<h1>Pango::LayoutLine Class Reference</h1>A Pango::LayoutLine represents one of the lines resulting from laying out a paragraph via <a class="el" href="classPango_1_1Layout.html">Pango::Layout</a>.
<a href="#_details">More...</a>
<p>
<a href="classPango_1_1LayoutLine-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classPango_1_1LayoutLine.html#a0">reference</a> () const</td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classPango_1_1LayoutLine.html#a1">unreference</a> () const</td></tr>
<tr><td nowrap align=right valign=top>PangoLayoutLine* </td><td valign=bottom><a class="el" href="classPango_1_1LayoutLine.html#a2">gobj</a> ()</td></tr>
<tr><td nowrap align=right valign=top>const PangoLayoutLine* </td><td valign=bottom><a class="el" href="classPango_1_1LayoutLine.html#a3">gobj</a> () const</td></tr>
<tr><td nowrap align=right valign=top>PangoLayoutLine* </td><td valign=bottom><a class="el" href="classPango_1_1LayoutLine.html#a4">gobj_copy</a> () const</td></tr>
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classPango_1_1LayoutLine.html#a5">x_to_index</a> (int x_pos, int& index, int& trailing) const</td></tr>
<tr><td> </td><td><font size=-1><em>Convert from x offset to the byte index of the corresponding character within the text of the layout.</em> <a href="#a5"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="classPango_1_1LayoutLine.html#a6">index_to_x</a> (int index, bool trailing) const</td></tr>
<tr><td> </td><td><font size=-1><em>Converts an index within a line to a <em>x</em> position.</em> <a href="#a6"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="classGlib_1_1ArrayHandle.html">Glib::ArrayHandle</a>< std::pair<<br>
int, int > > </td><td valign=bottom><a class="el" href="classPango_1_1LayoutLine.html#a7">get_x_ranges</a> (int start_index, int end_index) const</td></tr>
<tr><td> </td><td><font size=-1><em>Get a list of visual ranges corresponding to a given logical range.</em> <a href="#a7"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classPango_1_1LayoutLine.html#a8">get_extents</a> (<a class="el" href="classPango_1_1Rectangle.html">Rectangle</a>& ink_rect, <a class="el" href="classPango_1_1Rectangle.html">Rectangle</a>& logical_rect) const</td></tr>
<tr><td> </td><td><font size=-1><em>Compute the logical and ink extents of a layout line.</em> <a href="#a8"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="classPango_1_1Rectangle.html">Rectangle</a> </td><td valign=bottom><a class="el" href="classPango_1_1LayoutLine.html#a9">get_ink_extents</a> () const</td></tr>
<tr><td> </td><td><font size=-1><em>Compute the ink extents of a layout line.</em> <a href="#a9"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="classPango_1_1Rectangle.html">Rectangle</a> </td><td valign=bottom><a class="el" href="classPango_1_1LayoutLine.html#a10">get_logical_extents</a> () const</td></tr>
<tr><td> </td><td><font size=-1><em>Compute the logical extents of a layout line.</em> <a href="#a10"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classPango_1_1LayoutLine.html#a11">get_pixel_extents</a> (<a class="el" href="classPango_1_1Rectangle.html">Rectangle</a>& ink_rect, <a class="el" href="classPango_1_1Rectangle.html">Rectangle</a>& logical_rect) const</td></tr>
<tr><td> </td><td><font size=-1><em>Compute the logical and ink extents of a layout line.</em> <a href="#a11"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="classPango_1_1Rectangle.html">Rectangle</a> </td><td valign=bottom><a class="el" href="classPango_1_1LayoutLine.html#a12">get_pixel_ink_extents</a> () const</td></tr>
<tr><td> </td><td><font size=-1><em>Compute the ink extents of a layout line in device units.</em> <a href="#a12"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="classPango_1_1Rectangle.html">Rectangle</a> </td><td valign=bottom><a class="el" href="classPango_1_1LayoutLine.html#a13">get_pixel_logical_extents</a> () const</td></tr>
<tr><td> </td><td><font size=-1><em>Compute the logical extents of a layout line in device units.</em> <a href="#a13"></a><em></em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Protected Methods</h2></td></tr>
<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classPango_1_1LayoutLine.html#b0">LayoutLine</a> ()</td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classPango_1_1LayoutLine.html#b1">operator delete</a> (void*, size_t)</td></tr>
<tr><td colspan=2><br><h2>Related Functions</h2></td></tr>
<tr><td colspan=2>(Note that these are not member functions.)<br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><Pango::LayoutLine> </td><td valign=bottom><a class="el" href="classPango_1_1LayoutLine.html#k0">wrap</a> (PangoLayoutLine* object, bool take_copy=false)</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A Pango::LayoutLine represents one of the lines resulting from laying out a paragraph via <a class="el" href="classPango_1_1Layout.html">Pango::Layout</a>.
<p>
Pango::LayoutLine objects are obtained by calling <a class="el" href="classPango_1_1Layout.html#a46">Pango::Layout::get_line()</a> and are only valid until the text, attributes, or settings of the parent <a class="el" href="classPango_1_1Layout.html">Pango::Layout</a> are modified. Routines for rendering <a class="el" href="classPango_1_1Layout.html">Pango::Layout</a> objects are provided in code specific to each rendering system.
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a name="b0" doxytag="Pango::LayoutLine::LayoutLine"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> Pango::LayoutLine::LayoutLine </td>
<td class="md" valign="top">(</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap><code> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="a8" doxytag="Pango::LayoutLine::get_extents"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void Pango::LayoutLine::get_extents </td>
<td class="md" valign="top">(</td>
<td class="md" nowrap valign="top"><a class="el" href="classPango_1_1Rectangle.html">Rectangle</a>& </td>
<td class="mdname" nowrap> <em>ink_rect</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="classPango_1_1Rectangle.html">Rectangle</a>& </td>
<td class="mdname" nowrap> <em>logical_rect</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Compute the logical and ink extents of a layout line.
<p>
See the documentation for <a class="el" href="classPango_1_1Font.html#a8">Pango::Font::get_glyph_extents()</a> for details about the interpretation of the rectangles. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>ink_rect</em> </td><td><a class="el" href="classPango_1_1Rectangle.html">Rectangle</a> used to store the extents of the glyph string as drawn or <code>0</code> to indicate that the result is not needed. </td></tr>
<tr><td valign=top><em>logical_rect</em> </td><td><a class="el" href="classPango_1_1Rectangle.html">Rectangle</a> used to store the logical extents of the glyph string or <code>0</code> to indicate that the result is not needed. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a name="a9" doxytag="Pango::LayoutLine::get_ink_extents"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="classPango_1_1Rectangle.html">Rectangle</a> Pango::LayoutLine::get_ink_extents </td>
<td class="md" valign="top">(</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Compute the ink extents of a layout line.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>The extents of the layout line as drawn. </dd></dl>
</td>
</tr>
</table>
<a name="a10" doxytag="Pango::LayoutLine::get_logical_extents"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="classPango_1_1Rectangle.html">Rectangle</a> Pango::LayoutLine::get_logical_extents </td>
<td class="md" valign="top">(</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Compute the logical extents of a layout line.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>The logical extents of the layout line. </dd></dl>
</td>
</tr>
</table>
<a name="a11" doxytag="Pango::LayoutLine::get_pixel_extents"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void Pango::LayoutLine::get_pixel_extents </td>
<td class="md" valign="top">(</td>
<td class="md" nowrap valign="top"><a class="el" href="classPango_1_1Rectangle.html">Rectangle</a>& </td>
<td class="mdname" nowrap> <em>ink_rect</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="classPango_1_1Rectangle.html">Rectangle</a>& </td>
<td class="mdname" nowrap> <em>logical_rect</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Compute the logical and ink extents of a layout line.
<p>
See the documentation for <a class="el" href="classPango_1_1Font.html#a8">Pango::Font::get_glyph_extents()</a> for details about the interpretation of the rectangles. The returned rectangles are in device units, as opposed to pango_layout_line_get_extents(), which returns the extents in units of device unit / PANGO_SCALE. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>ink_rect</em> </td><td><a class="el" href="classPango_1_1Rectangle.html">Rectangle</a> used to store the extents of the glyph string as drawn or <code>0</code> to indicate that the result is not needed. </td></tr>
<tr><td valign=top><em>logical_rect</em> </td><td><a class="el" href="classPango_1_1Rectangle.html">Rectangle</a> used to store the logical extents of the glyph string or <code>0</code> to indicate that the result is not needed. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a name="a12" doxytag="Pango::LayoutLine::get_pixel_ink_extents"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="classPango_1_1Rectangle.html">Rectangle</a> Pango::LayoutLine::get_pixel_ink_extents </td>
<td class="md" valign="top">(</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Compute the ink extents of a layout line in device units.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>The extents of the layout line as drawn. </dd></dl>
</td>
</tr>
</table>
<a name="a13" doxytag="Pango::LayoutLine::get_pixel_logical_extents"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="classPango_1_1Rectangle.html">Rectangle</a> Pango::LayoutLine::get_pixel_logical_extents </td>
<td class="md" valign="top">(</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Compute the logical extents of a layout line in device units.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>The logical extents of the layout line. </dd></dl>
</td>
</tr>
</table>
<a name="a7" doxytag="Pango::LayoutLine::get_x_ranges"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="classGlib_1_1ArrayHandle.html">Glib::ArrayHandle</a><std::pair<int,int> > Pango::LayoutLine::get_x_ranges </td>
<td class="md" valign="top">(</td>
<td class="md" nowrap valign="top">int </td>
<td class="mdname" nowrap> <em>start_index</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>end_index</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Get a list of visual ranges corresponding to a given logical range.
<p>
This list is not necessarily minimal - there may be consecutive ranges which are adjacent. The ranges will be sorted from left to right. The ranges are with respect to the left edge of the entire layout, not with respect to the line. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>start_index</em> </td><td>The start byte index of the logical range. If the value of <em>start_index</em> is less than the start index for the line, then the first range will extend all the way to the leading edge of the layout. Otherwise it will start at the leading edge of the first character. </td></tr>
<tr><td valign=top><em>end_index</em> </td><td>The end byte index of the logical range. If the value of <em>end_index</em> is greater than the end index for the line, then the last range will extend all the way to the trailing edge of the layout. Otherwise, it will end at the trailing edge of the last character. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>An array of ranges represented by pairs of integers marking the start and end pixel coordinates of the ranges. </dd></dl>
</td>
</tr>
</table>
<a name="a3" doxytag="Pango::LayoutLine::gobj"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> const PangoLayoutLine* Pango::LayoutLine::gobj </td>
<td class="md" valign="top">(</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a2" doxytag="Pango::LayoutLine::gobj"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> PangoLayoutLine* Pango::LayoutLine::gobj </td>
<td class="md" valign="top">(</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a4" doxytag="Pango::LayoutLine::gobj_copy"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> PangoLayoutLine* Pango::LayoutLine::gobj_copy </td>
<td class="md" valign="top">(</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a6" doxytag="Pango::LayoutLine::index_to_x"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> int Pango::LayoutLine::index_to_x </td>
<td class="md" valign="top">(</td>
<td class="md" nowrap valign="top">int </td>
<td class="mdname" nowrap> <em>index</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>bool </td>
<td class="mdname" nowrap> <em>trailing</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Converts an index within a line to a <em>x</em> position.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>index</em> </td><td>Byte offset of a grapheme within the layout. </td></tr>
<tr><td valign=top><em>trailing</em> </td><td>An boolean indicating the edge of the grapheme to retrieve the position of. If <code>false</code>, the trailing edge of the grapheme, if <code>true</code> the leading of the grapheme. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The x offset (in thousands of a device unit). </dd></dl>
</td>
</tr>
</table>
<a name="b1" doxytag="Pango::LayoutLine::operator delete"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void Pango::LayoutLine::operator delete </td>
<td class="md" valign="top">(</td>
<td class="md" nowrap valign="top">void* </td>
<td class="mdname" nowrap> , </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>size_t </td>
<td class="mdname" nowrap> </td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a0" doxytag="Pango::LayoutLine::reference"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void Pango::LayoutLine::reference </td>
<td class="md" valign="top">(</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a1" doxytag="Pango::LayoutLine::unreference"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void Pango::LayoutLine::unreference </td>
<td class="md" valign="top">(</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a5" doxytag="Pango::LayoutLine::x_to_index"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool Pango::LayoutLine::x_to_index </td>
<td class="md" valign="top">(</td>
<td class="md" nowrap valign="top">int </td>
<td class="mdname" nowrap> <em>x_pos</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>int& </td>
<td class="mdname" nowrap> <em>index</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>int& </td>
<td class="mdname" nowrap> <em>trailing</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Convert from x offset to the byte index of the corresponding character within the text of the layout.
<p>
If <em>x_pos</em> is outside the line, the start or end of the line will be stored at <em>index</em> . <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>x_pos</em> </td><td>The x offset (in thousands of a device unit) from the left edge of the line. </td></tr>
<tr><td valign=top><em>index_</em> </td><td>Location to store calculated byte offset for the grapheme in which the user clicked. </td></tr>
<tr><td valign=top><em>trailing</em> </td><td>Location to store a integer indicating where in the grapheme the user clicked. It will either be zero, or the number of characters in the grapheme. 0 represents the trailing edge of the cluster. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd><code>false</code> if <em>x_pos</em> was outside the line, <code>true</code> if inside. </dd></dl>
</td>
</tr>
</table>
<hr><h2>Friends And Related Function Documentation</h2>
<a name="k0" doxytag="Pango::LayoutLine::wrap"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><Pango::LayoutLine> wrap </td>
<td class="md" valign="top">(</td>
<td class="md" nowrap valign="top">PangoLayoutLine* </td>
<td class="mdname" nowrap> <em>object</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>bool </td>
<td class="mdname" nowrap> <em>take_copy</em> = false</td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [related]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="layoutline_8h.html">layoutline.h</a></ul>
<hr><address><small>
Generated for gtkmm by <a href="http://www.doxygen.org/index.html">
Doxygen</a> 1.3-rc1 © 1997-2001</small></address>
</body>
</html>
