doc/libatspi/html/AtspiStateSet.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-stateset</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-text.html" title="atspi-text">
  10 <link rel="next" href="libatspi-AtspiApplication.html" title="atspi-application">
  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-text.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-AtspiApplication.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="#AtspiStateSet.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#AtspiStateSet.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#AtspiStateSet.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29 </td></tr>
  30 </table>
  31 <div class="refentry">
  32 <a name="AtspiStateSet"></a><div class="titlepage"></div>
  33 <div class="refnamediv"><table width="100%"><tr>
  34 <td valign="top">
  35 <h2><span class="refentrytitle"><a name="AtspiStateSet.top_of_page"></a>atspi-stateset</span></h2>
  36 <p>atspi-stateset — The atspi-stateset objects implement wrappers around a
  37 bitmap of accessible states.</p>
  38 </td>
  39 <td valign="top" align="right"></td>
  40 </tr></table></div>
  41 <div class="refsynopsisdiv">
  42 <a name="AtspiStateSet.synopsis"></a><h2>Synopsis</h2>
  43 <pre class="synopsis">struct              <a class="link" href="AtspiStateSet.html#AtspiStateSet-struct" title="struct AtspiStateSet">AtspiStateSet</a>;
  44 struct              <a class="link" href="AtspiStateSet.html#AtspiStateSetClass" title="struct AtspiStateSetClass">AtspiStateSetClass</a>;
  45 <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><a href="../glib/glib-Arrays.html#GArray"><span class="type">GArray</span></a> *states</code></em>);
  46 <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>,
  47                                                          <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>,
  48                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> enabled</code></em>);
  49 <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>,
  50                                                          <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>);
  51 <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>,
  52                                                          <em class="parameter"><code><a class="link" href="AtspiStateSet.html" title="atspi-stateset"><span class="type">AtspiStateSet</span></a> *set2</code></em>);
  53 <a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <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>,
  54                                                          <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>);
  55 <a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <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>,
  56                                                          <em class="parameter"><code><a class="link" href="AtspiStateSet.html" title="atspi-stateset"><span class="type">AtspiStateSet</span></a> *set2</code></em>);
  57 <a href="../glib/glib-Arrays.html#GArray"><span class="returnvalue">GArray</span></a> *            <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>);
  58 <a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <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>);
  59 <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>,
  60                                                          <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>);
  61 </pre>
  62 </div>
  63 <div class="refsect1">
  64 <a name="AtspiStateSet.object-hierarchy"></a><h2>Object Hierarchy</h2>
  65 <pre class="synopsis">
  66   <a href="../gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
  67    +----AtspiStateSet
  68 </pre>
  69 </div>
  70 <div class="refsect1">
  71 <a name="AtspiStateSet.description"></a><h2>Description</h2>
  72 <p>
  73 The atspi-stateset objects implement wrappers around a
  74 bitmap of accessible states.
  75 </p>
  76 </div>
  77 <div class="refsect1">
  78 <a name="AtspiStateSet.details"></a><h2>Details</h2>
  79 <div class="refsect2">
  80 <a name="AtspiStateSet-struct"></a><h3>struct AtspiStateSet</h3>
  81 <pre class="programlisting">struct AtspiStateSet;</pre>
  82 <p>
  83 </p>
  84 </div>
  85 <hr>
  86 <div class="refsect2">
  87 <a name="AtspiStateSetClass"></a><h3>struct AtspiStateSetClass</h3>
  88 <pre class="programlisting">struct AtspiStateSetClass {
  89   GObjectClass parent_class;
  90 };
  91 </pre>
  92 <p>
  93 </p>
  94 </div>
  95 <hr>
  96 <div class="refsect2">
  97 <a name="atspi-state-set-new"></a><h3>atspi_state_set_new ()</h3>
  98 <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><a href="../glib/glib-Arrays.html#GArray"><span class="type">GArray</span></a> *states</code></em>);</pre>
  99 <p>
 100 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>.
 101 </p>
 102 <div class="variablelist"><table border="0" class="variablelist">
 103 <colgroup>
 104 <col align="left" valign="top">
 105 <col>
 106 </colgroup>
 107 <tbody>
 108 <tr>
 109 <td><p><span class="term"><em class="parameter"><code>states</code></em> :</span></p></td>
 110 <td>An array of states with which the
 111 method initializes the state set. <span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> AtspiStateType]</span>
 112 </td>
 113 </tr>
 114 <tr>
 115 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 116 <td>A new <a class="link" href="AtspiStateSet.html" title="atspi-stateset"><span class="type">AtspiStateSet</span></a> with the given states.</td>
 117 </tr>
 118 </tbody>
 119 </table></div>
 120 </div>
 121 <hr>
 122 <div class="refsect2">
 123 <a name="atspi-state-set-set-by-name"></a><h3>atspi_state_set_set_by_name ()</h3>
 124 <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>,
 125                                                          <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>,
 126                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> enabled</code></em>);</pre>
 127 <p>
 128 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>.
 129 </p>
 130 <div class="variablelist"><table border="0" class="variablelist">
 131 <colgroup>
 132 <col align="left" valign="top">
 133 <col>
 134 </colgroup>
 135 <tbody>
 136 <tr>
 137 <td><p><span class="term"><em class="parameter"><code>set</code></em> :</span></p></td>
 138 <td>a pointer to the <a class="link" href="AtspiStateSet.html" title="atspi-stateset"><span class="type">AtspiStateSet</span></a> object on which to operate.</td>
 139 </tr>
 140 <tr>
 141 <td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
 142 <td>a string corresponding to a state name.</td>
 143 </tr>
 144 <tr>
 145 <td><p><span class="term"><em class="parameter"><code>enabled</code></em> :</span></p></td>
 146 <td>if <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><span class="type">TRUE</span></a>, <em class="parameter"><code>name</code></em> should be enabled in the <em class="parameter"><code>set</code></em> in question;
 147 otherwise, it should be disabled.</td>
 148 </tr>
 149 </tbody>
 150 </table></div>
 151 </div>
 152 <hr>
 153 <div class="refsect2">
 154 <a name="atspi-state-set-add"></a><h3>atspi_state_set_add ()</h3>
 155 <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>,
 156                                                          <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>
 157 <p>
 158 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
 159       given state to <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><span class="type">TRUE</span></a> in the stateset).
 160 </p>
 161 <div class="variablelist"><table border="0" class="variablelist">
 162 <colgroup>
 163 <col align="left" valign="top">
 164 <col>
 165 </colgroup>
 166 <tbody>
 167 <tr>
 168 <td><p><span class="term"><em class="parameter"><code>set</code></em> :</span></p></td>
 169 <td>a pointer to the <a class="link" href="AtspiStateSet.html" title="atspi-stateset"><span class="type">AtspiStateSet</span></a> object on which to operate.</td>
 170 </tr>
 171 <tr>
 172 <td><p><span class="term"><em class="parameter"><code>state</code></em> :</span></p></td>
 173 <td>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>.</td>
 174 </tr>
 175 </tbody>
 176 </table></div>
 177 </div>
 178 <hr>
 179 <div class="refsect2">
 180 <a name="atspi-state-set-compare"></a><h3>atspi_state_set_compare ()</h3>
 181 <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>,
 182                                                          <em class="parameter"><code><a class="link" href="AtspiStateSet.html" title="atspi-stateset"><span class="type">AtspiStateSet</span></a> *set2</code></em>);</pre>
 183 <p>
 184 Determines the differences between two instances of <a class="link" href="AtspiStateSet.html" title="atspi-stateset"><span class="type">AtspiStateSet</span></a>.
 185 </p>
 186 <p>
 187 <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>.
 188 </p>
 189 <div class="variablelist"><table border="0" class="variablelist">
 190 <colgroup>
 191 <col align="left" valign="top">
 192 <col>
 193 </colgroup>
 194 <tbody>
 195 <tr>
 196 <td><p><span class="term"><em class="parameter"><code>set</code></em> :</span></p></td>
 197 <td>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.</td>
 198 </tr>
 199 <tr>
 200 <td><p><span class="term"><em class="parameter"><code>set2</code></em> :</span></p></td>
 201 <td>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.</td>
 202 </tr>
 203 <tr>
 204 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 205 <td>an <a class="link" href="AtspiStateSet.html" title="atspi-stateset"><span class="type">AtspiStateSet</span></a> object containing all states
 206 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>
 207 </td>
 208 </tr>
 209 </tbody>
 210 </table></div>
 211 </div>
 212 <hr>
 213 <div class="refsect2">
 214 <a name="atspi-state-set-contains"></a><h3>atspi_state_set_contains ()</h3>
 215 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            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>,
 216                                                          <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>
 217 <p>
 218 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,
 219          whether <em class="parameter"><code>state</code></em> is true for the <em class="parameter"><code>set</code></em> in question.
 220 </p>
 221 <div class="variablelist"><table border="0" class="variablelist">
 222 <colgroup>
 223 <col align="left" valign="top">
 224 <col>
 225 </colgroup>
 226 <tbody>
 227 <tr>
 228 <td><p><span class="term"><em class="parameter"><code>set</code></em> :</span></p></td>
 229 <td>a pointer to the <a class="link" href="AtspiStateSet.html" title="atspi-stateset"><span class="type">AtspiStateSet</span></a> object on which to operate.</td>
 230 </tr>
 231 <tr>
 232 <td><p><span class="term"><em class="parameter"><code>state</code></em> :</span></p></td>
 233 <td>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>
 234 will be queried.</td>
 235 </tr>
 236 <tr>
 237 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 238 <td>
 239 <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><span class="type">TRUE</span></a> 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>,
 240 otherwise <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><span class="type">FALSE</span></a>.</td>
 241 </tr>
 242 </tbody>
 243 </table></div>
 244 </div>
 245 <hr>
 246 <div class="refsect2">
 247 <a name="atspi-state-set-equals"></a><h3>atspi_state_set_equals ()</h3>
 248 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            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>,
 249                                                          <em class="parameter"><code><a class="link" href="AtspiStateSet.html" title="atspi-stateset"><span class="type">AtspiStateSet</span></a> *set2</code></em>);</pre>
 250 <p>
 251 Determines whether two instances of <a class="link" href="AtspiStateSet.html" title="atspi-stateset"><span class="type">AtspiStateSet</span></a> are equivalent (i.e.
 252          consist of the same <span class="type">AtspiStates</span>).  Useful for checking multiple
 253          state variables at once.
 254 </p>
 255 <p>
 256 <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>.
 257 </p>
 258 <div class="variablelist"><table border="0" class="variablelist">
 259 <colgroup>
 260 <col align="left" valign="top">
 261 <col>
 262 </colgroup>
 263 <tbody>
 264 <tr>
 265 <td><p><span class="term"><em class="parameter"><code>set</code></em> :</span></p></td>
 266 <td>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.</td>
 267 </tr>
 268 <tr>
 269 <td><p><span class="term"><em class="parameter"><code>set2</code></em> :</span></p></td>
 270 <td>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.</td>
 271 </tr>
 272 <tr>
 273 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 274 <td>
 275 <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><span class="type">TRUE</span></a> if the two <a href="AtspiStateSet.html"><span class="type">AtspiStateSets</span></a> are equivalent,
 276 otherwise <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><span class="type">FALSE</span></a>.</td>
 277 </tr>
 278 </tbody>
 279 </table></div>
 280 </div>
 281 <hr>
 282 <div class="refsect2">
 283 <a name="atspi-state-set-get-states"></a><h3>atspi_state_set_get_states ()</h3>
 284 <pre class="programlisting"><a href="../glib/glib-Arrays.html#GArray"><span class="returnvalue">GArray</span></a> *            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>
 285 <p>
 286 Returns the states in an <a class="link" href="AtspiStateSet.html" title="atspi-stateset"><span class="type">AtspiStateSet</span></a> as an array.
 287 </p>
 288 <div class="variablelist"><table border="0" class="variablelist">
 289 <colgroup>
 290 <col align="left" valign="top">
 291 <col>
 292 </colgroup>
 293 <tbody>
 294 <tr>
 295 <td><p><span class="term"><em class="parameter"><code>set</code></em> :</span></p></td>
 296 <td>The <a class="link" href="AtspiStateSet.html" title="atspi-stateset"><span class="type">AtspiStateSet</span></a> to be queried.</td>
 297 </tr>
 298 <tr>
 299 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 300 <td>A <a href="../glib/glib-Arrays.html#GArray"><span class="type">GArray</span></a> of state
 301 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>
 302 </td>
 303 </tr>
 304 </tbody>
 305 </table></div>
 306 </div>
 307 <hr>
 308 <div class="refsect2">
 309 <a name="atspi-state-set-is-empty"></a><h3>atspi_state_set_is_empty ()</h3>
 310 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            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>
 311 <div class="variablelist"><table border="0" class="variablelist">
 312 <colgroup>
 313 <col align="left" valign="top">
 314 <col>
 315 </colgroup>
 316 <tbody>
 317 <tr>
 318 <td><p><span class="term"><em class="parameter"><code>set</code></em> :</span></p></td>
 319 <td>The <a class="link" href="AtspiStateSet.html" title="atspi-stateset"><span class="type">AtspiStateSet</span></a> to query.</td>
 320 </tr>
 321 <tr>
 322 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 323 <td>
 324 <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><span class="type">TRUE</span></a> if the state set contains no states; <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><span class="type">FALSE</span></a> otherwise.</td>
 325 </tr>
 326 </tbody>
 327 </table></div>
 328 </div>
 329 <hr>
 330 <div class="refsect2">
 331 <a name="atspi-state-set-remove"></a><h3>atspi_state_set_remove ()</h3>
 332 <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>,
 333                                                          <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>
 334 <p>
 335 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
 336       given state to <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><span class="type">FALSE</span></a> in the stateset.)
 337 </p>
 338 <div class="variablelist"><table border="0" class="variablelist">
 339 <colgroup>
 340 <col align="left" valign="top">
 341 <col>
 342 </colgroup>
 343 <tbody>
 344 <tr>
 345 <td><p><span class="term"><em class="parameter"><code>set</code></em> :</span></p></td>
 346 <td>a pointer to the <a class="link" href="AtspiStateSet.html" title="atspi-stateset"><span class="type">AtspiStateSet</span></a> object on which to operate.</td>
 347 </tr>
 348 <tr>
 349 <td><p><span class="term"><em class="parameter"><code>state</code></em> :</span></p></td>
 350 <td>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>.</td>
 351 </tr>
 352 </tbody>
 353 </table></div>
 354 </div>
 355 </div>
 356 </div>
 357 <div class="footer">
 358 <hr>
 359           Generated by GTK-Doc V1.18.1</div>
 360 </body>
 361 </html>