<!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"/>
<title>ICU 4.8.1.1: 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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</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 style="padding-left: 0.5em;">
<div id="projectname">ICU 4.8.1.1
 <span id="projectnumber">4.8.1.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<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 class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</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>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</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">ParagraphLayout Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><a class="el" href="classParagraphLayout.html" title="ParagraphLayout.">ParagraphLayout</a>.
<a href="classParagraphLayout.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 ParagraphLayout:</div>
<div class="dyncontent">
<div class="center">
<img src="classParagraphLayout.png" usemap="#ParagraphLayout_map" alt=""/>
<map id="ParagraphLayout_map" name="ParagraphLayout_map">
<area href="classUObject.html" title="UObject is the common ICU "boilerplate" class." alt="UObject" shape="rect" coords="0,56,110,80"/>
<area href="classUMemory.html" title="UMemory is the common ICU base class." alt="UMemory" shape="rect" coords="0,0,110,24"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><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="classParagraphLayout_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="classParagraphLayout.html" title="ParagraphLayout.">ParagraphLayout</a></code>. <a href="classParagraphLayout_1_1Line.html#details">More...</a><br/></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><b>StyleRunInfo</b></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classParagraphLayout_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="classParagraphLayout_1_1VisualRun.html#details">More...</a><br/></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a7907074382283b025c7bdd04489f902d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classParagraphLayout.html#a7907074382283b025c7bdd04489f902d">ParagraphLayout</a> (const <a class="el" href="LETypes_8h.html#a903cb689308cdef41500411d096a2c2d">LEUnicode</a> chars[], <a class="el" href="LETypes_8h.html#a3ae79f31399d76e3055d2a2745bd0d9a">le_int32</a> count, const <a class="el" href="classFontRuns.html">FontRuns</a> *fontRuns, const <a class="el" href="classValueRuns.html">ValueRuns</a> *levelRuns, const <a class="el" href="classValueRuns.html">ValueRuns</a> *scriptRuns, const <a class="el" href="classLocaleRuns.html">LocaleRuns</a> *localeRuns, <a class="el" href="ubidi_8h.html#ab2460a19f323ab9787a79a95db91a606">UBiDiLevel</a> paragraphLevel, <a class="el" href="LETypes_8h.html#a4b77bc254d0e88fdabffde9c03e6728f">le_bool</a> vertical, <a class="el" href="LETypes_8h.html#a2f75d3bb5abf7f0a71adbf00826e1934">LEErrorCode</a> &status)</td></tr>
<tr class="memdesc:a7907074382283b025c7bdd04489f902d"><td class="mdescLeft"> </td><td class="mdescRight">Construct a <code><a class="el" href="classParagraphLayout.html" title="ParagraphLayout.">ParagraphLayout</a></code> object for a styled paragraph. <a href="#a7907074382283b025c7bdd04489f902d"></a><br/></td></tr>
<tr class="memitem:a3ef387e6749a804b0b4343567ad27961"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classParagraphLayout.html#a3ef387e6749a804b0b4343567ad27961">~ParagraphLayout</a> ()</td></tr>
<tr class="memdesc:a3ef387e6749a804b0b4343567ad27961"><td class="mdescLeft"> </td><td class="mdescRight">The destructor. <a href="#a3ef387e6749a804b0b4343567ad27961"></a><br/></td></tr>
<tr class="memitem:a90f17221c71a4bbb893dc43bf44b8352"><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="classParagraphLayout.html#a90f17221c71a4bbb893dc43bf44b8352">getParagraphLevel</a> ()</td></tr>
<tr class="memdesc:a90f17221c71a4bbb893dc43bf44b8352"><td class="mdescLeft"> </td><td class="mdescRight">Return the resolved paragraph level. <a href="#a90f17221c71a4bbb893dc43bf44b8352"></a><br/></td></tr>
<tr class="memitem:a2a90412e5a4c2465d5068920579137fc"><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="classParagraphLayout.html#a2a90412e5a4c2465d5068920579137fc">getTextDirection</a> ()</td></tr>
<tr class="memdesc:a2a90412e5a4c2465d5068920579137fc"><td class="mdescLeft"> </td><td class="mdescRight">Return the directionality of the text in the paragraph. <a href="#a2a90412e5a4c2465d5068920579137fc"></a><br/></td></tr>
<tr class="memitem:ac107efb21e93bb88d279547cf9ef3a89"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="LETypes_8h.html#a3ae79f31399d76e3055d2a2745bd0d9a">le_int32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classParagraphLayout.html#ac107efb21e93bb88d279547cf9ef3a89">getAscent</a> () const </td></tr>
<tr class="memdesc:ac107efb21e93bb88d279547cf9ef3a89"><td class="mdescLeft"> </td><td class="mdescRight">Return the max ascent value for all the fonts in the paragraph. <a href="#ac107efb21e93bb88d279547cf9ef3a89"></a><br/></td></tr>
<tr class="memitem:a442b8a63149d41f5a9072aae90b39c8f"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="LETypes_8h.html#a3ae79f31399d76e3055d2a2745bd0d9a">le_int32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classParagraphLayout.html#a442b8a63149d41f5a9072aae90b39c8f">getDescent</a> () const </td></tr>
<tr class="memdesc:a442b8a63149d41f5a9072aae90b39c8f"><td class="mdescLeft"> </td><td class="mdescRight">Return the max descent value for all the fonts in the paragraph. <a href="#a442b8a63149d41f5a9072aae90b39c8f"></a><br/></td></tr>
<tr class="memitem:a8aee0a8278e9c7b019748ba04f56e909"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="LETypes_8h.html#a3ae79f31399d76e3055d2a2745bd0d9a">le_int32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classParagraphLayout.html#a8aee0a8278e9c7b019748ba04f56e909">getLeading</a> () const </td></tr>
<tr class="memdesc:a8aee0a8278e9c7b019748ba04f56e909"><td class="mdescLeft"> </td><td class="mdescRight">Return the max leading value for all the fonts in the paragraph. <a href="#a8aee0a8278e9c7b019748ba04f56e909"></a><br/></td></tr>
<tr class="memitem:a437d556bb78f8f31a3167cdebed34697"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classParagraphLayout.html#a437d556bb78f8f31a3167cdebed34697">reflow</a> ()</td></tr>
<tr class="memdesc:a437d556bb78f8f31a3167cdebed34697"><td class="mdescLeft"> </td><td class="mdescRight">Reset line breaking to start from the beginning of the paragraph. <a href="#a437d556bb78f8f31a3167cdebed34697"></a><br/></td></tr>
<tr class="memitem:ac1942a18258dacba2c6383882ec34b3d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="LETypes_8h.html#a4b77bc254d0e88fdabffde9c03e6728f">le_bool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classParagraphLayout.html#ac1942a18258dacba2c6383882ec34b3d">isDone</a> () const </td></tr>
<tr class="memdesc:ac1942a18258dacba2c6383882ec34b3d"><td class="mdescLeft"> </td><td class="mdescRight">Convenience method for determining if paragraph layout processing is complete ( i.e. <a href="#ac1942a18258dacba2c6383882ec34b3d"></a><br/></td></tr>
<tr class="memitem:a232b40ef6d0a565c026bec85890d7b50"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classParagraphLayout_1_1Line.html">Line</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classParagraphLayout.html#a232b40ef6d0a565c026bec85890d7b50">nextLine</a> (float width)</td></tr>
<tr class="memdesc:a232b40ef6d0a565c026bec85890d7b50"><td class="mdescLeft"> </td><td class="mdescRight">Return a <code><a class="el" href="classParagraphLayout_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="#a232b40ef6d0a565c026bec85890d7b50"></a><br/></td></tr>
<tr class="memitem:ac9d732c6f5f630acf85c17d213fb850a"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="utypes_8h.html#a22af10545208a455a6e884008df48e9f">UClassID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classParagraphLayout.html#ac9d732c6f5f630acf85c17d213fb850a">getDynamicClassID</a> () const </td></tr>
<tr class="memdesc:ac9d732c6f5f630acf85c17d213fb850a"><td class="mdescLeft"> </td><td class="mdescRight">ICU "poor man's RTTI", returns a UClassID for the actual class. <a href="#ac9d732c6f5f630acf85c17d213fb850a"></a><br/></td></tr>
<tr class="inherit_header pub_methods_classUObject"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classUObject')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classUObject.html">UObject</a></td></tr>
<tr class="memitem:ace22cf29a90641ef43350deae5bedb85 inherit pub_methods_classUObject"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classUObject.html#ace22cf29a90641ef43350deae5bedb85">~UObject</a> ()</td></tr>
<tr class="memdesc:ace22cf29a90641ef43350deae5bedb85 inherit pub_methods_classUObject"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#ace22cf29a90641ef43350deae5bedb85"></a><br/></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:af1135377e5cb8e87f36b1552c338105a"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="LETypes_8h.html#a4b77bc254d0e88fdabffde9c03e6728f">le_bool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classParagraphLayout.html#af1135377e5cb8e87f36b1552c338105a">isComplex</a> (const <a class="el" href="LETypes_8h.html#a903cb689308cdef41500411d096a2c2d">LEUnicode</a> chars[], <a class="el" href="LETypes_8h.html#a3ae79f31399d76e3055d2a2745bd0d9a">le_int32</a> count)</td></tr>
<tr class="memdesc:af1135377e5cb8e87f36b1552c338105a"><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="#af1135377e5cb8e87f36b1552c338105a"></a><br/></td></tr>
<tr class="memitem:aa2b61f27a4915a526eced0e2b089f182"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="utypes_8h.html#a22af10545208a455a6e884008df48e9f">UClassID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classParagraphLayout.html#aa2b61f27a4915a526eced0e2b089f182">getStaticClassID</a> ()</td></tr>
<tr class="memdesc:aa2b61f27a4915a526eced0e2b089f182"><td class="mdescLeft"> </td><td class="mdescRight">ICU "poor man's RTTI", returns a UClassID for this class. <a href="#aa2b61f27a4915a526eced0e2b089f182"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classParagraphLayout.html" title="ParagraphLayout.">ParagraphLayout</a>. </p>
<p>The <code><a class="el" href="classParagraphLayout.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><a class="el" href="classLayoutEngine.html" title="This is a virtual base class used to do complex text layout.">LayoutEngine</a></code> object for each run. The <code><a class="el" href="classLayoutEngine.html" title="This is a virtual base class used to do complex text layout.">LayoutEngine</a></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>Definition at line <a class="el" href="ParagraphLayout_8h_source.html#l00044">44</a> of file <a class="el" href="ParagraphLayout_8h_source.html">ParagraphLayout.h</a>.</p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a7907074382283b025c7bdd04489f902d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ParagraphLayout::ParagraphLayout </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="LETypes_8h.html#a903cb689308cdef41500411d096a2c2d">LEUnicode</a> </td>
<td class="paramname"><em>chars</em>[], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="LETypes_8h.html#a3ae79f31399d76e3055d2a2745bd0d9a">le_int32</a> </td>
<td class="paramname"><em>count</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classFontRuns.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="classValueRuns.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="classValueRuns.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="classLocaleRuns.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"><a class="el" href="LETypes_8h.html#a4b77bc254d0e88fdabffde9c03e6728f">le_bool</a> </td>
<td class="paramname"><em>vertical</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="LETypes_8h.html#a2f75d3bb5abf7f0a71adbf00826e1934">LEErrorCode</a> & </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="classParagraphLayout.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><a class="el" href="classLEFontInstance.html" title="This is a virtual base class that serves as the interface between a LayoutEngine and the platform fon...">LEFontInstance</a></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="classFontRuns.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="classValueRuns.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="classValueRuns.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="classLocaleRuns.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="classLocale.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>
<a class="el" href="LEFontInstance_8h.html" title="C++ API: Layout Engine Font Instance object.">LEFontInstance.h</a> </dd>
<dd>
<a class="el" href="LayoutEngine_8h.html" title="C++ API: Virtual base class for complex text layout.">LayoutEngine.h</a> </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#_stable004585">Stable:</a></b></dt><dd>ICU 2.8 </dd></dl>
</div>
</div>
<a class="anchor" id="a3ef387e6749a804b0b4343567ad27961"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">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#_stable004586">Stable:</a></b></dt><dd>ICU 3.2 </dd></dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ac107efb21e93bb88d279547cf9ef3a89"></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="LETypes_8h.html#a3ae79f31399d76e3055d2a2745bd0d9a">le_int32</a> 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#_stable004590">Stable:</a></b></dt><dd>ICU 3.2 </dd></dl>
</div>
</div>
<a class="anchor" id="a442b8a63149d41f5a9072aae90b39c8f"></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="LETypes_8h.html#a3ae79f31399d76e3055d2a2745bd0d9a">le_int32</a> 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#_stable004591">Stable:</a></b></dt><dd>ICU 3.2 </dd></dl>
</div>
</div>
<a class="anchor" id="ac9d732c6f5f630acf85c17d213fb850a"></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="utypes_8h.html#a22af10545208a455a6e884008df48e9f">UClassID</a> 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#_stable004596">Stable:</a></b></dt><dd>ICU 3.2 </dd></dl>
<p>Implements <a class="el" href="classUObject.html#a9b1acc95efd89cb86ec31f2dc947a262">UObject</a>.</p>
<p>Definition at line <a class="el" href="ParagraphLayout_8h_source.html#l00543">543</a> of file <a class="el" href="ParagraphLayout_8h_source.html">ParagraphLayout.h</a>.</p>
</div>
</div>
<a class="anchor" id="a8aee0a8278e9c7b019748ba04f56e909"></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="LETypes_8h.html#a3ae79f31399d76e3055d2a2745bd0d9a">le_int32</a> 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#_stable004592">Stable:</a></b></dt><dd>ICU 3.2 </dd></dl>
</div>
</div>
<a class="anchor" id="a90f17221c71a4bbb893dc43bf44b8352"></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> 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#_stable004588">Stable:</a></b></dt><dd>ICU 3.2 </dd></dl>
<p>Definition at line <a class="el" href="ParagraphLayout_8h_source.html#l00638">638</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="aa2b61f27a4915a526eced0e2b089f182"></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="utypes_8h.html#a22af10545208a455a6e884008df48e9f">UClassID</a> 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#_stable004595">Stable:</a></b></dt><dd>ICU 3.2 </dd></dl>
<p>Definition at line <a class="el" href="ParagraphLayout_8h_source.html#l00536">536</a> of file <a class="el" href="ParagraphLayout_8h_source.html">ParagraphLayout.h</a>.</p>
</div>
</div>
<a class="anchor" id="a2a90412e5a4c2465d5068920579137fc"></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> 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#_stable004589">Stable:</a></b></dt><dd>ICU 3.2 </dd></dl>
<p>Definition at line <a class="el" href="ParagraphLayout_8h_source.html#l00643">643</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="af1135377e5cb8e87f36b1552c338105a"></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="LETypes_8h.html#a4b77bc254d0e88fdabffde9c03e6728f">le_bool</a> ParagraphLayout::isComplex </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="LETypes_8h.html#a903cb689308cdef41500411d096a2c2d">LEUnicode</a> </td>
<td class="paramname"><em>chars</em>[], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="LETypes_8h.html#a3ae79f31399d76e3055d2a2745bd0d9a">le_int32</a> </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#_stable004587">Stable:</a></b></dt><dd>ICU 3.2 </dd></dl>
</div>
</div>
<a class="anchor" id="ac1942a18258dacba2c6383882ec34b3d"></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="LETypes_8h.html#a4b77bc254d0e88fdabffde9c03e6728f">le_bool</a> 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#_internal000470">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>
</div>
</div>
<a class="anchor" id="a232b40ef6d0a565c026bec85890d7b50"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classParagraphLayout_1_1Line.html">Line</a>* 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="classParagraphLayout_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="classParagraphLayout_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="classParagraphLayout_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="classParagraphLayout_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#_stable004594">Stable:</a></b></dt><dd>ICU 3.2 </dd></dl>
</div>
</div>
<a class="anchor" id="a437d556bb78f8f31a3167cdebed34697"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void 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#_stable004593">Stable:</a></b></dt><dd>ICU 3.2 </dd></dl>
<p>Definition at line <a class="el" href="ParagraphLayout_8h_source.html#l00648">648</a> of file <a class="el" href="ParagraphLayout_8h_source.html">ParagraphLayout.h</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.1.1
</small></address>
</body>
</html>
