1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144
|
<!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>Crazy Eddies GUI System: CEGUI::RefCounted< T > Class Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.4 -->
<script type="text/javascript">
function hasClass(ele,cls) {
return ele.className.match(new RegExp('(\\s|^)'+cls+'(\\s|$)'));
}
function addClass(ele,cls) {
if (!this.hasClass(ele,cls)) ele.className += " "+cls;
}
function removeClass(ele,cls) {
if (hasClass(ele,cls)) {
var reg = new RegExp('(\\s|^)'+cls+'(\\s|$)');
ele.className=ele.className.replace(reg,' ');
}
}
function toggleVisibility(linkObj) {
var base = linkObj.getAttribute('id');
var summary = document.getElementById(base + '-summary');
var content = document.getElementById(base + '-content');
var trigger = document.getElementById(base + '-trigger');
if ( hasClass(linkObj,'closed') ) {
summary.style.display = 'none';
content.style.display = 'block';
trigger.src = 'open.png';
removeClass(linkObj,'closed');
addClass(linkObj,'opened');
} else if ( hasClass(linkObj,'opened') ) {
summary.style.display = 'block';
content.style.display = 'none';
trigger.src = 'closed.png';
removeClass(linkObj,'opened');
addClass(linkObj,'closed');
}
return false;
}
</script>
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Crazy Eddies GUI System <span id="projectnumber">0.7.6</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<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="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceCEGUI.html">CEGUI</a> </li>
<li class="navelem"><a class="el" href="classCEGUI_1_1RefCounted.html">RefCounted</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">CEGUI::RefCounted< T > Class Template Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="CEGUI::RefCounted" -->
<p>Simple, generic, reference counted pointer class. This is primarily here for use by the Events system to track when to delete slot bindings.
<a href="classCEGUI_1_1RefCounted.html#details">More...</a></p>
<p><a href="classCEGUI_1_1RefCounted-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a664d68f4e0a39c965fb4e46e2d8ce375"></a><!-- doxytag: member="CEGUI::RefCounted::RefCounted" ref="a664d68f4e0a39c965fb4e46e2d8ce375" args="()" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RefCounted.html#a664d68f4e0a39c965fb4e46e2d8ce375">RefCounted</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5f5881233aae2fe27e628c9ee1c93c11"></a><!-- doxytag: member="CEGUI::RefCounted::RefCounted" ref="a5f5881233aae2fe27e628c9ee1c93c11" args="(T *ob)" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RefCounted.html#a5f5881233aae2fe27e628c9ee1c93c11">RefCounted</a> (T *ob)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Contruct a <a class="el" href="classCEGUI_1_1RefCounted.html" title="Simple, generic, reference counted pointer class. This is primarily here for use by the Events system...">RefCounted</a> object that wraps the pointer <em>ob</em>. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a85858524729804a9251574156e780608"></a><!-- doxytag: member="CEGUI::RefCounted::RefCounted" ref="a85858524729804a9251574156e780608" args="(const RefCounted< T > &other)" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RefCounted.html#a85858524729804a9251574156e780608">RefCounted</a> (const <a class="el" href="classCEGUI_1_1RefCounted.html">RefCounted</a>< T > &other)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a772f4e55e704f830d205de111a8f78bb"></a><!-- doxytag: member="CEGUI::RefCounted::~RefCounted" ref="a772f4e55e704f830d205de111a8f78bb" args="()" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RefCounted.html#a772f4e55e704f830d205de111a8f78bb">~RefCounted</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. Only deletes the associated object if no further references exist. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5b93a782767966d1202580dcb508861e"></a><!-- doxytag: member="CEGUI::RefCounted::operator=" ref="a5b93a782767966d1202580dcb508861e" args="(const RefCounted< T > &other)" -->
<a class="el" href="classCEGUI_1_1RefCounted.html">RefCounted</a>< T > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RefCounted.html#a5b93a782767966d1202580dcb508861e">operator=</a> (const <a class="el" href="classCEGUI_1_1RefCounted.html">RefCounted</a>< T > &other)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Assignment operator. Previously held object gets its reference count reduced, and is deleted if no further references exist. The newly assigned object, taken from <em>other</em>, gets its count increased. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a04aa4f94c1b33b03c730ae36a82f189f"></a><!-- doxytag: member="CEGUI::RefCounted::operator==" ref="a04aa4f94c1b33b03c730ae36a82f189f" args="(const RefCounted< T > &other) const " -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RefCounted.html#a04aa4f94c1b33b03c730ae36a82f189f">operator==</a> (const <a class="el" href="classCEGUI_1_1RefCounted.html">RefCounted</a>< T > &other) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return whether the two <a class="el" href="classCEGUI_1_1RefCounted.html" title="Simple, generic, reference counted pointer class. This is primarily here for use by the Events system...">RefCounted</a> ptrs are equal (point to the same object) <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a15e3f35f3b53229300718b5620912b71"></a><!-- doxytag: member="CEGUI::RefCounted::operator!=" ref="a15e3f35f3b53229300718b5620912b71" args="(const RefCounted< T > &other) const " -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RefCounted.html#a15e3f35f3b53229300718b5620912b71">operator!=</a> (const <a class="el" href="classCEGUI_1_1RefCounted.html">RefCounted</a>< T > &other) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return whether the two <a class="el" href="classCEGUI_1_1RefCounted.html" title="Simple, generic, reference counted pointer class. This is primarily here for use by the Events system...">RefCounted</a> ptrs are not equal (point to different objects) <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a395b96fc408f0dd924affe8f3c7f50ce"></a><!-- doxytag: member="CEGUI::RefCounted::operator*" ref="a395b96fc408f0dd924affe8f3c7f50ce" args="() const " -->
const T & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RefCounted.html#a395b96fc408f0dd924affe8f3c7f50ce">operator*</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the object referred to by the wrapped pointer. (beware of null pointers when using this!) <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adc954748d13918a98b2cf01eae734564"></a><!-- doxytag: member="CEGUI::RefCounted::operator*" ref="adc954748d13918a98b2cf01eae734564" args="()" -->
T & </td><td class="memItemRight" valign="bottom"><b>operator*</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a52d6c40348cb2c43309871b8ad51cdd1"></a><!-- doxytag: member="CEGUI::RefCounted::operator->" ref="a52d6c40348cb2c43309871b8ad51cdd1" args="() const " -->
const T * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RefCounted.html#a52d6c40348cb2c43309871b8ad51cdd1">operator-></a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the wrapped pointer. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1aed1d01b39531f82e5abcdbbc2bd215"></a><!-- doxytag: member="CEGUI::RefCounted::operator->" ref="a1aed1d01b39531f82e5abcdbbc2bd215" args="()" -->
T * </td><td class="memItemRight" valign="bottom"><b>operator-></b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aabe30992b214886b7f5960ec6f293e8c"></a><!-- doxytag: member="CEGUI::RefCounted::isValid" ref="aabe30992b214886b7f5960ec6f293e8c" args="() const " -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RefCounted.html#aabe30992b214886b7f5960ec6f293e8c">isValid</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return whether the wrapped pointer is valid. i.e. that it is not null. <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><h3>template<typename T><br/>
class CEGUI::RefCounted< T ></h3>
<p>Simple, generic, reference counted pointer class. This is primarily here for use by the Events system to track when to delete slot bindings. </p>
</div></div>
<hr class="footer"/><address class="footer"><small>Generated on Sun Jan 22 2012 16:07:41 for Crazy Eddies GUI System by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>
|