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
|
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE header PUBLIC "-//Boost//DTD BoostBook XML V1.0//EN"
"http://www.boost.org/tools/boostbook/dtd/boostbook.dtd">
<header name="boost/signals/connection.hpp" last-revision="$Date: 2003/04/02 04:34:42 $">
<namespace name="boost">
<namespace name="signals">
<class name="connection">
<!-- Models LessThanComparable and EqualityComparable -->
<purpose>Query/disconnect a signal-slot connection.</purpose>
<description>
<para>The <classname>connection</classname> class represents
a connection between a Signal and a Slot. It is a
lightweight object that has the ability to query whether the
signal and slot are currently connected, and to disconnect
the signal and slot. It is always safe to query or
disconnect a connection.</para>
</description>
<constructor>
<effects><para>Sets the currently represented connection to the
NULL connection.</para></effects>
<postconditions><para><computeroutput>!this-><methodname>connected</methodname>()</computeroutput>.</para></postconditions>
<throws><para>Will not throw.</para></throws>
</constructor>
<constructor>
<parameter name="other">
<paramtype>const <classname>connection</classname>&</paramtype>
</parameter>
<effects><para><computeroutput>this</computeroutput> references
the connection referenced by
<computeroutput>other</computeroutput>.</para></effects>
<throws><para>Will not throw.</para></throws>
</constructor>
<copy-assignment>
<parameter name="other">
<paramtype>const <classname>connection</classname>&</paramtype>
</parameter>
<effects><para><computeroutput>this</computeroutput> references
the connection referenced by
<computeroutput>other</computeroutput>.</para></effects>
<throws><para>Will not throw.</para></throws>
</copy-assignment>
<method-group name="connection management">
<method name="disconnect" cv="const">
<type>void</type>
<effects><para>If
<computeroutput>this-><methodname>connected</methodname>()</computeroutput>,
disconnects the signal and slot referenced by this;
otherwise, this operation is a no-op.</para></effects>
<postconditions><para><computeroutput>!this-><methodname>connected</methodname>()</computeroutput>.</para></postconditions>
</method>
<method name="connected" cv="const">
<type>bool</type>
<returns><para><computeroutput>true</computeroutput> if this
references a non-NULL connection that is still active
(connected), and <computeroutput>false</computeroutput>
otherwise.</para></returns>
<throws><para>Will not throw.</para></throws>
</method>
</method-group>
<method-group name="modifiers">
<method name="swap">
<type>void</type>
<parameter name="other">
<paramtype>const <classname>connection</classname>&</paramtype>
</parameter>
<effects><para>Swaps the connections referenced in
<computeroutput>this</computeroutput> and
<computeroutput>other</computeroutput>.</para></effects>
<throws><para>Will not throw.</para></throws>
</method>
</method-group>
<method-group name="comparisons">
<method name="operator==" cv="const">
<type>bool</type>
<parameter name="other">
<paramtype>const <classname>connection</classname>&</paramtype>
</parameter>
<returns><para><computeroutput>true</computeroutput> if
<computeroutput>this</computeroutput> and
<computeroutput>other</computeroutput> reference the same
connection or both reference the NULL connection, and
<computeroutput>false</computeroutput>
otherwise.</para></returns>
<throws><para>Will not throw.</para></throws>
</method>
<method name="operator<" cv="const">
<type>bool</type>
<parameter name="other">
<paramtype>const <classname>connection</classname>&</paramtype>
</parameter>
<returns><para><computeroutput>true</computeroutput> if the
connection referenced by
<computeroutput>this</computeroutput> precedes the
connection referenced by
<computeroutput>other</computeroutput> based on some
unspecified ordering, and
<computeroutput>false</computeroutput>
otherwise.</para></returns>
<throws><para>Will not throw.</para></throws>
</method>
</method-group>
<free-function-group name="specialized algorithms">
<function name="swap">
<type>void</type>
<parameter name="x">
<paramtype><classname>connection</classname>&</paramtype>
</parameter>
<parameter name="y">
<paramtype><classname>connection</classname>&</paramtype>
</parameter>
<effects><para><computeroutput>x.swap(y)</computeroutput></para></effects>
<throws><para>Will not throw.</para></throws>
</function>
</free-function-group>
</class>
<class name="scoped_connection">
<inherit access="private">
<type><classname>noncopyable</classname></type>
<purpose>Exposition only</purpose>
</inherit>
<purpose>Limits a signal-slot connection lifetime to a particular scope.</purpose>
<constructor>
<parameter name="other">
<paramtype>const <classname>connection</classname>&</paramtype>
</parameter>
<effects><para><computeroutput>this</computeroutput> references
the connection referenced by
<computeroutput>other</computeroutput>.</para></effects>
<throws><para>Will not throw.</para></throws>
</constructor>
<destructor>
<effects><para>If
<computeroutput>this-><methodname>connected</methodname>()</computeroutput>,
disconnects the signal-slot connection.</para></effects>
</destructor>
<method-group name="connection management">
<method name="disconnect" cv="const">
<type>void</type>
<effects><para>If
<computeroutput>this-><methodname>connected</methodname>()</computeroutput>,
disconnects the signal and slot referenced by this;
otherwise, this operation is a no-op.</para></effects>
<postconditions><para><computeroutput>!this-><methodname>connected</methodname>()</computeroutput>.</para></postconditions>
</method>
<method name="connected" cv="const">
<type>bool</type>
<returns><para><computeroutput>true</computeroutput> if this
references a non-NULL connection that is still active
(connected), and <computeroutput>false</computeroutput>
otherwise.</para></returns>
<throws><para>Will not throw.</para></throws>
</method>
</method-group>
</class>
</namespace>
</namespace>
</header>
|
