docs/reference/html/classsigc_1_1limit__reference_3_01T__type_00_01true_01_4.html

   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.9.1"/>
   7 <title>libsigc++: sigc::limit_reference&lt; T_type, true &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="doxygen.css" rel="stylesheet" type="text/css" />
  12 <link href="doxygen-extra.css" rel="stylesheet" type="text/css"/>
  13 </head>
  14 <body>
  15 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  16 <div id="titlearea">
  17 <table cellspacing="0" cellpadding="0">
  18  <tbody>
  19  <tr style="height: 56px;">
  20   <td style="padding-left: 0.5em;">
  21    <div id="projectname">libsigc++
  22    &#160;<span id="projectnumber">2.99.2</span>
  23    </div>
  24   </td>
  25  </tr>
  26  </tbody>
  27 </table>
  28 </div>
  29 <!-- end header part -->
  30 <!-- Generated by Doxygen 1.8.9.1 -->
  31   <div id="navrow1" class="tabs">
  32     <ul class="tablist">
  33       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  34       <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  35       <li><a href="modules.html"><span>Modules</span></a></li>
  36       <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  37       <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  38     </ul>
  39   </div>
  40   <div id="navrow2" class="tabs2">
  41     <ul class="tablist">
  42       <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  43       <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
  44       <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
  45       <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  46     </ul>
  47   </div>
  48 <div id="nav-path" class="navpath">
  49   <ul>
  50 <li class="navelem"><a class="el" href="namespacesigc.html">sigc</a></li><li class="navelem"><a class="el" href="classsigc_1_1limit__reference_3_01T__type_00_01true_01_4.html">limit_reference&lt; T_type, true &gt;</a></li>  </ul>
  51 </div>
  52 </div><!-- top -->
  53 <div class="header">
  54   <div class="summary">
  55 <a href="#pub-types">Public Types</a> &#124;
  56 <a href="#pub-methods">Public Member Functions</a> &#124;
  57 <a href="classsigc_1_1limit__reference_3_01T__type_00_01true_01_4-members.html">List of all members</a>  </div>
  58   <div class="headertitle">
  59 <div class="title">sigc::limit_reference&lt; T_type, true &gt; Class Template Reference</div>  </div>
  60 </div><!--header-->
  61 <div class="contents">
  62
  63 <p><a class="el" href="classsigc_1_1limit__reference.html" title="A limit_reference<Foo> object stores a reference (Foo&), but makes sure that, if Foo inherits from si...">limit_reference</a> object for a class that derives from trackable.
  64  <a href="classsigc_1_1limit__reference_3_01T__type_00_01true_01_4.html#details">More...</a></p>
  65
  66 <p><code>#include &lt;sigc++/limit_reference.h&gt;</code></p>
  67 <table class="memberdecls">
  68 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
  69 Public Types</h2></td></tr>
  70 <tr class="memitem:aae9d2692328f83a89ff8d78978a12ce9"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1limit__reference_3_01T__type_00_01true_01_4.html#aae9d2692328f83a89ff8d78978a12ce9">reference_type</a> = typename std::remove_volatile_t&lt; T_type &gt;</td></tr>
  71 <tr class="separator:aae9d2692328f83a89ff8d78978a12ce9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  72 </table><table class="memberdecls">
  73 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  74 Public Member Functions</h2></td></tr>
  75 <tr class="memitem:af0e66ad8f8945d73f658473e40c57057"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1limit__reference_3_01T__type_00_01true_01_4.html#af0e66ad8f8945d73f658473e40c57057">limit_reference</a> (<a class="el" href="classsigc_1_1limit__reference_3_01T__type_00_01true_01_4.html#aae9d2692328f83a89ff8d78978a12ce9">reference_type</a>&amp; _A_target)</td></tr>
  76 <tr class="memdesc:af0e66ad8f8945d73f658473e40c57057"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#af0e66ad8f8945d73f658473e40c57057">More...</a><br /></td></tr>
  77 <tr class="separator:af0e66ad8f8945d73f658473e40c57057"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78 <tr class="memitem:ad5fbda2f506ff396ed2b83fe327fc8d8"><td class="memItemLeft" align="right" valign="top">T_type&amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1limit__reference_3_01T__type_00_01true_01_4.html#ad5fbda2f506ff396ed2b83fe327fc8d8">invoke</a> () const </td></tr>
  79 <tr class="memdesc:ad5fbda2f506ff396ed2b83fe327fc8d8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieve the reference.  <a href="#ad5fbda2f506ff396ed2b83fe327fc8d8">More...</a><br /></td></tr>
  80 <tr class="separator:ad5fbda2f506ff396ed2b83fe327fc8d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81 <tr class="memitem:acda4db64eb1cf4156d6b35acbe75cef5"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structsigc_1_1trackable.html">trackable</a>&amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1limit__reference_3_01T__type_00_01true_01_4.html#acda4db64eb1cf4156d6b35acbe75cef5">visit</a> () const </td></tr>
  82 <tr class="memdesc:acda4db64eb1cf4156d6b35acbe75cef5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieve the entity to visit for <a class="el" href="group__sigcfunctors.html#ga64cb7832acc1e58efb5ffe0b4f5e9404" title="This function performs a functor on each of the targets of a functor. ">visit_each()</a>.  <a href="#acda4db64eb1cf4156d6b35acbe75cef5">More...</a><br /></td></tr>
  83 <tr class="separator:acda4db64eb1cf4156d6b35acbe75cef5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84 </table>
  85 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  86 <div class="textblock"><h3>template&lt;class T_type&gt;<br />
  87 class sigc::limit_reference&lt; T_type, true &gt;</h3>
  88
  89 <p><a class="el" href="classsigc_1_1limit__reference.html" title="A limit_reference<Foo> object stores a reference (Foo&), but makes sure that, if Foo inherits from si...">limit_reference</a> object for a class that derives from trackable. </p>
  90 <ul>
  91 <li><em>T_type</em> The type of the reference. </li>
  92 </ul>
  93 </div><h2 class="groupheader">Member Typedef Documentation</h2>
  94 <a class="anchor" id="aae9d2692328f83a89ff8d78978a12ce9"></a>
  95 <div class="memitem">
  96 <div class="memproto">
  97 <div class="memtemplate">
  98 template &lt;class T_type &gt; </div>
  99       <table class="memname">
 100         <tr>
 101           <td class="memname">using <a class="el" href="classsigc_1_1limit__reference.html">sigc::limit_reference</a>&lt; T_type, true &gt;::<a class="el" href="classsigc_1_1limit__reference_3_01T__type_00_01true_01_4.html#aae9d2692328f83a89ff8d78978a12ce9">reference_type</a> =  typename std::remove_volatile_t&lt;T_type&gt;</td>
 102         </tr>
 103       </table>
 104 </div><div class="memdoc">
 105
 106 </div>
 107 </div>
 108 <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 109 <a class="anchor" id="af0e66ad8f8945d73f658473e40c57057"></a>
 110 <div class="memitem">
 111 <div class="memproto">
 112 <div class="memtemplate">
 113 template &lt;class T_type &gt; </div>
 114 <table class="mlabels">
 115   <tr>
 116   <td class="mlabels-left">
 117       <table class="memname">
 118         <tr>
 119           <td class="memname"><a class="el" href="classsigc_1_1limit__reference.html">sigc::limit_reference</a>&lt; T_type, true &gt;::<a class="el" href="classsigc_1_1limit__reference.html">limit_reference</a> </td>
 120           <td>(</td>
 121           <td class="paramtype"><a class="el" href="classsigc_1_1limit__reference_3_01T__type_00_01true_01_4.html#aae9d2692328f83a89ff8d78978a12ce9">reference_type</a>&amp;&#160;</td>
 122           <td class="paramname"><em>_A_target</em></td><td>)</td>
 123           <td></td>
 124         </tr>
 125       </table>
 126   </td>
 127   <td class="mlabels-right">
 128 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 129   </tr>
 130 </table>
 131 </div><div class="memdoc">
 132
 133 <p>Constructor. </p>
 134 <dl class="params"><dt>Parameters</dt><dd>
 135   <table class="params">
 136     <tr><td class="paramname">_A_target</td><td>The reference to limit. </td></tr>
 137   </table>
 138   </dd>
 139 </dl>
 140
 141 </div>
 142 </div>
 143 <h2 class="groupheader">Member Function Documentation</h2>
 144 <a class="anchor" id="ad5fbda2f506ff396ed2b83fe327fc8d8"></a>
 145 <div class="memitem">
 146 <div class="memproto">
 147 <div class="memtemplate">
 148 template &lt;class T_type &gt; </div>
 149 <table class="mlabels">
 150   <tr>
 151   <td class="mlabels-left">
 152       <table class="memname">
 153         <tr>
 154           <td class="memname">T_type&amp; <a class="el" href="classsigc_1_1limit__reference.html">sigc::limit_reference</a>&lt; T_type, true &gt;::invoke </td>
 155           <td>(</td>
 156           <td class="paramname"></td><td>)</td>
 157           <td> const</td>
 158         </tr>
 159       </table>
 160   </td>
 161   <td class="mlabels-right">
 162 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 163   </tr>
 164 </table>
 165 </div><div class="memdoc">
 166
 167 <p>Retrieve the reference. </p>
 168 <p>This is always a reference to the derived instance. </p><dl class="section return"><dt>Returns</dt><dd>The reference. </dd></dl>
 169
 170 </div>
 171 </div>
 172 <a class="anchor" id="acda4db64eb1cf4156d6b35acbe75cef5"></a>
 173 <div class="memitem">
 174 <div class="memproto">
 175 <div class="memtemplate">
 176 template &lt;class T_type &gt; </div>
 177 <table class="mlabels">
 178   <tr>
 179   <td class="mlabels-left">
 180       <table class="memname">
 181         <tr>
 182           <td class="memname">const <a class="el" href="structsigc_1_1trackable.html">trackable</a>&amp; <a class="el" href="classsigc_1_1limit__reference.html">sigc::limit_reference</a>&lt; T_type, true &gt;::visit </td>
 183           <td>(</td>
 184           <td class="paramname"></td><td>)</td>
 185           <td> const</td>
 186         </tr>
 187       </table>
 188   </td>
 189   <td class="mlabels-right">
 190 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 191   </tr>
 192 </table>
 193 </div><div class="memdoc">
 194
 195 <p>Retrieve the entity to visit for <a class="el" href="group__sigcfunctors.html#ga64cb7832acc1e58efb5ffe0b4f5e9404" title="This function performs a functor on each of the targets of a functor. ">visit_each()</a>. </p>
 196 <p>Depending on the template specialization, this is either a derived reference, or <a class="el" href="structsigc_1_1trackable.html" title="Base class for objects with auto-disconnection. ">sigc::trackable</a>&amp; if T_type derives from <a class="el" href="structsigc_1_1trackable.html" title="Base class for objects with auto-disconnection. ">sigc::trackable</a>. </p><dl class="section return"><dt>Returns</dt><dd>The reference. </dd></dl>
 197
 198 </div>
 199 </div>
 200 </div><!-- contents -->
 201 <!-- start footer part -->
 202 <hr class="footer"/><address class="footer"><small>
 203 Generated on Wed Mar 16 2016 20:53:28 for libsigc++ by &#160;<a href="http://www.doxygen.org/index.html">
 204 <img class="footer" src="doxygen.png" alt="doxygen"/>
 205 </a> 1.8.9.1
 206 </small></address>
 207 </body>
 208 </html>