| Current File : //proc/self/root/kunden/usr/share/gtk-doc/html/libatspi/AtspiDeviceListener.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>AtspiDeviceListener: 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="AtspiAccessible.html" title="AtspiAccessible">
<link rel="next" href="AtspiHyperlink.html" title="AtspiHyperlink">
<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="#AtspiDeviceListener.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#AtspiDeviceListener.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="AtspiAccessible.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="AtspiHyperlink.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="AtspiDeviceListener"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="AtspiDeviceListener.top_of_page"></a>AtspiDeviceListener</span></h2>
<p>AtspiDeviceListener</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="AtspiDeviceListener.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">gboolean</span>
</td>
<td class="function_name">
<span class="c_punctuation">(</span><a class="link" href="AtspiDeviceListener.html#AtspiDeviceListenerCB" title="AtspiDeviceListenerCB ()">*AtspiDeviceListenerCB</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<span class="c_punctuation">(</span><a class="link" href="AtspiDeviceListener.html#AtspiDeviceListenerSimpleCB" title="AtspiDeviceListenerSimpleCB ()">*AtspiDeviceListenerSimpleCB</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="AtspiDeviceListener.html" title="AtspiDeviceListener"><span class="returnvalue">AtspiDeviceListener</span></a> *
</td>
<td class="function_name">
<a class="link" href="AtspiDeviceListener.html#atspi-device-listener-new" title="atspi_device_listener_new ()">atspi_device_listener_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="AtspiDeviceListener.html" title="AtspiDeviceListener"><span class="returnvalue">AtspiDeviceListener</span></a> *
</td>
<td class="function_name">
<a class="link" href="AtspiDeviceListener.html#atspi-device-listener-new-simple" title="atspi_device_listener_new_simple ()">atspi_device_listener_new_simple</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="AtspiDeviceListener.html#atspi-device-listener-add-callback" title="atspi_device_listener_add_callback ()">atspi_device_listener_add_callback</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="AtspiDeviceListener.html#atspi-device-listener-remove-callback" title="atspi_device_listener_remove_callback ()">atspi_device_listener_remove_callback</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="AtspiDeviceListener.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="AtspiDeviceListener.html#AtspiDeviceListener-struct" title="struct AtspiDeviceListener">AtspiDeviceListener</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="AtspiDeviceListener.html#AtspiDeviceListenerClass" title="struct AtspiDeviceListenerClass">AtspiDeviceListenerClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="AtspiDeviceListener.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GObject
<span class="lineart">╰──</span> AtspiDeviceListener
</pre>
</div>
<div class="refsect1">
<a name="AtspiDeviceListener.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="AtspiDeviceListener.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="AtspiDeviceListenerCB"></a><h3>AtspiDeviceListenerCB ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
<span class="c_punctuation">(</span>*AtspiDeviceListenerCB<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="libatspi-atspi-types.html#AtspiDeviceEvent"><span class="type">AtspiDeviceEvent</span></a> *stroke</code></em>,
<em class="parameter"><code><span class="type">void</span> *user_data</code></em>);</pre>
<p>A callback function prototype via which clients receive device event notifications.</p>
<div class="refsect3">
<a name="AtspiDeviceListenerCB.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>stroke</p></td>
<td class="parameter_description"><p>The <a class="link" href="libatspi-atspi-types.html#AtspiDeviceEvent"><span class="type">AtspiDeviceEvent</span></a> for which notification is
being received. </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>Data which is passed to the client each time this callback is notified.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="AtspiDeviceListenerCB.returns"></a><h4>Returns</h4>
<p> <span class="type">TRUE</span> if the client wishes to consume/preempt the event, preventing it from being
relayed to the currently focussed application, <span class="type">FALSE</span> if the event delivery should proceed as normal.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="AtspiDeviceListenerSimpleCB"></a><h3>AtspiDeviceListenerSimpleCB ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
<span class="c_punctuation">(</span>*AtspiDeviceListenerSimpleCB<span class="c_punctuation">)</span> (<em class="parameter"><code>const <a class="link" href="libatspi-atspi-types.html#AtspiDeviceEvent"><span class="type">AtspiDeviceEvent</span></a> *stroke</code></em>);</pre>
<p>Similar to <a class="link" href="AtspiDeviceListener.html#AtspiDeviceListenerCB" title="AtspiDeviceListenerCB ()"><span class="type">AtspiDeviceListenerCB</span></a>, but with no user data.</p>
<div class="refsect3">
<a name="AtspiDeviceListenerSimpleCB.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>stroke</p></td>
<td class="parameter_description"><p>The <a class="link" href="libatspi-atspi-types.html#AtspiDeviceEvent"><span class="type">AtspiDeviceEvent</span></a> for which notification is
being received. </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 class="refsect3">
<a name="AtspiDeviceListenerSimpleCB.returns"></a><h4>Returns</h4>
<p> <span class="type">TRUE</span> if the client wishes to consume/preempt the event, preventing it from being
relayed to the currently focussed application, <span class="type">FALSE</span> if the event delivery should proceed as normal.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-device-listener-new"></a><h3>atspi_device_listener_new ()</h3>
<pre class="programlisting"><a class="link" href="AtspiDeviceListener.html" title="AtspiDeviceListener"><span class="returnvalue">AtspiDeviceListener</span></a> *
atspi_device_listener_new (<em class="parameter"><code><a class="link" href="AtspiDeviceListener.html#AtspiDeviceListenerCB" title="AtspiDeviceListenerCB ()"><span class="type">AtspiDeviceListenerCB</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>);</pre>
<p>Creates a new <a class="link" href="AtspiDeviceListener.html" title="AtspiDeviceListener"><span class="type">AtspiDeviceListener</span></a> with a specified callback function.</p>
<div class="refsect3">
<a name="atspi-device-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="AtspiDeviceListener.html#AtspiDeviceListenerCB" title="AtspiDeviceListenerCB ()"><span class="type">AtspiDeviceListenerCB</span></a> callback function,
or NULL. </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>a pointer to data which will be passed to the
callback when invoked. </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. It can be NULL.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atspi-device-listener-new.returns"></a><h4>Returns</h4>
<p>a pointer to a newly-created <a class="link" href="AtspiDeviceListener.html" title="AtspiDeviceListener"><span class="type">AtspiDeviceListener</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-device-listener-new-simple"></a><h3>atspi_device_listener_new_simple ()</h3>
<pre class="programlisting"><a class="link" href="AtspiDeviceListener.html" title="AtspiDeviceListener"><span class="returnvalue">AtspiDeviceListener</span></a> *
atspi_device_listener_new_simple (<em class="parameter"><code><a class="link" href="AtspiDeviceListener.html#AtspiDeviceListenerSimpleCB" title="AtspiDeviceListenerSimpleCB ()"><span class="type">AtspiDeviceListenerSimpleCB</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="AtspiDeviceListener.html" title="AtspiDeviceListener"><span class="type">AtspiDeviceListener</span></a> with a specified callback function.
This method is similar to <a class="link" href="AtspiDeviceListener.html#atspi-device-listener-new" title="atspi_device_listener_new ()"><span class="type">atspi_device_listener_new</span></a>, but callback
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-device-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="AtspiDeviceListener.html#AtspiDeviceListenerCB" title="AtspiDeviceListenerCB ()"><span class="type">AtspiDeviceListenerCB</span></a> callback function,
or NULL. </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. It an be NULL.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atspi-device-listener-new-simple.returns"></a><h4>Returns</h4>
<p> a pointer to a newly-created <a class="link" href="AtspiDeviceListener.html" title="AtspiDeviceListener"><span class="type">AtspiDeviceListener</span></a>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-device-listener-add-callback"></a><h3>atspi_device_listener_add_callback ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
atspi_device_listener_add_callback (<em class="parameter"><code><a class="link" href="AtspiDeviceListener.html" title="AtspiDeviceListener"><span class="type">AtspiDeviceListener</span></a> *listener</code></em>,
<em class="parameter"><code><a class="link" href="AtspiDeviceListener.html#AtspiDeviceListenerCB" title="AtspiDeviceListenerCB ()"><span class="type">AtspiDeviceListenerCB</span></a> callback</code></em>,
<em class="parameter"><code><span class="type">GDestroyNotify</span> callback_destroyed</code></em>,
<em class="parameter"><code><span class="type">void</span> *user_data</code></em>);</pre>
<p>Adds an in-process callback function to an existing <a class="link" href="AtspiDeviceListener.html" title="AtspiDeviceListener"><span class="type">AtspiDeviceListener</span></a>.</p>
<div class="refsect3">
<a name="atspi-device-listener-add-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>listener</p></td>
<td class="parameter_description"><p>the <a class="link" href="AtspiDeviceListener.html" title="AtspiDeviceListener"><span class="type">AtspiDeviceListener</span></a> instance to modify.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>callback</p></td>
<td class="parameter_description"><p>an <a class="link" href="AtspiDeviceListener.html#AtspiDeviceListenerCB" title="AtspiDeviceListenerCB ()"><span class="type">AtspiDeviceListenerCB</span></a> function pointer. </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. It can be NULL.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>a pointer to data which will be passed to the
callback when invoked. </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>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-device-listener-remove-callback"></a><h3>atspi_device_listener_remove_callback ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
atspi_device_listener_remove_callback (<em class="parameter"><code><a class="link" href="AtspiDeviceListener.html" title="AtspiDeviceListener"><span class="type">AtspiDeviceListener</span></a> *listener</code></em>,
<em class="parameter"><code><a class="link" href="AtspiDeviceListener.html#AtspiDeviceListenerCB" title="AtspiDeviceListenerCB ()"><span class="type">AtspiDeviceListenerCB</span></a> callback</code></em>);</pre>
<p>Removes an in-process callback function from an existing
<a class="link" href="AtspiDeviceListener.html" title="AtspiDeviceListener"><span class="type">AtspiDeviceListener</span></a>.</p>
<div class="refsect3">
<a name="atspi-device-listener-remove-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>listener</p></td>
<td class="parameter_description"><p>the <a class="link" href="AtspiDeviceListener.html" title="AtspiDeviceListener"><span class="type">AtspiDeviceListener</span></a> instance to modify.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>callback</p></td>
<td class="parameter_description"><p>an <a class="link" href="AtspiDeviceListener.html#AtspiDeviceListenerCB" title="AtspiDeviceListenerCB ()"><span class="type">AtspiDeviceListenerCB</span></a> function pointer. </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>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="AtspiDeviceListener.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="AtspiDeviceListener-struct"></a><h3>struct AtspiDeviceListener</h3>
<pre class="programlisting">struct AtspiDeviceListener;</pre>
</div>
<hr>
<div class="refsect2">
<a name="AtspiDeviceListenerClass"></a><h3>struct AtspiDeviceListenerClass</h3>
<pre class="programlisting">struct AtspiDeviceListenerClass {
GObjectClass parent_class;
gboolean (*device_event) (AtspiDeviceListener *listener, const AtspiDeviceEvent *event);
};
</pre>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.33.1</div>
</body>
</html>