docs/reference/html/group__ptr__fun.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 <meta name="generator" content="Doxygen 1.8.9.1"/>
   7 <title>libsigc++: ptr_fun()</title>
   8 <link href="tabs.css" rel="stylesheet" type="text/css"/>
   9 <script type="text/javascript" src="jquery.js"></script>
  10 <script type="text/javascript" src="dynsections.js"></script>
  11 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  12 <link href="doxygen-extra.css" rel="stylesheet" type="text/css"/>
  13 </head>
  14 <body>
  15 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  16 <div id="titlearea">
  17 <table cellspacing="0" cellpadding="0">
  18  <tbody>
  19  <tr style="height: 56px;">
  20   <td style="padding-left: 0.5em;">
  21    <div id="projectname">libsigc++
  22    &#160;<span id="projectnumber">2.99.2</span>
  23    </div>
  24   </td>
  25  </tr>
  26  </tbody>
  27 </table>
  28 </div>
  29 <!-- end header part -->
  30 <!-- Generated by Doxygen 1.8.9.1 -->
  31   <div id="navrow1" class="tabs">
  32     <ul class="tablist">
  33       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  34       <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  35       <li><a href="modules.html"><span>Modules</span></a></li>
  36       <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  37       <li><a href="annotated.html"><span>Classes</span></a></li>
  38     </ul>
  39   </div>
  40 </div><!-- top -->
  41 <div class="header">
  42   <div class="summary">
  43 <a href="#nested-classes">Classes</a> &#124;
  44 <a href="#func-members">Functions</a>  </div>
  45   <div class="headertitle">
  46 <div class="title">ptr_fun()<div class="ingroups"><a class="el" href="group__sigcfunctors.html">Functors</a></div></div>  </div>
  47 </div><!--header-->
  48 <div class="contents">
  49
  50 <p><a class="el" href="group__ptr__fun.html#ga203dd1ac5747cf2f3d2b2d590ad32e82" title="Creates a functor of type sigc::pointer_functor which wraps an existing non-member function...">ptr_fun()</a> is used to convert a pointer to a function to a functor.
  51 <a href="#details">More...</a></p>
  52 <table class="memberdecls">
  53 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
  54 Classes</h2></td></tr>
  55 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1pointer__functor.html">sigc::pointer_functor&lt; T_return, T_args &gt;</a></td></tr>
  56 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classsigc_1_1pointer__functor.html" title="pointer_functor wraps existing non-member functions with, or without, arguments. ">pointer_functor</a> wraps existing non-member functions with, or without, arguments.  <a href="classsigc_1_1pointer__functor.html#details">More...</a><br /></td></tr>
  57 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  58 </table><table class="memberdecls">
  59 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  60 Functions</h2></td></tr>
  61 <tr class="memitem:ga203dd1ac5747cf2f3d2b2d590ad32e82"><td class="memTemplParams" colspan="2">template&lt;class T_return , class... T_args&gt; </td></tr>
  62 <tr class="memitem:ga203dd1ac5747cf2f3d2b2d590ad32e82"><td class="memTemplItemLeft" align="right" valign="top">decltype(auto)&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__ptr__fun.html#ga203dd1ac5747cf2f3d2b2d590ad32e82">sigc::ptr_fun</a> (T_return(* _A_func)(T_args...))</td></tr>
  63 <tr class="memdesc:ga203dd1ac5747cf2f3d2b2d590ad32e82"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a functor of type <a class="el" href="classsigc_1_1pointer__functor.html" title="pointer_functor wraps existing non-member functions with, or without, arguments. ">sigc::pointer_functor</a> which wraps an existing non-member function.  <a href="#ga203dd1ac5747cf2f3d2b2d590ad32e82">More...</a><br /></td></tr>
  64 <tr class="separator:ga203dd1ac5747cf2f3d2b2d590ad32e82"><td class="memSeparator" colspan="2">&#160;</td></tr>
  65 </table>
  66 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  67 <p><a class="el" href="group__ptr__fun.html#ga203dd1ac5747cf2f3d2b2d590ad32e82" title="Creates a functor of type sigc::pointer_functor which wraps an existing non-member function...">ptr_fun()</a> is used to convert a pointer to a function to a functor. </p>
  68 <p>If the function pointer is to an overloaded type, you must specify the types using template arguments starting with the first argument. It is not necessary to supply the return type.</p>
  69 <dl class="section user"><dt>Example:</dt><dd><div class="fragment"><div class="line"><span class="keywordtype">void</span> foo(<span class="keywordtype">int</span>) {}</div>
  70 <div class="line"><a class="code" href="classsigc_1_1slot.html">sigc::slot&lt;void(int)&gt;</a> sl = <a class="code" href="group__ptr__fun.html#ga203dd1ac5747cf2f3d2b2d590ad32e82">sigc::ptr_fun</a>(&amp;foo);</div>
  71 </div><!-- fragment --></dd></dl>
  72 <dl class="section user"><dt>Example:</dt><dd><div class="fragment"><div class="line"><span class="keywordtype">void</span> foo(<span class="keywordtype">int</span>) {}  <span class="comment">// choose this one</span></div>
  73 <div class="line"><span class="keywordtype">void</span> foo(<span class="keywordtype">float</span>) {}</div>
  74 <div class="line"><span class="keywordtype">void</span> foo(<span class="keywordtype">int</span>, <span class="keywordtype">int</span>) {}</div>
  75 <div class="line"><a class="code" href="classsigc_1_1slot.html">sigc::slot&lt;void(long)&gt;</a> sl = sigc::ptr_fun&lt;void, int&gt;(&amp;foo);</div>
  76 </div><!-- fragment --></dd></dl>
  77 <p><a class="el" href="group__ptr__fun.html#ga203dd1ac5747cf2f3d2b2d590ad32e82" title="Creates a functor of type sigc::pointer_functor which wraps an existing non-member function...">ptr_fun()</a> can also be used to convert a pointer to a static member function to a functor, like so:</p>
  78 <dl class="section user"><dt>Example:</dt><dd><div class="fragment"><div class="line"><span class="keyword">struct </span>foo</div>
  79 <div class="line">{</div>
  80 <div class="line">  <span class="keyword">static</span> <span class="keywordtype">void</span> bar(<span class="keywordtype">int</span>) {}</div>
  81 <div class="line">};</div>
  82 <div class="line"><a class="code" href="classsigc_1_1slot.html">sigc::slot&lt;void(int)&gt;</a> sl = <a class="code" href="group__ptr__fun.html#ga203dd1ac5747cf2f3d2b2d590ad32e82">sigc::ptr_fun</a>(&amp;foo::bar);</div>
  83 </div><!-- fragment --> </dd></dl>
  84 <h2 class="groupheader">Function Documentation</h2>
  85 <a class="anchor" id="ga203dd1ac5747cf2f3d2b2d590ad32e82"></a>
  86 <div class="memitem">
  87 <div class="memproto">
  88 <div class="memtemplate">
  89 template &lt;class T_return , class... T_args&gt; </div>
  90 <table class="mlabels">
  91   <tr>
  92   <td class="mlabels-left">
  93       <table class="memname">
  94         <tr>
  95           <td class="memname">decltype(auto) sigc::ptr_fun </td>
  96           <td>(</td>
  97           <td class="paramtype">T_return(*)(T_args...)&#160;</td>
  98           <td class="paramname"><em>_A_func</em></td><td>)</td>
  99           <td></td>
 100         </tr>
 101       </table>
 102   </td>
 103   <td class="mlabels-right">
 104 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 105   </tr>
 106 </table>
 107 </div><div class="memdoc">
 108
 109 <p>Creates a functor of type <a class="el" href="classsigc_1_1pointer__functor.html" title="pointer_functor wraps existing non-member functions with, or without, arguments. ">sigc::pointer_functor</a> which wraps an existing non-member function. </p>
 110 <dl class="params"><dt>Parameters</dt><dd>
 111   <table class="params">
 112     <tr><td class="paramname">_A_func</td><td>Pointer to function that should be wrapped. </td></tr>
 113   </table>
 114   </dd>
 115 </dl>
 116 <dl class="section return"><dt>Returns</dt><dd>Functor that executes <em>_A_func</em> on invokation. </dd></dl>
 117
 118 </div>
 119 </div>
 120 </div><!-- contents -->
 121 <!-- start footer part -->
 122 <hr class="footer"/><address class="footer"><small>
 123 Generated on Wed Mar 16 2016 20:53:27 for libsigc++ by &#160;<a href="http://www.doxygen.org/index.html">
 124 <img class="footer" src="doxygen.png" alt="doxygen"/>
 125 </a> 1.8.9.1
 126 </small></address>
 127 </body>
 128 </html>