190 lines
12 KiB
HTML
190 lines
12 KiB
HTML
<!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>libsigc++: sigc::bound_argument< T_type > 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">libsigc++
|
|
 <span id="projectnumber">2.10.3</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>
|
|
</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="namespacesigc.html">sigc</a></li><li class="navelem"><a class="el" href="classsigc_1_1bound__argument.html">bound_argument</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="classsigc_1_1bound__argument-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">sigc::bound_argument< T_type > Class Template Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>A bound_argument<Foo> object stores a bound (for instance, with <a class="el" href="group__bind.html#ga2f099bc6056b32f2a58134ba8537c6f4" title="Creates an adaptor of type sigc::bind_functor which binds the passed argument to the passed functor...">sigc::bind()</a>, or <a class="el" href="group__bind.html#gaca1ae2466988d67d00a5f2cd16c8d90a" title="Creates an adaptor of type sigc::bind_return_functor which fixes the return value of the passed funct...">sigc::bind_return()</a>) argument.
|
|
<a href="classsigc_1_1bound__argument.html#details">More...</a></p>
|
|
|
|
<p><code>#include <sigc++/adaptors/bound_argument.h></code></p>
|
|
<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:a495bb69a41b38eda5d6ace5a36807a37"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1bound__argument.html#a495bb69a41b38eda5d6ace5a36807a37">bound_argument</a> (const T_type& _A_argument)</td></tr>
|
|
<tr class="memdesc:a495bb69a41b38eda5d6ace5a36807a37"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a495bb69a41b38eda5d6ace5a36807a37">More...</a><br /></td></tr>
|
|
<tr class="separator:a495bb69a41b38eda5d6ace5a36807a37"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af1cf20526bade89328a1ed398055bbba"><td class="memItemLeft" align="right" valign="top">T_type& </td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1bound__argument.html#af1cf20526bade89328a1ed398055bbba">invoke</a> ()</td></tr>
|
|
<tr class="memdesc:af1cf20526bade89328a1ed398055bbba"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the entity to pass to the bound functor or return. <a href="#af1cf20526bade89328a1ed398055bbba">More...</a><br /></td></tr>
|
|
<tr class="separator:af1cf20526bade89328a1ed398055bbba"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae4816ddf9275c55962542dc7bba20397"><td class="memItemLeft" align="right" valign="top">const T_type& </td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1bound__argument.html#ae4816ddf9275c55962542dc7bba20397">visit</a> () const </td></tr>
|
|
<tr class="memdesc:ae4816ddf9275c55962542dc7bba20397"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the entity to visit in <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="#ae4816ddf9275c55962542dc7bba20397">More...</a><br /></td></tr>
|
|
<tr class="separator:ae4816ddf9275c55962542dc7bba20397"><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<class T_type><br />
|
|
class sigc::bound_argument< T_type ></h3>
|
|
|
|
<p>A bound_argument<Foo> object stores a bound (for instance, with <a class="el" href="group__bind.html#ga2f099bc6056b32f2a58134ba8537c6f4" title="Creates an adaptor of type sigc::bind_functor which binds the passed argument to the passed functor...">sigc::bind()</a>, or <a class="el" href="group__bind.html#gaca1ae2466988d67d00a5f2cd16c8d90a" title="Creates an adaptor of type sigc::bind_return_functor which fixes the return value of the passed funct...">sigc::bind_return()</a>) argument. </p>
|
|
<p>If Foo is a wrapped reference to a class Bar (reference_wrapper<Bar>) then this object is implemented on top of a <a class="el" href="classsigc_1_1limit__reference.html" title="A limit_reference<Foo> object stores a reference (Foo&), but make sure that, if Foo inherits from sig...">limit_reference</a>. When the slot is invoked, the <a class="el" href="classsigc_1_1limit__reference.html#a951ae1d15397406945d4a6b67f30936f" title="Retrieve the reference. ">limit_reference::invoke()</a> method provides the argument (a Bar&). When the slot is visited (e.g. <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>), we simply visit the <a class="el" href="classsigc_1_1limit__reference.html" title="A limit_reference<Foo> object stores a reference (Foo&), but make sure that, if Foo inherits from sig...">limit_reference</a>, which will visit the derived type, or a <a class="el" href="structsigc_1_1trackable.html" title="Base class for objects with auto-disconnection. ">sigc::trackable</a> base if necessary.</p>
|
|
<p>Likewise, If Foo is a wrapped const reference to a class Bar (const_reference_wrapper<Bar>) then this object is implemented on top of a <a class="el" href="classsigc_1_1const__limit__reference.html" title="A const_limit_reference<Foo> object stores a reference (Foo&), but make sure that, if Foo inherits from sigc::trackable, then visit_each<>() will "limit" itself to the sigc::trackable reference instead of the derived reference. ">const_limit_reference</a>.</p>
|
|
<p>If Foo is something else (such as an argument that is bound by value) <a class="el" href="classsigc_1_1bound__argument.html" title="A bound_argument<Foo> object stores a bound (for instance, with sigc::bind(), or sigc::bind_return())...">bound_argument</a> just stores a cop of that value, and both <a class="el" href="classsigc_1_1bound__argument.html#af1cf20526bade89328a1ed398055bbba" title="Retrieve the entity to pass to the bound functor or return. ">invoke()</a> and <a class="el" href="classsigc_1_1bound__argument.html#ae4816ddf9275c55962542dc7bba20397" title="Retrieve the entity to visit in visit_each(). ">visit()</a> simply return it.</p>
|
|
<p>This object is used by the bind_functor<> and bind_return_functor<> objects, depending on whether the argument is bound as a parameter or as a return value.</p>
|
|
<p>The general template implementation is used for parameters that are passed by value. <em>T_type</em> The type of the bound argument. </p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a class="anchor" id="a495bb69a41b38eda5d6ace5a36807a37"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template <class T_type> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classsigc_1_1bound__argument.html">sigc::bound_argument</a>< T_type >::<a class="el" href="classsigc_1_1bound__argument.html">bound_argument</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const T_type & </td>
|
|
<td class="paramname"><em>_A_argument</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">
|
|
|
|
<p>Constructor. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">_A_argument</td><td>The argument to bind. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a class="anchor" id="af1cf20526bade89328a1ed398055bbba"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template <class T_type> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">T_type& <a class="el" href="classsigc_1_1bound__argument.html">sigc::bound_argument</a>< T_type >::invoke </td>
|
|
<td>(</td>
|
|
<td class="paramname"></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>Retrieve the entity to pass to the bound functor or return. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The bound argument. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ae4816ddf9275c55962542dc7bba20397"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template <class T_type> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const T_type& <a class="el" href="classsigc_1_1bound__argument.html">sigc::bound_argument</a>< T_type >::visit </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>Retrieve the entity to visit in <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>
|
|
<dl class="section return"><dt>Returns</dt><dd>The bound argument. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Wed Mar 25 2020 10:13:28 for libsigc++ 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>
|