Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: downloads/boost_1_34_1/doc/html/boost/signal.html @ 29

Last change on this file since 29 was 29, checked in by landauf, 17 years ago

updated boost from 1_33_1 to 1_34_1
File size: 5.4 KB
Line 
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
4<title>Class template signal</title>
5<link rel="stylesheet" href="../boostbook.css" type="text/css">
6<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
7<link rel="start" href="../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
8<link rel="up" href="../signals/reference.html#header.boost.signal.hpp" title="Header &lt;boost/signal.hpp&gt;">
9<link rel="prev" href="signalN.html" title="Class template signalN">
10<link rel="next" href="slot.html" title="Class template slot">
11</head>
12<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
13<table cellpadding="2" width="100%">
14<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../boost.png"></td>
15<td align="center"><a href="../../../index.htm">Home</a></td>
16<td align="center"><a href="../../../libs/libraries.htm">Libraries</a></td>
17<td align="center"><a href="../../../people/people.htm">People</a></td>
18<td align="center"><a href="../../../more/faq.htm">FAQ</a></td>
19<td align="center"><a href="../../../more/index.htm">More</a></td>
20</table>
21<hr>
22<div class="spirit-nav">
23<a accesskey="p" href="signalN.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../signals/reference.html#header.boost.signal.hpp"><img src="../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../images/home.png" alt="Home"></a><a accesskey="n" href="slot.html"><img src="../images/next.png" alt="Next"></a>
24</div>
25<div class="refentry" lang="en">
26<a name="boost.signal"></a><div class="titlepage"></div>
27<div class="refnamediv">
28<h2><span class="refentrytitle">Class template signal</span></h2>
29<p>boost::signal &#8212; Safe multicast callback.</p>
30</div>
31<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
32<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="bold"><strong>template</strong></span>&lt;<span class="bold"><strong>typename</strong></span> Signature, <span class="emphasis"><em>  // Function type R (T1, T2, ..., TN)</em></span>
33         <span class="bold"><strong>typename</strong></span> Combiner = <a href="last_value.html" title="Class template last_value">last_value</a>&lt;R&gt;,
34         <span class="bold"><strong>typename</strong></span> Group = <span class="bold"><strong>int</strong></span>,
35         <span class="bold"><strong>typename</strong></span> GroupCompare = std::less&lt;Group&gt;,
36         <span class="bold"><strong>typename</strong></span> SlotFunction = <a href="functionN.html" title="Class template functionN">functionN</a>&lt;Signature&gt; &gt; 
37<span class="bold"><strong>class</strong></span> signal : <span class="bold"><strong>public</strong></span> <a href="signalN.html" title="Class template signalN">signalN</a>&lt;R, T1, T2, ..., TN, Combiner, Group, GroupCompare, SlotFunction&gt;
38{
39<span class="bold"><strong>public</strong></span>:
40  <span class="emphasis"><em>// <a href="signal.html#boost.signalconstruct-copy-destruct">construct/copy/destruct</a></em></span>
41  <a href="signal.html#id1221349-bb">signal</a>(<span class="bold"><strong>const</strong></span> combiner_type&amp; = combiner_type(),
42         <span class="bold"><strong>const</strong></span> group_compare_type&amp; = group_compare_type());
43};</pre></div>
44<div class="refsect1" lang="en">
45<a name="id1630357"></a><h2>Description</h2>
46<p>Class template <a href="signal.html" title="Class template signal">signal</a> is a thin
47        wrapper around the numbered class templates <a href="signalN.html" title="Class template signalN">signal0</a>, <a href="signalN.html" title="Class template signalN">signal1</a>, etc. It accepts a function
48        type with N arguments instead of N separate arguments, and
49        derives from the appropriate <a href="signalN.html" title="Class template signalN">signalN</a>
50        instantiation.</p>
51<p>All functionality of this class template is in its base
52        class <a href="signalN.html" title="Class template signalN">signalN</a>.</p>
53<div class="refsect2" lang="en">
54<a name="id1630406"></a><h3>
55<a name="boost.signalconstruct-copy-destruct"></a><code class="computeroutput">signal</code> construct/copy/destruct</h3>
56<div class="orderedlist"><ol type="1"><li>
57<pre class="literallayout"><a name="id1221349-bb"></a>signal(<span class="bold"><strong>const</strong></span> combiner_type&amp; combiner = combiner_type(),
58       <span class="bold"><strong>const</strong></span> group_compare_type&amp; compare = group_compare_type());</pre>
59<div class="variablelist"><table border="0">
60<col align="left" valign="top">
61<tbody><tr>
62<td>
63<span class="term">Effects:</span></td>
64<td>Initializes the base class with the given combiner
65        and comparison objects.</td>
66</tr></tbody>
67</table></div>
68</li></ol></div>
69</div>
70</div>
71</div>
72<table width="100%"><tr>
73<td align="left"></td>
74<td align="right"><small>Copyright © 2001-2004 Douglas Gregor</small></td>
75</tr></table>
76<hr>
77<div class="spirit-nav">
78<a accesskey="p" href="signalN.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../signals/reference.html#header.boost.signal.hpp"><img src="../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../images/home.png" alt="Home"></a><a accesskey="n" href="slot.html"><img src="../images/next.png" alt="Next"></a>
79</div>
80</body>
81</html>
Note: See TracBrowser for help on using the repository browser.