<!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: 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 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="#define-members">Macros</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 <a class="el" href="classUObject.html" title="UObject is the common ICU "boilerplate" class.">UObject</a>.
<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="uobject_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="classUMemory.html">UMemory</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classUMemory.html" title="UMemory is the common ICU base class.">UMemory</a> is the common ICU base class. <a href="classUMemory.html#details">More...</a><br/></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classUObject.html">UObject</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classUObject.html" title="UObject is the common ICU "boilerplate" class.">UObject</a> is the common ICU "boilerplate" class. <a href="classUObject.html#details">More...</a><br/></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a9ebf67ac651933234388f16add656f75"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="uobject_8h.html#a9ebf67ac651933234388f16add656f75">U_OVERRIDE_CXX_ALLOCATION</a>   1</td></tr>
<tr class="memdesc:a9ebf67ac651933234388f16add656f75"><td class="mdescLeft"> </td><td class="mdescRight">U_OVERRIDE_CXX_ALLOCATION - Define this to override operator new and delete in <a class="el" href="classUMemory.html" title="UMemory is the common ICU base class.">UMemory</a>. <a href="#a9ebf67ac651933234388f16add656f75"></a><br/></td></tr>
<tr class="memitem:a0f8af19e82b45be1de86ad402c164541"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="uobject_8h.html#a0f8af19e82b45be1de86ad402c164541">U_HAVE_PLACEMENT_NEW</a>   1</td></tr>
<tr class="memdesc:a0f8af19e82b45be1de86ad402c164541"><td class="mdescLeft"> </td><td class="mdescRight">Define this to define the placement new and delete in <a class="el" href="classUMemory.html" title="UMemory is the common ICU base class.">UMemory</a> for STL. <a href="#a0f8af19e82b45be1de86ad402c164541"></a><br/></td></tr>
<tr class="memitem:a80b308fe1f841cb450772f58197ef018"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="uobject_8h.html#a80b308fe1f841cb450772f58197ef018">U_HAVE_DEBUG_LOCATION_NEW</a>   0</td></tr>
<tr class="memdesc:a80b308fe1f841cb450772f58197ef018"><td class="mdescLeft"> </td><td class="mdescRight">Define this to define the MFC debug version of the operator new. <a href="#a80b308fe1f841cb450772f58197ef018"></a><br/></td></tr>
<tr class="memitem:a0415b3e188980bcb82e31c091265f34b"><td class="memItemLeft" align="right" valign="top">#define </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"> </td><td class="mdescRight">This is a simple macro to add ICU RTTI to an ICU object implementation. <a href="#a0415b3e188980bcb82e31c091265f34b"></a><br/></td></tr>
<tr class="memitem:aa53bdd883d784e4c951b051faffc29d0"><td class="memItemLeft" align="right" valign="top">#define </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"> </td><td class="mdescRight">This macro adds ICU RTTI to an ICU abstract class implementation. <a href="#aa53bdd883d784e4c951b051faffc29d0"></a><br/></td></tr>
<tr class="memitem:aebfc0b7b915d88200070b1cb8ea0a198"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="uobject_8h.html#aebfc0b7b915d88200070b1cb8ea0a198">UOBJECT_DEFINE_NO_RTTI_IMPLEMENTATION</a>(myClass)   <a class="el" href="utypes_8h.html#a22af10545208a455a6e884008df48e9f">UClassID</a> myClass::getDynamicClassID() const { return <a class="el" href="LETypes_8h.html#a070d2ce7b6bb7e5c05602aa8c308d0c4">NULL</a>; }</td></tr>
<tr class="memdesc:aebfc0b7b915d88200070b1cb8ea0a198"><td class="mdescLeft"> </td><td class="mdescRight">This is a simple macro to express that a class and its subclasses do not offer ICU's "poor man's RTTI". <a href="#aebfc0b7b915d88200070b1cb8ea0a198"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>C++ API: Common ICU base class <a class="el" href="classUObject.html" title="UObject is the common ICU "boilerplate" class.">UObject</a>. </p>
<p>Definition in file <a class="el" href="uobject_8h_source.html">uobject.h</a>.</p>
</div><hr/><h2>Macro Definition Documentation</h2>
<a class="anchor" id="a80b308fe1f841cb450772f58197ef018"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define U_HAVE_DEBUG_LOCATION_NEW   0</td>
</tr>
</table>
</div><div class="memdoc">
<p>Define this to define the MFC debug version of the operator new. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001790">Stable:</a></b></dt><dd>ICU 3.4 </dd></dl>
<p>Definition at line <a class="el" href="uobject_8h_source.html#l00063">63</a> of file <a class="el" href="uobject_8h_source.html">uobject.h</a>.</p>
</div>
</div>
<a class="anchor" id="a0f8af19e82b45be1de86ad402c164541"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define U_HAVE_PLACEMENT_NEW   1</td>
</tr>
</table>
</div><div class="memdoc">
<p>Define this to define the placement new and delete in <a class="el" href="classUMemory.html" title="UMemory is the common ICU base class.">UMemory</a> for STL. </p>
<dl class="stable"><dt><b><a class="el" href="stable.html#_stable001789">Stable:</a></b></dt><dd>ICU 2.6 </dd></dl>
<p>Definition at line <a class="el" href="uobject_8h_source.html#l00051">51</a> of file <a class="el" href="uobject_8h_source.html">uobject.h</a>.</p>
</div>
</div>
<a class="anchor" id="a9ebf67ac651933234388f16add656f75"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define U_OVERRIDE_CXX_ALLOCATION   1</td>
</tr>
</table>
</div><div class="memdoc">
<p>U_OVERRIDE_CXX_ALLOCATION - Define this to override operator new and delete in <a class="el" href="classUMemory.html" title="UMemory is the common ICU base class.">UMemory</a>. </p>
<p>Enabled by default for ICU. </p>
<pre class="fragment"> Enabling forces all allocation of ICU object types to use ICU's
memory allocation. On Windows, this allows the ICU DLL to be used by
applications that statically link the C Runtime library, meaning that
the app and ICU will be using different heaps.
</pre><dl class="stable"><dt><b><a class="el" href="stable.html#_stable001788">Stable:</a></b></dt><dd>ICU 2.2 </dd></dl>
<p>Definition at line <a class="el" href="uobject_8h_source.html#l00040">40</a> of file <a class="el" href="uobject_8h_source.html">uobject.h</a>.</p>
</div>
</div>
<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"> </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="utypes_8h.html#a22af10545208a455a6e884008df48e9f" title="UClassID is used to identify classes without using RTTI, since RTTI is not yet supported by all C++ c...">UClassID</a> <a class="code" href="platform_8h.html#a72bf6d8ec0640a37b1915e5d853b2016">U_EXPORT2</a> myClass::getStaticClassID() { \</div>
<div class="line"> static <span class="keywordtype">char</span> classID = 0; \</div>
<div class="line"> return (<a class="code" href="utypes_8h.html#a22af10545208a455a6e884008df48e9f" title="UClassID is used to identify classes without using RTTI, since RTTI is not yet supported by all C++ c...">UClassID</a>)&classID; \</div>
<div class="line"> }</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#_internal000146">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#l00314">314</a> of file <a class="el" href="uobject_8h_source.html">uobject.h</a>.</p>
</div>
</div>
<a class="anchor" id="aebfc0b7b915d88200070b1cb8ea0a198"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define UOBJECT_DEFINE_NO_RTTI_IMPLEMENTATION</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">myClass</td><td>)</td>
<td>   <a class="el" href="utypes_8h.html#a22af10545208a455a6e884008df48e9f">UClassID</a> myClass::getDynamicClassID() const { return <a class="el" href="LETypes_8h.html#a070d2ce7b6bb7e5c05602aa8c308d0c4">NULL</a>; }</td>
</tr>
</table>
</div><div class="memdoc">
<p>This is a simple macro to express that a class and its subclasses do not offer ICU's "poor man's RTTI". </p>
<p>Beginning with ICU 4.6, ICU requires C++ compiler RTTI. This does not go into the header. This should only be used in *.cpp files. Use this with a private getDynamicClassID() in an immediate subclass of <a class="el" href="classUObject.html" title="UObject is the common ICU "boilerplate" class.">UObject</a>.</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#_internal000147">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#l00330">330</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"> </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="utypes_8h.html#a22af10545208a455a6e884008df48e9f" title="UClassID is used to identify classes without using RTTI, since RTTI is not yet supported by all C++ c...">UClassID</a> <a class="code" href="platform_8h.html#a72bf6d8ec0640a37b1915e5d853b2016">U_EXPORT2</a> myClass::getStaticClassID() { \</div>
<div class="line"> static <span class="keywordtype">char</span> classID = 0; \</div>
<div class="line"> return (<a class="code" href="utypes_8h.html#a22af10545208a455a6e884008df48e9f" title="UClassID is used to identify classes without using RTTI, since RTTI is not yet supported by all C++ c...">UClassID</a>)&classID; \</div>
<div class="line"> } <a class="code" href="utypes_8h.html#a22af10545208a455a6e884008df48e9f" title="UClassID is used to identify classes without using RTTI, since RTTI is not yet supported by all C++ c...">\</a></div>
<div class="line"><a class="code" href="utypes_8h.html#a22af10545208a455a6e884008df48e9f" title="UClassID is used to identify classes without using RTTI, since RTTI is not yet supported by all C++ c..."> UClassID</a> myClass::getDynamicClassID() const \</div>
<div class="line"> { <span class="keywordflow">return</span> myClass::getStaticClassID(); }</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#_internal000145">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#l00297">297</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  <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>
