doc/libatspi/html/AtspiEventListener.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>atspi-event-listener</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.77.1">
   7 <link rel="home" href="index.html" title="libatspi Reference Manual">
   8 <link rel="up" href="ch01.html" title="API reference">
   9 <link rel="prev" href="libatspi-atspi-selection.html" title="atspi-selection">
  10 <link rel="next" href="libatspi-atspi-hypertext.html" title="atspi-hypertext">
  11 <meta name="generator" content="GTK-Doc V1.18.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="2">
  16 <tr valign="middle">
  17 <td><a accesskey="p" href="libatspi-atspi-selection.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
  19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
  20 <th width="100%" align="center">libatspi Reference Manual</th>
  21 <td><a accesskey="n" href="libatspi-atspi-hypertext.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
  22 </tr>
  23 <tr><td colspan="5" class="shortcuts">
  24 <a href="#AtspiEventListener.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#AtspiEventListener.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#AtspiEventListener.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29 </td></tr>
  30 </table>
  31 <div class="refentry">
  32 <a name="AtspiEventListener"></a><div class="titlepage"></div>
  33 <div class="refnamediv"><table width="100%"><tr>
  34 <td valign="top">
  35 <h2><span class="refentrytitle"><a name="AtspiEventListener.top_of_page"></a>atspi-event-listener</span></h2>
  36 <p>atspi-event-listener — A generic interface implemented by objects for the receipt of event
  37 notifications.</p>
  38 </td>
  39 <td valign="top" align="right"></td>
  40 </tr></table></div>
  41 <div class="refsynopsisdiv">
  42 <a name="AtspiEventListener.synopsis"></a><h2>Synopsis</h2>
  43 <pre class="synopsis"><span class="returnvalue">void</span>                (<a class="link" href="AtspiEventListener.html#AtspiEventListenerCB" title="AtspiEventListenerCB ()">*AtspiEventListenerCB</a>)             (<em class="parameter"><code>const <a class="link" href="libatspi-atspi-types.html#AtspiEvent"><span class="type">AtspiEvent</span></a> *event</code></em>,
  44                                                          <em class="parameter"><code><span class="type">void</span> *user_data</code></em>);
  45 <span class="returnvalue">void</span>                (<a class="link" href="AtspiEventListener.html#AtspiEventListenerSimpleCB" title="AtspiEventListenerSimpleCB ()">*AtspiEventListenerSimpleCB</a>)       (<em class="parameter"><code>const <a class="link" href="libatspi-atspi-types.html#AtspiEvent"><span class="type">AtspiEvent</span></a> *event</code></em>);
  46 struct              <a class="link" href="AtspiEventListener.html#AtspiEventListener-struct" title="struct AtspiEventListener">AtspiEventListener</a>;
  47 struct              <a class="link" href="AtspiEventListener.html#AtspiEventListenerClass" title="struct AtspiEventListenerClass">AtspiEventListenerClass</a>;
  48 <a href="../gobject/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a>               <a class="link" href="AtspiEventListener.html#atspi-event-listener-get-type" title="atspi_event_listener_get_type ()">atspi_event_listener_get_type</a>       (<em class="parameter"><code><span class="type">void</span></code></em>);
  49 <a class="link" href="AtspiEventListener.html" title="atspi-event-listener"><span class="returnvalue">AtspiEventListener</span></a> * <a class="link" href="AtspiEventListener.html#atspi-event-listener-new" title="atspi_event_listener_new ()">atspi_event_listener_new</a>           (<em class="parameter"><code><a class="link" href="AtspiEventListener.html#AtspiEventListenerCB" title="AtspiEventListenerCB ()"><span class="type">AtspiEventListenerCB</span></a> callback</code></em>,
  50                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>,
  51                                                          <em class="parameter"><code><a href="../glib/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> callback_destroyed</code></em>);
  52 <a class="link" href="AtspiEventListener.html" title="atspi-event-listener"><span class="returnvalue">AtspiEventListener</span></a> * <a class="link" href="AtspiEventListener.html#atspi-event-listener-new-simple" title="atspi_event_listener_new_simple ()">atspi_event_listener_new_simple</a>    (<em class="parameter"><code><a class="link" href="AtspiEventListener.html#AtspiEventListenerSimpleCB" title="AtspiEventListenerSimpleCB ()"><span class="type">AtspiEventListenerSimpleCB</span></a> callback</code></em>,
  53                                                          <em class="parameter"><code><a href="../glib/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> callback_destroyed</code></em>);
  54 <a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="AtspiEventListener.html#atspi-event-listener-register" title="atspi_event_listener_register ()">atspi_event_listener_register</a>       (<em class="parameter"><code><a class="link" href="AtspiEventListener.html" title="atspi-event-listener"><span class="type">AtspiEventListener</span></a> *listener</code></em>,
  55                                                          <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *event_type</code></em>,
  56                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
  57 <a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="AtspiEventListener.html#atspi-event-listener-register-from-callback" title="atspi_event_listener_register_from_callback ()">atspi_event_listener_register_from_callback</a>
  58                                                         (<em class="parameter"><code><a class="link" href="AtspiEventListener.html#AtspiEventListenerCB" title="AtspiEventListenerCB ()"><span class="type">AtspiEventListenerCB</span></a> callback</code></em>,
  59                                                          <em class="parameter"><code><span class="type">void</span> *user_data</code></em>,
  60                                                          <em class="parameter"><code><a href="../glib/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> callback_destroyed</code></em>,
  61                                                          <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *event_type</code></em>,
  62                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
  63 <a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="AtspiEventListener.html#atspi-event-listener-register-no-data" title="atspi_event_listener_register_no_data ()">atspi_event_listener_register_no_data</a>
  64                                                         (<em class="parameter"><code><a class="link" href="AtspiEventListener.html#AtspiEventListenerSimpleCB" title="AtspiEventListenerSimpleCB ()"><span class="type">AtspiEventListenerSimpleCB</span></a> callback</code></em>,
  65                                                          <em class="parameter"><code><a href="../glib/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> callback_destroyed</code></em>,
  66                                                          <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *event_type</code></em>,
  67                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
  68 <a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="AtspiEventListener.html#atspi-event-listener-deregister" title="atspi_event_listener_deregister ()">atspi_event_listener_deregister</a>     (<em class="parameter"><code><a class="link" href="AtspiEventListener.html" title="atspi-event-listener"><span class="type">AtspiEventListener</span></a> *listener</code></em>,
  69                                                          <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *event_type</code></em>,
  70                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
  71 <a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="AtspiEventListener.html#atspi-event-listener-deregister-from-callback" title="atspi_event_listener_deregister_from_callback ()">atspi_event_listener_deregister_from_callback</a>
  72                                                         (<em class="parameter"><code><a class="link" href="AtspiEventListener.html#AtspiEventListenerCB" title="AtspiEventListenerCB ()"><span class="type">AtspiEventListenerCB</span></a> callback</code></em>,
  73                                                          <em class="parameter"><code><span class="type">void</span> *user_data</code></em>,
  74                                                          <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *event_type</code></em>,
  75                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
  76 <a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="AtspiEventListener.html#atspi-event-listener-deregister-no-data" title="atspi_event_listener_deregister_no_data ()">atspi_event_listener_deregister_no_data</a>
  77                                                         (<em class="parameter"><code><a class="link" href="AtspiEventListener.html#AtspiEventListenerSimpleCB" title="AtspiEventListenerSimpleCB ()"><span class="type">AtspiEventListenerSimpleCB</span></a> callback</code></em>,
  78                                                          <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *event_type</code></em>,
  79                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
  80 </pre>
  81 </div>
  82 <div class="refsect1">
  83 <a name="AtspiEventListener.object-hierarchy"></a><h2>Object Hierarchy</h2>
  84 <pre class="synopsis">
  85   <a href="../gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
  86    +----AtspiEventListener
  87 </pre>
  88 </div>
  89 <div class="refsect1">
  90 <a name="AtspiEventListener.description"></a><h2>Description</h2>
  91 <p>
  92 A generic interface implemented by objects for the receipt of event
  93 notifications. atspi-event-listener is the interface via which clients of
  94 the atspi-registry receive notification of changes to an application's user
  95 interface and content.
  96 </p>
  97 </div>
  98 <div class="refsect1">
  99 <a name="AtspiEventListener.details"></a><h2>Details</h2>
 100 <div class="refsect2">
 101 <a name="AtspiEventListenerCB"></a><h3>AtspiEventListenerCB ()</h3>
 102 <pre class="programlisting"><span class="returnvalue">void</span>                (*AtspiEventListenerCB)             (<em class="parameter"><code>const <a class="link" href="libatspi-atspi-types.html#AtspiEvent"><span class="type">AtspiEvent</span></a> *event</code></em>,
 103                                                          <em class="parameter"><code><span class="type">void</span> *user_data</code></em>);</pre>
 104 <p>
 105 A function prototype for callbacks via which clients are notified of AT-SPI events.
 106 </p>
 107 <div class="variablelist"><table border="0" class="variablelist">
 108 <colgroup>
 109 <col align="left" valign="top">
 110 <col>
 111 </colgroup>
 112 <tbody>
 113 <tr>
 114 <td><p><span class="term"><em class="parameter"><code>event</code></em> :</span></p></td>
 115 <td>The event for which notification is sent. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
 116 </td>
 117 </tr>
 118 <tr>
 119 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 120 <td>User data which is passed to the callback each time a notification takes place.</td>
 121 </tr>
 122 </tbody>
 123 </table></div>
 124 </div>
 125 <hr>
 126 <div class="refsect2">
 127 <a name="AtspiEventListenerSimpleCB"></a><h3>AtspiEventListenerSimpleCB ()</h3>
 128 <pre class="programlisting"><span class="returnvalue">void</span>                (*AtspiEventListenerSimpleCB)       (<em class="parameter"><code>const <a class="link" href="libatspi-atspi-types.html#AtspiEvent"><span class="type">AtspiEvent</span></a> *event</code></em>);</pre>
 129 <p>
 130 Like <span class="type">AtspiEventlistenerCB</span>, but with no user_data.
 131 </p>
 132 <div class="variablelist"><table border="0" class="variablelist">
 133 <colgroup>
 134 <col align="left" valign="top">
 135 <col>
 136 </colgroup>
 137 <tbody><tr>
 138 <td><p><span class="term"><em class="parameter"><code>event</code></em> :</span></p></td>
 139 <td>The event for which notification is sent. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
 140 </td>
 141 </tr></tbody>
 142 </table></div>
 143 </div>
 144 <hr>
 145 <div class="refsect2">
 146 <a name="AtspiEventListener-struct"></a><h3>struct AtspiEventListener</h3>
 147 <pre class="programlisting">struct AtspiEventListener;</pre>
 148 <p>
 149 </p>
 150 </div>
 151 <hr>
 152 <div class="refsect2">
 153 <a name="AtspiEventListenerClass"></a><h3>struct AtspiEventListenerClass</h3>
 154 <pre class="programlisting">struct AtspiEventListenerClass {
 155   GObjectClass parent_class;
 156 };
 157 </pre>
 158 <p>
 159 </p>
 160 </div>
 161 <hr>
 162 <div class="refsect2">
 163 <a name="atspi-event-listener-get-type"></a><h3>atspi_event_listener_get_type ()</h3>
 164 <pre class="programlisting"><a href="../gobject/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a>               atspi_event_listener_get_type       (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 165 <p>
 166 </p>
 167 </div>
 168 <hr>
 169 <div class="refsect2">
 170 <a name="atspi-event-listener-new"></a><h3>atspi_event_listener_new ()</h3>
 171 <pre class="programlisting"><a class="link" href="AtspiEventListener.html" title="atspi-event-listener"><span class="returnvalue">AtspiEventListener</span></a> * atspi_event_listener_new           (<em class="parameter"><code><a class="link" href="AtspiEventListener.html#AtspiEventListenerCB" title="AtspiEventListenerCB ()"><span class="type">AtspiEventListenerCB</span></a> callback</code></em>,
 172                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>,
 173                                                          <em class="parameter"><code><a href="../glib/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> callback_destroyed</code></em>);</pre>
 174 <p>
 175 Creates a new <a class="link" href="AtspiEventListener.html" title="atspi-event-listener"><span class="type">AtspiEventListener</span></a> associated with a specified <em class="parameter"><code>callback</code></em>.
 176 </p>
 177 <div class="variablelist"><table border="0" class="variablelist">
 178 <colgroup>
 179 <col align="left" valign="top">
 180 <col>
 181 </colgroup>
 182 <tbody>
 183 <tr>
 184 <td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
 185 <td>An <a class="link" href="AtspiEventListener.html#AtspiEventListenerCB" title="AtspiEventListenerCB ()"><span class="type">AtspiEventListenerCB</span></a> to be called
 186 when an event is fired. <span class="annotation">[<acronym title="The callback is valid until the GDestroyNotify argument is called."><span class="acronym">scope notified</span></acronym>]</span>
 187 </td>
 188 </tr>
 189 <tr>
 190 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 191 <td>data to pass to the callback. <span class="annotation">[<acronym title="This parameter is a 'user_data', for callbacks; many bindings can pass NULL here."><span class="acronym">closure</span></acronym>]</span>
 192 </td>
 193 </tr>
 194 <tr>
 195 <td><p><span class="term"><em class="parameter"><code>callback_destroyed</code></em> :</span></p></td>
 196 <td>A <a href="../glib/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> called when the listener is freed
 197 and data associated with the callback should be freed.  Can be NULL.</td>
 198 </tr>
 199 <tr>
 200 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 201 <td>A new <a class="link" href="AtspiEventListener.html" title="atspi-event-listener"><span class="type">AtspiEventListener</span></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
 202 </td>
 203 </tr>
 204 </tbody>
 205 </table></div>
 206 </div>
 207 <hr>
 208 <div class="refsect2">
 209 <a name="atspi-event-listener-new-simple"></a><h3>atspi_event_listener_new_simple ()</h3>
 210 <pre class="programlisting"><a class="link" href="AtspiEventListener.html" title="atspi-event-listener"><span class="returnvalue">AtspiEventListener</span></a> * atspi_event_listener_new_simple    (<em class="parameter"><code><a class="link" href="AtspiEventListener.html#AtspiEventListenerSimpleCB" title="AtspiEventListenerSimpleCB ()"><span class="type">AtspiEventListenerSimpleCB</span></a> callback</code></em>,
 211                                                          <em class="parameter"><code><a href="../glib/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> callback_destroyed</code></em>);</pre>
 212 <p>
 213 Creates a new <a class="link" href="AtspiEventListener.html" title="atspi-event-listener"><span class="type">AtspiEventListener</span></a> associated with a specified <em class="parameter"><code>callback</code></em>.
 214 </p>
 215 <div class="variablelist"><table border="0" class="variablelist">
 216 <colgroup>
 217 <col align="left" valign="top">
 218 <col>
 219 </colgroup>
 220 <tbody>
 221 <tr>
 222 <td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
 223 <td>An <a class="link" href="AtspiEventListener.html#AtspiEventListenerSimpleCB" title="AtspiEventListenerSimpleCB ()"><span class="type">AtspiEventListenerSimpleCB</span></a> to be called
 224 when an event is fired. <span class="annotation">[<acronym title="The callback is valid until the GDestroyNotify argument is called."><span class="acronym">scope notified</span></acronym>]</span>
 225 </td>
 226 </tr>
 227 <tr>
 228 <td><p><span class="term"><em class="parameter"><code>callback_destroyed</code></em> :</span></p></td>
 229 <td>A <a href="../glib/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> called when the listener is freed
 230 and data associated with the callback should be freed.  Can be NULL.</td>
 231 </tr>
 232 <tr>
 233 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 234 <td>A new <a class="link" href="AtspiEventListener.html" title="atspi-event-listener"><span class="type">AtspiEventListener</span></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
 235 </td>
 236 </tr>
 237 </tbody>
 238 </table></div>
 239 </div>
 240 <hr>
 241 <div class="refsect2">
 242 <a name="atspi-event-listener-register"></a><h3>atspi_event_listener_register ()</h3>
 243 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            atspi_event_listener_register       (<em class="parameter"><code><a class="link" href="AtspiEventListener.html" title="atspi-event-listener"><span class="type">AtspiEventListener</span></a> *listener</code></em>,
 244                                                          <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *event_type</code></em>,
 245                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 246 <p>
 247 Adds an in-process callback function to an existing <a class="link" href="AtspiEventListener.html" title="atspi-event-listener"><span class="type">AtspiEventListener</span></a>.
 248 </p>
 249 <p>
 250 Legal object event types:
 251 </p>
 252 <p>
 253    (property change events)
 254 </p>
 255 <p>
 256            object:property-change
 257            object:property-change:accessible-name
 258            object:property-change:accessible-description
 259            object:property-change:accessible-parent
 260            object:property-change:accessible-value
 261            object:property-change:accessible-role
 262            object:property-change:accessible-table-caption
 263            object:property-change:accessible-table-column-description
 264            object:property-change:accessible-table-column-header
 265            object:property-change:accessible-table-row-description
 266            object:property-change:accessible-table-row-header
 267            object:property-change:accessible-table-summary
 268 </p>
 269 <p>
 270    (other object events)
 271 </p>
 272 <p>
 273            object:state-changed
 274            object:children-changed
 275            object:visible-data-changed
 276            object:selection-changed
 277            object:text-selection-changed
 278            object:text-changed
 279            object:text-caret-moved
 280            object:row-inserted
 281            object:row-reordered
 282            object:row-deleted
 283            object:column-inserted
 284            object:column-reordered
 285            object:column-deleted
 286            object:model-changed
 287            object:active-descendant-changed
 288 </p>
 289 <p>
 290  (window events)
 291 </p>
 292 <p>
 293            window:minimize
 294            window:maximize
 295            window:restore
 296            window:close
 297            window:create
 298            window:reparent
 299            window:desktop-create
 300            window:desktop-destroy
 301            window:activate
 302            window:deactivate
 303            window:raise
 304            window:lower
 305            window:move
 306            window:resize
 307            window:shade
 308            window:unshade
 309            window:restyle
 310 </p>
 311 <p>
 312  (other events)
 313 </p>
 314 <p>
 315            focus:
 316            mouse:abs
 317            mouse:rel
 318            mouse:b1p
 319            mouse:b1r
 320            mouse:b2p
 321            mouse:b2r
 322            mouse:b3p
 323            mouse:b3r
 324 </p>
 325 <p>
 326 NOTE: this character string may be UTF-8, but should not contain byte
 327 value 56
 328            (ascii ':'), except as a delimiter, since non-UTF-8 string
 329            delimiting functions are used internally.
 330            In general, listening to
 331            toolkit-specific events is not recommended.
 332 </p>
 333 <div class="variablelist"><table border="0" class="variablelist">
 334 <colgroup>
 335 <col align="left" valign="top">
 336 <col>
 337 </colgroup>
 338 <tbody>
 339 <tr>
 340 <td><p><span class="term"><em class="parameter"><code>listener</code></em> :</span></p></td>
 341 <td>The <a class="link" href="AtspiEventListener.html" title="atspi-event-listener"><span class="type">AtspiEventListener</span></a> to register against an event type.</td>
 342 </tr>
 343 <tr>
 344 <td><p><span class="term"><em class="parameter"><code>event_type</code></em> :</span></p></td>
 345 <td>a character string indicating the type of events for which
 346 notification is requested.  Format is
 347 EventClass:major_type:minor_type:detail
 348 where all subfields other than EventClass are optional.
 349 EventClasses include "object", "window", "mouse",
 350 and toolkit events (e.g. "Gtk", "AWT").
 351 Examples: "focus:", "Gtk:GtkWidget:button_press_event".</td>
 352 </tr>
 353 <tr>
 354 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 355 <td>
 356 <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><span class="type">TRUE</span></a> if successful, otherwise <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><span class="type">FALSE</span></a>.</td>
 357 </tr>
 358 </tbody>
 359 </table></div>
 360 </div>
 361 <hr>
 362 <div class="refsect2">
 363 <a name="atspi-event-listener-register-from-callback"></a><h3>atspi_event_listener_register_from_callback ()</h3>
 364 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            atspi_event_listener_register_from_callback
 365                                                         (<em class="parameter"><code><a class="link" href="AtspiEventListener.html#AtspiEventListenerCB" title="AtspiEventListenerCB ()"><span class="type">AtspiEventListenerCB</span></a> callback</code></em>,
 366                                                          <em class="parameter"><code><span class="type">void</span> *user_data</code></em>,
 367                                                          <em class="parameter"><code><a href="../glib/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> callback_destroyed</code></em>,
 368                                                          <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *event_type</code></em>,
 369                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 370 <p>
 371 Registers an <a class="link" href="AtspiEventListener.html#AtspiEventListenerCB" title="AtspiEventListenerCB ()"><span class="type">AtspiEventListenerCB</span></a> against an <em class="parameter"><code>event_type</code></em>.
 372 </p>
 373 <div class="variablelist"><table border="0" class="variablelist">
 374 <colgroup>
 375 <col align="left" valign="top">
 376 <col>
 377 </colgroup>
 378 <tbody>
 379 <tr>
 380 <td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
 381 <td>the <a class="link" href="AtspiEventListener.html#AtspiEventListenerCB" title="AtspiEventListenerCB ()"><span class="type">AtspiEventListenerCB</span></a> to be registered
 382 against an event type. <span class="annotation">[<acronym title="The callback is valid until the GDestroyNotify argument is called."><span class="acronym">scope notified</span></acronym>]</span>
 383 </td>
 384 </tr>
 385 <tr>
 386 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 387 <td>User data to be passed to the callback. <span class="annotation">[<acronym title="This parameter is a 'user_data', for callbacks; many bindings can pass NULL here."><span class="acronym">closure</span></acronym>]</span>
 388 </td>
 389 </tr>
 390 <tr>
 391 <td><p><span class="term"><em class="parameter"><code>callback_destroyed</code></em> :</span></p></td>
 392 <td>A <a href="../glib/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> called when the callback is destroyed.</td>
 393 </tr>
 394 <tr>
 395 <td><p><span class="term"><em class="parameter"><code>event_type</code></em> :</span></p></td>
 396 <td>a character string indicating the type of events for which
 397 notification is requested.  See <a class="link" href="AtspiEventListener.html#atspi-event-listener-register" title="atspi_event_listener_register ()"><span class="type">atspi_event_listener_register</span></a>
 398 for a description of the format.</td>
 399 </tr>
 400 <tr>
 401 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 402 <td>
 403 <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><span class="type">TRUE</span></a> if successfull, otherwise <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><span class="type">FALSE</span></a>.</td>
 404 </tr>
 405 </tbody>
 406 </table></div>
 407 </div>
 408 <hr>
 409 <div class="refsect2">
 410 <a name="atspi-event-listener-register-no-data"></a><h3>atspi_event_listener_register_no_data ()</h3>
 411 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            atspi_event_listener_register_no_data
 412                                                         (<em class="parameter"><code><a class="link" href="AtspiEventListener.html#AtspiEventListenerSimpleCB" title="AtspiEventListenerSimpleCB ()"><span class="type">AtspiEventListenerSimpleCB</span></a> callback</code></em>,
 413                                                          <em class="parameter"><code><a href="../glib/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> callback_destroyed</code></em>,
 414                                                          <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *event_type</code></em>,
 415                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 416 <p>
 417 Registers an <span class="type">AtspiEventListenetSimpleCB</span>. The method is similar to
 418 <a class="link" href="AtspiEventListener.html#atspi-event-listener-register" title="atspi_event_listener_register ()"><span class="type">atspi_event_listener_register</span></a>, but <em class="parameter"><code>callback</code></em> takes no user_data.
 419 </p>
 420 <div class="variablelist"><table border="0" class="variablelist">
 421 <colgroup>
 422 <col align="left" valign="top">
 423 <col>
 424 </colgroup>
 425 <tbody>
 426 <tr>
 427 <td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
 428 <td>the <a class="link" href="AtspiEventListener.html#AtspiEventListenerSimpleCB" title="AtspiEventListenerSimpleCB ()"><span class="type">AtspiEventListenerSimpleCB</span></a> to be
 429 registered against an event type. <span class="annotation">[<acronym title="The callback is valid until the GDestroyNotify argument is called."><span class="acronym">scope notified</span></acronym>]</span>
 430 </td>
 431 </tr>
 432 <tr>
 433 <td><p><span class="term"><em class="parameter"><code>callback_destroyed</code></em> :</span></p></td>
 434 <td>A <a href="../glib/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> called when the callback is destroyed.</td>
 435 </tr>
 436 <tr>
 437 <td><p><span class="term"><em class="parameter"><code>event_type</code></em> :</span></p></td>
 438 <td>a character string indicating the type of events for which
 439 notification is requested.  Format is
 440 EventClass:major_type:minor_type:detail
 441 where all subfields other than EventClass are optional.
 442 EventClasses include "object", "window", "mouse",
 443 and toolkit events (e.g. "Gtk", "AWT").
 444 Examples: "focus:", "Gtk:GtkWidget:button_press_event".</td>
 445 </tr>
 446 <tr>
 447 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 448 <td>
 449 <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><span class="type">TRUE</span></a> if successfull, otherwise <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><span class="type">FALSE</span></a>.</td>
 450 </tr>
 451 </tbody>
 452 </table></div>
 453 </div>
 454 <hr>
 455 <div class="refsect2">
 456 <a name="atspi-event-listener-deregister"></a><h3>atspi_event_listener_deregister ()</h3>
 457 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            atspi_event_listener_deregister     (<em class="parameter"><code><a class="link" href="AtspiEventListener.html" title="atspi-event-listener"><span class="type">AtspiEventListener</span></a> *listener</code></em>,
 458                                                          <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *event_type</code></em>,
 459                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 460 <p>
 461 Deregisters an <a class="link" href="AtspiEventListener.html" title="atspi-event-listener"><span class="type">AtspiEventListener</span></a> from the registry, for a specific
 462             event type.
 463 </p>
 464 <div class="variablelist"><table border="0" class="variablelist">
 465 <colgroup>
 466 <col align="left" valign="top">
 467 <col>
 468 </colgroup>
 469 <tbody>
 470 <tr>
 471 <td><p><span class="term"><em class="parameter"><code>listener</code></em> :</span></p></td>
 472 <td>The <a class="link" href="AtspiEventListener.html" title="atspi-event-listener"><span class="type">AtspiEventListener</span></a> to deregister.</td>
 473 </tr>
 474 <tr>
 475 <td><p><span class="term"><em class="parameter"><code>event_type</code></em> :</span></p></td>
 476 <td>a string specifying the event type for which this
 477 listener is to be deregistered.</td>
 478 </tr>
 479 <tr>
 480 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 481 <td>
 482 <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><span class="type">TRUE</span></a> if successful, otherwise <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><span class="type">FALSE</span></a>.</td>
 483 </tr>
 484 </tbody>
 485 </table></div>
 486 </div>
 487 <hr>
 488 <div class="refsect2">
 489 <a name="atspi-event-listener-deregister-from-callback"></a><h3>atspi_event_listener_deregister_from_callback ()</h3>
 490 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            atspi_event_listener_deregister_from_callback
 491                                                         (<em class="parameter"><code><a class="link" href="AtspiEventListener.html#AtspiEventListenerCB" title="AtspiEventListenerCB ()"><span class="type">AtspiEventListenerCB</span></a> callback</code></em>,
 492                                                          <em class="parameter"><code><span class="type">void</span> *user_data</code></em>,
 493                                                          <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *event_type</code></em>,
 494                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 495 <p>
 496 Deregisters an <a class="link" href="AtspiEventListener.html#AtspiEventListenerCB" title="AtspiEventListenerCB ()"><span class="type">AtspiEventListenerCB</span></a> from the registry, for a specific
 497             event type.
 498 </p>
 499 <div class="variablelist"><table border="0" class="variablelist">
 500 <colgroup>
 501 <col align="left" valign="top">
 502 <col>
 503 </colgroup>
 504 <tbody>
 505 <tr>
 506 <td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
 507 <td>the <a class="link" href="AtspiEventListener.html#AtspiEventListenerCB" title="AtspiEventListenerCB ()"><span class="type">AtspiEventListenerCB</span></a> registered against an
 508 event type. <span class="annotation">[<acronym title="The callback is valid only during the call to the method."><span class="acronym">scope call</span></acronym>]</span>
 509 </td>
 510 </tr>
 511 <tr>
 512 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 513 <td>User data that was passed in for this callback. <span class="annotation">[<acronym title="This parameter is a 'user_data', for callbacks; many bindings can pass NULL here."><span class="acronym">closure</span></acronym>]</span>
 514 </td>
 515 </tr>
 516 <tr>
 517 <td><p><span class="term"><em class="parameter"><code>event_type</code></em> :</span></p></td>
 518 <td>a string specifying the event type for which this
 519 listener is to be deregistered.</td>
 520 </tr>
 521 <tr>
 522 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 523 <td>
 524 <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><span class="type">TRUE</span></a> if successful, otherwise <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><span class="type">FALSE</span></a>.</td>
 525 </tr>
 526 </tbody>
 527 </table></div>
 528 </div>
 529 <hr>
 530 <div class="refsect2">
 531 <a name="atspi-event-listener-deregister-no-data"></a><h3>atspi_event_listener_deregister_no_data ()</h3>
 532 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            atspi_event_listener_deregister_no_data
 533                                                         (<em class="parameter"><code><a class="link" href="AtspiEventListener.html#AtspiEventListenerSimpleCB" title="AtspiEventListenerSimpleCB ()"><span class="type">AtspiEventListenerSimpleCB</span></a> callback</code></em>,
 534                                                          <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *event_type</code></em>,
 535                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 536 <p>
 537 deregisters an <a class="link" href="AtspiEventListener.html#AtspiEventListenerSimpleCB" title="AtspiEventListenerSimpleCB ()"><span class="type">AtspiEventListenerSimpleCB</span></a> from the registry, for a specific
 538             event type.
 539 </p>
 540 <div class="variablelist"><table border="0" class="variablelist">
 541 <colgroup>
 542 <col align="left" valign="top">
 543 <col>
 544 </colgroup>
 545 <tbody>
 546 <tr>
 547 <td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
 548 <td>the <a class="link" href="AtspiEventListener.html#AtspiEventListenerSimpleCB" title="AtspiEventListenerSimpleCB ()"><span class="type">AtspiEventListenerSimpleCB</span></a> registered against
 549 an event type. <span class="annotation">[<acronym title="The callback is valid only during the call to the method."><span class="acronym">scope call</span></acronym>]</span>
 550 </td>
 551 </tr>
 552 <tr>
 553 <td><p><span class="term"><em class="parameter"><code>event_type</code></em> :</span></p></td>
 554 <td>a string specifying the event type for which this
 555 listener is to be deregistered.</td>
 556 </tr>
 557 <tr>
 558 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 559 <td>
 560 <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><span class="type">TRUE</span></a> if successful, otherwise <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><span class="type">FALSE</span></a>.</td>
 561 </tr>
 562 </tbody>
 563 </table></div>
 564 </div>
 565 </div>
 566 </div>
 567 <div class="footer">
 568 <hr>
 569           Generated by GTK-Doc V1.18.1</div>
 570 </body>
 571 </html>