Sophie

Sophie

distrib > Mageia > 5 > x86_64 > media > core-updates > by-pkgid > 6be1bc83fe66bfd1cc77e80ea06f2bae > files > 1379

icu-doc-53.1-12.3.mga5.noarch.rpm

<!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.6"/>
<title>ICU 53.1: uobject.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 53.1
   &#160;<span id="projectnumber">53.1</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<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&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;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&#160;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&#160;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">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(12)"><span class="SelectionMark">&#160;</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_55bf5c6bcedc2c5705af95fc7596ac50.html">icu</a></li><li class="navelem"><a class="el" href="dir_17c4e3d278dd0be6889e0e8c41145d45.html">source</a></li><li class="navelem"><a class="el" href="dir_9d30126de01c6acabed440c3eefed2e6.html">common</a></li><li class="navelem"><a class="el" href="dir_09927d28e4089b088d7b70dcc744d58d.html">unicode</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#namespaces">Namespaces</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#typedef-members">Typedefs</a>  </div>
  <div class="headertitle">
<div class="title">uobject.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>C++ API: Common ICU base class UObject.  
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;<a class="el" href="utypes_8h_source.html">unicode/utypes.h</a>&quot;</code><br/>
</div>
<p><a href="uobject_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1UMemory.html">icu::UMemory</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classicu_1_1UMemory.html" title="UMemory is the common ICU base class. ">UMemory</a> is the common ICU base class.  <a href="classicu_1_1UMemory.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1UObject.html">icu::UObject</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classicu_1_1UObject.html" title="UObject is the common ICU &quot;boilerplate&quot; class. ">UObject</a> is the common ICU "boilerplate" class.  <a href="classicu_1_1UObject.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespaceicu"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceicu.html">icu</a></td></tr>
<tr class="memdesc:namespaceicu"><td class="mdescLeft">&#160;</td><td class="mdescRight">File <a class="el" href="coll_8h.html" title="C++ API: Collation Service. ">coll.h</a>. <br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a0415b3e188980bcb82e31c091265f34b"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="uobject_8h.html#a0415b3e188980bcb82e31c091265f34b">UOBJECT_DEFINE_RTTI_IMPLEMENTATION</a>(myClass)</td></tr>
<tr class="memdesc:a0415b3e188980bcb82e31c091265f34b"><td class="mdescLeft">&#160;</td><td class="mdescRight">This is a simple macro to add ICU RTTI to an ICU object implementation.  <a href="#a0415b3e188980bcb82e31c091265f34b">More...</a><br/></td></tr>
<tr class="separator:a0415b3e188980bcb82e31c091265f34b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa53bdd883d784e4c951b051faffc29d0"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="uobject_8h.html#aa53bdd883d784e4c951b051faffc29d0">UOBJECT_DEFINE_ABSTRACT_RTTI_IMPLEMENTATION</a>(myClass)</td></tr>
<tr class="memdesc:aa53bdd883d784e4c951b051faffc29d0"><td class="mdescLeft">&#160;</td><td class="mdescRight">This macro adds ICU RTTI to an ICU abstract class implementation.  <a href="#aa53bdd883d784e4c951b051faffc29d0">More...</a><br/></td></tr>
<tr class="separator:aa53bdd883d784e4c951b051faffc29d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a22af10545208a455a6e884008df48e9f"><td class="memItemLeft" align="right" valign="top">typedef void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="uobject_8h.html#a22af10545208a455a6e884008df48e9f">UClassID</a></td></tr>
<tr class="memdesc:a22af10545208a455a6e884008df48e9f"><td class="mdescLeft">&#160;</td><td class="mdescRight">UClassID is used to identify classes without using the compiler's RTTI.  <a href="#a22af10545208a455a6e884008df48e9f">More...</a><br/></td></tr>
<tr class="separator:a22af10545208a455a6e884008df48e9f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>C++ API: Common ICU base class UObject. </p>

<p>Definition in file <a class="el" href="uobject_8h_source.html">uobject.h</a>.</p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="aa53bdd883d784e4c951b051faffc29d0"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define UOBJECT_DEFINE_ABSTRACT_RTTI_IMPLEMENTATION</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">myClass</td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"><a class="code" href="uobject_8h.html#a22af10545208a455a6e884008df48e9f">UClassID</a> U_EXPORT2 myClass::getStaticClassID() { \</div>
<div class="line">        static <span class="keywordtype">char</span> classID = 0; \</div>
<div class="line">        return (<a class="code" href="uobject_8h.html#a22af10545208a455a6e884008df48e9f">UClassID</a>)&amp;classID; \</div>
<div class="line">    }</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#l00091">uobject.h:91</a></div></div>
</div><!-- fragment -->
<p>This macro adds ICU RTTI to an ICU abstract class implementation. </p>
<p>This macro should be invoked in *.cpp files. The corresponding header should declare getStaticClassID.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">myClass</td><td>The name of the class that needs RTTI defined. </td></tr>
  </table>
  </dd>
</dl>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000181">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>

<p>Definition at line <a class="el" href="uobject_8h_source.html#l00310">310</a> of file <a class="el" href="uobject_8h_source.html">uobject.h</a>.</p>

</div>
</div>
<a class="anchor" id="a0415b3e188980bcb82e31c091265f34b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define UOBJECT_DEFINE_RTTI_IMPLEMENTATION</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">myClass</td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"><a class="code" href="uobject_8h.html#a22af10545208a455a6e884008df48e9f">UClassID</a> U_EXPORT2 myClass::getStaticClassID() { \</div>
<div class="line">        static <span class="keywordtype">char</span> classID = 0; \</div>
<div class="line">        return (<a class="code" href="uobject_8h.html#a22af10545208a455a6e884008df48e9f">UClassID</a>)&amp;classID; \</div>
<div class="line">    } <a class="code" href="uobject_8h.html#a22af10545208a455a6e884008df48e9f">\</a></div>
<div class="line"><a class="code" href="uobject_8h.html#a22af10545208a455a6e884008df48e9f">    UClassID</a> myClass::getDynamicClassID() const \</div>
<div class="line">    { <span class="keywordflow">return</span> myClass::getStaticClassID(); }</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#l00091">uobject.h:91</a></div></div>
</div><!-- fragment -->
<p>This is a simple macro to add ICU RTTI to an ICU object implementation. </p>
<p>This does not go into the header. This should only be used in *.cpp files.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">myClass</td><td>The name of the class that needs RTTI defined. </td></tr>
  </table>
  </dd>
</dl>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000180">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>

<p>Definition at line <a class="el" href="uobject_8h_source.html#l00293">293</a> of file <a class="el" href="uobject_8h_source.html">uobject.h</a>.</p>

</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="a22af10545208a455a6e884008df48e9f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef void* <a class="el" href="uobject_8h.html#a22af10545208a455a6e884008df48e9f">UClassID</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>UClassID is used to identify classes without using the compiler's RTTI. </p>
<p>This was used before C++ compilers consistently supported RTTI. ICU 4.6 requires compiler RTTI to be turned on.</p>
<p>Each class hierarchy which needs to implement polymorphic clone() or <a class="el" href="namespaceicu.html#a1c2f6ca43e636f38d1a3291eb851e9f0" title="Global operator == for StringPiece. ">operator==()</a> defines two methods, described in detail below. UClassID values can be compared using <a class="el" href="namespaceicu.html#a1c2f6ca43e636f38d1a3291eb851e9f0" title="Global operator == for StringPiece. ">operator==()</a>. Nothing else should be done with them.</p>
<dl class="section user"><dt></dt><dd>In class hierarchies that implement "poor man's RTTI", each concrete subclass implements getDynamicClassID() in the same way:</dd></dl>
<div class="fragment"><div class="line"><span class="keyword">class </span>Derived {</div>
<div class="line"><span class="keyword">public</span>:</div>
<div class="line">    <span class="keyword">virtual</span> <a class="code" href="uobject_8h.html#a22af10545208a455a6e884008df48e9f">UClassID</a> getDynamicClassID()<span class="keyword"> const</span></div>
<div class="line"><span class="keyword">      </span>{ <span class="keywordflow">return</span> Derived::getStaticClassID(); }</div>
<div class="line">}</div>
</div><!-- fragment --><p>Each concrete class implements getStaticClassID() as well, which allows clients to test for a specific type.</p>
<div class="fragment"><div class="line"><span class="keyword">class </span>Derived {</div>
<div class="line"><span class="keyword">public</span>:</div>
<div class="line">    <span class="keyword">static</span> <a class="code" href="uobject_8h.html#a22af10545208a455a6e884008df48e9f">UClassID</a> U_EXPORT2 getStaticClassID();</div>
<div class="line"><span class="keyword">private</span>:</div>
<div class="line">    <span class="keyword">static</span> <span class="keywordtype">char</span> fgClassID;</div>
<div class="line">}</div>
<div class="line"></div>
<div class="line"><span class="comment">// In Derived.cpp:</span></div>
<div class="line"><a class="code" href="uobject_8h.html#a22af10545208a455a6e884008df48e9f">UClassID</a> Derived::getStaticClassID()</div>
<div class="line">  { <span class="keywordflow">return</span> (<a class="code" href="uobject_8h.html#a22af10545208a455a6e884008df48e9f">UClassID</a>)&amp;Derived::fgClassID; }</div>
<div class="line"><span class="keywordtype">char</span> Derived::fgClassID = 0; <span class="comment">// Value is irrelevant</span></div>
</div><!-- fragment --> <dl class="stable"><dt><b><a class="el" href="stable.html#_stable002135">Stable:</a></b></dt><dd>ICU 2.0 </dd></dl>

<p>Definition at line <a class="el" href="uobject_8h_source.html#l00091">91</a> of file <a class="el" href="uobject_8h_source.html">uobject.h</a>.</p>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>