Imported Upstream version 2.3.1

[platform/upstream/libsigc++.git] / docs / reference / html / structsigc_1_1connection.html

diff --git a/docs/reference/html/structsigc_1_1connection.html b/docs/reference/html/structsigc_1_1connection.html
index 6a13765..64a061f 100644 (file)
--- a/docs/reference/html/structsigc_1_1connection.html
+++ b/docs/reference/html/structsigc_1_1connection.html
@@ -17,7 +17,7 @@
  <tr style="height: 56px;">
   <td style="padding-left: 0.5em;">
    <div id="projectname">libsigc++
-   &#160;<span id="projectnumber">2.2.11</span>
+   &#160;<span id="projectnumber">2.3.1</span>
    </div>
   </td>
  </tr>
@@ -25,10 +25,11 @@
 </table>
 </div>
 <!-- end header part -->
-<!-- Generated by Doxygen 1.8.1.1 -->
+<!-- Generated by Doxygen 1.8.2 -->
   <div id="navrow1" class="tabs">
     <ul class="tablist">
       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
+      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
       <li><a href="modules.html"><span>Modules</span></a></li>
       <li><a href="namespaces.html"><span>Namespaces</span></a></li>
       <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
@@ -50,7 +51,8 @@
 <div class="header">
   <div class="summary">
 <a href="#pub-methods">Public Member Functions</a> &#124;
-<a href="#pub-static-methods">Static Public Member Functions</a> </div>
+<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
+<a href="structsigc_1_1connection-members.html">List of all members</a> </div>
   <div class="headertitle">
 <div class="title">sigc::connection Struct Reference<div class="ingroups"><a class="el" href="group__signal.html">Signals</a></div></div> </div>
 </div><!--header-->
@@ -59,51 +61,63 @@
 <p>Convinience class for safe disconnection.  <a href="structsigc_1_1connection.html#details">More...</a></p>
 
 <p><code>#include &lt;sigc++/connection.h&gt;</code></p>
-
-<p><a href="structsigc_1_1connection-members.html">List of all members.</a></p>
 <table class="memberdecls">
-<tr class="heading"><td colspan="2"><h2><a name="pub-methods"></a>
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
 Public Member Functions</h2></td></tr>
 <tr class="memitem:a9b74451c9a6a53bcc704a879f088cc7d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1connection.html#a9b74451c9a6a53bcc704a879f088cc7d">connection</a> ()</td></tr>
 <tr class="memdesc:a9b74451c9a6a53bcc704a879f088cc7d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs an empty connection object. <a href="#a9b74451c9a6a53bcc704a879f088cc7d"></a><br/></td></tr>
+<tr class="separator:a9b74451c9a6a53bcc704a879f088cc7d"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:ad13d5e3331cc9b1494e0edb8fa37fdba"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1connection.html#ad13d5e3331cc9b1494e0edb8fa37fdba">connection</a> (const <a class="el" href="structsigc_1_1connection.html">connection</a>&amp; c)</td></tr>
 <tr class="memdesc:ad13d5e3331cc9b1494e0edb8fa37fdba"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a connection object copying an existing one. <a href="#ad13d5e3331cc9b1494e0edb8fa37fdba"></a><br/></td></tr>
+<tr class="separator:ad13d5e3331cc9b1494e0edb8fa37fdba"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:ac8847ae94e0b05bed6c81f54f58deef3"><td class="memTemplParams" colspan="2">template&lt;typename T_slot &gt; </td></tr>
 <tr class="memitem:ac8847ae94e0b05bed6c81f54f58deef3"><td class="memTemplItemLeft" align="right" valign="top">&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structsigc_1_1connection.html#ac8847ae94e0b05bed6c81f54f58deef3">connection</a> (const <a class="el" href="structsigc_1_1slot__iterator.html">slot_iterator</a>&lt; T_slot &gt;&amp; it)</td></tr>
 <tr class="memdesc:ac8847ae94e0b05bed6c81f54f58deef3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a connection object from a slot list iterator. <a href="#ac8847ae94e0b05bed6c81f54f58deef3"></a><br/></td></tr>
+<tr class="separator:ac8847ae94e0b05bed6c81f54f58deef3"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a124709de26781e5ffcf8bbb5dcd621ed"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1connection.html#a124709de26781e5ffcf8bbb5dcd621ed">connection</a> (<a class="el" href="classsigc_1_1slot__base.html">slot_base</a>&amp; sl)</td></tr>
 <tr class="memdesc:a124709de26781e5ffcf8bbb5dcd621ed"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a connection object from a slot object. <a href="#a124709de26781e5ffcf8bbb5dcd621ed"></a><br/></td></tr>
+<tr class="separator:a124709de26781e5ffcf8bbb5dcd621ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a016094b53bafdc9ce593febb68cb00a5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structsigc_1_1connection.html">connection</a>&amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1connection.html#a016094b53bafdc9ce593febb68cb00a5">operator=</a> (const <a class="el" href="structsigc_1_1connection.html">connection</a>&amp; c)</td></tr>
 <tr class="memdesc:a016094b53bafdc9ce593febb68cb00a5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Overrides this connection object copying another one. <a href="#a016094b53bafdc9ce593febb68cb00a5"></a><br/></td></tr>
+<tr class="separator:a016094b53bafdc9ce593febb68cb00a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:adee4ffd4b1669b4726fd9afc36330c14"><td class="memTemplParams" colspan="2">template&lt;typename T_slot &gt; </td></tr>
 <tr class="memitem:adee4ffd4b1669b4726fd9afc36330c14"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="structsigc_1_1connection.html">connection</a>&amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structsigc_1_1connection.html#adee4ffd4b1669b4726fd9afc36330c14">operator=</a> (const <a class="el" href="structsigc_1_1slot__iterator.html">slot_iterator</a>&lt; T_slot &gt;&amp; it)</td></tr>
 <tr class="memdesc:adee4ffd4b1669b4726fd9afc36330c14"><td class="mdescLeft">&#160;</td><td class="mdescRight">Overrides this connection object with another slot list iterator. <a href="#adee4ffd4b1669b4726fd9afc36330c14"></a><br/></td></tr>
+<tr class="separator:adee4ffd4b1669b4726fd9afc36330c14"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a95ddcc6d1009adda4f2cc19cf246d2c7"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1connection.html#a95ddcc6d1009adda4f2cc19cf246d2c7">empty</a> () const </td></tr>
 <tr class="memdesc:a95ddcc6d1009adda4f2cc19cf246d2c7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns whether the connection is still active. <a href="#a95ddcc6d1009adda4f2cc19cf246d2c7"></a><br/></td></tr>
+<tr class="separator:a95ddcc6d1009adda4f2cc19cf246d2c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a86fcc7064a64aa15528d454b7f078225"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1connection.html#a86fcc7064a64aa15528d454b7f078225">connected</a> () const </td></tr>
 <tr class="memdesc:a86fcc7064a64aa15528d454b7f078225"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns whether the connection is still active. <a href="#a86fcc7064a64aa15528d454b7f078225"></a><br/></td></tr>
+<tr class="separator:a86fcc7064a64aa15528d454b7f078225"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a2c8ce2977a9e681d06c594ad90b41098"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1connection.html#a2c8ce2977a9e681d06c594ad90b41098">blocked</a> () const </td></tr>
 <tr class="memdesc:a2c8ce2977a9e681d06c594ad90b41098"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns whether the connection is blocked. <a href="#a2c8ce2977a9e681d06c594ad90b41098"></a><br/></td></tr>
+<tr class="separator:a2c8ce2977a9e681d06c594ad90b41098"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a6b09ee3010464b22abb3269935afcc49"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1connection.html#a6b09ee3010464b22abb3269935afcc49">block</a> (bool should_block=true)</td></tr>
 <tr class="memdesc:a6b09ee3010464b22abb3269935afcc49"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets or unsets the blocking state of this connection. <a href="#a6b09ee3010464b22abb3269935afcc49"></a><br/></td></tr>
+<tr class="separator:a6b09ee3010464b22abb3269935afcc49"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:aef87f355a73d50e8e54228a6fcbd1c6e"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1connection.html#aef87f355a73d50e8e54228a6fcbd1c6e">unblock</a> ()</td></tr>
 <tr class="memdesc:aef87f355a73d50e8e54228a6fcbd1c6e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unsets the blocking state of this connection. <a href="#aef87f355a73d50e8e54228a6fcbd1c6e"></a><br/></td></tr>
+<tr class="separator:aef87f355a73d50e8e54228a6fcbd1c6e"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a0452bd182a61650d14a9664d6297ed1b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0452bd182a61650d14a9664d6297ed1b"></a>
 void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1connection.html#a0452bd182a61650d14a9664d6297ed1b">disconnect</a> ()</td></tr>
 <tr class="memdesc:a0452bd182a61650d14a9664d6297ed1b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disconnects the referred slot. <br/></td></tr>
+<tr class="separator:a0452bd182a61650d14a9664d6297ed1b"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a67441b54b559cb1f84df9293dc0f5787"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1connection.html#a67441b54b559cb1f84df9293dc0f5787">operator bool</a> ()</td></tr>
 <tr class="memdesc:a67441b54b559cb1f84df9293dc0f5787"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns whether the connection is still active. <a href="#a67441b54b559cb1f84df9293dc0f5787"></a><br/></td></tr>
+<tr class="separator:a67441b54b559cb1f84df9293dc0f5787"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table><table class="memberdecls">
-<tr class="heading"><td colspan="2"><h2><a name="pub-static-methods"></a>
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
 Static Public Member Functions</h2></td></tr>
 <tr class="memitem:ad45fe90d68fe295e76e130b070e97070"><td class="memItemLeft" align="right" valign="top">static void*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1connection.html#ad45fe90d68fe295e76e130b070e97070">notify</a> (void* data)</td></tr>
 <tr class="memdesc:ad45fe90d68fe295e76e130b070e97070"><td class="mdescLeft">&#160;</td><td class="mdescRight">Callback that is executed when the referred slot is destroyed. <a href="#ad45fe90d68fe295e76e130b070e97070"></a><br/></td></tr>
+<tr class="separator:ad45fe90d68fe295e76e130b070e97070"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table>
-<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
+<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 <div class="textblock"><p>Convinience class for safe disconnection. </p>
 <p>Iterators must not be used beyond the lifetime of the list they work on. A connection object can be created from a slot list iterator and may safely be used to disconnect the referred slot at any time (<a class="el" href="structsigc_1_1connection.html#a0452bd182a61650d14a9664d6297ed1b" title="Disconnects the referred slot.">disconnect()</a>). If the slot has already been destroyed, <a class="el" href="structsigc_1_1connection.html#a0452bd182a61650d14a9664d6297ed1b" title="Disconnects the referred slot.">disconnect()</a> does nothing. <a class="el" href="structsigc_1_1connection.html#a95ddcc6d1009adda4f2cc19cf246d2c7" title="Returns whether the connection is still active.">empty()</a> or operator bool() can be used to test whether the connection is still active. The connection can be blocked (<a class="el" href="structsigc_1_1connection.html#a6b09ee3010464b22abb3269935afcc49" title="Sets or unsets the blocking state of this connection.">block()</a>, <a class="el" href="structsigc_1_1connection.html#aef87f355a73d50e8e54228a6fcbd1c6e" title="Unsets the blocking state of this connection.">unblock()</a>).</p>
 <p>This is possible because the connection object gets notified when the referred slot dies (<a class="el" href="structsigc_1_1connection.html#ad45fe90d68fe295e76e130b070e97070" title="Callback that is executed when the referred slot is destroyed.">notify()</a>). </p>
-</div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
+</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 <a class="anchor" id="a9b74451c9a6a53bcc704a879f088cc7d"></a>
 <div class="memitem">
 <div class="memproto">
@@ -136,7 +150,7 @@ Static Public Member Functions</h2></td></tr>
 </div><div class="memdoc">
 
 <p>Constructs a connection object copying an existing one. </p>
-<dl class="params"><dt>Parameters:</dt><dd>
+<dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
     <tr><td class="paramname">c</td><td>The connection object to make a copy from. </td></tr>
   </table>
@@ -170,7 +184,7 @@ template &lt;typename T_slot &gt; </div>
 </div><div class="memdoc">
 
 <p>Constructs a connection object from a slot list iterator. </p>
-<dl class="params"><dt>Parameters:</dt><dd>
+<dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
     <tr><td class="paramname">it</td><td>The slot list iterator to take the slot from. </td></tr>
   </table>
@@ -203,7 +217,7 @@ template &lt;typename T_slot &gt; </div>
 
 <p>Constructs a connection object from a slot object. </p>
 <p>This is only useful if you create your own slot list. </p>
-<dl class="params"><dt>Parameters:</dt><dd>
+<dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
     <tr><td class="paramname">sl</td><td>The slot to operate on. </td></tr>
   </table>
@@ -212,7 +226,7 @@ template &lt;typename T_slot &gt; </div>
 
 </div>
 </div>
-<hr/><h2>Member Function Documentation</h2>
+<h2 class="groupheader">Member Function Documentation</h2>
 <a class="anchor" id="a6b09ee3010464b22abb3269935afcc49"></a>
 <div class="memitem">
 <div class="memproto">
@@ -229,13 +243,13 @@ template &lt;typename T_slot &gt; </div>
 
 <p>Sets or unsets the blocking state of this connection. </p>
 <p>See <a class="el" href="classsigc_1_1slot__base.html#a69042c2e2b0e5449fbf8203e862192a7" title="Sets the blocking state.">slot_base::block()</a> for details. </p>
-<dl class="params"><dt>Parameters:</dt><dd>
+<dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
     <tr><td class="paramname">should_block</td><td>Indicates whether the blocking state should be set or unset. </td></tr>
   </table>
   </dd>
 </dl>
-<dl class="section return"><dt>Returns:</dt><dd><code>true</code> if the connection has been in blocking state before. </dd></dl>
+<dl class="section return"><dt>Returns</dt><dd><code>true</code> if the connection has been in blocking state before. </dd></dl>
 
 </div>
 </div>
@@ -253,7 +267,7 @@ template &lt;typename T_slot &gt; </div>
 </div><div class="memdoc">
 
 <p>Returns whether the connection is blocked. </p>
-<dl class="section return"><dt>Returns:</dt><dd><code>true</code> if the connection is blocked. </dd></dl>
+<dl class="section return"><dt>Returns</dt><dd><code>true</code> if the connection is blocked. </dd></dl>
 
 </div>
 </div>
@@ -271,7 +285,7 @@ template &lt;typename T_slot &gt; </div>
 </div><div class="memdoc">
 
 <p>Returns whether the connection is still active. </p>
-<dl class="section return"><dt>Returns:</dt><dd><code>true</code> if the connection is still active. </dd></dl>
+<dl class="section return"><dt>Returns</dt><dd><code>true</code> if the connection is still active. </dd></dl>
 
 </div>
 </div>
@@ -289,7 +303,7 @@ template &lt;typename T_slot &gt; </div>
 </div><div class="memdoc">
 
 <p>Returns whether the connection is still active. </p>
-<dl class="section return"><dt>Returns:</dt><dd><code>false</code> if the connection is still active. </dd></dl>
+<dl class="section return"><dt>Returns</dt><dd><code>false</code> if the connection is still active. </dd></dl>
 
 </div>
 </div>
@@ -316,7 +330,7 @@ template &lt;typename T_slot &gt; </div>
 </div><div class="memdoc">
 
 <p>Callback that is executed when the referred slot is destroyed. </p>
-<dl class="params"><dt>Parameters:</dt><dd>
+<dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
     <tr><td class="paramname">d</td><td>The connection object notified (<code>this</code>). </td></tr>
   </table>
@@ -339,7 +353,7 @@ template &lt;typename T_slot &gt; </div>
 </div><div class="memdoc">
 
 <p>Returns whether the connection is still active. </p>
-<dl class="section return"><dt>Returns:</dt><dd><code>true</code> if the connection is still active. </dd></dl>
+<dl class="section return"><dt>Returns</dt><dd><code>true</code> if the connection is still active. </dd></dl>
 
 </div>
 </div>
@@ -358,7 +372,7 @@ template &lt;typename T_slot &gt; </div>
 </div><div class="memdoc">
 
 <p>Overrides this connection object copying another one. </p>
-<dl class="params"><dt>Parameters:</dt><dd>
+<dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
     <tr><td class="paramname">c</td><td>The connection object to make a copy from. </td></tr>
   </table>
@@ -392,7 +406,7 @@ template &lt;typename T_slot &gt; </div>
 </div><div class="memdoc">
 
 <p>Overrides this connection object with another slot list iterator. </p>
-<dl class="params"><dt>Parameters:</dt><dd>
+<dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
     <tr><td class="paramname">it</td><td>The new slot list iterator to take the slot from. </td></tr>
   </table>
@@ -415,16 +429,16 @@ template &lt;typename T_slot &gt; </div>
 </div><div class="memdoc">
 
 <p>Unsets the blocking state of this connection. </p>
-<dl class="section return"><dt>Returns:</dt><dd><code>true</code> if the connection has been in blocking state before. </dd></dl>
+<dl class="section return"><dt>Returns</dt><dd><code>true</code> if the connection has been in blocking state before. </dd></dl>
 
 </div>
 </div>
 </div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>
-Generated by &#160;<a href="http://www.doxygen.org/index.html">
+Generated on Thu Oct 18 2012 09:28:24 for libsigc++ by &#160;<a href="http://www.doxygen.org/index.html">
 <img class="footer" src="doxygen.png" alt="doxygen"/>
-</a> 1.8.1.1
+</a> 1.8.2
 </small></address>
 </body>
 </html>