<!-- 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: UnicodeFunctor 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>UnicodeFunctor Class Reference</h1><!-- doxytag: class="UnicodeFunctor" --><!-- doxytag: inherits="UObject" --> <p><code><a class="el" href="classUnicodeFunctor.html" title="UnicodeFunctor is an abstract base class for objects that perform match and/or replace...">UnicodeFunctor</a></code> is an abstract base class for objects that perform match and/or replace operations on Unicode strings. <a href="#_details">More...</a></p> <p><code>#include <<a class="el" href="unifunct_8h_source.html">unifunct.h</a>></code></p> <div class="dynheader"> Inheritance diagram for UnicodeFunctor:</div> <div class="dynsection"> <div class="center"> <img src="classUnicodeFunctor.gif" usemap="#UnicodeFunctor_map" alt=""/> <map id="UnicodeFunctor_map" name="UnicodeFunctor_map"> <area href="classUObject.html" alt="UObject" shape="rect" coords="0,56,102,80"/> <area href="classUMemory.html" alt="UMemory" shape="rect" coords="0,0,102,24"/> <area href="classUnicodeFilter.html" alt="UnicodeFilter" shape="rect" coords="0,168,102,192"/> <area href="classUnicodeSet.html" alt="UnicodeSet" shape="rect" coords="0,224,102,248"/> </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">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classUnicodeFunctor.html#a3e7b6e387992d82cab424079cd623972">~UnicodeFunctor</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a3e7b6e387992d82cab424079cd623972"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classUnicodeFunctor.html">UnicodeFunctor</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classUnicodeFunctor.html#ae9aaff845a9885df3ec336df1b4afa10">clone</a> () const =0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Return a copy of this object. <a href="#ae9aaff845a9885df3ec336df1b4afa10"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classUnicodeMatcher.html">UnicodeMatcher</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classUnicodeFunctor.html#ae634c62ea3f1fc80db66e73c8b819545">toMatcher</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Cast 'this' to a UnicodeMatcher* pointer and return the pointer, or null if this is not a UnicodeMatcher*. <a href="#ae634c62ea3f1fc80db66e73c8b819545"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classUnicodeReplacer.html">UnicodeReplacer</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classUnicodeFunctor.html#af035fa7395f9996afe8ff6d934198884">toReplacer</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Cast 'this' to a UnicodeReplacer* pointer and return the pointer, or null if this is not a UnicodeReplacer*. <a href="#af035fa7395f9996afe8ff6d934198884"></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="classUnicodeFunctor.html#a6eaa9f077fe622d4c02643865f99bfa2">getDynamicClassID</a> (void) const =0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a unique class ID <b>polymorphically</b>. <a href="#a6eaa9f077fe622d4c02643865f99bfa2"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classUnicodeFunctor.html#ace3dc97994f3bf4fb74139ff0207db7c">setData</a> (const TransliterationRuleData *)=0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Set the data object associated with this functor. <a href="#ace3dc97994f3bf4fb74139ff0207db7c"></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="classUnicodeFunctor.html#a339304d367427ee3e16729a7f074ae25">getStaticClassID</a> (void)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Return the class ID for this class. <a href="#a339304d367427ee3e16729a7f074ae25"></a><br/></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p><code><a class="el" href="classUnicodeFunctor.html" title="UnicodeFunctor is an abstract base class for objects that perform match and/or replace...">UnicodeFunctor</a></code> is an abstract base class for objects that perform match and/or replace operations on Unicode strings. </p> <dl class="author"><dt><b>Author:</b></dt><dd>Alan Liu </dd></dl> <dl class="stable"><dt><b><a class="el" href="stable.html#_stable001343">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl> <p>Definition at line <a class="el" href="unifunct_8h_source.html#l00033">33</a> of file <a class="el" href="unifunct_8h_source.html">unifunct.h</a>.</p> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="a3e7b6e387992d82cab424079cd623972"></a><!-- doxytag: member="UnicodeFunctor::~UnicodeFunctor" ref="a3e7b6e387992d82cab424079cd623972" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual UnicodeFunctor::~UnicodeFunctor </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Destructor. </p> <dl class="stable"><dt><b><a class="el" href="stable.html#_stable001344">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="ae9aaff845a9885df3ec336df1b4afa10"></a><!-- doxytag: member="UnicodeFunctor::clone" ref="ae9aaff845a9885df3ec336df1b4afa10" args="() const =0" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual <a class="el" href="classUnicodeFunctor.html">UnicodeFunctor</a>* UnicodeFunctor::clone </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const<code> [pure virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Return a copy of this object. </p> <p>All <a class="el" href="classUnicodeFunctor.html" title="UnicodeFunctor is an abstract base class for objects that perform match and/or replace...">UnicodeFunctor</a> objects have to support cloning in order to allow classes using <a class="el" href="classUnicodeFunctor.html" title="UnicodeFunctor is an abstract base class for objects that perform match and/or replace...">UnicodeFunctor</a> to implement cloning. </p> <dl class="stable"><dt><b><a class="el" href="stable.html#_stable001345">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl> <p>Implemented in <a class="el" href="classUnicodeSet.html#a4a85692219bd42074445974f10ca9b9e">UnicodeSet</a>.</p> </div> </div> <a class="anchor" id="a6eaa9f077fe622d4c02643865f99bfa2"></a><!-- doxytag: member="UnicodeFunctor::getDynamicClassID" ref="a6eaa9f077fe622d4c02643865f99bfa2" args="(void) const =0" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual <a class="el" href="utypes_8h.html#a22af10545208a455a6e884008df48e9f">UClassID</a> UnicodeFunctor::getDynamicClassID </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td> <td> ) </td> <td> const<code> [pure virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Returns a unique class ID <b>polymorphically</b>. </p> <p>This method is to implement a simple version of RTTI, since not all C++ compilers support genuine RTTI. Polymorphic <a class="el" href="stringpiece_8h.html#a7652049cbac0bfeae2cd2aa4514a3352" title="Global operator == for StringPiece.">operator==()</a> and <a class="el" href="classUnicodeFunctor.html#ae9aaff845a9885df3ec336df1b4afa10" title="Return a copy of this object.">clone()</a> methods call this method.</p> <p>Concrete subclasses of <a class="el" href="classUnicodeFunctor.html" title="UnicodeFunctor is an abstract base class for objects that perform match and/or replace...">UnicodeFunctor</a> should use the macro UOBJECT_DEFINE_RTTI_IMPLEMENTATION from <a class="el" href="uobject_8h.html" title="C++ API: Common ICU base class UObject.">uobject.h</a> to provide definitios getStaticClassID and getDynamicClassID.</p> <dl class="return"><dt><b>Returns:</b></dt><dd>The class ID for this object. All objects of a given class have the same class ID. Objects of other classes have different class IDs. </dd></dl> <dl class="stable"><dt><b><a class="el" href="stable.html#_stable001349">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl> <p>Implements <a class="el" href="classUObject.html#a9b1acc95efd89cb86ec31f2dc947a262">UObject</a>.</p> <p>Implemented in <a class="el" href="classUnicodeFilter.html#ac4dc39e50294690b9dd2de60461970f3">UnicodeFilter</a>, and <a class="el" href="classUnicodeSet.html#a4e6c600a7a6bcc1d564d84d0fa512932">UnicodeSet</a>.</p> </div> </div> <a class="anchor" id="a339304d367427ee3e16729a7f074ae25"></a><!-- doxytag: member="UnicodeFunctor::getStaticClassID" ref="a339304d367427ee3e16729a7f074ae25" args="(void)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static <a class="el" href="utypes_8h.html#a22af10545208a455a6e884008df48e9f">UClassID</a> UnicodeFunctor::getStaticClassID </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td> <td> ) </td> <td><code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Return the class ID for this class. </p> <p>This is useful only for comparing to a return value from <a class="el" href="classUnicodeFunctor.html#a6eaa9f077fe622d4c02643865f99bfa2" title="Returns a unique class ID polymorphically.">getDynamicClassID()</a>. </p> <dl class="return"><dt><b>Returns:</b></dt><dd>The class ID for all objects of this class. </dd></dl> <dl class="stable"><dt><b><a class="el" href="stable.html#_stable001348">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl> <p>Reimplemented in <a class="el" href="classUnicodeFilter.html#a32a5fef7c44d68ebed5313e27645b5e6">UnicodeFilter</a>, and <a class="el" href="classUnicodeSet.html#a1f7725a2e4de21e4cfff622fecc89716">UnicodeSet</a>.</p> </div> </div> <a class="anchor" id="ace3dc97994f3bf4fb74139ff0207db7c"></a><!-- doxytag: member="UnicodeFunctor::setData" ref="ace3dc97994f3bf4fb74139ff0207db7c" args="(const TransliterationRuleData *)=0" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void UnicodeFunctor::setData </td> <td>(</td> <td class="paramtype">const TransliterationRuleData * </td> <td class="paramname"></td> <td> ) </td> <td><code> [pure virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Set the data object associated with this functor. </p> <p>The data object provides context for functor-to-standin mapping. This method is required when assigning a functor to a different data object. This function MAY GO AWAY later if the architecture is changed to pass data object pointers through the API. </p> <dl class="internal"><dt><b><a class="el" href="internal.html#_internal000094">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. ICU 2.1 </dd></dl> <p>Implemented in <a class="el" href="classUnicodeFilter.html#afd1f679426b2fbde93af707e3ba8c0a2">UnicodeFilter</a>.</p> </div> </div> <a class="anchor" id="ae634c62ea3f1fc80db66e73c8b819545"></a><!-- doxytag: member="UnicodeFunctor::toMatcher" ref="ae634c62ea3f1fc80db66e73c8b819545" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual <a class="el" href="classUnicodeMatcher.html">UnicodeMatcher</a>* UnicodeFunctor::toMatcher </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const<code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Cast 'this' to a UnicodeMatcher* pointer and return the pointer, or null if this is not a UnicodeMatcher*. </p> <p>Subclasses that mix in <a class="el" href="classUnicodeMatcher.html" title="UnicodeMatcher defines a protocol for objects that can match a range of characters...">UnicodeMatcher</a> as a base class must override this. This protocol is required because a pointer to a <a class="el" href="classUnicodeFunctor.html" title="UnicodeFunctor is an abstract base class for objects that perform match and/or replace...">UnicodeFunctor</a> cannot be cast to a pointer to a <a class="el" href="classUnicodeMatcher.html" title="UnicodeMatcher defines a protocol for objects that can match a range of characters...">UnicodeMatcher</a>, since <a class="el" href="classUnicodeMatcher.html" title="UnicodeMatcher defines a protocol for objects that can match a range of characters...">UnicodeMatcher</a> is a mixin that does not derive from <a class="el" href="classUnicodeFunctor.html" title="UnicodeFunctor is an abstract base class for objects that perform match and/or replace...">UnicodeFunctor</a>. </p> <dl class="stable"><dt><b><a class="el" href="stable.html#_stable001346">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl> <p>Reimplemented in <a class="el" href="classUnicodeFilter.html#a79392092ceb92adda473ac09d6f88f6c">UnicodeFilter</a>.</p> </div> </div> <a class="anchor" id="af035fa7395f9996afe8ff6d934198884"></a><!-- doxytag: member="UnicodeFunctor::toReplacer" ref="af035fa7395f9996afe8ff6d934198884" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual <a class="el" href="classUnicodeReplacer.html">UnicodeReplacer</a>* UnicodeFunctor::toReplacer </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const<code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Cast 'this' to a UnicodeReplacer* pointer and return the pointer, or null if this is not a UnicodeReplacer*. </p> <p>Subclasses that mix in <a class="el" href="classUnicodeReplacer.html" title="UnicodeReplacer defines a protocol for objects that replace a range of characters...">UnicodeReplacer</a> as a base class must override this. This protocol is required because a pointer to a <a class="el" href="classUnicodeFunctor.html" title="UnicodeFunctor is an abstract base class for objects that perform match and/or replace...">UnicodeFunctor</a> cannot be cast to a pointer to a <a class="el" href="classUnicodeReplacer.html" title="UnicodeReplacer defines a protocol for objects that replace a range of characters...">UnicodeReplacer</a>, since <a class="el" href="classUnicodeReplacer.html" title="UnicodeReplacer defines a protocol for objects that replace a range of characters...">UnicodeReplacer</a> is a mixin that does not derive from <a class="el" href="classUnicodeFunctor.html" title="UnicodeFunctor is an abstract base class for objects that perform match and/or replace...">UnicodeFunctor</a>. </p> <dl class="stable"><dt><b><a class="el" href="stable.html#_stable001347">Stable:</a></b></dt><dd>ICU 2.4 </dd></dl> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="unifunct_8h_source.html">unifunct.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>