<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>ICU 3.6: BreakIterator Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.7 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li id="current"><a href="classes.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li>
<form action="search.php" method="get">
<table cellspacing="0" cellpadding="0" border="0">
<tr>
<td><label> <u>S</u>earch for </label></td>
<td><input type="text" name="query" value="" size="20" accesskey="s"/></td>
</tr>
</table>
</form>
</li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Data Structures</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>
<h1>BreakIterator Class Reference</h1><!-- doxytag: class="BreakIterator" --><!-- doxytag: inherits="UObject" -->The <a class="el" href="classBreakIterator.html">BreakIterator</a> class implements methods for finding the location of boundaries in text.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="brkiter_8h-source.html">brkiter.h</a>></code>
<p>
<p>Inheritance diagram for BreakIterator:
<p><center><img src="classBreakIterator.png" usemap="#BreakIterator_map" border="0" alt=""></center>
<map name="BreakIterator_map">
<area href="classUObject.html" alt="UObject" shape="rect" coords="0,56,145,80">
<area href="classUMemory.html" alt="UMemory" shape="rect" coords="0,0,145,24">
<area href="classRuleBasedBreakIterator.html" alt="RuleBasedBreakIterator" shape="rect" coords="0,168,145,192">
</map>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBreakIterator.html#2aa0536d39ff4796ad283662f4d0bf0befef78b27572b25b7f6d320db401e205">DONE</a> = (<a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a>)-1</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">DONE is returned by <a class="el" href="classBreakIterator.html#a245cdcd24ee757fc8ddee98b6757a16">previous()</a> and <a class="el" href="classBreakIterator.html#4c90f5921eb3ee28194c78fbe0381e7b">next()</a> after all valid boundaries have been returned. <a href="#2aa0536d39ff4796ad283662f4d0bf0befef78b27572b25b7f6d320db401e205"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom">{ <a class="el" href="classBreakIterator.html#2aa0536d39ff4796ad283662f4d0bf0befef78b27572b25b7f6d320db401e205">DONE</a> = (int32_t)-1
}</td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classBreakIterator.html#a52f5bcdc67ad6c96093c572e93e40ec">~BreakIterator</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">destructor <a href="#a52f5bcdc67ad6c96093c572e93e40ec"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="umachine_8h.html#d373ce262c37cc047b0df2ad7b5dbba7">UBool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBreakIterator.html#e451dd25cd5589187849dcc9da81a5c9">operator==</a> (const <a class="el" href="classBreakIterator.html">BreakIterator</a> &) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return true if another object is semantically equal to this one. <a href="#e451dd25cd5589187849dcc9da81a5c9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="umachine_8h.html#d373ce262c37cc047b0df2ad7b5dbba7">UBool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBreakIterator.html#bc1382a5ea667d4d4ec68c8c22f4e711">operator!=</a> (const <a class="el" href="classBreakIterator.html">BreakIterator</a> &rhs) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the complement of the result of operator==. <a href="#bc1382a5ea667d4d4ec68c8c22f4e711"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classBreakIterator.html">BreakIterator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classBreakIterator.html#1b3ad99b8a2b1c62da1db097498f5b70">clone</a> (void) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a polymorphic copy of this object. <a href="#1b3ad99b8a2b1c62da1db097498f5b70"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="utypes_8h.html#452dc3c7d14eb1a1837ae1aa0b2d6724">UClassID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBreakIterator.html#2bfb69ee6fded0bdef64ac8fb6893c17">getDynamicClassID</a> (void) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a polymorphic class ID for this object. <a href="#2bfb69ee6fded0bdef64ac8fb6893c17"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classCharacterIterator.html">CharacterIterator</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classBreakIterator.html#b6f982f723d197c5dc75d8c19d64d19b">getText</a> (void) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a <a class="el" href="classCharacterIterator.html">CharacterIterator</a> over the text being analyzed. <a href="#b6f982f723d197c5dc75d8c19d64d19b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="structUText.html">UText</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classBreakIterator.html#72a648af03795a07cbe77cb21d0f193a">getUText</a> (<a class="el" href="structUText.html">UText</a> *fillIn, <a class="el" href="utypes_8h.html#863c11989634c998849cc946d04dfabe">UErrorCode</a> &status) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a <a class="el" href="structUText.html">UText</a> for the text being analyzed. <a href="#72a648af03795a07cbe77cb21d0f193a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classBreakIterator.html#abbf30bf5ba6f776e2ae7011f9cc1cce">setText</a> (const <a class="el" href="classUnicodeString.html">UnicodeString</a> &text)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Change the text over which this operates. <a href="#abbf30bf5ba6f776e2ae7011f9cc1cce"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classBreakIterator.html#229b0c908708da0278a01f14bd9df813">setText</a> (<a class="el" href="structUText.html">UText</a> *text, <a class="el" href="utypes_8h.html#863c11989634c998849cc946d04dfabe">UErrorCode</a> &status)=0</td></tr>
<tr><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">UText</a>. <a href="#229b0c908708da0278a01f14bd9df813"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classBreakIterator.html#b1c1392ce46a41893625be1a897d73d3">adoptText</a> (<a class="el" href="classCharacterIterator.html">CharacterIterator</a> *it)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Change the text over which this operates. <a href="#b1c1392ce46a41893625be1a897d73d3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBreakIterator.html#ef340a0afba53124b68575a6bb62afae">first</a> (void)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the index of the first character in the text being scanned. <a href="#ef340a0afba53124b68575a6bb62afae"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBreakIterator.html#04eddb92724a467a6706412374fd281b">last</a> (void)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the index immediately BEYOND the last character in the text being scanned. <a href="#04eddb92724a467a6706412374fd281b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBreakIterator.html#a245cdcd24ee757fc8ddee98b6757a16">previous</a> (void)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the boundary preceding the current boundary. <a href="#a245cdcd24ee757fc8ddee98b6757a16"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBreakIterator.html#4c90f5921eb3ee28194c78fbe0381e7b">next</a> (void)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the boundary following the current boundary. <a href="#4c90f5921eb3ee28194c78fbe0381e7b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBreakIterator.html#aaf316c36e7fab609606cb1b3978634c">current</a> (void) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return character index of the current interator position within the text. <a href="#aaf316c36e7fab609606cb1b3978634c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBreakIterator.html#b5d786b064729a64cc407d5f61766715">following</a> (<a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> offset)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the first boundary following the specified offset. <a href="#b5d786b064729a64cc407d5f61766715"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBreakIterator.html#ae2543da1eba3d3eec6bf9836cc25f72">preceding</a> (<a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> offset)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the first boundary preceding the specified offset. <a href="#ae2543da1eba3d3eec6bf9836cc25f72"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="umachine_8h.html#d373ce262c37cc047b0df2ad7b5dbba7">UBool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBreakIterator.html#6d54a0784025e22fcf5542f506bafa96">isBoundary</a> (<a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> offset)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return true if the specfied position is a boundary position. <a href="#6d54a0784025e22fcf5542f506bafa96"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBreakIterator.html#611bf3ce47935d89efb377332f8b57d1">next</a> (<a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> n)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the nth boundary from the current boundary. <a href="#611bf3ce47935d89efb377332f8b57d1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classBreakIterator.html">BreakIterator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classBreakIterator.html#7eb6abd3ffde83cc7095611640bd8ad7">createBufferClone</a> (void *stackBuffer, <a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> &BufferSize, <a class="el" href="utypes_8h.html#863c11989634c998849cc946d04dfabe">UErrorCode</a> &status)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Thread safe client-buffer-based cloning operation Do NOT call delete on a safeclone, since 'new' is not used to create it. <a href="#7eb6abd3ffde83cc7095611640bd8ad7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="umachine_8h.html#d373ce262c37cc047b0df2ad7b5dbba7">UBool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBreakIterator.html#b229062b0980198ef27d3bd7de5ac592">isBufferClone</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Determine whether the <a class="el" href="classBreakIterator.html">BreakIterator</a> was created in user memory by <a class="el" href="classBreakIterator.html#7eb6abd3ffde83cc7095611640bd8ad7">createBufferClone()</a>, and thus should not be deleted. <a href="#b229062b0980198ef27d3bd7de5ac592"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classLocale.html">Locale</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBreakIterator.html#9a3c0a06d5c661773ea1937087df43a8">getLocale</a> (<a class="el" href="uloc_8h.html#6de2f28093c32f13fb2527413bfcbef9">ULocDataLocaleType</a> type, <a class="el" href="utypes_8h.html#863c11989634c998849cc946d04dfabe">UErrorCode</a> &status) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the locale for this break iterator. <a href="#9a3c0a06d5c661773ea1937087df43a8"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classBreakIterator.html#efef1d872021fbfe14c8c9b1d746db2e">getLocaleID</a> (<a class="el" href="uloc_8h.html#6de2f28093c32f13fb2527413bfcbef9">ULocDataLocaleType</a> type, <a class="el" href="utypes_8h.html#863c11989634c998849cc946d04dfabe">UErrorCode</a> &status) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the locale for this break iterator object. <a href="#efef1d872021fbfe14c8c9b1d746db2e"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classBreakIterator.html">BreakIterator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classBreakIterator.html#5263e124f3eb73d937a0bb20fc667e7a">createWordInstance</a> (const <a class="el" href="classLocale.html">Locale</a> &where, <a class="el" href="utypes_8h.html#863c11989634c998849cc946d04dfabe">UErrorCode</a> &status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create <a class="el" href="classBreakIterator.html">BreakIterator</a> for word-breaks using the given locale. <a href="#5263e124f3eb73d937a0bb20fc667e7a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classBreakIterator.html">BreakIterator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classBreakIterator.html#4b6bb7df44016f850093bc11824a7aee">createLineInstance</a> (const <a class="el" href="classLocale.html">Locale</a> &where, <a class="el" href="utypes_8h.html#863c11989634c998849cc946d04dfabe">UErrorCode</a> &status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create <a class="el" href="classBreakIterator.html">BreakIterator</a> for line-breaks using specified locale. <a href="#4b6bb7df44016f850093bc11824a7aee"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classBreakIterator.html">BreakIterator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classBreakIterator.html#6c156f24b909f5b513ecfc8d8916fe7a">createCharacterInstance</a> (const <a class="el" href="classLocale.html">Locale</a> &where, <a class="el" href="utypes_8h.html#863c11989634c998849cc946d04dfabe">UErrorCode</a> &status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create <a class="el" href="classBreakIterator.html">BreakIterator</a> for character-breaks using specified locale Returns an instance of a <a class="el" href="classBreakIterator.html">BreakIterator</a> implementing character breaks. <a href="#6c156f24b909f5b513ecfc8d8916fe7a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classBreakIterator.html">BreakIterator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classBreakIterator.html#27c6a330d5caab91216a8ed7896b56b1">createSentenceInstance</a> (const <a class="el" href="classLocale.html">Locale</a> &where, <a class="el" href="utypes_8h.html#863c11989634c998849cc946d04dfabe">UErrorCode</a> &status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create <a class="el" href="classBreakIterator.html">BreakIterator</a> for sentence-breaks using specified locale Returns an instance of a <a class="el" href="classBreakIterator.html">BreakIterator</a> implementing sentence breaks. <a href="#27c6a330d5caab91216a8ed7896b56b1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classBreakIterator.html">BreakIterator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classBreakIterator.html#5d4d2822fa72c469f741da2d175a55be">createTitleInstance</a> (const <a class="el" href="classLocale.html">Locale</a> &where, <a class="el" href="utypes_8h.html#863c11989634c998849cc946d04dfabe">UErrorCode</a> &status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create <a class="el" href="classBreakIterator.html">BreakIterator</a> for title-casing breaks using the specified locale Returns an instance of a <a class="el" href="classBreakIterator.html">BreakIterator</a> implementing title breaks. <a href="#5d4d2822fa72c469f741da2d175a55be"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static const <a class="el" href="classLocale.html">Locale</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classBreakIterator.html#b33fdc9de4a55d5f4f1f0a233bc593b4">getAvailableLocales</a> (<a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> &count)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the set of Locales for which TextBoundaries are installed. <a href="#b33fdc9de4a55d5f4f1f0a233bc593b4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classUnicodeString.html">UnicodeString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classBreakIterator.html#b074d2eb0d4856a447c4e2e8939d2a6d">getDisplayName</a> (const <a class="el" href="classLocale.html">Locale</a> &objectLocale, const <a class="el" href="classLocale.html">Locale</a> &displayLocale, <a class="el" href="classUnicodeString.html">UnicodeString</a> &name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get name of the object for the desired <a class="el" href="classLocale.html">Locale</a>, in the desired langauge. <a href="#b074d2eb0d4856a447c4e2e8939d2a6d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classUnicodeString.html">UnicodeString</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classBreakIterator.html#fa06c460efb5cf8a0c394b6c16b550e7">getDisplayName</a> (const <a class="el" href="classLocale.html">Locale</a> &objectLocale, <a class="el" href="classUnicodeString.html">UnicodeString</a> &name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get name of the object for the desired <a class="el" href="classLocale.html">Locale</a>, in the langauge of the default locale. <a href="#fa06c460efb5cf8a0c394b6c16b550e7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="umisc_8h.html#c843777e019f4bd8c4aa698f7e50220f">URegistryKey</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBreakIterator.html#a8fd238ba5483e78711b4b528db6182a">registerInstance</a> (<a class="el" href="classBreakIterator.html">BreakIterator</a> *toAdopt, const <a class="el" href="classLocale.html">Locale</a> &locale, <a class="el" href="ubrk_8h.html#9ed6724d16a248ce8b7dd478450760f1">UBreakIteratorType</a> kind, <a class="el" href="utypes_8h.html#863c11989634c998849cc946d04dfabe">UErrorCode</a> &status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Register a new break iterator of the indicated kind, to use in the given locale. <a href="#a8fd238ba5483e78711b4b528db6182a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="umachine_8h.html#d373ce262c37cc047b0df2ad7b5dbba7">UBool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBreakIterator.html#d8a2c24ab751a8fc87e7694aeeec885a">unregister</a> (<a class="el" href="umisc_8h.html#c843777e019f4bd8c4aa698f7e50220f">URegistryKey</a> key, <a class="el" href="utypes_8h.html#863c11989634c998849cc946d04dfabe">UErrorCode</a> &status)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Unregister a previously-registered <a class="el" href="classBreakIterator.html">BreakIterator</a> using the key returned from the register call. <a href="#d8a2c24ab751a8fc87e7694aeeec885a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classStringEnumeration.html">StringEnumeration</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classBreakIterator.html#dd8ed1ea737beafe0020ace21b3c3683">getAvailableLocales</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a <a class="el" href="classStringEnumeration.html">StringEnumeration</a> over the locales available at the time of the call, including registered locales. <a href="#dd8ed1ea737beafe0020ace21b3c3683"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBreakIterator.html#466cc1e2110b3e199da073d30093ec6a">BreakIterator</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBreakIterator.html#c4dcce25adefe6846873a83d6f20213a">BreakIterator</a> (const <a class="el" href="classBreakIterator.html">BreakIterator</a> &other)</td></tr>
<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="umachine_8h.html#d373ce262c37cc047b0df2ad7b5dbba7">UBool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBreakIterator.html#09e129551708ddbef72959685ce8f0fd">fBufferClone</a></td></tr>
<tr><td colspan="2"><br><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4ec979fcd6cb0b693d0b99d40ad75df4"></a><!-- doxytag: member="BreakIterator::ICUBreakIteratorFactory" ref="4ec979fcd6cb0b693d0b99d40ad75df4" args="" -->
class </td><td class="memItemRight" valign="bottom"><a class="el" href="classBreakIterator.html#4ec979fcd6cb0b693d0b99d40ad75df4">ICUBreakIteratorFactory</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0db88d64c684e2030e6cd70299ac649f"></a><!-- doxytag: member="BreakIterator::ICUBreakIteratorService" ref="0db88d64c684e2030e6cd70299ac649f" args="" -->
class </td><td class="memItemRight" valign="bottom"><a class="el" href="classBreakIterator.html#0db88d64c684e2030e6cd70299ac649f">ICUBreakIteratorService</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The <a class="el" href="classBreakIterator.html">BreakIterator</a> class implements methods for finding the location of boundaries in text.
<p>
<a class="el" href="classBreakIterator.html">BreakIterator</a> is an abstract base class. Instances of <a class="el" href="classBreakIterator.html">BreakIterator</a> maintain a current position and scan over text returning the index of characters where boundaries occur. <p>
Line boundary analysis determines where a text string can be broken when line-wrapping. The mechanism correctly handles punctuation and hyphenated words. <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>
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>
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>
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>
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">ubrk.h</a> <p>
Code snippits illustrating the use of the Break Iterator APIs are available in the ICU User Guide, <a href="http://icu.sourceforge.net/userguide/boundaryAnalysis.html">http://icu.sourceforge.net/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#l00100">100</a> of file <a class="el" href="brkiter_8h-source.html">brkiter.h</a>.<hr><h2>Member Enumeration Documentation</h2>
<a class="anchor" name="2aa0536d39ff4796ad283662f4d0bf0b"></a><!-- doxytag: member="BreakIterator::@0" ref="2aa0536d39ff4796ad283662f4d0bf0b" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">anonymous enum </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="2aa0536d39ff4796ad283662f4d0bf0befef78b27572b25b7f6d320db401e205"></a><!-- doxytag: member="DONE" ref="2aa0536d39ff4796ad283662f4d0bf0befef78b27572b25b7f6d320db401e205" args="" -->DONE</em> </td><td>
DONE is returned by <a class="el" href="classBreakIterator.html#a245cdcd24ee757fc8ddee98b6757a16">previous()</a> and <a class="el" href="classBreakIterator.html#4c90f5921eb3ee28194c78fbe0381e7b">next()</a> after all valid boundaries have been returned.
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable000032">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="brkiter_8h-source.html#l00201">201</a> of file <a class="el" href="brkiter_8h-source.html">brkiter.h</a>.
</div>
</div><p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="a52f5bcdc67ad6c96093c572e93e40ec"></a><!-- doxytag: member="BreakIterator::~BreakIterator" ref="a52f5bcdc67ad6c96093c572e93e40ec" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual BreakIterator::~BreakIterator </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
destructor
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable000001">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="466cc1e2110b3e199da073d30093ec6a"></a><!-- doxytag: member="BreakIterator::BreakIterator" ref="466cc1e2110b3e199da073d30093ec6a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">BreakIterator::BreakIterator </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<dl compact><dt><b><a class="el" href="internal.html#_internal000002">Internal:</a></b></dt><dd>Do not use. This API is for interal use only. </dd></dl>
</div>
</div><p>
<a class="anchor" name="c4dcce25adefe6846873a83d6f20213a"></a><!-- doxytag: member="BreakIterator::BreakIterator" ref="c4dcce25adefe6846873a83d6f20213a" args="(const BreakIterator &other)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">BreakIterator::BreakIterator </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classBreakIterator.html">BreakIterator</a> & </td>
<td class="paramname"> <em>other</em> </td>
<td> ) </td>
<td width="100%"><code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<dl compact><dt><b><a class="el" href="internal.html#_internal000004">Internal:</a></b></dt><dd>Do not use. This API is for interal use only. </dd></dl>
<p>
Definition at line <a class="el" href="brkiter_8h-source.html#l00531">531</a> of file <a class="el" href="brkiter_8h-source.html">brkiter.h</a>.
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="b1c1392ce46a41893625be1a897d73d3"></a><!-- doxytag: member="BreakIterator::adoptText" ref="b1c1392ce46a41893625be1a897d73d3" args="(CharacterIterator *it)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void BreakIterator::adoptText </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCharacterIterator.html">CharacterIterator</a> * </td>
<td class="paramname"> <em>it</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Change the text over which this operates.
<p>
The text boundary is reset to the start. Note that setText(UText *) provides similar functionality to this function, and is more efficient. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>it</em> </td><td>The <a class="el" href="classCharacterIterator.html">CharacterIterator</a> used to change the text. </td></tr>
</table>
</dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000008">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Implemented in <a class="el" href="classRuleBasedBreakIterator.html#98462db1240659d794abc3a8ff7392b2">RuleBasedBreakIterator</a>.
</div>
</div><p>
<a class="anchor" name="1b3ad99b8a2b1c62da1db097498f5b70"></a><!-- doxytag: member="BreakIterator::clone" ref="1b3ad99b8a2b1c62da1db097498f5b70" args="(void) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classBreakIterator.html">BreakIterator</a>* BreakIterator::clone </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return a polymorphic copy of this object.
<p>
This is an abstract method which subclasses implement. <dl compact><dt><b><a class="el" href="stable.html#_stable000004">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Implemented in <a class="el" href="classRuleBasedBreakIterator.html#4436f3bb8f155e95858d75466335ceaf">RuleBasedBreakIterator</a>.
</div>
</div><p>
<a class="anchor" name="7eb6abd3ffde83cc7095611640bd8ad7"></a><!-- doxytag: member="BreakIterator::createBufferClone" ref="7eb6abd3ffde83cc7095611640bd8ad7" args="(void *stackBuffer, int32_t &BufferSize, UErrorCode &status)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classBreakIterator.html">BreakIterator</a>* 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"><a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> & </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#863c11989634c998849cc946d04dfabe">UErrorCode</a> & </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<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 compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>stackBuffer</em> </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 valign="top"></td><td valign="top"><em>BufferSize</em> </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 valign="top"></td><td valign="top"><em>status</em> </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>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>pointer to the new clone</dd></dl>
<dl compact><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="classRuleBasedBreakIterator.html#198edebe5e848e3ba32bfa8071e88b2b">RuleBasedBreakIterator</a>.
</div>
</div><p>
<a class="anchor" name="6c156f24b909f5b513ecfc8d8916fe7a"></a><!-- doxytag: member="BreakIterator::createCharacterInstance" ref="6c156f24b909f5b513ecfc8d8916fe7a" args="(const Locale &where, UErrorCode &status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classBreakIterator.html">BreakIterator</a>* BreakIterator::createCharacterInstance </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classLocale.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#863c11989634c998849cc946d04dfabe">UErrorCode</a> & </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create <a class="el" href="classBreakIterator.html">BreakIterator</a> for character-breaks using specified locale Returns an instance of a <a class="el" href="classBreakIterator.html">BreakIterator</a> implementing character breaks.
<p>
Character breaks are boundaries of combining character sequences. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>where</em> </td><td>the locale. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>The error code. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>A <a class="el" href="classBreakIterator.html">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#66bf50e5fe117e762c90f1a1fd9c297e">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 compact><dt><b><a class="el" href="stable.html#_stable000020">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="4b6bb7df44016f850093bc11824a7aee"></a><!-- doxytag: member="BreakIterator::createLineInstance" ref="4b6bb7df44016f850093bc11824a7aee" args="(const Locale &where, UErrorCode &status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classBreakIterator.html">BreakIterator</a>* BreakIterator::createLineInstance </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classLocale.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#863c11989634c998849cc946d04dfabe">UErrorCode</a> & </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create <a class="el" href="classBreakIterator.html">BreakIterator</a> for line-breaks using specified locale.
<p>
Returns an instance of a <a class="el" href="classBreakIterator.html">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. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>where</em> </td><td>the locale. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>The error code. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>A <a class="el" href="classBreakIterator.html">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#66bf50e5fe117e762c90f1a1fd9c297e">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 compact><dt><b><a class="el" href="stable.html#_stable000019">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="27c6a330d5caab91216a8ed7896b56b1"></a><!-- doxytag: member="BreakIterator::createSentenceInstance" ref="27c6a330d5caab91216a8ed7896b56b1" args="(const Locale &where, UErrorCode &status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classBreakIterator.html">BreakIterator</a>* BreakIterator::createSentenceInstance </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classLocale.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#863c11989634c998849cc946d04dfabe">UErrorCode</a> & </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create <a class="el" href="classBreakIterator.html">BreakIterator</a> for sentence-breaks using specified locale Returns an instance of a <a class="el" href="classBreakIterator.html">BreakIterator</a> implementing sentence breaks.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>where</em> </td><td>the locale. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>The error code. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>A <a class="el" href="classBreakIterator.html">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#66bf50e5fe117e762c90f1a1fd9c297e">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 compact><dt><b><a class="el" href="stable.html#_stable000021">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="5d4d2822fa72c469f741da2d175a55be"></a><!-- doxytag: member="BreakIterator::createTitleInstance" ref="5d4d2822fa72c469f741da2d175a55be" args="(const Locale &where, UErrorCode &status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classBreakIterator.html">BreakIterator</a>* BreakIterator::createTitleInstance </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classLocale.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#863c11989634c998849cc946d04dfabe">UErrorCode</a> & </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create <a class="el" href="classBreakIterator.html">BreakIterator</a> for title-casing breaks using the specified locale Returns an instance of a <a class="el" href="classBreakIterator.html">BreakIterator</a> implementing title breaks.
<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="classBreakIterator.html#5263e124f3eb73d937a0bb20fc667e7a">createWordInstance</a><p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>where</em> </td><td>the locale. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>The error code. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>A <a class="el" href="classBreakIterator.html">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#66bf50e5fe117e762c90f1a1fd9c297e">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 compact><dt><b><a class="el" href="stable.html#_stable000022">Stable:</a></b></dt><dd>ICU 2.1 </dd></dl>
</div>
</div><p>
<a class="anchor" name="5263e124f3eb73d937a0bb20fc667e7a"></a><!-- doxytag: member="BreakIterator::createWordInstance" ref="5263e124f3eb73d937a0bb20fc667e7a" args="(const Locale &where, UErrorCode &status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classBreakIterator.html">BreakIterator</a>* BreakIterator::createWordInstance </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classLocale.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#863c11989634c998849cc946d04dfabe">UErrorCode</a> & </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create <a class="el" href="classBreakIterator.html">BreakIterator</a> for word-breaks using the given locale.
<p>
Returns an instance of a <a class="el" href="classBreakIterator.html">BreakIterator</a> implementing word breaks. WordBreak is useful for word selection (ex. double click) <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>where</em> </td><td>the locale. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>the error code </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>A <a class="el" href="classBreakIterator.html">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#66bf50e5fe117e762c90f1a1fd9c297e">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 compact><dt><b><a class="el" href="stable.html#_stable000018">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="aaf316c36e7fab609606cb1b3978634c"></a><!-- doxytag: member="BreakIterator::current" ref="aaf316c36e7fab609606cb1b3978634c" args="(void) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> BreakIterator::current </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return character index of the current interator position within the text.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>The boundary most recently returned. </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000013">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Implemented in <a class="el" href="classRuleBasedBreakIterator.html#a58eaca177138d6906bd98776eb31872">RuleBasedBreakIterator</a>.
</div>
</div><p>
<a class="anchor" name="ef340a0afba53124b68575a6bb62afae"></a><!-- doxytag: member="BreakIterator::first" ref="ef340a0afba53124b68575a6bb62afae" args="(void)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> BreakIterator::first </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the index of the first character in the text being scanned.
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable000009">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Implemented in <a class="el" href="classRuleBasedBreakIterator.html#74ca2752f7373e3b93ef3a65b9eef4f1">RuleBasedBreakIterator</a>.
</div>
</div><p>
<a class="anchor" name="b5d786b064729a64cc407d5f61766715"></a><!-- doxytag: member="BreakIterator::following" ref="b5d786b064729a64cc407d5f61766715" args="(int32_t offset)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> BreakIterator::following </td>
<td>(</td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> </td>
<td class="paramname"> <em>offset</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the first boundary following the specified offset.
<p>
The value returned is always greater than the offset or the value <a class="el" href="classBreakIterator.html#2aa0536d39ff4796ad283662f4d0bf0befef78b27572b25b7f6d320db401e205">BreakIterator.DONE</a> <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>offset</em> </td><td>the offset to begin scanning. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The first boundary after the specified offset. </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000014">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Implemented in <a class="el" href="classRuleBasedBreakIterator.html#5cfd18955236c778aadb507356ed3813">RuleBasedBreakIterator</a>.
</div>
</div><p>
<a class="anchor" name="dd8ed1ea737beafe0020ace21b3c3683"></a><!-- doxytag: member="BreakIterator::getAvailableLocales" ref="dd8ed1ea737beafe0020ace21b3c3683" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classStringEnumeration.html">StringEnumeration</a>* BreakIterator::getAvailableLocales </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return a <a class="el" href="classStringEnumeration.html">StringEnumeration</a> over the locales available at the time of the call, including registered locales.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>a <a class="el" href="classStringEnumeration.html">StringEnumeration</a> over the locales available at the time of the call </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000030">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl>
</div>
</div><p>
<a class="anchor" name="b33fdc9de4a55d5f4f1f0a233bc593b4"></a><!-- doxytag: member="BreakIterator::getAvailableLocales" ref="b33fdc9de4a55d5f4f1f0a233bc593b4" args="(int32_t &count)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static const <a class="el" href="classLocale.html">Locale</a>* BreakIterator::getAvailableLocales </td>
<td>(</td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> & </td>
<td class="paramname"> <em>count</em> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the set of Locales for which TextBoundaries are installed.
<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="classStringEnumeration.html">StringEnumeration</a> object <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>count</em> </td><td>the output parameter of number of elements in the locale list </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>available locales </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000023">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="fa06c460efb5cf8a0c394b6c16b550e7"></a><!-- doxytag: member="BreakIterator::getDisplayName" ref="fa06c460efb5cf8a0c394b6c16b550e7" args="(const Locale &objectLocale, UnicodeString &name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classUnicodeString.html">UnicodeString</a>& BreakIterator::getDisplayName </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classLocale.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="classUnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"> <em>name</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get name of the object for the desired <a class="el" href="classLocale.html">Locale</a>, in the langauge of the default locale.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>objectLocale</em> </td><td>must be from getMatchingLocales </td></tr>
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>the fill-in parameter of the return value </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>user-displayable name </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000025">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="b074d2eb0d4856a447c4e2e8939d2a6d"></a><!-- doxytag: member="BreakIterator::getDisplayName" ref="b074d2eb0d4856a447c4e2e8939d2a6d" args="(const Locale &objectLocale, const Locale &displayLocale, UnicodeString &name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classUnicodeString.html">UnicodeString</a>& BreakIterator::getDisplayName </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classLocale.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="classLocale.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="classUnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"> <em>name</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get name of the object for the desired <a class="el" href="classLocale.html">Locale</a>, in the desired langauge.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>objectLocale</em> </td><td>must be from getAvailableLocales. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>displayLocale</em> </td><td>specifies the desired locale for output. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>the fill-in parameter of the return value Uses best match. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>user-displayable name </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000024">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="2bfb69ee6fded0bdef64ac8fb6893c17"></a><!-- doxytag: member="BreakIterator::getDynamicClassID" ref="2bfb69ee6fded0bdef64ac8fb6893c17" args="(void) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="utypes_8h.html#452dc3c7d14eb1a1837ae1aa0b2d6724">UClassID</a> BreakIterator::getDynamicClassID </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return a polymorphic class ID for this object.
<p>
Different subclasses will return distinct unequal values. <dl compact><dt><b><a class="el" href="stable.html#_stable000005">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Implements <a class="el" href="classUObject.html#60f3fba82b9d7edfe3d3f9d423ab826d">UObject</a>.
<p>
Implemented in <a class="el" href="classRuleBasedBreakIterator.html#52a1eadc1543c8af1227ce43ab465ee1">RuleBasedBreakIterator</a>.
</div>
</div><p>
<a class="anchor" name="9a3c0a06d5c661773ea1937087df43a8"></a><!-- doxytag: member="BreakIterator::getLocale" ref="9a3c0a06d5c661773ea1937087df43a8" args="(ULocDataLocaleType type, UErrorCode &status) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classLocale.html">Locale</a> BreakIterator::getLocale </td>
<td>(</td>
<td class="paramtype"><a class="el" href="uloc_8h.html#6de2f28093c32f13fb2527413bfcbef9">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#863c11989634c998849cc946d04dfabe">UErrorCode</a> & </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the locale for this break iterator.
<p>
Two flavors are available: valid and actual locale. <dl compact><dt><b><a class="el" href="stable.html#_stable000031">Stable:</a></b></dt><dd>ICU 2.8 </dd></dl>
</div>
</div><p>
<a class="anchor" name="efef1d872021fbfe14c8c9b1d746db2e"></a><!-- doxytag: member="BreakIterator::getLocaleID" ref="efef1d872021fbfe14c8c9b1d746db2e" args="(ULocDataLocaleType type, UErrorCode &status) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* BreakIterator::getLocaleID </td>
<td>(</td>
<td class="paramtype"><a class="el" href="uloc_8h.html#6de2f28093c32f13fb2527413bfcbef9">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#863c11989634c998849cc946d04dfabe">UErrorCode</a> & </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the locale for this break iterator object.
<p>
You can choose between valid and actual locale. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>type of the locale we're looking for (valid or actual) </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>error code for the operation </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>the locale </dd></dl>
<dl compact><dt><b><a class="el" href="internal.html#_internal000001">Internal:</a></b></dt><dd>Do not use. This API is for interal use only. </dd></dl>
</div>
</div><p>
<a class="anchor" name="b6f982f723d197c5dc75d8c19d64d19b"></a><!-- doxytag: member="BreakIterator::getText" ref="b6f982f723d197c5dc75d8c19d64d19b" args="(void) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classCharacterIterator.html">CharacterIterator</a>& BreakIterator::getText </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return a <a class="el" href="classCharacterIterator.html">CharacterIterator</a> over the text being analyzed.
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable000006">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Implemented in <a class="el" href="classRuleBasedBreakIterator.html#0125bd065000642f14bc7ca979564421">RuleBasedBreakIterator</a>.
</div>
</div><p>
<a class="anchor" name="72a648af03795a07cbe77cb21d0f193a"></a><!-- doxytag: member="BreakIterator::getUText" ref="72a648af03795a07cbe77cb21d0f193a" args="(UText *fillIn, UErrorCode &status) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="structUText.html">UText</a>* 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#863c11989634c998849cc946d04dfabe">UErrorCode</a> & </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get a <a class="el" href="structUText.html">UText</a> for the text being analyzed.
<p>
The returned <a class="el" href="structUText.html">UText</a> is a shallow clone of the <a class="el" href="structUText.html">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 compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>fillIn</em> </td><td>A <a class="el" href="structUText.html">UText</a> to be filled in. If NULL, a new <a class="el" href="structUText.html">UText</a> will be allocated to hold the result. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>receives any error codes. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The current <a class="el" href="structUText.html">UText</a> for this break iterator. If an input <a class="el" href="structUText.html">UText</a> was provided, it will always be returned. </dd></dl>
<dl compact><dt><b><a class="el" href="draft.html#_draft000001">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 3.4 </dd></dl>
<p>
Implemented in <a class="el" href="classRuleBasedBreakIterator.html#ac79b8728d45693b05eab2155a868ba0">RuleBasedBreakIterator</a>.
</div>
</div><p>
<a class="anchor" name="6d54a0784025e22fcf5542f506bafa96"></a><!-- doxytag: member="BreakIterator::isBoundary" ref="6d54a0784025e22fcf5542f506bafa96" args="(int32_t offset)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="umachine_8h.html#d373ce262c37cc047b0df2ad7b5dbba7">UBool</a> BreakIterator::isBoundary </td>
<td>(</td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> </td>
<td class="paramname"> <em>offset</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return true if the specfied position is a boundary position.
<p>
As a side effect, the current position of the iterator is set to the first boundary position at or following the specified offset. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>offset</em> </td><td>the offset to check. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>True if "offset" is a boundary position. </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000016">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Implemented in <a class="el" href="classRuleBasedBreakIterator.html#f402535b9d72f34d76cae95a38167bdc">RuleBasedBreakIterator</a>.
</div>
</div><p>
<a class="anchor" name="b229062b0980198ef27d3bd7de5ac592"></a><!-- doxytag: member="BreakIterator::isBufferClone" ref="b229062b0980198ef27d3bd7de5ac592" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="umachine_8h.html#d373ce262c37cc047b0df2ad7b5dbba7">UBool</a> BreakIterator::isBufferClone </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Determine whether the <a class="el" href="classBreakIterator.html">BreakIterator</a> was created in user memory by <a class="el" href="classBreakIterator.html#7eb6abd3ffde83cc7095611640bd8ad7">createBufferClone()</a>, and thus should not be deleted.
<p>
Such objects must be closed by an explicit call to the destructor (not delete). <dl compact><dt><b><a class="el" href="stable.html#_stable000027">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Definition at line <a class="el" href="brkiter_8h-source.html#l00546">546</a> of file <a class="el" href="brkiter_8h-source.html">brkiter.h</a>.
<p>
References <a class="el" href="brkiter_8h-source.html#l00529">fBufferClone</a>.
</div>
</div><p>
<a class="anchor" name="04eddb92724a467a6706412374fd281b"></a><!-- doxytag: member="BreakIterator::last" ref="04eddb92724a467a6706412374fd281b" args="(void)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> BreakIterator::last </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the index immediately BEYOND the last character in the text being scanned.
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable000010">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Implemented in <a class="el" href="classRuleBasedBreakIterator.html#e8153a083415e22a29e994f19a1d27b1">RuleBasedBreakIterator</a>.
</div>
</div><p>
<a class="anchor" name="611bf3ce47935d89efb377332f8b57d1"></a><!-- doxytag: member="BreakIterator::next" ref="611bf3ce47935d89efb377332f8b57d1" args="(int32_t n)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> BreakIterator::next </td>
<td>(</td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> </td>
<td class="paramname"> <em>n</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the nth boundary from the current boundary.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>n</em> </td><td>which boundary to return. A value of 0 does nothing. Negative values move to previous boundaries and positive values move to later boundaries. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The index of the nth boundary from the current position, or DONE if there are fewer than |n| boundaries in the specfied direction. </dd></dl>
<dl compact><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="classRuleBasedBreakIterator.html#c8007b96bc2f66b8c9a0c7e590bd56b5">RuleBasedBreakIterator</a>.
</div>
</div><p>
<a class="anchor" name="4c90f5921eb3ee28194c78fbe0381e7b"></a><!-- doxytag: member="BreakIterator::next" ref="4c90f5921eb3ee28194c78fbe0381e7b" args="(void)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> BreakIterator::next </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the boundary following the current boundary.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>The character index of the next text boundary or DONE if all boundaries have been returned. </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000012">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Implemented in <a class="el" href="classRuleBasedBreakIterator.html#864ec1ec46a68238cb2faab291259c92">RuleBasedBreakIterator</a>.
</div>
</div><p>
<a class="anchor" name="bc1382a5ea667d4d4ec68c8c22f4e711"></a><!-- doxytag: member="BreakIterator::operator!=" ref="bc1382a5ea667d4d4ec68c8c22f4e711" args="(const BreakIterator &rhs) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="umachine_8h.html#d373ce262c37cc047b0df2ad7b5dbba7">UBool</a> BreakIterator::operator!= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classBreakIterator.html">BreakIterator</a> & </td>
<td class="paramname"> <em>rhs</em> </td>
<td> ) </td>
<td width="100%"> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the complement of the result of operator==.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>rhs</em> </td><td>The <a class="el" href="classBreakIterator.html">BreakIterator</a> to be compared for inequality </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>the complement of the result of operator== </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000003">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Reimplemented in <a class="el" href="classRuleBasedBreakIterator.html#b8510cd3d5be449d75ff5d61a339f75a">RuleBasedBreakIterator</a>.
<p>
Definition at line <a class="el" href="brkiter_8h-source.html#l00129">129</a> of file <a class="el" href="brkiter_8h-source.html">brkiter.h</a>.
</div>
</div><p>
<a class="anchor" name="e451dd25cd5589187849dcc9da81a5c9"></a><!-- doxytag: member="BreakIterator::operator==" ref="e451dd25cd5589187849dcc9da81a5c9" args="(const BreakIterator &) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="umachine_8h.html#d373ce262c37cc047b0df2ad7b5dbba7">UBool</a> BreakIterator::operator== </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classBreakIterator.html">BreakIterator</a> & </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return true if another object is semantically equal to this one.
<p>
The other object should be an instance of the same subclass of <a class="el" href="classBreakIterator.html">BreakIterator</a>. Objects of different subclasses are considered unequal. <p>
Return true if this <a class="el" href="classBreakIterator.html">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="classBreakIterator.html">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. <dl compact><dt><b><a class="el" href="stable.html#_stable000002">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Implemented in <a class="el" href="classRuleBasedBreakIterator.html#d482d533057b966bbacdc6414eeda09d">RuleBasedBreakIterator</a>.
</div>
</div><p>
<a class="anchor" name="ae2543da1eba3d3eec6bf9836cc25f72"></a><!-- doxytag: member="BreakIterator::preceding" ref="ae2543da1eba3d3eec6bf9836cc25f72" args="(int32_t offset)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> BreakIterator::preceding </td>
<td>(</td>
<td class="paramtype"><a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> </td>
<td class="paramname"> <em>offset</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the first boundary preceding the specified offset.
<p>
The value returned is always smaller than the offset or the value <a class="el" href="classBreakIterator.html#2aa0536d39ff4796ad283662f4d0bf0befef78b27572b25b7f6d320db401e205">BreakIterator.DONE</a> <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>offset</em> </td><td>the offset to begin scanning. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The first boundary before the specified offset. </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000015">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Implemented in <a class="el" href="classRuleBasedBreakIterator.html#6d6abe8b140e9bbc3964c29f3d88837f">RuleBasedBreakIterator</a>.
</div>
</div><p>
<a class="anchor" name="a245cdcd24ee757fc8ddee98b6757a16"></a><!-- doxytag: member="BreakIterator::previous" ref="a245cdcd24ee757fc8ddee98b6757a16" args="(void)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> BreakIterator::previous </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the boundary preceding the current boundary.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>The character index of the previous text boundary or DONE if all boundaries have been returned. </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000011">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Implemented in <a class="el" href="classRuleBasedBreakIterator.html#1526b98261e6c4d7436a21a6a637bfd1">RuleBasedBreakIterator</a>.
</div>
</div><p>
<a class="anchor" name="a8fd238ba5483e78711b4b528db6182a"></a><!-- doxytag: member="BreakIterator::registerInstance" ref="a8fd238ba5483e78711b4b528db6182a" args="(BreakIterator *toAdopt, const Locale &locale, UBreakIteratorType kind, UErrorCode &status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="umisc_8h.html#c843777e019f4bd8c4aa698f7e50220f">URegistryKey</a> BreakIterator::registerInstance </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classBreakIterator.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="classLocale.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#9ed6724d16a248ce8b7dd478450760f1">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#863c11989634c998849cc946d04dfabe">UErrorCode</a> & </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Register a new break iterator of the indicated kind, to use in the given locale.
<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. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>toAdopt</em> </td><td>the <a class="el" href="classBreakIterator.html">BreakIterator</a> instance to be adopted </td></tr>
<tr><td valign="top"></td><td valign="top"><em>locale</em> </td><td>the <a class="el" href="classLocale.html">Locale</a> for which this instance is to be registered </td></tr>
<tr><td valign="top"></td><td valign="top"><em>kind</em> </td><td>the type of iterator for which this instance is to be registered </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>the in/out status code, no special meanings are assigned </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>a registry key that can be used to unregister this instance </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000028">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl>
</div>
</div><p>
<a class="anchor" name="229b0c908708da0278a01f14bd9df813"></a><!-- doxytag: member="BreakIterator::setText" ref="229b0c908708da0278a01f14bd9df813" args="(UText *text, UErrorCode &status)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void 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#863c11989634c998849cc946d04dfabe">UErrorCode</a> & </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [pure virtual]</code></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">UText</a>.
<p>
The iterator position is reset to the start.<p>
This function makes a shallow clone of the supplied <a class="el" href="structUText.html">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>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>text</em> </td><td>The <a class="el" href="structUText.html">UText</a> used to change the text. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>receives any error codes. </td></tr>
</table>
</dl>
<dl compact><dt><b><a class="el" href="draft.html#_draft000002">Draft:</a></b></dt><dd>This API may be changed in the future versions and was introduced in ICU 3.4 </dd></dl>
<p>
Implemented in <a class="el" href="classRuleBasedBreakIterator.html#edb9619a86419c2d08bc6b4b11ec2ce3">RuleBasedBreakIterator</a>.
</div>
</div><p>
<a class="anchor" name="abbf30bf5ba6f776e2ae7011f9cc1cce"></a><!-- doxytag: member="BreakIterator::setText" ref="abbf30bf5ba6f776e2ae7011f9cc1cce" args="(const UnicodeString &text)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void BreakIterator::setText </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classUnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"> <em>text</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Change the text over which this operates.
<p>
The text boundary is reset to the start. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>text</em> </td><td>The <a class="el" href="classUnicodeString.html">UnicodeString</a> used to change the text. </td></tr>
</table>
</dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000007">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Implemented in <a class="el" href="classRuleBasedBreakIterator.html#5d03f4099cfd65af02390484e57fdc01">RuleBasedBreakIterator</a>.
</div>
</div><p>
<a class="anchor" name="d8a2c24ab751a8fc87e7694aeeec885a"></a><!-- doxytag: member="BreakIterator::unregister" ref="d8a2c24ab751a8fc87e7694aeeec885a" args="(URegistryKey key, UErrorCode &status)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="umachine_8h.html#d373ce262c37cc047b0df2ad7b5dbba7">UBool</a> BreakIterator::unregister </td>
<td>(</td>
<td class="paramtype"><a class="el" href="umisc_8h.html#c843777e019f4bd8c4aa698f7e50220f">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#863c11989634c998849cc946d04dfabe">UErrorCode</a> & </td>
<td class="paramname"> <em>status</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Unregister a previously-registered <a class="el" href="classBreakIterator.html">BreakIterator</a> using the key returned from the register call.
<p>
Key becomes invalid after a successful call and should not be used again. The <a class="el" href="classBreakIterator.html">BreakIterator</a> corresponding to the key will be deleted. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>the registry key returned by a previous call to registerInstance </td></tr>
<tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>the in/out status code, no special meanings are assigned </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>TRUE if the iterator for the key was successfully unregistered </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000029">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl>
</div>
</div><p>
<hr><h2>Field Documentation</h2>
<a class="anchor" name="09e129551708ddbef72959685ce8f0fd"></a><!-- doxytag: member="BreakIterator::fBufferClone" ref="09e129551708ddbef72959685ce8f0fd" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="umachine_8h.html#d373ce262c37cc047b0df2ad7b5dbba7">UBool</a> <a class="el" href="classBreakIterator.html#09e129551708ddbef72959685ce8f0fd">BreakIterator::fBufferClone</a><code> [protected]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<dl compact><dt><b><a class="el" href="internal.html#_internal000003">Internal:</a></b></dt><dd>Do not use. This API is for interal use only. </dd></dl>
<p>
Definition at line <a class="el" href="brkiter_8h-source.html#l00529">529</a> of file <a class="el" href="brkiter_8h-source.html">brkiter.h</a>.
<p>
Referenced by <a class="el" href="brkiter_8h-source.html#l00546">isBufferClone()</a>.
</div>
</div><p>
<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></ul>
<hr size="1"><address style="align: right;"><small>Generated on Tue Dec 13 17:29:53 2011 for ICU 3.6 by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.7 </small></address>
</body>
</html>
