<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>scim: scim::Signal2< R, P1, P2, Marshal > Class Template Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.7.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="main.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>
<li><a href="files.html"><span>Files</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="a00157.html">scim</a>::<a class="el" href="a00078.html">Signal2</a>
</div>
</div>
<div class="contents">
<h1>scim::Signal2< R, P1, P2, Marshal > Class Template Reference<br>
<small>
[<a class="el" href="a00159.html">SignalSlot</a>]</small>
</h1><!-- doxytag: class="scim::Signal2" --><!-- doxytag: inherits="scim::Signal" -->A template for a signal passing two arguments of type P1 and P2, and returning a value of type R.
<a href="#_details">More...</a>
<p>
<code>#include <scim_signals.h></code>
<p>
<p>
<a href="a00277.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="a00098.html">Slot2</a>< R, P1, P2 > </td><td class="memItemRight" valign="bottom"><a class="el" href="a00078.html#01185a5326780fac64d67adb20555c66">SlotType</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Function signature for handlers connecting to the signal. <a href="#01185a5326780fac64d67adb20555c66"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00017.html">Connection</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00078.html#7665d4ae479f83b5fc6d9fe4e72ba60b">connect</a> (<a class="el" href="a00098.html">SlotType</a> *slot)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00098.html">SlotType</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00078.html#f6015cfa99726d9af43ad3299d398d85">slot</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">R </td><td class="memItemRight" valign="bottom"><a class="el" href="a00078.html#871336e6ed1020d6bdd2b8634a53e4dc">emit</a> (P1 p1, P2 p2)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">R </td><td class="memItemRight" valign="bottom"><a class="el" href="a00078.html#7a478f1748d67b9596d654f3b01008ce">operator()</a> (P1 p1, P2 p2)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Function operator; calls <a class="el" href="a00078.html#871336e6ed1020d6bdd2b8634a53e4dc">emit()</a>. <a href="#7a478f1748d67b9596d654f3b01008ce"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template<typename R, typename P1, typename P2, typename Marshal = class DefaultMarshal<R>><br>
class scim::Signal2< R, P1, P2, Marshal ></h3>
A template for a signal passing two arguments of type P1 and P2, and returning a value of type R. <hr><h2>Member Typedef Documentation</h2>
<a class="anchor" name="01185a5326780fac64d67adb20555c66"></a><!-- doxytag: member="scim::Signal2::SlotType" ref="01185a5326780fac64d67adb20555c66" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename R , typename P1 , typename P2 , typename Marshal = class DefaultMarshal<R>> </div>
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="a00098.html">Slot2</a><R, P1, P2> <a class="el" href="a00078.html">scim::Signal2</a>< R, P1, P2, Marshal >::<a class="el" href="a00098.html">SlotType</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Function signature for handlers connecting to the signal.
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="7665d4ae479f83b5fc6d9fe4e72ba60b"></a><!-- doxytag: member="scim::Signal2::connect" ref="7665d4ae479f83b5fc6d9fe4e72ba60b" args="(SlotType *slot)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename R , typename P1 , typename P2 , typename Marshal = class DefaultMarshal<R>> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00017.html">Connection</a> <a class="el" href="a00078.html">scim::Signal2</a>< R, P1, P2, Marshal >::connect </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00098.html">SlotType</a> * </td>
<td class="paramname"> <em>slot</em> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Connect a slot to the signal. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>slot</em> </td><td>- a slot of type Slot2<R, P1, P2>. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>a connection object.</dd></dl>
<br>
The returned connection object can be used alter or change the connection.
<p>Referenced by <a class="el" href="a00205.html#l00464">scim::Signal2< void, P1, P2, IgnoreMarshal >::connect()</a>.</p>
</div>
</div><p>
<a class="anchor" name="f6015cfa99726d9af43ad3299d398d85"></a><!-- doxytag: member="scim::Signal2::slot" ref="f6015cfa99726d9af43ad3299d398d85" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename R , typename P1 , typename P2 , typename Marshal = class DefaultMarshal<R>> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00098.html">SlotType</a>* <a class="el" href="a00078.html">scim::Signal2</a>< R, P1, P2, Marshal >::slot </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns a slot for this signal. <dl class="return" compact><dt><b>Returns:</b></dt><dd>a new slot of type Slot2<R, P1, P2>.</dd></dl>
<br>
The returned slot can be passed to another signal allowing the other signal to call this signal when it gets emitted.
<p>Referenced by <a class="el" href="a00205.html#l00474">scim::Signal2< void, P1, P2, IgnoreMarshal >::emit()</a>, and <a class="el" href="a00205.html#l00418">scim::Signal2< R, P1, P2, Marshal >::emit()</a>.</p>
</div>
</div><p>
<a class="anchor" name="871336e6ed1020d6bdd2b8634a53e4dc"></a><!-- doxytag: member="scim::Signal2::emit" ref="871336e6ed1020d6bdd2b8634a53e4dc" args="(P1 p1, P2 p2)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename R , typename P1 , typename P2 , typename Marshal = class DefaultMarshal<R>> </div>
<table class="memname">
<tr>
<td class="memname">R <a class="el" href="a00078.html">scim::Signal2</a>< R, P1, P2, Marshal >::emit </td>
<td>(</td>
<td class="paramtype">P1 </td>
<td class="paramname"> <em>p1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">P2 </td>
<td class="paramname"> <em>p2</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Emit the signal. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>p1</em> </td><td>- passes p1 to the signal handler. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>p2</em> </td><td>- passes p2 to the signal handler. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the value returned by the signal handler.</dd></dl>
<br>
Calls every slot connected to this signal, in order of connection.
<p>References <a class="el" href="a00098.html#1aeb51b15514976abf653ce327f38ccc">scim::Slot2< R, P1, P2 >::call()</a>, <a class="el" href="a00205.html#l00141">scim::Signal::connection_list</a>, and <a class="el" href="a00205.html#l00408">scim::Signal2< R, P1, P2, Marshal >::slot()</a>.</p>
<p>Referenced by <a class="el" href="a00205.html#l00488">scim::Signal2< void, P1, P2, IgnoreMarshal >::operator()()</a>, and <a class="el" href="a00205.html#l00441">scim::Signal2< R, P1, P2, Marshal >::operator()()</a>.</p>
</div>
</div><p>
<a class="anchor" name="7a478f1748d67b9596d654f3b01008ce"></a><!-- doxytag: member="scim::Signal2::operator()" ref="7a478f1748d67b9596d654f3b01008ce" args="(P1 p1, P2 p2)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename R , typename P1 , typename P2 , typename Marshal = class DefaultMarshal<R>> </div>
<table class="memname">
<tr>
<td class="memname">R <a class="el" href="a00078.html">scim::Signal2</a>< R, P1, P2, Marshal >::operator() </td>
<td>(</td>
<td class="paramtype">P1 </td>
<td class="paramname"> <em>p1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">P2 </td>
<td class="paramname"> <em>p2</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Function operator; calls <a class="el" href="a00078.html#871336e6ed1020d6bdd2b8634a53e4dc">emit()</a>.
<p>
<p>References <a class="el" href="a00205.html#l00418">scim::Signal2< R, P1, P2, Marshal >::emit()</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="a00149.html">scim_signals.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Sun Apr 19 13:02:43 2009 for scim by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.7.1 </small></address>
</body>
</html>
