<!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::slot5< T_return, T_arg1, T_arg2, T_arg3, T_arg4, T_arg5 > 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.7.2 -->
<div class="navigation" id="top">
<div class="tabs">
<ul class="tablist">
<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="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="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath">
<ul>
<li><a class="el" href="namespacesigc.html">sigc</a> </li>
<li><a class="el" href="classsigc_1_1slot5.html">slot5</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<h1>sigc::slot5< T_return, T_arg1, T_arg2, T_arg3, T_arg4, T_arg5 > Class Template Reference<br/>
<small>
[<a class="el" href="group__slot.html">Slots</a>]</small>
</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="sigc::slot5" --><!-- doxytag: inherits="sigc::slot_base" -->
<p>Converts an arbitrary functor to a unified type which is opaque. <a href="#_details">More...</a></p>
<p><code>#include <sigc++/functors/slot.h></code></p>
<!-- startSectionHeader --><div class="dynheader">
Inheritance diagram for sigc::slot5< T_return, T_arg1, T_arg2, T_arg3, T_arg4, T_arg5 >:<!-- endSectionHeader --></div>
<!-- startSectionSummary --><!-- endSectionSummary --><!-- startSectionContent --><div class="dyncontent">
<div class="center"><img src="classsigc_1_1slot5__inherit__graph.png" border="0" usemap="#sigc_1_1slot5_3_01T__return_00_01T__arg1_00_01T__arg2_00_01T__arg3_00_01T__arg4_00_01T__arg5_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="sigc_1_1slot5_3_01T__return_00_01T__arg1_00_01T__arg2_00_01T__arg3_00_01T__arg4_00_01T__arg5_01_4_inherit__map" id="sigc_1_1slot5_3_01T__return_00_01T__arg1_00_01T__arg2_00_01T__arg3_00_01T__arg4_00_01T__arg5_01_4_inherit__map">
<area shape="rect" id="node7" href="classsigc_1_1slot_3_01T__return_00_01T__arg1_00_01T__arg2_00_01T__arg3_00_01T__arg4_00_01T__arg5_00_01nil_00_01nil_01_4.html" title="Convenience wrapper for the numbered sigc::slot5 template." alt="" coords="5,237,464,267"/><area shape="rect" id="node2" href="classsigc_1_1slot__base.html" title="Base type for slots." alt="" coords="177,83,292,112"/><area shape="rect" id="node4" href="structsigc_1_1functor__base.html" title="A hint to the compiler." alt="" coords="165,5,304,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center><!-- endSectionContent --></div>
<p><a href="classsigc_1_1slot5-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aac50a6486dddcac3a42022a6f2189f09"></a><!-- doxytag: member="sigc::slot5::result_type" ref="aac50a6486dddcac3a42022a6f2189f09" args="" -->
typedef T_return </td><td class="memItemRight" valign="bottom"><b>result_type</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa3dd44327a3881b5fbf725456a08cb0d"></a><!-- doxytag: member="sigc::slot5::arg1_type_" ref="aa3dd44327a3881b5fbf725456a08cb0d" args="" -->
typedef type_trait< T_arg1 >::take </td><td class="memItemRight" valign="bottom"><b>arg1_type_</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acf28e48ef5d2fbac436b2b5480c54924"></a><!-- doxytag: member="sigc::slot5::arg2_type_" ref="acf28e48ef5d2fbac436b2b5480c54924" args="" -->
typedef type_trait< T_arg2 >::take </td><td class="memItemRight" valign="bottom"><b>arg2_type_</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a148432d9435380a29d4cb2501bcbe12a"></a><!-- doxytag: member="sigc::slot5::arg3_type_" ref="a148432d9435380a29d4cb2501bcbe12a" args="" -->
typedef type_trait< T_arg3 >::take </td><td class="memItemRight" valign="bottom"><b>arg3_type_</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8a06dbe3ec0dc66d60a7cd005fd6e134"></a><!-- doxytag: member="sigc::slot5::arg4_type_" ref="a8a06dbe3ec0dc66d60a7cd005fd6e134" args="" -->
typedef type_trait< T_arg4 >::take </td><td class="memItemRight" valign="bottom"><b>arg4_type_</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7838ffea5ef5d1b1e980267dba0d63e9"></a><!-- doxytag: member="sigc::slot5::arg5_type_" ref="a7838ffea5ef5d1b1e980267dba0d63e9" args="" -->
typedef type_trait< T_arg5 >::take </td><td class="memItemRight" valign="bottom"><b>arg5_type_</b></td></tr>
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">T_return </td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1slot5.html#a2c05f974b6c5c8b59b2a5259ace5e1c7">operator()</a> (arg1_type_ _A_a1, arg2_type_ _A_a2, arg3_type_ _A_a3, arg4_type_ _A_a4, arg5_type_ _A_a5) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Invoke the contained functor unless slot is in blocking state. <a href="#a2c05f974b6c5c8b59b2a5259ace5e1c7"></a><br/></td></tr>
<tr><td class="memTemplParams" colspan="2">template<class T_functor > </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top"> </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classsigc_1_1slot5.html#a2e67f263b100b6f542234dc37b3fe85f">slot5</a> (const T_functor& _A_func)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructs a slot from an arbitrary functor. <a href="#a2e67f263b100b6f542234dc37b3fe85f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad54fd2ef5f50844c214f1a5fbaef9299"></a><!-- doxytag: member="sigc::slot5::slot5" ref="ad54fd2ef5f50844c214f1a5fbaef9299" args="(const slot5 &src)" -->
 </td><td class="memItemRight" valign="bottom"><b>slot5</b> (const <a class="el" href="classsigc_1_1slot5.html">slot5</a>& src)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsigc_1_1slot5.html">slot5</a>& </td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1slot5.html#a24d22be7be827080b34109c625bad7fd">operator=</a> (const <a class="el" href="classsigc_1_1slot5.html">slot5</a>& src)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Overrides this slot making a copy from another slot. <a href="#a24d22be7be827080b34109c625bad7fd"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<h3>template <class T_return, class T_arg1, class T_arg2, class T_arg3, class T_arg4, class T_arg5><br/>
class sigc::slot5< T_return, T_arg1, T_arg2, T_arg3, T_arg4, T_arg5 ></h3>
<p>Converts an arbitrary functor to a unified type which is opaque. </p>
<p><a class="el" href="classsigc_1_1slot.html" title="Convenience wrapper for the numbered sigc::slot# templates.">sigc::slot</a> itself is a functor or to be more precise a closure. It contains a single, arbitrary functor (or closure) that is executed in <a class="el" href="classsigc_1_1slot5.html#a2c05f974b6c5c8b59b2a5259ace5e1c7" title="Invoke the contained functor unless slot is in blocking state.">operator()()</a>.</p>
<p>The template arguments determine the function signature of <a class="el" href="classsigc_1_1slot5.html#a2c05f974b6c5c8b59b2a5259ace5e1c7" title="Invoke the contained functor unless slot is in blocking state.">operator()()</a>:</p>
<ul>
<li><em>T_return</em> The return type of <a class="el" href="classsigc_1_1slot5.html#a2c05f974b6c5c8b59b2a5259ace5e1c7" title="Invoke the contained functor unless slot is in blocking state.">operator()()</a>.</li>
<li><em>T_arg1</em> Argument type used in the definition of <a class="el" href="classsigc_1_1slot5.html#a2c05f974b6c5c8b59b2a5259ace5e1c7" title="Invoke the contained functor unless slot is in blocking state.">operator()()</a>. The default <code>nil</code> means no argument.</li>
<li><em>T_arg2</em> Argument type used in the definition of <a class="el" href="classsigc_1_1slot5.html#a2c05f974b6c5c8b59b2a5259ace5e1c7" title="Invoke the contained functor unless slot is in blocking state.">operator()()</a>. The default <code>nil</code> means no argument.</li>
<li><em>T_arg3</em> Argument type used in the definition of <a class="el" href="classsigc_1_1slot5.html#a2c05f974b6c5c8b59b2a5259ace5e1c7" title="Invoke the contained functor unless slot is in blocking state.">operator()()</a>. The default <code>nil</code> means no argument.</li>
<li><em>T_arg4</em> Argument type used in the definition of <a class="el" href="classsigc_1_1slot5.html#a2c05f974b6c5c8b59b2a5259ace5e1c7" title="Invoke the contained functor unless slot is in blocking state.">operator()()</a>. The default <code>nil</code> means no argument.</li>
<li><em>T_arg5</em> Argument type used in the definition of <a class="el" href="classsigc_1_1slot5.html#a2c05f974b6c5c8b59b2a5259ace5e1c7" title="Invoke the contained functor unless slot is in blocking state.">operator()()</a>. The default <code>nil</code> means no argument.</li>
</ul>
<p>To use simply assign the slot to the desired functor. If the functor is not compatible with the parameter list defined with the template arguments compiler errors are triggered. When called the slot will invoke the functor with minimal copies. <a class="el" href="classsigc_1_1slot__base.html#a69042c2e2b0e5449fbf8203e862192a7" title="Sets the blocking state.">block()</a> and <a class="el" href="classsigc_1_1slot__base.html#ad93eaf25fae13186a1af8f699c6004a1" title="Unsets the blocking state.">unblock()</a> can be used to block the functor's invocation from <a class="el" href="classsigc_1_1slot5.html#a2c05f974b6c5c8b59b2a5259ace5e1c7" title="Invoke the contained functor unless slot is in blocking state.">operator()()</a> temporarily.</p>
<p>You should use the more convenient unnumbered <a class="el" href="classsigc_1_1slot.html" title="Convenience wrapper for the numbered sigc::slot# templates.">sigc::slot</a> template. </p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a2e67f263b100b6f542234dc37b3fe85f"></a><!-- doxytag: member="sigc::slot5::slot5" ref="a2e67f263b100b6f542234dc37b3fe85f" args="(const T_functor &_A_func)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template <class T_return , class T_arg1 , class T_arg2 , class T_arg3 , class T_arg4 , class T_arg5 > </div>
<div class="memtemplate">
template <class T_functor > </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classsigc_1_1slot5.html">sigc::slot5</a>< T_return, T_arg1, T_arg2, T_arg3, T_arg4, T_arg5 >::<a class="el" href="classsigc_1_1slot5.html">slot5</a> </td>
<td>(</td>
<td class="paramtype">const T_functor & </td>
<td class="paramname"> <em>_A_func</em> )</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructs a slot from an arbitrary functor. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">_A_func</td><td>The desired functor the new slot should be assigned to. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a2c05f974b6c5c8b59b2a5259ace5e1c7"></a><!-- doxytag: member="sigc::slot5::operator()" ref="a2c05f974b6c5c8b59b2a5259ace5e1c7" args="(arg1_type_ _A_a1, arg2_type_ _A_a2, arg3_type_ _A_a3, arg4_type_ _A_a4, arg5_type_ _A_a5) const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template <class T_return , class T_arg1 , class T_arg2 , class T_arg3 , class T_arg4 , class T_arg5 > </div>
<table class="memname">
<tr>
<td class="memname">T_return <a class="el" href="classsigc_1_1slot5.html">sigc::slot5</a>< T_return, T_arg1, T_arg2, T_arg3, T_arg4, T_arg5 >::operator() </td>
<td>(</td>
<td class="paramtype">arg1_type_ </td>
<td class="paramname"> <em>_A_a1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">arg2_type_ </td>
<td class="paramname"> <em>_A_a2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">arg3_type_ </td>
<td class="paramname"> <em>_A_a3</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">arg4_type_ </td>
<td class="paramname"> <em>_A_a4</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">arg5_type_ </td>
<td class="paramname"> <em>_A_a5</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Invoke the contained functor unless slot is in blocking state. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">_A_a1</td><td>Argument to be passed on to the functor. </td></tr>
<tr><td class="paramname">_A_a2</td><td>Argument to be passed on to the functor. </td></tr>
<tr><td class="paramname">_A_a3</td><td>Argument to be passed on to the functor. </td></tr>
<tr><td class="paramname">_A_a4</td><td>Argument to be passed on to the functor. </td></tr>
<tr><td class="paramname">_A_a5</td><td>Argument to be passed on to the functor. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The return value of the functor invocation. </dd></dl>
</div>
</div>
<a class="anchor" id="a24d22be7be827080b34109c625bad7fd"></a><!-- doxytag: member="sigc::slot5::operator=" ref="a24d22be7be827080b34109c625bad7fd" args="(const slot5 &src)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template <class T_return , class T_arg1 , class T_arg2 , class T_arg3 , class T_arg4 , class T_arg5 > </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classsigc_1_1slot5.html">slot5</a>& <a class="el" href="classsigc_1_1slot5.html">sigc::slot5</a>< T_return, T_arg1, T_arg2, T_arg3, T_arg4, T_arg5 >::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classsigc_1_1slot5.html">slot5</a>< T_return, T_arg1, T_arg2, T_arg3, T_arg4, T_arg5 >& </td>
<td class="paramname"> <em>src</em> )</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Overrides this slot making a copy from another slot. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">src</td><td>The slot from which to make a copy. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>this</code>. </dd></dl>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Tue Mar 8 2011 11:44:41 for libsigc++ by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.2 </small></address>
</body>
</html>
