<!-- This comment will put IE 6, 7 and 8 in quirks mode -->
<!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"/>
<title>ICU 4.4: ForwardCharacterIterator Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javaScript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Generated by Doxygen 1.6.1 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<img id="MSearchSelect" src="search/search.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</div>
</li>
</ul>
</div>
<div class="tabs">
<ul>
<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>
<div class="contents">
<h1>ForwardCharacterIterator Class Reference</h1><!-- doxytag: class="ForwardCharacterIterator" --><!-- doxytag: inherits="UObject" -->
<p>Abstract class that defines an API for forward-only iteration on text objects.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="chariter_8h_source.html">chariter.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for ForwardCharacterIterator:</div>
<div class="dynsection">
<div class="center">
<img src="classForwardCharacterIterator.gif" usemap="#ForwardCharacterIterator_map" alt=""/>
<map id="ForwardCharacterIterator_map" name="ForwardCharacterIterator_map">
<area href="classUObject.html" alt="UObject" shape="rect" coords="0,56,157,80"/>
<area href="classUMemory.html" alt="UMemory" shape="rect" coords="0,0,157,24"/>
<area href="classCharacterIterator.html" alt="CharacterIterator" shape="rect" coords="0,168,157,192"/>
<area href="classUCharCharacterIterator.html" alt="UCharCharacterIterator" shape="rect" coords="0,224,157,248"/>
<area href="classStringCharacterIterator.html" alt="StringCharacterIterator" shape="rect" coords="0,280,157,304"/>
</map>
</div>
</div>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom">{ <b>DONE</b> = 0xffff
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><p>Value returned by most of ForwardCharacterIterator's functions when the iterator has reached the limits of its iteration. </p>
<a href="classForwardCharacterIterator.html#a5b6537ad55ea252ddb2795076c268997">More...</a><br/></td></tr>
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classForwardCharacterIterator.html#a5d7a74e28d40b3234f7beb4f175649d1">~ForwardCharacterIterator</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a5d7a74e28d40b3234f7beb4f175649d1"></a><br/></td></tr>
<tr><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="classForwardCharacterIterator.html#a3359b21f630495c271715decce6703f4">operator==</a> (const <a class="el" href="classForwardCharacterIterator.html">ForwardCharacterIterator</a> &that) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true when both iterators refer to the same character in the same character-storage object. <a href="#a3359b21f630495c271715decce6703f4"></a><br/></td></tr>
<tr><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="classForwardCharacterIterator.html#ab55ea12533e313565bef5d4b3b020f76">operator!=</a> (const <a class="el" href="classForwardCharacterIterator.html">ForwardCharacterIterator</a> &that) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true when the iterators refer to different text-storage objects, or to different characters in the same text-storage object. <a href="#ab55ea12533e313565bef5d4b3b020f76"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classForwardCharacterIterator.html#a0b9696ca3d4d27b22a2744a2c498b4d7">hashCode</a> (void) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Generates a hash code for this iterator. <a href="#a0b9696ca3d4d27b22a2744a2c498b4d7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="utypes_8h.html#a22af10545208a455a6e884008df48e9f">UClassID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classForwardCharacterIterator.html#ac86e1b248f61b462458896b2113099b3">getDynamicClassID</a> (void) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a UClassID for this <a class="el" href="classForwardCharacterIterator.html" title="Abstract class that defines an API for forward-only iteration on text objects.">ForwardCharacterIterator</a> ("poor man's
RTTI"). <a href="#ac86e1b248f61b462458896b2113099b3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classForwardCharacterIterator.html#a713194d8a27d3f50fe0454b8286921cc">nextPostInc</a> (void)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the current code unit for returning and advances to the next code unit in the iteration range (toward endIndex()). <a href="#a713194d8a27d3f50fe0454b8286921cc"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="umachine_8h.html#a09fff5c3b5a5b015324dc3ec3cf92809">UChar32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classForwardCharacterIterator.html#acb902b4e8c192937270157bb1afca237">next32PostInc</a> (void)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the current code point for returning and advances to the next code point in the iteration range (toward endIndex()). <a href="#acb902b4e8c192937270157bb1afca237"></a><br/></td></tr>
<tr><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="classForwardCharacterIterator.html#ab53c28ee0b9ff659983ded76e53f6251">hasNext</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns FALSE if there are no more code units or code points at or after the current position in the iteration range. <a href="#ab53c28ee0b9ff659983ded76e53f6251"></a><br/></td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classForwardCharacterIterator.html#acf59da5fdaf57d8be166ccec06d54672">ForwardCharacterIterator</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor to be overridden in the implementing class. <a href="#acf59da5fdaf57d8be166ccec06d54672"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classForwardCharacterIterator.html#a1debdc2a50bd25e3663deb46f5bc8f3d">ForwardCharacterIterator</a> (const <a class="el" href="classForwardCharacterIterator.html">ForwardCharacterIterator</a> &other)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor to be overridden in the implementing class. <a href="#a1debdc2a50bd25e3663deb46f5bc8f3d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classForwardCharacterIterator.html">ForwardCharacterIterator</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classForwardCharacterIterator.html#a76c13ba2ac6386e2d46ad41df4b7b9a3">operator=</a> (const <a class="el" href="classForwardCharacterIterator.html">ForwardCharacterIterator</a> &)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Assignment operator to be overridden in the implementing class. <a href="#a76c13ba2ac6386e2d46ad41df4b7b9a3"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Abstract class that defines an API for forward-only iteration on text objects. </p>
<p>This is a minimal interface for iteration without random access or backwards iteration. It is especially useful for wrapping streams with converters into an object for collation or normalization.</p>
<p>Characters can be accessed in two ways: as code units or as code points. Unicode code points are 21-bit integers and are the scalar values of Unicode characters. ICU uses the type UChar32 for them. Unicode code units are the storage units of a given Unicode/UCS Transformation <a class="el" href="classFormat.html" title="Base class for all formats.">Format</a> (a character encoding scheme). With UTF-16, all code points can be represented with either one or two code units ("surrogates"). String storage is typically based on code units, while properties of characters are typically determined using code point values. Some processes may be designed to work with sequences of code units, or it may be known that all characters that are important to an algorithm can be represented with single code units. Other processes will need to use the code point access functions.</p>
<p><a class="el" href="classForwardCharacterIterator.html" title="Abstract class that defines an API for forward-only iteration on text objects.">ForwardCharacterIterator</a> provides <a class="el" href="classForwardCharacterIterator.html#a713194d8a27d3f50fe0454b8286921cc" title="Gets the current code unit for returning and advances to the next code unit in the...">nextPostInc()</a> to access a code unit and advance an internal position into the text object, similar to a <code>return text[position++]</code>.<br/>
It provides <a class="el" href="classForwardCharacterIterator.html#acb902b4e8c192937270157bb1afca237" title="Gets the current code point for returning and advances to the next code point in...">next32PostInc()</a> to access a code point and advance an internal position.</p>
<p><a class="el" href="classForwardCharacterIterator.html#acb902b4e8c192937270157bb1afca237" title="Gets the current code point for returning and advances to the next code point in...">next32PostInc()</a> assumes that the current position is that of the beginning of a code point, i.e., of its first code unit. After <a class="el" href="classForwardCharacterIterator.html#acb902b4e8c192937270157bb1afca237" title="Gets the current code point for returning and advances to the next code point in...">next32PostInc()</a>, this will be true again. In general, access to code units and code points in the same iteration loop should not be mixed. In UTF-16, if the current position is on a second code unit (Low Surrogate), then only that code unit is returned even by <a class="el" href="classForwardCharacterIterator.html#acb902b4e8c192937270157bb1afca237" title="Gets the current code point for returning and advances to the next code point in...">next32PostInc()</a>.</p>
<p>For iteration with either function, there are two ways to check for the end of the iteration. When there are no more characters in the text object: </p>
<ul>
<li>
The <a class="el" href="classForwardCharacterIterator.html#ab53c28ee0b9ff659983ded76e53f6251" title="Returns FALSE if there are no more code units or code points at or after the current...">hasNext()</a> function returns FALSE. </li>
<li>
<a class="el" href="classForwardCharacterIterator.html#a713194d8a27d3f50fe0454b8286921cc" title="Gets the current code unit for returning and advances to the next code unit in the...">nextPostInc()</a> and <a class="el" href="classForwardCharacterIterator.html#acb902b4e8c192937270157bb1afca237" title="Gets the current code point for returning and advances to the next code point in...">next32PostInc()</a> return DONE when one attempts to read beyond the end of the text object. </li>
</ul>
<p>Example: </p>
<div class="fragment"><pre class="fragment"> <span class="keywordtype">void</span> function1(<a class="code" href="classForwardCharacterIterator.html" title="Abstract class that defines an API for forward-only iteration on text objects.">ForwardCharacterIterator</a> &it) {
<a class="code" href="umachine_8h.html#a09fff5c3b5a5b015324dc3ec3cf92809" title="Define UChar32 as a type for single Unicode code points.">UChar32</a> c;
<span class="keywordflow">while</span>(it.<a class="code" href="classForwardCharacterIterator.html#ab53c28ee0b9ff659983ded76e53f6251" title="Returns FALSE if there are no more code units or code points at or after the current...">hasNext</a>()) {
c=it.<a class="code" href="classForwardCharacterIterator.html#acb902b4e8c192937270157bb1afca237" title="Gets the current code point for returning and advances to the next code point in...">next32PostInc</a>();
<span class="comment">// use c</span>
}
}
<span class="keywordtype">void</span> function1(<a class="code" href="classForwardCharacterIterator.html" title="Abstract class that defines an API for forward-only iteration on text objects.">ForwardCharacterIterator</a> &it) {
<a class="code" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac" title="Define UChar to be wchar_t if that is 16 bits wide; always assumed to be unsigned...">UChar</a> c;
<span class="keywordflow">while</span>((c=it.<a class="code" href="classForwardCharacterIterator.html#a713194d8a27d3f50fe0454b8286921cc" title="Gets the current code unit for returning and advances to the next code unit in the...">nextPostInc</a>())!=ForwardCharacterIterator::DONE) {
<span class="comment">// use c</span>
}
}
</pre></div> <dl class="stable"><dt><b><a class="el" href="stable.html#_stable000060">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Definition at line <a class="el" href="chariter_8h_source.html#l00089">89</a> of file <a class="el" href="chariter_8h_source.html">chariter.h</a>.</p>
<hr/><h2>Member Enumeration Documentation</h2>
<a class="anchor" id="a5b6537ad55ea252ddb2795076c268997"></a><!-- doxytag: member="ForwardCharacterIterator::@1" ref="a5b6537ad55ea252ddb2795076c268997" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">anonymous enum</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Value returned by most of ForwardCharacterIterator's functions when the iterator has reached the limits of its iteration. </p>
<dl class="stable"><dt><b>Stable:</b></dt><dd>ICU 2.0 </dd></dl>
<p>Definition at line <a class="el" href="chariter_8h_source.html#l00096">96</a> of file <a class="el" href="chariter_8h_source.html">chariter.h</a>.</p>
</div>
</div>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a5d7a74e28d40b3234f7beb4f175649d1"></a><!-- doxytag: member="ForwardCharacterIterator::~ForwardCharacterIterator" ref="a5d7a74e28d40b3234f7beb4f175649d1" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual ForwardCharacterIterator::~ForwardCharacterIterator </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000063">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="acf59da5fdaf57d8be166ccec06d54672"></a><!-- doxytag: member="ForwardCharacterIterator::ForwardCharacterIterator" ref="acf59da5fdaf57d8be166ccec06d54672" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ForwardCharacterIterator::ForwardCharacterIterator </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Default constructor to be overridden in the implementing class. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000071">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<a class="anchor" id="a1debdc2a50bd25e3663deb46f5bc8f3d"></a><!-- doxytag: member="ForwardCharacterIterator::ForwardCharacterIterator" ref="a1debdc2a50bd25e3663deb46f5bc8f3d" args="(const ForwardCharacterIterator &other)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ForwardCharacterIterator::ForwardCharacterIterator </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classForwardCharacterIterator.html">ForwardCharacterIterator</a> & </td>
<td class="paramname"> <em>other</em></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Copy constructor to be overridden in the implementing class. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000072">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ac86e1b248f61b462458896b2113099b3"></a><!-- doxytag: member="ForwardCharacterIterator::getDynamicClassID" ref="ac86e1b248f61b462458896b2113099b3" 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#a22af10545208a455a6e884008df48e9f">UClassID</a> ForwardCharacterIterator::getDynamicClassID </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns a UClassID for this <a class="el" href="classForwardCharacterIterator.html" title="Abstract class that defines an API for forward-only iteration on text objects.">ForwardCharacterIterator</a> ("poor man's
RTTI"). </p>
<p>Despite the fact that this function is public, DO NOT CONSIDER IT PART OF CHARACTERITERATOR'S API! </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>a UClassID for this <a class="el" href="classForwardCharacterIterator.html" title="Abstract class that defines an API for forward-only iteration on text objects.">ForwardCharacterIterator</a> </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000067">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Implements <a class="el" href="classUObject.html#a9b1acc95efd89cb86ec31f2dc947a262">UObject</a>.</p>
<p>Implemented in <a class="el" href="classStringCharacterIterator.html#a41e4e26fa81d682930112b3333f89f94">StringCharacterIterator</a>, and <a class="el" href="classUCharCharacterIterator.html#a48fcf4d6d1463b4662c7740ba6591022">UCharCharacterIterator</a>.</p>
</div>
</div>
<a class="anchor" id="a0b9696ca3d4d27b22a2744a2c498b4d7"></a><!-- doxytag: member="ForwardCharacterIterator::hashCode" ref="a0b9696ca3d4d27b22a2744a2c498b4d7" args="(void) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int32_t ForwardCharacterIterator::hashCode </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Generates a hash code for this iterator. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the hash code. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000066">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Implemented in <a class="el" href="classUCharCharacterIterator.html#a14d812367eb5d27b31d15edfb85df85a">UCharCharacterIterator</a>.</p>
</div>
</div>
<a class="anchor" id="ab53c28ee0b9ff659983ded76e53f6251"></a><!-- doxytag: member="ForwardCharacterIterator::hasNext" ref="ab53c28ee0b9ff659983ded76e53f6251" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> ForwardCharacterIterator::hasNext </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns FALSE if there are no more code units or code points at or after the current position in the iteration range. </p>
<p>This is used with <a class="el" href="classForwardCharacterIterator.html#a713194d8a27d3f50fe0454b8286921cc" title="Gets the current code unit for returning and advances to the next code unit in the...">nextPostInc()</a> or <a class="el" href="classForwardCharacterIterator.html#acb902b4e8c192937270157bb1afca237" title="Gets the current code point for returning and advances to the next code point in...">next32PostInc()</a> in forward iteration. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>FALSE if there are no more code units or code points at or after the current position in the iteration range. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000070">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Implemented in <a class="el" href="classUCharCharacterIterator.html#ad7a3eadf766b1b398b7a0af50bc9cd4c">UCharCharacterIterator</a>.</p>
</div>
</div>
<a class="anchor" id="acb902b4e8c192937270157bb1afca237"></a><!-- doxytag: member="ForwardCharacterIterator::next32PostInc" ref="acb902b4e8c192937270157bb1afca237" args="(void)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="umachine_8h.html#a09fff5c3b5a5b015324dc3ec3cf92809">UChar32</a> ForwardCharacterIterator::next32PostInc </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the current code point for returning and advances to the next code point in the iteration range (toward endIndex()). </p>
<p>If there are no more code points to return, returns DONE. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the current code point. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000069">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Implemented in <a class="el" href="classUCharCharacterIterator.html#af18b5ce2f7cb0ade1ef694a7def6bcff">UCharCharacterIterator</a>.</p>
</div>
</div>
<a class="anchor" id="a713194d8a27d3f50fe0454b8286921cc"></a><!-- doxytag: member="ForwardCharacterIterator::nextPostInc" ref="a713194d8a27d3f50fe0454b8286921cc" args="(void)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a> ForwardCharacterIterator::nextPostInc </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the current code unit for returning and advances to the next code unit in the iteration range (toward endIndex()). </p>
<p>If there are no more code units to return, returns DONE. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the current code unit. </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000068">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Implemented in <a class="el" href="classUCharCharacterIterator.html#a7f67c2cb06a8ccb951369862638a56da">UCharCharacterIterator</a>.</p>
</div>
</div>
<a class="anchor" id="ab55ea12533e313565bef5d4b3b020f76"></a><!-- doxytag: member="ForwardCharacterIterator::operator!=" ref="ab55ea12533e313565bef5d4b3b020f76" args="(const ForwardCharacterIterator &that) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> ForwardCharacterIterator::operator!= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classForwardCharacterIterator.html">ForwardCharacterIterator</a> & </td>
<td class="paramname"> <em>that</em></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns true when the iterators refer to different text-storage objects, or to different characters in the same text-storage object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>that</em> </td><td>The <a class="el" href="classForwardCharacterIterator.html" title="Abstract class that defines an API for forward-only iteration on text objects.">ForwardCharacterIterator</a> to be compared for inequality </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true when the iterators refer to different text-storage objects, or to different characters in the same text-storage object </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000065">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Definition at line <a class="el" href="chariter_8h_source.html#l00681">681</a> of file <a class="el" href="chariter_8h_source.html">chariter.h</a>.</p>
<p>References <a class="el" href="classForwardCharacterIterator.html#a3359b21f630495c271715decce6703f4">operator==()</a>.</p>
</div>
</div>
<a class="anchor" id="a76c13ba2ac6386e2d46ad41df4b7b9a3"></a><!-- doxytag: member="ForwardCharacterIterator::operator=" ref="a76c13ba2ac6386e2d46ad41df4b7b9a3" args="(const ForwardCharacterIterator &)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classForwardCharacterIterator.html">ForwardCharacterIterator</a>& ForwardCharacterIterator::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classForwardCharacterIterator.html">ForwardCharacterIterator</a> & </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Assignment operator to be overridden in the implementing class. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000073">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Reimplemented in <a class="el" href="classCharacterIterator.html#a24bbd0b8ba0893633c7ddac569f5161a">CharacterIterator</a>, <a class="el" href="classStringCharacterIterator.html#a4cd551b4e2371ac38288a82b9055fad8">StringCharacterIterator</a>, and <a class="el" href="classUCharCharacterIterator.html#a5843398b927bd88df8bf01d157058152">UCharCharacterIterator</a>.</p>
<p>Definition at line <a class="el" href="chariter_8h_source.html#l00184">184</a> of file <a class="el" href="chariter_8h_source.html">chariter.h</a>.</p>
</div>
</div>
<a class="anchor" id="a3359b21f630495c271715decce6703f4"></a><!-- doxytag: member="ForwardCharacterIterator::operator==" ref="a3359b21f630495c271715decce6703f4" args="(const ForwardCharacterIterator &that) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> ForwardCharacterIterator::operator== </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classForwardCharacterIterator.html">ForwardCharacterIterator</a> & </td>
<td class="paramname"> <em>that</em></td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns true when both iterators refer to the same character in the same character-storage object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>that</em> </td><td>The <a class="el" href="classForwardCharacterIterator.html" title="Abstract class that defines an API for forward-only iteration on text objects.">ForwardCharacterIterator</a> to be compared for equality </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true when both iterators refer to the same character in the same character-storage object </dd></dl>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable000064">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>Referenced by <a class="el" href="chariter_8h_source.html#l00681">operator!=()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="chariter_8h_source.html">chariter.h</a></li>
</ul>
</div>
<!--- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Defines</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on 16 Mar 2010 for ICU 4.4 by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
f51238514e2abe817779ad2fe01b0759
>
files
>
110
