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.
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Library General Public
10 * License as published by the Free Software Foundation; either
11 * version 2 of the License, or (at your option) any later version.
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Library General Public License for more details.
18 * You should have received a copy of the GNU Library General Public
19 * License along with this library; if not, write to the
20 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21 * Boston, MA 02111-1307, USA.
24 #include <stdlib.h> /* for malloc */
25 #include "spi-common/spi-stateset.h"
26 #include <cspi/spi-private.h>
28 static const char *role_names [] =
86 "table-column-header",
118 "input method window"
121 #define MAX_ROLES (sizeof (role_names) / sizeof (char *))
124 cspi_init_role_table (AccessibleRole *role_table)
127 for (i = 0; i < Accessibility_ROLE_LAST_DEFINED; ++i)
129 role_table [i] = SPI_ROLE_UNKNOWN;
131 role_table [Accessibility_ROLE_INVALID] = SPI_ROLE_INVALID;
132 role_table [Accessibility_ROLE_ACCELERATOR_LABEL] = SPI_ROLE_ACCEL_LABEL;
133 role_table [Accessibility_ROLE_ALERT] = SPI_ROLE_ALERT;
134 role_table [Accessibility_ROLE_ANIMATION] = SPI_ROLE_ANIMATION;
135 role_table [Accessibility_ROLE_ARROW] = SPI_ROLE_ARROW;
136 role_table [Accessibility_ROLE_CALENDAR] = SPI_ROLE_CALENDAR;
137 role_table [Accessibility_ROLE_CANVAS] = SPI_ROLE_CANVAS;
138 role_table [Accessibility_ROLE_CHECK_BOX] = SPI_ROLE_CHECK_BOX;
139 role_table [Accessibility_ROLE_CHECK_MENU_ITEM] = SPI_ROLE_CHECK_MENU_ITEM;
140 role_table [Accessibility_ROLE_COLOR_CHOOSER] = SPI_ROLE_COLOR_CHOOSER;
141 role_table [Accessibility_ROLE_COLUMN_HEADER] = SPI_ROLE_COLUMN_HEADER;
142 role_table [Accessibility_ROLE_COMBO_BOX] = SPI_ROLE_COMBO_BOX;
143 role_table [Accessibility_ROLE_DATE_EDITOR] = SPI_ROLE_DATE_EDITOR;
144 role_table [Accessibility_ROLE_DESKTOP_ICON] = SPI_ROLE_DESKTOP_ICON;
145 role_table [Accessibility_ROLE_DESKTOP_FRAME] = SPI_ROLE_DESKTOP_FRAME;
146 role_table [Accessibility_ROLE_DIAL] = SPI_ROLE_DIAL;
147 role_table [Accessibility_ROLE_DIALOG] = SPI_ROLE_DIALOG;
148 role_table [Accessibility_ROLE_DIRECTORY_PANE] = SPI_ROLE_DIRECTORY_PANE;
149 role_table [Accessibility_ROLE_DRAWING_AREA] = SPI_ROLE_DRAWING_AREA;
150 role_table [Accessibility_ROLE_FILE_CHOOSER] = SPI_ROLE_FILE_CHOOSER;
151 role_table [Accessibility_ROLE_FILLER] = SPI_ROLE_FILLER;
152 role_table [Accessibility_ROLE_FONT_CHOOSER] = SPI_ROLE_FONT_CHOOSER;
153 role_table [Accessibility_ROLE_FRAME] = SPI_ROLE_FRAME;
154 role_table [Accessibility_ROLE_GLASS_PANE] = SPI_ROLE_GLASS_PANE;
155 role_table [Accessibility_ROLE_HTML_CONTAINER] = SPI_ROLE_HTML_CONTAINER;
156 role_table [Accessibility_ROLE_ICON] = SPI_ROLE_ICON;
157 role_table [Accessibility_ROLE_IMAGE] = SPI_ROLE_IMAGE;
158 role_table [Accessibility_ROLE_INTERNAL_FRAME] = SPI_ROLE_INTERNAL_FRAME;
159 role_table [Accessibility_ROLE_LABEL] = SPI_ROLE_LABEL;
160 role_table [Accessibility_ROLE_LAYERED_PANE] = SPI_ROLE_LAYERED_PANE;
161 role_table [Accessibility_ROLE_LIST] = SPI_ROLE_LIST;
162 role_table [Accessibility_ROLE_LIST_ITEM] = SPI_ROLE_LIST_ITEM;
163 role_table [Accessibility_ROLE_MENU] = SPI_ROLE_MENU;
164 role_table [Accessibility_ROLE_MENU_BAR] = SPI_ROLE_MENU_BAR;
165 role_table [Accessibility_ROLE_MENU_ITEM] = SPI_ROLE_MENU_ITEM;
166 role_table [Accessibility_ROLE_OPTION_PANE] = SPI_ROLE_OPTION_PANE;
167 role_table [Accessibility_ROLE_PAGE_TAB] = SPI_ROLE_PAGE_TAB;
168 role_table [Accessibility_ROLE_PAGE_TAB_LIST] = SPI_ROLE_PAGE_TAB_LIST;
169 role_table [Accessibility_ROLE_PANEL] = SPI_ROLE_PANEL;
170 role_table [Accessibility_ROLE_PASSWORD_TEXT] = SPI_ROLE_PASSWORD_TEXT;
171 role_table [Accessibility_ROLE_POPUP_MENU] = SPI_ROLE_POPUP_MENU;
172 role_table [Accessibility_ROLE_PROGRESS_BAR] = SPI_ROLE_PROGRESS_BAR;
173 role_table [Accessibility_ROLE_PUSH_BUTTON] = SPI_ROLE_PUSH_BUTTON;
174 role_table [Accessibility_ROLE_RADIO_BUTTON] = SPI_ROLE_RADIO_BUTTON;
175 role_table [Accessibility_ROLE_RADIO_MENU_ITEM] = SPI_ROLE_RADIO_MENU_ITEM;
176 role_table [Accessibility_ROLE_ROOT_PANE] = SPI_ROLE_ROOT_PANE;
177 role_table [Accessibility_ROLE_ROW_HEADER] = SPI_ROLE_ROW_HEADER;
178 role_table [Accessibility_ROLE_SCROLL_BAR] = SPI_ROLE_SCROLL_BAR;
179 role_table [Accessibility_ROLE_SCROLL_PANE] = SPI_ROLE_SCROLL_PANE;
180 role_table [Accessibility_ROLE_SEPARATOR] = SPI_ROLE_SEPARATOR;
181 role_table [Accessibility_ROLE_SLIDER] = SPI_ROLE_SLIDER;
182 role_table [Accessibility_ROLE_SPIN_BUTTON] = SPI_ROLE_SPIN_BUTTON;
183 role_table [Accessibility_ROLE_SPLIT_PANE] = SPI_ROLE_SPLIT_PANE;
184 role_table [Accessibility_ROLE_STATUS_BAR] = SPI_ROLE_STATUS_BAR;
185 role_table [Accessibility_ROLE_TABLE] = SPI_ROLE_TABLE;
186 role_table [Accessibility_ROLE_TABLE_CELL] = SPI_ROLE_TABLE_CELL;
187 role_table[Accessibility_ROLE_TABLE_COLUMN_HEADER] = SPI_ROLE_TABLE_COLUMN_HEADER;
188 role_table[Accessibility_ROLE_TABLE_ROW_HEADER] = SPI_ROLE_TABLE_ROW_HEADER;
189 role_table [Accessibility_ROLE_TEAROFF_MENU_ITEM] = SPI_ROLE_TEAROFF_MENU_ITEM;
190 role_table[Accessibility_ROLE_TERMINAL] = SPI_ROLE_TERMINAL;
191 role_table [Accessibility_ROLE_TEXT] = SPI_ROLE_TEXT;
192 role_table [Accessibility_ROLE_TOGGLE_BUTTON] = SPI_ROLE_TOGGLE_BUTTON;
193 role_table [Accessibility_ROLE_TOOL_BAR] = SPI_ROLE_TOOL_BAR;
194 role_table [Accessibility_ROLE_TOOL_TIP] = SPI_ROLE_TOOL_TIP;
195 role_table [Accessibility_ROLE_TREE] = SPI_ROLE_TREE;
196 role_table [Accessibility_ROLE_TREE_TABLE] = SPI_ROLE_TREE_TABLE;
197 role_table [Accessibility_ROLE_VIEWPORT] = SPI_ROLE_VIEWPORT;
198 role_table [Accessibility_ROLE_WINDOW] = SPI_ROLE_WINDOW;
199 role_table [Accessibility_ROLE_EXTENDED] = SPI_ROLE_EXTENDED;
200 role_table [Accessibility_ROLE_HEADER] = SPI_ROLE_HEADER;
201 role_table [Accessibility_ROLE_FOOTER] = SPI_ROLE_FOOTER;
202 role_table [Accessibility_ROLE_PARAGRAPH] = SPI_ROLE_PARAGRAPH;
203 role_table [Accessibility_ROLE_RULER] = SPI_ROLE_RULER;
204 role_table [Accessibility_ROLE_APPLICATION] = SPI_ROLE_APPLICATION;
205 role_table [Accessibility_ROLE_AUTOCOMPLETE] = SPI_ROLE_AUTOCOMPLETE;
206 role_table [Accessibility_ROLE_EDITBAR] = SPI_ROLE_EDITBAR;
207 role_table [Accessibility_ROLE_EMBEDDED] = SPI_ROLE_EMBEDDED;
208 role_table [Accessibility_ROLE_ENTRY] = SPI_ROLE_ENTRY;
209 role_table [Accessibility_ROLE_CHART] = SPI_ROLE_CHART;
210 role_table [Accessibility_ROLE_CAPTION] = SPI_ROLE_CAPTION;
211 role_table [Accessibility_ROLE_DOCUMENT_FRAME] = SPI_ROLE_DOCUMENT_FRAME;
212 role_table [Accessibility_ROLE_HEADING] = SPI_ROLE_HEADING;
213 role_table [Accessibility_ROLE_PAGE] = SPI_ROLE_PAGE;
214 role_table [Accessibility_ROLE_SECTION] = SPI_ROLE_SECTION;
215 role_table [Accessibility_ROLE_FORM] = SPI_ROLE_FORM;
216 role_table [Accessibility_ROLE_REDUNDANT_OBJECT] = SPI_ROLE_REDUNDANT_OBJECT;
217 role_table [Accessibility_ROLE_LINK] = SPI_ROLE_LINK;
218 role_table [Accessibility_ROLE_INPUT_METHOD_WINDOW] = SPI_ROLE_INPUT_METHOD_WINDOW;
224 cspi_role_from_spi_role (Accessibility_Role role)
226 /* array is sized according to IDL roles because IDL roles are the index */
227 static AccessibleRole cspi_role_table [Accessibility_ROLE_LAST_DEFINED];
228 static SPIBoolean is_initialized = FALSE;
229 AccessibleRole cspi_role;
232 is_initialized = cspi_init_role_table (cspi_role_table);
234 if (role >= 0 && role < Accessibility_ROLE_LAST_DEFINED)
236 cspi_role = cspi_role_table [role];
240 cspi_role = SPI_ROLE_EXTENDED;
245 AccessibleAttributeSet *
246 _cspi_attribute_set_from_sequence (const GArray *seq)
248 AccessibleAttributeSet *set = g_new0 (AccessibleAttributeSet, 1);
252 set->attributes = g_new0 (char *, set->len);
253 for (i = 0; i < set->len; ++i)
255 set->attributes[i] = g_array_index (seq, char *, i);
258 g_array_free (seq, TRUE);
263 * AccessibleRole_getName:
264 * @role: an #AccessibleRole object to query.
266 * Get a localizeable string that indicates the name of an #AccessibleRole.
267 * <em>DEPRECATED.</em>
269 * Returns: a localizable string name for an #AccessibleRole enumerated type.
272 AccessibleRole_getName (AccessibleRole role)
274 if (role < MAX_ROLES && role_names [(int) role])
276 return g_strdup (role_names [(int) role]);
280 return g_strdup ("");
286 * @obj: a pointer to the #Accessible object on which to operate.
288 * Increment the reference count for an #Accessible object.
291 Accessible_ref (Accessible *obj)
293 cspi_object_ref (obj);
298 * @obj: a pointer to the #Accessible object on which to operate.
300 * Decrement the reference count for an #Accessible object.
303 Accessible_unref (Accessible *obj)
305 cspi_object_unref (obj);
309 * Accessible_getName:
310 * @obj: a pointer to the #Accessible object on which to operate.
312 * Get the name of an #Accessible object.
314 * Returns: a UTF-8 string indicating the name of the #Accessible object.
315 * or NULL on exception
318 Accessible_getName (Accessible *obj)
320 cspi_return_val_if_fail (obj != NULL, NULL);
321 return g_strdup (obj->name);
325 * Accessible_getDescription:
326 * @obj: a pointer to the #Accessible object on which to operate.
328 * Get the description of an #Accessible object.
330 * Returns: a UTF-8 string describing the #Accessible object.
331 * or NULL on exception
334 Accessible_getDescription (Accessible *obj)
336 cspi_return_val_if_fail (obj != NULL, NULL);
338 return g_strdup (obj->description);
342 * Accessible_getParent:
343 * @obj: a pointer to the #Accessible object to query.
345 * Get an #Accessible object's parent container.
347 * Returns: a pointer tothe #Accessible object which contains the given
348 * #Accessible instance, or NULL if the @obj has no parent container.
352 Accessible_getParent (Accessible *obj)
354 cspi_return_val_if_fail (obj != NULL, NULL);
356 return cspi_object_add (obj->parent);
360 * Accessible_getChildCount:
361 * @obj: a pointer to the #Accessible object on which to operate.
363 * Get the number of children contained by an #Accessible object.
365 * Returns: a #long indicating the number of #Accessible children
366 * contained by an #Accessible object. or -1 on exception
370 Accessible_getChildCount (Accessible *obj)
372 cspi_return_val_if_fail (obj != NULL, -1);
374 return g_list_length (obj->children);
378 * Accessible_getChildAtIndex:
379 * @obj: a pointer to the #Accessible object on which to operate.
380 * @childIndex: a #long indicating which child is specified.
382 * Get the #Accessible child of an #Accessible object at a given index.
384 * Returns: a pointer to the #Accessible child object at index
385 * @childIndex. or NULL on exception
388 Accessible_getChildAtIndex (Accessible *obj,
393 cspi_return_val_if_fail (obj != NULL, NULL);
395 child = g_list_nth_data (obj->children, childIndex);
396 return cspi_object_add(child);
400 * Accessible_getIndexInParent:
401 * @obj: a pointer to the #Accessible object on which to operate.
403 * Get the index of an #Accessible object in its containing #Accessible.
405 * Returns: a #long indicating the index of the #Accessible object
406 * in its parent (i.e. containing) #Accessible instance,
407 * or -1 if @obj has no containing parent or on exception.
410 Accessible_getIndexInParent (Accessible *obj)
415 cspi_return_val_if_fail (obj != NULL, -1);
416 if (!obj->parent) return -1;
417 l = obj->parent->children;
420 if (l->data == obj) return i;
431 } Accessibility_Relation;
434 * Accessible_getRelationSet:
435 * @obj: a pointer to the #Accessible object on which to operate.
437 * Get the set of #AccessibleRelation objects which describe this #Accessible object's
438 * relationships with other #Accessible objects.
440 * Returns: an array of #AccessibleRelation pointers. or NULL on exception
442 AccessibleRelation **
443 Accessible_getRelationSet (Accessible *obj)
447 AccessibleRelation **relations;
448 GArray *relation_set;
451 cspi_return_val_if_fail (obj != NULL, NULL);
453 g_assert (!cspi_exception ());
455 dbus_error_init (&error);
456 cspi_dbus_call (obj, spi_interface_accessible, "getAttributes", &error, "=>a(uao)", &relation_set);
458 cspi_return_val_if_ev ("getRelationSet", NULL);
460 n_relations = relation_set->len;
461 relations = malloc (sizeof (AccessibleRelation *) * (n_relations + 1));
463 for (i = 0; i < n_relations; ++i)
465 Accessibility_Relation *r = g_array_index (relation_set, Accessibility_Relation *, i);
466 relations[i] = g_new (AccessibleRelation, 1);
467 if (!relations[i]) continue;
468 relations[i]->ref_count = 1;
469 relations[i]->type = r->type;
470 relations[i]->targets = r->targets;
474 g_array_free (relation_set, TRUE);
480 * Accessible_getRole:
481 * @obj: a pointer to the #Accessible object on which to operate.
483 * Get the UI role of an #Accessible object.
484 * A UTF-8 string describing this role can be obtained via Accessible_getRoleName ().
486 * Returns: the #AccessibleRole of the object.
490 Accessible_getRole (Accessible *obj)
492 cspi_return_val_if_fail (obj != NULL, SPI_ROLE_INVALID);
498 * Accessible_getRoleName:
499 * @obj: a pointer to the #Accessible object on which to operate.
501 * Get a UTF-8 string describing the role this object plays in the UI.
502 * This method will return useful values for roles that fall outside the
503 * enumeration used in Accessible_getRole ().
505 * Returns: a UTF-8 string specifying the role of this #Accessible object.
509 Accessible_getRoleName (Accessible *obj)
513 cspi_return_val_if_fail (obj != NULL, g_strdup ("invalid"));
515 cspi_dbus_call (obj, spi_interface_accessible, "getRoleName", NULL, "=>s", &retval);
517 cspi_return_val_if_ev ("getRoleName", g_strdup ("invalid"));
523 * Accessible_getLocalizedRoleName:
524 * @obj: a pointer to the #Accessible object on which to operate.
526 * Get a UTF-8 string describing the (localized) role this object plays in the UI.
527 * This method will return useful values for roles that fall outside the
528 * enumeration used in Accessible_getRole ().
532 * Returns: a UTF-8 string specifying the role of this #Accessible object.
536 Accessible_getLocalizedRoleName (Accessible *obj)
540 cspi_return_val_if_fail (obj != NULL, g_strdup ("invalid"));
542 cspi_dbus_call (obj, spi_interface_accessible, "getLocalizedRoleName", NULL, "=>s", &retval);
544 cspi_return_val_if_ev ("getLocalizedRoleName", g_strdup ("invalid"));
550 * Accessible_getStateSet:
551 * @obj: a pointer to the #Accessible object on which to operate.
553 * Gets the current state of an object.
555 * Returns: a pointer to an #AccessibleStateSet representing the object's current state.
558 Accessible_getStateSet (Accessible *obj)
560 GArray *state_bitflags;
561 AccessibleStateSet *retval;
563 cspi_return_val_if_fail (obj != NULL, NULL);
565 cspi_dbus_call (obj, spi_interface_accessible, "getStateSet", NULL, "=>au", &state_bitflags);
566 cspi_return_val_if_ev ("getState", NULL);
568 retval = spi_state_set_cache_new (state_bitflags);
570 g_array_free (state_bitflags, TRUE);
576 * Accessible_getAttributes:
577 * @obj: The #Accessible being queried.
579 * Get the #AttributeSet representing any assigned
580 * name-value pair attributes or annotations for this object.
581 * For typographic, textual, or textually-semantic attributes, see
582 * AccessibleText_getAttributes instead.
584 * Returns: The name-value-pair attributes assigned to this object.
586 AccessibleAttributeSet *
587 Accessible_getAttributes (Accessible *obj)
589 AccessibleAttributeSet *retval;
592 cspi_return_val_if_fail (obj != NULL, NULL);
594 cspi_dbus_call (obj, spi_interface_accessible, "getAttributes", NULL, "=>as", &dbus_seq);
596 cspi_return_val_if_ev ("getAttributes", NULL);
598 retval = _cspi_attribute_set_from_sequence (dbus_seq);
604 * Accessible_getHostApplication:
605 * @obj: The #Accessible being queried.
607 * Get the containing #AccessibleApplication for an object.
609 * Returns: the containing AccessibleApplication instance for this object.
611 AccessibleApplication *
612 Accessible_getHostApplication (Accessible *obj)
614 while (obj->parent) obj = obj->parent;
618 /* Interface query methods */
621 * Accessible_isAction:
622 * @obj: a pointer to the #Accessible instance to query.
624 * Query whether the specified #Accessible implements #AccessibleAction.
626 * Returns: #TRUE if @obj implements the #AccessibleAction interface,
630 Accessible_isAction (Accessible *obj)
632 return cspi_accessible_is_a (obj,
633 spi_interface_action);
637 * Accessible_isApplication:
638 * @obj: a pointer to the #Accessible instance to query.
640 * Query whether the specified #Accessible implements #AccessibleApplication.
642 * Returns: #TRUE if @obj implements the #AccessibleApplication interface,
646 Accessible_isApplication (Accessible *obj)
648 return cspi_accessible_is_a (obj,
649 spi_interface_application);
653 * Accessible_isCollection: * @obj: a pointer to the #Accessible instance to query.
655 * Query whether the specified #Accessible implements #AccessibleCollection.
656 * Returns: #TRUE if @obj implements the #AccessibleCollection interface,
661 Accessible_isCollection (Accessible *obj)
664 g_warning ("Collections not implemented");
665 return cspi_accessible_is_a (obj,
666 spi_interface_collection);
673 * Accessible_isComponent:
674 * @obj: a pointer to the #Accessible instance to query.
676 * Query whether the specified #Accessible implements #AccessibleComponent.
678 * Returns: #TRUE if @obj implements the #AccessibleComponent interface,
682 Accessible_isComponent (Accessible *obj)
684 return cspi_accessible_is_a (obj,
685 spi_interface_component);
689 * Accessible_isDocument:
690 * @obj: a pointer to the #Accessible instance to query.
692 * Query whether the specified #Accessible implements #AccessibleDocument.
694 * Returns: #TRUE if @obj implements the #AccessibleDocument interface,
698 Accessible_isDocument (Accessible *obj)
700 return cspi_accessible_is_a (obj,
701 spi_interface_document);
705 * Accessible_isEditableText:
706 * @obj: a pointer to the #Accessible instance to query.
708 * Query whether the specified #Accessible implements #AccessibleEditableText.
710 * Returns: #TRUE if @obj implements the #AccessibleEditableText interface,
714 Accessible_isEditableText (Accessible *obj)
716 return cspi_accessible_is_a (obj,
717 spi_interface_editable_text);
721 * Accessible_isMatchRule:
722 * @obj: a pointer to the #Accessible instance to query.
724 * Query whether the specified #Accessible implements #AccessibleMatchRule.
726 * Returns: #TRUE if @obj implements the #AccessibleMatchRule interface,
730 Accessible_isMatchRule (Accessible *obj)
733 return cspi_accessible_is_a (obj,
734 spi_interface_match_rule);
736 g_warning ("Match rules not implemented");
742 * Accessible_isHypertext:
743 * @obj: a pointer to the #Accessible instance to query.
745 * Query whether the specified #Accessible implements #AccessibleHypertext.
747 * Returns: #TRUE if @obj implements the #AccessibleHypertext interface,
751 Accessible_isHypertext (Accessible *obj)
753 return cspi_accessible_is_a (obj,
754 spi_interface_hypertext);
758 * Accessible_isImage:
759 * @obj: a pointer to the #Accessible instance to query.
761 * Query whether the specified #Accessible implements #AccessibleImage.
763 * Returns: #TRUE if @obj implements the #AccessibleImage interface,
767 Accessible_isImage (Accessible *obj)
769 return cspi_accessible_is_a (obj,
770 spi_interface_image);
774 * Accessible_isSelection:
775 * @obj: a pointer to the #Accessible instance to query.
777 * Query whether the specified #Accessible implements #AccessibleSelection.
779 * Returns: #TRUE if @obj implements the #AccessibleSelection interface,
783 Accessible_isSelection (Accessible *obj)
785 return cspi_accessible_is_a (obj,
786 spi_interface_selection);
790 * Accessible_isTable:
791 * @obj: a pointer to the #Accessible instance to query.
793 * Query whether the specified #Accessible implements #AccessibleTable.
795 * Returns: #TRUE if @obj implements the #AccessibleTable interface,
799 Accessible_isTable (Accessible *obj)
801 return cspi_accessible_is_a (obj,
802 spi_interface_table);
806 * Accessible_isStreamableContent:
807 * @obj: a pointer to the #Accessible instance to query.
809 * Query whether the specified #Accessible implements
810 * #AccessibleStreamableContent.
812 * Returns: #TRUE if @obj implements the #AccessibleStreamableContent interface,
816 Accessible_isStreamableContent (Accessible *obj)
819 return cspi_accessible_is_a (obj,
820 spi_interface_streamable_content);
822 g_warning ("Streamable content not implemented");
829 * @obj: a pointer to the #Accessible instance to query.
831 * Query whether the specified #Accessible implements #AccessibleText.
833 * Returns: #TRUE if @obj implements the #AccessibleText interface,
837 Accessible_isText (Accessible *obj)
839 return cspi_accessible_is_a (obj,
844 * Accessible_isValue:
845 * @obj: a pointer to the #Accessible instance to query.
847 * Query whether the specified #Accessible implements #AccessibleValue.
849 * Returns: #TRUE if @obj implements the #AccessibleValue interface,
853 Accessible_isValue (Accessible *obj)
855 return cspi_accessible_is_a (obj,
856 spi_interface_value);
860 * Accessible_getApplication:
861 * @obj: a pointer to the #Accessible instance to query.
863 * Get the #AccessibleApplication interface for an #Accessible.
865 * Returns: a pointer to an #AccessibleApplication interface instance, or
866 * NULL if @obj does not implement #AccessibleApplication.
868 AccessibleApplication *
869 Accessible_getApplication (Accessible *obj)
871 return (AccessibleApplication *) Accessible_queryInterface (
872 obj, spi_interface_application);
876 * Accessible_getAction:
877 * @obj: a pointer to the #Accessible instance to query.
879 * Get the #AccessibleAction interface for an #Accessible.
881 * Returns: a pointer to an #AccessibleAction interface instance, or
882 * NULL if @obj does not implement #AccessibleAction.
885 Accessible_getAction (Accessible *obj)
887 return (AccessibleAction *) Accessible_queryInterface (
888 obj, spi_interface_action);
893 * Accessible_getCollection:
894 * @obj: a pointer to the #Accessible instance to query.
896 * Get the #AccessibleCollection interface for an #Accessible.
898 * Returns: a pointer to an #AccessibleCollection interface instance, or
899 * NULL if @obj does not implement #AccessibleCollection.
901 AccessibleCollection *
902 Accessible_getCollection (Accessible *obj)
905 return (AccessibleCollection *) Accessible_queryInterface (
906 obj, spi_interface_collection);
908 g_warning ("Collections not implemented");
913 * Accessible_getComponent:
914 * @obj: a pointer to the #Accessible instance to query.
916 * Get the #AccessibleComponent interface for an #Accessible.
918 * Returns: a pointer to an #AccessibleComponent interface instance, or
919 * NULL if @obj does not implement #AccessibleComponent.
921 AccessibleComponent *
922 Accessible_getComponent (Accessible *obj)
924 return (AccessibleComponent *) Accessible_queryInterface (
925 obj, spi_interface_component);
929 * Accessible_getDocument:
930 * @obj: a pointer to the #Accessible instance to query.
932 * Get the #AccessibleDocument interface for an #Accessible.
934 * Returns: a pointer to an #AccessibleDocument interface instance, or
935 * NULL if @obj does not implement #AccessibleDocument.
938 Accessible_getDocument (Accessible *obj)
940 return (AccessibleDocument *) Accessible_queryInterface (
941 obj, spi_interface_document);
945 * Accessible_getEditableText:
946 * @obj: a pointer to the #Accessible instance to query.
948 * Get the #AccessibleEditableText interface for an #Accessible.
950 * Returns: a pointer to an #AccessibleEditableText interface instance, or
951 * NULL if @obj does not implement #AccessibleEditableText.
953 AccessibleEditableText *
954 Accessible_getEditableText (Accessible *obj)
956 return (AccessibleEditableText *) Accessible_queryInterface (
957 obj, spi_interface_editable_text);
962 * Accessible_getHypertext:
963 * @obj: a pointer to the #Accessible instance to query.
965 * Get the #AccessibleHypertext interface for an #Accessible.
967 * Returns: a pointer to an #AccessibleHypertext interface instance, or
968 * NULL if @obj does not implement #AccessibleHypertext.
970 AccessibleHypertext *
971 Accessible_getHypertext (Accessible *obj)
973 return (AccessibleHypertext *) Accessible_queryInterface (
974 obj, spi_interface_hypertext);
980 * Accessible_getImage:
981 * @obj: a pointer to the #Accessible instance to query.
983 * Get the #AccessibleImage interface for an #Accessible.
985 * Returns: a pointer to an #AccessibleImage interface instance, or
986 * NULL if @obj does not implement #AccessibleImage.
989 Accessible_getImage (Accessible *obj)
991 return (AccessibleImage *) Accessible_queryInterface (
992 obj, spi_interface_image);
996 * Accessible_getMatchRule:
997 * @obj: a pointer to the #Accessible instance to query.
999 * Get the #AccessibleMatchRule interface for an #Accessible.
1001 * Returns: a pointer to an #AccessibleMatchRule interface instance, or
1002 * NULL if @obj does not implement #AccessibleMatchRule.
1004 AccessibleMatchRule *
1005 Accessible_getMatchRule (Accessible *obj)
1008 return (AccessibleMatchRule *) Accessible_queryInterface (
1009 obj, spi_interface_match_rule);
1011 g_warning ("Match rules not supported");
1016 * Accessible_getSelection:
1017 * @obj: a pointer to the #Accessible instance to query.
1019 * Get the #AccessibleSelection interface for an #Accessible.
1021 * Returns: a pointer to an #AccessibleSelection interface instance, or
1022 * NULL if @obj does not implement #AccessibleSelection.
1024 AccessibleSelection *
1025 Accessible_getSelection (Accessible *obj)
1027 return (AccessibleSelection *) Accessible_queryInterface (
1028 obj, spi_interface_selection);
1034 * Accessible_getStreamableContent:
1035 * @obj: a pointer to the #Accessible instance to query.
1037 * Get the #AccessibleStreamableContent interface for an #Accessible.
1039 * Returns: a pointer to an #AccessibleStreamableContent interface instance, or
1040 * NULL if @obj does not implement #AccessibleStreamableContent.
1042 AccessibleStreamableContent *
1043 Accessible_getStreamableContent (Accessible *obj)
1046 return (AccessibleStreamableContent *) Accessible_queryInterface (
1047 obj, spi_interface_streamable_content);
1049 g_warning ("Streamable content not supported");
1054 * Accessible_getTable:
1055 * @obj: a pointer to the #Accessible instance to query.
1057 * Get the #AccessibleTable interface for an #Accessible.
1059 * Returns: a pointer to an #AccessibleTable interface instance, or
1060 * NULL if @obj does not implement #AccessibleTable.
1063 Accessible_getTable (Accessible *obj)
1065 return (AccessibleTable *) Accessible_queryInterface (
1066 obj, spi_interface_table);
1070 * Accessible_getText:
1071 * @obj: a pointer to the #Accessible instance to query.
1073 * Get the #AccessibleText interface for an #Accessible.
1075 * Returns: a pointer to an #AccessibleText interface instance, or
1076 * NULL if @obj does not implement #AccessibleText.
1079 Accessible_getText (Accessible *obj)
1081 return (AccessibleText *) Accessible_queryInterface (
1082 obj, spi_interface_text);
1088 * Accessible_getValue:
1089 * @obj: a pointer to the #Accessible instance to query.
1091 * Get the #AccessibleValue interface for an #Accessible.
1093 * Returns: a pointer to an #AccessibleValue interface instance, or
1094 * NULL if @obj does not implement #AccessibleValue.
1097 Accessible_getValue (Accessible *obj)
1099 return (AccessibleValue *) Accessible_queryInterface (
1100 obj, spi_interface_value);
1106 * Accessible_queryInterface:
1107 * @obj: a pointer to the #Accessible instance to query.
1108 * @interface_name: a UTF-8 character string specifiying the requested interface.
1110 * Query an #Accessible object to for a named interface.
1112 * Returns: an instance of the named interface object, if it is implemented
1113 * by @obj, or NULL otherwise.
1117 Accessible_queryInterface (Accessible *obj,
1118 const char *interface_name)
1120 if (cspi_accessible_is_a (obj, interface_name))
1122 /* The original code called cspi_object_add(obj) instead, but gok and
1123 * simple-at don't treat interfaces as references, so I'm confused
1124 * and not going to replicate this bit of code */
1132 * AccessibleRelation_ref:
1133 * @obj: a pointer to the #AccessibleRelation object on which to operate.
1135 * Increment the reference count for an #AccessibleRelation object.
1139 AccessibleRelation_ref (AccessibleRelation *obj)
1145 * AccessibleRelation_unref:
1146 * @obj: a pointer to the #AccessibleRelation object on which to operate.
1148 * Decrement the reference count for an #AccessibleRelation object.
1152 AccessibleRelation_unref (AccessibleRelation *obj)
1155 if (obj->ref_count <= 0)
1157 g_array_free (obj->targets, TRUE);
1163 cspi_init_relation_type_table (AccessibleRelationType *relation_type_table)
1166 for (i = 0; i < Accessibility_RELATION_LAST_DEFINED; ++i)
1168 relation_type_table [i] = SPI_RELATION_NULL;
1170 relation_type_table [Accessibility_RELATION_NULL] = SPI_RELATION_NULL;
1171 relation_type_table [Accessibility_RELATION_LABEL_FOR] = SPI_RELATION_LABEL_FOR;
1172 relation_type_table [Accessibility_RELATION_LABELLED_BY] = SPI_RELATION_LABELED_BY;
1173 relation_type_table [Accessibility_RELATION_CONTROLLER_FOR] = SPI_RELATION_CONTROLLER_FOR;
1174 relation_type_table [Accessibility_RELATION_CONTROLLED_BY] = SPI_RELATION_CONTROLLED_BY;
1175 relation_type_table [Accessibility_RELATION_MEMBER_OF] = SPI_RELATION_MEMBER_OF;
1176 relation_type_table [Accessibility_RELATION_TOOLTIP_FOR] = SPI_RELATION_NULL;
1177 relation_type_table [Accessibility_RELATION_NODE_CHILD_OF] = SPI_RELATION_NODE_CHILD_OF;
1178 relation_type_table [Accessibility_RELATION_EXTENDED] = SPI_RELATION_EXTENDED;
1179 relation_type_table [Accessibility_RELATION_FLOWS_TO] = SPI_RELATION_FLOWS_TO;
1180 relation_type_table [Accessibility_RELATION_FLOWS_FROM] = SPI_RELATION_FLOWS_FROM;
1181 relation_type_table [Accessibility_RELATION_SUBWINDOW_OF] = SPI_RELATION_SUBWINDOW_OF;
1182 relation_type_table [Accessibility_RELATION_EMBEDS] = SPI_RELATION_EMBEDS;
1183 relation_type_table [Accessibility_RELATION_EMBEDDED_BY] = SPI_RELATION_EMBEDDED_BY;
1184 relation_type_table [Accessibility_RELATION_POPUP_FOR] = SPI_RELATION_POPUP_FOR;
1185 relation_type_table [Accessibility_RELATION_PARENT_WINDOW_OF] = SPI_RELATION_PARENT_WINDOW_OF;
1186 relation_type_table [Accessibility_RELATION_DESCRIBED_BY] = SPI_RELATION_DESCRIBED_BY;
1187 relation_type_table [Accessibility_RELATION_DESCRIPTION_FOR] = SPI_RELATION_DESCRIPTION_FOR;
1191 static AccessibleRelationType
1192 cspi_relation_type_from_spi_relation_type (Accessibility_RelationType type)
1194 /* array is sized according to IDL RelationType because IDL RelationTypes are the index */
1195 static AccessibleRelationType cspi_relation_type_table [Accessibility_RELATION_LAST_DEFINED];
1196 static SPIBoolean is_initialized = FALSE;
1197 AccessibleRelationType cspi_type;
1198 if (!is_initialized)
1200 is_initialized = cspi_init_relation_type_table (cspi_relation_type_table);
1202 if (type >= 0 && type < Accessibility_RELATION_LAST_DEFINED)
1204 cspi_type = cspi_relation_type_table [type];
1208 cspi_type = SPI_RELATION_NULL;
1213 * AccessibleRelation_getRelationType:
1214 * @obj: a pointer to the #AccessibleRelation object to query.
1216 * Get the type of relationship represented by an #AccessibleRelation.
1218 * Returns: an #AccessibleRelationType indicating the type of relation
1219 * encapsulated in this #AccessibleRelation object.
1222 AccessibleRelationType
1223 AccessibleRelation_getRelationType (AccessibleRelation *obj)
1225 cspi_return_val_if_fail (obj, SPI_RELATION_NULL);
1226 return cspi_relation_type_from_spi_relation_type (obj->type);
1230 * AccessibleRelation_getNTargets:
1231 * @obj: a pointer to the #AccessibleRelation object to query.
1233 * Get the number of objects which this relationship has as its
1234 * target objects (the subject is the #Accessible from which this
1235 * #AccessibleRelation originated).
1237 * Returns: a short integer indicating how many target objects which the
1238 * originating #Accessible object has the #AccessibleRelation
1239 * relationship with.
1242 AccessibleRelation_getNTargets (AccessibleRelation *obj)
1244 cspi_return_val_if_fail (obj, -1);
1245 return obj->targets->len;
1249 * AccessibleRelation_getTarget:
1250 * @obj: a pointer to the #AccessibleRelation object to query.
1251 * @i: a (zero-index) integer indicating which (of possibly several) target is requested.
1253 * Get the @i-th target of a specified #AccessibleRelation relationship.
1255 * Returns: an #Accessible which is the @i-th object with which the
1256 * originating #Accessible has relationship specified in the
1257 * #AccessibleRelation object.
1261 AccessibleRelation_getTarget (AccessibleRelation *obj, int i)
1263 cspi_return_val_if_fail (obj, NULL);
1265 if (i < 0 || i >= obj->targets->len) return NULL;
1266 return cspi_object_add (
1267 g_array_index (obj->targets, Accessible *, i));
1271 * AccessibleStateSet_ref:
1272 * @obj: a pointer to the #AccessibleStateSet object on which to operate.
1274 * Increment the reference count for an #AccessibleStateSet object.
1278 AccessibleStateSet_ref (AccessibleStateSet *obj)
1280 spi_state_set_cache_ref (obj);
1284 * AccessibleStateSet_unref:
1285 * @obj: a pointer to the #AccessibleStateSet object on which to operate.
1287 * Decrement the reference count for an #AccessibleStateSet object.
1291 AccessibleStateSet_unref (AccessibleStateSet *obj)
1293 spi_state_set_cache_unref (obj);
1296 static Accessibility_StateType
1297 spi_state_to_dbus (AccessibleState state)
1299 #define MAP_STATE(a) \
1300 case SPI_STATE_##a: \
1301 return Accessibility_STATE_##a
1305 MAP_STATE (INVALID);
1309 MAP_STATE (CHECKED);
1310 MAP_STATE (DEFUNCT);
1311 MAP_STATE (EDITABLE);
1312 MAP_STATE (ENABLED);
1313 MAP_STATE (EXPANDABLE);
1314 MAP_STATE (EXPANDED);
1315 MAP_STATE (FOCUSABLE);
1316 MAP_STATE (FOCUSED);
1317 MAP_STATE (HORIZONTAL);
1318 MAP_STATE (ICONIFIED);
1320 MAP_STATE (MULTI_LINE);
1321 MAP_STATE (MULTISELECTABLE);
1323 MAP_STATE (PRESSED);
1324 MAP_STATE (RESIZABLE);
1325 MAP_STATE (SELECTABLE);
1326 MAP_STATE (SELECTED);
1327 MAP_STATE (SENSITIVE);
1328 MAP_STATE (SHOWING);
1329 MAP_STATE (SINGLE_LINE);
1331 MAP_STATE (TRANSIENT);
1332 MAP_STATE (VERTICAL);
1333 MAP_STATE (VISIBLE);
1334 MAP_STATE (MANAGES_DESCENDANTS);
1335 MAP_STATE (INDETERMINATE);
1336 MAP_STATE (TRUNCATED);
1337 MAP_STATE (REQUIRED);
1338 MAP_STATE (INVALID_ENTRY);
1339 MAP_STATE (SUPPORTS_AUTOCOMPLETION);
1340 MAP_STATE (SELECTABLE_TEXT);
1341 MAP_STATE (IS_DEFAULT);
1342 MAP_STATE (VISITED);
1344 return Accessibility_STATE_INVALID;
1350 * AccessibleStateSet_contains:
1351 * @obj: a pointer to the #AccessibleStateSet object on which to operate.
1352 * @state: an #AccessibleState for which the specified #AccessibleStateSet
1355 * Determine whether a given #AccessibleStateSet includes a given state; that is,
1356 * whether @state is true for the stateset in question.
1358 * Returns: #TRUE if @state is true/included in the given #AccessibleStateSet,
1363 AccessibleStateSet_contains (AccessibleStateSet *obj,
1364 AccessibleState state)
1366 return spi_state_set_cache_contains (obj, spi_state_to_dbus (state));
1370 * AccessibleStateSet_add:
1371 * @obj: a pointer to the #AccessibleStateSet object on which to operate.
1372 * @state: an #AccessibleState to be added to the specified #AccessibleStateSet
1374 * Add a particular #AccessibleState to an #AccessibleStateSet (i.e. set the
1375 * given state to #TRUE in the stateset.
1379 AccessibleStateSet_add (AccessibleStateSet *obj,
1380 AccessibleState state)
1382 spi_state_set_cache_add (obj, spi_state_to_dbus (state));
1386 * AccessibleStateSet_remove:
1387 * @obj: a pointer to the #AccessibleStateSet object on which to operate.
1388 * @state: an #AccessibleState to be removed from the specified #AccessibleStateSet
1390 * Remove a particular #AccessibleState to an #AccessibleStateSet (i.e. set the
1391 * given state to #FALSE in the stateset.)
1395 AccessibleStateSet_remove (AccessibleStateSet *obj,
1396 AccessibleState state)
1398 spi_state_set_cache_remove (obj, spi_state_to_dbus (state));
1402 * AccessibleStateSet_equals:
1403 * @obj: a pointer to the first #AccessibleStateSet object on which to operate.
1404 * @obj2: a pointer to the second #AccessibleStateSet object on which to operate.
1406 * Determine whether two instances of #AccessibleStateSet are equivalent (i.e.
1407 * consist of the same #AccessibleStates). Useful for checking multiple
1408 * state variables at once; construct the target state then compare against it.
1410 * @see AccessibleStateSet_compare().
1412 * Returns: #TRUE if the two #AccessibleStateSets are equivalent,
1417 AccessibleStateSet_equals (AccessibleStateSet *obj,
1418 AccessibleStateSet *obj2)
1428 cmp = spi_state_set_cache_xor (obj, obj2);
1429 eq = spi_state_set_cache_is_empty (cmp);
1430 spi_state_set_cache_unref (cmp);
1436 * AccessibleStateSet_compare:
1437 * @obj: a pointer to the first #AccessibleStateSet object on which to operate.
1438 * @obj2: a pointer to the second #AccessibleStateSet object on which to operate.
1440 * Determine the differences between two instances of #AccessibleStateSet.
1441 * Not Yet Implemented.
1443 * @see AccessibleStateSet_equals().
1445 * Returns: an #AccessibleStateSet object containing all states contained on one of
1446 * the two sets but not the other.
1449 AccessibleStateSet *
1450 AccessibleStateSet_compare (AccessibleStateSet *obj,
1451 AccessibleStateSet *obj2)
1453 return spi_state_set_cache_xor (obj, obj2);
1457 * AccessibleStateSet_isEmpty:
1458 * @obj: a pointer to the #AccessibleStateSet object on which to operate.
1460 * Determine whether a given #AccessibleStateSet is the empty set.
1462 * Returns: #TRUE if the given #AccessibleStateSet contains no (true) states,
1467 AccessibleStateSet_isEmpty (AccessibleStateSet *obj)
1469 return spi_state_set_cache_is_empty (obj);