/usr/share/gtk-doc/html/libatspi/AtspiStateSet.html is in at-spi2-doc 2.4.0-1.
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 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 | <!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-stateset</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<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-text.html" title="atspi-text">
<link rel="next" href="libatspi-AtspiApplication.html" title="atspi-application">
<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="libatspi-atspi-text.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.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">libatspi Reference Manual</th>
<td><a accesskey="n" href="libatspi-AtspiApplication.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#AtspiStateSet.synopsis" class="shortcut">Top</a>
|
<a href="#AtspiStateSet.description" class="shortcut">Description</a>
|
<a href="#AtspiStateSet.object-hierarchy" class="shortcut">Object Hierarchy</a>
</td></tr>
</table>
<div class="refentry">
<a name="AtspiStateSet"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="AtspiStateSet.top_of_page"></a>atspi-stateset</span></h2>
<p>atspi-stateset — The atspi-stateset objects implement wrappers around a
bitmap of accessible states.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="AtspiStateSet.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct <a class="link" href="AtspiStateSet.html#AtspiStateSet-struct" title="struct AtspiStateSet">AtspiStateSet</a>;
struct <a class="link" href="AtspiStateSet.html#AtspiStateSetClass" title="struct AtspiStateSetClass">AtspiStateSetClass</a>;
<a class="link" href="AtspiStateSet.html" title="atspi-stateset"><span class="returnvalue">AtspiStateSet</span></a> * <a class="link" href="AtspiStateSet.html#atspi-state-set-new" title="atspi_state_set_new ()">atspi_state_set_new</a> (<em class="parameter"><code><span class="type">GArray</span> *states</code></em>);
<span class="returnvalue">void</span> <a class="link" href="AtspiStateSet.html#atspi-state-set-set-by-name" title="atspi_state_set_set_by_name ()">atspi_state_set_set_by_name</a> (<em class="parameter"><code><a class="link" href="AtspiStateSet.html" title="atspi-stateset"><span class="type">AtspiStateSet</span></a> *set</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> enabled</code></em>);
<span class="returnvalue">void</span> <a class="link" href="AtspiStateSet.html#atspi-state-set-add" title="atspi_state_set_add ()">atspi_state_set_add</a> (<em class="parameter"><code><a class="link" href="AtspiStateSet.html" title="atspi-stateset"><span class="type">AtspiStateSet</span></a> *set</code></em>,
<em class="parameter"><code><a class="link" href="libatspi-atspi-constants.html#AtspiStateType" title="enum AtspiStateType"><span class="type">AtspiStateType</span></a> state</code></em>);
<a class="link" href="AtspiStateSet.html" title="atspi-stateset"><span class="returnvalue">AtspiStateSet</span></a> * <a class="link" href="AtspiStateSet.html#atspi-state-set-compare" title="atspi_state_set_compare ()">atspi_state_set_compare</a> (<em class="parameter"><code><a class="link" href="AtspiStateSet.html" title="atspi-stateset"><span class="type">AtspiStateSet</span></a> *set</code></em>,
<em class="parameter"><code><a class="link" href="AtspiStateSet.html" title="atspi-stateset"><span class="type">AtspiStateSet</span></a> *set2</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="AtspiStateSet.html#atspi-state-set-contains" title="atspi_state_set_contains ()">atspi_state_set_contains</a> (<em class="parameter"><code><a class="link" href="AtspiStateSet.html" title="atspi-stateset"><span class="type">AtspiStateSet</span></a> *set</code></em>,
<em class="parameter"><code><a class="link" href="libatspi-atspi-constants.html#AtspiStateType" title="enum AtspiStateType"><span class="type">AtspiStateType</span></a> state</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="AtspiStateSet.html#atspi-state-set-equals" title="atspi_state_set_equals ()">atspi_state_set_equals</a> (<em class="parameter"><code><a class="link" href="AtspiStateSet.html" title="atspi-stateset"><span class="type">AtspiStateSet</span></a> *set</code></em>,
<em class="parameter"><code><a class="link" href="AtspiStateSet.html" title="atspi-stateset"><span class="type">AtspiStateSet</span></a> *set2</code></em>);
<span class="returnvalue">GArray</span> * <a class="link" href="AtspiStateSet.html#atspi-state-set-get-states" title="atspi_state_set_get_states ()">atspi_state_set_get_states</a> (<em class="parameter"><code><a class="link" href="AtspiStateSet.html" title="atspi-stateset"><span class="type">AtspiStateSet</span></a> *set</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="AtspiStateSet.html#atspi-state-set-is-empty" title="atspi_state_set_is_empty ()">atspi_state_set_is_empty</a> (<em class="parameter"><code><a class="link" href="AtspiStateSet.html" title="atspi-stateset"><span class="type">AtspiStateSet</span></a> *set</code></em>);
<span class="returnvalue">void</span> <a class="link" href="AtspiStateSet.html#atspi-state-set-remove" title="atspi_state_set_remove ()">atspi_state_set_remove</a> (<em class="parameter"><code><a class="link" href="AtspiStateSet.html" title="atspi-stateset"><span class="type">AtspiStateSet</span></a> *set</code></em>,
<em class="parameter"><code><a class="link" href="libatspi-atspi-constants.html#AtspiStateType" title="enum AtspiStateType"><span class="type">AtspiStateType</span></a> state</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="AtspiStateSet.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----AtspiStateSet
</pre>
</div>
<div class="refsect1">
<a name="AtspiStateSet.description"></a><h2>Description</h2>
<p>
The atspi-stateset objects implement wrappers around a
bitmap of accessible states.
</p>
</div>
<div class="refsect1">
<a name="AtspiStateSet.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="AtspiStateSet-struct"></a><h3>struct AtspiStateSet</h3>
<pre class="programlisting">struct AtspiStateSet;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="AtspiStateSetClass"></a><h3>struct AtspiStateSetClass</h3>
<pre class="programlisting">struct AtspiStateSetClass {
GObjectClass parent_class;
};
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="atspi-state-set-new"></a><h3>atspi_state_set_new ()</h3>
<pre class="programlisting"><a class="link" href="AtspiStateSet.html" title="atspi-stateset"><span class="returnvalue">AtspiStateSet</span></a> * atspi_state_set_new (<em class="parameter"><code><span class="type">GArray</span> *states</code></em>);</pre>
<p>
<em class="parameter"><code>states</code></em>: (element-type AtspiStateType): An array of states with which the
method initializes the state set.
</p>
<p>
Generates an <a class="link" href="AtspiStateSet.html" title="atspi-stateset"><span class="type">AtspiStateSet</span></a> with the given <em class="parameter"><code>states</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A new <a class="link" href="AtspiStateSet.html" title="atspi-stateset"><span class="type">AtspiStateSet</span></a> with the given states.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-state-set-set-by-name"></a><h3>atspi_state_set_set_by_name ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> atspi_state_set_set_by_name (<em class="parameter"><code><a class="link" href="AtspiStateSet.html" title="atspi-stateset"><span class="type">AtspiStateSet</span></a> *set</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> enabled</code></em>);</pre>
<p>
<em class="parameter"><code>set</code></em>: a pointer to the <a class="link" href="AtspiStateSet.html" title="atspi-stateset"><span class="type">AtspiStateSet</span></a> object on which to operate.
</p>
<p>
<em class="parameter"><code>name</code></em>: a string corresponding to a state name.
</p>
<p>
<em class="parameter"><code>enabled</code></em>: if <span class="type">TRUE</span>, <em class="parameter"><code>name</code></em> should be enabled in the <em class="parameter"><code>set</code></em> in question; otherwise, it
should be disabled.
</p>
<p>
Enables/disables a state in an <a class="link" href="AtspiStateSet.html" title="atspi-stateset"><span class="type">AtspiStateSet</span></a> according to its <em class="parameter"><code>name</code></em>.
</p>
</div>
<hr>
<div class="refsect2">
<a name="atspi-state-set-add"></a><h3>atspi_state_set_add ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> atspi_state_set_add (<em class="parameter"><code><a class="link" href="AtspiStateSet.html" title="atspi-stateset"><span class="type">AtspiStateSet</span></a> *set</code></em>,
<em class="parameter"><code><a class="link" href="libatspi-atspi-constants.html#AtspiStateType" title="enum AtspiStateType"><span class="type">AtspiStateType</span></a> state</code></em>);</pre>
<p>
<em class="parameter"><code>set</code></em>: a pointer to the <a class="link" href="AtspiStateSet.html" title="atspi-stateset"><span class="type">AtspiStateSet</span></a> object on which to operate.
</p>
<p>
<em class="parameter"><code>state</code></em>: an <a class="link" href="libatspi-atspi-constants.html#AtspiStateType" title="enum AtspiStateType"><span class="type">AtspiStateType</span></a> to be added to the specified <a class="link" href="AtspiStateSet.html" title="atspi-stateset"><span class="type">AtspiStateSet</span></a>.
</p>
<p>
Adds a particular <span class="type">AtspiState</span> to an <a class="link" href="AtspiStateSet.html" title="atspi-stateset"><span class="type">AtspiStateSet</span></a> (i.e. sets the
given state to <span class="type">TRUE</span> in the stateset).
</p>
</div>
<hr>
<div class="refsect2">
<a name="atspi-state-set-compare"></a><h3>atspi_state_set_compare ()</h3>
<pre class="programlisting"><a class="link" href="AtspiStateSet.html" title="atspi-stateset"><span class="returnvalue">AtspiStateSet</span></a> * atspi_state_set_compare (<em class="parameter"><code><a class="link" href="AtspiStateSet.html" title="atspi-stateset"><span class="type">AtspiStateSet</span></a> *set</code></em>,
<em class="parameter"><code><a class="link" href="AtspiStateSet.html" title="atspi-stateset"><span class="type">AtspiStateSet</span></a> *set2</code></em>);</pre>
<p>
<em class="parameter"><code>set</code></em>: a pointer to the first <a class="link" href="AtspiStateSet.html" title="atspi-stateset"><span class="type">AtspiStateSet</span></a> object on which to operate.
</p>
<p>
<em class="parameter"><code>set2</code></em>: a pointer to the second <a class="link" href="AtspiStateSet.html" title="atspi-stateset"><span class="type">AtspiStateSet</span></a> object on which to operate.
</p>
<p>
Determines the differences between two instances of <a class="link" href="AtspiStateSet.html" title="atspi-stateset"><span class="type">AtspiStateSet</span></a>.
</p>
<p>
<em class="parameter"><code>see</code></em> <a class="link" href="AtspiStateSet.html#atspi-state-set-equals" title="atspi_state_set_equals ()"><span class="type">atspi_state_set_equals</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>an <a class="link" href="AtspiStateSet.html" title="atspi-stateset"><span class="type">AtspiStateSet</span></a> object containing all states
contained on one of the two sets but not the other. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-state-set-contains"></a><h3>atspi_state_set_contains ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> atspi_state_set_contains (<em class="parameter"><code><a class="link" href="AtspiStateSet.html" title="atspi-stateset"><span class="type">AtspiStateSet</span></a> *set</code></em>,
<em class="parameter"><code><a class="link" href="libatspi-atspi-constants.html#AtspiStateType" title="enum AtspiStateType"><span class="type">AtspiStateType</span></a> state</code></em>);</pre>
<p>
<em class="parameter"><code>set</code></em>: a pointer to the <a class="link" href="AtspiStateSet.html" title="atspi-stateset"><span class="type">AtspiStateSet</span></a> object on which to operate.
</p>
<p>
<em class="parameter"><code>state</code></em>: an <a class="link" href="libatspi-atspi-constants.html#AtspiStateType" title="enum AtspiStateType"><span class="type">AtspiStateType</span></a> for which the specified <a class="link" href="AtspiStateSet.html" title="atspi-stateset"><span class="type">AtspiStateSet</span></a>
will be queried.
</p>
<p>
Determines whether a given <a class="link" href="AtspiStateSet.html" title="atspi-stateset"><span class="type">AtspiStateSet</span></a> includes a given state; that is,
whether <em class="parameter"><code>state</code></em> is true for the <em class="parameter"><code>set</code></em> in question.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<span class="type">TRUE</span> if <em class="parameter"><code>state</code></em> is true/included in the given <a class="link" href="AtspiStateSet.html" title="atspi-stateset"><span class="type">AtspiStateSet</span></a>,
otherwise <span class="type">FALSE</span>.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-state-set-equals"></a><h3>atspi_state_set_equals ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> atspi_state_set_equals (<em class="parameter"><code><a class="link" href="AtspiStateSet.html" title="atspi-stateset"><span class="type">AtspiStateSet</span></a> *set</code></em>,
<em class="parameter"><code><a class="link" href="AtspiStateSet.html" title="atspi-stateset"><span class="type">AtspiStateSet</span></a> *set2</code></em>);</pre>
<p>
<em class="parameter"><code>set</code></em>: a pointer to the first <a class="link" href="AtspiStateSet.html" title="atspi-stateset"><span class="type">AtspiStateSet</span></a> object on which to operate.
</p>
<p>
<em class="parameter"><code>set2</code></em>: a pointer to the second <a class="link" href="AtspiStateSet.html" title="atspi-stateset"><span class="type">AtspiStateSet</span></a> object on which to operate.
</p>
<p>
Determines whether two instances of <a class="link" href="AtspiStateSet.html" title="atspi-stateset"><span class="type">AtspiStateSet</span></a> are equivalent (i.e.
consist of the same <span class="type">AtspiStates</span>). Useful for checking multiple
state variables at once.
</p>
<p>
<em class="parameter"><code>see</code></em> <a class="link" href="AtspiStateSet.html#atspi-state-set-compare" title="atspi_state_set_compare ()"><span class="type">atspi_state_set_compare</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<span class="type">TRUE</span> if the two <a href="AtspiStateSet.html"><span class="type">AtspiStateSets</span></a> are equivalent,
otherwise <span class="type">FALSE</span>.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-state-set-get-states"></a><h3>atspi_state_set_get_states ()</h3>
<pre class="programlisting"><span class="returnvalue">GArray</span> * atspi_state_set_get_states (<em class="parameter"><code><a class="link" href="AtspiStateSet.html" title="atspi-stateset"><span class="type">AtspiStateSet</span></a> *set</code></em>);</pre>
<p>
<em class="parameter"><code>set</code></em>: The <a class="link" href="AtspiStateSet.html" title="atspi-stateset"><span class="type">AtspiStateSet</span></a> to be queried.
</p>
<p>
Returns the states in an <a class="link" href="AtspiStateSet.html" title="atspi-stateset"><span class="type">AtspiStateSet</span></a> as an array.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A <span class="type">GArray</span> of state
types representing the current state. <span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> AtspiStateType][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-state-set-is-empty"></a><h3>atspi_state_set_is_empty ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> atspi_state_set_is_empty (<em class="parameter"><code><a class="link" href="AtspiStateSet.html" title="atspi-stateset"><span class="type">AtspiStateSet</span></a> *set</code></em>);</pre>
<p>
<em class="parameter"><code>set</code></em>: The <a class="link" href="AtspiStateSet.html" title="atspi-stateset"><span class="type">AtspiStateSet</span></a> to query.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<span class="type">TRUE</span> if the state set contains no states; <span class="type">FALSE</span> otherwise.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-state-set-remove"></a><h3>atspi_state_set_remove ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> atspi_state_set_remove (<em class="parameter"><code><a class="link" href="AtspiStateSet.html" title="atspi-stateset"><span class="type">AtspiStateSet</span></a> *set</code></em>,
<em class="parameter"><code><a class="link" href="libatspi-atspi-constants.html#AtspiStateType" title="enum AtspiStateType"><span class="type">AtspiStateType</span></a> state</code></em>);</pre>
<p>
<em class="parameter"><code>set</code></em>: a pointer to the <a class="link" href="AtspiStateSet.html" title="atspi-stateset"><span class="type">AtspiStateSet</span></a> object on which to operate.
</p>
<p>
<em class="parameter"><code>state</code></em>: an <a class="link" href="libatspi-atspi-constants.html#AtspiStateType" title="enum AtspiStateType"><span class="type">AtspiStateType</span></a> to remove from the specified <em class="parameter"><code>set</code></em>.
</p>
<p>
Removes a particular <span class="type">AtspiState</span> to an <a class="link" href="AtspiStateSet.html" title="atspi-stateset"><span class="type">AtspiStateSet</span></a> (i.e. sets the
given state to <span class="type">FALSE</span> in the stateset.)
</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|