<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <title>scim: scim::Signal1< R, P1, 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.0 --> <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 id="current"><a href="classes.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="classes.html"><span>Alphabetical List</span></a></li> <li><a href="annotated.html"><span>Class List</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="nav"> <a class="el" href="a00157.html">scim</a>::<a class="el" href="a00076.html">Signal1</a></div> <h1>scim::Signal1< R, P1, Marshal > Class Template Reference<br> <small> [<a class="el" href="a00159.html">SignalSlot</a>, <a class="el" href="a00159.html">SignalSlot</a>]</small> </h1><!-- doxytag: class="scim::Signal1" --><!-- doxytag: inherits="scim::Signal" -->A template for a signal passing one argument of type P1 and returning a value of type R. <a href="#_details">More...</a> <p> <code>#include <scim_signals.h></code> <p> Inheritance diagram for scim::Signal1< R, P1, Marshal >:<p><center><img src="a00446.png" border="0" usemap="#a00447" alt="Inheritance graph"></center> <map name="a00447"> <area href="a00073.html" shape="rect" coords="71,8,172,32" alt=""> </map> <center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for scim::Signal1< R, P1, Marshal >:<p><center><img src="a00448.png" border="0" usemap="#a00449" alt="Collaboration graph"></center> <map name="a00449"> <area href="a00073.html" shape="rect" coords="71,8,172,32" alt=""> </map> <center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center><a href="a00450.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="a00097.html">Slot1</a>< R, P1 > </td><td class="memItemRight" valign="bottom"><a class="el" href="a00076.html#f1fbe2a644016397c27fbdfa4c243d25">SlotType</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Function signature for handlers connecting to the signal. <a href="#f1fbe2a644016397c27fbdfa4c243d25"></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="a00076.html#92f26ef97bf8b31ae831f444b93be7c9">connect</a> (<a class="el" href="a00097.html">SlotType</a> *slot)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00097.html">SlotType</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00076.html#c8765a6852386553140d432b54bcf0c2">slot</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">R </td><td class="memItemRight" valign="bottom"><a class="el" href="a00076.html#6c0104eb6e4796e0477bdadd7a074f26">emit</a> (P1 p1)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">R </td><td class="memItemRight" valign="bottom"><a class="el" href="a00076.html#41b544d7892de5892c27994ceec783ee">operator()</a> (P1 p1)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Function operator; calls <a class="el" href="a00076.html#6c0104eb6e4796e0477bdadd7a074f26">emit()</a>. <a href="#41b544d7892de5892c27994ceec783ee"></a><br></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> <h3>template<typename R, typename P1, typename Marshal = class DefaultMarshal<R>><br> class scim::Signal1< R, P1, Marshal ></h3> A template for a signal passing one argument of type P1 and returning a value of type R. <p> <hr><h2>Member Typedef Documentation</h2> <a class="anchor" name="f1fbe2a644016397c27fbdfa4c243d25"></a><!-- doxytag: member="scim::Signal1::SlotType" ref="f1fbe2a644016397c27fbdfa4c243d25" args="" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename R, typename P1, typename Marshal = class DefaultMarshal<R>> </div> <table class="memname"> <tr> <td class="memname">typedef <a class="el" href="a00097.html">Slot1</a><R, P1> <a class="el" href="a00076.html">scim::Signal1</a>< R, P1, Marshal >::<a class="el" href="a00097.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="92f26ef97bf8b31ae831f444b93be7c9"></a><!-- doxytag: member="scim::Signal1::connect" ref="92f26ef97bf8b31ae831f444b93be7c9" args="(SlotType *slot)" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename R, typename P1, 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="a00076.html">scim::Signal1</a>< R, P1, Marshal >::connect </td> <td>(</td> <td class="paramtype"><a class="el" href="a00097.html">SlotType</a> * </td> <td class="paramname"> <em>slot</em> </td> <td> ) </td> <td width="100%"><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 Slot1<R, P1>. </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. </div> </div><p> <a class="anchor" name="c8765a6852386553140d432b54bcf0c2"></a><!-- doxytag: member="scim::Signal1::slot" ref="c8765a6852386553140d432b54bcf0c2" args="()" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename R, typename P1, typename Marshal = class DefaultMarshal<R>> </div> <table class="memname"> <tr> <td class="memname"><a class="el" href="a00097.html">SlotType</a>* <a class="el" href="a00076.html">scim::Signal1</a>< R, P1, Marshal >::slot </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"><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 Slot1<R, P1>.</dd></dl> <br> The returned slot can be passed to another signal allowing the other signal to call this signal when it gets emitted. </div> </div><p> <a class="anchor" name="6c0104eb6e4796e0477bdadd7a074f26"></a><!-- doxytag: member="scim::Signal1::emit" ref="6c0104eb6e4796e0477bdadd7a074f26" args="(P1 p1)" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename R, typename P1, typename Marshal = class DefaultMarshal<R>> </div> <table class="memname"> <tr> <td class="memname">R <a class="el" href="a00076.html">scim::Signal1</a>< R, P1, Marshal >::emit </td> <td>(</td> <td class="paramtype">P1 </td> <td class="paramname"> <em>p1</em> </td> <td> ) </td> <td width="100%"><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> </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. </div> </div><p> <a class="anchor" name="41b544d7892de5892c27994ceec783ee"></a><!-- doxytag: member="scim::Signal1::operator()" ref="41b544d7892de5892c27994ceec783ee" args="(P1 p1)" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename R, typename P1, typename Marshal = class DefaultMarshal<R>> </div> <table class="memname"> <tr> <td class="memname">R <a class="el" href="a00076.html">scim::Signal1</a>< R, P1, Marshal >::operator() </td> <td>(</td> <td class="paramtype">P1 </td> <td class="paramname"> <em>p1</em> </td> <td> ) </td> <td width="100%"><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Function operator; calls <a class="el" href="a00076.html#6c0104eb6e4796e0477bdadd7a074f26">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> <hr size="1"><address style="align: right;"><small>Generated on Thu Jun 28 14:12:42 2007 for scim by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.0 </small></address> </body> </html>