<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Calculate the number of characters which can be included within the specified width</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="harupage.lineto.html">HaruPage::lineTo</a></div>
<div class="next" style="text-align: right; float: right;"><a href="harupage.movetextpos.html">HaruPage::moveTextPos</a></div>
<div class="up"><a href="class.harupage.html">HaruPage</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="harupage.measuretext" class="refentry">
<div class="refnamediv">
<h1 class="refname">HaruPage::measureText</h1>
<p class="verinfo">(PECL haru >= 0.0.1)</p><p class="refpurpose"><span class="refname">HaruPage::measureText</span> — <span class="dc-title">Calculate the number of characters which can be included within the specified width</span></p>
</div>
<div class="refsect1 description" id="refsect1-harupage.measuretext-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">int</span> <span class="methodname"><strong>HaruPage::measureText</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$text</code></span>
, <span class="methodparam"><span class="type">float</span> <code class="parameter">$width</code></span>
[, <span class="methodparam"><span class="type">bool</span> <code class="parameter">$wordwrap</code><span class="initializer"> = false</span></span>
] )</div>
<p class="para rdfs-comment">
Get the number of characters which can be included within the specified width.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-harupage.measuretext-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">text</code></em></span>
<dd>
<p class="para">
The text to measure.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">width</code></em></span>
<dd>
<p class="para">
The width of the area to put the text to.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">wordwrap</code></em></span>
<dd>
<p class="para">
When this parameter is set to <strong><code>TRUE</code></strong> the function "emulates" word
wrapping and doesn't include the part of the current word if reached
the end of the area.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-harupage.measuretext-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns the number of characters which can be included within the specified width.
</p>
</div>
<div class="refsect1 errors" id="refsect1-harupage.measuretext-errors">
<h3 class="title">Errors/Exceptions</h3>
<p class="para">Throws a <a href="class.haruexception.html" class="classname">HaruException</a> on error.</p>
</div>
<div class="refsect1 seealso" id="refsect1-harupage.measuretext-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="methodname"><a href="harufont.measuretext.html" class="methodname" rel="rdfs-seeAlso">HaruFont::measureText()</a> - Calculate the number of characters which can be included within the specified width</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="harupage.lineto.html">HaruPage::lineTo</a></div>
<div class="next" style="text-align: right; float: right;"><a href="harupage.movetextpos.html">HaruPage::moveTextPos</a></div>
<div class="up"><a href="class.harupage.html">HaruPage</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
