<!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: StringCharacterIterator 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>StringCharacterIterator Class Reference</h1><!-- doxytag: class="StringCharacterIterator" --><!-- doxytag: inherits="UCharCharacterIterator" -->A concrete subclass of <a class="el" href="classCharacterIterator.html">CharacterIterator</a> that iterates over the characters (code units or code points) in a <a class="el" href="classUnicodeString.html">UnicodeString</a>.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="schriter_8h-source.html">schriter.h</a>></code>
<p>
<p>Inheritance diagram for StringCharacterIterator:
<p><center><img src="classStringCharacterIterator.png" usemap="#StringCharacterIterator_map" border="0" alt=""></center>
<map name="StringCharacterIterator_map">
<area href="classUCharCharacterIterator.html" alt="UCharCharacterIterator" shape="rect" coords="0,224,157,248">
<area href="classCharacterIterator.html" alt="CharacterIterator" shape="rect" coords="0,168,157,192">
<area href="classForwardCharacterIterator.html" alt="ForwardCharacterIterator" shape="rect" coords="0,112,157,136">
<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">
</map>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringCharacterIterator.html#4d61075bf14cb60c3591b3e6acefe380">StringCharacterIterator</a> (const <a class="el" href="classUnicodeString.html">UnicodeString</a> &textStr)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create an iterator over the <a class="el" href="classUnicodeString.html">UnicodeString</a> referred to by "textStr". <a href="#4d61075bf14cb60c3591b3e6acefe380"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringCharacterIterator.html#892c2da643ed8e21bfa1cc1aa843edaa">StringCharacterIterator</a> (const <a class="el" href="classUnicodeString.html">UnicodeString</a> &textStr, <a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> textPos)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create an iterator over the <a class="el" href="classUnicodeString.html">UnicodeString</a> referred to by "textStr". <a href="#892c2da643ed8e21bfa1cc1aa843edaa"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringCharacterIterator.html#aaeff726f372af8e55a21efc917221bd">StringCharacterIterator</a> (const <a class="el" href="classUnicodeString.html">UnicodeString</a> &textStr, <a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> textBegin, <a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> textEnd, <a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> textPos)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create an iterator over the <a class="el" href="classUnicodeString.html">UnicodeString</a> referred to by "textStr". <a href="#aaeff726f372af8e55a21efc917221bd"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringCharacterIterator.html#c131b8cb8cc86bd88810fcaf4e11496b">StringCharacterIterator</a> (const <a class="el" href="classStringCharacterIterator.html">StringCharacterIterator</a> &that)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <a href="#c131b8cb8cc86bd88810fcaf4e11496b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringCharacterIterator.html#d29f2681cf8e2dbfdf883fc0a22e460d">~StringCharacterIterator</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#d29f2681cf8e2dbfdf883fc0a22e460d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classStringCharacterIterator.html">StringCharacterIterator</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringCharacterIterator.html#f2b366eb9f3bfd5f6c05a8d9d564d153">operator=</a> (const <a class="el" href="classStringCharacterIterator.html">StringCharacterIterator</a> &that)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Assignment operator. <a href="#f2b366eb9f3bfd5f6c05a8d9d564d153"></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="classStringCharacterIterator.html#173bebb9ba6e9d23e1b4e4d529e38eda">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 if the iterators iterate over the same range of the same string and are pointing at the same character. <a href="#173bebb9ba6e9d23e1b4e4d529e38eda"></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="classStringCharacterIterator.html#d7ea5f71e286b3575b86669875236c18">clone</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a new <a class="el" href="classStringCharacterIterator.html">StringCharacterIterator</a> referring to the same character in the same range of the same string as this one. <a href="#d7ea5f71e286b3575b86669875236c18"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringCharacterIterator.html#f3d3bf7ac2e027bfcc9746b125a376fb">setText</a> (const <a class="el" href="classUnicodeString.html">UnicodeString</a> &newText)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the iterator to iterate over the provided string. <a href="#f3d3bf7ac2e027bfcc9746b125a376fb"></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="classStringCharacterIterator.html#54940df60d6bf69a51b561601909e1d7">getText</a> (<a class="el" href="classUnicodeString.html">UnicodeString</a> &result)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copies the <a class="el" href="classUnicodeString.html">UnicodeString</a> under iteration into the <a class="el" href="classUnicodeString.html">UnicodeString</a> referred to by "result". <a href="#54940df60d6bf69a51b561601909e1d7"></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="classStringCharacterIterator.html#61b47f4168310d2e9b8a5894d9124899">getDynamicClassID</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a class ID for this object (not really public). <a href="#61b47f4168310d2e9b8a5894d9124899"></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="utypes_8h.html#452dc3c7d14eb1a1837ae1aa0b2d6724">UClassID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringCharacterIterator.html#eaeea54adce8e80a8de40b753e458871">getStaticClassID</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a class ID for this class (not really public). <a href="#eaeea54adce8e80a8de40b753e458871"></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="classStringCharacterIterator.html#60ebea139c8c199761dc2e6ec8a897ba">StringCharacterIterator</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor, iteration over empty string. <a href="#60ebea139c8c199761dc2e6ec8a897ba"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringCharacterIterator.html#624757827b292816ae69ed557588f876">setText</a> (const UChar *newText, <a class="el" href="pwin32_8h.html#f03f47ee300d26bee7dd521b1169f394">int32_t</a> newTextLength)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the iterator to iterate over the provided string. <a href="#624757827b292816ae69ed557588f876"></a><br></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="classUnicodeString.html">UnicodeString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringCharacterIterator.html#2e17d500e039848369e2855b2c65c1f9">text</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copy of the iterated string object. <a href="#2e17d500e039848369e2855b2c65c1f9"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A concrete subclass of <a class="el" href="classCharacterIterator.html">CharacterIterator</a> that iterates over the characters (code units or code points) in a <a class="el" href="classUnicodeString.html">UnicodeString</a>.
<p>
It's possible not only to create an iterator that iterates over an entire <a class="el" href="classUnicodeString.html">UnicodeString</a>, but also to create one that iterates over only a subrange of a <a class="el" href="classUnicodeString.html">UnicodeString</a> (iterators over different subranges of the same <a class="el" href="classUnicodeString.html">UnicodeString</a> don't compare equal). <dl compact><dt><b>See also:</b></dt><dd><a class="el" href="classCharacterIterator.html">CharacterIterator</a> <p>
<a class="el" href="classForwardCharacterIterator.html">ForwardCharacterIterator</a> </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000295">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
<p>
Definition at line <a class="el" href="schriter_8h-source.html#l00043">43</a> of file <a class="el" href="schriter_8h-source.html">schriter.h</a>.<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="4d61075bf14cb60c3591b3e6acefe380"></a><!-- doxytag: member="StringCharacterIterator::StringCharacterIterator" ref="4d61075bf14cb60c3591b3e6acefe380" args="(const UnicodeString &textStr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">StringCharacterIterator::StringCharacterIterator </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classUnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"> <em>textStr</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create an iterator over the <a class="el" href="classUnicodeString.html">UnicodeString</a> referred to by "textStr".
<p>
The <a class="el" href="classUnicodeString.html">UnicodeString</a> object is copied. The iteration range is the whole string, and the starting position is 0. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>textStr</em> </td><td>The unicode string used to create an iterator </td></tr>
</table>
</dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000296">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="892c2da643ed8e21bfa1cc1aa843edaa"></a><!-- doxytag: member="StringCharacterIterator::StringCharacterIterator" ref="892c2da643ed8e21bfa1cc1aa843edaa" args="(const UnicodeString &textStr, int32_t textPos)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">StringCharacterIterator::StringCharacterIterator </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classUnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"> <em>textStr</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>textPos</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create an iterator over the <a class="el" href="classUnicodeString.html">UnicodeString</a> referred to by "textStr".
<p>
The iteration range is the whole string, and the starting position is specified by "textPos". If "textPos" is outside the valid iteration range, the behavior of this object is undefined. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>textStr</em> </td><td>The unicode string used to create an iterator </td></tr>
<tr><td valign="top"></td><td valign="top"><em>textPos</em> </td><td>The starting position of the iteration </td></tr>
</table>
</dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000297">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="aaeff726f372af8e55a21efc917221bd"></a><!-- doxytag: member="StringCharacterIterator::StringCharacterIterator" ref="aaeff726f372af8e55a21efc917221bd" args="(const UnicodeString &textStr, int32_t textBegin, int32_t textEnd, int32_t textPos)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">StringCharacterIterator::StringCharacterIterator </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classUnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"> <em>textStr</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>textBegin</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>textEnd</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>textPos</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create an iterator over the <a class="el" href="classUnicodeString.html">UnicodeString</a> referred to by "textStr".
<p>
The <a class="el" href="classUnicodeString.html">UnicodeString</a> object is copied. The iteration range begins with the code unit specified by "textBegin" and ends with the code unit BEFORE the code unit specfied by "textEnd". The starting position is specified by "textPos". If "textBegin" and "textEnd" don't form a valid range on "text" (i.e., textBegin >= textEnd or either is negative or greater than text.size()), or "textPos" is outside the range defined by "textBegin" and "textEnd", the behavior of this iterator is undefined. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>textStr</em> </td><td>The unicode string used to create the <a class="el" href="classStringCharacterIterator.html">StringCharacterIterator</a> </td></tr>
<tr><td valign="top"></td><td valign="top"><em>textBegin</em> </td><td>The begin position of the iteration range </td></tr>
<tr><td valign="top"></td><td valign="top"><em>textEnd</em> </td><td>The end position of the iteration range </td></tr>
<tr><td valign="top"></td><td valign="top"><em>textPos</em> </td><td>The starting position of the iteration </td></tr>
</table>
</dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000298">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="c131b8cb8cc86bd88810fcaf4e11496b"></a><!-- doxytag: member="StringCharacterIterator::StringCharacterIterator" ref="c131b8cb8cc86bd88810fcaf4e11496b" args="(const StringCharacterIterator &that)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">StringCharacterIterator::StringCharacterIterator </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classStringCharacterIterator.html">StringCharacterIterator</a> & </td>
<td class="paramname"> <em>that</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Copy constructor.
<p>
The new iterator iterates over the same range of the same string as "that", and its initial position is the same as "that"'s current position. The <a class="el" href="classUnicodeString.html">UnicodeString</a> object in "that" is copied. <dl compact><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="classStringCharacterIterator.html">StringCharacterIterator</a> to be copied </td></tr>
</table>
</dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000299">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="d29f2681cf8e2dbfdf883fc0a22e460d"></a><!-- doxytag: member="StringCharacterIterator::~StringCharacterIterator" ref="d29f2681cf8e2dbfdf883fc0a22e460d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual StringCharacterIterator::~StringCharacterIterator </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#_stable000300">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="60ebea139c8c199761dc2e6ec8a897ba"></a><!-- doxytag: member="StringCharacterIterator::StringCharacterIterator" ref="60ebea139c8c199761dc2e6ec8a897ba" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">StringCharacterIterator::StringCharacterIterator </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Default constructor, iteration over empty string.
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable000308">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="d7ea5f71e286b3575b86669875236c18"></a><!-- doxytag: member="StringCharacterIterator::clone" ref="d7ea5f71e286b3575b86669875236c18" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classCharacterIterator.html">CharacterIterator</a>* StringCharacterIterator::clone </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns a new <a class="el" href="classStringCharacterIterator.html">StringCharacterIterator</a> referring to the same character in the same range of the same string as this one.
<p>
The caller must delete the new iterator. <dl compact><dt><b>Returns:</b></dt><dd>the newly cloned object. </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000303">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Reimplemented from <a class="el" href="classUCharCharacterIterator.html#7db930d1c86c61dd1ce884d39b8f18b4">UCharCharacterIterator</a>.
</div>
</div><p>
<a class="anchor" name="61b47f4168310d2e9b8a5894d9124899"></a><!-- doxytag: member="StringCharacterIterator::getDynamicClassID" ref="61b47f4168310d2e9b8a5894d9124899" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="utypes_8h.html#452dc3c7d14eb1a1837ae1aa0b2d6724">UClassID</a> StringCharacterIterator::getDynamicClassID </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return a class ID for this object (not really public).
<p>
<dl compact><dt><b>Returns:</b></dt><dd>a class ID for this object. </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000306">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Reimplemented from <a class="el" href="classUCharCharacterIterator.html#f3f3d1d6af04bd8ce70ace494bc69af1">UCharCharacterIterator</a>.
</div>
</div><p>
<a class="anchor" name="eaeea54adce8e80a8de40b753e458871"></a><!-- doxytag: member="StringCharacterIterator::getStaticClassID" ref="eaeea54adce8e80a8de40b753e458871" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="utypes_8h.html#452dc3c7d14eb1a1837ae1aa0b2d6724">UClassID</a> StringCharacterIterator::getStaticClassID </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 class ID for this class (not really public).
<p>
<dl compact><dt><b>Returns:</b></dt><dd>a class ID for this class </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000307">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Reimplemented from <a class="el" href="classUCharCharacterIterator.html#c08b633a8ed9ca457bd3ec1702703861">UCharCharacterIterator</a>.
</div>
</div><p>
<a class="anchor" name="54940df60d6bf69a51b561601909e1d7"></a><!-- doxytag: member="StringCharacterIterator::getText" ref="54940df60d6bf69a51b561601909e1d7" args="(UnicodeString &result)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void StringCharacterIterator::getText </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classUnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"> <em>result</em> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Copies the <a class="el" href="classUnicodeString.html">UnicodeString</a> under iteration into the <a class="el" href="classUnicodeString.html">UnicodeString</a> referred to by "result".
<p>
Even if this iterator iterates across only a part of this string, the whole string is copied. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>result</em> </td><td>Receives a copy of the text under iteration. </td></tr>
</table>
</dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000305">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Reimplemented from <a class="el" href="classUCharCharacterIterator.html#11492aae30e7ac7ec2c0b45954120714">UCharCharacterIterator</a>.
</div>
</div><p>
<a class="anchor" name="f2b366eb9f3bfd5f6c05a8d9d564d153"></a><!-- doxytag: member="StringCharacterIterator::operator=" ref="f2b366eb9f3bfd5f6c05a8d9d564d153" args="(const StringCharacterIterator &that)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classStringCharacterIterator.html">StringCharacterIterator</a>& StringCharacterIterator::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classStringCharacterIterator.html">StringCharacterIterator</a> & </td>
<td class="paramname"> <em>that</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Assignment operator.
<p>
*this is altered to iterate over the same range of the same string as "that", and refers to the same character within that string as "that" does. <dl compact><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 object to be copied. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>the newly created object. </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000301">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="173bebb9ba6e9d23e1b4e4d529e38eda"></a><!-- doxytag: member="StringCharacterIterator::operator==" ref="173bebb9ba6e9d23e1b4e4d529e38eda" args="(const ForwardCharacterIterator &that) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="umachine_8h.html#d373ce262c37cc047b0df2ad7b5dbba7">UBool</a> StringCharacterIterator::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 width="100%"> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns true if the iterators iterate over the same range of the same string and are pointing at the same character.
<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>that</em> </td><td>The <a class="el" href="classForwardCharacterIterator.html">ForwardCharacterIterator</a> to be compared for equality </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>true if the iterators iterate over the same range of the same string and are pointing at the same character. </dd></dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000302">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Reimplemented from <a class="el" href="classUCharCharacterIterator.html#46e8eb0cbb0ac9c091fa91f086388f18">UCharCharacterIterator</a>.
</div>
</div><p>
<a class="anchor" name="624757827b292816ae69ed557588f876"></a><!-- doxytag: member="StringCharacterIterator::setText" ref="624757827b292816ae69ed557588f876" args="(const UChar *newText, int32_t newTextLength)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void StringCharacterIterator::setText </td>
<td>(</td>
<td class="paramtype">const UChar * </td>
<td class="paramname"> <em>newText</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>newTextLength</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets the iterator to iterate over the provided string.
<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>newText</em> </td><td>The string to be iterated over </td></tr>
<tr><td valign="top"></td><td valign="top"><em>newTextLength</em> </td><td>The length of the String </td></tr>
</table>
</dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000309">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Reimplemented from <a class="el" href="classUCharCharacterIterator.html#034c6a2a5f7f9dbdae743d919bda48ad">UCharCharacterIterator</a>.
</div>
</div><p>
<a class="anchor" name="f3d3bf7ac2e027bfcc9746b125a376fb"></a><!-- doxytag: member="StringCharacterIterator::setText" ref="f3d3bf7ac2e027bfcc9746b125a376fb" args="(const UnicodeString &newText)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void StringCharacterIterator::setText </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classUnicodeString.html">UnicodeString</a> & </td>
<td class="paramname"> <em>newText</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets the iterator to iterate over the provided string.
<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>newText</em> </td><td>The string to be iterated over </td></tr>
</table>
</dl>
<dl compact><dt><b><a class="el" href="stable.html#_stable000304">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
</div>
</div><p>
<hr><h2>Field Documentation</h2>
<a class="anchor" name="2e17d500e039848369e2855b2c65c1f9"></a><!-- doxytag: member="StringCharacterIterator::text" ref="2e17d500e039848369e2855b2c65c1f9" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classUnicodeString.html">UnicodeString</a> <a class="el" href="classStringCharacterIterator.html#2e17d500e039848369e2855b2c65c1f9">StringCharacterIterator::text</a><code> [protected]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Copy of the iterated string object.
<p>
<dl compact><dt><b><a class="el" href="stable.html#_stable000310">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>
<p>
Reimplemented from <a class="el" href="classUCharCharacterIterator.html#548d11968b65842dda79861f9517feb2">UCharCharacterIterator</a>.
<p>
Definition at line <a class="el" href="schriter_8h-source.html#l00182">182</a> of file <a class="el" href="schriter_8h-source.html">schriter.h</a>.
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="schriter_8h-source.html">schriter.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Tue Dec 13 17:29:55 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>
