| Current File : //proc/thread-self/root/kunden/usr/share/gtk-doc/html/libatspi/libatspi-atspi-registry.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>atspi-registry: 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-component.html" title="atspi-component">
<link rel="next" href="libatspi-atspi-types.html" title="atspi-types">
<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="#libatspi-atspi-registry.description" class="shortcut">Description</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-component.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libatspi-atspi-types.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libatspi-atspi-registry"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libatspi-atspi-registry.top_of_page"></a>atspi-registry</span></h2>
<p>atspi-registry</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libatspi-atspi-registry.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">GType</span>
</td>
<td class="function_name">
<a class="link" href="libatspi-atspi-registry.html#atspi-key-definition-get-type" title="atspi_key_definition_get_type ()">atspi_key_definition_get_type</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gint</span>
</td>
<td class="function_name">
<a class="link" href="libatspi-atspi-registry.html#atspi-get-desktop-count" title="atspi_get_desktop_count ()">atspi_get_desktop_count</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="returnvalue">AtspiAccessible</span></a> *
</td>
<td class="function_name">
<a class="link" href="libatspi-atspi-registry.html#atspi-get-desktop" title="atspi_get_desktop ()">atspi_get_desktop</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GArray</span> *
</td>
<td class="function_name">
<a class="link" href="libatspi-atspi-registry.html#atspi-get-desktop-list" title="atspi_get_desktop_list ()">atspi_get_desktop_list</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="libatspi-atspi-registry.html#atspi-register-keystroke-listener" title="atspi_register_keystroke_listener ()">atspi_register_keystroke_listener</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="libatspi-atspi-registry.html#atspi-deregister-keystroke-listener" title="atspi_deregister_keystroke_listener ()">atspi_deregister_keystroke_listener</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="libatspi-atspi-registry.html#atspi-register-device-event-listener" title="atspi_register_device_event_listener ()">atspi_register_device_event_listener</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="libatspi-atspi-registry.html#atspi-deregister-device-event-listener" title="atspi_deregister_device_event_listener ()">atspi_deregister_device_event_listener</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="libatspi-atspi-registry.html#atspi-generate-keyboard-event" title="atspi_generate_keyboard_event ()">atspi_generate_keyboard_event</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="libatspi-atspi-registry.html#atspi-generate-mouse-event" title="atspi_generate_mouse_event ()">atspi_generate_mouse_event</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="libatspi-atspi-registry.html#atspi-set-reference-window" title="atspi_set_reference_window ()">atspi_set_reference_window</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libatspi-atspi-registry.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="libatspi-atspi-registry.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="atspi-key-definition-get-type"></a><h3>atspi_key_definition_get_type ()</h3>
<pre class="programlisting"><span class="returnvalue">GType</span>
atspi_key_definition_get_type ();</pre>
</div>
<hr>
<div class="refsect2">
<a name="atspi-get-desktop-count"></a><h3>atspi_get_desktop_count ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span>
atspi_get_desktop_count ();</pre>
<p>Gets the number of virtual desktops.
NOTE: multiple virtual desktops are not implemented yet; as a
consequence, this function always returns 1.</p>
<div class="refsect3">
<a name="atspi-get-desktop-count.returns"></a><h4>Returns</h4>
<p> a <span class="type">gint</span> indicating the number of active virtual desktops.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-get-desktop"></a><h3>atspi_get_desktop ()</h3>
<pre class="programlisting"><a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="returnvalue">AtspiAccessible</span></a> *
atspi_get_desktop (<em class="parameter"><code><span class="type">gint</span> i</code></em>);</pre>
<p>Gets the virtual desktop indicated by index <em class="parameter"><code>i</code></em>
.
NOTE: currently multiple virtual desktops are not implemented;
as a consequence, any <em class="parameter"><code>i</code></em>
value different from 0 will not return a
virtual desktop - instead it will return NULL.</p>
<div class="refsect3">
<a name="atspi-get-desktop.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>i</p></td>
<td class="parameter_description"><p>a <span class="type">gint</span> indicating which of the accessible desktops is to be returned.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atspi-get-desktop.returns"></a><h4>Returns</h4>
<p>a pointer to the <em class="parameter"><code>i</code></em>
-th virtual desktop's
<a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> representation. </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-get-desktop-list"></a><h3>atspi_get_desktop_list ()</h3>
<pre class="programlisting"><span class="returnvalue">GArray</span> *
atspi_get_desktop_list ();</pre>
<p>Gets the list of virtual desktops. On return, <em class="parameter"><code>list</code></em>
will point
to a newly-created, NULL terminated array of virtual desktop
pointers.
It is the responsibility of the caller to free this array when
it is no longer needed.
NOTE: currently multiple virtual desktops are not implemented;
this implementation always returns a <span class="type">Garray</span> with a single
<a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> desktop.</p>
<div class="refsect3">
<a name="atspi-get-desktop-list.returns"></a><h4>Returns</h4>
<p>a <span class="type">GArray</span> of
desktops. </p>
<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> AtspiAccessible*][<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-register-keystroke-listener"></a><h3>atspi_register_keystroke_listener ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
atspi_register_keystroke_listener (<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><span class="type">GArray</span> *key_set</code></em>,
<em class="parameter"><code><a class="link" href="libatspi-atspi-types.html#AtspiKeyMaskType" title="AtspiKeyMaskType"><span class="type">AtspiKeyMaskType</span></a> modmask</code></em>,
<em class="parameter"><code><a class="link" href="libatspi-atspi-types.html#AtspiKeyEventMask" title="AtspiKeyEventMask"><span class="type">AtspiKeyEventMask</span></a> event_types</code></em>,
<em class="parameter"><code><a class="link" href="libatspi-atspi-types.html#AtspiKeyListenerSyncType" title="enum AtspiKeyListenerSyncType"><span class="type">AtspiKeyListenerSyncType</span></a> sync_type</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Registers a listener for keystroke events, either pre-emptively for
all windows (<a class="link" href="libatspi-atspi-types.html#ATSPI-KEYLISTENER-ALL-WINDOWS:CAPS"><code class="literal">ATSPI_KEYLISTENER_ALL_WINDOWS</code></a>),
non-preemptively (<a class="link" href="libatspi-atspi-types.html#ATSPI-KEYLISTENER-NOSYNC:CAPS"><code class="literal">ATSPI_KEYLISTENER_NOSYNC</code></a>), or
pre-emptively at the toolkit level (<a class="link" href="libatspi-atspi-types.html#ATSPI-KEYLISTENER-CANCONSUME:CAPS"><code class="literal">ATSPI_KEYLISTENER_CANCONSUME</code></a>).
If ALL_WINDOWS or CANCONSUME are used, the event is consumed
upon receipt if one of <em class="parameter"><code>listener</code></em>
's callbacks returns <code class="literal">TRUE</code>
(other sync_type values may be available in the future).</p>
<div class="refsect3">
<a name="atspi-register-keystroke-listener.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>a pointer to the <a class="link" href="AtspiDeviceListener.html" title="AtspiDeviceListener"><span class="type">AtspiDeviceListener</span></a> for which
keystroke events are requested.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>key_set</p></td>
<td class="parameter_description"><p>a pointer to the
<a class="link" href="libatspi-atspi-types.html#AtspiKeyDefinition"><span class="type">AtspiKeyDefinition</span></a> array indicating which keystroke events are
requested, or NULL
to indicate that all keycodes and keyvals for the specified
modifier set are to be included. </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> AtspiKeyDefinition][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>modmask</p></td>
<td class="parameter_description"><p>an <a class="link" href="libatspi-atspi-types.html#AtspiKeyMaskType" title="AtspiKeyMaskType"><span class="type">AtspiKeyMaskType</span></a> mask indicating which
key event modifiers must be set in combination with <em class="parameter"><code>keys</code></em>
,
events will only be reported for key events for which all
modifiers in <em class="parameter"><code>modmask</code></em>
are set. If you wish to listen for
events with multiple modifier combinations, you must call
<a class="link" href="libatspi-atspi-registry.html#atspi-register-keystroke-listener" title="atspi_register_keystroke_listener ()"><span class="type">atspi_register_keystroke_listener</span></a> once for each
combination.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>event_types</p></td>
<td class="parameter_description"><p>an <a class="link" href="libatspi-atspi-types.html#AtspiKeyMaskType" title="AtspiKeyMaskType"><span class="type">AtspiKeyMaskType</span></a> mask indicating which
types of key events are requested (<a class="link" href="libatspi-atspi-constants.html#ATSPI-KEY-PRESSED:CAPS"><code class="literal">ATSPI_KEY_PRESSED</code></a> etc.).</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>sync_type</p></td>
<td class="parameter_description"><p>an <a class="link" href="libatspi-atspi-types.html#AtspiKeyListenerSyncType" title="enum AtspiKeyListenerSyncType"><span class="type">AtspiKeyListenerSyncType</span></a> parameter indicating
the behavior of the notification/listener transaction.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>a pointer to a <code class="literal">NULL</code> <span class="type">GError</span> pointer, or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<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-register-keystroke-listener.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if successful, otherwise <code class="literal">FALSE</code>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-deregister-keystroke-listener"></a><h3>atspi_deregister_keystroke_listener ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
atspi_deregister_keystroke_listener (<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><span class="type">GArray</span> *key_set</code></em>,
<em class="parameter"><code><a class="link" href="libatspi-atspi-types.html#AtspiKeyMaskType" title="AtspiKeyMaskType"><span class="type">AtspiKeyMaskType</span></a> modmask</code></em>,
<em class="parameter"><code><a class="link" href="libatspi-atspi-types.html#AtspiKeyEventMask" title="AtspiKeyEventMask"><span class="type">AtspiKeyEventMask</span></a> event_types</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Removes a keystroke event listener from the registry's listener queue,
ceasing notification of events with modifiers matching <em class="parameter"><code>modmask</code></em>
.</p>
<div class="refsect3">
<a name="atspi-deregister-keystroke-listener.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>a pointer to the <a class="link" href="AtspiDeviceListener.html" title="AtspiDeviceListener"><span class="type">AtspiDeviceListener</span></a> for which
keystroke events are requested.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>key_set</p></td>
<td class="parameter_description"><p>a pointer to the
<a class="link" href="libatspi-atspi-types.html#AtspiKeyDefinition"><span class="type">AtspiKeyDefinition</span></a> array indicating which keystroke events are
requested, or <code class="literal">NULL</code>
to indicate that all keycodes and keyvals for the specified
modifier set are to be included. </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> AtspiKeyDefinition][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>modmask</p></td>
<td class="parameter_description"><p>the key modifier mask for which this listener is to be
'deregistered' (of type <a class="link" href="libatspi-atspi-types.html#AtspiKeyMaskType" title="AtspiKeyMaskType"><span class="type">AtspiKeyMaskType</span></a>).</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>event_types</p></td>
<td class="parameter_description"><p>an <a class="link" href="libatspi-atspi-types.html#AtspiKeyMaskType" title="AtspiKeyMaskType"><span class="type">AtspiKeyMaskType</span></a> mask indicating which
types of key events were requested (<a class="link" href="libatspi-atspi-constants.html#ATSPI-KEY-PRESSED:CAPS"><code class="literal">ATSPI_KEY_PRESSED</code></a>, etc.).</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>a pointer to a <code class="literal">NULL</code> <span class="type">GError</span> pointer, or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<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-deregister-keystroke-listener.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if successful, otherwise <code class="literal">FALSE</code>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-register-device-event-listener"></a><h3>atspi_register_device_event_listener ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
atspi_register_device_event_listener (<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="libatspi-atspi-types.html#AtspiDeviceEventMask" title="AtspiDeviceEventMask"><span class="type">AtspiDeviceEventMask</span></a> event_types</code></em>,
<em class="parameter"><code><span class="type">void</span> *filter</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Registers a listener for device events, for instance button events.</p>
<div class="refsect3">
<a name="atspi-register-device-event-listener.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>a pointer to the <a class="link" href="AtspiDeviceListener.html" title="AtspiDeviceListener"><span class="type">AtspiDeviceListener</span></a> which requests
the events.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>event_types</p></td>
<td class="parameter_description"><p>an <a class="link" href="libatspi-atspi-types.html#AtspiDeviceEventMask" title="AtspiDeviceEventMask"><span class="type">AtspiDeviceEventMask</span></a> mask indicating which
types of key events are requested (<a class="link" href="libatspi-atspi-constants.html#ATSPI-KEY-PRESSED:CAPS"><code class="literal">ATSPI_KEY_PRESSED</code></a>, etc.).</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>filter</p></td>
<td class="parameter_description"><p>Unused parameter. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>a pointer to a <code class="literal">NULL</code> <span class="type">GError</span> pointer, or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<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-register-device-event-listener.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if successful, otherwise <code class="literal">FALSE</code>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-deregister-device-event-listener"></a><h3>atspi_deregister_device_event_listener ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
atspi_deregister_device_event_listener
(<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><span class="type">void</span> *filter</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Removes a device event listener from the registry's listener queue,
ceasing notification of events of the specified type.</p>
<div class="refsect3">
<a name="atspi-deregister-device-event-listener.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>a pointer to the <a class="link" href="AtspiDeviceListener.html" title="AtspiDeviceListener"><span class="type">AtspiDeviceListener</span></a> for which
device events are requested.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>filter</p></td>
<td class="parameter_description"><p>Unused parameter. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>a pointer to a <code class="literal">NULL</code> <span class="type">GError</span> pointer, or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<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-deregister-device-event-listener.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if successful, otherwise <code class="literal">FALSE</code>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-generate-keyboard-event"></a><h3>atspi_generate_keyboard_event ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
atspi_generate_keyboard_event (<em class="parameter"><code><span class="type">glong</span> keyval</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *keystring</code></em>,
<em class="parameter"><code><a class="link" href="libatspi-atspi-constants.html#AtspiKeySynthType" title="enum AtspiKeySynthType"><span class="type">AtspiKeySynthType</span></a> synth_type</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Synthesizes a keyboard event (as if a hardware keyboard event occurred in the
current UI context).</p>
<div class="refsect3">
<a name="atspi-generate-keyboard-event.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>keyval</p></td>
<td class="parameter_description"><p>a <span class="type">gint</span> indicating the keycode or keysym or modifier mask of the
key event being synthesized.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>keystring</p></td>
<td class="parameter_description"><p>an (optional) UTF-8 string which, if
<em class="parameter"><code>synth_type</code></em>
is <a class="link" href="libatspi-atspi-constants.html#ATSPI-KEY-STRING:CAPS"><code class="literal">ATSPI_KEY_STRING</code></a>, indicates a 'composed'
keyboard input string being synthesized; this type of
keyboard event synthesis does not emulate hardware
keypresses but injects the string as though a composing
input method (such as XIM) were used. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>synth_type</p></td>
<td class="parameter_description"><p>an <a class="link" href="libatspi-atspi-constants.html#AtspiKeySynthType" title="enum AtspiKeySynthType"><span class="type">AtspiKeySynthType</span></a> flag indicating whether <em class="parameter"><code>keyval</code></em>
is to be interpreted as a keysym rather than a keycode
(<a class="link" href="libatspi-atspi-constants.html#ATSPI-KEY-SYM:CAPS"><code class="literal">ATSPI_KEY_SYM</code></a>) or a string (<a class="link" href="libatspi-atspi-constants.html#ATSPI-KEY-STRING:CAPS"><code class="literal">ATSPI_KEY_STRING</code></a>) or a modifier
mask (<a class="link" href="libatspi-atspi-constants.html#ATSPI-KEY-LOCKMODIFIERS:CAPS"><code class="literal">ATSPI_KEY_LOCKMODIFIERS</code></a> and <a class="link" href="libatspi-atspi-constants.html#ATSPI-KEY-UNLOCKMODIFIERS:CAPS"><code class="literal">ATSPI_KEY_UNLOCKMODIFIERS</code></a>), or
whether to synthesize <a class="link" href="libatspi-atspi-constants.html#ATSPI-KEY-PRESS:CAPS"><code class="literal">ATSPI_KEY_PRESS</code></a>,
<a class="link" href="libatspi-atspi-constants.html#ATSPI-KEY-RELEASE:CAPS"><code class="literal">ATSPI_KEY_RELEASE</code></a>, or both (<a class="link" href="libatspi-atspi-constants.html#ATSPI-KEY-PRESSRELEASE:CAPS"><code class="literal">ATSPI_KEY_PRESSRELEASE</code></a>).</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>a pointer to a <code class="literal">NULL</code> <span class="type">GError</span> pointer, or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<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-generate-keyboard-event.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if successful, otherwise <code class="literal">FALSE</code>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-generate-mouse-event"></a><h3>atspi_generate_mouse_event ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
atspi_generate_mouse_event (<em class="parameter"><code><span class="type">glong</span> x</code></em>,
<em class="parameter"><code><span class="type">glong</span> y</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Synthesizes a mouse event at a specific screen coordinate.
Most AT clients should use the <span class="type">AccessibleAction</span> interface when
tempted to generate mouse events, rather than this method.
Event names: b1p = button 1 press; b2r = button 2 release;
b3c = button 3 click; b2d = button 2 double-click;
abs = absolute motion; rel = relative motion.</p>
<div class="refsect3">
<a name="atspi-generate-mouse-event.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>x</p></td>
<td class="parameter_description"><p>a <span class="type">glong</span> indicating the screen x coordinate of the mouse event.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>y</p></td>
<td class="parameter_description"><p>a <span class="type">glong</span> indicating the screen y coordinate of the mouse event.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>a string indicating which mouse event to be synthesized
(e.g. "b1p", "b1c", "b2r", "rel", "abs").</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>a pointer to a <code class="literal">NULL</code> <span class="type">GError</span> pointer, or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<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-generate-mouse-event.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if successful, otherwise <code class="literal">FALSE</code>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-set-reference-window"></a><h3>atspi_set_reference_window ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
atspi_set_reference_window (<em class="parameter"><code><a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> *accessible</code></em>);</pre>
<p>Sets the reference window that will be used when atspi_generate_mouse_event
is called. Coordinates will be assumed to be relative to this window. This
is needed because, due to Wayland's security model, it is not currently
possible to retrieve global coordinates.
If NULL is passed, then AT-SPI will use the window that has focus at the
time that atspi_generate_mouse_event is called.</p>
<div class="refsect3">
<a name="atspi-set-reference-window.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>accessible</p></td>
<td class="parameter_description"><p>the <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> corresponding to the window to select.
should be a top-level window with a role of
ATSPI_ROLE_APPLICATION.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.33.1</div>
</body>
</html>