<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>ICU 3.8: ParagraphLayout::Line Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.1 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li id="current"><a href="classes.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li>
<form action="search.php" method="get">
<table cellspacing="0" cellpadding="0" border="0">
<tr>
<td><label> <u>S</u>earch for </label></td>
<td><input type="text" name="query" value="" size="20" accesskey="s"/></td>
</tr>
</table>
</form>
</li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul></div>
<div class="nav">
<a class="el" href="classParagraphLayout.html">ParagraphLayout</a>::<a class="el" href="classParagraphLayout_1_1Line.html">Line</a></div>
<h1>ParagraphLayout::Line Class Reference</h1><!-- doxytag: class="ParagraphLayout::Line" --><!-- doxytag: inherits="UObject" -->This class represents a single line of text in a <code><a class="el" href="classParagraphLayout.html">ParagraphLayout</a></code>.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="ParagraphLayout_8h-source.html">ParagraphLayout.h</a>></code>
<p>
<p>Inheritance diagram for ParagraphLayout::Line:
<p><center><img src="classParagraphLayout_1_1Line.png" usemap="#ParagraphLayout::Line_map" border="0" alt=""></center>
<map name="ParagraphLayout::Line_map">
<area href="classUObject.html" alt="UObject" shape="rect" coords="0,56,140,80">
<area href="classUMemory.html" alt="UMemory" shape="rect" coords="0,0,140,24">
</map>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classParagraphLayout_1_1Line.html#0d44cc615972afc6611eae13a05f01e7">~Line</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The constructor is private since these objects can only be created by <code><a class="el" href="classParagraphLayout.html">ParagraphLayout</a></code>. <a href="#0d44cc615972afc6611eae13a05f01e7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="LETypes_8h.html#3ae79f31399d76e3055d2a2745bd0d9a">le_int32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classParagraphLayout_1_1Line.html#1ab57c664b6b026e1315530ca5bce486">countRuns</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Count the number of visual runs in the line. <a href="#1ab57c664b6b026e1315530ca5bce486"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="LETypes_8h.html#3ae79f31399d76e3055d2a2745bd0d9a">le_int32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classParagraphLayout_1_1Line.html#b954e223e7451996ba2fab33adb23e9e">getAscent</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the ascent of the line. <a href="#b954e223e7451996ba2fab33adb23e9e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="LETypes_8h.html#3ae79f31399d76e3055d2a2745bd0d9a">le_int32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classParagraphLayout_1_1Line.html#afbe58a22a1eeec224e2ed65779bc38e">getDescent</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the descent of the line. <a href="#afbe58a22a1eeec224e2ed65779bc38e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="LETypes_8h.html#3ae79f31399d76e3055d2a2745bd0d9a">le_int32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classParagraphLayout_1_1Line.html#7649f23f46f91febde2ee5c8bbd5c838">getLeading</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the leading of the line. <a href="#7649f23f46f91febde2ee5c8bbd5c838"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="LETypes_8h.html#3ae79f31399d76e3055d2a2745bd0d9a">le_int32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classParagraphLayout_1_1Line.html#c181a18eaf36ce07e0bff5df7e182d5b">getWidth</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the width of the line. <a href="#c181a18eaf36ce07e0bff5df7e182d5b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classParagraphLayout_1_1VisualRun.html">VisualRun</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classParagraphLayout_1_1Line.html#8f53ee3cc98fa66e52f8f3b89f548e96">getVisualRun</a> (<a class="el" href="LETypes_8h.html#3ae79f31399d76e3055d2a2745bd0d9a">le_int32</a> runIndex) const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a <code><a class="el" href="classParagraphLayout_1_1VisualRun.html">ParagraphLayout::VisualRun</a></code> object for a given visual run in the line. <a href="#8f53ee3cc98fa66e52f8f3b89f548e96"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="utypes_8h.html#22af10545208a455a6e884008df48e9f">UClassID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classParagraphLayout_1_1Line.html#30ebeb777f271f16e74f1fc00cdded54">getDynamicClassID</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">ICU "poor man's RTTI", returns a UClassID for the actual class. <a href="#30ebeb777f271f16e74f1fc00cdded54"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="utypes_8h.html#22af10545208a455a6e884008df48e9f">UClassID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classParagraphLayout_1_1Line.html#7133cf4733116c9200c02941d6ca0b9e">getStaticClassID</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">ICU "poor man's RTTI", returns a UClassID for this class. <a href="#7133cf4733116c9200c02941d6ca0b9e"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="efa8892424f624336802e05074701eeb"></a><!-- doxytag: member="ParagraphLayout::Line::ParagraphLayout" ref="efa8892424f624336802e05074701eeb" args="" -->
class </td><td class="memItemRight" valign="bottom"><a class="el" href="classParagraphLayout_1_1Line.html#efa8892424f624336802e05074701eeb">ParagraphLayout</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This class represents a single line of text in a <code><a class="el" href="classParagraphLayout.html">ParagraphLayout</a></code>.
<p>
They can only be created by calling <code><a class="el" href="classParagraphLayout.html#232b40ef6d0a565c026bec85890d7b50">ParagraphLayout::nextLine()</a></code>. Each line consists of multiple visual runs, represented by <code><a class="el" href="classParagraphLayout_1_1VisualRun.html">ParagraphLayout::VisualRun</a></code> objects.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classParagraphLayout.html">ParagraphLayout</a> <p>
<a class="el" href="classParagraphLayout_1_1VisualRun.html">ParagraphLayout::VisualRun</a></dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable003452">Stable:</a></b></dt><dd>ICU 3.2 </dd></dl>
<p>
<p>
Definition at line <a class="el" href="ParagraphLayout_8h-source.html#l00060">60</a> of file <a class="el" href="ParagraphLayout_8h-source.html">ParagraphLayout.h</a>.<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="0d44cc615972afc6611eae13a05f01e7"></a><!-- doxytag: member="ParagraphLayout::Line::~Line" ref="0d44cc615972afc6611eae13a05f01e7" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ParagraphLayout::Line::~Line </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The constructor is private since these objects can only be created by <code><a class="el" href="classParagraphLayout.html">ParagraphLayout</a></code>.
<p>
However, it is the clients responsibility to destroy the objects, so the destructor is public.<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable003466">Stable:</a></b></dt><dd>ICU 3.2 </dd></dl>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="1ab57c664b6b026e1315530ca5bce486"></a><!-- doxytag: member="ParagraphLayout::Line::countRuns" ref="1ab57c664b6b026e1315530ca5bce486" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="LETypes_8h.html#3ae79f31399d76e3055d2a2745bd0d9a">le_int32</a> ParagraphLayout::Line::countRuns </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Count the number of visual runs in the line.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the number of visual runs.</dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable003467">Stable:</a></b></dt><dd>ICU 3.2 </dd></dl>
<p>
Definition at line <a class="el" href="ParagraphLayout_8h-source.html#l00655">655</a> of file <a class="el" href="ParagraphLayout_8h-source.html">ParagraphLayout.h</a>.
</div>
</div><p>
<a class="anchor" name="b954e223e7451996ba2fab33adb23e9e"></a><!-- doxytag: member="ParagraphLayout::Line::getAscent" ref="b954e223e7451996ba2fab33adb23e9e" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="LETypes_8h.html#3ae79f31399d76e3055d2a2745bd0d9a">le_int32</a> ParagraphLayout::Line::getAscent </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the ascent of the line.
<p>
This is the maximum ascent of all the fonts on the line.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the ascent of the line.</dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable003468">Stable:</a></b></dt><dd>ICU 3.2 </dd></dl>
</div>
</div><p>
<a class="anchor" name="afbe58a22a1eeec224e2ed65779bc38e"></a><!-- doxytag: member="ParagraphLayout::Line::getDescent" ref="afbe58a22a1eeec224e2ed65779bc38e" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="LETypes_8h.html#3ae79f31399d76e3055d2a2745bd0d9a">le_int32</a> ParagraphLayout::Line::getDescent </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the descent of the line.
<p>
This is the maximum descent of all the fonts on the line.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the descent of the line.</dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable003469">Stable:</a></b></dt><dd>ICU 3.2 </dd></dl>
</div>
</div><p>
<a class="anchor" name="7649f23f46f91febde2ee5c8bbd5c838"></a><!-- doxytag: member="ParagraphLayout::Line::getLeading" ref="7649f23f46f91febde2ee5c8bbd5c838" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="LETypes_8h.html#3ae79f31399d76e3055d2a2745bd0d9a">le_int32</a> ParagraphLayout::Line::getLeading </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the leading of the line.
<p>
This is the maximum leading of all the fonts on the line.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the leading of the line.</dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable003470">Stable:</a></b></dt><dd>ICU 3.2 </dd></dl>
</div>
</div><p>
<a class="anchor" name="c181a18eaf36ce07e0bff5df7e182d5b"></a><!-- doxytag: member="ParagraphLayout::Line::getWidth" ref="c181a18eaf36ce07e0bff5df7e182d5b" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="LETypes_8h.html#3ae79f31399d76e3055d2a2745bd0d9a">le_int32</a> ParagraphLayout::Line::getWidth </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the width of the line.
<p>
This is a convenience method which returns the last X position of the last visual run in the line.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the width of the line.</dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable003471">Stable:</a></b></dt><dd>ICU 2.8 </dd></dl>
</div>
</div><p>
<a class="anchor" name="8f53ee3cc98fa66e52f8f3b89f548e96"></a><!-- doxytag: member="ParagraphLayout::Line::getVisualRun" ref="8f53ee3cc98fa66e52f8f3b89f548e96" args="(le_int32 runIndex) const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classParagraphLayout_1_1VisualRun.html">VisualRun</a>* ParagraphLayout::Line::getVisualRun </td>
<td>(</td>
<td class="paramtype"><a class="el" href="LETypes_8h.html#3ae79f31399d76e3055d2a2745bd0d9a">le_int32</a> </td>
<td class="paramname"> <em>runIndex</em> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get a <code><a class="el" href="classParagraphLayout_1_1VisualRun.html">ParagraphLayout::VisualRun</a></code> object for a given visual run in the line.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>runIndex</em> </td><td>is the index of the run, in visual order.</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the <code><a class="el" href="classParagraphLayout_1_1VisualRun.html">ParagraphLayout::VisualRun</a></code> object representing the visual run. This object is owned by the <code><a class="el" href="classParagraphLayout_1_1Line.html">Line</a></code> object which created it, and will remain valid for as long as the <code><a class="el" href="classParagraphLayout_1_1Line.html">Line</a></code> object is valid.</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classParagraphLayout_1_1VisualRun.html">ParagraphLayout::VisualRun</a></dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable003472">Stable:</a></b></dt><dd>ICU 3.2 </dd></dl>
</div>
</div><p>
<a class="anchor" name="7133cf4733116c9200c02941d6ca0b9e"></a><!-- doxytag: member="ParagraphLayout::Line::getStaticClassID" ref="7133cf4733116c9200c02941d6ca0b9e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="utypes_8h.html#22af10545208a455a6e884008df48e9f">UClassID</a> ParagraphLayout::Line::getStaticClassID </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
ICU "poor man's RTTI", returns a UClassID for this class.
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable003473">Stable:</a></b></dt><dd>ICU 3.2 </dd></dl>
<p>
Definition at line <a class="el" href="ParagraphLayout_8h-source.html#l00145">145</a> of file <a class="el" href="ParagraphLayout_8h-source.html">ParagraphLayout.h</a>.
</div>
</div><p>
<a class="anchor" name="30ebeb777f271f16e74f1fc00cdded54"></a><!-- doxytag: member="ParagraphLayout::Line::getDynamicClassID" ref="30ebeb777f271f16e74f1fc00cdded54" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="utypes_8h.html#22af10545208a455a6e884008df48e9f">UClassID</a> ParagraphLayout::Line::getDynamicClassID </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
ICU "poor man's RTTI", returns a UClassID for the actual class.
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable003474">Stable:</a></b></dt><dd>ICU 3.2 </dd></dl>
<p>
Implements <a class="el" href="classUObject.html#ce1dd31fb2c6f2c07dfebe8fd240ec37">UObject</a>.
<p>
Definition at line <a class="el" href="ParagraphLayout_8h-source.html#l00152">152</a> of file <a class="el" href="ParagraphLayout_8h-source.html">ParagraphLayout.h</a>.
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="ParagraphLayout_8h-source.html">ParagraphLayout.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Fri Sep 14 12:59:43 2007 for ICU 3.8 by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.1 </small></address>
</body>
</html>
