← Back to branch summary

~kklimonda/ubuntu/natty/glibmm2.4/update

« back to all changes in this revision

Viewing changes to docs/reference/html/classGlib_1_1SignalIO.html

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2009-03-16 14:26:05 UTC
  • mfrom: (1.2.35 upstream)
  • Revision ID: james.westby@ubuntu.com-20090316142605-gj2oyabw69a9b9li
Tags: 2.20.0-0ubuntu1
New upstream version

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/html/classGlib_1_1SignalIO.html
19
19
 
20
20
<!-- begin main content -->
21
21
<div id="content">
22
 
<!-- Generated by Doxygen 1.5.6 -->
 
22
<!-- Generated by Doxygen 1.5.8 -->
23
23
  <div class="navpath"><a class="el" href="namespaceGlib.html">Glib</a>::<a class="el" href="classGlib_1_1SignalIO.html">SignalIO</a>
24
24
  </div>
25
25
<div class="contents">
39
39
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Connects an I/O channel.  <a href="#779227bae6390b055243d1f3083a5388"></a><br></td></tr>
40
40
</table>
41
41
<hr><h2>Member Function Documentation</h2>
42
 
<a class="anchor" name="c205b21234d26094e75e0931c968c5d2"></a><!-- doxytag: member="Glib::SignalIO::connect" ref="c205b21234d26094e75e0931c968c5d2" args="(const sigc::slot&lt; bool, IOCondition &gt; &amp;slot, int fd, IOCondition condition, int priority=PRIORITY_DEFAULT)" -->
43
 
<div class="memitem">
44
 
<div class="memproto">
45
 
      <table class="memname">
46
 
        <tr>
47
 
          <td class="memname">sigc::connection Glib::SignalIO::connect           </td>
48
 
          <td>(</td>
49
 
          <td class="paramtype">const sigc::slot&lt;bool, <a class="el" href="group__MainLoop.html#gbd96381793b70d4ae32c725926990918">IOCondition</a>&gt;&amp;&nbsp;</td>
50
 
          <td class="paramname"> <em>slot</em>, </td>
51
 
        </tr>
52
 
        <tr>
53
 
          <td class="paramkey"></td>
54
 
          <td></td>
55
 
          <td class="paramtype">int&nbsp;</td>
56
 
          <td class="paramname"> <em>fd</em>, </td>
57
 
        </tr>
58
 
        <tr>
59
 
          <td class="paramkey"></td>
60
 
          <td></td>
61
 
          <td class="paramtype"><a class="el" href="group__MainLoop.html#gbd96381793b70d4ae32c725926990918">IOCondition</a>&nbsp;</td>
62
 
          <td class="paramname"> <em>condition</em>, </td>
63
 
        </tr>
64
 
        <tr>
65
 
          <td class="paramkey"></td>
66
 
          <td></td>
67
 
          <td class="paramtype">int&nbsp;</td>
68
 
          <td class="paramname"> <em>priority</em> = <code>PRIORITY_DEFAULT</code></td><td>&nbsp;</td>
69
 
        </tr>
70
 
        <tr>
71
 
          <td></td>
72
 
          <td>)</td>
73
 
          <td></td><td></td><td></td>
74
 
        </tr>
75
 
      </table>
76
 
</div>
77
 
<div class="memdoc">
78
 
 
79
 
<p>
80
 
Connects an I/O handler. 
81
 
<p>
82
 
<div class="fragment"><pre class="fragment"> <a class="code" href="group__MainLoop.html#gf391654b755a32169d18be4835677376" title="Convenience I/O signal.">Glib::signal_io</a>().connect(<a class="codeRef" doxygen="libstdc++.tag.xml:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/group__s20__3__7__adaptors.html#ga1">sigc::ptr_fun</a>(&amp;io_handler), fd, <a class="code" href="group__MainLoop.html#ggbd96381793b70d4ae32c725926990918f244f3e8c1c9525762f3630befd76336">Glib::IO_IN</a> | <a class="code" href="group__MainLoop.html#ggbd96381793b70d4ae32c725926990918b5dcc0e24c236c027b041d362dcff35b">Glib::IO_HUP</a>);
83
 
</pre></div> is equivalent to: <div class="fragment"><pre class="fragment"> <span class="keyword">const</span> <a class="code" href="classGlib_1_1RefPtr.html" title="RefPtr&amp;lt;&amp;gt; is a reference-counting shared smartpointer.">Glib::RefPtr&lt;Glib::IOSource&gt;</a> io_source = <a class="code" href="classGlib_1_1Source.html#eaffb039abf99982d7a89403bca71569">Glib::IOSource::create</a>(fd, <a class="code" href="group__MainLoop.html#ggbd96381793b70d4ae32c725926990918f244f3e8c1c9525762f3630befd76336">Glib::IO_IN</a> | <a class="code" href="group__MainLoop.html#ggbd96381793b70d4ae32c725926990918b5dcc0e24c236c027b041d362dcff35b">Glib::IO_HUP</a>);
84
 
 io_source-&gt;connect(<a class="codeRef" doxygen="libstdc++.tag.xml:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/group__s20__3__7__adaptors.html#ga1">sigc::ptr_fun</a>(&amp;io_handler));
85
 
 io_source-&gt;attach(<a class="code" href="classGlib_1_1MainContext.html#1502cbed045a9fb27d18c6975e1d255d" title="Returns the default main context.">Glib::MainContext::get_default</a>());
86
 
</pre></div> <dl compact><dt><b>Parameters:</b></dt><dd>
87
 
  <table border="0" cellspacing="2" cellpadding="0">
88
 
    <tr><td valign="top"></td><td valign="top"><em>slot</em>&nbsp;</td><td>A slot to call when polling <em>fd</em> results in an event that matches <em>condition</em>. The event will be passed as a parameter to <em>slot</em>. If <em>io_handler</em> returns <code>false</code> the signal is disconnected. </td></tr>
89
 
    <tr><td valign="top"></td><td valign="top"><em>fd</em>&nbsp;</td><td>The file descriptor (or a <code>HANDLE</code> on Win32 systems) to watch. </td></tr>
90
 
    <tr><td valign="top"></td><td valign="top"><em>condition</em>&nbsp;</td><td>The conditions to watch for. </td></tr>
91
 
    <tr><td valign="top"></td><td valign="top"><em>priority</em>&nbsp;</td><td>The priority of the new event source. </td></tr>
92
 
  </table>
93
 
</dl>
94
 
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A connection handle, which can be used to disconnect the handler. </dd></dl>
95
 
 
96
 
</div>
97
 
</div><p>
98
42
<a class="anchor" name="779227bae6390b055243d1f3083a5388"></a><!-- doxytag: member="Glib::SignalIO::connect" ref="779227bae6390b055243d1f3083a5388" args="(const sigc::slot&lt; bool, IOCondition &gt; &amp;slot, const Glib::RefPtr&lt; IOChannel &gt; &amp;channel, IOCondition condition, int priority=PRIORITY_DEFAULT)" -->
99
43
<div class="memitem">
100
44
<div class="memproto">
151
95
 
152
96
</div>
153
97
</div><p>
 
98
<a class="anchor" name="c205b21234d26094e75e0931c968c5d2"></a><!-- doxytag: member="Glib::SignalIO::connect" ref="c205b21234d26094e75e0931c968c5d2" args="(const sigc::slot&lt; bool, IOCondition &gt; &amp;slot, int fd, IOCondition condition, int priority=PRIORITY_DEFAULT)" -->
 
99
<div class="memitem">
 
100
<div class="memproto">
 
101
      <table class="memname">
 
102
        <tr>
 
103
          <td class="memname">sigc::connection Glib::SignalIO::connect           </td>
 
104
          <td>(</td>
 
105
          <td class="paramtype">const sigc::slot&lt;bool, <a class="el" href="group__MainLoop.html#gbd96381793b70d4ae32c725926990918">IOCondition</a>&gt;&amp;&nbsp;</td>
 
106
          <td class="paramname"> <em>slot</em>, </td>
 
107
        </tr>
 
108
        <tr>
 
109
          <td class="paramkey"></td>
 
110
          <td></td>
 
111
          <td class="paramtype">int&nbsp;</td>
 
112
          <td class="paramname"> <em>fd</em>, </td>
 
113
        </tr>
 
114
        <tr>
 
115
          <td class="paramkey"></td>
 
116
          <td></td>
 
117
          <td class="paramtype"><a class="el" href="group__MainLoop.html#gbd96381793b70d4ae32c725926990918">IOCondition</a>&nbsp;</td>
 
118
          <td class="paramname"> <em>condition</em>, </td>
 
119
        </tr>
 
120
        <tr>
 
121
          <td class="paramkey"></td>
 
122
          <td></td>
 
123
          <td class="paramtype">int&nbsp;</td>
 
124
          <td class="paramname"> <em>priority</em> = <code>PRIORITY_DEFAULT</code></td><td>&nbsp;</td>
 
125
        </tr>
 
126
        <tr>
 
127
          <td></td>
 
128
          <td>)</td>
 
129
          <td></td><td></td><td></td>
 
130
        </tr>
 
131
      </table>
 
132
</div>
 
133
<div class="memdoc">
 
134
 
 
135
<p>
 
136
Connects an I/O handler. 
 
137
<p>
 
138
<div class="fragment"><pre class="fragment"> <a class="code" href="group__MainLoop.html#gf391654b755a32169d18be4835677376" title="Convenience I/O signal.">Glib::signal_io</a>().connect(<a class="codeRef" doxygen="libstdc++.tag.xml:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/group__s20__3__7__adaptors.html#ga1">sigc::ptr_fun</a>(&amp;io_handler), fd, <a class="code" href="group__MainLoop.html#ggbd96381793b70d4ae32c725926990918f244f3e8c1c9525762f3630befd76336">Glib::IO_IN</a> | <a class="code" href="group__MainLoop.html#ggbd96381793b70d4ae32c725926990918b5dcc0e24c236c027b041d362dcff35b">Glib::IO_HUP</a>);
 
139
</pre></div> is equivalent to: <div class="fragment"><pre class="fragment"> <span class="keyword">const</span> <a class="code" href="classGlib_1_1RefPtr.html" title="RefPtr&amp;lt;&amp;gt; is a reference-counting shared smartpointer.">Glib::RefPtr&lt;Glib::IOSource&gt;</a> io_source = <a class="code" href="classGlib_1_1Source.html#eaffb039abf99982d7a89403bca71569">Glib::IOSource::create</a>(fd, <a class="code" href="group__MainLoop.html#ggbd96381793b70d4ae32c725926990918f244f3e8c1c9525762f3630befd76336">Glib::IO_IN</a> | <a class="code" href="group__MainLoop.html#ggbd96381793b70d4ae32c725926990918b5dcc0e24c236c027b041d362dcff35b">Glib::IO_HUP</a>);
 
140
 io_source-&gt;connect(<a class="codeRef" doxygen="libstdc++.tag.xml:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/group__s20__3__7__adaptors.html#ga1">sigc::ptr_fun</a>(&amp;io_handler));
 
141
 io_source-&gt;attach(<a class="code" href="classGlib_1_1MainContext.html#1502cbed045a9fb27d18c6975e1d255d" title="Returns the default main context.">Glib::MainContext::get_default</a>());
 
142
</pre></div> <dl compact><dt><b>Parameters:</b></dt><dd>
 
143
  <table border="0" cellspacing="2" cellpadding="0">
 
144
    <tr><td valign="top"></td><td valign="top"><em>slot</em>&nbsp;</td><td>A slot to call when polling <em>fd</em> results in an event that matches <em>condition</em>. The event will be passed as a parameter to <em>slot</em>. If <em>io_handler</em> returns <code>false</code> the signal is disconnected. </td></tr>
 
145
    <tr><td valign="top"></td><td valign="top"><em>fd</em>&nbsp;</td><td>The file descriptor (or a <code>HANDLE</code> on Win32 systems) to watch. </td></tr>
 
146
    <tr><td valign="top"></td><td valign="top"><em>condition</em>&nbsp;</td><td>The conditions to watch for. </td></tr>
 
147
    <tr><td valign="top"></td><td valign="top"><em>priority</em>&nbsp;</td><td>The priority of the new event source. </td></tr>
 
148
  </table>
 
149
</dl>
 
150
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A connection handle, which can be used to disconnect the handler. </dd></dl>
 
151
 
 
152
</div>
 
153
</div><p>
154
154
<hr>The documentation for this class was generated from the following file:<ul>
155
155
<li><a class="el" href="main_8h.html">main.h</a></ul>
156
156
</div>
158
158
 
159
159
<hr><address><small>
160
160
Generated for glibmm 2.4 by <a href="http://www.doxygen.org/index.html">
161
 
Doxygen</a> 1.5.6 &copy;&nbsp;1997-2001</small></address>
 
161
Doxygen</a> 1.5.8 &copy;&nbsp;1997-2001</small></address>
162
162
</body>
163
163
</html>