<!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 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> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">icu::ParagraphLayout Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><a class="el" href="classicu_1_1ParagraphLayout.html" title="ParagraphLayout. ">ParagraphLayout</a>.
<a href="classicu_1_1ParagraphLayout.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:</div>
<div class="dyncontent">
<div class="center">
<img src="classicu_1_1ParagraphLayout.png" usemap="#icu::ParagraphLayout_map" alt=""/>
<map id="icu::ParagraphLayout_map" name="icu::ParagraphLayout_map">
<area href="classicu_1_1UObject.html" title="UObject is the common ICU "boilerplate" class. " alt="icu::UObject" shape="rect" coords="0,56,133,80"/>
<area href="classicu_1_1UMemory.html" title="UMemory is the common ICU base class. " alt="icu::UMemory" shape="rect" coords="0,0,133,24"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1ParagraphLayout_1_1Line.html">Line</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">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><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1ParagraphLayout_1_1VisualRun.html">VisualRun</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">This object represents a single visual run in a line of text in a paragraph. <a href="classicu_1_1ParagraphLayout_1_1VisualRun.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><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:a96dbc659bf4e0e357eb469122be782d8"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1ParagraphLayout.html#a96dbc659bf4e0e357eb469122be782d8">ParagraphLayout</a> (const LEUnicode chars[], le_int32 count, const <a class="el" href="classicu_1_1FontRuns.html">FontRuns</a> *fontRuns, const <a class="el" href="classicu_1_1ValueRuns.html">ValueRuns</a> *levelRuns, const <a class="el" href="classicu_1_1ValueRuns.html">ValueRuns</a> *scriptRuns, const <a class="el" href="classicu_1_1LocaleRuns.html">LocaleRuns</a> *localeRuns, <a class="el" href="ubidi_8h.html#ab2460a19f323ab9787a79a95db91a606">UBiDiLevel</a> paragraphLevel, le_bool vertical, LEErrorCode &status)</td></tr>
<tr class="memdesc:a96dbc659bf4e0e357eb469122be782d8"><td class="mdescLeft"> </td><td class="mdescRight">Construct a <code><a class="el" href="classicu_1_1ParagraphLayout.html" title="ParagraphLayout. ">ParagraphLayout</a></code> object for a styled paragraph. <a href="#a96dbc659bf4e0e357eb469122be782d8">More...</a><br /></td></tr>
<tr class="separator:a96dbc659bf4e0e357eb469122be782d8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4b0b923b3f254551e5c1d4e799c5d62d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1ParagraphLayout.html#a4b0b923b3f254551e5c1d4e799c5d62d">~ParagraphLayout</a> ()</td></tr>
<tr class="memdesc:a4b0b923b3f254551e5c1d4e799c5d62d"><td class="mdescLeft"> </td><td class="mdescRight">The destructor. <a href="#a4b0b923b3f254551e5c1d4e799c5d62d">More...</a><br /></td></tr>
<tr class="separator:a4b0b923b3f254551e5c1d4e799c5d62d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa0216b8a157da8abc4abedf4a7749b4b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="ubidi_8h.html#ab2460a19f323ab9787a79a95db91a606">UBiDiLevel</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1ParagraphLayout.html#aa0216b8a157da8abc4abedf4a7749b4b">getParagraphLevel</a> ()</td></tr>
<tr class="memdesc:aa0216b8a157da8abc4abedf4a7749b4b"><td class="mdescLeft"> </td><td class="mdescRight">Return the resolved paragraph level. <a href="#aa0216b8a157da8abc4abedf4a7749b4b">More...</a><br /></td></tr>
<tr class="separator:aa0216b8a157da8abc4abedf4a7749b4b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a915a9bc838490f8cefd717c5bb09ad84"><td class="memItemLeft" align="right" valign="top"><a class="el" href="ubidi_8h.html#a68a6b5fdcbf80aaa51b5bd39f7f31102">UBiDiDirection</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1ParagraphLayout.html#a915a9bc838490f8cefd717c5bb09ad84">getTextDirection</a> ()</td></tr>
<tr class="memdesc:a915a9bc838490f8cefd717c5bb09ad84"><td class="mdescLeft"> </td><td class="mdescRight">Return the directionality of the text in the paragraph. <a href="#a915a9bc838490f8cefd717c5bb09ad84">More...</a><br /></td></tr>
<tr class="separator:a915a9bc838490f8cefd717c5bb09ad84"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac8adf63b2053daf56988adac9f6ca4f7"><td class="memItemLeft" align="right" valign="top">virtual le_int32 </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1ParagraphLayout.html#ac8adf63b2053daf56988adac9f6ca4f7">getAscent</a> () const </td></tr>
<tr class="memdesc:ac8adf63b2053daf56988adac9f6ca4f7"><td class="mdescLeft"> </td><td class="mdescRight">Return the max ascent value for all the fonts in the paragraph. <a href="#ac8adf63b2053daf56988adac9f6ca4f7">More...</a><br /></td></tr>
<tr class="separator:ac8adf63b2053daf56988adac9f6ca4f7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a69d1d17477adc8ab80cc35e738666dd9"><td class="memItemLeft" align="right" valign="top">virtual le_int32 </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1ParagraphLayout.html#a69d1d17477adc8ab80cc35e738666dd9">getDescent</a> () const </td></tr>
<tr class="memdesc:a69d1d17477adc8ab80cc35e738666dd9"><td class="mdescLeft"> </td><td class="mdescRight">Return the max descent value for all the fonts in the paragraph. <a href="#a69d1d17477adc8ab80cc35e738666dd9">More...</a><br /></td></tr>
<tr class="separator:a69d1d17477adc8ab80cc35e738666dd9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8b2877c64e7390e62a47a477a544e310"><td class="memItemLeft" align="right" valign="top">virtual le_int32 </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1ParagraphLayout.html#a8b2877c64e7390e62a47a477a544e310">getLeading</a> () const </td></tr>
<tr class="memdesc:a8b2877c64e7390e62a47a477a544e310"><td class="mdescLeft"> </td><td class="mdescRight">Return the max leading value for all the fonts in the paragraph. <a href="#a8b2877c64e7390e62a47a477a544e310">More...</a><br /></td></tr>
<tr class="separator:a8b2877c64e7390e62a47a477a544e310"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afc35c9d57ff860dd4964d1e6c41132dc"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1ParagraphLayout.html#afc35c9d57ff860dd4964d1e6c41132dc">reflow</a> ()</td></tr>
<tr class="memdesc:afc35c9d57ff860dd4964d1e6c41132dc"><td class="mdescLeft"> </td><td class="mdescRight">Reset line breaking to start from the beginning of the paragraph. <a href="#afc35c9d57ff860dd4964d1e6c41132dc">More...</a><br /></td></tr>
<tr class="separator:afc35c9d57ff860dd4964d1e6c41132dc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a41e2c834373071f29337c5025b62d09d"><td class="memItemLeft" align="right" valign="top">le_bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1ParagraphLayout.html#a41e2c834373071f29337c5025b62d09d">isDone</a> () const </td></tr>
<tr class="memdesc:a41e2c834373071f29337c5025b62d09d"><td class="mdescLeft"> </td><td class="mdescRight">Convenience method for determining if paragraph layout processing is complete ( i.e. <a href="#a41e2c834373071f29337c5025b62d09d">More...</a><br /></td></tr>
<tr class="separator:a41e2c834373071f29337c5025b62d09d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a565a74fccbd54f6567e79e0c02d6f0a0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classicu_1_1ParagraphLayout_1_1Line.html">Line</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1ParagraphLayout.html#a565a74fccbd54f6567e79e0c02d6f0a0">nextLine</a> (float width)</td></tr>
<tr class="memdesc:a565a74fccbd54f6567e79e0c02d6f0a0"><td class="mdescLeft"> </td><td class="mdescRight">Return a <code><a class="el" href="classicu_1_1ParagraphLayout_1_1Line.html" title="This class represents a single line of text in a ParagraphLayout. ">ParagraphLayout::Line</a></code> object which represents next line in the paragraph. <a href="#a565a74fccbd54f6567e79e0c02d6f0a0">More...</a><br /></td></tr>
<tr class="separator:a565a74fccbd54f6567e79e0c02d6f0a0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2dd8c6db4d88cfd3c606f39f7c919ec2"><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.html#a2dd8c6db4d88cfd3c606f39f7c919ec2">getDynamicClassID</a> () const </td></tr>
<tr class="memdesc:a2dd8c6db4d88cfd3c606f39f7c919ec2"><td class="mdescLeft"> </td><td class="mdescRight">ICU "poor man's RTTI", returns a UClassID for the actual class. <a href="#a2dd8c6db4d88cfd3c606f39f7c919ec2">More...</a><br /></td></tr>
<tr class="separator:a2dd8c6db4d88cfd3c606f39f7c919ec2"><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:a7c7699ccdb1e221d2a787537f57d9ae3"><td class="memItemLeft" align="right" valign="top">static le_bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1ParagraphLayout.html#a7c7699ccdb1e221d2a787537f57d9ae3">isComplex</a> (const LEUnicode chars[], le_int32 count)</td></tr>
<tr class="memdesc:a7c7699ccdb1e221d2a787537f57d9ae3"><td class="mdescLeft"> </td><td class="mdescRight">Examine the given text and determine if it contains characters in any script which requires complex processing to be rendered correctly. <a href="#a7c7699ccdb1e221d2a787537f57d9ae3">More...</a><br /></td></tr>
<tr class="separator:a7c7699ccdb1e221d2a787537f57d9ae3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a33fe6994f8e392d83a6846fc819be750"><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.html#a33fe6994f8e392d83a6846fc819be750">getStaticClassID</a> ()</td></tr>
<tr class="memdesc:a33fe6994f8e392d83a6846fc819be750"><td class="mdescLeft"> </td><td class="mdescRight">ICU "poor man's RTTI", returns a UClassID for this class. <a href="#a33fe6994f8e392d83a6846fc819be750">More...</a><br /></td></tr>
<tr class="separator:a33fe6994f8e392d83a6846fc819be750"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classicu_1_1ParagraphLayout.html" title="ParagraphLayout. ">ParagraphLayout</a>. </p>
<p>The <code><a class="el" href="classicu_1_1ParagraphLayout.html" title="ParagraphLayout. ">ParagraphLayout</a></code> object will analyze the text into runs of text in the same font, script and direction, and will create a <code>LayoutEngine</code> object for each run. The <code>LayoutEngine</code> will transform the characters into glyph codes in visual order.</p>
<p>Clients can use this to break a paragraph into lines, and to display the glyphs in each line.</p>
<p>Note that <a class="el" href="">icu::LayoutEngine</a> is deprecated, but this class is not. You may use this class with the HarfBuzz icu-le-hb wrapper, see <a href="http://www.freedesktop.org/wiki/Software/HarfBuzz/">http://www.freedesktop.org/wiki/Software/HarfBuzz/</a></p>
<p>See <a href="http://userguide.icu-project.org/layoutengine">http://userguide.icu-project.org/layoutengine</a> for special build instructions.</p>
<dl class="section see"><dt>See also</dt><dd>icu::LayoutEngine </dd></dl>
<p>Definition at line <a class="el" href="ParagraphLayout_8h_source.html#l00053">53</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="a96dbc659bf4e0e357eb469122be782d8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">icu::ParagraphLayout::ParagraphLayout </td>
<td>(</td>
<td class="paramtype">const LEUnicode </td>
<td class="paramname"><em>chars</em>[], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">le_int32 </td>
<td class="paramname"><em>count</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classicu_1_1FontRuns.html">FontRuns</a> * </td>
<td class="paramname"><em>fontRuns</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classicu_1_1ValueRuns.html">ValueRuns</a> * </td>
<td class="paramname"><em>levelRuns</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classicu_1_1ValueRuns.html">ValueRuns</a> * </td>
<td class="paramname"><em>scriptRuns</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classicu_1_1LocaleRuns.html">LocaleRuns</a> * </td>
<td class="paramname"><em>localeRuns</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="ubidi_8h.html#ab2460a19f323ab9787a79a95db91a606">UBiDiLevel</a> </td>
<td class="paramname"><em>paragraphLevel</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">le_bool </td>
<td class="paramname"><em>vertical</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">LEErrorCode & </td>
<td class="paramname"><em>status</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct a <code><a class="el" href="classicu_1_1ParagraphLayout.html" title="ParagraphLayout. ">ParagraphLayout</a></code> object for a styled paragraph. </p>
<p>The paragraph is specified as runs of text all in the same font. An <code>LEFontInstance</code> object and a limit offset are specified for each font run. The limit offset is the offset of the character immediately after the font run.</p>
<p>Clients can optionally specify directional runs and / or script runs. If these aren't specified they will be computed.</p>
<p>If any errors are encountered during construction, <code>status</code> will be set, and the object will be set to be empty.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">chars</td><td>is an array of the characters in the paragraph</td></tr>
<tr><td class="paramname">count</td><td>is the number of characters in the paragraph.</td></tr>
<tr><td class="paramname">fontRuns</td><td>a pointer to a <code><a class="el" href="classicu_1_1FontRuns.html" title="The FontRuns class associates pointers to LEFontInstance objects with runs of text. ">FontRuns</a></code> object representing the font runs.</td></tr>
<tr><td class="paramname">levelRuns</td><td>is a pointer to a <code><a class="el" href="classicu_1_1ValueRuns.html" title="The ValueRuns class associates integer values with runs of text. ">ValueRuns</a></code> object representing the directional levels. If this pointer in <code>NULL</code> the levels will be determined by running the Unicde Bidi algorithm.</td></tr>
<tr><td class="paramname">scriptRuns</td><td>is a pointer to a <code><a class="el" href="classicu_1_1ValueRuns.html" title="The ValueRuns class associates integer values with runs of text. ">ValueRuns</a></code> object representing script runs. If this pointer in <code>NULL</code> the script runs will be determined using the Unicode code points.</td></tr>
<tr><td class="paramname">localeRuns</td><td>is a pointer to a <code><a class="el" href="classicu_1_1LocaleRuns.html" title="The LocaleRuns class associates pointers to Locale objects with runs of text. ">LocaleRuns</a></code> object representing locale runs. The <code><a class="el" href="classicu_1_1Locale.html" title="A Locale object represents a specific geographical, political, or cultural region. ">Locale</a></code> objects are used to determind the language of the text. If this pointer is <code>NULL</code> the default locale will be used for all of the text.</td></tr>
<tr><td class="paramname">paragraphLevel</td><td>is the directionality of the paragraph, as in the UBiDi object.</td></tr>
<tr><td class="paramname">vertical</td><td>is <code>TRUE</code> if the paragraph should be set vertically.</td></tr>
<tr><td class="paramname">status</td><td>will be set to any error code encountered during construction.</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="ubidi_8h.html" title="C API: Bidi algorithm. ">ubidi.h</a> </dd>
<dd>
LEFontInstance.h </dd>
<dd>
LayoutEngine.h </dd>
<dd>
<a class="el" href="RunArrays_8h.html" title="C++ API: base class for building classes which represent data that is associated with runs of text...">RunArrays.h</a></dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005726">Stable:</a></b></dt><dd>ICU 2.8 </dd></dl>
</div>
</div>
<a class="anchor" id="a4b0b923b3f254551e5c1d4e799c5d62d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">icu::ParagraphLayout::~ParagraphLayout </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>The destructor. </p>
<p>Virtual so that it works correctly with sublcasses.</p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005727">Stable:</a></b></dt><dd>ICU 3.2 </dd></dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="ac8adf63b2053daf56988adac9f6ca4f7"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual le_int32 icu::ParagraphLayout::getAscent </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">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the max ascent value for all the fonts in the paragraph. </p>
<dl class="section return"><dt>Returns</dt><dd>the ascent value.</dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005731">Stable:</a></b></dt><dd>ICU 3.2 </dd></dl>
</div>
</div>
<a class="anchor" id="a69d1d17477adc8ab80cc35e738666dd9"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual le_int32 icu::ParagraphLayout::getDescent </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">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the max descent value for all the fonts in the paragraph. </p>
<dl class="section return"><dt>Returns</dt><dd>the decent value.</dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005732">Stable:</a></b></dt><dd>ICU 3.2 </dd></dl>
</div>
</div>
<a class="anchor" id="a2dd8c6db4d88cfd3c606f39f7c919ec2"></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::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#_stable005737">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#l00555">555</a> of file <a class="el" href="ParagraphLayout_8h_source.html">ParagraphLayout.h</a>.</p>
</div>
</div>
<a class="anchor" id="a8b2877c64e7390e62a47a477a544e310"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual le_int32 icu::ParagraphLayout::getLeading </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">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the max leading value for all the fonts in the paragraph. </p>
<dl class="section return"><dt>Returns</dt><dd>the leading value.</dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005733">Stable:</a></b></dt><dd>ICU 3.2 </dd></dl>
</div>
</div>
<a class="anchor" id="aa0216b8a157da8abc4abedf4a7749b4b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="ubidi_8h.html#ab2460a19f323ab9787a79a95db91a606">UBiDiLevel</a> icu::ParagraphLayout::getParagraphLevel </td>
<td>(</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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the resolved paragraph level. </p>
<p>This is useful for those cases where the bidi analysis has determined the level based on the first strong character in the paragraph.</p>
<dl class="section return"><dt>Returns</dt><dd>the resolved paragraph level.</dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005729">Stable:</a></b></dt><dd>ICU 3.2 </dd></dl>
<p>Definition at line <a class="el" href="ParagraphLayout_8h_source.html#l00650">650</a> of file <a class="el" href="ParagraphLayout_8h_source.html">ParagraphLayout.h</a>.</p>
<p>References <a class="el" href="ubidi_8h.html#a6724e673e9ff8f0ee47bd24e47ceb95a">ubidi_getParaLevel()</a>.</p>
</div>
</div>
<a class="anchor" id="a33fe6994f8e392d83a6846fc819be750"></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::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#_stable005736">Stable:</a></b></dt><dd>ICU 3.2 </dd></dl>
<p>Definition at line <a class="el" href="ParagraphLayout_8h_source.html#l00548">548</a> of file <a class="el" href="ParagraphLayout_8h_source.html">ParagraphLayout.h</a>.</p>
</div>
</div>
<a class="anchor" id="a915a9bc838490f8cefd717c5bb09ad84"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="ubidi_8h.html#a68a6b5fdcbf80aaa51b5bd39f7f31102">UBiDiDirection</a> icu::ParagraphLayout::getTextDirection </td>
<td>(</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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the directionality of the text in the paragraph. </p>
<dl class="section return"><dt>Returns</dt><dd><code>UBIDI_LTR</code> if the text is all left to right, <code>UBIDI_RTL</code> if the text is all right to left, or <code>UBIDI_MIXED</code> if the text has mixed direction.</dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005730">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>.</p>
<p>References <a class="el" href="ubidi_8h.html#af31ec52194764c663c224f5171e95ea3">ubidi_getDirection()</a>.</p>
</div>
</div>
<a class="anchor" id="a7c7699ccdb1e221d2a787537f57d9ae3"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static le_bool icu::ParagraphLayout::isComplex </td>
<td>(</td>
<td class="paramtype">const LEUnicode </td>
<td class="paramname"><em>chars</em>[], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">le_int32 </td>
<td class="paramname"><em>count</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Examine the given text and determine if it contains characters in any script which requires complex processing to be rendered correctly. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">chars</td><td>is an array of the characters in the paragraph</td></tr>
<tr><td class="paramname">count</td><td>is the number of characters in the paragraph.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>TRUE</code> if any of the text requires complex processing.</dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005728">Stable:</a></b></dt><dd>ICU 3.2 </dd></dl>
</div>
</div>
<a class="anchor" id="a41e2c834373071f29337c5025b62d09d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">le_bool icu::ParagraphLayout::isDone </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>Convenience method for determining if paragraph layout processing is complete ( i.e. </p>
<p>there are no more lines left to process. )</p>
<dl class="section return"><dt>Returns</dt><dd>true if there are no more lines to be processed</dd></dl>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000495">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>
</div>
</div>
<a class="anchor" id="a565a74fccbd54f6567e79e0c02d6f0a0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classicu_1_1ParagraphLayout_1_1Line.html">Line</a>* icu::ParagraphLayout::nextLine </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>width</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return a <code><a class="el" href="classicu_1_1ParagraphLayout_1_1Line.html" title="This class represents a single line of text in a ParagraphLayout. ">ParagraphLayout::Line</a></code> object which represents next line in the paragraph. </p>
<p>The width of the line is specified each time so that it can be varied to support arbitrary paragraph shapes.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">width</td><td>is the width of the line. If <code>width</code> is less than or equal to zero, a <code><a class="el" href="classicu_1_1ParagraphLayout_1_1Line.html" title="This class represents a single line of text in a ParagraphLayout. ">ParagraphLayout::Line</a></code> object representing the rest of the paragraph will be returned.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a <code><a class="el" href="classicu_1_1ParagraphLayout_1_1Line.html" title="This class represents a single line of text in a ParagraphLayout. ">ParagraphLayout::Line</a></code> object which represents the line. The caller is responsible for deleting the object. Returns <code>NULL</code> if there are no more lines in the paragraph.</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classicu_1_1ParagraphLayout_1_1Line.html" title="This class represents a single line of text in a ParagraphLayout. ">ParagraphLayout::Line</a></dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005735">Stable:</a></b></dt><dd>ICU 3.2 </dd></dl>
</div>
</div>
<a class="anchor" id="afc35c9d57ff860dd4964d1e6c41132dc"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void icu::ParagraphLayout::reflow </td>
<td>(</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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reset line breaking to start from the beginning of the paragraph. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable005734">Stable:</a></b></dt><dd>ICU 3.2 </dd></dl>
<p>Definition at line <a class="el" href="ParagraphLayout_8h_source.html#l00660">660</a> of file <a class="el" href="ParagraphLayout_8h_source.html">ParagraphLayout.h</a>.</p>
<p>References <a class="el" href="utypes_8h_source.html#l00188">NULL</a>.</p>
</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>
distrib
>
Mageia
>
6
>
armv5tl
>
media
>
core-release
>
by-pkgid
>
3a4e91bde08970529a0aa07935652fe8
>
files
>
202
