Sophie

Sophie

distrib > * > 2010.0 > * > by-pkgid > e30a327878e3ba1e4fc6c751cb1f95c0 > files > 140

libscim-devel-1.4.9-2mdv2010.0.i586.rpm

<!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::Signal3&lt; R, P1, P2, P3, Marshal &gt; 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&nbsp;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&nbsp;List</span></a></li>
      <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    </ul>
  </div>
  <div class="navpath"><a class="el" href="a00157.html">scim</a>::<a class="el" href="a00080.html">Signal3</a>
  </div>
</div>
<div class="contents">
<h1>scim::Signal3&lt; R, P1, P2, P3, Marshal &gt; Class Template Reference<br>
<small>
[<a class="el" href="a00159.html">SignalSlot</a>]</small>
</h1><!-- doxytag: class="scim::Signal3" --><!-- doxytag: inherits="scim::Signal" -->A template for a signal passing three arguments of type P1, P2 and P3, and returning a value of type R.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;scim_signals.h&gt;</code>
<p>

<p>
<a href="a00279.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="a00099.html">Slot3</a>&lt; R, P1, P2, P3 &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00080.html#dd8988c09cf3203284786e1f3aff8542">SlotType</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Function signature for handlers connecting to the signal.  <a href="#dd8988c09cf3203284786e1f3aff8542"></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>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00080.html#21cf7c6b18c9d1f8207d3605eeb6908a">connect</a> (<a class="el" href="a00099.html">SlotType</a> *slot)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00099.html">SlotType</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00080.html#1ca20b0631d940b09662f394f551995d">slot</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">R&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00080.html#96cd3cf066f0bfcc0f4ac0eef51101a9">emit</a> (P1 p1, P2 p2, P3 p3)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">R&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00080.html#1303426fb085fbf1a3fcfdae3a3ffac8">operator()</a> (P1 p1, P2 p2, P3 p3)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Function operator; calls <a class="el" href="a00080.html#96cd3cf066f0bfcc0f4ac0eef51101a9">emit()</a>.  <a href="#1303426fb085fbf1a3fcfdae3a3ffac8"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template&lt;typename R, typename P1, typename P2, typename P3, typename Marshal = class DefaultMarshal&lt;R&gt;&gt;<br>
 class scim::Signal3&lt; R, P1, P2, P3, Marshal &gt;</h3>

A template for a signal passing three arguments of type P1, P2 and P3, and returning a value of type R. <hr><h2>Member Typedef Documentation</h2>
<a class="anchor" name="dd8988c09cf3203284786e1f3aff8542"></a><!-- doxytag: member="scim::Signal3::SlotType" ref="dd8988c09cf3203284786e1f3aff8542" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename R , typename P1 , typename P2 , typename P3 , typename Marshal  = class DefaultMarshal&lt;R&gt;&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">typedef <a class="el" href="a00099.html">Slot3</a>&lt;R, P1, P2, P3&gt; <a class="el" href="a00080.html">scim::Signal3</a>&lt; R, P1, P2, P3, Marshal &gt;::<a class="el" href="a00099.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="21cf7c6b18c9d1f8207d3605eeb6908a"></a><!-- doxytag: member="scim::Signal3::connect" ref="21cf7c6b18c9d1f8207d3605eeb6908a" args="(SlotType *slot)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename R , typename P1 , typename P2 , typename P3 , typename Marshal  = class DefaultMarshal&lt;R&gt;&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00017.html">Connection</a> <a class="el" href="a00080.html">scim::Signal3</a>&lt; R, P1, P2, P3, Marshal &gt;::connect           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00099.html">SlotType</a> *&nbsp;</td>
          <td class="paramname"> <em>slot</em>          </td>
          <td>&nbsp;)&nbsp;</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>&nbsp;</td><td>- a slot of type Slot3&lt;R, P1, P2, P3&gt;. </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#l00580">scim::Signal3&lt; void, P1, P2, P3, IgnoreMarshal &gt;::connect()</a>.</p>

</div>
</div><p>
<a class="anchor" name="1ca20b0631d940b09662f394f551995d"></a><!-- doxytag: member="scim::Signal3::slot" ref="1ca20b0631d940b09662f394f551995d" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename R , typename P1 , typename P2 , typename P3 , typename Marshal  = class DefaultMarshal&lt;R&gt;&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00099.html">SlotType</a>* <a class="el" href="a00080.html">scim::Signal3</a>&lt; R, P1, P2, P3, Marshal &gt;::slot           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</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 Slot3&lt;R, P1, P2, P3&gt;.</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#l00590">scim::Signal3&lt; void, P1, P2, P3, IgnoreMarshal &gt;::emit()</a>, and <a class="el" href="a00205.html#l00533">scim::Signal3&lt; R, P1, P2, P3, Marshal &gt;::emit()</a>.</p>

</div>
</div><p>
<a class="anchor" name="96cd3cf066f0bfcc0f4ac0eef51101a9"></a><!-- doxytag: member="scim::Signal3::emit" ref="96cd3cf066f0bfcc0f4ac0eef51101a9" args="(P1 p1, P2 p2, P3 p3)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename R , typename P1 , typename P2 , typename P3 , typename Marshal  = class DefaultMarshal&lt;R&gt;&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">R <a class="el" href="a00080.html">scim::Signal3</a>&lt; R, P1, P2, P3, Marshal &gt;::emit           </td>
          <td>(</td>
          <td class="paramtype">P1&nbsp;</td>
          <td class="paramname"> <em>p1</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">P2&nbsp;</td>
          <td class="paramname"> <em>p2</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">P3&nbsp;</td>
          <td class="paramname"> <em>p3</em></td><td>&nbsp;</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>&nbsp;</td><td>- passes p1 to the signal handler. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>p2</em>&nbsp;</td><td>- passes p2 to the signal handler. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>p3</em>&nbsp;</td><td>- passes p3 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="a00099.html#4a6aae9883ea1840cfcabcba72d68f75">scim::Slot3&lt; R, P1, P2, P3 &gt;::call()</a>, <a class="el" href="a00205.html#l00141">scim::Signal::connection_list</a>, and <a class="el" href="a00205.html#l00523">scim::Signal3&lt; R, P1, P2, P3, Marshal &gt;::slot()</a>.</p>

<p>Referenced by <a class="el" href="a00205.html#l00604">scim::Signal3&lt; void, P1, P2, P3, IgnoreMarshal &gt;::operator()()</a>, and <a class="el" href="a00205.html#l00557">scim::Signal3&lt; R, P1, P2, P3, Marshal &gt;::operator()()</a>.</p>

</div>
</div><p>
<a class="anchor" name="1303426fb085fbf1a3fcfdae3a3ffac8"></a><!-- doxytag: member="scim::Signal3::operator()" ref="1303426fb085fbf1a3fcfdae3a3ffac8" args="(P1 p1, P2 p2, P3 p3)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename R , typename P1 , typename P2 , typename P3 , typename Marshal  = class DefaultMarshal&lt;R&gt;&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">R <a class="el" href="a00080.html">scim::Signal3</a>&lt; R, P1, P2, P3, Marshal &gt;::operator()           </td>
          <td>(</td>
          <td class="paramtype">P1&nbsp;</td>
          <td class="paramname"> <em>p1</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">P2&nbsp;</td>
          <td class="paramname"> <em>p2</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">P3&nbsp;</td>
          <td class="paramname"> <em>p3</em></td><td>&nbsp;</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="a00080.html#96cd3cf066f0bfcc0f4ac0eef51101a9">emit()</a>. 
<p>

<p>References <a class="el" href="a00205.html#l00533">scim::Signal3&lt; R, P1, P2, P3, Marshal &gt;::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&nbsp;
<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>