Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > 0be7620be6a1578fbd49765844864a01 > files > 732

ocaml-lablgtk2-doc-2.14.0-2mdv2010.0.i586.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="Start" href="index.html">
<link rel="previous" href="Pango.html">
<link rel="next" href="GtkObject.html">
<link rel="Up" href="index.html">
<title>LablGTK : GtkSignal</title>
</head>
<body>
<div class="navbar"><a href="Pango.html">Previous</a>
&nbsp;<a href="index.html">Up</a>
&nbsp;<a href="GtkObject.html">Next</a>
</div>
<center><h1>Module <a href="type_GtkSignal.html">GtkSignal</a></h1></center>
<br>
<pre><span class="keyword">module</span> GtkSignal: <code class="code">sig</code> <a href="GtkSignal.html">..</a> <code class="code">end</code></pre>Signals<br>
<hr width="100%">
<br>
Signals<br>
<pre><span class="keyword">type</span> <a name="TYPEid"></a><code class="type"></code>id </pre>

<pre><span class="keyword">type</span> <a name="TYPEmarshaller"></a><code class="type">'a</code> marshaller = <code class="type">'a -> <a href="Gobject.Closure.html#TYPEargv">Gobject.Closure.argv</a> -> unit</code> </pre>

<br><code><span class="keyword">type</span> <a name="TYPEt"></a><code class="type">('a, 'b)</code> t = {</code><table class="typetable">
<tr>
<td align="left" valign="top" >
<code>&nbsp;&nbsp;</code></td>
<td align="left" valign="top" >
<code>name&nbsp;: <code class="type">string</code>;</code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code>&nbsp;&nbsp;</code></td>
<td align="left" valign="top" >
<code>classe&nbsp;: <code class="type">'a</code>;</code></td>

</tr>
<tr>
<td align="left" valign="top" >
<code>&nbsp;&nbsp;</code></td>
<td align="left" valign="top" >
<code>marshaller&nbsp;: <code class="type">'b <a href="GtkSignal.html#TYPEmarshaller">marshaller</a></code>;</code></td>

</tr></table>
}

<div class="info">
When writing marshallers, beware that the list omits the 0th
       argument of argv, which is the referent object<br>
</div>

<pre><span class="keyword">val</span> <a name="VALstop_emit"></a>stop_emit : <code class="type">unit -> unit</code></pre><div class="info">
Call <code class="code">stop_emit ()</code> in a callback to prohibit further handling
       of the current signal invocation, by calling <code class="code">emit_stop_by_name</code>.
       Be careful about where you use it, since the concept of current
       signal may be tricky.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALconnect"></a>connect : <code class="type">sgn:('a, 'b) <a href="GtkSignal.html#TYPEt">t</a> -><br>       callback:'b -> ?after:bool -> 'a <a href="Gobject.html#TYPEobj">Gobject.obj</a> -> <a href="GtkSignal.html#TYPEid">id</a></code></pre><div class="info">
You may use <code class="code">stop_emit</code> inside the callback<br>
</div>
<pre><span class="keyword">val</span> <a name="VALuser_handler"></a>user_handler : <code class="type">(exn -> unit) Pervasives.ref</code></pre><div class="info">
A hook to allow changing the behaviour of exceptions in callbacks
       The default behaviour of printing the exception and ignoring it
       is obtained when <code class="code">user_handler</code> is set to <code class="code">Pervasives.raise</code><br>
</div>
<pre><span class="keyword">val</span> <a name="VALconnect_by_name"></a>connect_by_name : <code class="type">'a <a href="Gobject.html#TYPEobj">Gobject.obj</a> -><br>       name:string -> callback:<a href="Gobject.html#TYPEg_closure">Gobject.g_closure</a> -> after:bool -> <a href="GtkSignal.html#TYPEid">id</a></code></pre><pre><span class="keyword">val</span> <a name="VALdisconnect"></a>disconnect : <code class="type">'a <a href="Gobject.html#TYPEobj">Gobject.obj</a> -> <a href="GtkSignal.html#TYPEid">id</a> -> unit</code></pre><pre><span class="keyword">val</span> <a name="VALemit_stop_by_name"></a>emit_stop_by_name : <code class="type">'a <a href="Gobject.html#TYPEobj">Gobject.obj</a> -> name:string -> unit</code></pre><div class="info">
Unsafe: use <code class="code">stop_emit</code> instead.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALhandler_block"></a>handler_block : <code class="type">'a <a href="Gobject.html#TYPEobj">Gobject.obj</a> -> <a href="GtkSignal.html#TYPEid">id</a> -> unit</code></pre><pre><span class="keyword">val</span> <a name="VALhandler_unblock"></a>handler_unblock : <code class="type">'a <a href="Gobject.html#TYPEobj">Gobject.obj</a> -> <a href="GtkSignal.html#TYPEid">id</a> -> unit</code></pre><br>
<a name="4_Marshallers"></a>
<h4>Marshallers</h4> Some marshaller functions, to build signals<br>
<pre><span class="keyword">val</span> <a name="VALmarshal_unit"></a>marshal_unit : <code class="type">(unit -> unit) <a href="GtkSignal.html#TYPEmarshaller">marshaller</a></code></pre><pre><span class="keyword">val</span> <a name="VALmarshal_int"></a>marshal_int : <code class="type">(int -> unit) <a href="GtkSignal.html#TYPEmarshaller">marshaller</a></code></pre><pre><span class="keyword">val</span> <a name="VALmarshal_string"></a>marshal_string : <code class="type">(string -> unit) <a href="GtkSignal.html#TYPEmarshaller">marshaller</a></code></pre><pre><span class="keyword">val</span> <a name="VALmarshal1"></a>marshal1 : <code class="type">'a <a href="Gobject.html#TYPEdata_conv">Gobject.data_conv</a> -> string -> ('a -> unit) <a href="GtkSignal.html#TYPEmarshaller">marshaller</a></code></pre><pre><span class="keyword">val</span> <a name="VALmarshal2"></a>marshal2 : <code class="type">'a <a href="Gobject.html#TYPEdata_conv">Gobject.data_conv</a> -><br>       'b <a href="Gobject.html#TYPEdata_conv">Gobject.data_conv</a> -> string -> ('a -> 'b -> unit) <a href="GtkSignal.html#TYPEmarshaller">marshaller</a></code></pre><pre><span class="keyword">val</span> <a name="VALmarshal3"></a>marshal3 : <code class="type">'a <a href="Gobject.html#TYPEdata_conv">Gobject.data_conv</a> -><br>       'b <a href="Gobject.html#TYPEdata_conv">Gobject.data_conv</a> -><br>       'c <a href="Gobject.html#TYPEdata_conv">Gobject.data_conv</a> -><br>       string -> ('a -> 'b -> 'c -> unit) <a href="GtkSignal.html#TYPEmarshaller">marshaller</a></code></pre><pre><span class="keyword">val</span> <a name="VALmarshal4"></a>marshal4 : <code class="type">'a <a href="Gobject.html#TYPEdata_conv">Gobject.data_conv</a> -><br>       'b <a href="Gobject.html#TYPEdata_conv">Gobject.data_conv</a> -><br>       'c <a href="Gobject.html#TYPEdata_conv">Gobject.data_conv</a> -><br>       'd <a href="Gobject.html#TYPEdata_conv">Gobject.data_conv</a> -><br>       string -> ('a -> 'b -> 'c -> 'd -> unit) <a href="GtkSignal.html#TYPEmarshaller">marshaller</a></code></pre><pre><span class="keyword">val</span> <a name="VALmarshal5"></a>marshal5 : <code class="type">'a <a href="Gobject.html#TYPEdata_conv">Gobject.data_conv</a> -><br>       'b <a href="Gobject.html#TYPEdata_conv">Gobject.data_conv</a> -><br>       'c <a href="Gobject.html#TYPEdata_conv">Gobject.data_conv</a> -><br>       'd <a href="Gobject.html#TYPEdata_conv">Gobject.data_conv</a> -><br>       'e <a href="Gobject.html#TYPEdata_conv">Gobject.data_conv</a> -><br>       string -> ('a -> 'b -> 'c -> 'd -> 'e -> unit) <a href="GtkSignal.html#TYPEmarshaller">marshaller</a></code></pre><pre><span class="keyword">val</span> <a name="VALmarshal6"></a>marshal6 : <code class="type">'a <a href="Gobject.html#TYPEdata_conv">Gobject.data_conv</a> -><br>       'b <a href="Gobject.html#TYPEdata_conv">Gobject.data_conv</a> -><br>       'c <a href="Gobject.html#TYPEdata_conv">Gobject.data_conv</a> -><br>       'd <a href="Gobject.html#TYPEdata_conv">Gobject.data_conv</a> -><br>       'e <a href="Gobject.html#TYPEdata_conv">Gobject.data_conv</a> -><br>       'f <a href="Gobject.html#TYPEdata_conv">Gobject.data_conv</a> -><br>       string -> ('a -> 'b -> 'c -> 'd -> 'e -> 'f -> unit) <a href="GtkSignal.html#TYPEmarshaller">marshaller</a></code></pre><pre><span class="keyword">val</span> <a name="VALmarshal0_ret"></a>marshal0_ret : <code class="type">ret:'a <a href="Gobject.html#TYPEdata_conv">Gobject.data_conv</a> -> (unit -> 'a) <a href="GtkSignal.html#TYPEmarshaller">marshaller</a></code></pre><pre><span class="keyword">val</span> <a name="VALmarshal1_ret"></a>marshal1_ret : <code class="type">ret:'a <a href="Gobject.html#TYPEdata_conv">Gobject.data_conv</a> -><br>       'b <a href="Gobject.html#TYPEdata_conv">Gobject.data_conv</a> -> string -> ('b -> 'a) <a href="GtkSignal.html#TYPEmarshaller">marshaller</a></code></pre><pre><span class="keyword">val</span> <a name="VALmarshal2_ret"></a>marshal2_ret : <code class="type">ret:'a <a href="Gobject.html#TYPEdata_conv">Gobject.data_conv</a> -><br>       'b <a href="Gobject.html#TYPEdata_conv">Gobject.data_conv</a> -><br>       'c <a href="Gobject.html#TYPEdata_conv">Gobject.data_conv</a> -> string -> ('b -> 'c -> 'a) <a href="GtkSignal.html#TYPEmarshaller">marshaller</a></code></pre><pre><span class="keyword">val</span> <a name="VALmarshal3_ret"></a>marshal3_ret : <code class="type">ret:'a <a href="Gobject.html#TYPEdata_conv">Gobject.data_conv</a> -><br>       'b <a href="Gobject.html#TYPEdata_conv">Gobject.data_conv</a> -><br>       'c <a href="Gobject.html#TYPEdata_conv">Gobject.data_conv</a> -><br>       'd <a href="Gobject.html#TYPEdata_conv">Gobject.data_conv</a> -> string -> ('b -> 'c -> 'd -> 'a) <a href="GtkSignal.html#TYPEmarshaller">marshaller</a></code></pre><pre><span class="keyword">val</span> <a name="VALmarshal4_ret"></a>marshal4_ret : <code class="type">ret:'a <a href="Gobject.html#TYPEdata_conv">Gobject.data_conv</a> -><br>       'b <a href="Gobject.html#TYPEdata_conv">Gobject.data_conv</a> -><br>       'c <a href="Gobject.html#TYPEdata_conv">Gobject.data_conv</a> -><br>       'd <a href="Gobject.html#TYPEdata_conv">Gobject.data_conv</a> -><br>       'e <a href="Gobject.html#TYPEdata_conv">Gobject.data_conv</a> -><br>       string -> ('b -> 'c -> 'd -> 'e -> 'a) <a href="GtkSignal.html#TYPEmarshaller">marshaller</a></code></pre><br>
<a name="4_Emitterfunctions"></a>
<h4>Emitter functions</h4><br>
<pre><span class="keyword">val</span> <a name="VALemit"></a>emit : <code class="type">'a <a href="Gobject.html#TYPEobj">Gobject.obj</a> -><br>       sgn:('a, 'b) <a href="GtkSignal.html#TYPEt">t</a> -><br>       emitter:(cont:('c <a href="Gobject.html#TYPEdata_set">Gobject.data_set</a> array -> 'd) -> 'b) -><br>       conv:(<a href="Gobject.html#TYPEg_value">Gobject.g_value</a> -> 'd) -> 'b</code></pre><pre><span class="keyword">val</span> <a name="VALemit_unit"></a>emit_unit : <code class="type">'a <a href="Gobject.html#TYPEobj">Gobject.obj</a> -> sgn:('a, unit -> unit) <a href="GtkSignal.html#TYPEt">t</a> -> unit</code></pre><pre><span class="keyword">val</span> <a name="VALemit_int"></a>emit_int : <code class="type">'a <a href="Gobject.html#TYPEobj">Gobject.obj</a> -> sgn:('a, int -> unit) <a href="GtkSignal.html#TYPEt">t</a> -> int -> unit</code></pre><br>
<a name="4_Defaulthandleroverride"></a>
<h4>Default handler override</h4><br>
<pre><span class="keyword">val</span> <a name="VALoverride_class_closure"></a>override_class_closure : <code class="type">('a, 'b) <a href="GtkSignal.html#TYPEt">t</a> -> <a href="Gobject.html#TYPEg_type">Gobject.g_type</a> -> <a href="Gobject.html#TYPEg_closure">Gobject.g_closure</a> -> unit</code></pre><pre><span class="keyword">val</span> <a name="VALchain_from_overridden"></a>chain_from_overridden : <code class="type"><a href="Gobject.Closure.html#TYPEargv">Gobject.Closure.argv</a> -> unit</code></pre></body></html>