<!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"/>
<title>libsigc++: sigc::bound_argument< T_type > Class Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</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 class="tabs">
<ul>
<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="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="namespacesigc.html">sigc</a>::<a class="el" href="classsigc_1_1bound__argument.html">bound_argument</a>
</div>
</div>
<div class="contents">
<h1>sigc::bound_argument< T_type > Class Template Reference</h1><!-- doxytag: class="sigc::bound_argument" -->
<p>A bound_argument<Foo> object stores a bound (for instance, with <a class="el" href="group__bind.html#ga2148290d2cf9c1961ec157a085badd5a" title="Creates an adaptor of type sigc::bind_functor which binds the passed argument to...">sigc::bind()</a>, or <a class="el" href="group__bind.html#ga8a001b0bb588d2ac1af712781b89dc8a" title="Creates an adaptor of type sigc::bind_return_functor which fixes the return value...">sigc::bind_return()</a>) argument. <a href="#_details">More...</a></p>
<p><code>#include <sigc++/adaptors/bound_argument.h></code></p>
<p><a href="classsigc_1_1bound__argument-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><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><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a495bb69a41b38eda5d6ace5a36807a37"></a><br/></td></tr>
<tr><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><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the entity to visit in <a class="el" href="group__sigcfunctors.html#gadab29aed05524743da16319da4430541" title="This function performs a functor on each of the targets of a functor.">visit_each()</a>. <a href="#ae4816ddf9275c55962542dc7bba20397"></a><br/></td></tr>
<tr><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><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the entity to pass to the bound functor or return. <a href="#af1cf20526bade89328a1ed398055bbba"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<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#ga2148290d2cf9c1961ec157a085badd5a" title="Creates an adaptor of type sigc::bind_functor which binds the passed argument to...">sigc::bind()</a>, or <a class="el" href="group__bind.html#ga8a001b0bb588d2ac1af712781b89dc8a" title="Creates an adaptor of type sigc::bind_return_functor which fixes the return value...">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...">limit_reference</a>. When the <a class="el" href="classsigc_1_1slot.html" title="Convenience wrapper for the numbered sigc::slot# templates.">slot</a> 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 <a class="el" href="classsigc_1_1slot.html" title="Convenience wrapper for the numbered sigc::slot# templates.">slot</a> is visited (e.g. <a class="el" href="group__sigcfunctors.html#gadab29aed05524743da16319da4430541" 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...">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...">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()...">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>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a495bb69a41b38eda5d6ace5a36807a37"></a><!-- doxytag: member="sigc::bound_argument::bound_argument" ref="a495bb69a41b38eda5d6ace5a36807a37" args="(const T_type &_A_argument)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template <class T_type> </div>
<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><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>_A_argument</em> </td><td>The argument to bind. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="af1cf20526bade89328a1ed398055bbba"></a><!-- doxytag: member="sigc::bound_argument::invoke" ref="af1cf20526bade89328a1ed398055bbba" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template <class T_type> </div>
<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><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Retrieve the entity to pass to the bound functor or return. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The bound argument. </dd></dl>
</div>
</div>
<a class="anchor" id="ae4816ddf9275c55962542dc7bba20397"></a><!-- doxytag: member="sigc::bound_argument::visit" ref="ae4816ddf9275c55962542dc7bba20397" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template <class T_type> </div>
<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<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Retrieve the entity to visit in <a class="el" href="group__sigcfunctors.html#gadab29aed05524743da16319da4430541" title="This function performs a functor on each of the targets of a functor.">visit_each()</a>. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The bound argument. </dd></dl>
</div>
</div>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on Tue May 4 21:44:43 2010 for libsigc++ by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>
distrib
>
Mandriva
>
2010.1
>
x86_64
>
media
>
main-release
>
by-pkgid
>
bd29e346140bd3fbcbf1674e576e565a
>
files
>
13
