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.
386 Commits
7 Branches
57MB
Tree: 16812ef750
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '16812ef750'
${ noResults }
DPF/classScopedPointer.html

469 lines
24KB
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.11"/>

  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/searchdata.js"></script>

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

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

  15.   $(document).ready(function() { init_search(); });

  16. </script>

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

  18. </head>

  19. <body>

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

  21. <div id="titlearea">

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

  23.  <tbody>

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

  25.   <td id="projectalign" style="padding-left: 0.5em;">

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

  27.    </div>

  28.   </td>

  29.  </tr>

  30.  </tbody>

  31. </table>

  32. </div>

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

  34. <!-- Generated by Doxygen 1.8.11 -->

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

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

  37. </script>

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

  39.     <ul class="tablist">

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

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

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

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

  44.       <li>

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

  46.         <span class="left">

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

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

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

  50.                alt=""/>

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

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

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

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

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

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

  57.           </span>

  58.         </div>

  59.       </li>

  60.     </ul>

  61.   </div>

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

  63.     <ul class="tablist">

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

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

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

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

  68.     </ul>

  69.   </div>

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

  71. <div id="MSearchSelectWindow"

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

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

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

  75. </div>

  76. 

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

  78. <div id="MSearchResultsWindow">

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

  80.         name="MSearchResults" id="MSearchResults">

  81. </iframe>

  82. </div>

  83. 

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

  85. <div class="header">

  86.   <div class="summary">

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

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

  89.   <div class="headertitle">

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

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

  92. <div class="contents">

  93. 

  94. <p><code>#include &lt;<a class="el" href="ScopedPointer_8hpp_source.html">ScopedPointer.hpp</a>&gt;</code></p>

  95. <table class="memberdecls">

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

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

  98. <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>

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

  100. <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>

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

  102. <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>

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

  104. <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>

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

  106. <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>

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

  108. <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>

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

  110. <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>

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

  112. <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>

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

  114. <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>

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

  116. <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>

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

  118. <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>

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

  120. <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>

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

  122. </table>

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

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

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

  126. 

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

  128. <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>

  129. <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>

  130. <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>

  131. <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>

  132. <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>

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

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

  135. <div class="memitem">

  136. <div class="memproto">

  137. <div class="memtemplate">

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

  139. <table class="mlabels">

  140.   <tr>

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

  142.       <table class="memname">

  143.         <tr>

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

  145.           <td>(</td>

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

  147.           <td></td>

  148.         </tr>

  149.       </table>

  150.   </td>

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

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

  153.   </tr>

  154. </table>

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

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

  157. 

  158. </div>

  159. </div>

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

  161. <div class="memitem">

  162. <div class="memproto">

  163. <div class="memtemplate">

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

  165. <table class="mlabels">

  166.   <tr>

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

  168.       <table class="memname">

  169.         <tr>

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

  171.           <td>(</td>

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

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

  174.           <td></td>

  175.         </tr>

  176.       </table>

  177.   </td>

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

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

  180.   </tr>

  181. </table>

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

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

  184. 

  185. </div>

  186. </div>

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

  188. <div class="memitem">

  189. <div class="memproto">

  190. <div class="memtemplate">

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

  192. <table class="mlabels">

  193.   <tr>

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

  195.       <table class="memname">

  196.         <tr>

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

  198.           <td>(</td>

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

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

  201.           <td></td>

  202.         </tr>

  203.       </table>

  204.   </td>

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

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

  207.   </tr>

  208. </table>

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

  210. <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>

  211. <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>

  212. 

  213. </div>

  214. </div>

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

  216. <div class="memitem">

  217. <div class="memproto">

  218. <div class="memtemplate">

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

  220. <table class="mlabels">

  221.   <tr>

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

  223.       <table class="memname">

  224.         <tr>

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

  226.           <td>(</td>

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

  228.           <td></td>

  229.         </tr>

  230.       </table>

  231.   </td>

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

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

  234.   </tr>

  235. </table>

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

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

  238. 

  239. </div>

  240. </div>

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

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

  243. <div class="memitem">

  244. <div class="memproto">

  245. <div class="memtemplate">

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

  247. <table class="mlabels">

  248.   <tr>

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

  250.       <table class="memname">

  251.         <tr>

  252.           <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>

  253.           <td>(</td>

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

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

  256.           <td></td>

  257.         </tr>

  258.       </table>

  259.   </td>

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

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

  262.   </tr>

  263. </table>

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

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

  266. <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>

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

  268. 

  269. </div>

  270. </div>

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

  272. <div class="memitem">

  273. <div class="memproto">

  274. <div class="memtemplate">

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

  276. <table class="mlabels">

  277.   <tr>

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

  279.       <table class="memname">

  280.         <tr>

  281.           <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>

  282.           <td>(</td>

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

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

  285.           <td></td>

  286.         </tr>

  287.       </table>

  288.   </td>

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

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

  291.   </tr>

  292. </table>

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

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

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

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

  297. 

  298. </div>

  299. </div>

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

  301. <div class="memitem">

  302. <div class="memproto">

  303. <div class="memtemplate">

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

  305. <table class="mlabels">

  306.   <tr>

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

  308.       <table class="memname">

  309.         <tr>

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

  311.           <td>(</td>

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

  313.           <td> const</td>

  314.         </tr>

  315.       </table>

  316.   </td>

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

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

  319.   </tr>

  320. </table>

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

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

  323. 

  324. </div>

  325. </div>

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

  327. <div class="memitem">

  328. <div class="memproto">

  329. <div class="memtemplate">

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

  331. <table class="mlabels">

  332.   <tr>

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

  334.       <table class="memname">

  335.         <tr>

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

  337.           <td>(</td>

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

  339.           <td> const</td>

  340.         </tr>

  341.       </table>

  342.   </td>

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

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

  345.   </tr>

  346. </table>

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

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

  349. 

  350. </div>

  351. </div>

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

  353. <div class="memitem">

  354. <div class="memproto">

  355. <div class="memtemplate">

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

  357. <table class="mlabels">

  358.   <tr>

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

  360.       <table class="memname">

  361.         <tr>

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

  363.           <td>(</td>

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

  365.           <td> const</td>

  366.         </tr>

  367.       </table>

  368.   </td>

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

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

  371.   </tr>

  372. </table>

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

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

  375. 

  376. </div>

  377. </div>

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

  379. <div class="memitem">

  380. <div class="memproto">

  381. <div class="memtemplate">

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

  383. <table class="mlabels">

  384.   <tr>

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

  386.       <table class="memname">

  387.         <tr>

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

  389.           <td>(</td>

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

  391.           <td> const</td>

  392.         </tr>

  393.       </table>

  394.   </td>

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

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

  397.   </tr>

  398. </table>

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

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

  401. 

  402. </div>

  403. </div>

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

  405. <div class="memitem">

  406. <div class="memproto">

  407. <div class="memtemplate">

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

  409. <table class="mlabels">

  410.   <tr>

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

  412.       <table class="memname">

  413.         <tr>

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

  415.           <td>(</td>

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

  417.           <td></td>

  418.         </tr>

  419.       </table>

  420.   </td>

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

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

  423.   </tr>

  424. </table>

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

  426. <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>

  427. 

  428. </div>

  429. </div>

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

  431. <div class="memitem">

  432. <div class="memproto">

  433. <div class="memtemplate">

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

  435. <table class="mlabels">

  436.   <tr>

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

  438.       <table class="memname">

  439.         <tr>

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

  441.           <td>(</td>

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

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

  444.           <td></td>

  445.         </tr>

  446.       </table>

  447.   </td>

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

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

  450.   </tr>

  451. </table>

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

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

  454. 

  455. </div>

  456. </div>

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

  458. <li>distrho/extra/<a class="el" href="ScopedPointer_8hpp_source.html">ScopedPointer.hpp</a></li>

  459. </ul>

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

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

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

  463. Generated on Tue Jun 7 2016 14:04:30 for DISTRHO Plugin Framework by &#160;<a href="http://www.doxygen.org/index.html">

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

  465. </a> 1.8.11

  466. </small></address>

  467. </body>

  468. </html>