<!-- 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: CEList 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>CEList Class Reference</h1><!-- doxytag: class="CEList" --><!-- doxytag: inherits="UObject" --> <p>This object holds a list of CEs generated from a particular <code><a class="el" href="classUnicodeString.html" title="UnicodeString is a string class that stores Unicode characters directly and provides...">UnicodeString</a></code>. <a href="#_details">More...</a></p> <p><code>#include <<a class="el" href="colldata_8h_source.html">colldata.h</a>></code></p> <div class="dynheader"> Inheritance diagram for CEList:</div> <div class="dynsection"> <div class="center"> <img src="classCEList.gif" usemap="#CEList_map" alt=""/> <map id="CEList_map" name="CEList_map"> <area href="classUObject.html" alt="UObject" shape="rect" coords="0,56,66,80"/> <area href="classUMemory.html" alt="UMemory" shape="rect" coords="0,0,66,24"/> </map> </div> </div> <table border="0" cellpadding="0" cellspacing="0"> <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEList.html#abf99e598a1d6426ec5338a4f8193ee2e">CEList</a> (<a class="el" href="ucol_8h.html#a3c4eeb412a5fd72762e6245aa75ca081">UCollator</a> *coll, const <a class="el" href="classUnicodeString.html">UnicodeString</a> &string, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a <code><a class="el" href="classCEList.html" title="This object holds a list of CEs generated from a particular UnicodeString.">CEList</a></code> object. <a href="#abf99e598a1d6426ec5338a4f8193ee2e"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEList.html#a82625296ba6bab84db6083ec0eadeb8a">~CEList</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The destructor. <a href="#a82625296ba6bab84db6083ec0eadeb8a"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEList.html#a9a022681cd11cf7f561c081f8e352dee">size</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Return the number of CEs in the list. <a href="#a9a022681cd11cf7f561c081f8e352dee"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEList.html#a5798cbcdeabb3a34d6a0776ef714b7a0">get</a> (int32_t index) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get a particular CE from the list. <a href="#a5798cbcdeabb3a34d6a0776ef714b7a0"></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="classCEList.html#a59d5abd34f52a3382488f1b35214b229">matchesAt</a> (int32_t offset, const <a class="el" href="classCEList.html">CEList</a> *other) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Check if the CEs in another <code><a class="el" href="classCEList.html" title="This object holds a list of CEs generated from a particular UnicodeString.">CEList</a></code> match the suffix of this list starting at a give offset. <a href="#a59d5abd34f52a3382488f1b35214b229"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">uint32_t & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEList.html#a551179fab3d6ebae3caf7dc4852d8b90">operator[]</a> (int32_t index) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The index operator. <a href="#a551179fab3d6ebae3caf7dc4852d8b90"></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="classCEList.html#aa0eb5c99e6ad284bf637524fabe669cc">getDynamicClassID</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classUObject.html" title="UObject is the common ICU "boilerplate" class.">UObject</a> glue. <a href="#aa0eb5c99e6ad284bf637524fabe669cc"></a><br/></td></tr> <tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="utypes_8h.html#a22af10545208a455a6e884008df48e9f">UClassID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEList.html#a09ce636621d595b224df6f5e9adce98f">getStaticClassID</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classUObject.html" title="UObject is the common ICU "boilerplate" class.">UObject</a> glue. <a href="#a09ce636621d595b224df6f5e9adce98f"></a><br/></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>This object holds a list of CEs generated from a particular <code><a class="el" href="classUnicodeString.html" title="UnicodeString is a string class that stores Unicode characters directly and provides...">UnicodeString</a></code>. </p> <dl class="internal"><dt><b><a class="el" href="internal.html#_internal000224">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. ICU 4.0.1 technology preview </dd></dl> <p>Definition at line <a class="el" href="colldata_8h_source.html#l00066">66</a> of file <a class="el" href="colldata_8h_source.html">colldata.h</a>.</p> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="abf99e598a1d6426ec5338a4f8193ee2e"></a><!-- doxytag: member="CEList::CEList" ref="abf99e598a1d6426ec5338a4f8193ee2e" args="(UCollator *coll, const UnicodeString &string, UErrorCode &status)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">CEList::CEList </td> <td>(</td> <td class="paramtype"><a class="el" href="ucol_8h.html#a3c4eeb412a5fd72762e6245aa75ca081">UCollator</a> * </td> <td class="paramname"> <em>coll</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="classUnicodeString.html">UnicodeString</a> & </td> <td class="paramname"> <em>string</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td> <td class="paramname"> <em>status</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p>Construct a <code><a class="el" href="classCEList.html" title="This object holds a list of CEs generated from a particular UnicodeString.">CEList</a></code> 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>coll</em> </td><td>- the <a class="el" href="classCollator.html" title="The Collator class performs locale-sensitive string comparison.">Collator</a> used to collect the CEs. </td></tr> <tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>- the string for which to collect the CEs. </td></tr> <tr><td valign="top"></td><td valign="top"><em>status</em> </td><td>- will be set if any errors occur.</td></tr> </table> </dd> </dl> <p>Note: if on return, status is set to an error code, the only safe thing to do with this object is to call the destructor.</p> <dl class="internal"><dt><b><a class="el" href="internal.html#_internal000227">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. ICU 4.0.1 technology preview </dd></dl> </div> </div> <a class="anchor" id="a82625296ba6bab84db6083ec0eadeb8a"></a><!-- doxytag: member="CEList::~CEList" ref="a82625296ba6bab84db6083ec0eadeb8a" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">CEList::~CEList </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>The destructor. </p> <dl class="internal"><dt><b><a class="el" href="internal.html#_internal000228">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. ICU 4.0.1 technology preview </dd></dl> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="a5798cbcdeabb3a34d6a0776ef714b7a0"></a><!-- doxytag: member="CEList::get" ref="a5798cbcdeabb3a34d6a0776ef714b7a0" args="(int32_t index) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">uint32_t CEList::get </td> <td>(</td> <td class="paramtype">int32_t </td> <td class="paramname"> <em>index</em></td> <td> ) </td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Get a particular CE from the list. </p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>index</em> </td><td>- the index of the CE to return</td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>the CE, or <code>0</code> if <code>index</code> is out of range</dd></dl> <dl class="internal"><dt><b><a class="el" href="internal.html#_internal000230">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. ICU 4.0.1 technology preview </dd></dl> </div> </div> <a class="anchor" id="aa0eb5c99e6ad284bf637524fabe669cc"></a><!-- doxytag: member="CEList::getDynamicClassID" ref="aa0eb5c99e6ad284bf637524fabe669cc" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual <a class="el" href="utypes_8h.html#a22af10545208a455a6e884008df48e9f">UClassID</a> CEList::getDynamicClassID </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const<code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p><a class="el" href="classUObject.html" title="UObject is the common ICU "boilerplate" class.">UObject</a> glue. </p> <p>.. </p> <dl class="internal"><dt><b><a class="el" href="internal.html#_internal000233">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. ICU 4.0.1 technology preview </dd></dl> <p>Implements <a class="el" href="classUObject.html#a9b1acc95efd89cb86ec31f2dc947a262">UObject</a>.</p> </div> </div> <a class="anchor" id="a09ce636621d595b224df6f5e9adce98f"></a><!-- doxytag: member="CEList::getStaticClassID" ref="a09ce636621d595b224df6f5e9adce98f" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static <a class="el" href="utypes_8h.html#a22af10545208a455a6e884008df48e9f">UClassID</a> CEList::getStaticClassID </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td><code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> <p><a class="el" href="classUObject.html" title="UObject is the common ICU "boilerplate" class.">UObject</a> glue. </p> <p>.. </p> <dl class="internal"><dt><b><a class="el" href="internal.html#_internal000234">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. ICU 4.0.1 technology preview </dd></dl> </div> </div> <a class="anchor" id="a59d5abd34f52a3382488f1b35214b229"></a><!-- doxytag: member="CEList::matchesAt" ref="a59d5abd34f52a3382488f1b35214b229" args="(int32_t offset, const CEList *other) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="umachine_8h.html#a349ef00011f20ccd1d3b424445681aa5">UBool</a> CEList::matchesAt </td> <td>(</td> <td class="paramtype">int32_t </td> <td class="paramname"> <em>offset</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="classCEList.html">CEList</a> * </td> <td class="paramname"> <em>other</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Check if the CEs in another <code><a class="el" href="classCEList.html" title="This object holds a list of CEs generated from a particular UnicodeString.">CEList</a></code> match the suffix of this list starting at a give offset. </p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>offset</em> </td><td>- the offset of the suffix </td></tr> <tr><td valign="top"></td><td valign="top"><em>other</em> </td><td>- the other <code><a class="el" href="classCEList.html" title="This object holds a list of CEs generated from a particular UnicodeString.">CEList</a></code></td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd><code>TRUE</code> if the CEs match, <code>FALSE</code> otherwise.</dd></dl> <dl class="internal"><dt><b><a class="el" href="internal.html#_internal000231">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. ICU 4.0.1 technology preview </dd></dl> </div> </div> <a class="anchor" id="a551179fab3d6ebae3caf7dc4852d8b90"></a><!-- doxytag: member="CEList::operator[]" ref="a551179fab3d6ebae3caf7dc4852d8b90" args="(int32_t index) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">uint32_t& CEList::operator[] </td> <td>(</td> <td class="paramtype">int32_t </td> <td class="paramname"> <em>index</em></td> <td> ) </td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>The index operator. </p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>index</em> </td><td>- the index</td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>a reference to the given CE in the list</dd></dl> <dl class="internal"><dt><b><a class="el" href="internal.html#_internal000232">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. ICU 4.0.1 technology preview </dd></dl> </div> </div> <a class="anchor" id="a9a022681cd11cf7f561c081f8e352dee"></a><!-- doxytag: member="CEList::size" ref="a9a022681cd11cf7f561c081f8e352dee" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int32_t CEList::size </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Return the number of CEs in the list. </p> <dl class="return"><dt><b>Returns:</b></dt><dd>the number of CEs in the list.</dd></dl> <dl class="internal"><dt><b><a class="el" href="internal.html#_internal000229">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. ICU 4.0.1 technology preview </dd></dl> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="colldata_8h_source.html">colldata.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>