docs/reference/html/group__slot.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml">
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
   6 <title>libsigc++: Slots</title>
   7 <link href="tabs.css" rel="stylesheet" type="text/css"/>
   8 <script type="text/javascript" src="jquery.js"></script>
   9 <script type="text/javascript" src="dynsections.js"></script>
  10 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  11 </head>
  12 <body>
  13 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  14 <div id="titlearea">
  15 <table cellspacing="0" cellpadding="0">
  16  <tbody>
  17  <tr style="height: 56px;">
  18   <td style="padding-left: 0.5em;">
  19    <div id="projectname">libsigc++
  20    &#160;<span id="projectnumber">2.3.1</span>
  21    </div>
  22   </td>
  23  </tr>
  24  </tbody>
  25 </table>
  26 </div>
  27 <!-- end header part -->
  28 <!-- Generated by Doxygen 1.8.2 -->
  29   <div id="navrow1" class="tabs">
  30     <ul class="tablist">
  31       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  32       <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  33       <li><a href="modules.html"><span>Modules</span></a></li>
  34       <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  35       <li><a href="annotated.html"><span>Classes</span></a></li>
  36     </ul>
  37   </div>
  38 </div><!-- top -->
  39 <div class="header">
  40   <div class="summary">
  41 <a href="#nested-classes">Classes</a> </div>
  42   <div class="headertitle">
  43 <div class="title">Slots</div> </div>
  44 <div class="ingroups"><a class="el" href="group__sigcfunctors.html">Functors</a></div></div><!--header-->
  45 <div class="contents">
  46
  47 <p>Slots are type-safe representations of callback methods and functions. <a href="#details">More...</a></p>
  48 <table class="memberdecls">
  49 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
  50 Classes</h2></td></tr>
  51 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1slot__base.html">sigc::slot_base</a></td></tr>
  52 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Base type for slots. <a href="classsigc_1_1slot__base.html#details">More...</a><br/></td></tr>
  53 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  54 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1slot0.html">sigc::slot0&lt; T_return &gt;</a></td></tr>
  55 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts an arbitrary functor to a unified type which is opaque. <a href="classsigc_1_1slot0.html#details">More...</a><br/></td></tr>
  56 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  57 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1slot1.html">sigc::slot1&lt; T_return, T_arg1 &gt;</a></td></tr>
  58 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts an arbitrary functor to a unified type which is opaque. <a href="classsigc_1_1slot1.html#details">More...</a><br/></td></tr>
  59 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  60 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1slot2.html">sigc::slot2&lt; T_return, T_arg1, T_arg2 &gt;</a></td></tr>
  61 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts an arbitrary functor to a unified type which is opaque. <a href="classsigc_1_1slot2.html#details">More...</a><br/></td></tr>
  62 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  63 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1slot3.html">sigc::slot3&lt; T_return, T_arg1, T_arg2, T_arg3 &gt;</a></td></tr>
  64 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts an arbitrary functor to a unified type which is opaque. <a href="classsigc_1_1slot3.html#details">More...</a><br/></td></tr>
  65 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  66 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1slot4.html">sigc::slot4&lt; T_return, T_arg1, T_arg2, T_arg3, T_arg4 &gt;</a></td></tr>
  67 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts an arbitrary functor to a unified type which is opaque. <a href="classsigc_1_1slot4.html#details">More...</a><br/></td></tr>
  68 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  69 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1slot5.html">sigc::slot5&lt; T_return, T_arg1, T_arg2, T_arg3, T_arg4, T_arg5 &gt;</a></td></tr>
  70 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts an arbitrary functor to a unified type which is opaque. <a href="classsigc_1_1slot5.html#details">More...</a><br/></td></tr>
  71 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  72 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1slot6.html">sigc::slot6&lt; T_return, T_arg1, T_arg2, T_arg3, T_arg4, T_arg5, T_arg6 &gt;</a></td></tr>
  73 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts an arbitrary functor to a unified type which is opaque. <a href="classsigc_1_1slot6.html#details">More...</a><br/></td></tr>
  74 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  75 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1slot7.html">sigc::slot7&lt; T_return, T_arg1, T_arg2, T_arg3, T_arg4, T_arg5, T_arg6, T_arg7 &gt;</a></td></tr>
  76 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts an arbitrary functor to a unified type which is opaque. <a href="classsigc_1_1slot7.html#details">More...</a><br/></td></tr>
  77 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1slot.html">sigc::slot&lt; T_return, T_arg1, T_arg2, T_arg3, T_arg4, T_arg5, T_arg6, T_arg7 &gt;</a></td></tr>
  79 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convenience wrapper for the numbered <a class="el" href="classsigc_1_1slot.html" title="Convenience wrapper for the numbered sigc::slot# templates.">sigc::slot</a># templates. <a href="classsigc_1_1slot.html#details">More...</a><br/></td></tr>
  80 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81 </table>
  82 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  83 <p>Slots are type-safe representations of callback methods and functions. </p>
  84 <p>A Slot can be constructed from any function, regardless of whether it is a global function, a member method, static, or virtual.</p>
  85 <p>Use the <a class="el" href="group__mem__fun.html#ga52244864d2f65f072678b682bfc9913f" title="Creates a functor of type sigc::mem_functor0 which wraps a method.">sigc::mem_fun()</a> and <a class="el" href="group__ptr__fun.html#ga9c80de72f656fb05e81fda622dddc863" title="Creates a functor of type sigc::pointer_functor0 which wraps an existing non-member function...">sigc::ptr_fun()</a> template functions to get a <a class="el" href="classsigc_1_1slot.html" title="Convenience wrapper for the numbered sigc::slot# templates.">sigc::slot</a>, like so:</p>
  86 <div class="fragment"><div class="line"><a class="code" href="classsigc_1_1slot.html" title="Convenience wrapper for the numbered sigc::slot# templates.">sigc::slot&lt;void, int&gt;</a> sl = <a class="code" href="group__mem__fun.html#ga52244864d2f65f072678b682bfc9913f" title="Creates a functor of type sigc::mem_functor0 which wraps a method.">sigc::mem_fun</a>(someobj,&amp; SomeClass::somemethod);</div>
  87 </div><!-- fragment --><p>or</p>
  88 <div class="fragment"><div class="line"><a class="code" href="classsigc_1_1slot.html" title="Convenience wrapper for the numbered sigc::slot# templates.">sigc::slot&lt;void, int&gt;</a> sl = <a class="code" href="group__ptr__fun.html#ga9c80de72f656fb05e81fda622dddc863" title="Creates a functor of type sigc::pointer_functor0 which wraps an existing non-member function...">sigc::ptr_fun</a>(&amp;somefunction);</div>
  89 </div><!-- fragment --><p>or</p>
  90 <div class="fragment"><div class="line">m_Button.signal_clicked().connect( <a class="code" href="group__mem__fun.html#ga52244864d2f65f072678b682bfc9913f" title="Creates a functor of type sigc::mem_functor0 which wraps a method.">sigc::mem_fun</a>(*<span class="keyword">this</span>, &amp;MyWindow::on_button_clicked) );</div>
  91 </div><!-- fragment --><p>The compiler will complain if SomeClass::somemethod, etc. have the wrong signature.</p>
  92 <p>You can also pass slots as method parameters where you might normally pass a function pointer. </p>
  93 </div><!-- contents -->
  94 <!-- start footer part -->
  95 <hr class="footer"/><address class="footer"><small>
  96 Generated on Thu Oct 18 2012 09:28:24 for libsigc++ by &#160;<a href="http://www.doxygen.org/index.html">
  97 <img class="footer" src="doxygen.png" alt="doxygen"/>
  98 </a> 1.8.2
  99 </small></address>
 100 </body>
 101 </html>