/usr/share/doc/properties-cpp/html/classcore_1_1Signal.html is in libproperties-cpp-doc 0.0.1+14.10.20140730-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.7"/>
<title>properties-cpp: core::Signal< Arguments > Class Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">properties-cpp
 <span id="projectnumber">0.0.1</span>
</div>
<div id="projectbrief">A very simple convenience library for handling properties and signals in C++11.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.7 -->
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classcore_1_1Signal.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="classcore_1_1Signal-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">core::Signal< Arguments > Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A signal class that observers can subscribe to.
<a href="classcore_1_1Signal.html#details">More...</a></p>
<p><code>#include <<a class="el" href="signal_8h_source.html">signal.h</a>></code></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Collaboration diagram for core::Signal< Arguments >:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classcore_1_1Signal__coll__graph.png" border="0" usemap="#core_1_1Signal_3_01Arguments_01_4_coll__map" alt="Collaboration graph"/></div>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a689a758a900edf115d984b494f1862f9"><td class="memItemLeft" align="right" valign="top">typedef std::function< void(Arguments...)> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1Signal.html#a689a758a900edf115d984b494f1862f9">Slot</a></td></tr>
<tr class="memdesc:a689a758a900edf115d984b494f1862f9"><td class="mdescLeft"> </td><td class="mdescRight">Slot is the function type that observers have to provide to connect to this signal. <a href="#a689a758a900edf115d984b494f1862f9">More...</a><br /></td></tr>
<tr class="separator:a689a758a900edf115d984b494f1862f9"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ae8cdfa83633ce3cad9ae6fc49fb876bd"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1Signal.html#ae8cdfa83633ce3cad9ae6fc49fb876bd">Signal</a> () noexcept(true)</td></tr>
<tr class="memdesc:ae8cdfa83633ce3cad9ae6fc49fb876bd"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classcore_1_1Signal.html" title="A signal class that observers can subscribe to. ">Signal</a> constructs a new instance. Never throws. <a href="#ae8cdfa83633ce3cad9ae6fc49fb876bd">More...</a><br /></td></tr>
<tr class="separator:ae8cdfa83633ce3cad9ae6fc49fb876bd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9c321c7345617cb48786aea00fbe0ea8"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1Signal.html#a9c321c7345617cb48786aea00fbe0ea8">~Signal</a> ()</td></tr>
<tr class="separator:a9c321c7345617cb48786aea00fbe0ea8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0b3459313dca129e0e2d64b6dacb7063"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1Signal.html#a0b3459313dca129e0e2d64b6dacb7063">Signal</a> (const <a class="el" href="classcore_1_1Signal.html">Signal</a> &)=delete</td></tr>
<tr class="separator:a0b3459313dca129e0e2d64b6dacb7063"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac0326bc0eadc52c597bd5c405a5cdafe"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classcore_1_1Signal.html">Signal</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1Signal.html#ac0326bc0eadc52c597bd5c405a5cdafe">operator=</a> (const <a class="el" href="classcore_1_1Signal.html">Signal</a> &)=delete</td></tr>
<tr class="separator:ac0326bc0eadc52c597bd5c405a5cdafe"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6acfe400a299ce8277630a2b4bd00539"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1Signal.html#a6acfe400a299ce8277630a2b4bd00539">operator==</a> (const <a class="el" href="classcore_1_1Signal.html">Signal</a> &) const =delete</td></tr>
<tr class="separator:a6acfe400a299ce8277630a2b4bd00539"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0f982cab5160c5dedbbb13315f9d715a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classcore_1_1Connection.html">Connection</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1Signal.html#a0f982cab5160c5dedbbb13315f9d715a">connect</a> (const <a class="el" href="classcore_1_1Signal.html#a689a758a900edf115d984b494f1862f9">Slot</a> &slot) const </td></tr>
<tr class="memdesc:a0f982cab5160c5dedbbb13315f9d715a"><td class="mdescLeft"> </td><td class="mdescRight">Connects the provided slot to this signal instance. <a href="#a0f982cab5160c5dedbbb13315f9d715a">More...</a><br /></td></tr>
<tr class="separator:a0f982cab5160c5dedbbb13315f9d715a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aae0b7ab936c8c89656a2a5a50fddc229"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcore_1_1Signal.html#aae0b7ab936c8c89656a2a5a50fddc229">operator()</a> (Arguments...args)</td></tr>
<tr class="memdesc:aae0b7ab936c8c89656a2a5a50fddc229"><td class="mdescLeft"> </td><td class="mdescRight">operator () emits the signal with the provided parameters. <a href="#aae0b7ab936c8c89656a2a5a50fddc229">More...</a><br /></td></tr>
<tr class="separator:aae0b7ab936c8c89656a2a5a50fddc229"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template<typename... Arguments><br />
class core::Signal< Arguments ></h3>
<p>A signal class that observers can subscribe to. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Arguments</td><td>List of argument types passed on to observers when the signal is emitted. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="signal_8h_source.html#l00036">36</a> of file <a class="el" href="signal_8h_source.html">signal.h</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a class="anchor" id="a689a758a900edf115d984b494f1862f9"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename... Arguments> </div>
<table class="memname">
<tr>
<td class="memname">typedef std::function<void(Arguments...)> <a class="el" href="classcore_1_1Signal.html">core::Signal</a>< Arguments >::<a class="el" href="classcore_1_1Signal.html#a689a758a900edf115d984b494f1862f9">Slot</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Slot is the function type that observers have to provide to connect to this signal. </p>
<p>Definition at line <a class="el" href="signal_8h_source.html#l00042">42</a> of file <a class="el" href="signal_8h_source.html">signal.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="ae8cdfa83633ce3cad9ae6fc49fb876bd"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename... Arguments> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classcore_1_1Signal.html">core::Signal</a>< Arguments >::<a class="el" href="classcore_1_1Signal.html">Signal</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="classcore_1_1Signal.html" title="A signal class that observers can subscribe to. ">Signal</a> constructs a new instance. Never throws. </p>
<p>Definition at line <a class="el" href="signal_8h_source.html#l00061">61</a> of file <a class="el" href="signal_8h_source.html">signal.h</a>.</p>
</div>
</div>
<a class="anchor" id="a9c321c7345617cb48786aea00fbe0ea8"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename... Arguments> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classcore_1_1Signal.html">core::Signal</a>< Arguments >::~<a class="el" href="classcore_1_1Signal.html">Signal</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="signal_8h_source.html#l00065">65</a> of file <a class="el" href="signal_8h_source.html">signal.h</a>.</p>
</div>
</div>
<a class="anchor" id="a0b3459313dca129e0e2d64b6dacb7063"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename... Arguments> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classcore_1_1Signal.html">core::Signal</a>< Arguments >::<a class="el" href="classcore_1_1Signal.html">Signal</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classcore_1_1Signal.html">Signal</a>< Arguments > & </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a0f982cab5160c5dedbbb13315f9d715a"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename... Arguments> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classcore_1_1Connection.html">Connection</a> <a class="el" href="classcore_1_1Signal.html">core::Signal</a>< Arguments >::connect </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classcore_1_1Signal.html#a689a758a900edf115d984b494f1862f9">Slot</a> & </td>
<td class="paramname"><em>slot</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Connects the provided slot to this signal instance. </p>
<p>Calling this method is thread-safe and synchronized with any other connect, signal emission or disconnect calls.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">slot</td><td>The function to be called when the signal is emitted. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A connection object corresponding to the signal-slot connection. </dd></dl>
<p>Definition at line <a class="el" href="signal_8h_source.html#l00086">86</a> of file <a class="el" href="signal_8h_source.html">signal.h</a>.</p>
<p>Referenced by <a class="el" href="signals__test_8cpp_source.html#l00048">TEST()</a>.</p>
</div>
</div>
<a class="anchor" id="aae0b7ab936c8c89656a2a5a50fddc229"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename... Arguments> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classcore_1_1Signal.html">core::Signal</a>< Arguments >::operator() </td>
<td>(</td>
<td class="paramtype">Arguments... </td>
<td class="paramname"><em>args</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>operator () emits the signal with the provided parameters. </p>
<p>Please note that signal emissions might not be delivered immediately to registered slots, depending on whether the respective connection is dispatched via a queueing dispatcher. For that reason, the lifetime of the arguments has to exceed the scope of the call to this operator and its surrounding scope.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">args</td><td>The arguments to be passed on to registered slots. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="signal_8h_source.html#l00132">132</a> of file <a class="el" href="signal_8h_source.html">signal.h</a>.</p>
</div>
</div>
<a class="anchor" id="ac0326bc0eadc52c597bd5c405a5cdafe"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename... Arguments> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classcore_1_1Signal.html">Signal</a>& <a class="el" href="classcore_1_1Signal.html">core::Signal</a>< Arguments >::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classcore_1_1Signal.html">Signal</a>< Arguments > & </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a6acfe400a299ce8277630a2b4bd00539"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename... Arguments> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classcore_1_1Signal.html">core::Signal</a>< Arguments >::operator== </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classcore_1_1Signal.html">Signal</a>< Arguments > & </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>/build/buildd/properties-cpp-0.0.1+14.10.20140730/include/core/<a class="el" href="signal_8h_source.html">signal.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespacecore.html">core</a></li><li class="navelem"><a class="el" href="classcore_1_1Signal.html">Signal</a></li>
<li class="footer">Generated on Wed Jul 30 2014 15:14:22 for properties-cpp by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.7 </li>
</ul>
</div>
</body>
</html>
|