| Current File : //proc/self/root/kunden/usr/share/gtk-doc/html/libatspi/AtspiEventListener.html |
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>AtspiEventListener: libatspi Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="libatspi Reference Manual">
<link rel="up" href="ch01.html" title="API reference">
<link rel="prev" href="libatspi-atspi-selection.html" title="atspi-selection">
<link rel="next" href="libatspi-atspi-hypertext.html" title="atspi-hypertext">
<meta name="generator" content="GTK-Doc V1.33.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#AtspiEventListener.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#AtspiEventListener.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="libatspi-atspi-selection.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libatspi-atspi-hypertext.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="AtspiEventListener"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="AtspiEventListener.top_of_page"></a>AtspiEventListener</span></h2>
<p>AtspiEventListener</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="AtspiEventListener.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<span class="c_punctuation">(</span><a class="link" href="AtspiEventListener.html#AtspiEventListenerCB" title="AtspiEventListenerCB ()">*AtspiEventListenerCB</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<span class="c_punctuation">(</span><a class="link" href="AtspiEventListener.html#AtspiEventListenerSimpleCB" title="AtspiEventListenerSimpleCB ()">*AtspiEventListenerSimpleCB</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GType</span>
</td>
<td class="function_name">
<a class="link" href="AtspiEventListener.html#atspi-event-listener-get-type" title="atspi_event_listener_get_type ()">atspi_event_listener_get_type</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="AtspiEventListener.html" title="AtspiEventListener"><span class="returnvalue">AtspiEventListener</span></a> *
</td>
<td class="function_name">
<a class="link" href="AtspiEventListener.html#atspi-event-listener-new" title="atspi_event_listener_new ()">atspi_event_listener_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="AtspiEventListener.html" title="AtspiEventListener"><span class="returnvalue">AtspiEventListener</span></a> *
</td>
<td class="function_name">
<a class="link" href="AtspiEventListener.html#atspi-event-listener-new-simple" title="atspi_event_listener_new_simple ()">atspi_event_listener_new_simple</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="AtspiEventListener.html#atspi-event-listener-register" title="atspi_event_listener_register ()">atspi_event_listener_register</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<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> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="AtspiEventListener.html#atspi-event-listener-register-from-callback-full" title="atspi_event_listener_register_from_callback_full ()">atspi_event_listener_register_from_callback_full</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<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> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="AtspiEventListener.html#atspi-event-listener-register-full" title="atspi_event_listener_register_full ()">atspi_event_listener_register_full</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="AtspiEventListener.html#atspi-event-listener-deregister" title="atspi_event_listener_deregister ()">atspi_event_listener_deregister</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<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> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<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> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="AtspiEventListener.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="other_proto_type">
<col class="other_proto_name">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="AtspiEventListener.html#AtspiEventListener-struct" title="struct AtspiEventListener">AtspiEventListener</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="AtspiEventListener.html#AtspiEventListenerClass" title="struct AtspiEventListenerClass">AtspiEventListenerClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="AtspiEventListener.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GObject
<span class="lineart">╰──</span> AtspiEventListener
</pre>
</div>
<div class="refsect1">
<a name="AtspiEventListener.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="AtspiEventListener.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="AtspiEventListenerCB"></a><h3>AtspiEventListenerCB ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
<span class="c_punctuation">(</span>*AtspiEventListenerCB<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="libatspi-atspi-types.html#AtspiEvent"><span class="type">AtspiEvent</span></a> *event</code></em>,
<em class="parameter"><code><span class="type">void</span> *user_data</code></em>);</pre>
<p>A function prototype for callbacks via which clients are notified of AT-SPI events.</p>
<div class="refsect3">
<a name="AtspiEventListenerCB.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>event</p></td>
<td class="parameter_description"><p>The event for which notification is sent. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="The caller owns the data, and is responsible for free it."><span class="acronym">transfer full</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>User data which is passed to the callback each time a notification takes place.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="AtspiEventListenerSimpleCB"></a><h3>AtspiEventListenerSimpleCB ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
<span class="c_punctuation">(</span>*AtspiEventListenerSimpleCB<span class="c_punctuation">)</span> (<em class="parameter"><code>const <a class="link" href="libatspi-atspi-types.html#AtspiEvent"><span class="type">AtspiEvent</span></a> *event</code></em>);</pre>
<p>Like <span class="type">AtspiEventlistenerCB</span>, but with no user_data.</p>
<div class="refsect3">
<a name="AtspiEventListenerSimpleCB.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>event</p></td>
<td class="parameter_description"><p>The event for which notification is sent. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="The caller owns the data, and is responsible for free it."><span class="acronym">transfer full</span></acronym>]</span></td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-event-listener-get-type"></a><h3>atspi_event_listener_get_type ()</h3>
<pre class="programlisting"><span class="returnvalue">GType</span>
atspi_event_listener_get_type (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="atspi-event-listener-new"></a><h3>atspi_event_listener_new ()</h3>
<pre class="programlisting"><a class="link" href="AtspiEventListener.html" title="AtspiEventListener"><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>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>,
<em class="parameter"><code><span class="type">GDestroyNotify</span> callback_destroyed</code></em>);</pre>
<p>Creates a new <a class="link" href="AtspiEventListener.html" title="AtspiEventListener"><span class="type">AtspiEventListener</span></a> associated with a specified <em class="parameter"><code>callback</code></em>
.</p>
<div class="refsect3">
<a name="atspi-event-listener-new.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>callback</p></td>
<td class="parameter_description"><p>An <a class="link" href="AtspiEventListener.html#AtspiEventListenerCB" title="AtspiEventListenerCB ()"><span class="type">AtspiEventListenerCB</span></a> to be called
when an event is fired. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="The callback is valid until the GDestroyNotify argument is called."><span class="acronym">scope notified</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>data to pass to the callback. </p></td>
<td class="parameter_annotations"><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></td>
</tr>
<tr>
<td class="parameter_name"><p>callback_destroyed</p></td>
<td class="parameter_description"><p>A <span class="type">GDestroyNotify</span> called when the listener is freed
and data associated with the callback should be freed. Can be NULL.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atspi-event-listener-new.returns"></a><h4>Returns</h4>
<p>A new <a class="link" href="AtspiEventListener.html" title="AtspiEventListener"><span class="type">AtspiEventListener</span></a>. </p>
<p><span class="annotation">[<acronym title="The caller owns the data, and is responsible for free it."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-event-listener-new-simple"></a><h3>atspi_event_listener_new_simple ()</h3>
<pre class="programlisting"><a class="link" href="AtspiEventListener.html" title="AtspiEventListener"><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>,
<em class="parameter"><code><span class="type">GDestroyNotify</span> callback_destroyed</code></em>);</pre>
<p>Creates a new <a class="link" href="AtspiEventListener.html" title="AtspiEventListener"><span class="type">AtspiEventListener</span></a> associated with a specified <em class="parameter"><code>callback</code></em>
.</p>
<p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
<div class="refsect3">
<a name="atspi-event-listener-new-simple.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>callback</p></td>
<td class="parameter_description"><p>An <a class="link" href="AtspiEventListener.html#AtspiEventListenerSimpleCB" title="AtspiEventListenerSimpleCB ()"><span class="type">AtspiEventListenerSimpleCB</span></a> to be called
when an event is fired. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="The callback is valid until the GDestroyNotify argument is called."><span class="acronym">scope notified</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>callback_destroyed</p></td>
<td class="parameter_description"><p>A <span class="type">GDestroyNotify</span> called when the listener is freed
and data associated with the callback should be freed. Can be NULL.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atspi-event-listener-new-simple.returns"></a><h4>Returns</h4>
<p>A new <a class="link" href="AtspiEventListener.html" title="AtspiEventListener"><span class="type">AtspiEventListener</span></a>. </p>
<p><span class="annotation">[<acronym title="The caller owns the data, and is responsible for free it."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-event-listener-register"></a><h3>atspi_event_listener_register ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
atspi_event_listener_register (<em class="parameter"><code><a class="link" href="AtspiEventListener.html" title="AtspiEventListener"><span class="type">AtspiEventListener</span></a> *listener</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *event_type</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Adds an in-process callback function to an existing <a class="link" href="AtspiEventListener.html" title="AtspiEventListener"><span class="type">AtspiEventListener</span></a>.</p>
<p>Legal object event types:</p>
<p> (property change events)</p>
<p> object:property-change
object:property-change:accessible-name
object:property-change:accessible-description
object:property-change:accessible-parent
object:property-change:accessible-value
object:property-change:accessible-role
object:property-change:accessible-table-caption
object:property-change:accessible-table-column-description
object:property-change:accessible-table-column-header
object:property-change:accessible-table-row-description
object:property-change:accessible-table-row-header
object:property-change:accessible-table-summary</p>
<p> (other object events)</p>
<p> object:state-changed
object:children-changed
object:visible-data-changed
object:selection-changed
object:text-selection-changed
object:text-changed
object:text-caret-moved
object:row-inserted
object:row-reordered
object:row-deleted
object:column-inserted
object:column-reordered
object:column-deleted
object:model-changed
object:active-descendant-changed</p>
<p> (screen reader events)
screen-reader:region-changed</p>
<p> (window events)</p>
<p> window:minimize
window:maximize
window:restore
window:close
window:create
window:reparent
window:desktop-create
window:desktop-destroy
window:activate
window:deactivate
window:raise
window:lower
window:move
window:resize
window:shade
window:unshade
window:restyle</p>
<p> (other events)</p>
<p> focus:
mouse:abs
mouse:rel
mouse:b1p
mouse:b1r
mouse:b2p
mouse:b2r
mouse:b3p
mouse:b3r</p>
<p>NOTE: this character string may be UTF-8, but should not contain byte
value 56
(ascii ':'), except as a delimiter, since non-UTF-8 string
delimiting functions are used internally.
In general, listening to
toolkit-specific events is not recommended.</p>
<p>Currently, object:text-reading-position needs to be specified explicitly
(it is not implied by object:text), since it is generated by the screen
reader and is thus a special case internally.</p>
<div class="refsect3">
<a name="atspi-event-listener-register.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>listener</p></td>
<td class="parameter_description"><p>The <a class="link" href="AtspiEventListener.html" title="AtspiEventListener"><span class="type">AtspiEventListener</span></a> to register against an event type.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>event_type</p></td>
<td class="parameter_description"><p>a character string indicating the type of events for which
notification is requested. Format is
EventClass:major_type:minor_type:detail
where all subfields other than EventClass are optional.
EventClasses include "object", "window", "mouse",
and toolkit events (e.g. "Gtk", "AWT").
Examples: "focus:", "Gtk:GtkWidget:button_press_event".</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atspi-event-listener-register.returns"></a><h4>Returns</h4>
<p> <span class="type">TRUE</span> if successful, otherwise <span class="type">FALSE</span>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-event-listener-register-from-callback"></a><h3>atspi_event_listener_register_from_callback ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
atspi_event_listener_register_from_callback
(<em class="parameter"><code><a class="link" href="AtspiEventListener.html#AtspiEventListenerCB" title="AtspiEventListenerCB ()"><span class="type">AtspiEventListenerCB</span></a> callback</code></em>,
<em class="parameter"><code><span class="type">void</span> *user_data</code></em>,
<em class="parameter"><code><span class="type">GDestroyNotify</span> callback_destroyed</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *event_type</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>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>
.</p>
<div class="refsect3">
<a name="atspi-event-listener-register-from-callback.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>callback</p></td>
<td class="parameter_description"><p>the <a class="link" href="AtspiEventListener.html#AtspiEventListenerCB" title="AtspiEventListenerCB ()"><span class="type">AtspiEventListenerCB</span></a> to be registered
against an event type. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="The callback is valid until the GDestroyNotify argument is called."><span class="acronym">scope notified</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>User data to be passed to the callback. </p></td>
<td class="parameter_annotations"><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></td>
</tr>
<tr>
<td class="parameter_name"><p>callback_destroyed</p></td>
<td class="parameter_description"><p>A <span class="type">GDestroyNotify</span> called when the callback is destroyed.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>event_type</p></td>
<td class="parameter_description"><p>a character string indicating the type of events for which
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>
for a description of the format.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atspi-event-listener-register-from-callback.returns"></a><h4>Returns</h4>
<p> <span class="type">TRUE</span> if successfull, otherwise <span class="type">FALSE</span>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-event-listener-register-from-callback-full"></a><h3>atspi_event_listener_register_from_callback_full ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
atspi_event_listener_register_from_callback_full
(<em class="parameter"><code><a class="link" href="AtspiEventListener.html#AtspiEventListenerCB" title="AtspiEventListenerCB ()"><span class="type">AtspiEventListenerCB</span></a> callback</code></em>,
<em class="parameter"><code><span class="type">void</span> *user_data</code></em>,
<em class="parameter"><code><span class="type">GDestroyNotify</span> callback_destroyed</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *event_type</code></em>,
<em class="parameter"><code><span class="type">GArray</span> *properties</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<div class="refsect3">
<a name="atspi-event-listener-register-from-callback-full.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>callback</p></td>
<td class="parameter_description"><p>an <a class="link" href="AtspiEventListener.html#AtspiEventListenerCB" title="AtspiEventListenerCB ()"><span class="type">AtspiEventListenerCB</span></a> function pointer. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="The callback is valid until first called."><span class="acronym">scope async</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>. </p></td>
<td class="parameter_annotations"><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> callback]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>callback_destroyed</p></td>
<td class="parameter_description"><p>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="This parameter is a 'destroy_data', for callbacks."><span class="acronym">destroy</span></acronym> callback]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>properties</p></td>
<td class="parameter_description"><p>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atspi-event-listener-register-from-callback-full.returns"></a><h4>Returns</h4>
<p> <span class="type">TRUE</span> if successful, otherwise <span class="type">FALSE</span>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-event-listener-register-no-data"></a><h3>atspi_event_listener_register_no_data ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
atspi_event_listener_register_no_data (<em class="parameter"><code><a class="link" href="AtspiEventListener.html#AtspiEventListenerSimpleCB" title="AtspiEventListenerSimpleCB ()"><span class="type">AtspiEventListenerSimpleCB</span></a> callback</code></em>,
<em class="parameter"><code><span class="type">GDestroyNotify</span> callback_destroyed</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *event_type</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Registers an <span class="type">AtspiEventListenetSimpleCB</span>. The method is similar to
<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.</p>
<p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
<div class="refsect3">
<a name="atspi-event-listener-register-no-data.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>callback</p></td>
<td class="parameter_description"><p>the <a class="link" href="AtspiEventListener.html#AtspiEventListenerSimpleCB" title="AtspiEventListenerSimpleCB ()"><span class="type">AtspiEventListenerSimpleCB</span></a> to be
registered against an event type. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="The callback is valid until the GDestroyNotify argument is called."><span class="acronym">scope notified</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>callback_destroyed</p></td>
<td class="parameter_description"><p>A <span class="type">GDestroyNotify</span> called when the callback is destroyed.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>event_type</p></td>
<td class="parameter_description"><p>a character string indicating the type of events for which
notification is requested. Format is
EventClass:major_type:minor_type:detail
where all subfields other than EventClass are optional.
EventClasses include "object", "window", "mouse",
and toolkit events (e.g. "Gtk", "AWT").
Examples: "focus:", "Gtk:GtkWidget:button_press_event".</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atspi-event-listener-register-no-data.returns"></a><h4>Returns</h4>
<p> <span class="type">TRUE</span> if successfull, otherwise <span class="type">FALSE</span>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-event-listener-register-full"></a><h3>atspi_event_listener_register_full ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
atspi_event_listener_register_full (<em class="parameter"><code><a class="link" href="AtspiEventListener.html" title="AtspiEventListener"><span class="type">AtspiEventListener</span></a> *listener</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *event_type</code></em>,
<em class="parameter"><code><span class="type">GArray</span> *properties</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Adds an in-process callback function to an existing <a class="link" href="AtspiEventListener.html" title="AtspiEventListener"><span class="type">AtspiEventListener</span></a>.</p>
<div class="refsect3">
<a name="atspi-event-listener-register-full.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>listener</p></td>
<td class="parameter_description"><p>The <a class="link" href="AtspiEventListener.html" title="AtspiEventListener"><span class="type">AtspiEventListener</span></a> to register against an event type.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>event_type</p></td>
<td class="parameter_description"><p>a character string indicating the type of events for which
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>
for a description of the format and legal event types.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>properties</p></td>
<td class="parameter_description"><p>a list of
properties that should be sent along with the event. The
properties are valued for the duration of the event callback.k
TODO: Document. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> gchar*][<acronym title="The data is owned by the callee, which is responsible of freeing it."><span class="acronym">transfer none</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atspi-event-listener-register-full.returns"></a><h4>Returns</h4>
<p> <span class="type">TRUE</span> if successful, otherwise <span class="type">FALSE</span>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-event-listener-deregister"></a><h3>atspi_event_listener_deregister ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
atspi_event_listener_deregister (<em class="parameter"><code><a class="link" href="AtspiEventListener.html" title="AtspiEventListener"><span class="type">AtspiEventListener</span></a> *listener</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *event_type</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Deregisters an <a class="link" href="AtspiEventListener.html" title="AtspiEventListener"><span class="type">AtspiEventListener</span></a> from the registry, for a specific
event type.</p>
<div class="refsect3">
<a name="atspi-event-listener-deregister.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>listener</p></td>
<td class="parameter_description"><p>The <a class="link" href="AtspiEventListener.html" title="AtspiEventListener"><span class="type">AtspiEventListener</span></a> to deregister.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>event_type</p></td>
<td class="parameter_description"><p>a string specifying the event type for which this
listener is to be deregistered.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atspi-event-listener-deregister.returns"></a><h4>Returns</h4>
<p> <span class="type">TRUE</span> if successful, otherwise <span class="type">FALSE</span>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-event-listener-deregister-from-callback"></a><h3>atspi_event_listener_deregister_from_callback ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
atspi_event_listener_deregister_from_callback
(<em class="parameter"><code><a class="link" href="AtspiEventListener.html#AtspiEventListenerCB" title="AtspiEventListenerCB ()"><span class="type">AtspiEventListenerCB</span></a> callback</code></em>,
<em class="parameter"><code><span class="type">void</span> *user_data</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *event_type</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Deregisters an <a class="link" href="AtspiEventListener.html#AtspiEventListenerCB" title="AtspiEventListenerCB ()"><span class="type">AtspiEventListenerCB</span></a> from the registry, for a specific
event type.</p>
<div class="refsect3">
<a name="atspi-event-listener-deregister-from-callback.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>callback</p></td>
<td class="parameter_description"><p>the <a class="link" href="AtspiEventListener.html#AtspiEventListenerCB" title="AtspiEventListenerCB ()"><span class="type">AtspiEventListenerCB</span></a> registered against an
event type. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="The callback is valid only during the call to the method."><span class="acronym">scope call</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>User data that was passed in for this callback. </p></td>
<td class="parameter_annotations"><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></td>
</tr>
<tr>
<td class="parameter_name"><p>event_type</p></td>
<td class="parameter_description"><p>a string specifying the event type for which this
listener is to be deregistered.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atspi-event-listener-deregister-from-callback.returns"></a><h4>Returns</h4>
<p> <span class="type">TRUE</span> if successful, otherwise <span class="type">FALSE</span>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-event-listener-deregister-no-data"></a><h3>atspi_event_listener_deregister_no_data ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
atspi_event_listener_deregister_no_data
(<em class="parameter"><code><a class="link" href="AtspiEventListener.html#AtspiEventListenerSimpleCB" title="AtspiEventListenerSimpleCB ()"><span class="type">AtspiEventListenerSimpleCB</span></a> callback</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *event_type</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>deregisters an <a class="link" href="AtspiEventListener.html#AtspiEventListenerSimpleCB" title="AtspiEventListenerSimpleCB ()"><span class="type">AtspiEventListenerSimpleCB</span></a> from the registry, for a specific
event type.</p>
<p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
<div class="refsect3">
<a name="atspi-event-listener-deregister-no-data.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>callback</p></td>
<td class="parameter_description"><p>the <a class="link" href="AtspiEventListener.html#AtspiEventListenerSimpleCB" title="AtspiEventListenerSimpleCB ()"><span class="type">AtspiEventListenerSimpleCB</span></a> registered against
an event type. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="The callback is valid only during the call to the method."><span class="acronym">scope call</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>event_type</p></td>
<td class="parameter_description"><p>a string specifying the event type for which this
listener is to be deregistered.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atspi-event-listener-deregister-no-data.returns"></a><h4>Returns</h4>
<p> <span class="type">TRUE</span> if successful, otherwise <span class="type">FALSE</span>.</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="AtspiEventListener.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="AtspiEventListener-struct"></a><h3>struct AtspiEventListener</h3>
<pre class="programlisting">struct AtspiEventListener;</pre>
</div>
<hr>
<div class="refsect2">
<a name="AtspiEventListenerClass"></a><h3>struct AtspiEventListenerClass</h3>
<pre class="programlisting">struct AtspiEventListenerClass {
GObjectClass parent_class;
};
</pre>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.33.1</div>
</body>
</html>