diff options
Diffstat (limited to 'doc/html/signal.html')
| -rw-r--r-- | doc/html/signal.html | 76 |
1 files changed, 76 insertions, 0 deletions
diff --git a/doc/html/signal.html b/doc/html/signal.html new file mode 100644 index 0000000000..45778f1c6b --- /dev/null +++ b/doc/html/signal.html @@ -0,0 +1,76 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title>Class template signal</title> +<link rel="stylesheet" href="boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.68.1"> +<link rel="start" href="index.html" title="The Boost C++ Libraries"> +<link rel="up" href="signals/reference.html#header.boost.signal.hpp" title="Header <boost/signal.hpp>"> +<link rel="prev" href="signalN.html" title="Class template signalN"> +<link rel="next" href="slot.html" title="Class template slot"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"> +<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../boost.png"></td> +<td align="center"><a href="../../index.htm">Home</a></td> +<td align="center"><a href="../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="../../people/people.htm">People</a></td> +<td align="center"><a href="../../more/faq.htm">FAQ</a></td> +<td align="center"><a href="../../more/index.htm">More</a></td> +</table> +<hr> +<div class="spirit-nav"> +<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> +</div> +<div class="refentry" lang="en"> +<a name="signal"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Class template signal</span></h2> +<p>boost::signal — Safe multicast callback.</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<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><<span class="bold"><strong>typename</strong></span> Signature, <span class="emphasis"><em> // Function type R (T1, T2, ..., TN)</em></span> + <span class="bold"><strong>typename</strong></span> Combiner = <a href="last_value.html" title="Class template last_value">last_value</a><R>, + <span class="bold"><strong>typename</strong></span> Group = <span class="bold"><strong>int</strong></span>, + <span class="bold"><strong>typename</strong></span> GroupCompare = std::less<Group>, + <span class="bold"><strong>typename</strong></span> SlotFunction = <a href="functionN.html" title="Class template functionN">functionN</a><Signature> > +<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><R, T1, T2, ..., TN, Combiner, Group, GroupCompare, SlotFunction> +{ +<span class="bold"><strong>public</strong></span>: + <span class="emphasis"><em>// <a href="signal.html#signalconstruct-copy-destruct">construct/copy/destruct</a></em></span> + <a href="signal.html#id726530-bb">signal</a>(<span class="bold"><strong>const</strong></span> combiner_type& = combiner_type(), + <span class="bold"><strong>const</strong></span> group_compare_type& = group_compare_type()); +};</pre></div> +<div class="refsect1" lang="en"> +<a name="id1284049"></a><h2>Description</h2> +<p>Class template <a href="signal.html" title="Class template signal">signal</a> is a thin + 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 + type with N arguments instead of N separate arguments, and + derives from the appropriate <a href="signalN.html" title="Class template signalN">signalN</a> + instantiation.</p> +<p>All functionality of this class template is in its base + class <a href="signalN.html" title="Class template signalN">signalN</a>.</p> +<div class="refsect2" lang="en"> +<a name="id1284094"></a><h3> +<a name="signalconstruct-copy-destruct"></a><code class="computeroutput">signal</code> construct/copy/destruct</h3> +<div class="orderedlist"><ol type="1"><li> +<pre class="literallayout"><a name="id726530-bb"></a>signal(<span class="bold"><strong>const</strong></span> combiner_type& combiner = combiner_type(), + <span class="bold"><strong>const</strong></span> group_compare_type& compare = group_compare_type());</pre> +<p><b xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"><span class="term">Effects</span></b>: + + Initializes the base class with the given combiner + and comparison objects.</p> +</li></ol></div> +</div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><small>Copyright © 2001-2004 Douglas Gregor</small></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<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> +</div> +</body> +</html> |