<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.11"/> <title>glibmm: Glib::Container_Helpers::ArrayKeeper< Tr > 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> <link href="doxygen.css" rel="stylesheet" type="text/css" /> <link href="doxygen-extra.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 style="height: 56px;"> <td id="projectalign" style="padding-left: 0.5em;"> <div id="projectname">glibmm  <span id="projectnumber">2.60.0</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.11 --> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> <li><a href="examples.html"><span>Examples</span></a></li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="classes.html"><span>Class Index</span></a></li> <li><a href="inherits.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="namespaceGlib.html">Glib</a></li><li class="navelem"><a class="el" href="namespaceGlib_1_1Container__Helpers.html">Container_Helpers</a></li><li class="navelem"><a class="el" href="classGlib_1_1Container__Helpers_1_1ArrayKeeper.html">ArrayKeeper</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#pub-types">Public Types</a> | <a href="#pub-methods">Public Member Functions</a> | <a href="classGlib_1_1Container__Helpers_1_1ArrayKeeper-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">Glib::Container_Helpers::ArrayKeeper< Tr > Class Template Reference</div> </div> </div><!--header--> <div class="contents"> <p>A keeper class for C array. <a href="classGlib_1_1Container__Helpers_1_1ArrayKeeper.html#details">More...</a></p> <p><code>#include <glibmm/vectorutils.h></code></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a> Public Types</h2></td></tr> <tr class="memitem:a71580ea30bdbe2abdf09d90a99540411"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1Container__Helpers_1_1ArrayKeeper.html#a71580ea30bdbe2abdf09d90a99540411">CppType</a> = typename Tr::CppType</td></tr> <tr class="separator:a71580ea30bdbe2abdf09d90a99540411"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a001e4008744d1bb974a31d6cb6237562"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1Container__Helpers_1_1ArrayKeeper.html#a001e4008744d1bb974a31d6cb6237562">CType</a> = typename Tr::CType</td></tr> <tr class="separator:a001e4008744d1bb974a31d6cb6237562"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr class="memitem:a5aef24f8ff4c0f9d5e5b75f34ed5557e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1Container__Helpers_1_1ArrayKeeper.html#a5aef24f8ff4c0f9d5e5b75f34ed5557e">ArrayKeeper</a> (const <a class="el" href="classGlib_1_1Container__Helpers_1_1ArrayKeeper.html#a001e4008744d1bb974a31d6cb6237562">CType</a>* array, std::size_t array_size, <a class="el" href="group__ContHandles.html#ga64c27560b41710ccf64a3679a3ba3f20">Glib::OwnershipType</a> ownership)</td></tr> <tr class="memdesc:a5aef24f8ff4c0f9d5e5b75f34ed5557e"><td class="mdescLeft"> </td><td class="mdescRight">Constructs an <a class="el" href="classGlib_1_1Container__Helpers_1_1ArrayKeeper.html" title="A keeper class for C array. ">ArrayKeeper</a> holding <em>array</em> of size <em>array_size</em>. <a href="#a5aef24f8ff4c0f9d5e5b75f34ed5557e">More...</a><br /></td></tr> <tr class="separator:a5aef24f8ff4c0f9d5e5b75f34ed5557e"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a738365225944b868725261e4a6a78e19"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1Container__Helpers_1_1ArrayKeeper.html#a738365225944b868725261e4a6a78e19">ArrayKeeper</a> (const <a class="el" href="classGlib_1_1Container__Helpers_1_1ArrayKeeper.html">ArrayKeeper</a>& keeper)</td></tr> <tr class="separator:a738365225944b868725261e4a6a78e19"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ac393065acda97ba912eacf78c1b68410"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1Container__Helpers_1_1ArrayKeeper.html#ac393065acda97ba912eacf78c1b68410">~ArrayKeeper</a> () noexcept</td></tr> <tr class="separator:ac393065acda97ba912eacf78c1b68410"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a18f975bdb32d597905cac18321853676"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classGlib_1_1Container__Helpers_1_1ArrayKeeper.html#a001e4008744d1bb974a31d6cb6237562">CType</a>* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGlib_1_1Container__Helpers_1_1ArrayKeeper.html#a18f975bdb32d597905cac18321853676">data</a> () const </td></tr> <tr class="memdesc:a18f975bdb32d597905cac18321853676"><td class="mdescLeft"> </td><td class="mdescRight">Gets data the keeper holds. <a href="#a18f975bdb32d597905cac18321853676">More...</a><br /></td></tr> <tr class="separator:a18f975bdb32d597905cac18321853676"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><h3>template<typename Tr><br /> class Glib::Container_Helpers::ArrayKeeper< Tr ></h3> <p>A keeper class for C array. </p> <p>Primarily used by C++ wrappers like gtkmm.</p> <p>Its main purpose is to free its data when they are not needed. What will be destroyed depends on passed ownership upon construction.</p> <p>The most common usage of Glib::ArrayKeeper is getting its data when converting <a class="elRef" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a06912.html">std::vector</a> to a C array: </p><div class="fragment"><div class="line"><span class="keywordtype">void</span> G::Temp::do_something(<span class="keyword">const</span> <a class="codeRef" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a06912.html">std::vector<int></a>& v)</div><div class="line">{</div><div class="line"> g_temp_do_something(gobj(), <a class="code" href="classGlib_1_1ArrayHandler.html">Glib::ArrayHandler<int>::vector_to_array</a>(v).<a class="code" href="classGlib_1_1Container__Helpers_1_1ArrayKeeper.html#a18f975bdb32d597905cac18321853676">data</a>());</div><div class="line">}</div></div><!-- fragment --><p> Variables of this class are seldom defined directly - it is mostly used as a temporary variable returned by <a class="el" href="classGlib_1_1ArrayHandler.html#a563ad995495dd87c559f9c4c26f4c6f0">Glib::ArrayHandler::vector_to_array()</a>.</p> <p>Note that the usage above is correct with regards to C++ standard point 12.2.3. That means that data returned by <a class="el" href="classGlib_1_1Container__Helpers_1_1ArrayKeeper.html#a18f975bdb32d597905cac18321853676" title="Gets data the keeper holds. ">data()</a> method is valid through whole g_temp_do_something function and is destroyed, when this function returns. </p> </div><h2 class="groupheader">Member Typedef Documentation</h2> <a class="anchor" id="a71580ea30bdbe2abdf09d90a99540411"></a> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template <typename Tr > </div> <table class="memname"> <tr> <td class="memname">using <a class="el" href="classGlib_1_1Container__Helpers_1_1ArrayKeeper.html">Glib::Container_Helpers::ArrayKeeper</a>< Tr >::<a class="el" href="classGlib_1_1Container__Helpers_1_1ArrayKeeper.html#a71580ea30bdbe2abdf09d90a99540411">CppType</a> = typename Tr::CppType</td> </tr> </table> </div><div class="memdoc"> </div> </div> <a class="anchor" id="a001e4008744d1bb974a31d6cb6237562"></a> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template <typename Tr > </div> <table class="memname"> <tr> <td class="memname">using <a class="el" href="classGlib_1_1Container__Helpers_1_1ArrayKeeper.html">Glib::Container_Helpers::ArrayKeeper</a>< Tr >::<a class="el" href="classGlib_1_1Container__Helpers_1_1ArrayKeeper.html#a001e4008744d1bb974a31d6cb6237562">CType</a> = typename Tr::CType</td> </tr> </table> </div><div class="memdoc"> </div> </div> <h2 class="groupheader">Constructor & Destructor Documentation</h2> <a class="anchor" id="a5aef24f8ff4c0f9d5e5b75f34ed5557e"></a> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template <typename Tr > </div> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classGlib_1_1Container__Helpers_1_1ArrayKeeper.html">Glib::Container_Helpers::ArrayKeeper</a>< Tr >::<a class="el" href="classGlib_1_1Container__Helpers_1_1ArrayKeeper.html">ArrayKeeper</a> </td> <td>(</td> <td class="paramtype">const <a class="el" href="classGlib_1_1Container__Helpers_1_1ArrayKeeper.html#a001e4008744d1bb974a31d6cb6237562">CType</a>* </td> <td class="paramname"><em>array</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">std::size_t </td> <td class="paramname"><em>array_size</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="group__ContHandles.html#ga64c27560b41710ccf64a3679a3ba3f20">Glib::OwnershipType</a> </td> <td class="paramname"><em>ownership</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Constructs an <a class="el" href="classGlib_1_1Container__Helpers_1_1ArrayKeeper.html" title="A keeper class for C array. ">ArrayKeeper</a> holding <em>array</em> of size <em>array_size</em>. </p> <p><em>ownership</em> tells what should be destroyed with keeper destruction: </p><ul> <li> <a class="el" href="group__ContHandles.html#gga64c27560b41710ccf64a3679a3ba3f20a7d594cffcc2d2d6c4313ddb4d6613c79">Glib::OWNERSHIP_NONE</a> - keeper won't destroy data it holds. </li> <li> <a class="el" href="group__ContHandles.html#gga64c27560b41710ccf64a3679a3ba3f20a448c598cdc37e2de8a162e1020001715">Glib::OWNERSHIP_SHALLOW</a> - keeper will destroy only container it holds. </li> <li> <a class="el" href="group__ContHandles.html#gga64c27560b41710ccf64a3679a3ba3f20a2a6d6bfadc36f9eda31af79d32928c6a">Glib::OWNERSHIP_DEEP</a> - keeper will destroy data and container it holds. </li> </ul> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">array</td><td>- C array to hold. </td></tr> <tr><td class="paramname">array_size</td><td>- length of <em>array</em>. </td></tr> <tr><td class="paramname">ownership</td><td>- ownership definition. </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="a738365225944b868725261e4a6a78e19"></a> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template <typename Tr > </div> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classGlib_1_1Container__Helpers_1_1ArrayKeeper.html">Glib::Container_Helpers::ArrayKeeper</a>< Tr >::<a class="el" href="classGlib_1_1Container__Helpers_1_1ArrayKeeper.html">ArrayKeeper</a> </td> <td>(</td> <td class="paramtype">const <a class="el" href="classGlib_1_1Container__Helpers_1_1ArrayKeeper.html">ArrayKeeper</a>< Tr >& </td> <td class="paramname"><em>keeper</em></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"> </div> </div> <a class="anchor" id="ac393065acda97ba912eacf78c1b68410"></a> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template <typename Tr > </div> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classGlib_1_1Container__Helpers_1_1ArrayKeeper.html">Glib::Container_Helpers::ArrayKeeper</a>< Tr >::~<a class="el" href="classGlib_1_1Container__Helpers_1_1ArrayKeeper.html">ArrayKeeper</a> </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">noexcept</span></span> </td> </tr> </table> </div><div class="memdoc"> </div> </div> <h2 class="groupheader">Member Function Documentation</h2> <a class="anchor" id="a18f975bdb32d597905cac18321853676"></a> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template <typename Tr > </div> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classGlib_1_1Container__Helpers_1_1ArrayKeeper.html#a001e4008744d1bb974a31d6cb6237562">CType</a>* <a class="el" href="classGlib_1_1Container__Helpers_1_1ArrayKeeper.html">Glib::Container_Helpers::ArrayKeeper</a>< Tr >::data </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</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>Gets data the keeper holds. </p> <p>Note that this data is owned by the keeper, so there is no need to free it.</p> <dl class="section return"><dt>Returns</dt><dd>C array owned by <a class="el" href="classGlib_1_1Container__Helpers_1_1ArrayKeeper.html" title="A keeper class for C array. ">ArrayKeeper</a>. </dd></dl> </div> </div> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated on Tue Mar 19 2019 09:56:47 for glibmm by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.11 </small></address> </body> </html>