<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.11"/> <title>ICU 58.2: icu::ParagraphLayout::Line Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td id="projectalign" style="padding-left: 0.5em;"> <div id="projectname">ICU 58.2  <span id="projectnumber">58.2</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.11 --> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="annotated.html"><span>Data Structures</span></a></li> <li><a href="files.html"><span>Files</span></a></li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="annotated.html"><span>Data Structures</span></a></li> <li><a href="classes.html"><span>Data Structure Index</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 id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="namespaceicu.html">icu</a></li><li class="navelem"><a class="el" href="classicu_1_1ParagraphLayout.html">ParagraphLayout</a></li><li class="navelem"><a class="el" href="classicu_1_1ParagraphLayout_1_1Line.html">Line</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="#pub-static-methods">Static Public Member Functions</a> | <a href="#friends">Friends</a> </div> <div class="headertitle"> <div class="title">icu::ParagraphLayout::Line Class Reference</div> </div> </div><!--header--> <div class="contents"> <p>This class represents a single line of text in a <code><a class="el" href="classicu_1_1ParagraphLayout.html" title="ParagraphLayout. ">ParagraphLayout</a></code>. <a href="classicu_1_1ParagraphLayout_1_1Line.html#details">More...</a></p> <p><code>#include <<a class="el" href="ParagraphLayout_8h_source.html">ParagraphLayout.h</a>></code></p> <div class="dynheader"> Inheritance diagram for icu::ParagraphLayout::Line:</div> <div class="dyncontent"> <div class="center"> <img src="classicu_1_1ParagraphLayout_1_1Line.png" usemap="#icu::ParagraphLayout::Line_map" alt=""/> <map id="icu::ParagraphLayout::Line_map" name="icu::ParagraphLayout::Line_map"> <area href="classicu_1_1UObject.html" title="UObject is the common ICU "boilerplate" class. " alt="icu::UObject" shape="rect" coords="0,56,163,80"/> <area href="classicu_1_1UMemory.html" title="UMemory is the common ICU base class. " alt="icu::UMemory" shape="rect" coords="0,0,163,24"/> </map> </div></div> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr class="memitem:a18e93cd1d325bd5672f3c1135940d35e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1ParagraphLayout_1_1Line.html#a18e93cd1d325bd5672f3c1135940d35e">~Line</a> ()</td></tr> <tr class="memdesc:a18e93cd1d325bd5672f3c1135940d35e"><td class="mdescLeft"> </td><td class="mdescRight">The constructor is private since these objects can only be created by <code><a class="el" href="classicu_1_1ParagraphLayout.html" title="ParagraphLayout. ">ParagraphLayout</a></code>. <a href="#a18e93cd1d325bd5672f3c1135940d35e">More...</a><br /></td></tr> <tr class="separator:a18e93cd1d325bd5672f3c1135940d35e"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ae7204d4104faf48ed38e8914ccf28d6a"><td class="memItemLeft" align="right" valign="top">le_int32 </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1ParagraphLayout_1_1Line.html#ae7204d4104faf48ed38e8914ccf28d6a">countRuns</a> () const </td></tr> <tr class="memdesc:ae7204d4104faf48ed38e8914ccf28d6a"><td class="mdescLeft"> </td><td class="mdescRight">Count the number of visual runs in the line. <a href="#ae7204d4104faf48ed38e8914ccf28d6a">More...</a><br /></td></tr> <tr class="separator:ae7204d4104faf48ed38e8914ccf28d6a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ab5214f276a0754633b488197897e1963"><td class="memItemLeft" align="right" valign="top">le_int32 </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1ParagraphLayout_1_1Line.html#ab5214f276a0754633b488197897e1963">getAscent</a> () const </td></tr> <tr class="memdesc:ab5214f276a0754633b488197897e1963"><td class="mdescLeft"> </td><td class="mdescRight">Get the ascent of the line. <a href="#ab5214f276a0754633b488197897e1963">More...</a><br /></td></tr> <tr class="separator:ab5214f276a0754633b488197897e1963"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a1204cb1202920c78925eee1e0676c966"><td class="memItemLeft" align="right" valign="top">le_int32 </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1ParagraphLayout_1_1Line.html#a1204cb1202920c78925eee1e0676c966">getDescent</a> () const </td></tr> <tr class="memdesc:a1204cb1202920c78925eee1e0676c966"><td class="mdescLeft"> </td><td class="mdescRight">Get the descent of the line. <a href="#a1204cb1202920c78925eee1e0676c966">More...</a><br /></td></tr> <tr class="separator:a1204cb1202920c78925eee1e0676c966"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a9283321b91c8a041e3cf73a3b42f44dd"><td class="memItemLeft" align="right" valign="top">le_int32 </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1ParagraphLayout_1_1Line.html#a9283321b91c8a041e3cf73a3b42f44dd">getLeading</a> () const </td></tr> <tr class="memdesc:a9283321b91c8a041e3cf73a3b42f44dd"><td class="mdescLeft"> </td><td class="mdescRight">Get the leading of the line. <a href="#a9283321b91c8a041e3cf73a3b42f44dd">More...</a><br /></td></tr> <tr class="separator:a9283321b91c8a041e3cf73a3b42f44dd"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a644aed0f4256582f4fca118766350dd0"><td class="memItemLeft" align="right" valign="top">le_int32 </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1ParagraphLayout_1_1Line.html#a644aed0f4256582f4fca118766350dd0">getWidth</a> () const </td></tr> <tr class="memdesc:a644aed0f4256582f4fca118766350dd0"><td class="mdescLeft"> </td><td class="mdescRight">Get the width of the line. <a href="#a644aed0f4256582f4fca118766350dd0">More...</a><br /></td></tr> <tr class="separator:a644aed0f4256582f4fca118766350dd0"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a66e582883b5f3da14e084d55f648d24c"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classicu_1_1ParagraphLayout_1_1VisualRun.html">VisualRun</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1ParagraphLayout_1_1Line.html#a66e582883b5f3da14e084d55f648d24c">getVisualRun</a> (le_int32 runIndex) const </td></tr> <tr class="memdesc:a66e582883b5f3da14e084d55f648d24c"><td class="mdescLeft"> </td><td class="mdescRight">Get a <code><a class="el" href="classicu_1_1ParagraphLayout_1_1VisualRun.html" title="This object represents a single visual run in a line of text in a paragraph. ">ParagraphLayout::VisualRun</a></code> object for a given visual run in the line. <a href="#a66e582883b5f3da14e084d55f648d24c">More...</a><br /></td></tr> <tr class="separator:a66e582883b5f3da14e084d55f648d24c"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a6c8e688c5998de9563de9536d8267383"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="uobject_8h.html#a22af10545208a455a6e884008df48e9f">UClassID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1ParagraphLayout_1_1Line.html#a6c8e688c5998de9563de9536d8267383">getDynamicClassID</a> () const </td></tr> <tr class="memdesc:a6c8e688c5998de9563de9536d8267383"><td class="mdescLeft"> </td><td class="mdescRight">ICU "poor man's RTTI", returns a UClassID for the actual class. <a href="#a6c8e688c5998de9563de9536d8267383">More...</a><br /></td></tr> <tr class="separator:a6c8e688c5998de9563de9536d8267383"><td class="memSeparator" colspan="2"> </td></tr> <tr class="inherit_header pub_methods_classicu_1_1UObject"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classicu_1_1UObject')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classicu_1_1UObject.html">icu::UObject</a></td></tr> <tr class="memitem:af10026497704f510d3d1f2eff50acb18 inherit pub_methods_classicu_1_1UObject"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1UObject.html#af10026497704f510d3d1f2eff50acb18">~UObject</a> ()</td></tr> <tr class="memdesc:af10026497704f510d3d1f2eff50acb18 inherit pub_methods_classicu_1_1UObject"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#af10026497704f510d3d1f2eff50acb18">More...</a><br /></td></tr> <tr class="separator:af10026497704f510d3d1f2eff50acb18 inherit pub_methods_classicu_1_1UObject"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a> Static Public Member Functions</h2></td></tr> <tr class="memitem:a7a3a82759edd2b5e743602bd85ccc918"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="uobject_8h.html#a22af10545208a455a6e884008df48e9f">UClassID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1ParagraphLayout_1_1Line.html#a7a3a82759edd2b5e743602bd85ccc918">getStaticClassID</a> ()</td></tr> <tr class="memdesc:a7a3a82759edd2b5e743602bd85ccc918"><td class="mdescLeft"> </td><td class="mdescRight">ICU "poor man's RTTI", returns a UClassID for this class. <a href="#a7a3a82759edd2b5e743602bd85ccc918">More...</a><br /></td></tr> <tr class="separator:a7a3a82759edd2b5e743602bd85ccc918"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a> Friends</h2></td></tr> <tr class="memitem:aefa8892424f624336802e05074701eeb"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aefa8892424f624336802e05074701eeb"></a> class </td><td class="memItemRight" valign="bottom"><b>ParagraphLayout</b></td></tr> <tr class="separator:aefa8892424f624336802e05074701eeb"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>This class represents a single line of text in a <code><a class="el" href="classicu_1_1ParagraphLayout.html" title="ParagraphLayout. ">ParagraphLayout</a></code>. </p> <p>They can only be created by calling <code><a class="el" href="classicu_1_1ParagraphLayout.html#a565a74fccbd54f6567e79e0c02d6f0a0" title="Return a ParagraphLayout::Line object which represents next line in the paragraph. ">ParagraphLayout::nextLine()</a></code>. Each line consists of multiple visual runs, represented by <code><a class="el" href="classicu_1_1ParagraphLayout_1_1VisualRun.html" title="This object represents a single visual run in a line of text in a paragraph. ">ParagraphLayout::VisualRun</a></code> objects.</p> <dl class="section see"><dt>See also</dt><dd><a class="el" href="classicu_1_1ParagraphLayout.html" title="ParagraphLayout. ">ParagraphLayout</a> </dd> <dd> <a class="el" href="classicu_1_1ParagraphLayout_1_1VisualRun.html" title="This object represents a single visual run in a line of text in a paragraph. ">ParagraphLayout::VisualRun</a></dd></dl> <dl class="stable"><dt><b><a class="el" href="stable.html#_stable005724">Stable:</a></b></dt><dd>ICU 3.2 </dd></dl> <p>Definition at line <a class="el" href="ParagraphLayout_8h_source.html#l00069">69</a> of file <a class="el" href="ParagraphLayout_8h_source.html">ParagraphLayout.h</a>.</p> </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> <a class="anchor" id="a18e93cd1d325bd5672f3c1135940d35e"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">icu::ParagraphLayout::Line::~Line </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></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="classicu_1_1ParagraphLayout.html" title="ParagraphLayout. ">ParagraphLayout</a></code>. </p> <p>However, it is the clients responsibility to destroy the objects, so the destructor is public.</p> <dl class="stable"><dt><b><a class="el" href="stable.html#_stable005738">Stable:</a></b></dt><dd>ICU 3.2 </dd></dl> </div> </div> <h2 class="groupheader">Member Function Documentation</h2> <a class="anchor" id="ae7204d4104faf48ed38e8914ccf28d6a"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">le_int32 icu::ParagraphLayout::Line::countRuns </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Count the number of visual runs in the line. </p> <dl class="section return"><dt>Returns</dt><dd>the number of visual runs.</dd></dl> <dl class="stable"><dt><b><a class="el" href="stable.html#_stable005739">Stable:</a></b></dt><dd>ICU 3.2 </dd></dl> <p>Definition at line <a class="el" href="ParagraphLayout_8h_source.html#l00677">677</a> of file <a class="el" href="ParagraphLayout_8h_source.html">ParagraphLayout.h</a>.</p> </div> </div> <a class="anchor" id="ab5214f276a0754633b488197897e1963"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">le_int32 icu::ParagraphLayout::Line::getAscent </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </div><div class="memdoc"> <p>Get the ascent of the line. </p> <p>This is the maximum ascent of all the fonts on the line.</p> <dl class="section return"><dt>Returns</dt><dd>the ascent of the line.</dd></dl> <dl class="stable"><dt><b><a class="el" href="stable.html#_stable005740">Stable:</a></b></dt><dd>ICU 3.2 </dd></dl> </div> </div> <a class="anchor" id="a1204cb1202920c78925eee1e0676c966"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">le_int32 icu::ParagraphLayout::Line::getDescent </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </div><div class="memdoc"> <p>Get the descent of the line. </p> <p>This is the maximum descent of all the fonts on the line.</p> <dl class="section return"><dt>Returns</dt><dd>the descent of the line.</dd></dl> <dl class="stable"><dt><b><a class="el" href="stable.html#_stable005741">Stable:</a></b></dt><dd>ICU 3.2 </dd></dl> </div> </div> <a class="anchor" id="a6c8e688c5998de9563de9536d8267383"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual <a class="el" href="uobject_8h.html#a22af10545208a455a6e884008df48e9f">UClassID</a> icu::ParagraphLayout::Line::getDynamicClassID </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>ICU "poor man's RTTI", returns a UClassID for the actual class. </p> <dl class="stable"><dt><b><a class="el" href="stable.html#_stable005746">Stable:</a></b></dt><dd>ICU 3.2 </dd></dl> <p>Reimplemented from <a class="el" href="classicu_1_1UObject.html#a1aa93096e880907080b503ff1fb0f8bc">icu::UObject</a>.</p> <p>Definition at line <a class="el" href="ParagraphLayout_8h_source.html#l00161">161</a> of file <a class="el" href="ParagraphLayout_8h_source.html">ParagraphLayout.h</a>.</p> </div> </div> <a class="anchor" id="a9283321b91c8a041e3cf73a3b42f44dd"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">le_int32 icu::ParagraphLayout::Line::getLeading </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </div><div class="memdoc"> <p>Get the leading of the line. </p> <p>This is the maximum leading of all the fonts on the line.</p> <dl class="section return"><dt>Returns</dt><dd>the leading of the line.</dd></dl> <dl class="stable"><dt><b><a class="el" href="stable.html#_stable005742">Stable:</a></b></dt><dd>ICU 3.2 </dd></dl> </div> </div> <a class="anchor" id="a7a3a82759edd2b5e743602bd85ccc918"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">static <a class="el" href="uobject_8h.html#a22af10545208a455a6e884008df48e9f">UClassID</a> icu::ParagraphLayout::Line::getStaticClassID </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>ICU "poor man's RTTI", returns a UClassID for this class. </p> <dl class="stable"><dt><b><a class="el" href="stable.html#_stable005745">Stable:</a></b></dt><dd>ICU 3.2 </dd></dl> <p>Definition at line <a class="el" href="ParagraphLayout_8h_source.html#l00154">154</a> of file <a class="el" href="ParagraphLayout_8h_source.html">ParagraphLayout.h</a>.</p> </div> </div> <a class="anchor" id="a66e582883b5f3da14e084d55f648d24c"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const <a class="el" href="classicu_1_1ParagraphLayout_1_1VisualRun.html">VisualRun</a>* icu::ParagraphLayout::Line::getVisualRun </td> <td>(</td> <td class="paramtype">le_int32 </td> <td class="paramname"><em>runIndex</em></td><td>)</td> <td> const</td> </tr> </table> </div><div class="memdoc"> <p>Get a <code><a class="el" href="classicu_1_1ParagraphLayout_1_1VisualRun.html" title="This object represents a single visual run in a line of text in a paragraph. ">ParagraphLayout::VisualRun</a></code> object for a given visual run in the line. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">runIndex</td><td>is the index of the run, in visual order.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>the <code><a class="el" href="classicu_1_1ParagraphLayout_1_1VisualRun.html" title="This object represents a single visual run in a line of text in a paragraph. ">ParagraphLayout::VisualRun</a></code> object representing the visual run. This object is owned by the <code><a class="el" href="classicu_1_1ParagraphLayout_1_1Line.html" title="This class represents a single line of text in a ParagraphLayout. ">Line</a></code> object which created it, and will remain valid for as long as the <code><a class="el" href="classicu_1_1ParagraphLayout_1_1Line.html" title="This class represents a single line of text in a ParagraphLayout. ">Line</a></code> object is valid.</dd></dl> <dl class="section see"><dt>See also</dt><dd><a class="el" href="classicu_1_1ParagraphLayout_1_1VisualRun.html" title="This object represents a single visual run in a line of text in a paragraph. ">ParagraphLayout::VisualRun</a></dd></dl> <dl class="stable"><dt><b><a class="el" href="stable.html#_stable005744">Stable:</a></b></dt><dd>ICU 3.2 </dd></dl> </div> </div> <a class="anchor" id="a644aed0f4256582f4fca118766350dd0"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">le_int32 icu::ParagraphLayout::Line::getWidth </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </div><div class="memdoc"> <p>Get the width of the line. </p> <p>This is a convenience method which returns the last X position of the last visual run in the line.</p> <dl class="section return"><dt>Returns</dt><dd>the width of the line.</dd></dl> <dl class="stable"><dt><b><a class="el" href="stable.html#_stable005743">Stable:</a></b></dt><dd>ICU 2.8 </dd></dl> </div> </div> <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></li> </ul> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.11 </small></address> </body> </html>