doc/libatspi/html/libatspi-atspi-misc.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <title>atspi-misc</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.77.1">
   7 <link rel="home" href="index.html" title="libatspi Reference Manual">
   8 <link rel="up" href="ch01.html" title="API reference">
   9 <link rel="prev" href="libatspi-atspi-constants.html" title="atspi-constants">
  10 <link rel="next" href="libatspi-atspi-misc-private.html" title="atspi-misc-private">
  11 <meta name="generator" content="GTK-Doc V1.18.1 (XML mode)">
  12 <link rel="stylesheet" href="style.css" type="text/css">
  13 </head>
  14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
  16 <tr valign="middle">
  17 <td><a accesskey="p" href="libatspi-atspi-constants.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
  19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
  20 <th width="100%" align="center">libatspi Reference Manual</th>
  21 <td><a accesskey="n" href="libatspi-atspi-misc-private.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
  22 </tr>
  23 <tr><td colspan="5" class="shortcuts">
  24 <a href="#libatspi-atspi-misc.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#libatspi-atspi-misc.description" class="shortcut">Description</a>
  27 </td></tr>
  28 </table>
  29 <div class="refentry">
  30 <a name="libatspi-atspi-misc"></a><div class="titlepage"></div>
  31 <div class="refnamediv"><table width="100%"><tr>
  32 <td valign="top">
  33 <h2><span class="refentrytitle"><a name="libatspi-atspi-misc.top_of_page"></a>atspi-misc</span></h2>
  34 <p>atspi-misc — Miscellaneous methods for using AT-SPI services.</p>
  35 </td>
  36 <td valign="top" align="right"></td>
  37 </tr></table></div>
  38 <div class="refsynopsisdiv">
  39 <a name="libatspi-atspi-misc.synopsis"></a><h2>Synopsis</h2>
  40 <pre class="synopsis"><span class="returnvalue">int</span>                 <a class="link" href="libatspi-atspi-misc.html#atspi-init" title="atspi_init ()">atspi_init</a>                          (<em class="parameter"><code><span class="type">void</span></code></em>);
  41 <span class="returnvalue">void</span>                <a class="link" href="libatspi-atspi-misc.html#atspi-event-main" title="atspi_event_main ()">atspi_event_main</a>                    ();
  42 <span class="returnvalue">void</span>                <a class="link" href="libatspi-atspi-misc.html#atspi-event-quit" title="atspi_event_quit ()">atspi_event_quit</a>                    ();
  43 <span class="returnvalue">int</span>                 <a class="link" href="libatspi-atspi-misc.html#atspi-exit" title="atspi_exit ()">atspi_exit</a>                          ();
  44 </pre>
  45 </div>
  46 <div class="refsect1">
  47 <a name="libatspi-atspi-misc.description"></a><h2>Description</h2>
  48 <p>
  49 Miscellaneous methods for using AT-SPI services.
  50 </p>
  51 </div>
  52 <div class="refsect1">
  53 <a name="libatspi-atspi-misc.details"></a><h2>Details</h2>
  54 <div class="refsect2">
  55 <a name="atspi-init"></a><h3>atspi_init ()</h3>
  56 <pre class="programlisting"><span class="returnvalue">int</span>                 atspi_init                          (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
  57 <p>
  58 Connects to the accessibility registry and initializes the SPI.
  59 </p>
  60 <div class="variablelist"><table border="0" class="variablelist">
  61 <colgroup>
  62 <col align="left" valign="top">
  63 <col>
  64 </colgroup>
  65 <tbody><tr>
  66 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
  67 <td>0 on success, 1 if already initialized, or an integer error code.</td>
  68 </tr></tbody>
  69 </table></div>
  70 </div>
  71 <hr>
  72 <div class="refsect2">
  73 <a name="atspi-event-main"></a><h3>atspi_event_main ()</h3>
  74 <pre class="programlisting"><span class="returnvalue">void</span>                atspi_event_main                    ();</pre>
  75 <p>
  76 Starts/enters the main event loop for the AT-SPI services.
  77 </p>
  78 <p>
  79 NOTE: This method does not return control; it is exited via a call to
  80 <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.
  81 </p>
  82 </div>
  83 <hr>
  84 <div class="refsect2">
  85 <a name="atspi-event-quit"></a><h3>atspi_event_quit ()</h3>
  86 <pre class="programlisting"><span class="returnvalue">void</span>                atspi_event_quit                    ();</pre>
  87 <p>
  88 Quits the last main event loop for the AT-SPI services,
  89 See: <a class="link" href="libatspi-atspi-misc.html#atspi-event-main" title="atspi_event_main ()"><span class="type">atspi_event_main</span></a>
  90 </p>
  91 </div>
  92 <hr>
  93 <div class="refsect2">
  94 <a name="atspi-exit"></a><h3>atspi_exit ()</h3>
  95 <pre class="programlisting"><span class="returnvalue">int</span>                 atspi_exit                          ();</pre>
  96 <p>
  97 Disconnects from <span class="type">AtspiRegistry</span> instances and releases
  98 any floating resources. Call only once at exit.
  99 </p>
 100 <div class="variablelist"><table border="0" class="variablelist">
 101 <colgroup>
 102 <col align="left" valign="top">
 103 <col>
 104 </colgroup>
 105 <tbody><tr>
 106 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 107 <td>0 if there were no leaks, otherwise other integer values.</td>
 108 </tr></tbody>
 109 </table></div>
 110 </div>
 111 </div>
 112 </div>
 113 <div class="footer">
 114 <hr>
 115           Generated by GTK-Doc V1.18.1</div>
 116 </body>
 117 </html>