<!-- 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: usetiter.h Source File</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><a href="annotated.html"><span>Data Structures</span></a></li> <li class="current"><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="files.html"><span>File List</span></a></li> <li><a href="globals.html"><span>Globals</span></a></li> </ul> </div> <h1>usetiter.h</h1><a href="usetiter_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span> <a name="l00002"></a>00002 <span class="comment">**********************************************************************</span> <a name="l00003"></a>00003 <span class="comment">* Copyright (c) 2002-2008, International Business Machines</span> <a name="l00004"></a>00004 <span class="comment">* Corporation and others. All Rights Reserved.</span> <a name="l00005"></a>00005 <span class="comment">**********************************************************************</span> <a name="l00006"></a>00006 <span class="comment">*/</span> <a name="l00007"></a>00007 <span class="preprocessor">#ifndef USETITER_H</span> <a name="l00008"></a>00008 <span class="preprocessor"></span><span class="preprocessor">#define USETITER_H</span> <a name="l00009"></a>00009 <span class="preprocessor"></span> <a name="l00010"></a>00010 <span class="preprocessor">#include "<a class="code" href="utypes_8h.html" title="Basic definitions for ICU, for both C and C++ APIs.">unicode/utypes.h</a>"</span> <a name="l00011"></a>00011 <span class="preprocessor">#include "<a class="code" href="uobject_8h.html" title="C++ API: Common ICU base class UObject.">unicode/uobject.h</a>"</span> <a name="l00012"></a>00012 <span class="preprocessor">#include "<a class="code" href="unistr_8h.html" title="C++ API: Unicode String.">unicode/unistr.h</a>"</span> <a name="l00013"></a>00013 <a name="l00019"></a>00019 <a class="code" href="uversion_8h.html#a7d9374e037299886d4192b763b4c5e8b" title="This is used to begin a declaration of a public ICU C++ API.">U_NAMESPACE_BEGIN</a> <a name="l00020"></a>00020 <a name="l00021"></a>00021 <span class="keyword">class </span><a class="code" href="classUnicodeSet.html" title="A mutable set of Unicode characters and multicharacter strings.">UnicodeSet</a>; <a name="l00022"></a>00022 <span class="keyword">class </span><a class="code" href="classUnicodeString.html" title="UnicodeString is a string class that stores Unicode characters directly and provides...">UnicodeString</a>; <a name="l00023"></a>00023 <a name="l00061"></a><a class="code" href="classUnicodeSetIterator.html">00061</a> <span class="keyword">class </span><a class="code" href="utypes_8h.html#a559955ec3bc692657c5d8b1c6de8e334" title="Set to export library symbols from inside the common library, and to import them...">U_COMMON_API</a> <a class="code" href="classUnicodeSetIterator.html" title="UnicodeSetIterator iterates over the contents of a UnicodeSet.">UnicodeSetIterator</a> : <span class="keyword">public</span> <a class="code" href="classUObject.html" title="UObject is the common ICU &quot;boilerplate&quot; class.">UObject</a> { <a name="l00062"></a>00062 <a name="l00063"></a>00063 <span class="keyword">protected</span>: <a name="l00064"></a>00064 <a name="l00071"></a>00071 <span class="keyword">enum</span> { IS_STRING = -1 }; <a name="l00072"></a>00072 <a name="l00078"></a><a class="code" href="classUnicodeSetIterator.html#aa4eb1658beaaaf6673b5d37e3c6a69ef">00078</a> <a class="code" href="umachine_8h.html#a09fff5c3b5a5b015324dc3ec3cf92809" title="Define UChar32 as a type for single Unicode code points.">UChar32</a> codepoint; <a name="l00079"></a>00079 <a name="l00089"></a><a class="code" href="classUnicodeSetIterator.html#a68e47154dd6f9259a1706f4b61dbf103">00089</a> <a class="code" href="umachine_8h.html#a09fff5c3b5a5b015324dc3ec3cf92809" title="Define UChar32 as a type for single Unicode code points.">UChar32</a> codepointEnd; <a name="l00090"></a>00090 <a name="l00097"></a><a class="code" href="classUnicodeSetIterator.html#a4063239bfe90af16a06788dd6d06b85a">00097</a> <span class="keyword">const</span> <a class="code" href="classUnicodeString.html" title="UnicodeString is a string class that stores Unicode characters directly and provides...">UnicodeString</a>* string; <a name="l00098"></a>00098 <a name="l00099"></a>00099 <span class="keyword">public</span>: <a name="l00100"></a>00100 <a name="l00107"></a>00107 <a class="code" href="classUnicodeSetIterator.html" title="UnicodeSetIterator iterates over the contents of a UnicodeSet.">UnicodeSetIterator</a>(<span class="keyword">const</span> <a class="code" href="classUnicodeSet.html" title="A mutable set of Unicode characters and multicharacter strings.">UnicodeSet</a>& <span class="keyword">set</span>); <a name="l00108"></a>00108 <a name="l00115"></a>00115 <a class="code" href="classUnicodeSetIterator.html" title="UnicodeSetIterator iterates over the contents of a UnicodeSet.">UnicodeSetIterator</a>(); <a name="l00116"></a>00116 <a name="l00121"></a>00121 <span class="keyword">virtual</span> ~<a class="code" href="classUnicodeSetIterator.html" title="UnicodeSetIterator iterates over the contents of a UnicodeSet.">UnicodeSetIterator</a>(); <a name="l00122"></a>00122 <a name="l00138"></a>00138 <span class="keyword">inline</span> <a class="code" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5" title="The ICU boolean type.">UBool</a> isString() <span class="keyword">const</span>; <a name="l00139"></a>00139 <a name="l00145"></a>00145 <span class="keyword">inline</span> <a class="code" href="umachine_8h.html#a09fff5c3b5a5b015324dc3ec3cf92809" title="Define UChar32 as a type for single Unicode code points.">UChar32</a> getCodepoint() <span class="keyword">const</span>; <a name="l00146"></a>00146 <a name="l00153"></a>00153 <span class="keyword">inline</span> <a class="code" href="umachine_8h.html#a09fff5c3b5a5b015324dc3ec3cf92809" title="Define UChar32 as a type for single Unicode code points.">UChar32</a> getCodepointEnd() <span class="keyword">const</span>; <a name="l00154"></a>00154 <a name="l00166"></a>00166 <span class="keyword">const</span> <a class="code" href="classUnicodeString.html" title="UnicodeString is a string class that stores Unicode characters directly and provides...">UnicodeString</a>& getString(); <a name="l00167"></a>00167 <a name="l00190"></a>00190 <a class="code" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5" title="The ICU boolean type.">UBool</a> next(); <a name="l00191"></a>00191 <a name="l00211"></a>00211 <a class="code" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5" title="The ICU boolean type.">UBool</a> nextRange(); <a name="l00212"></a>00212 <a name="l00220"></a>00220 <span class="keywordtype">void</span> reset(<span class="keyword">const</span> <a class="code" href="classUnicodeSet.html" title="A mutable set of Unicode characters and multicharacter strings.">UnicodeSet</a>& <span class="keyword">set</span>); <a name="l00221"></a>00221 <a name="l00226"></a>00226 <span class="keywordtype">void</span> reset(); <a name="l00227"></a>00227 <a name="l00233"></a>00233 <span class="keyword">static</span> <a class="code" href="utypes_8h.html#a22af10545208a455a6e884008df48e9f" title="UClassID is used to identify classes without using RTTI, since RTTI is not yet supported...">UClassID</a> <a class="code" href="platform_8h.html#a72bf6d8ec0640a37b1915e5d853b2016">U_EXPORT2</a> getStaticClassID(); <a name="l00234"></a>00234 <a name="l00240"></a>00240 <span class="keyword">virtual</span> <a class="code" href="utypes_8h.html#a22af10545208a455a6e884008df48e9f" title="UClassID is used to identify classes without using RTTI, since RTTI is not yet supported...">UClassID</a> <a class="code" href="classUObject.html#a9b1acc95efd89cb86ec31f2dc947a262" title="ICU4C &quot;poor man&#39;s RTTI&quot;, returns a UClassID for the actual ICU class...">getDynamicClassID</a>() <span class="keyword">const</span>; <a name="l00241"></a>00241 <a name="l00242"></a>00242 <span class="comment">// ======================= PRIVATES ===========================</span> <a name="l00243"></a>00243 <a name="l00244"></a>00244 <span class="keyword">protected</span>: <a name="l00245"></a>00245 <a name="l00246"></a>00246 <span class="comment">// endElement and nextElements are really UChar32's, but we keep</span> <a name="l00247"></a>00247 <span class="comment">// them as signed int32_t's so we can do comparisons with</span> <a name="l00248"></a>00248 <span class="comment">// endElement set to -1. Leave them as int32_t's.</span> <a name="l00252"></a><a class="code" href="classUnicodeSetIterator.html#a2f65d38d2e7b6b2bf21aa4591a2ac24e">00252</a> <span class="comment"></span> <span class="keyword">const</span> <a class="code" href="classUnicodeSet.html" title="A mutable set of Unicode characters and multicharacter strings.">UnicodeSet</a>* <span class="keyword">set</span>; <a name="l00256"></a><a class="code" href="classUnicodeSetIterator.html#a878514479691a3846b20b6e569119ab9">00256</a> int32_t endRange; <a name="l00260"></a><a class="code" href="classUnicodeSetIterator.html#a3b1df5ba38de7ab69f86da5b044f8e2d">00260</a> int32_t range; <a name="l00264"></a><a class="code" href="classUnicodeSetIterator.html#a7d3d501416100a83c28f04d08d4addb4">00264</a> int32_t endElement; <a name="l00268"></a><a class="code" href="classUnicodeSetIterator.html#ab2f6ef22b4028b02bc90391b9a0f6d5e">00268</a> int32_t nextElement; <a name="l00269"></a>00269 <span class="comment">//UBool abbreviated;</span> <a name="l00273"></a><a class="code" href="classUnicodeSetIterator.html#ab9b1ebf18974bc98a940d75631fcc077">00273</a> <span class="comment"></span> int32_t nextString; <a name="l00277"></a><a class="code" href="classUnicodeSetIterator.html#ab13d31425166fb962bf72cb36032f227">00277</a> int32_t stringCount; <a name="l00278"></a>00278 <a name="l00284"></a><a class="code" href="classUnicodeSetIterator.html#afbe599f508d1557f0146d531d30dea67">00284</a> <a class="code" href="classUnicodeString.html" title="UnicodeString is a string class that stores Unicode characters directly and provides...">UnicodeString</a> *cpString; <a name="l00285"></a>00285 <a name="l00289"></a>00289 <a class="code" href="classUnicodeSetIterator.html" title="UnicodeSetIterator iterates over the contents of a UnicodeSet.">UnicodeSetIterator</a>(<span class="keyword">const</span> <a class="code" href="classUnicodeSetIterator.html" title="UnicodeSetIterator iterates over the contents of a UnicodeSet.">UnicodeSetIterator</a>&); <span class="comment">// disallow</span> <a name="l00290"></a>00290 <a name="l00294"></a>00294 <a class="code" href="classUnicodeSetIterator.html" title="UnicodeSetIterator iterates over the contents of a UnicodeSet.">UnicodeSetIterator</a>& operator=(<span class="keyword">const</span> <a class="code" href="classUnicodeSetIterator.html" title="UnicodeSetIterator iterates over the contents of a UnicodeSet.">UnicodeSetIterator</a>&); <span class="comment">// disallow</span> <a name="l00295"></a>00295 <a name="l00299"></a>00299 <span class="keyword">virtual</span> <span class="keywordtype">void</span> loadRange(int32_t range); <a name="l00300"></a>00300 <a name="l00301"></a>00301 }; <a name="l00302"></a>00302 <a name="l00303"></a><a class="code" href="classUnicodeSetIterator.html#ade92aa1c12c730dd577c16945cf7d165">00303</a> <span class="keyword">inline</span> <a class="code" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5" title="The ICU boolean type.">UBool</a> <a class="code" href="classUnicodeSetIterator.html#ade92aa1c12c730dd577c16945cf7d165" title="Returns true if the current element is a string.">UnicodeSetIterator::isString</a>()<span class="keyword"> const </span>{ <a name="l00304"></a>00304 <span class="keywordflow">return</span> <a class="code" href="classUnicodeSetIterator.html#aa4eb1658beaaaf6673b5d37e3c6a69ef" title="Current code point, or the special value IS_STRING, if the iterator points to a string...">codepoint</a> == (<a class="code" href="umachine_8h.html#a09fff5c3b5a5b015324dc3ec3cf92809" title="Define UChar32 as a type for single Unicode code points.">UChar32</a>)IS_STRING; <a name="l00305"></a>00305 } <a name="l00306"></a>00306 <a name="l00307"></a><a class="code" href="classUnicodeSetIterator.html#a61919dfa42210572bb89e388dfeb0268">00307</a> <span class="keyword">inline</span> <a class="code" href="umachine_8h.html#a09fff5c3b5a5b015324dc3ec3cf92809" title="Define UChar32 as a type for single Unicode code points.">UChar32</a> <a class="code" href="classUnicodeSetIterator.html#a61919dfa42210572bb89e388dfeb0268" title="Returns the current code point, if isString() returned false.">UnicodeSetIterator::getCodepoint</a>()<span class="keyword"> const </span>{ <a name="l00308"></a>00308 <span class="keywordflow">return</span> <a class="code" href="classUnicodeSetIterator.html#aa4eb1658beaaaf6673b5d37e3c6a69ef" title="Current code point, or the special value IS_STRING, if the iterator points to a string...">codepoint</a>; <a name="l00309"></a>00309 } <a name="l00310"></a>00310 <a name="l00311"></a><a class="code" href="classUnicodeSetIterator.html#ae7e32fd213d8b7ede8d766bf6de0dcf7">00311</a> <span class="keyword">inline</span> <a class="code" href="umachine_8h.html#a09fff5c3b5a5b015324dc3ec3cf92809" title="Define UChar32 as a type for single Unicode code points.">UChar32</a> <a class="code" href="classUnicodeSetIterator.html#ae7e32fd213d8b7ede8d766bf6de0dcf7" title="Returns the end of the current code point range, if isString() returned false and...">UnicodeSetIterator::getCodepointEnd</a>()<span class="keyword"> const </span>{ <a name="l00312"></a>00312 <span class="keywordflow">return</span> <a class="code" href="classUnicodeSetIterator.html#a68e47154dd6f9259a1706f4b61dbf103" title="When iterating over ranges using nextRange(), codepointEnd contains the inclusive...">codepointEnd</a>; <a name="l00313"></a>00313 } <a name="l00314"></a>00314 <a name="l00315"></a>00315 <a name="l00316"></a>00316 <a class="code" href="uversion_8h.html#a3da1f00f3b02976ac53c014a3e4c0933" title="This is used to end a declaration of a public ICU C++ API.">U_NAMESPACE_END</a> <a name="l00317"></a>00317 <a name="l00318"></a>00318 <span class="preprocessor">#endif</span> </pre></div></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>