Amebis/WinStd
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
WinStd/classwinstd_1_1ref__unique__ptr.html

267 lines
16 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.10.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>WinStd: winstd::ref_unique_ptr&lt; _Ty, _Dx &gt; Class Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">WinStd
</div>
<div id="projectbrief">Windows Win32 API using Standard C++</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.10.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>winstd</b></li><li class="navelem"><a class="el" href="classwinstd_1_1ref__unique__ptr.html">ref_unique_ptr</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="classwinstd_1_1ref__unique__ptr-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">winstd::ref_unique_ptr&lt; _Ty, _Dx &gt; Class Template Reference<div class="ingroups"><a class="el" href="group___win_std_general.html">General</a></div></div></div>
</div><!--header-->
<div class="contents">
<p>Helper class for returning pointers to std::unique_ptr.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="_common_8h_source.html">WinStd/Common.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:af092ed7ea1346c7a92b20ae2f6de5577" id="r_af092ed7ea1346c7a92b20ae2f6de5577"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af092ed7ea1346c7a92b20ae2f6de5577">ref_unique_ptr</a> (std::unique_ptr&lt; <a class="el" href="classwinstd_1_1ref__unique__ptr.html">_Ty</a>, <a class="el" href="classwinstd_1_1ref__unique__ptr.html">_Dx</a> &gt; &amp;<a class="el" href="classwinstd_1_1ref__unique__ptr.html">owner</a>)</td></tr>
<tr class="memdesc:af092ed7ea1346c7a92b20ae2f6de5577"><td class="mdescLeft">&#160;</td><td class="mdescRight">Takes ownership of the pointer. <br /></td></tr>
<tr class="separator:af092ed7ea1346c7a92b20ae2f6de5577"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a755e6f4235fa54330304921ea14b76bc" id="r_a755e6f4235fa54330304921ea14b76bc"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a755e6f4235fa54330304921ea14b76bc">ref_unique_ptr</a> (<a class="el" href="classwinstd_1_1ref__unique__ptr.html">ref_unique_ptr</a>&lt; <a class="el" href="classwinstd_1_1ref__unique__ptr.html">_Ty</a>, <a class="el" href="classwinstd_1_1ref__unique__ptr.html">_Dx</a> &gt; &amp;&amp;other)</td></tr>
<tr class="memdesc:a755e6f4235fa54330304921ea14b76bc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Moves object. <br /></td></tr>
<tr class="separator:a755e6f4235fa54330304921ea14b76bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7bf6de1a715ad7d84f0df0470a102275" id="r_a7bf6de1a715ad7d84f0df0470a102275"><td class="memItemLeft" align="right" valign="top"><a id="a7bf6de1a715ad7d84f0df0470a102275" name="a7bf6de1a715ad7d84f0df0470a102275"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>~ref_unique_ptr</b> ()</td></tr>
<tr class="memdesc:a7bf6de1a715ad7d84f0df0470a102275"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns ownership of the pointer. <br /></td></tr>
<tr class="separator:a7bf6de1a715ad7d84f0df0470a102275"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0a43c89cd281cfe203cd45655d537a02" id="r_a0a43c89cd281cfe203cd45655d537a02"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0a43c89cd281cfe203cd45655d537a02">operator typename _Ty **</a> ()</td></tr>
<tr class="memdesc:a0a43c89cd281cfe203cd45655d537a02"><td class="mdescLeft">&#160;</td><td class="mdescRight">Operator for pointer-to-pointer parameters by value use-cases. <br /></td></tr>
<tr class="separator:a0a43c89cd281cfe203cd45655d537a02"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a45bf0e1b5544e6b8f8f1e907ddaec41b" id="r_a45bf0e1b5544e6b8f8f1e907ddaec41b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a45bf0e1b5544e6b8f8f1e907ddaec41b">operator typename _Ty *&amp;</a> ()</td></tr>
<tr class="memdesc:a45bf0e1b5544e6b8f8f1e907ddaec41b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Operator for reverence-to-pointer parameters by value use-cases. <br /></td></tr>
<tr class="separator:a45bf0e1b5544e6b8f8f1e907ddaec41b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-attribs" name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a343d26837b90973a7f562f0ce36fb82d" id="r_a343d26837b90973a7f562f0ce36fb82d"><td class="memItemLeft" align="right" valign="top"><a id="a343d26837b90973a7f562f0ce36fb82d" name="a343d26837b90973a7f562f0ce36fb82d"></a>
std::unique_ptr&lt; <a class="el" href="classwinstd_1_1ref__unique__ptr.html">_Ty</a>, <a class="el" href="classwinstd_1_1ref__unique__ptr.html">_Dx</a> &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>m_own</b></td></tr>
<tr class="memdesc:a343d26837b90973a7f562f0ce36fb82d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Original owner of the pointer. <br /></td></tr>
<tr class="separator:a343d26837b90973a7f562f0ce36fb82d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a72486d304d712600e6b222fab19d1032" id="r_a72486d304d712600e6b222fab19d1032"><td class="memItemLeft" align="right" valign="top"><a id="a72486d304d712600e6b222fab19d1032" name="a72486d304d712600e6b222fab19d1032"></a>
<a class="el" href="classwinstd_1_1ref__unique__ptr.html">_Ty</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>m_ptr</b></td></tr>
<tr class="memdesc:a72486d304d712600e6b222fab19d1032"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer. <br /></td></tr>
<tr class="separator:a72486d304d712600e6b222fab19d1032"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><div class="compoundTemplParams">template&lt;<a class="el" href="#af092ed7ea1346c7a92b20ae2f6de5577">class</a> <a class="el" href="#af092ed7ea1346c7a92b20ae2f6de5577">_Ty</a>, <a class="el" href="#af092ed7ea1346c7a92b20ae2f6de5577">class</a> <a class="el" href="#af092ed7ea1346c7a92b20ae2f6de5577">_Dx</a>&gt;<br />
class winstd::ref_unique_ptr&lt; _Ty, _Dx &gt;</div><p>Helper class for returning pointers to std::unique_ptr. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="af092ed7ea1346c7a92b20ae2f6de5577" name="af092ed7ea1346c7a92b20ae2f6de5577"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af092ed7ea1346c7a92b20ae2f6de5577">&#9670;&#160;</a></span>ref_unique_ptr() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;<a class="el" href="classwinstd_1_1ref__unique__ptr.html">class</a> <a class="el" href="classwinstd_1_1ref__unique__ptr.html">_Ty</a> , <a class="el" href="classwinstd_1_1ref__unique__ptr.html">class</a> <a class="el" href="classwinstd_1_1ref__unique__ptr.html">_Dx</a> &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classwinstd_1_1ref__unique__ptr.html">winstd::ref_unique_ptr</a>&lt; <a class="el" href="classwinstd_1_1ref__unique__ptr.html">_Ty</a>, <a class="el" href="classwinstd_1_1ref__unique__ptr.html">_Dx</a> &gt;::ref_unique_ptr </td>
<td>(</td>
<td class="paramtype">std::unique_ptr&lt; <a class="el" href="classwinstd_1_1ref__unique__ptr.html">_Ty</a>, <a class="el" href="classwinstd_1_1ref__unique__ptr.html">_Dx</a> &gt; &amp;</td> <td class="paramname"><span class="paramname"><em>owner</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Takes ownership of the pointer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in,out]</td><td class="paramname">owner</td><td>Object to attach helper to </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a755e6f4235fa54330304921ea14b76bc" name="a755e6f4235fa54330304921ea14b76bc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a755e6f4235fa54330304921ea14b76bc">&#9670;&#160;</a></span>ref_unique_ptr() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;<a class="el" href="classwinstd_1_1ref__unique__ptr.html">class</a> <a class="el" href="classwinstd_1_1ref__unique__ptr.html">_Ty</a> , <a class="el" href="classwinstd_1_1ref__unique__ptr.html">class</a> <a class="el" href="classwinstd_1_1ref__unique__ptr.html">_Dx</a> &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classwinstd_1_1ref__unique__ptr.html">winstd::ref_unique_ptr</a>&lt; <a class="el" href="classwinstd_1_1ref__unique__ptr.html">_Ty</a>, <a class="el" href="classwinstd_1_1ref__unique__ptr.html">_Dx</a> &gt;::ref_unique_ptr </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classwinstd_1_1ref__unique__ptr.html">ref_unique_ptr</a>&lt; <a class="el" href="classwinstd_1_1ref__unique__ptr.html">_Ty</a>, <a class="el" href="classwinstd_1_1ref__unique__ptr.html">_Dx</a> &gt; &amp;&amp;</td> <td class="paramname"><span class="paramname"><em>other</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Moves object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in,out]</td><td class="paramname">other</td><td>Source object </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a45bf0e1b5544e6b8f8f1e907ddaec41b" name="a45bf0e1b5544e6b8f8f1e907ddaec41b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a45bf0e1b5544e6b8f8f1e907ddaec41b">&#9670;&#160;</a></span>operator typename _Ty *&amp;()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;<a class="el" href="classwinstd_1_1ref__unique__ptr.html">class</a> <a class="el" href="classwinstd_1_1ref__unique__ptr.html">_Ty</a> , <a class="el" href="classwinstd_1_1ref__unique__ptr.html">class</a> <a class="el" href="classwinstd_1_1ref__unique__ptr.html">_Dx</a> &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classwinstd_1_1ref__unique__ptr.html">winstd::ref_unique_ptr</a>&lt; <a class="el" href="classwinstd_1_1ref__unique__ptr.html">_Ty</a>, <a class="el" href="classwinstd_1_1ref__unique__ptr.html">_Dx</a> &gt;<a class="el" href="#af092ed7ea1346c7a92b20ae2f6de5577">::operator</a> <a class="el" href="classwinstd_1_1ref__unique__ptr.html">typename</a> <a class="el" href="classwinstd_1_1ref__unique__ptr.html">_Ty</a> *&amp; </td>
<td>(</td>
<td class="paramname"><span class="paramname"></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Operator for reverence-to-pointer parameters by value use-cases. </p>
<dl class="section return"><dt>Returns</dt><dd>Reference to the pointer </dd></dl>
</div>
</div>
<a id="a0a43c89cd281cfe203cd45655d537a02" name="a0a43c89cd281cfe203cd45655d537a02"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0a43c89cd281cfe203cd45655d537a02">&#9670;&#160;</a></span>operator typename _Ty **()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;<a class="el" href="classwinstd_1_1ref__unique__ptr.html">class</a> <a class="el" href="classwinstd_1_1ref__unique__ptr.html">_Ty</a> , <a class="el" href="classwinstd_1_1ref__unique__ptr.html">class</a> <a class="el" href="classwinstd_1_1ref__unique__ptr.html">_Dx</a> &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classwinstd_1_1ref__unique__ptr.html">winstd::ref_unique_ptr</a>&lt; <a class="el" href="classwinstd_1_1ref__unique__ptr.html">_Ty</a>, <a class="el" href="classwinstd_1_1ref__unique__ptr.html">_Dx</a> &gt;<a class="el" href="#af092ed7ea1346c7a92b20ae2f6de5577">::operator</a> <a class="el" href="classwinstd_1_1ref__unique__ptr.html">typename</a> <a class="el" href="classwinstd_1_1ref__unique__ptr.html">_Ty</a> ** </td>
<td>(</td>
<td class="paramname"><span class="paramname"></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Operator for pointer-to-pointer parameters by value use-cases. </p>
<dl class="section return"><dt>Returns</dt><dd>Pointer to the pointer </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/WinStd/<a class="el" href="_common_8h_source.html">Common.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Jan 8 2024 07:53:19 for WinStd by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.10.0
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink