1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189
|
<!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::Signal0< R, 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="a00074.html">Signal0</a></div>
<h1>scim::Signal0< R, 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::Signal0" --><!-- doxytag: inherits="scim::Signal" -->A template for a signal passing no arguments and returning a value of type R.
<a href="#_details">More...</a>
<p>
<code>#include <scim_signals.h></code>
<p>
Inheritance diagram for scim::Signal0< R, Marshal >:<p><center><img src="a00436.png" border="0" usemap="#a00437" alt="Inheritance graph"></center>
<map name="a00437">
<area href="a00073.html" shape="rect" coords="57,8,159,32" alt="">
</map>
<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for scim::Signal0< R, Marshal >:<p><center><img src="a00438.png" border="0" usemap="#a00439" alt="Collaboration graph"></center>
<map name="a00439">
<area href="a00073.html" shape="rect" coords="57,8,159,32" alt="">
</map>
<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center><a href="a00440.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="a00096.html">Slot0</a>< R > </td><td class="memItemRight" valign="bottom"><a class="el" href="a00074.html#0c6e5a07c566eedbdde7aaee90608e91">SlotType</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Function signature for handlers connecting the signal. <a href="#0c6e5a07c566eedbdde7aaee90608e91"></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="a00074.html#23ccda2933027f1ca3c2ab973d2d6c3b">connect</a> (<a class="el" href="a00096.html">SlotType</a> *slot)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00096.html">SlotType</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00074.html#de7924b322435b4acee94d21cbc3afc2">slot</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">R </td><td class="memItemRight" valign="bottom"><a class="el" href="a00074.html#5b556dd39a108555fc10fdbea59465ce">emit</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">R </td><td class="memItemRight" valign="bottom"><a class="el" href="a00074.html#41d4c1a2ed010dd1580172076a361c2e">operator()</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Function operator; calls <a class="el" href="a00074.html#5b556dd39a108555fc10fdbea59465ce">emit()</a>. <a href="#41d4c1a2ed010dd1580172076a361c2e"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template<typename R, typename Marshal = class DefaultMarshal<R>><br>
class scim::Signal0< R, Marshal ></h3>
A template for a signal passing no arguments and returning a value of type R.
<p>
<hr><h2>Member Typedef Documentation</h2>
<a class="anchor" name="0c6e5a07c566eedbdde7aaee90608e91"></a><!-- doxytag: member="scim::Signal0::SlotType" ref="0c6e5a07c566eedbdde7aaee90608e91" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename R, typename Marshal = class DefaultMarshal<R>> </div>
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="a00096.html">Slot0</a><R> <a class="el" href="a00074.html">scim::Signal0</a>< R, Marshal >::<a class="el" href="a00096.html">SlotType</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Function signature for handlers connecting the signal.
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="23ccda2933027f1ca3c2ab973d2d6c3b"></a><!-- doxytag: member="scim::Signal0::connect" ref="23ccda2933027f1ca3c2ab973d2d6c3b" args="(SlotType *slot)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename R, 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="a00074.html">scim::Signal0</a>< R, Marshal >::connect </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00096.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 Slot0<R>. </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="de7924b322435b4acee94d21cbc3afc2"></a><!-- doxytag: member="scim::Signal0::slot" ref="de7924b322435b4acee94d21cbc3afc2" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename R, typename Marshal = class DefaultMarshal<R>> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00096.html">SlotType</a>* <a class="el" href="a00074.html">scim::Signal0</a>< R, 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 Slot0<R>.</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="5b556dd39a108555fc10fdbea59465ce"></a><!-- doxytag: member="scim::Signal0::emit" ref="5b556dd39a108555fc10fdbea59465ce" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename R, typename Marshal = class DefaultMarshal<R>> </div>
<table class="memname">
<tr>
<td class="memname">R <a class="el" href="a00074.html">scim::Signal0</a>< R, Marshal >::emit </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Emit the signal. <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="41d4c1a2ed010dd1580172076a361c2e"></a><!-- doxytag: member="scim::Signal0::operator()" ref="41d4c1a2ed010dd1580172076a361c2e" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename R, typename Marshal = class DefaultMarshal<R>> </div>
<table class="memname">
<tr>
<td class="memname">R <a class="el" href="a00074.html">scim::Signal0</a>< R, Marshal >::operator() </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Function operator; calls <a class="el" href="a00074.html#5b556dd39a108555fc10fdbea59465ce">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:41 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>
|