diff options
Diffstat (limited to 'doc/html/classsf_1_1ResourcePtr.htm')
| -rwxr-xr-x | doc/html/classsf_1_1ResourcePtr.htm | 162 |
1 files changed, 83 insertions, 79 deletions
diff --git a/doc/html/classsf_1_1ResourcePtr.htm b/doc/html/classsf_1_1ResourcePtr.htm index 0599f96..8f84713 100755 --- a/doc/html/classsf_1_1ResourcePtr.htm +++ b/doc/html/classsf_1_1ResourcePtr.htm @@ -10,30 +10,35 @@ <div id="logo"> <img src="./logo.jpg" width="770" height="200" title="SFML home" alt="SFML logo" /> </div> -<!-- Generated by Doxygen 1.5.2 --> -<div class="tabs"> - <ul> - <li><a href="index.htm"><span>Main Page</span></a></li> - <li><a href="namespaces.htm"><span>Namespaces</span></a></li> - <li class="current"><a href="classes.htm"><span>Classes</span></a></li> - <li><a href="files.htm"><span>Files</span></a></li> - </ul> +<!-- Generated by Doxygen 1.5.8 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.htm"><span>Main Page</span></a></li> + <li><a href="namespaces.htm"><span>Namespaces</span></a></li> + <li class="current"><a href="annotated.htm"><span>Classes</span></a></li> + <li><a href="files.htm"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="annotated.htm"><span>Class List</span></a></li> + <li><a href="classes.htm"><span>Class Index</span></a></li> + <li><a href="hierarchy.htm"><span>Class Hierarchy</span></a></li> + <li><a href="functions.htm"><span>Class Members</span></a></li> + </ul> + </div> + <div class="navpath"><b>sf</b>::<a class="el" href="classsf_1_1ResourcePtr.htm">ResourcePtr</a> + </div> </div> -<div class="tabs"> - <ul> - <li><a href="classes.htm"><span>Alphabetical List</span></a></li> - <li><a href="annotated.htm"><span>Class List</span></a></li> - <li><a href="hierarchy.htm"><span>Class Hierarchy</span></a></li> - <li><a href="functions.htm"><span>Class Members</span></a></li> - </ul> -</div> -<div class="nav"> -<a class="el" href="namespacesf.htm">sf</a>::<a class="el" href="classsf_1_1ResourcePtr.htm">ResourcePtr</a></div> +<div class="contents"> <h1>sf::ResourcePtr< T > Class Template Reference</h1><!-- doxytag: class="sf::ResourcePtr" -->Safe pointer to a T resource (inheriting from sf::Resource<T>), its pointer is automatically reseted when the resource is destroyed. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="Resource_8hpp-source.htm">Resource.hpp</a>></code> <p> + +<p> <a href="classsf_1_1ResourcePtr-members.htm">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> @@ -51,19 +56,19 @@ <tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#0ec69fdecccd1240030b24385f6884dd"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classsf_1_1ResourcePtr.htm">ResourcePtr</a>< T > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1ResourcePtr.htm#efd17640cfe8d96934435fb8f2b40574">operator=</a> (const <a class="el" href="classsf_1_1ResourcePtr.htm">ResourcePtr</a>< T > &Other)</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Assignment operator from another <a class="el" href="classsf_1_1ResourcePtr.htm" title="Safe pointer to a T resource (inheriting from sf::Resource<T>), its pointer is automatically...">ResourcePtr</a>. <a href="#efd17640cfe8d96934435fb8f2b40574"></a><br></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Assignment operator from another <a class="el" href="classsf_1_1ResourcePtr.htm" title="Safe pointer to a T resource (inheriting from sf::Resource<T>), its pointer...">ResourcePtr</a>. <a href="#efd17640cfe8d96934435fb8f2b40574"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classsf_1_1ResourcePtr.htm">ResourcePtr</a>< T > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1ResourcePtr.htm#23a9350a7565a26f0cc1bbadb917248d">operator=</a> (const T *<a class="el" href="classsf_1_1Resource.htm">Resource</a>)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Assignment operator from a raw resource. <a href="#23a9350a7565a26f0cc1bbadb917248d"></a><br></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1ResourcePtr.htm#46b2a5d5ec86f78cd6f6ddd7b609f5a8">operator const T *</a> () const</td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1ResourcePtr.htm#7af0f407f121bff6e4dcf71c7c7955de">operator const T *</a> () const </td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Cast operator to implicitely convert the resource pointer to its raw pointer type. <a href="#46b2a5d5ec86f78cd6f6ddd7b609f5a8"></a><br></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top">const T & </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1ResourcePtr.htm#56fb1195fde211fc11f1c0fbfb1e4211">operator *</a> () const</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Cast operator to implicitely convert the resource pointer to its raw pointer type. <a href="#7af0f407f121bff6e4dcf71c7c7955de"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">const T & </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1ResourcePtr.htm#4e5401c5a07347a35cc3b9192e11b071">operator*</a> () const </td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Operator * overload to return a reference to the actual resource. <a href="#56fb1195fde211fc11f1c0fbfb1e4211"></a><br></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top">const T * </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1ResourcePtr.htm#991c69a0e0d56a5f61fccfd78ee808f9">operator-></a> () const</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Operator * overload to return a reference to the actual resource. <a href="#4e5401c5a07347a35cc3b9192e11b071"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">const T * </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1ResourcePtr.htm#e58ea517eee0a97a778c3c59e4c3fe3a">operator-></a> () const </td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Operator -> overload to return a pointer to the actual resource. <a href="#991c69a0e0d56a5f61fccfd78ee808f9"></a><br></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Operator -> overload to return a pointer to the actual resource. <a href="#e58ea517eee0a97a778c3c59e4c3fe3a"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1ResourcePtr.htm#e7e9d9ed819db0f541a7c22f5a28abf9">OnResourceDestroyed</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Function called when the observed resource is about to be destroyed. <a href="#e7e9d9ed819db0f541a7c22f5a28abf9"></a><br></td></tr> @@ -73,10 +78,8 @@ class sf::ResourcePtr< T ></h3> Safe pointer to a T resource (inheriting from sf::Resource<T>), its pointer is automatically reseted when the resource is destroyed. -<p> - -<p> -Definition at line <a class="el" href="Resource_8hpp-source.htm#l00116">116</a> of file <a class="el" href="Resource_8hpp-source.htm">Resource.hpp</a>.<hr><h2>Constructor & Destructor Documentation</h2> +<p>Definition at line <a class="el" href="Resource_8hpp-source.htm#l00116">116</a> of file <a class="el" href="Resource_8hpp-source.htm">Resource.hpp</a>.</p> +<hr><h2>Constructor & Destructor Documentation</h2> <a class="anchor" name="48ddcd15ed75e9ee3ea88e4d29402140"></a><!-- doxytag: member="sf::ResourcePtr::ResourcePtr" ref="48ddcd15ed75e9ee3ea88e4d29402140" args="()" --> <div class="memitem"> <div class="memproto"> @@ -88,7 +91,7 @@ template<typename T> </div> <td>(</td> <td class="paramname"> </td> <td> ) </td> - <td width="100%"></td> + <td></td> </tr> </table> </div> @@ -112,7 +115,7 @@ template<typename T> </div> <td class="paramtype">const T * </td> <td class="paramname"> <em>Resource</em> </td> <td> ) </td> - <td width="100%"></td> + <td></td> </tr> </table> </div> @@ -141,7 +144,7 @@ template<typename T> </div> <td class="paramtype">const <a class="el" href="classsf_1_1ResourcePtr.htm">ResourcePtr</a>< T > & </td> <td class="paramname"> <em>Copy</em> </td> <td> ) </td> - <td width="100%"></td> + <td></td> </tr> </table> </div> @@ -169,7 +172,7 @@ template<typename T> </div> <td>(</td> <td class="paramname"> </td> <td> ) </td> - <td width="100%"></td> + <td></td> </tr> </table> </div> @@ -182,164 +185,165 @@ Destructor. </div> </div><p> <hr><h2>Member Function Documentation</h2> -<a class="anchor" name="efd17640cfe8d96934435fb8f2b40574"></a><!-- doxytag: member="sf::ResourcePtr::operator=" ref="efd17640cfe8d96934435fb8f2b40574" args="(const ResourcePtr< T > &Other)" --> +<a class="anchor" name="e7e9d9ed819db0f541a7c22f5a28abf9"></a><!-- doxytag: member="sf::ResourcePtr::OnResourceDestroyed" ref="e7e9d9ed819db0f541a7c22f5a28abf9" args="()" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename T> </div> <table class="memname"> <tr> - <td class="memname"><a class="el" href="classsf_1_1ResourcePtr.htm">ResourcePtr</a><T>& <a class="el" href="classsf_1_1ResourcePtr.htm">sf::ResourcePtr</a>< T >::operator= </td> + <td class="memname">void <a class="el" href="classsf_1_1ResourcePtr.htm">sf::ResourcePtr</a>< T >::OnResourceDestroyed </td> <td>(</td> - <td class="paramtype">const <a class="el" href="classsf_1_1ResourcePtr.htm">ResourcePtr</a>< T > & </td> - <td class="paramname"> <em>Other</em> </td> + <td class="paramname"> </td> <td> ) </td> - <td width="100%"></td> + <td></td> </tr> </table> </div> <div class="memdoc"> <p> -Assignment operator from another <a class="el" href="classsf_1_1ResourcePtr.htm" title="Safe pointer to a T resource (inheriting from sf::Resource<T>), its pointer is automatically...">ResourcePtr</a>. +Function called when the observed resource is about to be destroyed. <p> -<dl compact><dt><b>Parameters:</b></dt><dd> - <table border="0" cellspacing="2" cellpadding="0"> - <tr><td valign="top"></td><td valign="top"><em>Other</em> </td><td>: <a class="el" href="classsf_1_1Resource.htm" title="Base class for every resource that needs to notify dependent classes about its destruction...">Resource</a> pointer to assign</td></tr> - </table> -</dl> -<dl class="return" compact><dt><b>Returns:</b></dt><dd>Reference to this </dd></dl> </div> </div><p> -<a class="anchor" name="23a9350a7565a26f0cc1bbadb917248d"></a><!-- doxytag: member="sf::ResourcePtr::operator=" ref="23a9350a7565a26f0cc1bbadb917248d" args="(const T *Resource)" --> +<a class="anchor" name="7af0f407f121bff6e4dcf71c7c7955de"></a><!-- doxytag: member="sf::ResourcePtr::operator const T *" ref="7af0f407f121bff6e4dcf71c7c7955de" args="() const " --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename T> </div> <table class="memname"> <tr> - <td class="memname"><a class="el" href="classsf_1_1ResourcePtr.htm">ResourcePtr</a><T>& <a class="el" href="classsf_1_1ResourcePtr.htm">sf::ResourcePtr</a>< T >::operator= </td> + <td class="memname"><a class="el" href="classsf_1_1ResourcePtr.htm">sf::ResourcePtr</a>< T >::operator const T * </td> <td>(</td> - <td class="paramtype">const T * </td> - <td class="paramname"> <em>Resource</em> </td> + <td class="paramname"> </td> <td> ) </td> - <td width="100%"></td> + <td> const</td> </tr> </table> </div> <div class="memdoc"> <p> -Assignment operator from a raw resource. +Cast operator to implicitely convert the resource pointer to its raw pointer type. <p> -<dl compact><dt><b>Parameters:</b></dt><dd> - <table border="0" cellspacing="2" cellpadding="0"> - <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classsf_1_1Resource.htm" title="Base class for every resource that needs to notify dependent classes about its destruction...">Resource</a></em> </td><td>: <a class="el" href="classsf_1_1Resource.htm" title="Base class for every resource that needs to notify dependent classes about its destruction...">Resource</a> to assign</td></tr> - </table> -</dl> -<dl class="return" compact><dt><b>Returns:</b></dt><dd>Reference to this </dd></dl> +This might be dangerous in the general case, but in this context it is safe enough to define this operator<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>Pointer to the actual resource </dd></dl> </div> </div><p> -<a class="anchor" name="46b2a5d5ec86f78cd6f6ddd7b609f5a8"></a><!-- doxytag: member="sf::ResourcePtr::operator const T *" ref="46b2a5d5ec86f78cd6f6ddd7b609f5a8" args="() const" --> +<a class="anchor" name="4e5401c5a07347a35cc3b9192e11b071"></a><!-- doxytag: member="sf::ResourcePtr::operator*" ref="4e5401c5a07347a35cc3b9192e11b071" args="() const " --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename T> </div> <table class="memname"> <tr> - <td class="memname"><a class="el" href="classsf_1_1ResourcePtr.htm">sf::ResourcePtr</a>< T >::operator const T * </td> + <td class="memname">const T& <a class="el" href="classsf_1_1ResourcePtr.htm">sf::ResourcePtr</a>< T >::operator* </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> - <td width="100%"> const</td> + <td> const</td> </tr> </table> </div> <div class="memdoc"> <p> -Cast operator to implicitely convert the resource pointer to its raw pointer type. +Operator * overload to return a reference to the actual resource. <p> -This might be dangerous in the general case, but in this context it is safe enough to define this operator<p> -<dl class="return" compact><dt><b>Returns:</b></dt><dd>Pointer to the actual resource </dd></dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>Reference to the internal resource </dd></dl> </div> </div><p> -<a class="anchor" name="56fb1195fde211fc11f1c0fbfb1e4211"></a><!-- doxytag: member="sf::ResourcePtr::operator *" ref="56fb1195fde211fc11f1c0fbfb1e4211" args="() const" --> +<a class="anchor" name="e58ea517eee0a97a778c3c59e4c3fe3a"></a><!-- doxytag: member="sf::ResourcePtr::operator->" ref="e58ea517eee0a97a778c3c59e4c3fe3a" args="() const " --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename T> </div> <table class="memname"> <tr> - <td class="memname">const T& <a class="el" href="classsf_1_1ResourcePtr.htm">sf::ResourcePtr</a>< T >::operator * </td> + <td class="memname">const T* <a class="el" href="classsf_1_1ResourcePtr.htm">sf::ResourcePtr</a>< T >::operator-> </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> - <td width="100%"> const</td> + <td> const</td> </tr> </table> </div> <div class="memdoc"> <p> -Operator * overload to return a reference to the actual resource. +Operator -> overload to return a pointer to the actual resource. <p> -<dl class="return" compact><dt><b>Returns:</b></dt><dd>Reference to the internal resource </dd></dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>Pointer to the internal resource </dd></dl> </div> </div><p> -<a class="anchor" name="991c69a0e0d56a5f61fccfd78ee808f9"></a><!-- doxytag: member="sf::ResourcePtr::operator->" ref="991c69a0e0d56a5f61fccfd78ee808f9" args="() const" --> +<a class="anchor" name="23a9350a7565a26f0cc1bbadb917248d"></a><!-- doxytag: member="sf::ResourcePtr::operator=" ref="23a9350a7565a26f0cc1bbadb917248d" args="(const T *Resource)" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename T> </div> <table class="memname"> <tr> - <td class="memname">const T* <a class="el" href="classsf_1_1ResourcePtr.htm">sf::ResourcePtr</a>< T >::operator-> </td> + <td class="memname"><a class="el" href="classsf_1_1ResourcePtr.htm">ResourcePtr</a><T>& <a class="el" href="classsf_1_1ResourcePtr.htm">sf::ResourcePtr</a>< T >::operator= </td> <td>(</td> - <td class="paramname"> </td> + <td class="paramtype">const T * </td> + <td class="paramname"> <em>Resource</em> </td> <td> ) </td> - <td width="100%"> const</td> + <td></td> </tr> </table> </div> <div class="memdoc"> <p> -Operator -> overload to return a pointer to the actual resource. +Assignment operator from a raw resource. <p> -<dl class="return" compact><dt><b>Returns:</b></dt><dd>Pointer to the internal resource </dd></dl> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classsf_1_1Resource.htm" title="Base class for every resource that needs to notify dependent classes about its destruction...">Resource</a></em> </td><td>: <a class="el" href="classsf_1_1Resource.htm" title="Base class for every resource that needs to notify dependent classes about its destruction...">Resource</a> to assign</td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>Reference to this </dd></dl> </div> </div><p> -<a class="anchor" name="e7e9d9ed819db0f541a7c22f5a28abf9"></a><!-- doxytag: member="sf::ResourcePtr::OnResourceDestroyed" ref="e7e9d9ed819db0f541a7c22f5a28abf9" args="()" --> +<a class="anchor" name="efd17640cfe8d96934435fb8f2b40574"></a><!-- doxytag: member="sf::ResourcePtr::operator=" ref="efd17640cfe8d96934435fb8f2b40574" args="(const ResourcePtr< T > &Other)" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename T> </div> <table class="memname"> <tr> - <td class="memname">void <a class="el" href="classsf_1_1ResourcePtr.htm">sf::ResourcePtr</a>< T >::OnResourceDestroyed </td> + <td class="memname"><a class="el" href="classsf_1_1ResourcePtr.htm">ResourcePtr</a><T>& <a class="el" href="classsf_1_1ResourcePtr.htm">sf::ResourcePtr</a>< T >::operator= </td> <td>(</td> - <td class="paramname"> </td> + <td class="paramtype">const <a class="el" href="classsf_1_1ResourcePtr.htm">ResourcePtr</a>< T > & </td> + <td class="paramname"> <em>Other</em> </td> <td> ) </td> - <td width="100%"></td> + <td></td> </tr> </table> </div> <div class="memdoc"> <p> -Function called when the observed resource is about to be destroyed. +Assignment operator from another <a class="el" href="classsf_1_1ResourcePtr.htm" title="Safe pointer to a T resource (inheriting from sf::Resource<T>), its pointer...">ResourcePtr</a>. <p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>Other</em> </td><td>: <a class="el" href="classsf_1_1Resource.htm" title="Base class for every resource that needs to notify dependent classes about its destruction...">Resource</a> pointer to assign</td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>Reference to this </dd></dl> </div> </div><p> <hr>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="Resource_8hpp-source.htm">Resource.hpp</a></ul> +</div> <p id="footer"> :: Copyright © 2007-2008 Laurent Gomila, all rights reserved :: |