2 * AT-SPI - Assistive Technology Service Provider Interface
3 * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
5 * Copyright 2001, 2002 Sun Microsystems Inc.,
6 * Copyright 2001, 2002 Ximian, Inc.
7 * Copyright 2010, 2011 Novell, Inc.
9 * This library is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU Library General Public
11 * License as published by the Free Software Foundation; either
12 * version 2 of the License, or (at your option) any later version.
14 * This library is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * Library General Public License for more details.
19 * You should have received a copy of the GNU Library General Public
20 * License along with this library; if not, write to the
21 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
22 * Boston, MA 02111-1307, USA.
25 #include "atspi-private.h"
27 static void atspi_state_set_class_init (AtspiStateSetClass *klass);
29 G_DEFINE_TYPE (AtspiStateSet, atspi_state_set, G_TYPE_OBJECT)
31 static const char *state_names [] =
64 "manages-descendants",
70 "supports-autocompletion",
78 atspi_state_set_init (AtspiStateSet *set)
84 atspi_state_set_class_init (AtspiStateSetClass* klass)
89 * atspi_state_set_new:
91 * @states: (element-type AtspiStateType): An array of states with which to initialize
94 * Returns: A new #AtspiStateSet with the given states.
97 atspi_state_set_new (GArray *states)
99 AtspiStateSet *set = g_object_new (ATSPI_TYPE_STATE_SET, NULL);
105 for (i = 0; i < states->len; i++)
106 atspi_state_set_add (set, g_array_index (states, AtspiStateType, i));
111 _atspi_state_set_new_internal (AtspiAccessible *accessible, gint64 states)
115 set = g_object_new (ATSPI_TYPE_STATE_SET, NULL);
116 g_return_val_if_fail (set != NULL, NULL);
118 set->accessible = accessible;
119 set->states = states;
124 atspi_state_set_set_by_name (AtspiStateSet *set, const gchar *name, gboolean enabled)
128 if (set->accessible &&
129 !(set->accessible->cached_properties & ATSPI_CACHE_STATES))
132 /* TODO: This could perhaps be optimized */
133 for (i = 0; state_names [i]; i++)
135 if (!strcmp (state_names [i], name))
138 set->states |= ((gint64)1 << i);
140 set->states &= ~((gint64)1 << i);
144 g_warning ("at-spi: Attempt to set unknown state '%s'", name);
148 refresh_states (AtspiStateSet *set)
151 dbus_uint32_t *states;
153 if (!set->accessible ||
154 (set->accessible->cached_properties & ATSPI_CACHE_STATES))
157 if (!_atspi_dbus_call (set->accessible, atspi_interface_accessible, "GetState", NULL, "=>au", &state_array))
160 states = (dbus_uint32_t *) state_array->data;
162 set->states = ((gint64)states [1]) << 32;
163 set->states += states [0];
164 g_array_free (state_array, TRUE);
168 * atspi_state_set_add:
170 * @set: a pointer to the #AtspiStateSet object on which to operate.
171 * @state: an #AtspiStateType to be added to the specified #AtspiStateSet.
173 * Add a particular #AtspiState to an #AtspiStateSet (i.e. set the
174 * given state to #TRUE in the stateset.
178 atspi_state_set_add (AtspiStateSet *set, AtspiStateType state)
180 g_return_if_fail (set != NULL);
181 set->states |= (((gint64)1) << state);
185 * atspi_state_set_compare:
186 * @set: a pointer to the first #AtspiStateSet object on which to operate.
187 * @set: a pointer to the second #AtspiStateSet setect on which to operate.
189 * Determine the differences between two instances of #AtspiStateSet.
191 * @see AtspiStateSet_equals().
193 * Returns: (transfer full): an #AtspiStateSet object containing all states
194 * contained on one of the two sets but not the other.
198 atspi_state_set_compare (AtspiStateSet *set,
201 g_return_val_if_fail (set != NULL, NULL);
202 g_return_val_if_fail (set2 != NULL, NULL);
204 return _atspi_state_set_new_internal (NULL, set->states ^ set2->states);
208 * atspi_state_set_contains:
209 * @set: a pointer to the #AtspiStateSet object on which to operate.
210 * @state: an #AtspiStateType for which the specified #AtspiStateSet
213 * Determine whether a given #AtspiStateSet includes a given state; that is,
214 * whether @state is true for the stateset in question.
216 * Returns: #TRUE if @state is true/included in the given #AtspiStateSet,
221 atspi_state_set_contains (AtspiStateSet *set,
222 AtspiStateType state)
226 refresh_states (set);
227 return (set->states & ((gint64)1 << state)) ? TRUE : FALSE;
231 * atspi_state_set_equals:
232 * @set: a pointer to the first #AtspiStateSet object on which to operate.
233 * @set2: a pointer to the second #AtspiStateSet object on which to operate.
235 * Determine whether two instances of #AtspiStateSet are equivalent (i.e.
236 * consist of the same #AtspiStates). Useful for checking multiple
237 * state variables at once; construct the target state then compare against it.
239 * @see AtspiStateSet_compare().
241 * Returns: #TRUE if the two #AtspiStateSets are equivalent,
246 atspi_state_set_equals (AtspiStateSet *set,
251 if (set == NULL || set2 == NULL)
253 return (set->states == set2->states);
257 * atspi_state_set_get_states:
259 * @set: The #AtspiStateSet to be queried.
261 * Return the states in an #AtspiStateSet as an array.
263 * Returns: (element-type AtspiStateType) (transfer full): A #GArray of state
264 * types representing the current state.
267 atspi_state_set_get_states (AtspiStateSet *set)
273 g_return_val_if_fail (set != NULL, NULL);
274 refresh_states (set);
275 ret = g_array_new (TRUE, TRUE, sizeof (AtspiStateType));
278 for (i = 0; i < 64; i++)
280 if (set->states & val)
282 GArray *new_array = g_array_append_val (ret, i);
292 * atspi_state_set_is_empty:
294 * @set: The #AtspiStateSet to query.
296 * Returns: #TRUE if the state set contains no states; #FALSE otherwise.
299 atspi_state_set_is_empty (AtspiStateSet *set)
301 return (set->states == 0);
305 * atspi_state_set_remove:
307 * @set: a pointer to the #AtspiStateSet object on which to operate.
308 * @state: an #AtspiStateType to remove from the specifiedn state set.
310 * Remove a particular #AtspiState to an #AtspiStateSet (i.e. set the
311 * given state to #FALSE in the stateset.)
315 atspi_state_set_remove (AtspiStateSet *set, AtspiStateType state)
317 g_return_if_fail (set != NULL);
318 set->states &= ~((gint64)1 << state);