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:
90 * @states: (element-type AtspiStateType): An array of states with which the
91 * method initializes the state set.
93 * Generates an #AtspiStateSet with the given @states.
95 * Returns: A new #AtspiStateSet with the given states.
98 atspi_state_set_new (GArray *states)
100 AtspiStateSet *set = g_object_new (ATSPI_TYPE_STATE_SET, NULL);
106 for (i = 0; i < states->len; i++)
107 atspi_state_set_add (set, g_array_index (states, AtspiStateType, i));
112 _atspi_state_set_new_internal (AtspiAccessible *accessible, gint64 states)
116 set = g_object_new (ATSPI_TYPE_STATE_SET, NULL);
117 g_return_val_if_fail (set != NULL, NULL);
119 set->accessible = accessible;
120 set->states = states;
125 * atspi_state_set_set_by_name:
126 * @set: a pointer to the #AtspiStateSet object on which to operate.
127 * @name: a string corresponding to a state name.
128 * @enabled: if #TRUE, @name should be enabled in the @set in question;
129 * otherwise, it should be disabled.
131 * Enables/disables a state in an #AtspiStateSet according to its @name.
134 atspi_state_set_set_by_name (AtspiStateSet *set, const gchar *name, gboolean enabled)
138 if (set->accessible &&
139 !(set->accessible->cached_properties & ATSPI_CACHE_STATES))
142 /* TODO: This could perhaps be optimized */
143 for (i = 0; state_names [i]; i++)
145 if (!strcmp (state_names [i], name))
148 set->states |= ((gint64)1 << i);
150 set->states &= ~((gint64)1 << i);
154 g_warning ("at-spi: Attempt to set unknown state '%s'", name);
158 refresh_states (AtspiStateSet *set)
161 dbus_uint32_t *states;
163 if (!set->accessible ||
164 (set->accessible->cached_properties & ATSPI_CACHE_STATES))
167 if (!_atspi_dbus_call (set->accessible, atspi_interface_accessible, "GetState", NULL, "=>au", &state_array))
170 states = (dbus_uint32_t *) state_array->data;
172 set->states = ((gint64)states [1]) << 32;
173 set->states |= (gint64) states [0];
174 g_array_free (state_array, TRUE);
178 * atspi_state_set_add:
179 * @set: a pointer to the #AtspiStateSet object on which to operate.
180 * @state: an #AtspiStateType to be added to the specified #AtspiStateSet.
182 * Adds a particular #AtspiState to an #AtspiStateSet (i.e. sets the
183 * given state to #TRUE in the stateset).
187 atspi_state_set_add (AtspiStateSet *set, AtspiStateType state)
189 g_return_if_fail (set != NULL);
190 set->states |= (((gint64)1) << state);
194 * atspi_state_set_compare:
195 * @set: a pointer to the first #AtspiStateSet object on which to operate.
196 * @set2: a pointer to the second #AtspiStateSet object on which to operate.
198 * Determines the differences between two instances of #AtspiStateSet.
200 * @see #atspi_state_set_equals.
202 * Returns: (transfer full): an #AtspiStateSet object containing all states
203 * contained on one of the two sets but not the other.
207 atspi_state_set_compare (AtspiStateSet *set,
210 g_return_val_if_fail (set != NULL, NULL);
211 g_return_val_if_fail (set2 != NULL, NULL);
213 return _atspi_state_set_new_internal (NULL, set->states ^ set2->states);
217 * atspi_state_set_contains:
218 * @set: a pointer to the #AtspiStateSet object on which to operate.
219 * @state: an #AtspiStateType for which the specified #AtspiStateSet
222 * Determines whether a given #AtspiStateSet includes a given state; that is,
223 * whether @state is true for the @set in question.
225 * Returns: #TRUE if @state is true/included in the given #AtspiStateSet,
230 atspi_state_set_contains (AtspiStateSet *set,
231 AtspiStateType state)
235 refresh_states (set);
236 return (set->states & ((gint64)1 << state)) ? TRUE : FALSE;
240 * atspi_state_set_equals:
241 * @set: a pointer to the first #AtspiStateSet object on which to operate.
242 * @set2: a pointer to the second #AtspiStateSet object on which to operate.
244 * Determines whether two instances of #AtspiStateSet are equivalent (i.e.
245 * consist of the same #AtspiStates). Useful for checking multiple
246 * state variables at once.
248 * @see #atspi_state_set_compare.
250 * Returns: #TRUE if the two #AtspiStateSets are equivalent,
255 atspi_state_set_equals (AtspiStateSet *set,
260 if (set == NULL || set2 == NULL)
262 return (set->states == set2->states);
266 * atspi_state_set_get_states:
267 * @set: The #AtspiStateSet to be queried.
269 * Returns the states in an #AtspiStateSet as an array.
271 * Returns: (element-type AtspiStateType) (transfer full): A #GArray of state
272 * types representing the current state.
275 atspi_state_set_get_states (AtspiStateSet *set)
281 g_return_val_if_fail (set != NULL, NULL);
282 refresh_states (set);
283 ret = g_array_new (TRUE, TRUE, sizeof (AtspiStateType));
286 for (i = 0; i < 64; i++)
288 if (set->states & val)
289 ret = g_array_append_val (ret, i);
296 * atspi_state_set_is_empty:
297 * @set: The #AtspiStateSet to query.
299 * Returns: #TRUE if the state set contains no states; #FALSE otherwise.
302 atspi_state_set_is_empty (AtspiStateSet *set)
304 return (set->states == 0);
308 * atspi_state_set_remove:
309 * @set: a pointer to the #AtspiStateSet object on which to operate.
310 * @state: an #AtspiStateType to remove from the specified @set.
312 * Removes a particular #AtspiState to an #AtspiStateSet (i.e. sets the
313 * given state to #FALSE in the stateset.)
317 atspi_state_set_remove (AtspiStateSet *set, AtspiStateType state)
319 g_return_if_fail (set != NULL);
320 set->states &= ~((gint64)1 << state);