<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Signal_info (gobject-introspection.GObject_introspection.Signal_info)</title><link rel="stylesheet" href="../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc %%VERSION%%"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> – <a href="../../index.html">gobject-introspection</a> &#x00BB; <a href="../index.html">GObject_introspection</a> &#x00BB; Signal_info</nav><h1>Module <code>GObject_introspection.Signal_info</code></h1></header><aside><p>Signal_info — Struct representing a signal.</p></aside><dl><dt class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><code><span class="keyword">type</span> t</code></dt><dd><p>Signal_info represents a signal. It's a sub-struct of Callable_info and contains a set of flags and a class closure. See Callable_info for information on how to retreive arguments and other metadata from the signal.</p></dd></dl><dl><dt class="spec value" id="val-signalinfo"><a href="#val-signalinfo" class="anchor"></a><code><span class="keyword">val</span> signalinfo : <span><span><a href="index.html#type-t">t</a> Ctypes.structure</span> Ctypes.typ</span></code></dt><dt class="spec value" id="val-true_stops_emit"><a href="#val-true_stops_emit" class="anchor"></a><code><span class="keyword">val</span> true_stops_emit : <span><span><a href="index.html#type-t">t</a> Ctypes.structure</span> Ctypes.ptr</span> <span>&#45;&gt;</span> bool</code></dt><dd><p>Obtain if the returning true in the signal handler will stop the emission of the signal.</p></dd></dl><dl><dt class="spec value" id="val-get_flags"><a href="#val-get_flags" class="anchor"></a><code><span class="keyword">val</span> get_flags : <span><span><a href="index.html#type-t">t</a> Ctypes.structure</span> Ctypes.ptr</span> <span>&#45;&gt;</span> <span><a href="../../Bindings/GSignal/index.html#type-flags">Bindings.GSignal.flags</a> list</span></code></dt><dd><p>Obtain the flags for this signal info. See GSignalFlags for more information about possible flag values.</p></dd></dl><dl><dt class="spec value" id="val-get_class_closure"><a href="#val-get_class_closure" class="anchor"></a><code><span class="keyword">val</span> get_class_closure : <span><span><a href="index.html#type-t">t</a> Ctypes.structure</span> Ctypes.ptr</span> <span>&#45;&gt;</span> <span><span><span><a href="../Callable_info/index.html#type-t">Callable_info.t</a> Ctypes.structure</span> Ctypes.ptr</span> option</span></code></dt><dd><p>Obtain the class closure for this signal if one is set. The class closure is a virtual function on the type that the signal belongs to. If the signal lacks a closure None will be returned. In order to avoid circular call graph between Signal_info and VFunc_info, this function will return a Callable_info. It is upto the user to use GIVSignalInfo.from_callableinfo in order to have the VFunc_info.</p></dd></dl><dl><dt class="spec value" id="val-cast_from_baseinfo"><a href="#val-cast_from_baseinfo" class="anchor"></a><code><span class="keyword">val</span> cast_from_baseinfo : <span><span><a href="../Base_info/index.html#type-t">Base_info.t</a> Ctypes.structure</span> Ctypes.ptr</span> <span>&#45;&gt;</span> <span><span><a href="index.html#type-t">t</a> Ctypes.structure</span> Ctypes.ptr</span></code></dt><dd><p>Just cast OCaml Ctypes base info to signal info.</p></dd></dl><dl><dt class="spec value" id="val-cast_to_baseinfo"><a href="#val-cast_to_baseinfo" class="anchor"></a><code><span class="keyword">val</span> cast_to_baseinfo : <span><span><a href="index.html#type-t">t</a> Ctypes.structure</span> Ctypes.ptr</span> <span>&#45;&gt;</span> <span><span><a href="../Base_info/index.html#type-t">Base_info.t</a> Ctypes.structure</span> Ctypes.ptr</span></code></dt><dd><p>Just cast OCaml Ctypes signal info to base info</p></dd></dl><dl><dt class="spec value" id="val-add_unref_finaliser"><a href="#val-add_unref_finaliser" class="anchor"></a><code><span class="keyword">val</span> add_unref_finaliser : <span><span><a href="index.html#type-t">t</a> Ctypes.structure</span> Ctypes.ptr</span> <span>&#45;&gt;</span> <span><span><a href="index.html#type-t">t</a> Ctypes.structure</span> Ctypes.ptr</span></code></dt><dd><p>Add unref of the C underlying structure whith Gc.finalise.</p></dd></dl><dl><dt class="spec value" id="val-from_baseinfo"><a href="#val-from_baseinfo" class="anchor"></a><code><span class="keyword">val</span> from_baseinfo : <span><span><a href="../Base_info/index.html#type-t">Base_info.t</a> Ctypes.structure</span> Ctypes.ptr</span> <span>&#45;&gt;</span> <span><span><a href="index.html#type-t">t</a> Ctypes.structure</span> Ctypes.ptr</span></code></dt><dd><p>Return a Signal_info.t from a Base_info.t, the underlying C structure ref count is increased and the value is Gc.finalis&quot;ed&quot; with Base_info.baseinfo_unref.</p></dd></dl><dl><dt class="spec value" id="val-to_baseinfo"><a href="#val-to_baseinfo" class="anchor"></a><code><span class="keyword">val</span> to_baseinfo : <span><span><a href="index.html#type-t">t</a> Ctypes.structure</span> Ctypes.ptr</span> <span>&#45;&gt;</span> <span><span><a href="../Base_info/index.html#type-t">Base_info.t</a> Ctypes.structure</span> Ctypes.ptr</span></code></dt><dd><p>Return a Base_info.t from a Signal_info, the underlying C structure ref count is increased and the value is Gc.finalis&quot;ed&quot; with Base_info.baseinfo_unref.</p></dd></dl><dl><dt class="spec value" id="val-cast_from_callableinfo"><a href="#val-cast_from_callableinfo" class="anchor"></a><code><span class="keyword">val</span> cast_from_callableinfo : <span><span><a href="../Callable_info/index.html#type-t">Callable_info.t</a> Ctypes.structure</span> Ctypes.ptr</span> <span>&#45;&gt;</span> <span><span><a href="index.html#type-t">t</a> Ctypes.structure</span> Ctypes.ptr</span></code></dt><dd><p>Just cast OCaml Ctypes callable info to signal info.</p></dd></dl><dl><dt class="spec value" id="val-cast_to_callableinfo"><a href="#val-cast_to_callableinfo" class="anchor"></a><code><span class="keyword">val</span> cast_to_callableinfo : <span><span><a href="index.html#type-t">t</a> Ctypes.structure</span> Ctypes.ptr</span> <span>&#45;&gt;</span> <span><span><a href="../Callable_info/index.html#type-t">Callable_info.t</a> Ctypes.structure</span> Ctypes.ptr</span></code></dt><dd><p>Just cast OCaml Ctypes signal info to callable info</p></dd></dl><dl><dt class="spec value" id="val-from_callableinfo"><a href="#val-from_callableinfo" class="anchor"></a><code><span class="keyword">val</span> from_callableinfo : <span><span><a href="../Callable_info/index.html#type-t">Callable_info.t</a> Ctypes.structure</span> Ctypes.ptr</span> <span>&#45;&gt;</span> <span><span><a href="index.html#type-t">t</a> Ctypes.structure</span> Ctypes.ptr</span></code></dt><dd><p>Return a Signal_info.t from a Callable_info.t, the underlying C structure ref count is increased and the value is Gc.finalis&quot;ed&quot; with Base_info.baseinfo_unref.</p></dd></dl><dl><dt class="spec value" id="val-to_callableinfo"><a href="#val-to_callableinfo" class="anchor"></a><code><span class="keyword">val</span> to_callableinfo : <span><span><a href="index.html#type-t">t</a> Ctypes.structure</span> Ctypes.ptr</span> <span>&#45;&gt;</span> <span><span><a href="../Callable_info/index.html#type-t">Callable_info.t</a> Ctypes.structure</span> Ctypes.ptr</span></code></dt><dd><p>Return a Callable_info.t from a Signal_info, the underlying C structure ref count is increased and the value is Gc.finalis&quot;ed&quot; with Base_info.baseinfo_unref.</p></dd></dl></div></body></html>