/usr/share/gtk-doc/html/at-spi-cspi/at-spi-cspi-AccessibleApplication-API.html is in at-spi-doc 1.32.0-1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>AccessibleApplication API</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="AT-SPI C Bindings Reference Manual">
<link rel="up" href="spi-application.html" title="AccessibleApplication Methods">
<link rel="prev" href="spi-application.html" title="AccessibleApplication Methods">
<link rel="next" href="spi-accessible.html" title="Basic Accessible Object Methods and Interface Query">
<meta name="generator" content="GTK-Doc V1.18 (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="2">
<tr valign="middle">
<td><a accesskey="p" href="spi-application.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="spi-application.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">AT-SPI C Bindings Reference Manual</th>
<td><a accesskey="n" href="spi-accessible.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#at-spi-cspi-AccessibleApplication-API.synopsis" class="shortcut">Top</a>
|
<a href="#at-spi-cspi-AccessibleApplication-API.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="at-spi-cspi-AccessibleApplication-API"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="at-spi-cspi-AccessibleApplication-API.top_of_page"></a>AccessibleApplication API</span></h2>
<p>AccessibleApplication API — The interface implemented by the topmost Accessible in an application's
hierarchy of Accessible objects.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="at-spi-cspi-AccessibleApplication-API.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"><span class="returnvalue">void</span> <a class="link" href="at-spi-cspi-AccessibleApplication-API.html#AccessibleApplication-ref" title="AccessibleApplication_ref ()">AccessibleApplication_ref</a> (<em class="parameter"><code><span class="type">AccessibleApplication</span> *obj</code></em>);
<span class="returnvalue">void</span> <a class="link" href="at-spi-cspi-AccessibleApplication-API.html#AccessibleApplication-unref" title="AccessibleApplication_unref ()">AccessibleApplication_unref</a> (<em class="parameter"><code><span class="type">AccessibleApplication</span> *obj</code></em>);
<span class="returnvalue">char</span> * <a class="link" href="at-spi-cspi-AccessibleApplication-API.html#AccessibleApplication-getToolkitName" title="AccessibleApplication_getToolkitName ()">AccessibleApplication_getToolkitName</a>
(<em class="parameter"><code><span class="type">AccessibleApplication</span> *obj</code></em>);
<span class="returnvalue">char</span> * <a class="link" href="at-spi-cspi-AccessibleApplication-API.html#AccessibleApplication-getVersion" title="AccessibleApplication_getVersion ()">AccessibleApplication_getVersion</a> (<em class="parameter"><code><span class="type">AccessibleApplication</span> *obj</code></em>);
<span class="returnvalue">long</span> <a class="link" href="at-spi-cspi-AccessibleApplication-API.html#AccessibleApplication-getID" title="AccessibleApplication_getID ()">AccessibleApplication_getID</a> (<em class="parameter"><code><span class="type">AccessibleApplication</span> *obj</code></em>);
<span class="returnvalue">char</span> * <a class="link" href="at-spi-cspi-AccessibleApplication-API.html#AccessibleApplication-getLocale" title="AccessibleApplication_getLocale ()">AccessibleApplication_getLocale</a> (<em class="parameter"><code><span class="type">AccessibleApplication</span> *obj</code></em>,
<em class="parameter"><code><span class="type">int</span> lc_category</code></em>);
<span class="returnvalue">SPIBoolean</span> <a class="link" href="at-spi-cspi-AccessibleApplication-API.html#AccessibleApplication-pause" title="AccessibleApplication_pause ()">AccessibleApplication_pause</a> (<em class="parameter"><code><span class="type">AccessibleApplication</span> *obj</code></em>);
<span class="returnvalue">SPIBoolean</span> <a class="link" href="at-spi-cspi-AccessibleApplication-API.html#AccessibleApplication-resume" title="AccessibleApplication_resume ()">AccessibleApplication_resume</a> (<em class="parameter"><code><span class="type">AccessibleApplication</span> *obj</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="at-spi-cspi-AccessibleApplication-API.description"></a><h2>Description</h2>
<p>
This interface is implemented on the topmost object in an application's
hierarchy. It is primarily a marker interface, though certain properties
associated with an application, such as the application's current default
locale, are also exposed.
</p>
</div>
<div class="refsect1">
<a name="at-spi-cspi-AccessibleApplication-API.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="AccessibleApplication-ref"></a><h3>AccessibleApplication_ref ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> AccessibleApplication_ref (<em class="parameter"><code><span class="type">AccessibleApplication</span> *obj</code></em>);</pre>
<p>
Increment the reference count for an <span class="type">AccessibleApplication</span>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to the <span class="type">AccessibleApplication</span> on which to operate.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="AccessibleApplication-unref"></a><h3>AccessibleApplication_unref ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> AccessibleApplication_unref (<em class="parameter"><code><span class="type">AccessibleApplication</span> *obj</code></em>);</pre>
<p>
Decrement the reference count for an <span class="type">AccessibleApplication</span>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to the <span class="type">AccessibleApplication</span> object on which to operate.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="AccessibleApplication-getToolkitName"></a><h3>AccessibleApplication_getToolkitName ()</h3>
<pre class="programlisting"><span class="returnvalue">char</span> * AccessibleApplication_getToolkitName
(<em class="parameter"><code><span class="type">AccessibleApplication</span> *obj</code></em>);</pre>
<p>
Get the name of the UI toolkit used by an <span class="type">AccessibleApplication</span>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to the <span class="type">AccessibleApplication</span> to query.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a UTF-8 string indicating which UI toolkit is
used by an application.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="AccessibleApplication-getVersion"></a><h3>AccessibleApplication_getVersion ()</h3>
<pre class="programlisting"><span class="returnvalue">char</span> * AccessibleApplication_getVersion (<em class="parameter"><code><span class="type">AccessibleApplication</span> *obj</code></em>);</pre>
<p>
Get the version of the UI toolkit used by an
<span class="type">AccessibleApplication</span> instance.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to the <span class="type">AccessibleApplication</span> being queried.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a UTF-8 string indicating the version of the UI toolkit
which is used by an application.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="AccessibleApplication-getID"></a><h3>AccessibleApplication_getID ()</h3>
<pre class="programlisting"><span class="returnvalue">long</span> AccessibleApplication_getID (<em class="parameter"><code><span class="type">AccessibleApplication</span> *obj</code></em>);</pre>
<p>
Get the unique ID assigned by the Registry to an
<span class="type">AccessibleApplication</span> instance.
(Not Yet Implemented by the registry).
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to the <span class="type">AccessibleApplication</span> being queried.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a unique <span class="type">long</span> integer associated with the application
by the Registry, or 0 if the application is not registered.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="AccessibleApplication-getLocale"></a><h3>AccessibleApplication_getLocale ()</h3>
<pre class="programlisting"><span class="returnvalue">char</span> * AccessibleApplication_getLocale (<em class="parameter"><code><span class="type">AccessibleApplication</span> *obj</code></em>,
<em class="parameter"><code><span class="type">int</span> lc_category</code></em>);</pre>
<p>
Get a POSIX-compliant string describing the application's current
locale setting for a particular <em class="parameter"><code>lctype</code></em> category.
</p>
<p>
<em class="parameter"><code>Since</code></em>: AT-SPI 1.4
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to the <span class="type">AccessibleApplication</span> being queried.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>lc_category</code></em> :</span></p></td>
<td>one of the POSIX LC_TYPE enumeration, for instance
LC_MESSAGES.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a POSIX-compliant locale string, e.g. "C", "pt_BR", "sr<em class="parameter"><code>latn</code></em>", etc.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="AccessibleApplication-pause"></a><h3>AccessibleApplication_pause ()</h3>
<pre class="programlisting"><span class="returnvalue">SPIBoolean</span> AccessibleApplication_pause (<em class="parameter"><code><span class="type">AccessibleApplication</span> *obj</code></em>);</pre>
<p>
Attempt to pause the application (used when client event queue is
over-full).
Not Yet Implemented.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to the <a class="link" href="at-spi-cspi-Accessible-Objects.html#Accessible" title="struct Accessible"><span class="type">Accessible</span></a> object on which to operate.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<span class="type">TRUE</span> if the application was paused successfully, <span class="type">FALSE</span> otherwise.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="AccessibleApplication-resume"></a><h3>AccessibleApplication_resume ()</h3>
<pre class="programlisting"><span class="returnvalue">SPIBoolean</span> AccessibleApplication_resume (<em class="parameter"><code><span class="type">AccessibleApplication</span> *obj</code></em>);</pre>
<p>
Attempt to resume the application (used after <a class="link" href="at-spi-cspi-AccessibleApplication-API.html#AccessibleApplication-pause" title="AccessibleApplication_pause ()"><span class="type">AccessibleApplication_pause</span></a>).
Not Yet Implemented.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to the <a class="link" href="at-spi-cspi-Accessible-Objects.html#Accessible" title="struct Accessible"><span class="type">Accessible</span></a> object on which to operate.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<span class="type">TRUE</span> if application processing resumed successfully, <span class="type">FALSE</span> otherwise.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|