<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.11"/> <title>ICU 58.2: schriter.h Source File</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td id="projectalign" style="padding-left: 0.5em;"> <div id="projectname">ICU 58.2  <span id="projectnumber">58.2</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.11 --> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li><a href="annotated.html"><span>Data Structures</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="files.html"><span>File List</span></a></li> <li><a href="globals.html"><span>Globals</span></a></li> </ul> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="dir_b2f33c71d4aa5e7af42a1ca61ff5af1b.html">source</a></li><li class="navelem"><a class="el" href="dir_30087b5439e04c85304dbcf15650710b.html">common</a></li><li class="navelem"><a class="el" href="dir_8bf9c54ed6ca2fd1e2117fb037e4ad06.html">unicode</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="headertitle"> <div class="title">schriter.h</div> </div> </div><!--header--> <div class="contents"> <a href="schriter_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">// Copyright (C) 2016 and later: Unicode, Inc. and others.</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// License & terms of use: http://www.unicode.org/copyright.html</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">/*</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">******************************************************************************</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">*</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">* Copyright (C) 1998-2005, International Business Machines</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">* Corporation and others. All Rights Reserved.</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">*</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">******************************************************************************</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">*</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">* File schriter.h</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">*</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">* Modification History:</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">*</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">* Date Name Description</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">* 05/05/99 stephen Cleaned up.</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">******************************************************************************</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">*/</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#ifndef SCHRITER_H</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define SCHRITER_H</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include "<a class="code" href="utypes_8h.html">unicode/utypes.h</a>"</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include "<a class="code" href="chariter_8h.html">unicode/chariter.h</a>"</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include "<a class="code" href="uchriter_8h.html">unicode/uchriter.h</a>"</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <a class="code" href="uversion_8h.html#a7d9374e037299886d4192b763b4c5e8b">U_NAMESPACE_BEGIN</a></div><div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="classicu_1_1StringCharacterIterator.html"> 45</a></span> <span class="keyword">class </span><a class="code" href="utypes_8h.html#a559955ec3bc692657c5d8b1c6de8e334">U_COMMON_API</a> <a class="code" href="classicu_1_1StringCharacterIterator.html">StringCharacterIterator</a> : <span class="keyword">public</span> <a class="code" href="classicu_1_1UCharCharacterIterator.html">UCharCharacterIterator</a> {</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <a class="code" href="classicu_1_1StringCharacterIterator.html">StringCharacterIterator</a>(<span class="keyword">const</span> <a class="code" href="classicu_1_1UnicodeString.html">UnicodeString</a>& textStr);</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <a class="code" href="classicu_1_1StringCharacterIterator.html">StringCharacterIterator</a>(<span class="keyword">const</span> <a class="code" href="classicu_1_1UnicodeString.html">UnicodeString</a>& textStr,</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  int32_t textPos);</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <a class="code" href="classicu_1_1StringCharacterIterator.html">StringCharacterIterator</a>(<span class="keyword">const</span> <a class="code" href="classicu_1_1UnicodeString.html">UnicodeString</a>& textStr,</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  int32_t textBegin,</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  int32_t textEnd,</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  int32_t textPos);</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> </div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <a class="code" href="classicu_1_1StringCharacterIterator.html">StringCharacterIterator</a>(<span class="keyword">const</span> <a class="code" href="classicu_1_1StringCharacterIterator.html">StringCharacterIterator</a>& that);</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> </div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <span class="keyword">virtual</span> ~<a class="code" href="classicu_1_1StringCharacterIterator.html">StringCharacterIterator</a>();</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> </div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  <a class="code" href="classicu_1_1StringCharacterIterator.html">StringCharacterIterator</a>&</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  <a class="code" href="classicu_1_1UCharCharacterIterator.html#a95f968c82cccff92193e036f6da599df">operator=</a>(<span class="keyword">const</span> <a class="code" href="classicu_1_1StringCharacterIterator.html">StringCharacterIterator</a>& that);</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> </div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  <span class="keyword">virtual</span> <a class="code" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> <a class="code" href="classicu_1_1UCharCharacterIterator.html#a6c63cceb24e7ec0a2b0cee8e055dab6f">operator==</a>(<span class="keyword">const</span> <a class="code" href="classicu_1_1ForwardCharacterIterator.html">ForwardCharacterIterator</a>& that) <span class="keyword">const</span>;</div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span> </div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  <span class="keyword">virtual</span> <a class="code" href="classicu_1_1CharacterIterator.html">CharacterIterator</a>* <a class="code" href="classicu_1_1UCharCharacterIterator.html#a786173968fbad4b02c4962ff1b569e40">clone</a>(<span class="keywordtype">void</span>) <span class="keyword">const</span>;</div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span> </div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  <span class="keywordtype">void</span> <a class="code" href="classicu_1_1UCharCharacterIterator.html#ad350ff31f9930f9393fe4ba2885e526a">setText</a>(<span class="keyword">const</span> <a class="code" href="classicu_1_1UnicodeString.html">UnicodeString</a>& newText);</div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span> </div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classicu_1_1UCharCharacterIterator.html#a4bf66cb3192643dd39ce6d5057d78b4f">getText</a>(<a class="code" href="classicu_1_1UnicodeString.html">UnicodeString</a>& result);</div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span> </div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  <span class="keyword">virtual</span> <a class="code" href="uobject_8h.html#a22af10545208a455a6e884008df48e9f">UClassID</a> <a class="code" href="classicu_1_1UCharCharacterIterator.html#ae4d50b2d22c05e7e45b7a36276809313">getDynamicClassID</a>(<span class="keywordtype">void</span>) <span class="keyword">const</span>;</div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span> </div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span>  <span class="keyword">static</span> <a class="code" href="uobject_8h.html#a22af10545208a455a6e884008df48e9f">UClassID</a> U_EXPORT2 <a class="code" href="classicu_1_1UCharCharacterIterator.html#a84885a6daae4cbe2e8429562117ba0f0">getStaticClassID</a>(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span> </div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span> <span class="keyword">protected</span>:</div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span>  <a class="code" href="classicu_1_1StringCharacterIterator.html">StringCharacterIterator</a>();</div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span> </div><div class="line"><a name="l00178"></a><span class="lineno"> 178</span>  <span class="keywordtype">void</span> <a class="code" href="classicu_1_1UCharCharacterIterator.html#ad350ff31f9930f9393fe4ba2885e526a">setText</a>(<span class="keyword">const</span> <a class="code" href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a>* newText, int32_t newTextLength);</div><div class="line"><a name="l00179"></a><span class="lineno"> 179</span> </div><div class="line"><a name="l00184"></a><span class="lineno"><a class="line" href="classicu_1_1StringCharacterIterator.html#a60d250e284e0c008a5553d9559669291"> 184</a></span>  <a class="code" href="classicu_1_1UnicodeString.html">UnicodeString</a> <a class="code" href="classicu_1_1StringCharacterIterator.html#a60d250e284e0c008a5553d9559669291">text</a>;</div><div class="line"><a name="l00185"></a><span class="lineno"> 185</span> </div><div class="line"><a name="l00186"></a><span class="lineno"> 186</span> };</div><div class="line"><a name="l00187"></a><span class="lineno"> 187</span> </div><div class="line"><a name="l00188"></a><span class="lineno"> 188</span> <a class="code" href="uversion_8h.html#a3da1f00f3b02976ac53c014a3e4c0933">U_NAMESPACE_END</a></div><div class="line"><a name="l00189"></a><span class="lineno"> 189</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="classicu_1_1UCharCharacterIterator_html_ae4d50b2d22c05e7e45b7a36276809313"><div class="ttname"><a href="classicu_1_1UCharCharacterIterator.html#ae4d50b2d22c05e7e45b7a36276809313">icu::UCharCharacterIterator::getDynamicClassID</a></div><div class="ttdeci">virtual UClassID getDynamicClassID(void) const </div><div class="ttdoc">Return a class ID for this object (not really public) </div></div> <div class="ttc" id="uobject_8h_html_a22af10545208a455a6e884008df48e9f"><div class="ttname"><a href="uobject_8h.html#a22af10545208a455a6e884008df48e9f">UClassID</a></div><div class="ttdeci">void * UClassID</div><div class="ttdoc">UClassID is used to identify classes without using the compiler&#39;s RTTI. </div><div class="ttdef"><b>Definition:</b> <a href="uobject_8h_source.html#l00093">uobject.h:93</a></div></div> <div class="ttc" id="classicu_1_1UCharCharacterIterator_html_a95f968c82cccff92193e036f6da599df"><div class="ttname"><a href="classicu_1_1UCharCharacterIterator.html#a95f968c82cccff92193e036f6da599df">icu::UCharCharacterIterator::operator=</a></div><div class="ttdeci">UCharCharacterIterator & operator=(const UCharCharacterIterator &that)</div><div class="ttdoc">Assignment operator. </div></div> <div class="ttc" id="classicu_1_1StringCharacterIterator_html_a60d250e284e0c008a5553d9559669291"><div class="ttname"><a href="classicu_1_1StringCharacterIterator.html#a60d250e284e0c008a5553d9559669291">icu::StringCharacterIterator::text</a></div><div class="ttdeci">UnicodeString text</div><div class="ttdoc">Copy of the iterated string object. </div><div class="ttdef"><b>Definition:</b> <a href="schriter_8h_source.html#l00184">schriter.h:184</a></div></div> <div class="ttc" id="classicu_1_1UCharCharacterIterator_html_a4bf66cb3192643dd39ce6d5057d78b4f"><div class="ttname"><a href="classicu_1_1UCharCharacterIterator.html#a4bf66cb3192643dd39ce6d5057d78b4f">icu::UCharCharacterIterator::getText</a></div><div class="ttdeci">virtual void getText(UnicodeString &result)</div><div class="ttdoc">Copies the UChar array under iteration into the UnicodeString referred to by "result". </div></div> <div class="ttc" id="uversion_8h_html_a7d9374e037299886d4192b763b4c5e8b"><div class="ttname"><a href="uversion_8h.html#a7d9374e037299886d4192b763b4c5e8b">U_NAMESPACE_BEGIN</a></div><div class="ttdeci">#define U_NAMESPACE_BEGIN</div><div class="ttdoc">This is used to begin a declaration of a public ICU C++ API. </div><div class="ttdef"><b>Definition:</b> <a href="uversion_8h_source.html#l00131">uversion.h:131</a></div></div> <div class="ttc" id="classicu_1_1CharacterIterator_html"><div class="ttname"><a href="classicu_1_1CharacterIterator.html">icu::CharacterIterator</a></div><div class="ttdoc">Abstract class that defines an API for iteration on text objects. </div><div class="ttdef"><b>Definition:</b> <a href="chariter_8h_source.html#l00358">chariter.h:358</a></div></div> <div class="ttc" id="classicu_1_1UCharCharacterIterator_html"><div class="ttname"><a href="classicu_1_1UCharCharacterIterator.html">icu::UCharCharacterIterator</a></div><div class="ttdoc">A concrete subclass of CharacterIterator that iterates over the characters (code units or code points...</div><div class="ttdef"><b>Definition:</b> <a href="uchriter_8h_source.html#l00035">uchriter.h:35</a></div></div> <div class="ttc" id="classicu_1_1StringCharacterIterator_html"><div class="ttname"><a href="classicu_1_1StringCharacterIterator.html">icu::StringCharacterIterator</a></div><div class="ttdoc">A concrete subclass of CharacterIterator that iterates over the characters (code units or code points...</div><div class="ttdef"><b>Definition:</b> <a href="schriter_8h_source.html#l00045">schriter.h:45</a></div></div> <div class="ttc" id="uchriter_8h_html"><div class="ttname"><a href="uchriter_8h.html">uchriter.h</a></div><div class="ttdoc">C++ API: UChar Character Iterator. </div></div> <div class="ttc" id="classicu_1_1UCharCharacterIterator_html_ad350ff31f9930f9393fe4ba2885e526a"><div class="ttname"><a href="classicu_1_1UCharCharacterIterator.html#ad350ff31f9930f9393fe4ba2885e526a">icu::UCharCharacterIterator::setText</a></div><div class="ttdeci">void setText(const UChar *newText, int32_t newTextLength)</div><div class="ttdoc">Sets the iterator to iterate over a new range of text. </div></div> <div class="ttc" id="umachine_8h_html_a6bb9fad572d65b305324ef288165e2ac"><div class="ttname"><a href="umachine_8h.html#a6bb9fad572d65b305324ef288165e2ac">UChar</a></div><div class="ttdeci">uint16_t UChar</div><div class="ttdoc">Define UChar to be UCHAR_TYPE, if that is #defined (for example, to char16_t), or wchar_t if that is ...</div><div class="ttdef"><b>Definition:</b> <a href="umachine_8h_source.html#l00337">umachine.h:337</a></div></div> <div class="ttc" id="uversion_8h_html_a3da1f00f3b02976ac53c014a3e4c0933"><div class="ttname"><a href="uversion_8h.html#a3da1f00f3b02976ac53c014a3e4c0933">U_NAMESPACE_END</a></div><div class="ttdeci">#define U_NAMESPACE_END</div><div class="ttdoc">This is used to end a declaration of a public ICU C++ API. </div><div class="ttdef"><b>Definition:</b> <a href="uversion_8h_source.html#l00132">uversion.h:132</a></div></div> <div class="ttc" id="classicu_1_1UCharCharacterIterator_html_a786173968fbad4b02c4962ff1b569e40"><div class="ttname"><a href="classicu_1_1UCharCharacterIterator.html#a786173968fbad4b02c4962ff1b569e40">icu::UCharCharacterIterator::clone</a></div><div class="ttdeci">virtual CharacterIterator * clone(void) const </div><div class="ttdoc">Returns a new UCharCharacterIterator referring to the same character in the same range of the same st...</div></div> <div class="ttc" id="classicu_1_1ForwardCharacterIterator_html"><div class="ttname"><a href="classicu_1_1ForwardCharacterIterator.html">icu::ForwardCharacterIterator</a></div><div class="ttdoc">Abstract class that defines an API for forward-only iteration on text objects. </div><div class="ttdef"><b>Definition:</b> <a href="chariter_8h_source.html#l00091">chariter.h:91</a></div></div> <div class="ttc" id="classicu_1_1UCharCharacterIterator_html_a84885a6daae4cbe2e8429562117ba0f0"><div class="ttname"><a href="classicu_1_1UCharCharacterIterator.html#a84885a6daae4cbe2e8429562117ba0f0">icu::UCharCharacterIterator::getStaticClassID</a></div><div class="ttdeci">static UClassID getStaticClassID(void)</div><div class="ttdoc">Return a class ID for this class (not really public) </div></div> <div class="ttc" id="utypes_8h_html"><div class="ttname"><a href="utypes_8h.html">utypes.h</a></div><div class="ttdoc">Basic definitions for ICU, for both C and C++ APIs. </div></div> <div class="ttc" id="utypes_8h_html_a559955ec3bc692657c5d8b1c6de8e334"><div class="ttname"><a href="utypes_8h.html#a559955ec3bc692657c5d8b1c6de8e334">U_COMMON_API</a></div><div class="ttdeci">#define U_COMMON_API</div><div class="ttdoc">Set to export library symbols from inside the common library, and to import them from outside...</div><div class="ttdef"><b>Definition:</b> <a href="utypes_8h_source.html#l00359">utypes.h:359</a></div></div> <div class="ttc" id="classicu_1_1UnicodeString_html"><div class="ttname"><a href="classicu_1_1UnicodeString.html">icu::UnicodeString</a></div><div class="ttdoc">UnicodeString is a string class that stores Unicode characters directly and provides similar function...</div><div class="ttdef"><b>Definition:</b> <a href="unistr_8h_source.html#l00295">unistr.h:295</a></div></div> <div class="ttc" id="chariter_8h_html"><div class="ttname"><a href="chariter_8h.html">chariter.h</a></div><div class="ttdoc">C++ API: Character Iterator. </div></div> <div class="ttc" id="umachine_8h_html_a349ef00011f20ccd1d3b424445681aa5"><div class="ttname"><a href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a></div><div class="ttdeci">int8_t UBool</div><div class="ttdoc">The ICU boolean type. </div><div class="ttdef"><b>Definition:</b> <a href="umachine_8h_source.html#l00259">umachine.h:259</a></div></div> <div class="ttc" id="classicu_1_1UCharCharacterIterator_html_a6c63cceb24e7ec0a2b0cee8e055dab6f"><div class="ttname"><a href="classicu_1_1UCharCharacterIterator.html#a6c63cceb24e7ec0a2b0cee8e055dab6f">icu::UCharCharacterIterator::operator==</a></div><div class="ttdeci">virtual UBool operator==(const ForwardCharacterIterator &that) const </div><div class="ttdoc">Returns true if the iterators iterate over the same range of the same string and are pointing at the ...</div></div> </div><!-- fragment --></div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.11 </small></address> </body> </html>