<!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::BreakIterator 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_1BreakIterator.html">BreakIterator</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#friends">Friends</a> </div>
<div class="headertitle">
<div class="title">icu::BreakIterator Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>The <a class="el" href="classicu_1_1BreakIterator.html" title="The BreakIterator class implements methods for finding the location of boundaries in text...">BreakIterator</a> class implements methods for finding the location of boundaries in text.
<a href="classicu_1_1BreakIterator.html#details">More...</a></p>
<p><code>#include <<a class="el" href="brkiter_8h_source.html">brkiter.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for icu::BreakIterator:</div>
<div class="dyncontent">
<div class="center">
<img src="classicu_1_1BreakIterator.png" usemap="#icu::BreakIterator_map" alt=""/>
<map id="icu::BreakIterator_map" name="icu::BreakIterator_map">
<area href="classicu_1_1UObject.html" title="UObject is the common ICU "boilerplate" class. " alt="icu::UObject" shape="rect" coords="0,56,168,80"/>
<area href="classicu_1_1UMemory.html" title="UMemory is the common ICU base class. " alt="icu::UMemory" shape="rect" coords="0,0,168,24"/>
<area href="classicu_1_1RuleBasedBreakIterator.html" title="A subclass of BreakIterator whose behavior is specified using a list of rules. " alt="icu::RuleBasedBreakIterator" shape="rect" coords="0,168,168,192"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a0174c4360d0cb8d21ecc3e4cea71d035"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom">{ <a class="el" href="classicu_1_1BreakIterator.html#a0174c4360d0cb8d21ecc3e4cea71d035af9daa8410e7f8dc1631f8fc6a8a8115c">DONE</a> = (int32_t)-1
}</td></tr>
<tr class="separator:a0174c4360d0cb8d21ecc3e4cea71d035"><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:a026e38276ffa6c40d8953b4e3bc4bc01"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1BreakIterator.html#a026e38276ffa6c40d8953b4e3bc4bc01">~BreakIterator</a> ()</td></tr>
<tr class="memdesc:a026e38276ffa6c40d8953b4e3bc4bc01"><td class="mdescLeft"> </td><td class="mdescRight">destructor <a href="#a026e38276ffa6c40d8953b4e3bc4bc01">More...</a><br /></td></tr>
<tr class="separator:a026e38276ffa6c40d8953b4e3bc4bc01"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5e65e03f2e505ff1dc01311b01790abc"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1BreakIterator.html#a5e65e03f2e505ff1dc01311b01790abc">operator==</a> (const <a class="el" href="classicu_1_1BreakIterator.html">BreakIterator</a> &) const =0</td></tr>
<tr class="memdesc:a5e65e03f2e505ff1dc01311b01790abc"><td class="mdescLeft"> </td><td class="mdescRight">Return true if another object is semantically equal to this one. <a href="#a5e65e03f2e505ff1dc01311b01790abc">More...</a><br /></td></tr>
<tr class="separator:a5e65e03f2e505ff1dc01311b01790abc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a612d1f537c854399c788c0d250623eff"><td class="memItemLeft" align="right" valign="top"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1BreakIterator.html#a612d1f537c854399c788c0d250623eff">operator!=</a> (const <a class="el" href="classicu_1_1BreakIterator.html">BreakIterator</a> &rhs) const </td></tr>
<tr class="memdesc:a612d1f537c854399c788c0d250623eff"><td class="mdescLeft"> </td><td class="mdescRight">Returns the complement of the result of operator==. <a href="#a612d1f537c854399c788c0d250623eff">More...</a><br /></td></tr>
<tr class="separator:a612d1f537c854399c788c0d250623eff"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a015c6d751d24f35b1f4339ea86f83c62"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classicu_1_1BreakIterator.html">BreakIterator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1BreakIterator.html#a015c6d751d24f35b1f4339ea86f83c62">clone</a> (void) const =0</td></tr>
<tr class="memdesc:a015c6d751d24f35b1f4339ea86f83c62"><td class="mdescLeft"> </td><td class="mdescRight">Return a polymorphic copy of this object. <a href="#a015c6d751d24f35b1f4339ea86f83c62">More...</a><br /></td></tr>
<tr class="separator:a015c6d751d24f35b1f4339ea86f83c62"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5515a96ff2f8ade4e3c2ce581ffe839b"><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_1BreakIterator.html#a5515a96ff2f8ade4e3c2ce581ffe839b">getDynamicClassID</a> (void) const =0</td></tr>
<tr class="memdesc:a5515a96ff2f8ade4e3c2ce581ffe839b"><td class="mdescLeft"> </td><td class="mdescRight">Return a polymorphic class ID for this object. <a href="#a5515a96ff2f8ade4e3c2ce581ffe839b">More...</a><br /></td></tr>
<tr class="separator:a5515a96ff2f8ade4e3c2ce581ffe839b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a290f5be64b2dffdfd707b4cdb602379b"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classicu_1_1CharacterIterator.html">CharacterIterator</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1BreakIterator.html#a290f5be64b2dffdfd707b4cdb602379b">getText</a> (void) const =0</td></tr>
<tr class="memdesc:a290f5be64b2dffdfd707b4cdb602379b"><td class="mdescLeft"> </td><td class="mdescRight">Return a <a class="el" href="classicu_1_1CharacterIterator.html" title="Abstract class that defines an API for iteration on text objects. ">CharacterIterator</a> over the text being analyzed. <a href="#a290f5be64b2dffdfd707b4cdb602379b">More...</a><br /></td></tr>
<tr class="separator:a290f5be64b2dffdfd707b4cdb602379b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af57b33540abfb9c41e9f1e54974d0559"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="structUText.html">UText</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1BreakIterator.html#af57b33540abfb9c41e9f1e54974d0559">getUText</a> (<a class="el" href="structUText.html">UText</a> *fillIn, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status) const =0</td></tr>
<tr class="memdesc:af57b33540abfb9c41e9f1e54974d0559"><td class="mdescLeft"> </td><td class="mdescRight">Get a <a class="el" href="structUText.html" title="UText struct. ">UText</a> for the text being analyzed. <a href="#af57b33540abfb9c41e9f1e54974d0559">More...</a><br /></td></tr>
<tr class="separator:af57b33540abfb9c41e9f1e54974d0559"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8b894129fb567fded3ed85a7e8ead942"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1BreakIterator.html#a8b894129fb567fded3ed85a7e8ead942">setText</a> (const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> &text)=0</td></tr>
<tr class="memdesc:a8b894129fb567fded3ed85a7e8ead942"><td class="mdescLeft"> </td><td class="mdescRight">Change the text over which this operates. <a href="#a8b894129fb567fded3ed85a7e8ead942">More...</a><br /></td></tr>
<tr class="separator:a8b894129fb567fded3ed85a7e8ead942"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3110dd5111286cd514ea6896ddd8c5bd"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1BreakIterator.html#a3110dd5111286cd514ea6896ddd8c5bd">setText</a> (<a class="el" href="structUText.html">UText</a> *text, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)=0</td></tr>
<tr class="memdesc:a3110dd5111286cd514ea6896ddd8c5bd"><td class="mdescLeft"> </td><td class="mdescRight">Reset the break iterator to operate over the text represented by the <a class="el" href="structUText.html" title="UText struct. ">UText</a>. <a href="#a3110dd5111286cd514ea6896ddd8c5bd">More...</a><br /></td></tr>
<tr class="separator:a3110dd5111286cd514ea6896ddd8c5bd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1fd72184b59936bb62b07af071e2b0c1"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1BreakIterator.html#a1fd72184b59936bb62b07af071e2b0c1">adoptText</a> (<a class="el" href="classicu_1_1CharacterIterator.html">CharacterIterator</a> *it)=0</td></tr>
<tr class="memdesc:a1fd72184b59936bb62b07af071e2b0c1"><td class="mdescLeft"> </td><td class="mdescRight">Change the text over which this operates. <a href="#a1fd72184b59936bb62b07af071e2b0c1">More...</a><br /></td></tr>
<tr class="separator:a1fd72184b59936bb62b07af071e2b0c1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abc6bb155a2ec664f63df79a80f8b43e5"><td class="memItemLeft" align="right" valign="top">virtual int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1BreakIterator.html#abc6bb155a2ec664f63df79a80f8b43e5">first</a> (void)=0</td></tr>
<tr class="memdesc:abc6bb155a2ec664f63df79a80f8b43e5"><td class="mdescLeft"> </td><td class="mdescRight">Sets the current iteration position to the beginning of the text, position zero. <a href="#abc6bb155a2ec664f63df79a80f8b43e5">More...</a><br /></td></tr>
<tr class="separator:abc6bb155a2ec664f63df79a80f8b43e5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2ecbdcabef74105eb7f0747011d05e01"><td class="memItemLeft" align="right" valign="top">virtual int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1BreakIterator.html#a2ecbdcabef74105eb7f0747011d05e01">last</a> (void)=0</td></tr>
<tr class="memdesc:a2ecbdcabef74105eb7f0747011d05e01"><td class="mdescLeft"> </td><td class="mdescRight">Set the iterator position to the index immediately BEYOND the last character in the text being scanned. <a href="#a2ecbdcabef74105eb7f0747011d05e01">More...</a><br /></td></tr>
<tr class="separator:a2ecbdcabef74105eb7f0747011d05e01"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aeede95a59db8408760b106724dfb7a4d"><td class="memItemLeft" align="right" valign="top">virtual int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1BreakIterator.html#aeede95a59db8408760b106724dfb7a4d">previous</a> (void)=0</td></tr>
<tr class="memdesc:aeede95a59db8408760b106724dfb7a4d"><td class="mdescLeft"> </td><td class="mdescRight">Set the iterator position to the boundary preceding the current boundary. <a href="#aeede95a59db8408760b106724dfb7a4d">More...</a><br /></td></tr>
<tr class="separator:aeede95a59db8408760b106724dfb7a4d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a13468dd341e9f0eb92c61f25e88a5154"><td class="memItemLeft" align="right" valign="top">virtual int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1BreakIterator.html#a13468dd341e9f0eb92c61f25e88a5154">next</a> (void)=0</td></tr>
<tr class="memdesc:a13468dd341e9f0eb92c61f25e88a5154"><td class="mdescLeft"> </td><td class="mdescRight">Advance the iterator to the boundary following the current boundary. <a href="#a13468dd341e9f0eb92c61f25e88a5154">More...</a><br /></td></tr>
<tr class="separator:a13468dd341e9f0eb92c61f25e88a5154"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af6ad53a2e16b52b8d746f81d2ffdf231"><td class="memItemLeft" align="right" valign="top">virtual int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1BreakIterator.html#af6ad53a2e16b52b8d746f81d2ffdf231">current</a> (void) const =0</td></tr>
<tr class="memdesc:af6ad53a2e16b52b8d746f81d2ffdf231"><td class="mdescLeft"> </td><td class="mdescRight">Return character index of the current interator position within the text. <a href="#af6ad53a2e16b52b8d746f81d2ffdf231">More...</a><br /></td></tr>
<tr class="separator:af6ad53a2e16b52b8d746f81d2ffdf231"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae4178f880af4875ae5e30a716331fbaf"><td class="memItemLeft" align="right" valign="top">virtual int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1BreakIterator.html#ae4178f880af4875ae5e30a716331fbaf">following</a> (int32_t offset)=0</td></tr>
<tr class="memdesc:ae4178f880af4875ae5e30a716331fbaf"><td class="mdescLeft"> </td><td class="mdescRight">Advance the iterator to the first boundary following the specified offset. <a href="#ae4178f880af4875ae5e30a716331fbaf">More...</a><br /></td></tr>
<tr class="separator:ae4178f880af4875ae5e30a716331fbaf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a980f8e8fbe1d37827cacc24f9606399f"><td class="memItemLeft" align="right" valign="top">virtual int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1BreakIterator.html#a980f8e8fbe1d37827cacc24f9606399f">preceding</a> (int32_t offset)=0</td></tr>
<tr class="memdesc:a980f8e8fbe1d37827cacc24f9606399f"><td class="mdescLeft"> </td><td class="mdescRight">Set the iterator position to the first boundary preceding the specified offset. <a href="#a980f8e8fbe1d37827cacc24f9606399f">More...</a><br /></td></tr>
<tr class="separator:a980f8e8fbe1d37827cacc24f9606399f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaf997425386eae9c50cd5c208dbef214"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1BreakIterator.html#aaf997425386eae9c50cd5c208dbef214">isBoundary</a> (int32_t offset)=0</td></tr>
<tr class="memdesc:aaf997425386eae9c50cd5c208dbef214"><td class="mdescLeft"> </td><td class="mdescRight">Return true if the specfied position is a boundary position. <a href="#aaf997425386eae9c50cd5c208dbef214">More...</a><br /></td></tr>
<tr class="separator:aaf997425386eae9c50cd5c208dbef214"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a971257b3ed9676ec02890187025caf1b"><td class="memItemLeft" align="right" valign="top">virtual int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1BreakIterator.html#a971257b3ed9676ec02890187025caf1b">next</a> (int32_t n)=0</td></tr>
<tr class="memdesc:a971257b3ed9676ec02890187025caf1b"><td class="mdescLeft"> </td><td class="mdescRight">Set the iterator position to the nth boundary from the current boundary. <a href="#a971257b3ed9676ec02890187025caf1b">More...</a><br /></td></tr>
<tr class="separator:a971257b3ed9676ec02890187025caf1b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae6ccdc933c069e2b13b2022eefa3ac54"><td class="memItemLeft" align="right" valign="top">virtual int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1BreakIterator.html#ae6ccdc933c069e2b13b2022eefa3ac54">getRuleStatus</a> () const </td></tr>
<tr class="memdesc:ae6ccdc933c069e2b13b2022eefa3ac54"><td class="mdescLeft"> </td><td class="mdescRight">For RuleBasedBreakIterators, return the status tag from the break rule that determined the most recently returned break position. <a href="#ae6ccdc933c069e2b13b2022eefa3ac54">More...</a><br /></td></tr>
<tr class="separator:ae6ccdc933c069e2b13b2022eefa3ac54"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af3bf12df7434e65041447bef51264e13"><td class="memItemLeft" align="right" valign="top">virtual int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1BreakIterator.html#af3bf12df7434e65041447bef51264e13">getRuleStatusVec</a> (int32_t *fillInVec, int32_t capacity, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr class="memdesc:af3bf12df7434e65041447bef51264e13"><td class="mdescLeft"> </td><td class="mdescRight">For RuleBasedBreakIterators, get the status (tag) values from the break rule(s) that determined the most recently returned break position. <a href="#af3bf12df7434e65041447bef51264e13">More...</a><br /></td></tr>
<tr class="separator:af3bf12df7434e65041447bef51264e13"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac0b126946521a209ec2c6d490b7db86e"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classicu_1_1BreakIterator.html">BreakIterator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1BreakIterator.html#ac0b126946521a209ec2c6d490b7db86e">createBufferClone</a> (void *stackBuffer, int32_t &BufferSize, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)=0</td></tr>
<tr class="memdesc:ac0b126946521a209ec2c6d490b7db86e"><td class="mdescLeft"> </td><td class="mdescRight">Deprecated functionality. <a href="#ac0b126946521a209ec2c6d490b7db86e">More...</a><br /></td></tr>
<tr class="separator:ac0b126946521a209ec2c6d490b7db86e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a20ce3ce8c87b0f5b11527caf0e824fbf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1BreakIterator.html#a20ce3ce8c87b0f5b11527caf0e824fbf">isBufferClone</a> (void)</td></tr>
<tr class="memdesc:a20ce3ce8c87b0f5b11527caf0e824fbf"><td class="mdescLeft"> </td><td class="mdescRight">Determine whether the <a class="el" href="classicu_1_1BreakIterator.html" title="The BreakIterator class implements methods for finding the location of boundaries in text...">BreakIterator</a> was created in user memory by <a class="el" href="classicu_1_1BreakIterator.html#ac0b126946521a209ec2c6d490b7db86e" title="Deprecated functionality. ">createBufferClone()</a>, and thus should not be deleted. <a href="#a20ce3ce8c87b0f5b11527caf0e824fbf">More...</a><br /></td></tr>
<tr class="separator:a20ce3ce8c87b0f5b11527caf0e824fbf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a03515a30c7cf3e368941dca2c0a89703"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classicu_1_1Locale.html">Locale</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1BreakIterator.html#a03515a30c7cf3e368941dca2c0a89703">getLocale</a> (<a class="el" href="uloc_8h.html#adf053345d343f8d82ae080f7a5871f34">ULocDataLocaleType</a> type, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status) const </td></tr>
<tr class="memdesc:a03515a30c7cf3e368941dca2c0a89703"><td class="mdescLeft"> </td><td class="mdescRight">Returns the locale for this break iterator. <a href="#a03515a30c7cf3e368941dca2c0a89703">More...</a><br /></td></tr>
<tr class="separator:a03515a30c7cf3e368941dca2c0a89703"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5106467f373ef0d2c09974790abfb288"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1BreakIterator.html#a5106467f373ef0d2c09974790abfb288">getLocaleID</a> (<a class="el" href="uloc_8h.html#adf053345d343f8d82ae080f7a5871f34">ULocDataLocaleType</a> type, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status) const </td></tr>
<tr class="memdesc:a5106467f373ef0d2c09974790abfb288"><td class="mdescLeft"> </td><td class="mdescRight">Get the locale for this break iterator object. <a href="#a5106467f373ef0d2c09974790abfb288">More...</a><br /></td></tr>
<tr class="separator:a5106467f373ef0d2c09974790abfb288"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a88ac5ff907f98e814783267b7fe082a5"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classicu_1_1BreakIterator.html">BreakIterator</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1BreakIterator.html#a88ac5ff907f98e814783267b7fe082a5">refreshInputText</a> (<a class="el" href="structUText.html">UText</a> *input, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)=0</td></tr>
<tr class="memdesc:a88ac5ff907f98e814783267b7fe082a5"><td class="mdescLeft"> </td><td class="mdescRight">Set the subject text string upon which the break iterator is operating without changing any other aspect of the matching state. <a href="#a88ac5ff907f98e814783267b7fe082a5">More...</a><br /></td></tr>
<tr class="separator:a88ac5ff907f98e814783267b7fe082a5"><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:a1266dc4f44f0d8614b3060ece504f786"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classicu_1_1BreakIterator.html">BreakIterator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1BreakIterator.html#a1266dc4f44f0d8614b3060ece504f786">createWordInstance</a> (const <a class="el" href="classicu_1_1Locale.html">Locale</a> &where, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr class="memdesc:a1266dc4f44f0d8614b3060ece504f786"><td class="mdescLeft"> </td><td class="mdescRight">Create <a class="el" href="classicu_1_1BreakIterator.html" title="The BreakIterator class implements methods for finding the location of boundaries in text...">BreakIterator</a> for word-breaks using the given locale. <a href="#a1266dc4f44f0d8614b3060ece504f786">More...</a><br /></td></tr>
<tr class="separator:a1266dc4f44f0d8614b3060ece504f786"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ace3d9612593db8fe5ec25c5c5210daea"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classicu_1_1BreakIterator.html">BreakIterator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1BreakIterator.html#ace3d9612593db8fe5ec25c5c5210daea">createLineInstance</a> (const <a class="el" href="classicu_1_1Locale.html">Locale</a> &where, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr class="memdesc:ace3d9612593db8fe5ec25c5c5210daea"><td class="mdescLeft"> </td><td class="mdescRight">Create <a class="el" href="classicu_1_1BreakIterator.html" title="The BreakIterator class implements methods for finding the location of boundaries in text...">BreakIterator</a> for line-breaks using specified locale. <a href="#ace3d9612593db8fe5ec25c5c5210daea">More...</a><br /></td></tr>
<tr class="separator:ace3d9612593db8fe5ec25c5c5210daea"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adffa57ea9131c4a9e0cf8226c17d459a"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classicu_1_1BreakIterator.html">BreakIterator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1BreakIterator.html#adffa57ea9131c4a9e0cf8226c17d459a">createCharacterInstance</a> (const <a class="el" href="classicu_1_1Locale.html">Locale</a> &where, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr class="memdesc:adffa57ea9131c4a9e0cf8226c17d459a"><td class="mdescLeft"> </td><td class="mdescRight">Create <a class="el" href="classicu_1_1BreakIterator.html" title="The BreakIterator class implements methods for finding the location of boundaries in text...">BreakIterator</a> for character-breaks using specified locale Returns an instance of a <a class="el" href="classicu_1_1BreakIterator.html" title="The BreakIterator class implements methods for finding the location of boundaries in text...">BreakIterator</a> implementing character breaks. <a href="#adffa57ea9131c4a9e0cf8226c17d459a">More...</a><br /></td></tr>
<tr class="separator:adffa57ea9131c4a9e0cf8226c17d459a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0cfe6e08f720030beb29ff395066c3d8"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classicu_1_1BreakIterator.html">BreakIterator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1BreakIterator.html#a0cfe6e08f720030beb29ff395066c3d8">createSentenceInstance</a> (const <a class="el" href="classicu_1_1Locale.html">Locale</a> &where, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr class="memdesc:a0cfe6e08f720030beb29ff395066c3d8"><td class="mdescLeft"> </td><td class="mdescRight">Create <a class="el" href="classicu_1_1BreakIterator.html" title="The BreakIterator class implements methods for finding the location of boundaries in text...">BreakIterator</a> for sentence-breaks using specified locale Returns an instance of a <a class="el" href="classicu_1_1BreakIterator.html" title="The BreakIterator class implements methods for finding the location of boundaries in text...">BreakIterator</a> implementing sentence breaks. <a href="#a0cfe6e08f720030beb29ff395066c3d8">More...</a><br /></td></tr>
<tr class="separator:a0cfe6e08f720030beb29ff395066c3d8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a46067034b6b72745e816589d6692c716"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classicu_1_1BreakIterator.html">BreakIterator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1BreakIterator.html#a46067034b6b72745e816589d6692c716">createTitleInstance</a> (const <a class="el" href="classicu_1_1Locale.html">Locale</a> &where, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr class="memdesc:a46067034b6b72745e816589d6692c716"><td class="mdescLeft"> </td><td class="mdescRight">Create <a class="el" href="classicu_1_1BreakIterator.html" title="The BreakIterator class implements methods for finding the location of boundaries in text...">BreakIterator</a> for title-casing breaks using the specified locale Returns an instance of a <a class="el" href="classicu_1_1BreakIterator.html" title="The BreakIterator class implements methods for finding the location of boundaries in text...">BreakIterator</a> implementing title breaks. <a href="#a46067034b6b72745e816589d6692c716">More...</a><br /></td></tr>
<tr class="separator:a46067034b6b72745e816589d6692c716"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1ececc0263be6fb1d2cec4a47eaad154"><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="classicu_1_1Locale.html">Locale</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1BreakIterator.html#a1ececc0263be6fb1d2cec4a47eaad154">getAvailableLocales</a> (int32_t &count)</td></tr>
<tr class="memdesc:a1ececc0263be6fb1d2cec4a47eaad154"><td class="mdescLeft"> </td><td class="mdescRight">Get the set of Locales for which TextBoundaries are installed. <a href="#a1ececc0263be6fb1d2cec4a47eaad154">More...</a><br /></td></tr>
<tr class="separator:a1ececc0263be6fb1d2cec4a47eaad154"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab06789c46f4b192aced3b4ee568b6ea8"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1BreakIterator.html#ab06789c46f4b192aced3b4ee568b6ea8">getDisplayName</a> (const <a class="el" href="classicu_1_1Locale.html">Locale</a> &objectLocale, const <a class="el" href="classicu_1_1Locale.html">Locale</a> &displayLocale, <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> &name)</td></tr>
<tr class="memdesc:ab06789c46f4b192aced3b4ee568b6ea8"><td class="mdescLeft"> </td><td class="mdescRight">Get name of the object for the desired <a class="el" href="classicu_1_1Locale.html" title="A Locale object represents a specific geographical, political, or cultural region. ">Locale</a>, in the desired langauge. <a href="#ab06789c46f4b192aced3b4ee568b6ea8">More...</a><br /></td></tr>
<tr class="separator:ab06789c46f4b192aced3b4ee568b6ea8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0280f649fca63ddc353e0d17ab9bb4a8"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1BreakIterator.html#a0280f649fca63ddc353e0d17ab9bb4a8">getDisplayName</a> (const <a class="el" href="classicu_1_1Locale.html">Locale</a> &objectLocale, <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> &name)</td></tr>
<tr class="memdesc:a0280f649fca63ddc353e0d17ab9bb4a8"><td class="mdescLeft"> </td><td class="mdescRight">Get name of the object for the desired <a class="el" href="classicu_1_1Locale.html" title="A Locale object represents a specific geographical, political, or cultural region. ">Locale</a>, in the langauge of the default locale. <a href="#a0280f649fca63ddc353e0d17ab9bb4a8">More...</a><br /></td></tr>
<tr class="separator:a0280f649fca63ddc353e0d17ab9bb4a8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af03207fda29e7eab8adf59fb1788b2cf"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="umisc_8h.html#ab5905d79ed3b979840cee1d5fd48b4fb">URegistryKey</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1BreakIterator.html#af03207fda29e7eab8adf59fb1788b2cf">registerInstance</a> (<a class="el" href="classicu_1_1BreakIterator.html">BreakIterator</a> *toAdopt, const <a class="el" href="classicu_1_1Locale.html">Locale</a> &locale, <a class="el" href="ubrk_8h.html#a026dec40289da8261d787daf3baa588b">UBreakIteratorType</a> kind, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr class="memdesc:af03207fda29e7eab8adf59fb1788b2cf"><td class="mdescLeft"> </td><td class="mdescRight">Register a new break iterator of the indicated kind, to use in the given locale. <a href="#af03207fda29e7eab8adf59fb1788b2cf">More...</a><br /></td></tr>
<tr class="separator:af03207fda29e7eab8adf59fb1788b2cf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac89b591636b40ec7a1037d02bfe8d832"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1BreakIterator.html#ac89b591636b40ec7a1037d02bfe8d832">unregister</a> (<a class="el" href="umisc_8h.html#ab5905d79ed3b979840cee1d5fd48b4fb">URegistryKey</a> key, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr>
<tr class="memdesc:ac89b591636b40ec7a1037d02bfe8d832"><td class="mdescLeft"> </td><td class="mdescRight">Unregister a previously-registered <a class="el" href="classicu_1_1BreakIterator.html" title="The BreakIterator class implements methods for finding the location of boundaries in text...">BreakIterator</a> using the key returned from the register call. <a href="#ac89b591636b40ec7a1037d02bfe8d832">More...</a><br /></td></tr>
<tr class="separator:ac89b591636b40ec7a1037d02bfe8d832"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a715fcfc47c6961a67541d6e7b5d83773"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classicu_1_1StringEnumeration.html">StringEnumeration</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1BreakIterator.html#a715fcfc47c6961a67541d6e7b5d83773">getAvailableLocales</a> (void)</td></tr>
<tr class="memdesc:a715fcfc47c6961a67541d6e7b5d83773"><td class="mdescLeft"> </td><td class="mdescRight">Return a <a class="el" href="classicu_1_1StringEnumeration.html" title="Base class for 'pure' C++ implementations of uenum api. ">StringEnumeration</a> over the locales available at the time of the call, including registered locales. <a href="#a715fcfc47c6961a67541d6e7b5d83773">More...</a><br /></td></tr>
<tr class="separator:a715fcfc47c6961a67541d6e7b5d83773"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a151b3d5496d7ca586c331f8521446755"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1BreakIterator.html#a151b3d5496d7ca586c331f8521446755">BreakIterator</a> ()</td></tr>
<tr class="separator:a151b3d5496d7ca586c331f8521446755"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0a44745041bbe7e3ec41bc1e2a880c80"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1BreakIterator.html#a0a44745041bbe7e3ec41bc1e2a880c80">BreakIterator</a> (const <a class="el" href="classicu_1_1BreakIterator.html">BreakIterator</a> &other)</td></tr>
<tr class="separator:a0a44745041bbe7e3ec41bc1e2a880c80"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a094580dacf6cc3f251fb4844278a61ce"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1BreakIterator.html#a094580dacf6cc3f251fb4844278a61ce">BreakIterator</a> (const <a class="el" href="classicu_1_1Locale.html">Locale</a> &valid, const <a class="el" href="classicu_1_1Locale.html">Locale</a> &actual)</td></tr>
<tr class="separator:a094580dacf6cc3f251fb4844278a61ce"><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:a9d94f465eba6b867a8e081a6650d0aa7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9d94f465eba6b867a8e081a6650d0aa7"></a>
class </td><td class="memItemRight" valign="bottom"><b>ICUBreakIteratorFactory</b></td></tr>
<tr class="separator:a9d94f465eba6b867a8e081a6650d0aa7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab98b7c14471379197ac959b4d8e12e4e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab98b7c14471379197ac959b4d8e12e4e"></a>
class </td><td class="memItemRight" valign="bottom"><b>ICUBreakIteratorService</b></td></tr>
<tr class="separator:ab98b7c14471379197ac959b4d8e12e4e"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The <a class="el" href="classicu_1_1BreakIterator.html" title="The BreakIterator class implements methods for finding the location of boundaries in text...">BreakIterator</a> class implements methods for finding the location of boundaries in text. </p>
<p><a class="el" href="classicu_1_1BreakIterator.html" title="The BreakIterator class implements methods for finding the location of boundaries in text...">BreakIterator</a> is an abstract base class. Instances of <a class="el" href="classicu_1_1BreakIterator.html" title="The BreakIterator class implements methods for finding the location of boundaries in text...">BreakIterator</a> maintain a current position and scan over text returning the index of characters where boundaries occur. </p>
<p>Line boundary analysis determines where a text string can be broken when line-wrapping. The mechanism correctly handles punctuation and hyphenated words. </p>
<p>Sentence boundary analysis allows selection with correct interpretation of periods within numbers and abbreviations, and trailing punctuation marks such as quotation marks and parentheses. </p>
<p>Word boundary analysis is used by search and replace functions, as well as within text editing applications that allow the user to select words with a double click. Word selection provides correct interpretation of punctuation marks within and following words. Characters that are not part of a word, such as symbols or punctuation marks, have word-breaks on both sides. </p>
<p>Character boundary analysis allows users to interact with characters as they expect to, for example, when moving the cursor through a text string. Character boundary analysis provides correct navigation of through character strings, regardless of how the character is stored. For example, an accented character might be stored as a base character and a diacritical mark. What users consider to be a character can differ between languages. </p>
<p>The text boundary positions are found according to the rules described in Unicode Standard Annex #29, Text Boundaries, and Unicode Standard Annex #14, Line Breaking Properties. These are available at <a href="http://www.unicode.org/reports/tr14/">http://www.unicode.org/reports/tr14/</a> and <a href="http://www.unicode.org/reports/tr29/">http://www.unicode.org/reports/tr29/</a>. </p>
<p>In addition to the C++ API defined in this header file, a plain C API with equivalent functionality is defined in the file <a class="el" href="ubrk_8h.html" title="C API: BreakIterator. ">ubrk.h</a> </p>
<p>Code snippets illustrating the use of the Break Iterator APIs are available in the ICU User Guide, <a href="http://icu-project.org/userguide/boundaryAnalysis.html">http://icu-project.org/userguide/boundaryAnalysis.html</a> and in the sample program icu/source/samples/break/break.cpp </p>
<p>Definition at line <a class="el" href="brkiter_8h_source.html#l00102">102</a> of file <a class="el" href="brkiter_8h_source.html">brkiter.h</a>.</p>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a class="anchor" id="a0174c4360d0cb8d21ecc3e4cea71d035"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">anonymous enum</td>
</tr>
</table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="a0174c4360d0cb8d21ecc3e4cea71d035af9daa8410e7f8dc1631f8fc6a8a8115c"></a>DONE </td><td class="fielddoc">
<p>DONE is returned by <a class="el" href="classicu_1_1BreakIterator.html#aeede95a59db8408760b106724dfb7a4d" title="Set the iterator position to the boundary preceding the current boundary. ">previous()</a> and <a class="el" href="classicu_1_1BreakIterator.html#a13468dd341e9f0eb92c61f25e88a5154" title="Advance the iterator to the boundary following the current boundary. ">next()</a> after all valid boundaries have been returned. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000050">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</td></tr>
</table>
<p>Definition at line <a class="el" href="brkiter_8h_source.html#l00213">213</a> of file <a class="el" href="brkiter_8h_source.html">brkiter.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a026e38276ffa6c40d8953b4e3bc4bc01"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual icu::BreakIterator::~BreakIterator </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></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>destructor </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000016">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a151b3d5496d7ca586c331f8521446755"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">icu::BreakIterator::BreakIterator </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000002">Internal:</a></b></dt><dd>Do not use.</dd></dl>
<p>This API is for internal use only. </p>
</div>
</div>
<a class="anchor" id="a0a44745041bbe7e3ec41bc1e2a880c80"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">icu::BreakIterator::BreakIterator </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classicu_1_1BreakIterator.html">BreakIterator</a> & </td>
<td class="paramname"><em>other</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000003">Internal:</a></b></dt><dd>Do not use.</dd></dl>
<p>This API is for internal use only. </p>
<p>Definition at line <a class="el" href="brkiter_8h_source.html#l00632">632</a> of file <a class="el" href="brkiter_8h_source.html">brkiter.h</a>.</p>
<p>References <a class="el" href="uloc_8h_source.html#l00264">ULOC_FULLNAME_CAPACITY</a>.</p>
</div>
</div>
<a class="anchor" id="a094580dacf6cc3f251fb4844278a61ce"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">icu::BreakIterator::BreakIterator </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classicu_1_1Locale.html">Locale</a> & </td>
<td class="paramname"><em>valid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classicu_1_1Locale.html">Locale</a> & </td>
<td class="paramname"><em>actual</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">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000004">Internal:</a></b></dt><dd>Do not use.</dd></dl>
<p>This API is for internal use only. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a1fd72184b59936bb62b07af071e2b0c1"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void icu::BreakIterator::adoptText </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classicu_1_1CharacterIterator.html">CharacterIterator</a> * </td>
<td class="paramname"><em>it</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Change the text over which this operates. </p>
<p>The text boundary is reset to the start. Note that setText(UText *) provides similar functionality to this function, and is more efficient. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">it</td><td>The <a class="el" href="classicu_1_1CharacterIterator.html" title="Abstract class that defines an API for iteration on text objects. ">CharacterIterator</a> used to change the text. </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000025">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Implemented in <a class="el" href="classicu_1_1RuleBasedBreakIterator.html#af552e13c98aed9f2995fc0f8f066d6f1">icu::RuleBasedBreakIterator</a>.</p>
</div>
</div>
<a class="anchor" id="a015c6d751d24f35b1f4339ea86f83c62"></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="classicu_1_1BreakIterator.html">BreakIterator</a>* icu::BreakIterator::clone </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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return a polymorphic copy of this object. </p>
<p>This is an abstract method which subclasses implement. </p><dl class="stable"><dt><b><a class="el" href="stable.html#_stable000019">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Implemented in <a class="el" href="classicu_1_1RuleBasedBreakIterator.html#a3cbdfd31f01904b75d44555286a8a83f">icu::RuleBasedBreakIterator</a>.</p>
</div>
</div>
<a class="anchor" id="ac0b126946521a209ec2c6d490b7db86e"></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="classicu_1_1BreakIterator.html">BreakIterator</a>* icu::BreakIterator::createBufferClone </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>stackBuffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t & </td>
<td class="paramname"><em>BufferSize</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"><em>status</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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Deprecated functionality. </p>
<p>Use <a class="el" href="classicu_1_1BreakIterator.html#a015c6d751d24f35b1f4339ea86f83c62" title="Return a polymorphic copy of this object. ">clone()</a> instead.</p>
<p>Thread safe client-buffer-based cloning operation Do NOT call delete on a safeclone, since 'new' is not used to create it. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">stackBuffer</td><td>user allocated space for the new clone. If NULL new memory will be allocated. If buffer is not large enough, new memory will be allocated. </td></tr>
<tr><td class="paramname">BufferSize</td><td>reference to size of allocated space. If BufferSize == 0, a sufficient size for use in cloning will be returned ('pre-flighting') If BufferSize is not enough for a stack-based safe clone, new memory will be allocated. </td></tr>
<tr><td class="paramname">status</td><td>to indicate whether the operation went on smoothly or there were errors An informational status value, U_SAFECLONE_ALLOCATED_ERROR, is used if any allocations were necessary. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>pointer to the new clone</dd></dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000001">Deprecated:</a></b></dt><dd>ICU 52. Use <a class="el" href="classicu_1_1BreakIterator.html#a015c6d751d24f35b1f4339ea86f83c62" title="Return a polymorphic copy of this object. ">clone()</a> instead. </dd></dl>
<p>Implemented in <a class="el" href="classicu_1_1RuleBasedBreakIterator.html#a846ac3670fa9bef6261e2f27b4fba22b">icu::RuleBasedBreakIterator</a>.</p>
</div>
</div>
<a class="anchor" id="adffa57ea9131c4a9e0cf8226c17d459a"></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="classicu_1_1BreakIterator.html">BreakIterator</a>* icu::BreakIterator::createCharacterInstance </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classicu_1_1Locale.html">Locale</a> & </td>
<td class="paramname"><em>where</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"><em>status</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>Create <a class="el" href="classicu_1_1BreakIterator.html" title="The BreakIterator class implements methods for finding the location of boundaries in text...">BreakIterator</a> for character-breaks using specified locale Returns an instance of a <a class="el" href="classicu_1_1BreakIterator.html" title="The BreakIterator class implements methods for finding the location of boundaries in text...">BreakIterator</a> implementing character breaks. </p>
<p>Character breaks are boundaries of combining character sequences. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">where</td><td>the locale. </td></tr>
<tr><td class="paramname">status</td><td>The error code. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A <a class="el" href="classicu_1_1BreakIterator.html" title="The BreakIterator class implements methods for finding the location of boundaries in text...">BreakIterator</a> for character-breaks. The UErrorCode& status parameter is used to return status information to the user. To check whether the construction succeeded or not, you should check the value of <a class="el" href="utypes_8h.html#a527f2c69e6b2e3b2c53ad8a99fb36711" title="Does the error code indicate success? ">U_SUCCESS(err)</a>. If you wish more detailed information, you can check for informational error results which still indicate success. U_USING_FALLBACK_WARNING indicates that a fall back locale was used. For example, 'de_CH' was requested, but nothing was found there, so 'de' was used. U_USING_DEFAULT_WARNING indicates that the default locale data was used; neither the requested locale nor any of its fall back locales could be found. The caller owns the returned object and is responsible for deleting it. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000039">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="ace3d9612593db8fe5ec25c5c5210daea"></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="classicu_1_1BreakIterator.html">BreakIterator</a>* icu::BreakIterator::createLineInstance </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classicu_1_1Locale.html">Locale</a> & </td>
<td class="paramname"><em>where</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"><em>status</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>Create <a class="el" href="classicu_1_1BreakIterator.html" title="The BreakIterator class implements methods for finding the location of boundaries in text...">BreakIterator</a> for line-breaks using specified locale. </p>
<p>Returns an instance of a <a class="el" href="classicu_1_1BreakIterator.html" title="The BreakIterator class implements methods for finding the location of boundaries in text...">BreakIterator</a> implementing line breaks. Line breaks are logically possible line breaks, actual line breaks are usually determined based on display width. LineBreak is useful for word wrapping text. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">where</td><td>the locale. </td></tr>
<tr><td class="paramname">status</td><td>The error code. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A <a class="el" href="classicu_1_1BreakIterator.html" title="The BreakIterator class implements methods for finding the location of boundaries in text...">BreakIterator</a> for line-breaks. The UErrorCode& status parameter is used to return status information to the user. To check whether the construction succeeded or not, you should check the value of <a class="el" href="utypes_8h.html#a527f2c69e6b2e3b2c53ad8a99fb36711" title="Does the error code indicate success? ">U_SUCCESS(err)</a>. If you wish more detailed information, you can check for informational error results which still indicate success. U_USING_FALLBACK_WARNING indicates that a fall back locale was used. For example, 'de_CH' was requested, but nothing was found there, so 'de' was used. U_USING_DEFAULT_WARNING indicates that the default locale data was used; neither the requested locale nor any of its fall back locales could be found. The caller owns the returned object and is responsible for deleting it. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000038">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a0cfe6e08f720030beb29ff395066c3d8"></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="classicu_1_1BreakIterator.html">BreakIterator</a>* icu::BreakIterator::createSentenceInstance </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classicu_1_1Locale.html">Locale</a> & </td>
<td class="paramname"><em>where</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"><em>status</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>Create <a class="el" href="classicu_1_1BreakIterator.html" title="The BreakIterator class implements methods for finding the location of boundaries in text...">BreakIterator</a> for sentence-breaks using specified locale Returns an instance of a <a class="el" href="classicu_1_1BreakIterator.html" title="The BreakIterator class implements methods for finding the location of boundaries in text...">BreakIterator</a> implementing sentence breaks. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">where</td><td>the locale. </td></tr>
<tr><td class="paramname">status</td><td>The error code. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A <a class="el" href="classicu_1_1BreakIterator.html" title="The BreakIterator class implements methods for finding the location of boundaries in text...">BreakIterator</a> for sentence-breaks. The UErrorCode& status parameter is used to return status information to the user. To check whether the construction succeeded or not, you should check the value of <a class="el" href="utypes_8h.html#a527f2c69e6b2e3b2c53ad8a99fb36711" title="Does the error code indicate success? ">U_SUCCESS(err)</a>. If you wish more detailed information, you can check for informational error results which still indicate success. U_USING_FALLBACK_WARNING indicates that a fall back locale was used. For example, 'de_CH' was requested, but nothing was found there, so 'de' was used. U_USING_DEFAULT_WARNING indicates that the default locale data was used; neither the requested locale nor any of its fall back locales could be found. The caller owns the returned object and is responsible for deleting it. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000040">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a46067034b6b72745e816589d6692c716"></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="classicu_1_1BreakIterator.html">BreakIterator</a>* icu::BreakIterator::createTitleInstance </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classicu_1_1Locale.html">Locale</a> & </td>
<td class="paramname"><em>where</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"><em>status</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>Create <a class="el" href="classicu_1_1BreakIterator.html" title="The BreakIterator class implements methods for finding the location of boundaries in text...">BreakIterator</a> for title-casing breaks using the specified locale Returns an instance of a <a class="el" href="classicu_1_1BreakIterator.html" title="The BreakIterator class implements methods for finding the location of boundaries in text...">BreakIterator</a> implementing title breaks. </p>
<p>The iterator returned locates title boundaries as described for Unicode 3.2 only. For Unicode 4.0 and above title boundary iteration, please use Word Boundary iterator.<a class="el" href="classicu_1_1BreakIterator.html#a1266dc4f44f0d8614b3060ece504f786">createWordInstance</a></p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">where</td><td>the locale. </td></tr>
<tr><td class="paramname">status</td><td>The error code. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A <a class="el" href="classicu_1_1BreakIterator.html" title="The BreakIterator class implements methods for finding the location of boundaries in text...">BreakIterator</a> for title-breaks. The UErrorCode& status parameter is used to return status information to the user. To check whether the construction succeeded or not, you should check the value of <a class="el" href="utypes_8h.html#a527f2c69e6b2e3b2c53ad8a99fb36711" title="Does the error code indicate success? ">U_SUCCESS(err)</a>. If you wish more detailed information, you can check for informational error results which still indicate success. U_USING_FALLBACK_WARNING indicates that a fall back locale was used. For example, 'de_CH' was requested, but nothing was found there, so 'de' was used. U_USING_DEFAULT_WARNING indicates that the default locale data was used; neither the requested locale nor any of its fall back locales could be found. The caller owns the returned object and is responsible for deleting it. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000041">Stable:</a></b></dt><dd>ICU 2.1 </dd></dl>
</div>
</div>
<a class="anchor" id="a1266dc4f44f0d8614b3060ece504f786"></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="classicu_1_1BreakIterator.html">BreakIterator</a>* icu::BreakIterator::createWordInstance </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classicu_1_1Locale.html">Locale</a> & </td>
<td class="paramname"><em>where</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"><em>status</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>Create <a class="el" href="classicu_1_1BreakIterator.html" title="The BreakIterator class implements methods for finding the location of boundaries in text...">BreakIterator</a> for word-breaks using the given locale. </p>
<p>Returns an instance of a <a class="el" href="classicu_1_1BreakIterator.html" title="The BreakIterator class implements methods for finding the location of boundaries in text...">BreakIterator</a> implementing word breaks. WordBreak is useful for word selection (ex. double click) </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">where</td><td>the locale. </td></tr>
<tr><td class="paramname">status</td><td>the error code </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A <a class="el" href="classicu_1_1BreakIterator.html" title="The BreakIterator class implements methods for finding the location of boundaries in text...">BreakIterator</a> for word-breaks. The UErrorCode& status parameter is used to return status information to the user. To check whether the construction succeeded or not, you should check the value of <a class="el" href="utypes_8h.html#a527f2c69e6b2e3b2c53ad8a99fb36711" title="Does the error code indicate success? ">U_SUCCESS(err)</a>. If you wish more detailed information, you can check for informational error results which still indicate success. U_USING_FALLBACK_WARNING indicates that a fall back locale was used. For example, 'de_CH' was requested, but nothing was found there, so 'de' was used. U_USING_DEFAULT_WARNING indicates that the default locale data was used; neither the requested locale nor any of its fall back locales could be found. The caller owns the returned object and is responsible for deleting it. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000037">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="af6ad53a2e16b52b8d746f81d2ffdf231"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int32_t icu::BreakIterator::current </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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return character index of the current interator position within the text. </p>
<dl class="section return"><dt>Returns</dt><dd>The boundary most recently returned. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000030">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Implemented in <a class="el" href="classicu_1_1RuleBasedBreakIterator.html#adf946f06f98d9a9a28e35d5debce95f6">icu::RuleBasedBreakIterator</a>.</p>
</div>
</div>
<a class="anchor" id="abc6bb155a2ec664f63df79a80f8b43e5"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int32_t icu::BreakIterator::first </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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the current iteration position to the beginning of the text, position zero. </p>
<dl class="section return"><dt>Returns</dt><dd>The offset of the beginning of the text, zero. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000026">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Implemented in <a class="el" href="classicu_1_1RuleBasedBreakIterator.html#ae570e1d10c69d488add6ca6450185ff9">icu::RuleBasedBreakIterator</a>.</p>
</div>
</div>
<a class="anchor" id="ae4178f880af4875ae5e30a716331fbaf"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int32_t icu::BreakIterator::following </td>
<td>(</td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>offset</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Advance the iterator to the first boundary following the specified offset. </p>
<p>The value returned is always greater than the offset or the value <a class="el" href="classicu_1_1BreakIterator.html#a0174c4360d0cb8d21ecc3e4cea71d035af9daa8410e7f8dc1631f8fc6a8a8115c" title="DONE is returned by previous() and next() after all valid boundaries have been returned. ">BreakIterator.DONE</a> </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">offset</td><td>the offset to begin scanning. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The first boundary after the specified offset. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000031">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Implemented in <a class="el" href="classicu_1_1RuleBasedBreakIterator.html#adf540b2d0d834bea3b7953502e36c717">icu::RuleBasedBreakIterator</a>.</p>
</div>
</div>
<a class="anchor" id="a1ececc0263be6fb1d2cec4a47eaad154"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static const <a class="el" href="classicu_1_1Locale.html">Locale</a>* icu::BreakIterator::getAvailableLocales </td>
<td>(</td>
<td class="paramtype">int32_t & </td>
<td class="paramname"><em>count</em></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>Get the set of Locales for which TextBoundaries are installed. </p>
<p><b>Note:</b> this will not return locales added through the register call. To see the registered locales too, use the getAvailableLocales function that returns a <a class="el" href="classicu_1_1StringEnumeration.html" title="Base class for 'pure' C++ implementations of uenum api. ">StringEnumeration</a> object </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">count</td><td>the output parameter of number of elements in the locale list </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>available locales </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000042">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a715fcfc47c6961a67541d6e7b5d83773"></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="classicu_1_1StringEnumeration.html">StringEnumeration</a>* icu::BreakIterator::getAvailableLocales </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">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return a <a class="el" href="classicu_1_1StringEnumeration.html" title="Base class for 'pure' C++ implementations of uenum api. ">StringEnumeration</a> over the locales available at the time of the call, including registered locales. </p>
<dl class="section return"><dt>Returns</dt><dd>a <a class="el" href="classicu_1_1StringEnumeration.html" title="Base class for 'pure' C++ implementations of uenum api. ">StringEnumeration</a> over the locales available at the time of the call </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000047">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl>
</div>
</div>
<a class="anchor" id="ab06789c46f4b192aced3b4ee568b6ea8"></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="classicu_1_1UnicodeString.html">UnicodeString</a>& icu::BreakIterator::getDisplayName </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classicu_1_1Locale.html">Locale</a> & </td>
<td class="paramname"><em>objectLocale</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classicu_1_1Locale.html">Locale</a> & </td>
<td class="paramname"><em>displayLocale</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"><em>name</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>Get name of the object for the desired <a class="el" href="classicu_1_1Locale.html" title="A Locale object represents a specific geographical, political, or cultural region. ">Locale</a>, in the desired langauge. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">objectLocale</td><td>must be from getAvailableLocales. </td></tr>
<tr><td class="paramname">displayLocale</td><td>specifies the desired locale for output. </td></tr>
<tr><td class="paramname">name</td><td>the fill-in parameter of the return value Uses best match. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>user-displayable name </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000043">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a0280f649fca63ddc353e0d17ab9bb4a8"></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="classicu_1_1UnicodeString.html">UnicodeString</a>& icu::BreakIterator::getDisplayName </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classicu_1_1Locale.html">Locale</a> & </td>
<td class="paramname"><em>objectLocale</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"><em>name</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>Get name of the object for the desired <a class="el" href="classicu_1_1Locale.html" title="A Locale object represents a specific geographical, political, or cultural region. ">Locale</a>, in the langauge of the default locale. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">objectLocale</td><td>must be from getMatchingLocales </td></tr>
<tr><td class="paramname">name</td><td>the fill-in parameter of the return value </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>user-displayable name </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000044">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a5515a96ff2f8ade4e3c2ce581ffe839b"></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::BreakIterator::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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return a polymorphic class ID for this object. </p>
<p>Different subclasses will return distinct unequal values. </p><dl class="stable"><dt><b><a class="el" href="stable.html#_stable000020">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Reimplemented from <a class="el" href="classicu_1_1UObject.html#a1aa93096e880907080b503ff1fb0f8bc">icu::UObject</a>.</p>
<p>Implemented in <a class="el" href="classicu_1_1RuleBasedBreakIterator.html#aec8924e01d4c044b69c647af3ae64755">icu::RuleBasedBreakIterator</a>.</p>
</div>
</div>
<a class="anchor" id="a03515a30c7cf3e368941dca2c0a89703"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classicu_1_1Locale.html">Locale</a> icu::BreakIterator::getLocale </td>
<td>(</td>
<td class="paramtype"><a class="el" href="uloc_8h.html#adf053345d343f8d82ae080f7a5871f34">ULocDataLocaleType</a> </td>
<td class="paramname"><em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"><em>status</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the locale for this break iterator. </p>
<p>Two flavors are available: valid and actual locale. </p><dl class="stable"><dt><b><a class="el" href="stable.html#_stable000048">Stable:</a></b></dt><dd>ICU 2.8 </dd></dl>
</div>
</div>
<a class="anchor" id="a5106467f373ef0d2c09974790abfb288"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* icu::BreakIterator::getLocaleID </td>
<td>(</td>
<td class="paramtype"><a class="el" href="uloc_8h.html#adf053345d343f8d82ae080f7a5871f34">ULocDataLocaleType</a> </td>
<td class="paramname"><em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"><em>status</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the locale for this break iterator object. </p>
<p>You can choose between valid and actual locale. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">type</td><td>type of the locale we're looking for (valid or actual) </td></tr>
<tr><td class="paramname">status</td><td>error code for the operation </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the locale </dd></dl>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000001">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>
</div>
</div>
<a class="anchor" id="ae6ccdc933c069e2b13b2022eefa3ac54"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int32_t icu::BreakIterator::getRuleStatus </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>For RuleBasedBreakIterators, return the status tag from the break rule that determined the most recently returned break position. </p>
<p>For break iterator types that do not support a rule status, a default value of 0 is returned. </p>
<dl class="section return"><dt>Returns</dt><dd>the status from the break rule that determined the most recently returned break position. </dd></dl>
<dl class="section see"><dt>See also</dt><dd>RuleBaseBreakIterator::getRuleStatus() </dd>
<dd>
<a class="el" href="ubrk_8h.html#afc5d4d3f7f4207d27081409e4b1b6c9a" title="Enum constants for the word break tags returned by getRuleStatus(). ">UWordBreak</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000035">Stable:</a></b></dt><dd>ICU 52 </dd></dl>
<p>Reimplemented in <a class="el" href="classicu_1_1RuleBasedBreakIterator.html#a3d0f8f408c7b3df7c4c242846a26e3ec">icu::RuleBasedBreakIterator</a>.</p>
</div>
</div>
<a class="anchor" id="af3bf12df7434e65041447bef51264e13"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int32_t icu::BreakIterator::getRuleStatusVec </td>
<td>(</td>
<td class="paramtype">int32_t * </td>
<td class="paramname"><em>fillInVec</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>capacity</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"><em>status</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">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>For RuleBasedBreakIterators, get the status (tag) values from the break rule(s) that determined the most recently returned break position. </p>
<p>For break iterator types that do not support rule status, no values are returned. </p>
<p>The returned status value(s) are stored into an array provided by the caller. The values are stored in sorted (ascending) order. If the capacity of the output array is insufficient to hold the data, the output will be truncated to the available length, and a U_BUFFER_OVERFLOW_ERROR will be signaled. </p>
<dl class="section see"><dt>See also</dt><dd>RuleBaseBreakIterator::getRuleStatusVec</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fillInVec</td><td>an array to be filled in with the status values. </td></tr>
<tr><td class="paramname">capacity</td><td>the length of the supplied vector. A length of zero causes the function to return the number of status values, in the normal way, without attemtping to store any values. </td></tr>
<tr><td class="paramname">status</td><td>receives error codes. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The number of rule status values from rules that determined the most recent boundary returned by the break iterator. In the event of a U_BUFFER_OVERFLOW_ERROR, the return value is the total number of status values that were available, not the reduced number that were actually returned. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classicu_1_1BreakIterator.html#ae6ccdc933c069e2b13b2022eefa3ac54" title="For RuleBasedBreakIterators, return the status tag from the break rule that determined the most recen...">getRuleStatus</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000036">Stable:</a></b></dt><dd>ICU 52 </dd></dl>
<p>Reimplemented in <a class="el" href="classicu_1_1RuleBasedBreakIterator.html#a49e5fa6fabba66a1b862eb3725f14b0d">icu::RuleBasedBreakIterator</a>.</p>
</div>
</div>
<a class="anchor" id="a290f5be64b2dffdfd707b4cdb602379b"></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="classicu_1_1CharacterIterator.html">CharacterIterator</a>& icu::BreakIterator::getText </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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return a <a class="el" href="classicu_1_1CharacterIterator.html" title="Abstract class that defines an API for iteration on text objects. ">CharacterIterator</a> over the text being analyzed. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000021">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Implemented in <a class="el" href="classicu_1_1RuleBasedBreakIterator.html#a1fcfcea9894445d31b9b88e8fed2a266">icu::RuleBasedBreakIterator</a>.</p>
</div>
</div>
<a class="anchor" id="af57b33540abfb9c41e9f1e54974d0559"></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="structUText.html">UText</a>* icu::BreakIterator::getUText </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structUText.html">UText</a> * </td>
<td class="paramname"><em>fillIn</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"><em>status</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a <a class="el" href="structUText.html" title="UText struct. ">UText</a> for the text being analyzed. </p>
<p>The returned <a class="el" href="structUText.html" title="UText struct. ">UText</a> is a shallow clone of the <a class="el" href="structUText.html" title="UText struct. ">UText</a> used internally by the break iterator implementation. It can safely be used to access the text without impacting any break iterator operations, but the underlying text itself must not be altered.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fillIn</td><td>A <a class="el" href="structUText.html" title="UText struct. ">UText</a> to be filled in. If NULL, a new <a class="el" href="structUText.html" title="UText struct. ">UText</a> will be allocated to hold the result. </td></tr>
<tr><td class="paramname">status</td><td>receives any error codes. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The current <a class="el" href="structUText.html" title="UText struct. ">UText</a> for this break iterator. If an input <a class="el" href="structUText.html" title="UText struct. ">UText</a> was provided, it will always be returned. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000022">Stable:</a></b></dt><dd>ICU 3.4 </dd></dl>
<p>Implemented in <a class="el" href="classicu_1_1RuleBasedBreakIterator.html#aef461c13b0fd2c107688c5686a5d256e">icu::RuleBasedBreakIterator</a>.</p>
</div>
</div>
<a class="anchor" id="aaf997425386eae9c50cd5c208dbef214"></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="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> icu::BreakIterator::isBoundary </td>
<td>(</td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>offset</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return true if the specfied position is a boundary position. </p>
<p>As a side effect, the current position of the iterator is set to the first boundary position at or following the specified offset. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">offset</td><td>the offset to check. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if "offset" is a boundary position. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000033">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Implemented in <a class="el" href="classicu_1_1RuleBasedBreakIterator.html#ac4a68042aa461be2eeb9940a3d00b37d">icu::RuleBasedBreakIterator</a>.</p>
</div>
</div>
<a class="anchor" id="a20ce3ce8c87b0f5b11527caf0e824fbf"></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="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> icu::BreakIterator::isBufferClone </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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Determine whether the <a class="el" href="classicu_1_1BreakIterator.html" title="The BreakIterator class implements methods for finding the location of boundaries in text...">BreakIterator</a> was created in user memory by <a class="el" href="classicu_1_1BreakIterator.html#ac0b126946521a209ec2c6d490b7db86e" title="Deprecated functionality. ">createBufferClone()</a>, and thus should not be deleted. </p>
<p>Such objects must be closed by an explicit call to the destructor (not delete). </p><dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000002">Deprecated:</a></b></dt><dd>ICU 52. Always delete the <a class="el" href="classicu_1_1BreakIterator.html" title="The BreakIterator class implements methods for finding the location of boundaries in text...">BreakIterator</a>. </dd></dl>
<p>Definition at line <a class="el" href="brkiter_8h_source.html#l00653">653</a> of file <a class="el" href="brkiter_8h_source.html">brkiter.h</a>.</p>
<p>References <a class="el" href="umachine_8h_source.html#l00267">FALSE</a>, and <a class="el" href="uversion_8h_source.html#l00132">U_NAMESPACE_END</a>.</p>
</div>
</div>
<a class="anchor" id="a2ecbdcabef74105eb7f0747011d05e01"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int32_t icu::BreakIterator::last </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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the iterator position to the index immediately BEYOND the last character in the text being scanned. </p>
<dl class="section return"><dt>Returns</dt><dd>The index immediately BEYOND the last character in the text being scanned. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000027">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Implemented in <a class="el" href="classicu_1_1RuleBasedBreakIterator.html#ae76433bea39e818b36dd68fef2d923e9">icu::RuleBasedBreakIterator</a>.</p>
</div>
</div>
<a class="anchor" id="a13468dd341e9f0eb92c61f25e88a5154"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int32_t icu::BreakIterator::next </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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Advance the iterator to the boundary following the current boundary. </p>
<dl class="section return"><dt>Returns</dt><dd>The character index of the next text boundary or DONE if all boundaries have been returned. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000029">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Implemented in <a class="el" href="classicu_1_1RuleBasedBreakIterator.html#a81d13c4995852cfad40af882452fbcba">icu::RuleBasedBreakIterator</a>.</p>
</div>
</div>
<a class="anchor" id="a971257b3ed9676ec02890187025caf1b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int32_t icu::BreakIterator::next </td>
<td>(</td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>n</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the iterator position to the nth boundary from the current boundary. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">n</td><td>the number of boundaries to move by. A value of 0 does nothing. Negative values move to previous boundaries and positive values move to later boundaries. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The new iterator position, or DONE if there are fewer than |n| boundaries in the specfied direction. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000034">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Implemented in <a class="el" href="classicu_1_1RuleBasedBreakIterator.html#ad1ca41106d2b7697a8a88b5ede42bf96">icu::RuleBasedBreakIterator</a>.</p>
</div>
</div>
<a class="anchor" id="a612d1f537c854399c788c0d250623eff"></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="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> icu::BreakIterator::operator!= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classicu_1_1BreakIterator.html">BreakIterator</a> & </td>
<td class="paramname"><em>rhs</em></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>Returns the complement of the result of operator==. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">rhs</td><td>The <a class="el" href="classicu_1_1BreakIterator.html" title="The BreakIterator class implements methods for finding the location of boundaries in text...">BreakIterator</a> to be compared for inequality </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the complement of the result of operator== </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000018">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Definition at line <a class="el" href="brkiter_8h_source.html#l00131">131</a> of file <a class="el" href="brkiter_8h_source.html">brkiter.h</a>.</p>
<p>References <a class="el" href="classicu_1_1UObject.html#a1aa93096e880907080b503ff1fb0f8bc">icu::UObject::getDynamicClassID()</a>, and <a class="el" href="namespaceicu.html#a1c2f6ca43e636f38d1a3291eb851e9f0">icu::operator==()</a>.</p>
</div>
</div>
<a class="anchor" id="a5e65e03f2e505ff1dc01311b01790abc"></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="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> icu::BreakIterator::operator== </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classicu_1_1BreakIterator.html">BreakIterator</a> & </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return true if another object is semantically equal to this one. </p>
<p>The other object should be an instance of the same subclass of <a class="el" href="classicu_1_1BreakIterator.html" title="The BreakIterator class implements methods for finding the location of boundaries in text...">BreakIterator</a>. Objects of different subclasses are considered unequal. </p>
<p>Return true if this <a class="el" href="classicu_1_1BreakIterator.html" title="The BreakIterator class implements methods for finding the location of boundaries in text...">BreakIterator</a> is at the same position in the same text, and is the same class and type (word, line, etc.) of <a class="el" href="classicu_1_1BreakIterator.html" title="The BreakIterator class implements methods for finding the location of boundaries in text...">BreakIterator</a>, as the argument. Text is considered the same if it contains the same characters, it need not be the same object, and styles are not considered. </p><dl class="stable"><dt><b><a class="el" href="stable.html#_stable000017">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Implemented in <a class="el" href="classicu_1_1RuleBasedBreakIterator.html#ada68546c29873051976d36fd66368804">icu::RuleBasedBreakIterator</a>.</p>
<p>Referenced by <a class="el" href="rbbi_8h_source.html#l00726">icu::RuleBasedBreakIterator::operator!=()</a>.</p>
</div>
</div>
<a class="anchor" id="a980f8e8fbe1d37827cacc24f9606399f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int32_t icu::BreakIterator::preceding </td>
<td>(</td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>offset</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the iterator position to the first boundary preceding the specified offset. </p>
<p>The value returned is always smaller than the offset or the value <a class="el" href="classicu_1_1BreakIterator.html#a0174c4360d0cb8d21ecc3e4cea71d035af9daa8410e7f8dc1631f8fc6a8a8115c" title="DONE is returned by previous() and next() after all valid boundaries have been returned. ">BreakIterator.DONE</a> </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">offset</td><td>the offset to begin scanning. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The first boundary before the specified offset. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000032">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Implemented in <a class="el" href="classicu_1_1RuleBasedBreakIterator.html#ac7beaf4da856f4573e15fe756114e32d">icu::RuleBasedBreakIterator</a>.</p>
</div>
</div>
<a class="anchor" id="aeede95a59db8408760b106724dfb7a4d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int32_t icu::BreakIterator::previous </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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the iterator position to the boundary preceding the current boundary. </p>
<dl class="section return"><dt>Returns</dt><dd>The character index of the previous text boundary or DONE if all boundaries have been returned. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000028">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Implemented in <a class="el" href="classicu_1_1RuleBasedBreakIterator.html#a6b566ab3e2b8a8e49d2f0a0415f5a151">icu::RuleBasedBreakIterator</a>.</p>
</div>
</div>
<a class="anchor" id="a88ac5ff907f98e814783267b7fe082a5"></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="classicu_1_1BreakIterator.html">BreakIterator</a>& icu::BreakIterator::refreshInputText </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structUText.html">UText</a> * </td>
<td class="paramname"><em>input</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"><em>status</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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the subject text string upon which the break iterator is operating without changing any other aspect of the matching state. </p>
<p>The new and previous text strings must have the same content.</p>
<p>This function is intended for use in environments where ICU is operating on strings that may move around in memory. It provides a mechanism for notifying ICU that the string has been relocated, and providing a new <a class="el" href="structUText.html" title="UText struct. ">UText</a> to access the string in its new position.</p>
<p>Note that the break iterator implementation never copies the underlying text of a string being processed, but always operates directly on the original text provided by the user. Refreshing simply drops the references to the old text and replaces them with references to the new.</p>
<p>Caution: this function is normally used only by very specialized, system-level code. One example use case is with garbage collection that moves the text in memory.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">input</td><td>The new (moved) text string. </td></tr>
<tr><td class="paramname">status</td><td>Receives errors detected by this function. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>*this</dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000049">Stable:</a></b></dt><dd>ICU 49 </dd></dl>
<p>Implemented in <a class="el" href="classicu_1_1RuleBasedBreakIterator.html#a42cefac1ccd59b8b0bb282c2df26ef73">icu::RuleBasedBreakIterator</a>.</p>
</div>
</div>
<a class="anchor" id="af03207fda29e7eab8adf59fb1788b2cf"></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="umisc_8h.html#ab5905d79ed3b979840cee1d5fd48b4fb">URegistryKey</a> icu::BreakIterator::registerInstance </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classicu_1_1BreakIterator.html">BreakIterator</a> * </td>
<td class="paramname"><em>toAdopt</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classicu_1_1Locale.html">Locale</a> & </td>
<td class="paramname"><em>locale</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="ubrk_8h.html#a026dec40289da8261d787daf3baa588b">UBreakIteratorType</a> </td>
<td class="paramname"><em>kind</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"><em>status</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>Register a new break iterator of the indicated kind, to use in the given locale. </p>
<p>The break iterator will be adopted. Clones of the iterator will be returned if a request for a break iterator of the given kind matches or falls back to this locale. Because ICU may choose to cache BreakIterators internally, this must be called at application startup, prior to any calls to BreakIterator::createXXXInstance to avoid undefined behavior. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">toAdopt</td><td>the <a class="el" href="classicu_1_1BreakIterator.html" title="The BreakIterator class implements methods for finding the location of boundaries in text...">BreakIterator</a> instance to be adopted </td></tr>
<tr><td class="paramname">locale</td><td>the <a class="el" href="classicu_1_1Locale.html" title="A Locale object represents a specific geographical, political, or cultural region. ">Locale</a> for which this instance is to be registered </td></tr>
<tr><td class="paramname">kind</td><td>the type of iterator for which this instance is to be registered </td></tr>
<tr><td class="paramname">status</td><td>the in/out status code, no special meanings are assigned </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a registry key that can be used to unregister this instance </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000045">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl>
</div>
</div>
<a class="anchor" id="a8b894129fb567fded3ed85a7e8ead942"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void icu::BreakIterator::setText </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classicu_1_1UnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"><em>text</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Change the text over which this operates. </p>
<p>The text boundary is reset to the start.</p>
<p>The <a class="el" href="classicu_1_1BreakIterator.html" title="The BreakIterator class implements methods for finding the location of boundaries in text...">BreakIterator</a> will retain a reference to the supplied string. The caller must not modify or delete the text while the <a class="el" href="classicu_1_1BreakIterator.html" title="The BreakIterator class implements methods for finding the location of boundaries in text...">BreakIterator</a> retains the reference.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">text</td><td>The <a class="el" href="classicu_1_1UnicodeString.html" title="UnicodeString is a string class that stores Unicode characters directly and provides similar function...">UnicodeString</a> used to change the text. </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000023">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Implemented in <a class="el" href="classicu_1_1RuleBasedBreakIterator.html#aa751ea4cc941ed62585ac1d2de812ee6">icu::RuleBasedBreakIterator</a>.</p>
</div>
</div>
<a class="anchor" id="a3110dd5111286cd514ea6896ddd8c5bd"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void icu::BreakIterator::setText </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structUText.html">UText</a> * </td>
<td class="paramname"><em>text</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"><em>status</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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reset the break iterator to operate over the text represented by the <a class="el" href="structUText.html" title="UText struct. ">UText</a>. </p>
<p>The iterator position is reset to the start.</p>
<p>This function makes a shallow clone of the supplied <a class="el" href="structUText.html" title="UText struct. ">UText</a>. This means that the caller is free to immediately close or otherwise reuse the Utext that was passed as a parameter, but that the underlying text itself must not be altered while being referenced by the break iterator.</p>
<p>All index positions returned by break iterator functions are native indices from the <a class="el" href="structUText.html" title="UText struct. ">UText</a>. For example, when breaking UTF-8 encoded text, the break positions returned by <a class="el" href="classicu_1_1BreakIterator.html#a13468dd341e9f0eb92c61f25e88a5154" title="Advance the iterator to the boundary following the current boundary. ">next()</a>, <a class="el" href="classicu_1_1BreakIterator.html#aeede95a59db8408760b106724dfb7a4d" title="Set the iterator position to the boundary preceding the current boundary. ">previous()</a>, etc. will be UTF-8 string indices, not UTF-16 positions.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">text</td><td>The <a class="el" href="structUText.html" title="UText struct. ">UText</a> used to change the text. </td></tr>
<tr><td class="paramname">status</td><td>receives any error codes. </td></tr>
</table>
</dd>
</dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000024">Stable:</a></b></dt><dd>ICU 3.4 </dd></dl>
<p>Implemented in <a class="el" href="classicu_1_1RuleBasedBreakIterator.html#a2725705885bda731102965658868d2b3">icu::RuleBasedBreakIterator</a>.</p>
</div>
</div>
<a class="anchor" id="ac89b591636b40ec7a1037d02bfe8d832"></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="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> icu::BreakIterator::unregister </td>
<td>(</td>
<td class="paramtype"><a class="el" href="umisc_8h.html#ab5905d79ed3b979840cee1d5fd48b4fb">URegistryKey</a> </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"><em>status</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>Unregister a previously-registered <a class="el" href="classicu_1_1BreakIterator.html" title="The BreakIterator class implements methods for finding the location of boundaries in text...">BreakIterator</a> using the key returned from the register call. </p>
<p>Key becomes invalid after a successful call and should not be used again. The <a class="el" href="classicu_1_1BreakIterator.html" title="The BreakIterator class implements methods for finding the location of boundaries in text...">BreakIterator</a> corresponding to the key will be deleted. Because ICU may choose to cache BreakIterators internally, this should be called during application shutdown, after all calls to BreakIterator::createXXXInstance to avoid undefined behavior. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">key</td><td>the registry key returned by a previous call to registerInstance </td></tr>
<tr><td class="paramname">status</td><td>the in/out status code, no special meanings are assigned </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>TRUE if the iterator for the key was successfully unregistered </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000046">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="brkiter_8h_source.html">brkiter.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
>
45
