openkylin
/
libsigcplusplus
mirror of https://gitee.com/openkylin/libsigcplusplus.git
9
0
Fork 0
Code Issues Projects Releases Wiki Activity
libsigcplusplus/docs/reference/html/classsigc_1_1slot__base.html

649 lines
37 KiB
HTML
Raw Blame History

<!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.11"/>
<title>libsigc++: sigc::slot_base Class 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="doxygen.css" rel="stylesheet" type="text/css" />
<link href="doxygen-extra.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 id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">libsigc++
&#160;<span id="projectnumber">2.10.3</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<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>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacesigc.html">sigc</a></li><li class="navelem"><a class="el" href="classsigc_1_1slot__base.html">slot_base</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="classsigc_1_1slot__base-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">sigc::slot_base Class Reference<div class="ingroups"><a class="el" href="group__sigcfunctors.html">Functors</a> &raquo; <a class="el" href="group__slot.html">Slots</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Base type for slots.
<a href="classsigc_1_1slot__base.html#details">More...</a></p>
<p><code>#include &lt;sigc++/functors/slot_base.h&gt;</code></p>
<div class="dynheader">
Inheritance diagram for sigc::slot_base:</div>
<div class="dyncontent">
<div class="center"><img src="classsigc_1_1slot__base__inherit__graph.png" border="0" usemap="#sigc_1_1slot__base_inherit__map" alt="Inheritance graph"/></div>
<map name="sigc_1_1slot__base_inherit__map" id="sigc_1_1slot__base_inherit__map">
<area shape="rect" id="node3" href="classsigc_1_1slot0.html" title="Converts an arbitrary functor to a unified type which is opaque. " alt="" coords="369,31,541,57"/>
<area shape="rect" id="node5" href="classsigc_1_1slot1.html" title="Converts an arbitrary functor to a unified type which is opaque. " alt="" coords="374,99,535,141"/>
<area shape="rect" id="node7" href="classsigc_1_1slot2.html" title="Converts an arbitrary functor to a unified type which is opaque. " alt="" coords="374,179,535,221"/>
<area shape="rect" id="node9" href="classsigc_1_1slot3.html" title="Converts an arbitrary functor to a unified type which is opaque. " alt="" coords="360,254,549,295"/>
<area shape="rect" id="node11" href="classsigc_1_1slot4.html" title="Converts an arbitrary functor to a unified type which is opaque. " alt="" coords="365,323,544,379"/>
<area shape="rect" id="node13" href="classsigc_1_1slot5.html" title="Converts an arbitrary functor to a unified type which is opaque. " alt="" coords="365,403,544,459"/>
<area shape="rect" id="node15" href="classsigc_1_1slot6.html" title="Converts an arbitrary functor to a unified type which is opaque. " alt="" coords="360,483,549,539"/>
<area shape="rect" id="node17" href="classsigc_1_1slot7.html" title="Converts an arbitrary functor to a unified type which is opaque. " alt="" coords="365,563,544,634"/>
<area shape="rect" id="node19" href="classsigc_1_1slot_3_01T__return_07T__arg_8_8_8_08_4.html" title="Converts an arbitrary functor to a unified type which is opaque. " alt="" coords="380,658,529,699"/>
<area shape="rect" id="node2" href="structsigc_1_1functor__base.html" title="A hint to the compiler. " alt="" coords="5,337,145,364"/>
<area shape="rect" id="node4" href="classsigc_1_1slot_3_01T__return_00_01nil_00_01nil_00_01nil_00_01nil_00_01nil_00_01nil_00_01nil_01_4.html" title="Convenience wrapper for the numbered sigc::slot0 template. " alt="" coords="627,5,781,61"/>
<area shape="rect" id="node6" href="classsigc_1_1slot_3_01T__return_00_01T__arg1_00_01nil_00_01nil_00_01nil_00_01nil_00_01nil_00_01nil_01_4.html" title="Convenience wrapper for the numbered sigc::slot1 template. " alt="" coords="627,85,781,141"/>
<area shape="rect" id="node8" href="classsigc_1_1slot_3_01T__return_00_01T__arg1_00_01T__arg2_00_01nil_00_01nil_00_01nil_00_01nil_00_01nil_01_4.html" title="Convenience wrapper for the numbered sigc::slot2 template. " alt="" coords="627,165,781,221"/>
<area shape="rect" id="node10" href="classsigc_1_1slot_3_01T__return_00_01T__arg1_00_01T__arg2_00_01T__arg3_00_01nil_00_01nil_00_01nil_00_01nil_01_4.html" title="Convenience wrapper for the numbered sigc::slot3 template. " alt="" coords="615,245,793,301"/>
<area shape="rect" id="node12" href="classsigc_1_1slot_3_01T__return_00_01T__arg1_00_01T__arg2_00_01T__arg3_00_01T__arg4_00_01nil_00_01nil_00_01nil_01_4.html" title="Convenience wrapper for the numbered sigc::slot4 template. " alt="" coords="615,325,793,381"/>
<area shape="rect" id="node14" href="classsigc_1_1slot_3_01T__return_00_01T__arg1_00_01T__arg2_00_01T__arg3_00_01T__arg4_00_01T__arg5_00_01nil_00_01nil_01_4.html" title="Convenience wrapper for the numbered sigc::slot5 template. " alt="" coords="611,405,797,461"/>
<area shape="rect" id="node16" href="classsigc_1_1slot_3_01T__return_00_01T__arg1_00_01T__arg2_00_01T__arg3_00_01T__arg4_00_01T__arg5_00_01T__arg6_00_01nil_01_4.html" title="Convenience wrapper for the numbered sigc::slot6 template. " alt="" coords="597,485,811,541"/>
<area shape="rect" id="node18" href="classsigc_1_1slot.html" title="Convenience wrapper for the numbered sigc::slot# templates. " alt="" coords="615,566,793,637"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></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:a7e1a0c2fe43a42187810e8997abeb341"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="structsigc_1_1trackable.html#a3338954d7565534bd945290b798e13ed">trackable::func_destroy_notify</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1slot__base.html#a7e1a0c2fe43a42187810e8997abeb341">func_destroy_notify</a></td></tr>
<tr class="separator:a7e1a0c2fe43a42187810e8997abeb341"><td class="memSeparator" colspan="2">&#160;</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:a182d5db71ef371838c73bcf1c135cd9a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1slot__base.html#a182d5db71ef371838c73bcf1c135cd9a">slot_base</a> () noexcept</td></tr>
<tr class="memdesc:a182d5db71ef371838c73bcf1c135cd9a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs an empty slot. <a href="#a182d5db71ef371838c73bcf1c135cd9a">More...</a><br /></td></tr>
<tr class="separator:a182d5db71ef371838c73bcf1c135cd9a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5fbc2bf38a0d9ebcbe13d578d2b3d5a1"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1slot__base.html#a5fbc2bf38a0d9ebcbe13d578d2b3d5a1">slot_base</a> (rep_type* rep) noexcept</td></tr>
<tr class="memdesc:a5fbc2bf38a0d9ebcbe13d578d2b3d5a1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a slot from an existing slot_rep object. <a href="#a5fbc2bf38a0d9ebcbe13d578d2b3d5a1">More...</a><br /></td></tr>
<tr class="separator:a5fbc2bf38a0d9ebcbe13d578d2b3d5a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aadcbb54832b5207bddf89ac5433b531a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1slot__base.html#aadcbb54832b5207bddf89ac5433b531a">slot_base</a> (const <a class="el" href="classsigc_1_1slot__base.html">slot_base</a>&amp; src)</td></tr>
<tr class="memdesc:aadcbb54832b5207bddf89ac5433b531a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a slot, copying an existing one. <a href="#aadcbb54832b5207bddf89ac5433b531a">More...</a><br /></td></tr>
<tr class="separator:aadcbb54832b5207bddf89ac5433b531a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad1fee67a5885e424c275ad0f48fc81b1"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1slot__base.html#ad1fee67a5885e424c275ad0f48fc81b1">slot_base</a> (<a class="el" href="classsigc_1_1slot__base.html">slot_base</a>&amp;&amp; src)</td></tr>
<tr class="memdesc:ad1fee67a5885e424c275ad0f48fc81b1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a slot, moving an existing one. <a href="#ad1fee67a5885e424c275ad0f48fc81b1">More...</a><br /></td></tr>
<tr class="separator:ad1fee67a5885e424c275ad0f48fc81b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a75c18c50860f63fb020fc2953576ea57"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1slot__base.html#a75c18c50860f63fb020fc2953576ea57">~slot_base</a> ()</td></tr>
<tr class="separator:a75c18c50860f63fb020fc2953576ea57"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afb626f3bce53c7430ee4b5e00449837e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1slot__base.html#afb626f3bce53c7430ee4b5e00449837e">add_destroy_notify_callback</a> (void* data, <a class="el" href="classsigc_1_1slot__base.html#a7e1a0c2fe43a42187810e8997abeb341">func_destroy_notify</a> func) const </td></tr>
<tr class="memdesc:afb626f3bce53c7430ee4b5e00449837e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a callback that is executed (notified) when the slot is detroyed. <a href="#afb626f3bce53c7430ee4b5e00449837e">More...</a><br /></td></tr>
<tr class="separator:afb626f3bce53c7430ee4b5e00449837e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a657a8473164c963a5ca4828c88121bb9"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1slot__base.html#a657a8473164c963a5ca4828c88121bb9">block</a> (bool should_block=true) noexcept</td></tr>
<tr class="memdesc:a657a8473164c963a5ca4828c88121bb9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the blocking state. <a href="#a657a8473164c963a5ca4828c88121bb9">More...</a><br /></td></tr>
<tr class="separator:a657a8473164c963a5ca4828c88121bb9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acd29a4d95a10e790a58c9ad294678cfa"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1slot__base.html#acd29a4d95a10e790a58c9ad294678cfa">blocked</a> () const noexcept</td></tr>
<tr class="memdesc:acd29a4d95a10e790a58c9ad294678cfa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns whether the slot is blocked. <a href="#acd29a4d95a10e790a58c9ad294678cfa">More...</a><br /></td></tr>
<tr class="separator:acd29a4d95a10e790a58c9ad294678cfa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4042d221f7f07a7394d2eb0f14db2857"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1slot__base.html#a4042d221f7f07a7394d2eb0f14db2857">disconnect</a> ()</td></tr>
<tr class="memdesc:a4042d221f7f07a7394d2eb0f14db2857"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disconnects the slot. <a href="#a4042d221f7f07a7394d2eb0f14db2857">More...</a><br /></td></tr>
<tr class="separator:a4042d221f7f07a7394d2eb0f14db2857"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afa612ec525c4ee0d4b096dc905f02fe8"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1slot__base.html#afa612ec525c4ee0d4b096dc905f02fe8">empty</a> () const noexcept</td></tr>
<tr class="memdesc:afa612ec525c4ee0d4b096dc905f02fe8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns whether the slot is invalid. <a href="#afa612ec525c4ee0d4b096dc905f02fe8">More...</a><br /></td></tr>
<tr class="separator:afa612ec525c4ee0d4b096dc905f02fe8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa6bfd3decffca58a532cd8439b70402d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1slot__base.html#aa6bfd3decffca58a532cd8439b70402d">operator bool</a> () const noexcept</td></tr>
<tr class="memdesc:aa6bfd3decffca58a532cd8439b70402d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tests whether a slot is null, because the default constructor was used. <a href="#aa6bfd3decffca58a532cd8439b70402d">More...</a><br /></td></tr>
<tr class="separator:aa6bfd3decffca58a532cd8439b70402d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a19522528264f1646f8ed982b0042ffad"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsigc_1_1slot__base.html">slot_base</a>&amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1slot__base.html#a19522528264f1646f8ed982b0042ffad">operator=</a> (const <a class="el" href="classsigc_1_1slot__base.html">slot_base</a>&amp; src)</td></tr>
<tr class="memdesc:a19522528264f1646f8ed982b0042ffad"><td class="mdescLeft">&#160;</td><td class="mdescRight">Overrides this slot, making a copy from another slot. <a href="#a19522528264f1646f8ed982b0042ffad">More...</a><br /></td></tr>
<tr class="separator:a19522528264f1646f8ed982b0042ffad"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a64e36f28ee61a94c0496fe76f6b3e813"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsigc_1_1slot__base.html">slot_base</a>&amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1slot__base.html#a64e36f28ee61a94c0496fe76f6b3e813">operator=</a> (<a class="el" href="classsigc_1_1slot__base.html">slot_base</a>&amp;&amp; src)</td></tr>
<tr class="memdesc:a64e36f28ee61a94c0496fe76f6b3e813"><td class="mdescLeft">&#160;</td><td class="mdescRight">Overrides this slot, making a move from another slot. <a href="#a64e36f28ee61a94c0496fe76f6b3e813">More...</a><br /></td></tr>
<tr class="separator:a64e36f28ee61a94c0496fe76f6b3e813"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6374e1400eef020eab09dfdbdc563912"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1slot__base.html#a6374e1400eef020eab09dfdbdc563912">remove_destroy_notify_callback</a> (void* data) const </td></tr>
<tr class="memdesc:a6374e1400eef020eab09dfdbdc563912"><td class="mdescLeft">&#160;</td><td class="mdescRight">Remove a callback previously installed with <a class="el" href="classsigc_1_1slot__base.html#afb626f3bce53c7430ee4b5e00449837e" title="Add a callback that is executed (notified) when the slot is detroyed. ">add_destroy_notify_callback()</a>. <a href="#a6374e1400eef020eab09dfdbdc563912">More...</a><br /></td></tr>
<tr class="separator:a6374e1400eef020eab09dfdbdc563912"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a37a481612bb852b7f749fe4c57201392"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1slot__base.html#a37a481612bb852b7f749fe4c57201392">set_parent</a> (void* parent, void*(* cleanup)(void*)) const noexcept</td></tr>
<tr class="memdesc:a37a481612bb852b7f749fe4c57201392"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the parent of this slot. <a href="#a37a481612bb852b7f749fe4c57201392">More...</a><br /></td></tr>
<tr class="separator:a37a481612bb852b7f749fe4c57201392"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a25ad0bd4d2cea4dbfcd09f7d393d266d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1slot__base.html#a25ad0bd4d2cea4dbfcd09f7d393d266d">unblock</a> () noexcept</td></tr>
<tr class="memdesc:a25ad0bd4d2cea4dbfcd09f7d393d266d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unsets the blocking state. <a href="#a25ad0bd4d2cea4dbfcd09f7d393d266d">More...</a><br /></td></tr>
<tr class="separator:a25ad0bd4d2cea4dbfcd09f7d393d266d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a9dc4958860c0f8300b461a743b7f2a2b"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1slot__base.html#a9dc4958860c0f8300b461a743b7f2a2b">blocked_</a></td></tr>
<tr class="memdesc:a9dc4958860c0f8300b461a743b7f2a2b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Indicates whether the slot is blocked. <a href="#a9dc4958860c0f8300b461a743b7f2a2b">More...</a><br /></td></tr>
<tr class="separator:a9dc4958860c0f8300b461a743b7f2a2b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa482f7dfc73c6950abde0fd51b3125b5"><td class="memItemLeft" align="right" valign="top">rep_type*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1slot__base.html#aa482f7dfc73c6950abde0fd51b3125b5">rep_</a></td></tr>
<tr class="memdesc:aa482f7dfc73c6950abde0fd51b3125b5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Typed slot_rep object that contains a functor. <a href="#aa482f7dfc73c6950abde0fd51b3125b5">More...</a><br /></td></tr>
<tr class="separator:aa482f7dfc73c6950abde0fd51b3125b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Base type for slots. </p>
<p><a class="el" href="classsigc_1_1slot__base.html" title="Base type for slots. ">slot_base</a> integrates most of the interface of the derived <a class="el" href="classsigc_1_1slot.html" title="Convenience wrapper for the numbered sigc::slot# templates. ">sigc::slot</a> templates. slots can be connected to signals, be disconnected at some later point (<a class="el" href="classsigc_1_1slot__base.html#a4042d221f7f07a7394d2eb0f14db2857" title="Disconnects the slot. ">disconnect()</a>) and temporarily be blocked (<a class="el" href="classsigc_1_1slot__base.html#a657a8473164c963a5ca4828c88121bb9" title="Sets the blocking state. ">block()</a>, <a class="el" href="classsigc_1_1slot__base.html#a25ad0bd4d2cea4dbfcd09f7d393d266d" title="Unsets the blocking state. ">unblock()</a>). The validity of a slot can be tested with <a class="el" href="classsigc_1_1slot__base.html#afa612ec525c4ee0d4b096dc905f02fe8" title="Returns whether the slot is invalid. ">empty()</a>.</p>
<p>The internal representation of a sigc::internal::slot_rep derived type is built from <a class="el" href="classsigc_1_1slot__base.html" title="Base type for slots. ">slot_base</a>'s derivations. <a class="el" href="classsigc_1_1slot__base.html#a37a481612bb852b7f749fe4c57201392" title="Sets the parent of this slot. ">set_parent()</a> is used to register a notification callback that is executed when the slot gets invalid. <a class="el" href="classsigc_1_1slot__base.html#afb626f3bce53c7430ee4b5e00449837e" title="Add a callback that is executed (notified) when the slot is detroyed. ">add_destroy_notify_callback()</a> is used by connection objects to add a notification callback that is executed on destruction. </p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a class="anchor" id="a7e1a0c2fe43a42187810e8997abeb341"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="structsigc_1_1trackable.html#a3338954d7565534bd945290b798e13ed">trackable::func_destroy_notify</a> <a class="el" href="classsigc_1_1slot__base.html#a7e1a0c2fe43a42187810e8997abeb341">sigc::slot_base::func_destroy_notify</a></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a182d5db71ef371838c73bcf1c135cd9a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">sigc::slot_base::slot_base </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructs an empty slot. </p>
</div>
</div>
<a class="anchor" id="a5fbc2bf38a0d9ebcbe13d578d2b3d5a1"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">sigc::slot_base::slot_base </td>
<td>(</td>
<td class="paramtype">rep_type *&#160;</td>
<td class="paramname"><em>rep</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructs a slot from an existing slot_rep object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">rep</td><td>The slot_rep object this slot should contain. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aadcbb54832b5207bddf89ac5433b531a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">sigc::slot_base::slot_base </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classsigc_1_1slot__base.html">slot_base</a>&amp;&#160;</td>
<td class="paramname"><em>src</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructs a slot, copying an existing one. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">src</td><td>The existing slot to copy. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ad1fee67a5885e424c275ad0f48fc81b1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">sigc::slot_base::slot_base </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classsigc_1_1slot__base.html">slot_base</a>&amp;&amp;&#160;</td>
<td class="paramname"><em>src</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructs a slot, moving an existing one. </p>
<p>If <code>src</code> is connected to a parent (e.g. a signal), it is copied, not moved. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">src</td><td>The existing slot to move or copy. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a75c18c50860f63fb020fc2953576ea57"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">sigc::slot_base::~slot_base </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="afb626f3bce53c7430ee4b5e00449837e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void sigc::slot_base::add_destroy_notify_callback </td>
<td>(</td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classsigc_1_1slot__base.html#a7e1a0c2fe43a42187810e8997abeb341">func_destroy_notify</a>&#160;</td>
<td class="paramname"><em>func</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Add a callback that is executed (notified) when the slot is detroyed. </p>
<p>This function is used internally by connection objects. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>Passed into func upon notification. </td></tr>
<tr><td class="paramname">func</td><td>Callback executed upon destruction of the object. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a657a8473164c963a5ca4828c88121bb9"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool sigc::slot_base::block </td>
<td>(</td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>should_block</em> = <code>true</code></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the blocking state. </p>
<p>If <em>should_block</em> is <code>true</code> then the blocking state is set. Subsequent calls to <a class="el" href="classsigc_1_1slot7.html#a115f4dc171664e693a6bb7afc41778d4" title="Invoke the contained functor unless slot is in blocking state. ">slot::operator()()</a> don't invoke the functor contained by this slot until <a class="el" href="classsigc_1_1slot__base.html#a25ad0bd4d2cea4dbfcd09f7d393d266d" title="Unsets the blocking state. ">unblock()</a> or <a class="el" href="classsigc_1_1slot__base.html#a657a8473164c963a5ca4828c88121bb9" title="Sets the blocking state. ">block()</a> with <em>should_block</em> = <code>false</code> is called. </p><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 slot was in blocking state before. </dd></dl>
</div>
</div>
<a class="anchor" id="acd29a4d95a10e790a58c9ad294678cfa"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool sigc::slot_base::blocked </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</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>Returns whether the slot is blocked. </p>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if the slot is blocked. </dd></dl>
</div>
</div>
<a class="anchor" id="a4042d221f7f07a7394d2eb0f14db2857"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void sigc::slot_base::disconnect </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Disconnects the slot. </p>
<p>Invalidates the slot and notifies the parent. </p>
</div>
</div>
<a class="anchor" id="afa612ec525c4ee0d4b096dc905f02fe8"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool sigc::slot_base::empty </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</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>Returns whether the slot is invalid. </p>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if the slot is invalid (empty). </dd></dl>
</div>
</div>
<a class="anchor" id="aa6bfd3decffca58a532cd8439b70402d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">sigc::slot_base::operator bool </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Tests whether a slot is null, because the default constructor was used. </p>
<p>Test a slot for null like so: </p><div class="fragment"><div class="line"><span class="keywordflow">if</span>(slot)</div><div class="line"> do_something()</div></div><!-- fragment -->
</div>
</div>
<a class="anchor" id="a19522528264f1646f8ed982b0042ffad"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classsigc_1_1slot__base.html">slot_base</a>&amp; sigc::slot_base::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classsigc_1_1slot__base.html">slot_base</a>&amp;&#160;</td>
<td class="paramname"><em>src</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Overrides this slot, making a copy from another slot. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">src</td><td>The slot from which to make a copy. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>this</code>. </dd></dl>
</div>
</div>
<a class="anchor" id="a64e36f28ee61a94c0496fe76f6b3e813"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classsigc_1_1slot__base.html">slot_base</a>&amp; sigc::slot_base::operator= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classsigc_1_1slot__base.html">slot_base</a>&amp;&amp;&#160;</td>
<td class="paramname"><em>src</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Overrides this slot, making a move from another slot. </p>
<p>If <code>src</code> is connected to a parent (e.g. a signal), it is copied, not moved. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">src</td><td>The slot from which to move or copy. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>this</code>. </dd></dl>
</div>
</div>
<a class="anchor" id="a6374e1400eef020eab09dfdbdc563912"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void sigc::slot_base::remove_destroy_notify_callback </td>
<td>(</td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>data</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Remove a callback previously installed with <a class="el" href="classsigc_1_1slot__base.html#afb626f3bce53c7430ee4b5e00449837e" title="Add a callback that is executed (notified) when the slot is detroyed. ">add_destroy_notify_callback()</a>. </p>
<p>The callback is not executed. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>Parameter passed into previous call to <a class="el" href="classsigc_1_1slot__base.html#afb626f3bce53c7430ee4b5e00449837e" title="Add a callback that is executed (notified) when the slot is detroyed. ">add_destroy_notify_callback()</a>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a37a481612bb852b7f749fe4c57201392"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void sigc::slot_base::set_parent </td>
<td>(</td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>parent</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *(*)(void *)&#160;</td>
<td class="paramname"><em>cleanup</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the parent of this slot. </p>
<p>This function is used by signals to register a notification callback. This notification callback is executed when the slot becomes invalid because of some referred object dying. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">parent</td><td>The new parent. </td></tr>
<tr><td class="paramname">cleanup</td><td>The notification callback. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a25ad0bd4d2cea4dbfcd09f7d393d266d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool sigc::slot_base::unblock </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Unsets the blocking state. </p>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if the slot was in blocking state before. </dd></dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a9dc4958860c0f8300b461a743b7f2a2b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool sigc::slot_base::blocked_</td>
</tr>
</table>
</div><div class="memdoc">
<p>Indicates whether the slot is blocked. </p>
</div>
</div>
<a class="anchor" id="aa482f7dfc73c6950abde0fd51b3125b5"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">rep_type* sigc::slot_base::rep_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">mutable</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Typed slot_rep object that contains a functor. </p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Mar 25 2020 10:13:31 for libsigc++ by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink