docs/reference/html/gi-GISignalInfo.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <title>GISignalInfo: GObject Introspection Reference Manual</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
   7 <link rel="home" href="index.html" title="GObject Introspection Reference Manual">
   8 <link rel="up" href="ch01.html" title="GIRepository">
   9 <link rel="prev" href="gi-GICallbackInfo.html" title="GICallbackInfo">
  10 <link rel="next" href="gi-GIVFuncInfo.html" title="GIVFuncInfo">
  11 <meta name="generator" content="GTK-Doc V1.25.1 (XML mode)">
  12 <link rel="stylesheet" href="style.css" type="text/css">
  13 </head>
  14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
  16 <td width="100%" align="left" class="shortcuts">
  17 <a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span>
  18                   <a href="#gi-GISignalInfo.description" class="shortcut">Description</a></span>
  19 </td>
  20 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
  21 <td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
  22 <td><a accesskey="p" href="gi-GICallbackInfo.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
  23 <td><a accesskey="n" href="gi-GIVFuncInfo.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
  24 </tr></table>
  25 <div class="refentry">
  26 <a name="gi-GISignalInfo"></a><div class="titlepage"></div>
  27 <div class="refnamediv"><table width="100%"><tr>
  28 <td valign="top">
  29 <h2><span class="refentrytitle"><a name="gi-GISignalInfo.top_of_page"></a>GISignalInfo</span></h2>
  30 <p>GISignalInfo — Struct representing a signal</p>
  31 </td>
  32 <td class="gallery_image" valign="top" align="right"></td>
  33 </tr></table></div>
  34 <div class="refsect1">
  35 <a name="gi-GISignalInfo.functions"></a><h2>Functions</h2>
  36 <div class="informaltable"><table class="informaltable" width="100%" border="0">
  37 <colgroup>
  38 <col width="150px" class="functions_return">
  39 <col class="functions_name">
  40 </colgroup>
  41 <tbody>
  42 <tr>
  43 <td class="define_keyword">#define</td>
  44 <td class="function_name">
  45 <a class="link" href="gi-GISignalInfo.html#GI-IS-SIGNAL-INFO:CAPS" title="GI_IS_SIGNAL_INFO()">GI_IS_SIGNAL_INFO</a><span class="c_punctuation">()</span>
  46 </td>
  47 </tr>
  48 <tr>
  49 <td class="function_type">
  50 <span class="returnvalue">GSignalFlags</span>
  51 </td>
  52 <td class="function_name">
  53 <a class="link" href="gi-GISignalInfo.html#g-signal-info-get-flags" title="g_signal_info_get_flags ()">g_signal_info_get_flags</a> <span class="c_punctuation">()</span>
  54 </td>
  55 </tr>
  56 <tr>
  57 <td class="function_type">
  58 <a class="link" href="gi-GIVFuncInfo.html#GIVFuncInfo" title="GIVFuncInfo"><span class="returnvalue">GIVFuncInfo</span></a> *
  59 </td>
  60 <td class="function_name">
  61 <a class="link" href="gi-GISignalInfo.html#g-signal-info-get-class-closure" title="g_signal_info_get_class_closure ()">g_signal_info_get_class_closure</a> <span class="c_punctuation">()</span>
  62 </td>
  63 </tr>
  64 <tr>
  65 <td class="function_type">
  66 <span class="returnvalue">gboolean</span>
  67 </td>
  68 <td class="function_name">
  69 <a class="link" href="gi-GISignalInfo.html#g-signal-info-true-stops-emit" title="g_signal_info_true_stops_emit ()">g_signal_info_true_stops_emit</a> <span class="c_punctuation">()</span>
  70 </td>
  71 </tr>
  72 </tbody>
  73 </table></div>
  74 </div>
  75 <div class="refsect1">
  76 <a name="gi-GISignalInfo.other"></a><h2>Types and Values</h2>
  77 <div class="informaltable"><table class="informaltable" width="100%" border="0">
  78 <colgroup>
  79 <col width="150px" class="name">
  80 <col class="description">
  81 </colgroup>
  82 <tbody><tr>
  83 <td class="typedef_keyword">typedef</td>
  84 <td class="function_name"><a class="link" href="gi-GISignalInfo.html#GISignalInfo" title="GISignalInfo">GISignalInfo</a></td>
  85 </tr></tbody>
  86 </table></div>
  87 </div>
  88 <div class="refsect1">
  89 <a name="gi-GISignalInfo.description"></a><h2>Description</h2>
  90 <p>GISignalInfo represents a signal. It's a sub-struct of <a class="link" href="gi-GICallableInfo.html#GICallableInfo" title="GICallableInfo"><span class="type">GICallableInfo</span></a>
  91 and contains a set of flags and a class closure.</p>
  92 <p>See <a class="link" href="gi-GICallableInfo.html#GICallableInfo" title="GICallableInfo"><span class="type">GICallableInfo</span></a> for information on how to retreive arguments
  93 and other metadata from the signal.</p>
  94 <div class="refsect1">
  95 <a name="gi-gisignalinfo.struct-hierarchy"></a><h2>Struct hierarchy</h2>
  96 <pre class="synopsis">
  97   <a class="link" href="gi-GIBaseInfo.html" title="GIBaseInfo">GIBaseInfo</a>
  98    +----<a class="link" href="gi-GICallableInfo.html" title="GICallableInfo">GICallableInfo</a>
  99          +----<a class="link" href="gi-GIFunctionInfo.html" title="GIFunctionInfo">GIFunctionInfo</a>
 100          +----GISignalInfo
 101          +----<a class="link" href="gi-GIVFuncInfo.html" title="GIVFuncInfo">GIVFuncInfo</a>
 102 </pre>
 103 </div>
 104 </div>
 105 <div class="refsect1">
 106 <a name="gi-GISignalInfo.functions_details"></a><h2>Functions</h2>
 107 <div class="refsect2">
 108 <a name="GI-IS-SIGNAL-INFO:CAPS"></a><h3>GI_IS_SIGNAL_INFO()</h3>
 109 <pre class="programlisting">#define             GI_IS_SIGNAL_INFO(info)</pre>
 110 <p>Checks if <em class="parameter"><code>info</code></em>
 111  is a <a class="link" href="gi-GISignalInfo.html#GISignalInfo" title="GISignalInfo"><span class="type">GISignalInfo</span></a>.</p>
 112 <div class="refsect3">
 113 <a name="GI-IS-SIGNAL-INFO.parameters"></a><h4>Parameters</h4>
 114 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 115 <colgroup>
 116 <col width="150px" class="parameters_name">
 117 <col class="parameters_description">
 118 <col width="200px" class="parameters_annotations">
 119 </colgroup>
 120 <tbody><tr>
 121 <td class="parameter_name"><p>info</p></td>
 122 <td class="parameter_description"><p>an info structure</p></td>
 123 <td class="parameter_annotations"> </td>
 124 </tr></tbody>
 125 </table></div>
 126 </div>
 127 </div>
 128 <hr>
 129 <div class="refsect2">
 130 <a name="g-signal-info-get-flags"></a><h3>g_signal_info_get_flags ()</h3>
 131 <pre class="programlisting"><span class="returnvalue">GSignalFlags</span>
 132 g_signal_info_get_flags (<em class="parameter"><code><a class="link" href="gi-GISignalInfo.html#GISignalInfo" title="GISignalInfo"><span class="type">GISignalInfo</span></a> *info</code></em>);</pre>
 133 <p>Obtain the flags for this signal info. See <span class="type">GSignalFlags</span> for
 134 more information about possible flag values.</p>
 135 <div class="refsect3">
 136 <a name="g-signal-info-get-flags.parameters"></a><h4>Parameters</h4>
 137 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 138 <colgroup>
 139 <col width="150px" class="parameters_name">
 140 <col class="parameters_description">
 141 <col width="200px" class="parameters_annotations">
 142 </colgroup>
 143 <tbody><tr>
 144 <td class="parameter_name"><p>info</p></td>
 145 <td class="parameter_description"><p>a <a class="link" href="gi-GISignalInfo.html#GISignalInfo" title="GISignalInfo"><span class="type">GISignalInfo</span></a></p></td>
 146 <td class="parameter_annotations"> </td>
 147 </tr></tbody>
 148 </table></div>
 149 </div>
 150 <div class="refsect3">
 151 <a name="g-signal-info-get-flags.returns"></a><h4>Returns</h4>
 152 <p> the flags</p>
 153 </div>
 154 </div>
 155 <hr>
 156 <div class="refsect2">
 157 <a name="g-signal-info-get-class-closure"></a><h3>g_signal_info_get_class_closure ()</h3>
 158 <pre class="programlisting"><a class="link" href="gi-GIVFuncInfo.html#GIVFuncInfo" title="GIVFuncInfo"><span class="returnvalue">GIVFuncInfo</span></a> *
 159 g_signal_info_get_class_closure (<em class="parameter"><code><a class="link" href="gi-GISignalInfo.html#GISignalInfo" title="GISignalInfo"><span class="type">GISignalInfo</span></a> *info</code></em>);</pre>
 160 <p>Obtain the class closure for this signal if one is set. The class
 161 closure is a virtual function on the type that the signal belongs to.
 162 If the signal lacks a closure <code class="literal">NULL</code> will be returned.</p>
 163 <div class="refsect3">
 164 <a name="g-signal-info-get-class-closure.parameters"></a><h4>Parameters</h4>
 165 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 166 <colgroup>
 167 <col width="150px" class="parameters_name">
 168 <col class="parameters_description">
 169 <col width="200px" class="parameters_annotations">
 170 </colgroup>
 171 <tbody><tr>
 172 <td class="parameter_name"><p>info</p></td>
 173 <td class="parameter_description"><p>a <a class="link" href="gi-GISignalInfo.html#GISignalInfo" title="GISignalInfo"><span class="type">GISignalInfo</span></a></p></td>
 174 <td class="parameter_annotations"> </td>
 175 </tr></tbody>
 176 </table></div>
 177 </div>
 178 <div class="refsect3">
 179 <a name="g-signal-info-get-class-closure.returns"></a><h4>Returns</h4>
 180 <p> the class closure or <code class="literal">NULL</code>. </p>
 181 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
 182 </div>
 183 </div>
 184 <hr>
 185 <div class="refsect2">
 186 <a name="g-signal-info-true-stops-emit"></a><h3>g_signal_info_true_stops_emit ()</h3>
 187 <pre class="programlisting"><span class="returnvalue">gboolean</span>
 188 g_signal_info_true_stops_emit (<em class="parameter"><code><a class="link" href="gi-GISignalInfo.html#GISignalInfo" title="GISignalInfo"><span class="type">GISignalInfo</span></a> *info</code></em>);</pre>
 189 <p>Obtain if the returning true in the signal handler will
 190 stop the emission of the signal.</p>
 191 <div class="refsect3">
 192 <a name="g-signal-info-true-stops-emit.parameters"></a><h4>Parameters</h4>
 193 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 194 <colgroup>
 195 <col width="150px" class="parameters_name">
 196 <col class="parameters_description">
 197 <col width="200px" class="parameters_annotations">
 198 </colgroup>
 199 <tbody><tr>
 200 <td class="parameter_name"><p>info</p></td>
 201 <td class="parameter_description"><p>a <a class="link" href="gi-GISignalInfo.html#GISignalInfo" title="GISignalInfo"><span class="type">GISignalInfo</span></a></p></td>
 202 <td class="parameter_annotations"> </td>
 203 </tr></tbody>
 204 </table></div>
 205 </div>
 206 <div class="refsect3">
 207 <a name="g-signal-info-true-stops-emit.returns"></a><h4>Returns</h4>
 208 <p> <code class="literal">TRUE</code> if returning true stops the signal emission</p>
 209 </div>
 210 </div>
 211 </div>
 212 <div class="refsect1">
 213 <a name="gi-GISignalInfo.other_details"></a><h2>Types and Values</h2>
 214 <div class="refsect2">
 215 <a name="GISignalInfo"></a><h3>GISignalInfo</h3>
 216 <pre class="programlisting">typedef GIBaseInfo GISignalInfo;
 217 </pre>
 218 <p>Represents a signal.</p>
 219 </div>
 220 </div>
 221 </div>
 222 <div class="footer">
 223 <hr>Generated by GTK-Doc V1.25.1</div>
 224 </body>
 225 </html>