DISTRHO
/
DPF
mirror of https://github.com/DISTRHO/DPF
1
0
Fork 0
Code Releases 0 Activity
DISTRHO Plugin Framework
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
381 Commits
7 Branches
55MB
Tree: f17caee488
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'f17caee488'
${ noResults }
DPF/classScopedPointer.html

468 lines
25KB
Raw Blame History 

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

  2. <html xmlns="http://www.w3.org/1999/xhtml">

  3. <head>

  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>

  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>

  6. <meta name="generator" content="Doxygen 1.8.8"/>

  7. <title>DISTRHO Plugin Framework: ScopedPointer&lt; ObjectType &gt; Class Template Reference</title>

  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>

  9. <script type="text/javascript" src="jquery.js"></script>

  10. <script type="text/javascript" src="dynsections.js"></script>

  11. <link href="search/search.css" rel="stylesheet" type="text/css"/>

  12. <script type="text/javascript" src="search/search.js"></script>

  13. <script type="text/javascript">

  14.   $(document).ready(function() { searchBox.OnSelectItem(0); });

  15. </script>

  16. <link href="doxygen.css" rel="stylesheet" type="text/css" />

  17. </head>

  18. <body>

  19. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->

  20. <div id="titlearea">

  21. <table cellspacing="0" cellpadding="0">

  22.  <tbody>

  23.  <tr style="height: 56px;">

  24.   <td style="padding-left: 0.5em;">

  25.    <div id="projectname">DISTRHO Plugin Framework

  26.    </div>

  27.   </td>

  28.  </tr>

  29.  </tbody>

  30. </table>

  31. </div>

  32. <!-- end header part -->

  33. <!-- Generated by Doxygen 1.8.8 -->

  34. <script type="text/javascript">

  35. var searchBox = new SearchBox("searchBox", "search",false,'Search');

  36. </script>

  37.   <div id="navrow1" class="tabs">

  38.     <ul class="tablist">

  39.       <li><a href="index.html"><span>Main&#160;Page</span></a></li>

  40.       <li><a href="modules.html"><span>Modules</span></a></li>

  41.       <li class="current"><a href="annotated.html"><span>Classes</span></a></li>

  42.       <li><a href="files.html"><span>Files</span></a></li>

  43.       <li>

  44.         <div id="MSearchBox" class="MSearchBoxInactive">

  45.         <span class="left">

  46.           <img id="MSearchSelect" src="search/mag_sel.png"

  47.                onmouseover="return searchBox.OnSearchSelectShow()"

  48.                onmouseout="return searchBox.OnSearchSelectHide()"

  49.                alt=""/>

  50.           <input type="text" id="MSearchField" value="Search" accesskey="S"

  51.                onfocus="searchBox.OnSearchFieldFocus(true)" 

  52.                onblur="searchBox.OnSearchFieldFocus(false)" 

  53.                onkeyup="searchBox.OnSearchFieldChange(event)"/>

  54.           </span><span class="right">

  55.             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>

  56.           </span>

  57.         </div>

  58.       </li>

  59.     </ul>

  60.   </div>

  61.   <div id="navrow2" class="tabs2">

  62.     <ul class="tablist">

  63.       <li><a href="annotated.html"><span>Class&#160;List</span></a></li>

  64.       <li><a href="classes.html"><span>Class&#160;Index</span></a></li>

  65.       <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>

  66.       <li><a href="functions.html"><span>Class&#160;Members</span></a></li>

  67.     </ul>

  68.   </div>

  69. <!-- window showing the filter options -->

  70. <div id="MSearchSelectWindow"

  71.      onmouseover="return searchBox.OnSearchSelectShow()"

  72.      onmouseout="return searchBox.OnSearchSelectHide()"

  73.      onkeydown="return searchBox.OnSearchSelectKey(event)">

  74. <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>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Modules</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Pages</a></div>

  75. 

  76. <!-- iframe showing the search results (closed by default) -->

  77. <div id="MSearchResultsWindow">

  78. <iframe src="javascript:void(0)" frameborder="0" 

  79.         name="MSearchResults" id="MSearchResults">

  80. </iframe>

  81. </div>

  82. 

  83. </div><!-- top -->

  84. <div class="header">

  85.   <div class="summary">

  86. <a href="#pub-methods">Public Member Functions</a> &#124;

  87. <a href="classScopedPointer-members.html">List of all members</a>  </div>

  88.   <div class="headertitle">

  89. <div class="title">ScopedPointer&lt; ObjectType &gt; Class Template Reference</div>  </div>

  90. </div><!--header-->

  91. <div class="contents">

  92. 

  93. <p><code>#include &lt;<a class="el" href="d__scopedpointer_8hpp_source.html">d_scopedpointer.hpp</a>&gt;</code></p>

  94. <table class="memberdecls">

  95. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>

  96. Public Member Functions</h2></td></tr>

  97. <tr class="memitem:ac187958296e33aa057dd37478ea70400"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScopedPointer.html#ac187958296e33aa057dd37478ea70400">ScopedPointer</a> () noexcept</td></tr>

  98. <tr class="separator:ac187958296e33aa057dd37478ea70400"><td class="memSeparator" colspan="2">&#160;</td></tr>

  99. <tr class="memitem:a44a7843e49c3ff719f06607b6e908f7d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScopedPointer.html#a44a7843e49c3ff719f06607b6e908f7d">ScopedPointer</a> (ObjectType *const objectToTakePossessionOf) noexcept</td></tr>

  100. <tr class="separator:a44a7843e49c3ff719f06607b6e908f7d"><td class="memSeparator" colspan="2">&#160;</td></tr>

  101. <tr class="memitem:a04688b1561dd9d861ca80c6deb63a233"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScopedPointer.html#a04688b1561dd9d861ca80c6deb63a233">ScopedPointer</a> (<a class="el" href="classScopedPointer.html">ScopedPointer</a> &amp;objectToTransferFrom) noexcept</td></tr>

  102. <tr class="separator:a04688b1561dd9d861ca80c6deb63a233"><td class="memSeparator" colspan="2">&#160;</td></tr>

  103. <tr class="memitem:a3c540f0121065aafa5f9607362fc1450"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScopedPointer.html#a3c540f0121065aafa5f9607362fc1450">~ScopedPointer</a> ()</td></tr>

  104. <tr class="separator:a3c540f0121065aafa5f9607362fc1450"><td class="memSeparator" colspan="2">&#160;</td></tr>

  105. <tr class="memitem:afefc7940828d72c056e03804cd6bea9f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classScopedPointer.html">ScopedPointer</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScopedPointer.html#afefc7940828d72c056e03804cd6bea9f">operator=</a> (<a class="el" href="classScopedPointer.html">ScopedPointer</a> &amp;objectToTransferFrom)</td></tr>

  106. <tr class="separator:afefc7940828d72c056e03804cd6bea9f"><td class="memSeparator" colspan="2">&#160;</td></tr>

  107. <tr class="memitem:a88ee7f038e57471539d3181141c0390e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classScopedPointer.html">ScopedPointer</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScopedPointer.html#a88ee7f038e57471539d3181141c0390e">operator=</a> (ObjectType *const newObjectToTakePossessionOf)</td></tr>

  108. <tr class="separator:a88ee7f038e57471539d3181141c0390e"><td class="memSeparator" colspan="2">&#160;</td></tr>

  109. <tr class="memitem:af7c241c736d79754fd6f8d305cce8bc3"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScopedPointer.html#af7c241c736d79754fd6f8d305cce8bc3">operator ObjectType *</a> () const noexcept</td></tr>

  110. <tr class="separator:af7c241c736d79754fd6f8d305cce8bc3"><td class="memSeparator" colspan="2">&#160;</td></tr>

  111. <tr class="memitem:ac65fb45b9eb2d53773489fcfbc6fd740"><td class="memItemLeft" align="right" valign="top">ObjectType *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScopedPointer.html#ac65fb45b9eb2d53773489fcfbc6fd740">get</a> () const noexcept</td></tr>

  112. <tr class="separator:ac65fb45b9eb2d53773489fcfbc6fd740"><td class="memSeparator" colspan="2">&#160;</td></tr>

  113. <tr class="memitem:a2f48458a1656a6ef1bd35cb8452eed35"><td class="memItemLeft" align="right" valign="top">ObjectType &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScopedPointer.html#a2f48458a1656a6ef1bd35cb8452eed35">operator*</a> () const noexcept</td></tr>

  114. <tr class="separator:a2f48458a1656a6ef1bd35cb8452eed35"><td class="memSeparator" colspan="2">&#160;</td></tr>

  115. <tr class="memitem:a6eedc84349cbe629cc1abb79ffa74e87"><td class="memItemLeft" align="right" valign="top">ObjectType *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScopedPointer.html#a6eedc84349cbe629cc1abb79ffa74e87">operator-&gt;</a> () const noexcept</td></tr>

  116. <tr class="separator:a6eedc84349cbe629cc1abb79ffa74e87"><td class="memSeparator" colspan="2">&#160;</td></tr>

  117. <tr class="memitem:a10c8f696fec0cca763b067ec3e469199"><td class="memItemLeft" align="right" valign="top">ObjectType *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScopedPointer.html#a10c8f696fec0cca763b067ec3e469199">release</a> () noexcept</td></tr>

  118. <tr class="separator:a10c8f696fec0cca763b067ec3e469199"><td class="memSeparator" colspan="2">&#160;</td></tr>

  119. <tr class="memitem:a362cd8d5a212df0ee08691b75a4ba3de"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScopedPointer.html#a362cd8d5a212df0ee08691b75a4ba3de">swapWith</a> (<a class="el" href="classScopedPointer.html">ScopedPointer</a>&lt; ObjectType &gt; &amp;other) noexcept</td></tr>

  120. <tr class="separator:a362cd8d5a212df0ee08691b75a4ba3de"><td class="memSeparator" colspan="2">&#160;</td></tr>

  121. </table>

  122. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>

  123. <div class="textblock"><h3>template&lt;class ObjectType&gt;<br />

  124. class ScopedPointer&lt; ObjectType &gt;</h3>

  125. 

  126. <p>This class holds a pointer which is automatically deleted when this object goes out of scope.</p>

  127. <p>Once a pointer has been passed to a <a class="el" href="classScopedPointer.html">ScopedPointer</a>, it will make sure that the pointer gets deleted when the <a class="el" href="classScopedPointer.html">ScopedPointer</a> is deleted. Using the <a class="el" href="classScopedPointer.html">ScopedPointer</a> on the stack or as member variables is a good way to use RAII to avoid accidentally leaking dynamically created objects.</p>

  128. <p>A <a class="el" href="classScopedPointer.html">ScopedPointer</a> can be used in pretty much the same way that you'd use a normal pointer to an object. If you use the assignment operator to assign a different object to a <a class="el" href="classScopedPointer.html">ScopedPointer</a>, the old one will be automatically deleted.</p>

  129. <p>A const <a class="el" href="classScopedPointer.html">ScopedPointer</a> is guaranteed not to lose ownership of its object or change the object to which it points during its lifetime. This means that making a copy of a const <a class="el" href="classScopedPointer.html">ScopedPointer</a> is impossible, as that would involve the new copy taking ownership from the old one.</p>

  130. <p>If you need to get a pointer out of a <a class="el" href="classScopedPointer.html">ScopedPointer</a> without it being deleted, you can use the <a class="el" href="classScopedPointer.html#a10c8f696fec0cca763b067ec3e469199">release()</a> method.</p>

  131. <p>Something to note is the main difference between this class and the std::auto_ptr class, which is that <a class="el" href="classScopedPointer.html">ScopedPointer</a> provides a cast-to-object operator, wheras std::auto_ptr requires that you always call <a class="el" href="classScopedPointer.html#ac65fb45b9eb2d53773489fcfbc6fd740">get()</a> to retrieve the pointer. The advantages of providing the cast is that you don't need to call <a class="el" href="classScopedPointer.html#ac65fb45b9eb2d53773489fcfbc6fd740">get()</a>, so can use the <a class="el" href="classScopedPointer.html">ScopedPointer</a> in pretty much exactly the same way as a raw pointer. The disadvantage is that the compiler is free to use the cast in unexpected and sometimes dangerous ways - in particular, it becomes difficult to return a <a class="el" href="classScopedPointer.html">ScopedPointer</a> as the result of a function. To avoid this causing errors, <a class="el" href="classScopedPointer.html">ScopedPointer</a> contains an overloaded constructor that should cause a syntax error in these circumstances, but it does mean that instead of returning a <a class="el" href="classScopedPointer.html">ScopedPointer</a> from a function, you'd need to return a raw pointer (or use a std::auto_ptr instead). </p>

  132. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>

  133. <a class="anchor" id="ac187958296e33aa057dd37478ea70400"></a>

  134. <div class="memitem">

  135. <div class="memproto">

  136. <div class="memtemplate">

  137. template&lt;class ObjectType&gt; </div>

  138. <table class="mlabels">

  139.   <tr>

  140.   <td class="mlabels-left">

  141.       <table class="memname">

  142.         <tr>

  143.           <td class="memname"><a class="el" href="classScopedPointer.html">ScopedPointer</a>&lt; ObjectType &gt;::<a class="el" href="classScopedPointer.html">ScopedPointer</a> </td>

  144.           <td>(</td>

  145.           <td class="paramname"></td><td>)</td>

  146.           <td></td>

  147.         </tr>

  148.       </table>

  149.   </td>

  150.   <td class="mlabels-right">

  151. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span>  </td>

  152.   </tr>

  153. </table>

  154. </div><div class="memdoc">

  155. <p>Creates a <a class="el" href="classScopedPointer.html">ScopedPointer</a> containing a null pointer. </p>

  156. 

  157. </div>

  158. </div>

  159. <a class="anchor" id="a44a7843e49c3ff719f06607b6e908f7d"></a>

  160. <div class="memitem">

  161. <div class="memproto">

  162. <div class="memtemplate">

  163. template&lt;class ObjectType&gt; </div>

  164. <table class="mlabels">

  165.   <tr>

  166.   <td class="mlabels-left">

  167.       <table class="memname">

  168.         <tr>

  169.           <td class="memname"><a class="el" href="classScopedPointer.html">ScopedPointer</a>&lt; ObjectType &gt;::<a class="el" href="classScopedPointer.html">ScopedPointer</a> </td>

  170.           <td>(</td>

  171.           <td class="paramtype">ObjectType *const&#160;</td>

  172.           <td class="paramname"><em>objectToTakePossessionOf</em></td><td>)</td>

  173.           <td></td>

  174.         </tr>

  175.       </table>

  176.   </td>

  177.   <td class="mlabels-right">

  178. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span>  </td>

  179.   </tr>

  180. </table>

  181. </div><div class="memdoc">

  182. <p>Creates a <a class="el" href="classScopedPointer.html">ScopedPointer</a> that owns the specified object. </p>

  183. 

  184. </div>

  185. </div>

  186. <a class="anchor" id="a04688b1561dd9d861ca80c6deb63a233"></a>

  187. <div class="memitem">

  188. <div class="memproto">

  189. <div class="memtemplate">

  190. template&lt;class ObjectType&gt; </div>

  191. <table class="mlabels">

  192.   <tr>

  193.   <td class="mlabels-left">

  194.       <table class="memname">

  195.         <tr>

  196.           <td class="memname"><a class="el" href="classScopedPointer.html">ScopedPointer</a>&lt; ObjectType &gt;::<a class="el" href="classScopedPointer.html">ScopedPointer</a> </td>

  197.           <td>(</td>

  198.           <td class="paramtype"><a class="el" href="classScopedPointer.html">ScopedPointer</a>&lt; ObjectType &gt; &amp;&#160;</td>

  199.           <td class="paramname"><em>objectToTransferFrom</em></td><td>)</td>

  200.           <td></td>

  201.         </tr>

  202.       </table>

  203.   </td>

  204.   <td class="mlabels-right">

  205. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span>  </td>

  206.   </tr>

  207. </table>

  208. </div><div class="memdoc">

  209. <p>Creates a <a class="el" href="classScopedPointer.html">ScopedPointer</a> that takes its pointer from another <a class="el" href="classScopedPointer.html">ScopedPointer</a>.</p>

  210. <p>Because a pointer can only belong to one <a class="el" href="classScopedPointer.html">ScopedPointer</a>, this transfers the pointer from the other object to this one, and the other object is reset to be a null pointer. </p>

  211. 

  212. </div>

  213. </div>

  214. <a class="anchor" id="a3c540f0121065aafa5f9607362fc1450"></a>

  215. <div class="memitem">

  216. <div class="memproto">

  217. <div class="memtemplate">

  218. template&lt;class ObjectType&gt; </div>

  219. <table class="mlabels">

  220.   <tr>

  221.   <td class="mlabels-left">

  222.       <table class="memname">

  223.         <tr>

  224.           <td class="memname"><a class="el" href="classScopedPointer.html">ScopedPointer</a>&lt; ObjectType &gt;::~<a class="el" href="classScopedPointer.html">ScopedPointer</a> </td>

  225.           <td>(</td>

  226.           <td class="paramname"></td><td>)</td>

  227.           <td></td>

  228.         </tr>

  229.       </table>

  230.   </td>

  231.   <td class="mlabels-right">

  232. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  233.   </tr>

  234. </table>

  235. </div><div class="memdoc">

  236. <p>Destructor. This will delete the object that this <a class="el" href="classScopedPointer.html">ScopedPointer</a> currently refers to. </p>

  237. 

  238. </div>

  239. </div>

  240. <h2 class="groupheader">Member Function Documentation</h2>

  241. <a class="anchor" id="afefc7940828d72c056e03804cd6bea9f"></a>

  242. <div class="memitem">

  243. <div class="memproto">

  244. <div class="memtemplate">

  245. template&lt;class ObjectType&gt; </div>

  246. <table class="mlabels">

  247.   <tr>

  248.   <td class="mlabels-left">

  249.       <table class="memname">

  250.         <tr>

  251.           <td class="memname"><a class="el" href="classScopedPointer.html">ScopedPointer</a>&amp; <a class="el" href="classScopedPointer.html">ScopedPointer</a>&lt; ObjectType &gt;::operator= </td>

  252.           <td>(</td>

  253.           <td class="paramtype"><a class="el" href="classScopedPointer.html">ScopedPointer</a>&lt; ObjectType &gt; &amp;&#160;</td>

  254.           <td class="paramname"><em>objectToTransferFrom</em></td><td>)</td>

  255.           <td></td>

  256.         </tr>

  257.       </table>

  258.   </td>

  259.   <td class="mlabels-right">

  260. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  261.   </tr>

  262. </table>

  263. </div><div class="memdoc">

  264. <p>Changes this <a class="el" href="classScopedPointer.html">ScopedPointer</a> to point to a new object.</p>

  265. <p>Because a pointer can only belong to one <a class="el" href="classScopedPointer.html">ScopedPointer</a>, this transfers the pointer from the other object to this one, and the other object is reset to be a null pointer.</p>

  266. <p>If this <a class="el" href="classScopedPointer.html">ScopedPointer</a> already points to an object, that object will first be deleted. </p>

  267. 

  268. </div>

  269. </div>

  270. <a class="anchor" id="a88ee7f038e57471539d3181141c0390e"></a>

  271. <div class="memitem">

  272. <div class="memproto">

  273. <div class="memtemplate">

  274. template&lt;class ObjectType&gt; </div>

  275. <table class="mlabels">

  276.   <tr>

  277.   <td class="mlabels-left">

  278.       <table class="memname">

  279.         <tr>

  280.           <td class="memname"><a class="el" href="classScopedPointer.html">ScopedPointer</a>&amp; <a class="el" href="classScopedPointer.html">ScopedPointer</a>&lt; ObjectType &gt;::operator= </td>

  281.           <td>(</td>

  282.           <td class="paramtype">ObjectType *const&#160;</td>

  283.           <td class="paramname"><em>newObjectToTakePossessionOf</em></td><td>)</td>

  284.           <td></td>

  285.         </tr>

  286.       </table>

  287.   </td>

  288.   <td class="mlabels-right">

  289. <span class="mlabels"><span class="mlabel">inline</span></span>  </td>

  290.   </tr>

  291. </table>

  292. </div><div class="memdoc">

  293. <p>Changes this <a class="el" href="classScopedPointer.html">ScopedPointer</a> to point to a new object.</p>

  294. <p>If this <a class="el" href="classScopedPointer.html">ScopedPointer</a> already points to an object, that object will first be deleted.</p>

  295. <p>The pointer that you pass in may be a nullptr. </p>

  296. 

  297. </div>

  298. </div>

  299. <a class="anchor" id="af7c241c736d79754fd6f8d305cce8bc3"></a>

  300. <div class="memitem">

  301. <div class="memproto">

  302. <div class="memtemplate">

  303. template&lt;class ObjectType&gt; </div>

  304. <table class="mlabels">

  305.   <tr>

  306.   <td class="mlabels-left">

  307.       <table class="memname">

  308.         <tr>

  309.           <td class="memname"><a class="el" href="classScopedPointer.html">ScopedPointer</a>&lt; ObjectType &gt;::operator ObjectType * </td>

  310.           <td>(</td>

  311.           <td class="paramname"></td><td>)</td>

  312.           <td> const</td>

  313.         </tr>

  314.       </table>

  315.   </td>

  316.   <td class="mlabels-right">

  317. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span>  </td>

  318.   </tr>

  319. </table>

  320. </div><div class="memdoc">

  321. <p>Returns the object that this <a class="el" href="classScopedPointer.html">ScopedPointer</a> refers to. </p>

  322. 

  323. </div>

  324. </div>

  325. <a class="anchor" id="ac65fb45b9eb2d53773489fcfbc6fd740"></a>

  326. <div class="memitem">

  327. <div class="memproto">

  328. <div class="memtemplate">

  329. template&lt;class ObjectType&gt; </div>

  330. <table class="mlabels">

  331.   <tr>

  332.   <td class="mlabels-left">

  333.       <table class="memname">

  334.         <tr>

  335.           <td class="memname">ObjectType* <a class="el" href="classScopedPointer.html">ScopedPointer</a>&lt; ObjectType &gt;::get </td>

  336.           <td>(</td>

  337.           <td class="paramname"></td><td>)</td>

  338.           <td> const</td>

  339.         </tr>

  340.       </table>

  341.   </td>

  342.   <td class="mlabels-right">

  343. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span>  </td>

  344.   </tr>

  345. </table>

  346. </div><div class="memdoc">

  347. <p>Returns the object that this <a class="el" href="classScopedPointer.html">ScopedPointer</a> refers to. </p>

  348. 

  349. </div>

  350. </div>

  351. <a class="anchor" id="a2f48458a1656a6ef1bd35cb8452eed35"></a>

  352. <div class="memitem">

  353. <div class="memproto">

  354. <div class="memtemplate">

  355. template&lt;class ObjectType&gt; </div>

  356. <table class="mlabels">

  357.   <tr>

  358.   <td class="mlabels-left">

  359.       <table class="memname">

  360.         <tr>

  361.           <td class="memname">ObjectType&amp; <a class="el" href="classScopedPointer.html">ScopedPointer</a>&lt; ObjectType &gt;::operator* </td>

  362.           <td>(</td>

  363.           <td class="paramname"></td><td>)</td>

  364.           <td> const</td>

  365.         </tr>

  366.       </table>

  367.   </td>

  368.   <td class="mlabels-right">

  369. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span>  </td>

  370.   </tr>

  371. </table>

  372. </div><div class="memdoc">

  373. <p>Returns the object that this <a class="el" href="classScopedPointer.html">ScopedPointer</a> refers to. </p>

  374. 

  375. </div>

  376. </div>

  377. <a class="anchor" id="a6eedc84349cbe629cc1abb79ffa74e87"></a>

  378. <div class="memitem">

  379. <div class="memproto">

  380. <div class="memtemplate">

  381. template&lt;class ObjectType&gt; </div>

  382. <table class="mlabels">

  383.   <tr>

  384.   <td class="mlabels-left">

  385.       <table class="memname">

  386.         <tr>

  387.           <td class="memname">ObjectType* <a class="el" href="classScopedPointer.html">ScopedPointer</a>&lt; ObjectType &gt;::operator-&gt; </td>

  388.           <td>(</td>

  389.           <td class="paramname"></td><td>)</td>

  390.           <td> const</td>

  391.         </tr>

  392.       </table>

  393.   </td>

  394.   <td class="mlabels-right">

  395. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span>  </td>

  396.   </tr>

  397. </table>

  398. </div><div class="memdoc">

  399. <p>Lets you access methods and properties of the object that this <a class="el" href="classScopedPointer.html">ScopedPointer</a> refers to. </p>

  400. 

  401. </div>

  402. </div>

  403. <a class="anchor" id="a10c8f696fec0cca763b067ec3e469199"></a>

  404. <div class="memitem">

  405. <div class="memproto">

  406. <div class="memtemplate">

  407. template&lt;class ObjectType&gt; </div>

  408. <table class="mlabels">

  409.   <tr>

  410.   <td class="mlabels-left">

  411.       <table class="memname">

  412.         <tr>

  413.           <td class="memname">ObjectType* <a class="el" href="classScopedPointer.html">ScopedPointer</a>&lt; ObjectType &gt;::release </td>

  414.           <td>(</td>

  415.           <td class="paramname"></td><td>)</td>

  416.           <td></td>

  417.         </tr>

  418.       </table>

  419.   </td>

  420.   <td class="mlabels-right">

  421. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span>  </td>

  422.   </tr>

  423. </table>

  424. </div><div class="memdoc">

  425. <p>Removes the current object from this <a class="el" href="classScopedPointer.html">ScopedPointer</a> without deleting it. This will return the current object, and set the <a class="el" href="classScopedPointer.html">ScopedPointer</a> to a null pointer. </p>

  426. 

  427. </div>

  428. </div>

  429. <a class="anchor" id="a362cd8d5a212df0ee08691b75a4ba3de"></a>

  430. <div class="memitem">

  431. <div class="memproto">

  432. <div class="memtemplate">

  433. template&lt;class ObjectType&gt; </div>

  434. <table class="mlabels">

  435.   <tr>

  436.   <td class="mlabels-left">

  437.       <table class="memname">

  438.         <tr>

  439.           <td class="memname">void <a class="el" href="classScopedPointer.html">ScopedPointer</a>&lt; ObjectType &gt;::swapWith </td>

  440.           <td>(</td>

  441.           <td class="paramtype"><a class="el" href="classScopedPointer.html">ScopedPointer</a>&lt; ObjectType &gt; &amp;&#160;</td>

  442.           <td class="paramname"><em>other</em></td><td>)</td>

  443.           <td></td>

  444.         </tr>

  445.       </table>

  446.   </td>

  447.   <td class="mlabels-right">

  448. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span>  </td>

  449.   </tr>

  450. </table>

  451. </div><div class="memdoc">

  452. <p>Swaps this object with that of another <a class="el" href="classScopedPointer.html">ScopedPointer</a>. The two objects simply exchange their pointers. </p>

  453. 

  454. </div>

  455. </div>

  456. <hr/>The documentation for this class was generated from the following file:<ul>

  457. <li>distrho/extra/<a class="el" href="d__scopedpointer_8hpp_source.html">d_scopedpointer.hpp</a></li>

  458. </ul>

  459. </div><!-- contents -->

  460. <!-- start footer part -->

  461. <hr class="footer"/><address class="footer"><small>

  462. Generated on Sun Apr 26 2015 16:30:13 for DISTRHO Plugin Framework by &#160;<a href="http://www.doxygen.org/index.html">

  463. <img class="footer" src="doxygen.png" alt="doxygen"/>

  464. </a> 1.8.8

  465. </small></address>

  466. </body>

  467. </html>