Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > bad97183153701b09df5fae1052b1c30 > files > 922

crystalspace-doc-1.2.1-5mdv2010.0.i586.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Crystal Space 1.2.1: csPtrWrap&lt; T &gt; Class Template Reference (Crystal Space 1.2.1 Public API Reference)</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<table border="0" cellpadding="0" cellspacing="0" width="100%" class="head">
 <tr height="59">
  <td class="head" width="202" valign="bottom" style="padding-left:0;"><a href="http://www.crystalspace3d.org/"><img src="csblur.png" width="236" height="59" alt="CrystalSpace" border="0"></a></td>
  <td class="head"><h2>Public API Reference</h2></td>
 </tr>
 <tr height="11">
  <td colspan="2" class="headshadow" valign="top" style="padding-left:0;"><img src="csblurb.png" width="236" height="11" alt="" border="0"></td>
 </tr>
</table>
<div class="content">
<!-- Generated by Doxygen 1.5.3 -->
<div class="tabs">
  <ul>
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
    <li><a href="modules.html"><span>Modules</span></a></li>
    <li><a href="namespaces.html"><span>Namespaces</span></a></li>
    <li class="current"><a href="classes.html"><span>Classes</span></a></li>
    <li><a href="files.html"><span>Files</span></a></li>
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
  </ul>
</div>
<div class="tabs">
  <ul>
    <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
    <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
    <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
    <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
  </ul>
</div>
<h1>csPtrWrap&lt; T &gt; Class Template Reference</h1><!-- doxytag: class="csPtrWrap" -->Simple pointer wrapper class.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="ptrwrap_8h-source.html">csutil/ptrwrap.h</a>&gt;</code>
<p>

<p>
<a href="classcsPtrWrap-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e8181bb3864ec171c880cf22caf544ca"></a><!-- doxytag: member="csPtrWrap::csPtrWrap" ref="e8181bb3864ec171c880cf22caf544ca" args="(T *ptr)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsPtrWrap.html#e8181bb3864ec171c880cf22caf544ca">csPtrWrap</a> (T *ptr)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="05049b75575d138a9f5df3fb4a74f7eb"></a><!-- doxytag: member="csPtrWrap::csPtrWrap" ref="05049b75575d138a9f5df3fb4a74f7eb" args="(const csPtrWrap &amp;other)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsPtrWrap.html#05049b75575d138a9f5df3fb4a74f7eb">csPtrWrap</a> (const <a class="el" href="classcsPtrWrap.html">csPtrWrap</a> &amp;other)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsPtrWrap.html#4e4f5f714e259a59a081b0767f43696a">csPtrWrap</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor.  <a href="#4e4f5f714e259a59a081b0767f43696a"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsPtrWrap.html#27f97a73c9664754e4166c2ab92cb6f1">operator const T *</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Obtain the wrapped pointer.  <a href="#27f97a73c9664754e4166c2ab92cb6f1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsPtrWrap.html#40dd71da2d28b5b88b4c1f69c9276596">operator T *&amp;</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Obtain the wrapped pointer.  <a href="#40dd71da2d28b5b88b4c1f69c9276596"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f09f8c92b41ebe6ed79679c1540bf998"></a><!-- doxytag: member="csPtrWrap::operator=" ref="f09f8c92b41ebe6ed79679c1540bf998" args="(const T *ptr)" -->
<a class="el" href="classcsPtrWrap.html">csPtrWrap</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsPtrWrap.html#f09f8c92b41ebe6ed79679c1540bf998">operator=</a> (const T *ptr)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classcsPtrWrap.html">csPtrWrap</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsPtrWrap.html#0d06c0d6eb49e36a50bfeacd2ba07ee3">operator=</a> (T *ptr)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Assign another pointer.  <a href="#0d06c0d6eb49e36a50bfeacd2ba07ee3"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template&lt;typename T&gt;<br>
 class csPtrWrap&lt; T &gt;</h3>

Simple pointer wrapper class. 
<p>
The difference to a "normal" pointer is that this one will be initialized with 0. 
<p>Definition at line <a class="el" href="ptrwrap_8h-source.html#l00032">32</a> of file <a class="el" href="ptrwrap_8h-source.html">ptrwrap.h</a>.</p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="4e4f5f714e259a59a081b0767f43696a"></a><!-- doxytag: member="csPtrWrap::csPtrWrap" ref="4e4f5f714e259a59a081b0767f43696a" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classcsPtrWrap.html">csPtrWrap</a>&lt; T &gt;::<a class="el" href="classcsPtrWrap.html">csPtrWrap</a>           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Constructor. 
<p>

<p>Definition at line <a class="el" href="ptrwrap_8h-source.html#l00039">39</a> of file <a class="el" href="ptrwrap_8h-source.html">ptrwrap.h</a>.</p>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="27f97a73c9664754e4166c2ab92cb6f1"></a><!-- doxytag: member="csPtrWrap::operator const T *" ref="27f97a73c9664754e4166c2ab92cb6f1" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classcsPtrWrap.html">csPtrWrap</a>&lt; T &gt;::operator const T *           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Obtain the wrapped pointer. 
<p>

<p>Definition at line <a class="el" href="ptrwrap_8h-source.html#l00046">46</a> of file <a class="el" href="ptrwrap_8h-source.html">ptrwrap.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="40dd71da2d28b5b88b4c1f69c9276596"></a><!-- doxytag: member="csPtrWrap::operator T *&amp;" ref="40dd71da2d28b5b88b4c1f69c9276596" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classcsPtrWrap.html">csPtrWrap</a>&lt; T &gt;::operator T *&amp;           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Obtain the wrapped pointer. 
<p>

<p>Definition at line <a class="el" href="ptrwrap_8h-source.html#l00047">47</a> of file <a class="el" href="ptrwrap_8h-source.html">ptrwrap.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="0d06c0d6eb49e36a50bfeacd2ba07ee3"></a><!-- doxytag: member="csPtrWrap::operator=" ref="0d06c0d6eb49e36a50bfeacd2ba07ee3" args="(T *ptr)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classcsPtrWrap.html">csPtrWrap</a>&amp; <a class="el" href="classcsPtrWrap.html">csPtrWrap</a>&lt; T &gt;::operator=           </td>
          <td>(</td>
          <td class="paramtype">T *&nbsp;</td>
          <td class="paramname"> <em>ptr</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Assign another pointer. 
<p>

<p>Definition at line <a class="el" href="ptrwrap_8h-source.html#l00052">52</a> of file <a class="el" href="ptrwrap_8h-source.html">ptrwrap.h</a>.</p>

</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>csutil/<a class="el" href="ptrwrap_8h-source.html">ptrwrap.h</a></ul>
<hr size="1"><address><small>Generated for Crystal Space 1.2.1 by 
<a href="http://www.doxygen.org/index.html">doxygen</a> 1.5.3 
</small></address> </div></body> </html>