<!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"/> <title>libsigc++: Signals</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body> <!-- Generated by Doxygen 1.6.1 --> <div class="navigation" id="top"> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li><a href="annotated.html"><span>Classes</span></a></li> </ul> </div> </div> <div class="contents"> <h1>Signals</h1> <p>Use <a class="el" href="classsigc_1_1signal7.html#adc55ac9b0f935fd87a67904022e03cb2" title="Add a slot to the list of slots.">sigc::signal::connect()</a> with <a class="el" href="group__mem__fun.html#ga7d9ea809173f48bf5c76cf1989591602" 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#gada8b678665c14dc85eb32d25b7299465" title="Creates a functor of type sigc::pointer_functor0 which wraps an existing non-member...">sigc::ptr_fun()</a> to connect a method or function with a <a class="el" href="classsigc_1_1signal.html" title="Convenience wrapper for the numbered sigc::signal# templates.">signal</a>. <a href="#_details">More...</a></p> <table border="0" cellpadding="0" cellspacing="0"> <tr><td colspan="2"><h2>Classes</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1connection.html">sigc::connection</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Convinience class for safe disconnection. <a href="structsigc_1_1connection.html#_details">More...</a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1signal__base.html">sigc::signal_base</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Base class for the <a class="el" href="classsigc_1_1signal.html" title="Convenience wrapper for the numbered sigc::signal# templates.">sigc::signal</a># templates. <a href="structsigc_1_1signal__base.html#_details">More...</a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1trackable.html">sigc::trackable</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Base class for objects with auto-disconnection. <a href="structsigc_1_1trackable.html#_details">More...</a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1slot__iterator.html">sigc::slot_iterator< T_slot ></a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">STL-style iterator for <a class="el" href="structsigc_1_1slot__list.html" title="STL-style list interface for sigc::signal#.">slot_list</a>. <a href="structsigc_1_1slot__iterator.html#_details">More...</a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1slot__const__iterator.html">sigc::slot_const_iterator< T_slot ></a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">STL-style const iterator for <a class="el" href="structsigc_1_1slot__list.html" title="STL-style list interface for sigc::signal#.">slot_list</a>. <a href="structsigc_1_1slot__const__iterator.html#_details">More...</a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1slot__list.html">sigc::slot_list< T_slot ></a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">STL-style list interface for <a class="el" href="classsigc_1_1signal.html" title="Convenience wrapper for the numbered sigc::signal# templates.">sigc::signal</a>#. <a href="structsigc_1_1slot__list.html#_details">More...</a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1signal0.html">sigc::signal0< T_return, T_accumulator ></a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Signal declaration. <a href="classsigc_1_1signal0.html#_details">More...</a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1signal1.html">sigc::signal1< T_return, T_arg1, T_accumulator ></a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Signal declaration. <a href="classsigc_1_1signal1.html#_details">More...</a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1signal2.html">sigc::signal2< T_return, T_arg1, T_arg2, T_accumulator ></a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Signal declaration. <a href="classsigc_1_1signal2.html#_details">More...</a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1signal3.html">sigc::signal3< T_return, T_arg1, T_arg2, T_arg3, T_accumulator ></a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Signal declaration. <a href="classsigc_1_1signal3.html#_details">More...</a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1signal4.html">sigc::signal4< T_return, T_arg1, T_arg2, T_arg3, T_arg4, T_accumulator ></a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Signal declaration. <a href="classsigc_1_1signal4.html#_details">More...</a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1signal5.html">sigc::signal5< T_return, T_arg1, T_arg2, T_arg3, T_arg4, T_arg5, T_accumulator ></a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Signal declaration. <a href="classsigc_1_1signal5.html#_details">More...</a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1signal6.html">sigc::signal6< T_return, T_arg1, T_arg2, T_arg3, T_arg4, T_arg5, T_arg6, T_accumulator ></a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Signal declaration. <a href="classsigc_1_1signal6.html#_details">More...</a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1signal7.html">sigc::signal7< T_return, T_arg1, T_arg2, T_arg3, T_arg4, T_arg5, T_arg6, T_arg7, T_accumulator ></a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Signal declaration. <a href="classsigc_1_1signal7.html#_details">More...</a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1signal.html">sigc::signal< T_return, T_arg1, T_arg2, T_arg3, T_arg4, T_arg5, T_arg6, T_arg7 ></a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Convenience wrapper for the numbered <a class="el" href="classsigc_1_1signal.html" title="Convenience wrapper for the numbered sigc::signal# templates.">sigc::signal</a># templates. <a href="classsigc_1_1signal.html#_details">More...</a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1signal_1_1accumulated.html">sigc::signal< T_return, T_arg1, T_arg2, T_arg3, T_arg4, T_arg5, T_arg6, T_arg7 >::accumulated< T_accumulator ></a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Convenience wrapper for the numbered <a class="el" href="classsigc_1_1signal.html" title="Convenience wrapper for the numbered sigc::signal# templates.">sigc::signal</a># templates. <a href="classsigc_1_1signal_1_1accumulated.html#_details">More...</a><br/></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>Use <a class="el" href="classsigc_1_1signal7.html#adc55ac9b0f935fd87a67904022e03cb2" title="Add a slot to the list of slots.">sigc::signal::connect()</a> with <a class="el" href="group__mem__fun.html#ga7d9ea809173f48bf5c76cf1989591602" 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#gada8b678665c14dc85eb32d25b7299465" title="Creates a functor of type sigc::pointer_functor0 which wraps an existing non-member...">sigc::ptr_fun()</a> to connect a method or function with a <a class="el" href="classsigc_1_1signal.html" title="Convenience wrapper for the numbered sigc::signal# templates.">signal</a>. </p> <div class="fragment"><pre class="fragment"> signal_clicked.connect( <a class="code" href="group__mem__fun.html#ga7d9ea809173f48bf5c76cf1989591602" title="Creates a functor of type sigc::mem_functor0 which wraps a method.">sigc::mem_fun</a>(*<span class="keyword">this</span>, &MyWindow::on_clicked) ); </pre></div><p>When the <a class="el" href="classsigc_1_1signal.html" title="Convenience wrapper for the numbered sigc::signal# templates.">signal</a> is emitted your method will be called.</p> <p><a class="el" href="classsigc_1_1signal7.html#adc55ac9b0f935fd87a67904022e03cb2" title="Add a slot to the list of slots.">signal::connect()</a> returns a <a class="el" href="structsigc_1_1connection.html" title="Convinience class for safe disconnection.">connection</a>, which you can later use to disconnect your method. If the type of your object inherits from <a class="el" href="structsigc_1_1trackable.html" title="Base class for objects with auto-disconnection.">sigc::trackable</a> the method is disconnected automatically when your object is destroyed.</p> <p>When signals are copied they share the underlying information, so you can have a protected/private <a class="el" href="classsigc_1_1signal.html" title="Convenience wrapper for the numbered sigc::signal# templates.">sigc::signal</a> member and a public accessor method.</p> <p><a class="el" href="classsigc_1_1signal.html" title="Convenience wrapper for the numbered sigc::signal# templates.">signal</a> and <a class="el" href="classsigc_1_1slot.html" title="Convenience wrapper for the numbered sigc::slot# templates.">slot</a> objects provide the core functionality of this library. A <a class="el" href="classsigc_1_1slot.html" title="Convenience wrapper for the numbered sigc::slot# templates.">slot</a> is a container for an arbitrary functor. A <a class="el" href="classsigc_1_1signal.html" title="Convenience wrapper for the numbered sigc::signal# templates.">signal</a> is a list of slots that are executed on emission. For compile time type safety a list of template arguments must be provided for the <a class="el" href="classsigc_1_1signal.html" title="Convenience wrapper for the numbered sigc::signal# templates.">signal</a> template that determines the parameter list for emission. Functors and closures are converted into slots implicitely on <a class="el" href="structsigc_1_1connection.html" title="Convinience class for safe disconnection.">connection</a>, triggering compiler errors if the given functor or closure cannot be invoked with the parameter list of the <a class="el" href="classsigc_1_1signal.html" title="Convenience wrapper for the numbered sigc::signal# templates.">signal</a> to connect to. </p> </div> <hr size="1"/><address style="text-align: right;"><small>Generated on Tue May 4 21:44:38 2010 for libsigc++ by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address> </body> </html>