| Current File : //proc/self/root/kunden/usr/share/gtk-doc/html/libatspi/libatspi-atspi-misc.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-misc: 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-constants.html" title="atspi-constants">
<link rel="next" href="object-tree.html" title="Object Hierarchy">
<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-misc.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-constants.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="object-tree.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libatspi-atspi-misc"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libatspi-atspi-misc.top_of_page"></a>atspi-misc</span></h2>
<p>atspi-misc</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libatspi-atspi-misc.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">int</span>
</td>
<td class="function_name">
<a class="link" href="libatspi-atspi-misc.html#atspi-init" title="atspi_init ()">atspi_init</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-misc.html#atspi-is-initialized" title="atspi_is_initialized ()">atspi_is_initialized</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-misc.html#atspi-set-timeout" title="atspi_set_timeout ()">atspi_set_timeout</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-misc.html#atspi-set-main-context" title="atspi_set_main_context ()">atspi_set_main_context</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-misc.html#atspi-event-main" title="atspi_event_main ()">atspi_event_main</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-misc.html#atspi-event-quit" title="atspi_event_quit ()">atspi_event_quit</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="libatspi-atspi-misc.html#atspi-exit" title="atspi_exit ()">atspi_exit</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libatspi-atspi-misc.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="libatspi-atspi-misc.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="atspi-init"></a><h3>atspi_init ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
atspi_init (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Connects to the accessibility registry and initializes the SPI.</p>
<div class="refsect3">
<a name="atspi-init.returns"></a><h4>Returns</h4>
<p> 0 on success, 1 if already initialized, or an integer error code. </p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-is-initialized"></a><h3>atspi_is_initialized ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
atspi_is_initialized (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Indicates whether AT-SPI has been initialized.</p>
<div class="refsect3">
<a name="atspi-is-initialized.returns"></a><h4>Returns</h4>
<p> <code class="literal">True</code> if initialized; <code class="literal">False</code> otherwise.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-set-timeout"></a><h3>atspi_set_timeout ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
atspi_set_timeout (<em class="parameter"><code><span class="type">gint</span> val</code></em>,
<em class="parameter"><code><span class="type">gint</span> startup_time</code></em>);</pre>
<p>Set the timeout used for method calls. If this is not set explicitly,
a default of 0.8 ms is used.
Note that at-spi2-registryd currently uses a timeout of 3 seconds when
sending a keyboard event notification. This means that, if an AT makes
a call in response to the keyboard notification and the application
being called does not respond before the timeout is reached,
at-spi2-registryd will time out on the keyboard event notification and
pass the key onto the application (ie, reply to indicate that the key
was not consumed), so this may make it undesirable to set a timeout
larger than 3 seconds.</p>
<p>By default, the normal timeout is set to 800 ms, and the application startup
timeout is set to 15 seconds.</p>
<div class="refsect3">
<a name="atspi-set-timeout.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>val</p></td>
<td class="parameter_description"><p>The timeout value, in milliseconds, or -1 to disable the timeout.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>startup_time</p></td>
<td class="parameter_description"><p>The amount of time, in milliseconds, to allow to pass
before enforcing timeouts on an application. Can be used to prevent
timeout exceptions if an application is likely to block for an extended
period of time on initialization. -1 can be passed to disable this
behavior.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-set-main-context"></a><h3>atspi_set_main_context ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
atspi_set_main_context (<em class="parameter"><code><span class="type">GMainContext</span> *cnx</code></em>);</pre>
<p>Sets the main loop context that AT-SPI should assume is in use when
setting an idle callback.
This function should be called by application-side implementors (ie,
at-spi2-atk) when it is desirable to re-enter the main loop.</p>
<div class="refsect3">
<a name="atspi-set-main-context.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>cnx</p></td>
<td class="parameter_description"><p>The <span class="type">GMainContext</span> to use.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-event-main"></a><h3>atspi_event_main ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
atspi_event_main ();</pre>
<p>Starts/enters the main event loop for the AT-SPI services.</p>
<p>NOTE: This method does not return control; it is exited via a call to
<a class="link" href="libatspi-atspi-misc.html#atspi-event-quit" title="atspi_event_quit ()"><span class="type">atspi_event_quit</span></a> from within an event handler.</p>
</div>
<hr>
<div class="refsect2">
<a name="atspi-event-quit"></a><h3>atspi_event_quit ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
atspi_event_quit ();</pre>
<p>Quits the last main event loop for the AT-SPI services,
See: <a class="link" href="libatspi-atspi-misc.html#atspi-event-main" title="atspi_event_main ()"><span class="type">atspi_event_main</span></a></p>
</div>
<hr>
<div class="refsect2">
<a name="atspi-exit"></a><h3>atspi_exit ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
atspi_exit ();</pre>
<p>Disconnects from <span class="type">AtspiRegistry</span> instances and releases
any floating resources. Call only once at exit.</p>
<div class="refsect3">
<a name="atspi-exit.returns"></a><h4>Returns</h4>
<p> 0 if there were no leaks, otherwise other integer values.</p>
</div>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.33.1</div>
</body>
</html>