<!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"/> <title>ICU 4.8.1.1: unimatch.h File Reference</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="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/search.js"></script> <script type="text/javascript"> $(document).ready(function() { searchBox.OnSelectItem(0); }); </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 style="padding-left: 0.5em;"> <div id="projectname">ICU 4.8.1.1  <span id="projectnumber">4.8.1.1</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.1.1 --> <script type="text/javascript"> var searchBox = new SearchBox("searchBox", "search",false,'Search'); </script> <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="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"> <span class="left"> <img id="MSearchSelect" src="search/mag_sel.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)"/> </span><span class="right"> <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> </span> </div> </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> <!-- 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>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark"> </span>Pages</a></div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="javascript:void(0)" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="dir_bdd9a5d540de89e9fe90efdfc6973a4f.html">common</a></li><li class="navelem"><a class="el" href="dir_f59c6450ff718ff1b085cfd1c36acbd7.html">unicode</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#nested-classes">Data Structures</a> | <a href="#enum-members">Enumerations</a> </div> <div class="headertitle"> <div class="title">unimatch.h File Reference</div> </div> </div><!--header--> <div class="contents"> <p>C++ API: Unicode Matcher. <a href="#details">More...</a></p> <div class="textblock"><code>#include "<a class="el" href="utypes_8h_source.html">unicode/utypes.h</a>"</code><br/> </div> <p><a href="unimatch_8h_source.html">Go to the source code of this file.</a></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2><a name="nested-classes"></a> Data Structures</h2></td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classUnicodeMatcher.html">UnicodeMatcher</a></td></tr> <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight"><code><a class="el" href="classUnicodeMatcher.html" title="UnicodeMatcher defines a protocol for objects that can match a range of characters in a Replaceable s...">UnicodeMatcher</a></code> defines a protocol for objects that can match a range of characters in a <a class="el" href="classReplaceable.html" title="Replaceable is an abstract base class representing a string of characters that supports the replaceme...">Replaceable</a> string. <a href="classUnicodeMatcher.html#details">More...</a><br/></td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2><a name="enum-members"></a> Enumerations</h2></td></tr> <tr class="memitem:aa87e5322490b3e89e6913bfabd0390e6"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="unimatch_8h.html#aa87e5322490b3e89e6913bfabd0390e6">UMatchDegree</a> { <a class="el" href="unimatch_8h.html#aa87e5322490b3e89e6913bfabd0390e6a1f6e449ce699dc36cbe7ebf85f084b03">U_MISMATCH</a>, <a class="el" href="unimatch_8h.html#aa87e5322490b3e89e6913bfabd0390e6ab2587ee51e223d32277d7efeafda90b7">U_PARTIAL_MATCH</a>, <a class="el" href="unimatch_8h.html#aa87e5322490b3e89e6913bfabd0390e6ae704cd60becb64c776a061677629ad26">U_MATCH</a> }</td></tr> <tr class="memdesc:aa87e5322490b3e89e6913bfabd0390e6"><td class="mdescLeft"> </td><td class="mdescRight">Constants returned by <code><a class="el" href="classUnicodeMatcher.html#ab712e496c0023237fbe38184d0424310" title="Return a UMatchDegree value indicating the degree of match for the given text at the given offset...">UnicodeMatcher::matches()</a></code> indicating the degree of match. <a href="unimatch_8h.html#aa87e5322490b3e89e6913bfabd0390e6">More...</a><br/></td></tr> </table> <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> <div class="textblock"><p>C++ API: Unicode Matcher. </p> <p>Definition in file <a class="el" href="unimatch_8h_source.html">unimatch.h</a>.</p> </div><hr/><h2>Enumeration Type Documentation</h2> <a class="anchor" id="aa87e5322490b3e89e6913bfabd0390e6"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">enum <a class="el" href="unimatch_8h.html#aa87e5322490b3e89e6913bfabd0390e6">UMatchDegree</a></td> </tr> </table> </div><div class="memdoc"> <p>Constants returned by <code><a class="el" href="classUnicodeMatcher.html#ab712e496c0023237fbe38184d0424310" title="Return a UMatchDegree value indicating the degree of match for the given text at the given offset...">UnicodeMatcher::matches()</a></code> indicating the degree of match. </p> <dl class="stable"><dt><b><a class="el" href="stable.html#_stable001457">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl> <dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"><em><a class="anchor" id="aa87e5322490b3e89e6913bfabd0390e6a1f6e449ce699dc36cbe7ebf85f084b03"></a>U_MISMATCH</em> </td><td> <p>Constant returned by <code>matches()</code> indicating a mismatch between the text and this matcher. </p> <p>The text contains a character which does not match, or the text does not contain all desired characters for a non-incremental match. </p> <dl class="stable"><dt><b><a class="el" href="stable.html#_stable001459">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl> </td></tr> <tr><td valign="top"><em><a class="anchor" id="aa87e5322490b3e89e6913bfabd0390e6ab2587ee51e223d32277d7efeafda90b7"></a>U_PARTIAL_MATCH</em> </td><td> <p>Constant returned by <code>matches()</code> indicating a partial match between the text and this matcher. </p> <p>This value is only returned for incremental match operations. All characters of the text match, but more characters are required for a complete match. Alternatively, for variable-length matchers, all characters of the text match, and if more characters were supplied at limit, they might also match. </p> <dl class="stable"><dt><b><a class="el" href="stable.html#_stable001460">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl> </td></tr> <tr><td valign="top"><em><a class="anchor" id="aa87e5322490b3e89e6913bfabd0390e6ae704cd60becb64c776a061677629ad26"></a>U_MATCH</em> </td><td> <p>Constant returned by <code>matches()</code> indicating a complete match between the text and this matcher. </p> <p>For an incremental variable-length match, this value is returned if the given text matches, and it is known that additional characters would not alter the extent of the match. </p> <dl class="stable"><dt><b><a class="el" href="stable.html#_stable001461">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl> </td></tr> </table> </dd> </dl> <p>Definition at line <a class="el" href="unimatch_8h_source.html#l00030">30</a> of file <a class="el" href="unimatch_8h_source.html">unimatch.h</a>.</p> </div> </div> </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.1.1 </small></address> </body> </html>