]>
Commit | Line | Data |
---|---|---|
7c673cae FG |
1 | <?xml version="1.0" encoding="utf-8"?> |
2 | <!DOCTYPE header PUBLIC "-//Boost//DTD BoostBook XML V1.0//EN" | |
3 | "http://www.boost.org/tools/boostbook/dtd/boostbook.dtd"> | |
4 | <!-- | |
5 | Copyright Frank Mori Hess 2007-2009 | |
6 | ||
7 | Distributed under the Boost Software License, Version 1.0. (See accompanying | |
8 | file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) | |
9 | --> | |
10 | <header name="boost/signals2/slot_base.hpp" last-revision="$Date: 2007-03-06 16:51:55 -0500 (Tue, 06 Mar 2007) $"> | |
11 | <using-namespace name="boost::signals2"/> | |
12 | <using-namespace name="boost"/> | |
13 | <namespace name="boost"> | |
14 | <namespace name="signals2"> | |
15 | <class name="slot_base"> | |
16 | <purpose>Base class for slots.</purpose> | |
17 | ||
18 | <description> | |
19 | <para></para> | |
20 | </description> | |
21 | ||
22 | <typedef name="locked_container_type"> | |
23 | <type>std::vector<<emphasis>implementation-detail</emphasis>></type> | |
24 | </typedef> | |
25 | ||
26 | <method-group name="tracking"> | |
27 | <method name = "expired" cv="const"> | |
28 | <type>bool</type> | |
29 | <returns><para><code>true</code> if any tracked object has expired.</para></returns> | |
30 | </method> | |
31 | <method name = "lock" cv="const"> | |
32 | <type>locked_container_type</type> | |
33 | <returns>A container holding <code>shared_ptr</code>s to each of the slot's tracked objects. As long | |
34 | as the returned container is kept in scope, none of the slot's tracked objects can expire.</returns> | |
35 | <throws><classname>expired_slot</classname> if any of the slot's tracked objects have expired.</throws> | |
36 | </method> | |
37 | </method-group> | |
38 | </class> | |
39 | <class name="expired_slot"> | |
40 | <inherit access="public"><classname>bad_weak_ptr</classname></inherit> | |
41 | <purpose>Indicates at least one of a slot's tracked objects has expired.</purpose> | |
42 | <description>The <code>expired_slot</code> exception is thrown to indicate at least one of | |
43 | a slot's tracked objects has expired. | |
44 | </description> | |
45 | <method name="what" cv="const" specifiers="virtual"> | |
46 | <type>const char * </type> | |
47 | </method> | |
48 | </class> | |
49 | </namespace> | |
50 | </namespace> | |
51 | </header> |