File: classsigc_1_1bound__mem__functor1.html

package info (click to toggle)
libsigc%2B%2B-2.0 2.0.10-1
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 20,220 kB
  • ctags: 6,376
  • sloc: sh: 8,402; cpp: 1,717; xml: 368; makefile: 364; perl: 51; ansic: 45
file content (269 lines) | stat: -rw-r--r-- 13,517 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>libsigc++ 2.0: sigc::bound_mem_functor1&lt; T_return, T_obj, T_arg1 &gt; Class Template Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head>
<body bgcolor="#ffffff">
<table border="0" width="100%">
<tr>
    <td width="10%" height="40"><img src="../../images/libsigc_logo.gif" alt="logo" border="0" width="100%" height="100%"/></td>
    <td width="90%" height="40"><img src="../../images/top.gif" alt="top" width="100%" height="40"/></td>
</tr>
</table>
<center>
  <a class="qindex" href="../../index.html">Main Page</a> &nbsp;
  <a class="qindex" href="modules.html">Groups</a> &nbsp;
  <a class="qindex" href="namespaces.html"> Namespaces</a> &nbsp;
</center>
<hr width="100%"/>

<!-- Generated by Doxygen 1.3.9.1 -->
<h1>sigc::bound_mem_functor1&lt; T_return, T_obj, T_arg1 &gt; Class Template Reference<br>
<small>
[<a class="el" href="group__mem__fun.html">mem_fun()</a>]</small>
</h1><a class="el" href="classsigc_1_1bound__mem__functor1.html">bound_mem_functor1</a> encapsulates a method with 1 arguments and an object instance.  
<a href="#_details">More...</a>
<p>
Inheritance diagram for sigc::bound_mem_functor1&lt; T_return, T_obj, T_arg1 &gt;:<p><center><img src="classsigc_1_1bound__mem__functor1__inherit__graph.png" border="0" usemap="#sigc_1_1bound__mem__functor1_3_01T__return_00_01T__obj_00_01T__arg1_01_4__inherit__map" alt="Inheritance graph"></center>
<map name="sigc_1_1bound__mem__functor1_3_01T__return_00_01T__obj_00_01T__arg1_01_4__inherit__map">
<area href="classsigc_1_1mem__functor1.html" shape="rect" coords="30,84,332,108" alt="">
<area href="structsigc_1_1functor__base.html" shape="rect" coords="116,9,246,33" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classsigc_1_1bound__mem__functor1-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="classsigc_1_1mem__functor1.html#w0">base_type_::function_type</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1bound__mem__functor1.html#w0">function_type</a></td></tr>

<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1bound__mem__functor1.html#a0">bound_mem_functor1</a> (T_obj* _A_obj, <a class="el" href="classsigc_1_1bound__mem__functor1.html#w0">function_type</a> _A_func)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructs a <a class="el" href="classsigc_1_1bound__mem__functor1.html">bound_mem_functor1</a> object that wraps the passed method.  <a href="#a0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1bound__mem__functor1.html#a1">bound_mem_functor1</a> (T_obj&amp; _A_obj, <a class="el" href="classsigc_1_1bound__mem__functor1.html#w0">function_type</a> _A_func)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructs a <a class="el" href="classsigc_1_1bound__mem__functor1.html">bound_mem_functor1</a> object that wraps the passed method.  <a href="#a1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">T_return&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1bound__mem__functor1.html#a2">operator()</a> (typename <a class="el" href="structsigc_1_1type__trait.html">type_trait</a>&lt;T_arg1&gt;::take _A_a1) const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Execute the wrapped method operating on the stored instance.  <a href="#a2"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">T_obj*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1bound__mem__functor1.html#o0">obj_ptr_</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Pointer to stored object instance.  <a href="#o0"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template &lt;class T_return, class T_obj, class T_arg1&gt;<br>
 class sigc::bound_mem_functor1&lt; T_return, T_obj, T_arg1 &gt;</h3>

<a class="el" href="classsigc_1_1bound__mem__functor1.html">bound_mem_functor1</a> encapsulates a method with 1 arguments and an object instance. 
<p>
Use the convenience function <a class="el" href="group__mem__fun.html#ga56">mem_fun()</a> to create an instance of <a class="el" href="classsigc_1_1bound__mem__functor1.html">bound_mem_functor1</a>.<p>
The following template arguments are used:<ul>
<li><em>T_arg1</em> Argument type used in the definition of <a class="el" href="classsigc_1_1bound__mem__functor1.html#a2">operator()()</a>.</li><li><em>T_return</em> The return type of <a class="el" href="classsigc_1_1bound__mem__functor1.html#a2">operator()()</a>.</li><li><em>T_obj</em> The object type. </li></ul>

<p>
<hr><h2>Member Typedef Documentation</h2>
<a class="anchor" name="w0" doxytag="sigc::bound_mem_functor1::function_type"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" colspan="4">
template &lt;class T_return, class T_obj, class T_arg1&gt; </td>
        </tr>
        <tr>
          <td class="md" nowrap valign="top">typedef <a class="el" href="classsigc_1_1mem__functor1.html#w0">base_type_::function_type</a> <a class="el" href="classsigc_1_1bound__mem__functor1.html">sigc::bound_mem_functor1</a>&lt;T_return, T_obj, T_arg1&gt;::<a class="el" href="classsigc_1_1bound__mem__functor1.html#w0">function_type</a>          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>

<p>
Reimplemented from <a class="el" href="classsigc_1_1mem__functor1.html#w0">sigc::mem_functor1&lt;T_return, T_obj, T_arg1&gt;</a>.    </td>
  </tr>
</table>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="a0" doxytag="sigc::bound_mem_functor1::bound_mem_functor1"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" colspan="4">
template &lt;class T_return, class T_obj, class T_arg1&gt; </td>
        </tr>
        <tr>
          <td class="md" nowrap valign="top"><a class="el" href="classsigc_1_1bound__mem__functor1.html">sigc::bound_mem_functor1</a>&lt;T_return, T_obj, T_arg1&gt;::<a class="el" href="classsigc_1_1bound__mem__functor1.html">bound_mem_functor1</a>           </td>
          <td class="md" valign="top">(</td>
          <td class="md" nowrap valign="top">T_obj*&nbsp;</td>
          <td class="mdname" nowrap> <em>_A_obj</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap><a class="el" href="classsigc_1_1bound__mem__functor1.html#w0">function_type</a>&nbsp;</td>
          <td class="mdname" nowrap> <em>_A_func</em></td>
        </tr>
        <tr>
          <td class="md"></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"><code> [inline]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Constructs a <a class="el" href="classsigc_1_1bound__mem__functor1.html">bound_mem_functor1</a> object that wraps the passed method. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>_A_obj</em>&nbsp;</td><td>Pointer to instance the method will operate on. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>_A_func</em>&nbsp;</td><td>Pointer to method will be invoked from <a class="el" href="classsigc_1_1bound__mem__functor1.html#a2">operator()()</a>. </td></tr>
  </table>
</dl>
    </td>
  </tr>
</table>
<a class="anchor" name="a1" doxytag="sigc::bound_mem_functor1::bound_mem_functor1"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" colspan="4">
template &lt;class T_return, class T_obj, class T_arg1&gt; </td>
        </tr>
        <tr>
          <td class="md" nowrap valign="top"><a class="el" href="classsigc_1_1bound__mem__functor1.html">sigc::bound_mem_functor1</a>&lt;T_return, T_obj, T_arg1&gt;::<a class="el" href="classsigc_1_1bound__mem__functor1.html">bound_mem_functor1</a>           </td>
          <td class="md" valign="top">(</td>
          <td class="md" nowrap valign="top">T_obj&amp;&nbsp;</td>
          <td class="mdname" nowrap> <em>_A_obj</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap><a class="el" href="classsigc_1_1bound__mem__functor1.html#w0">function_type</a>&nbsp;</td>
          <td class="mdname" nowrap> <em>_A_func</em></td>
        </tr>
        <tr>
          <td class="md"></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"><code> [inline]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Constructs a <a class="el" href="classsigc_1_1bound__mem__functor1.html">bound_mem_functor1</a> object that wraps the passed method. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>_A_obj</em>&nbsp;</td><td>Reference to instance the method will operate on. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>_A_func</em>&nbsp;</td><td>Pointer to method will be invoked from <a class="el" href="classsigc_1_1bound__mem__functor1.html#a2">operator()()</a>. </td></tr>
  </table>
</dl>
    </td>
  </tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a2" doxytag="sigc::bound_mem_functor1::operator()"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" colspan="4">
template &lt;class T_return, class T_obj, class T_arg1&gt; </td>
        </tr>
        <tr>
          <td class="md" nowrap valign="top">T_return <a class="el" href="classsigc_1_1bound__mem__functor1.html">sigc::bound_mem_functor1</a>&lt;T_return, T_obj, T_arg1&gt;::operator()           </td>
          <td class="md" valign="top">(</td>
          <td class="md" nowrap valign="top">typename <a class="el" href="structsigc_1_1type__trait.html">type_trait</a>&lt;T_arg1&gt;::take&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>_A_a1</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap> const<code> [inline]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Execute the wrapped method operating on the stored instance. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>_A_a1</em>&nbsp;</td><td>Argument to be passed on to the method. </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The return value of the method invocation. </dd></dl>
    </td>
  </tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="o0" doxytag="sigc::bound_mem_functor1::obj_ptr_"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" colspan="4">
template &lt;class T_return, class T_obj, class T_arg1&gt; </td>
        </tr>
        <tr>
          <td class="md" nowrap valign="top">T_obj* <a class="el" href="classsigc_1_1bound__mem__functor1.html">sigc::bound_mem_functor1</a>&lt;T_return, T_obj, T_arg1&gt;::<a class="el" href="classsigc_1_1bound__mem__functor1.html#o0">obj_ptr_</a>          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Pointer to stored object instance. 
<p>
    </td>
  </tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="mem__fun_8h.html">mem_fun.h</a></ul>
<hr><address><small>
Generated for libsigc++ 2.0 by <a href="http://www.doxygen.org/index.html">
Doxygen</a> 1.3.9.1 &copy;&nbsp;1997-2001</small></address>
</body>
</html>