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 <libspi/stateset.h>
26 #include <cspi/spi-private.h>
28 static const char *role_names [] =
86 "table-column-header",
107 #define MAX_ROLES (sizeof (role_names) / sizeof (char *))
110 cspi_init_role_table (AccessibleRole *role_table)
113 for (i = 0; i < Accessibility_ROLE_LAST_DEFINED; ++i)
115 role_table [i] = SPI_ROLE_UNKNOWN;
117 role_table [Accessibility_ROLE_INVALID] = SPI_ROLE_INVALID;
118 role_table [Accessibility_ROLE_ACCELERATOR_LABEL] = SPI_ROLE_ACCEL_LABEL;
119 role_table [Accessibility_ROLE_ALERT] = SPI_ROLE_ALERT;
120 role_table [Accessibility_ROLE_ANIMATION] = SPI_ROLE_ANIMATION;
121 role_table [Accessibility_ROLE_ARROW] = SPI_ROLE_ARROW;
122 role_table [Accessibility_ROLE_CALENDAR] = SPI_ROLE_CALENDAR;
123 role_table [Accessibility_ROLE_CANVAS] = SPI_ROLE_CANVAS;
124 role_table [Accessibility_ROLE_CHECK_BOX] = SPI_ROLE_CHECK_BOX;
125 role_table [Accessibility_ROLE_CHECK_MENU_ITEM] = SPI_ROLE_CHECK_MENU_ITEM;
126 role_table [Accessibility_ROLE_COLOR_CHOOSER] = SPI_ROLE_COLOR_CHOOSER;
127 role_table [Accessibility_ROLE_COLUMN_HEADER] = SPI_ROLE_COLUMN_HEADER;
128 role_table [Accessibility_ROLE_COMBO_BOX] = SPI_ROLE_COMBO_BOX;
129 role_table [Accessibility_ROLE_DATE_EDITOR] = SPI_ROLE_DATE_EDITOR;
130 role_table [Accessibility_ROLE_DESKTOP_ICON] = SPI_ROLE_DESKTOP_ICON;
131 role_table [Accessibility_ROLE_DESKTOP_FRAME] = SPI_ROLE_DESKTOP_FRAME;
132 role_table [Accessibility_ROLE_DIAL] = SPI_ROLE_DIAL;
133 role_table [Accessibility_ROLE_DIALOG] = SPI_ROLE_DIALOG;
134 role_table [Accessibility_ROLE_DIRECTORY_PANE] = SPI_ROLE_DIRECTORY_PANE;
135 role_table [Accessibility_ROLE_DRAWING_AREA] = SPI_ROLE_DRAWING_AREA;
136 role_table [Accessibility_ROLE_FILE_CHOOSER] = SPI_ROLE_FILE_CHOOSER;
137 role_table [Accessibility_ROLE_FILLER] = SPI_ROLE_FILLER;
138 role_table [Accessibility_ROLE_FONT_CHOOSER] = SPI_ROLE_FONT_CHOOSER;
139 role_table [Accessibility_ROLE_FRAME] = SPI_ROLE_FRAME;
140 role_table [Accessibility_ROLE_GLASS_PANE] = SPI_ROLE_GLASS_PANE;
141 role_table [Accessibility_ROLE_HTML_CONTAINER] = SPI_ROLE_HTML_CONTAINER;
142 role_table [Accessibility_ROLE_ICON] = SPI_ROLE_ICON;
143 role_table [Accessibility_ROLE_IMAGE] = SPI_ROLE_IMAGE;
144 role_table [Accessibility_ROLE_INTERNAL_FRAME] = SPI_ROLE_INTERNAL_FRAME;
145 role_table [Accessibility_ROLE_LABEL] = SPI_ROLE_LABEL;
146 role_table [Accessibility_ROLE_LAYERED_PANE] = SPI_ROLE_LAYERED_PANE;
147 role_table [Accessibility_ROLE_LIST] = SPI_ROLE_LIST;
148 role_table [Accessibility_ROLE_LIST_ITEM] = SPI_ROLE_LIST_ITEM;
149 role_table [Accessibility_ROLE_MENU] = SPI_ROLE_MENU;
150 role_table [Accessibility_ROLE_MENU_BAR] = SPI_ROLE_MENU_BAR;
151 role_table [Accessibility_ROLE_MENU_ITEM] = SPI_ROLE_MENU_ITEM;
152 role_table [Accessibility_ROLE_OPTION_PANE] = SPI_ROLE_OPTION_PANE;
153 role_table [Accessibility_ROLE_PAGE_TAB] = SPI_ROLE_PAGE_TAB;
154 role_table [Accessibility_ROLE_PAGE_TAB_LIST] = SPI_ROLE_PAGE_TAB_LIST;
155 role_table [Accessibility_ROLE_PANEL] = SPI_ROLE_PANEL;
156 role_table [Accessibility_ROLE_PASSWORD_TEXT] = SPI_ROLE_PASSWORD_TEXT;
157 role_table [Accessibility_ROLE_POPUP_MENU] = SPI_ROLE_POPUP_MENU;
158 role_table [Accessibility_ROLE_PROGRESS_BAR] = SPI_ROLE_PROGRESS_BAR;
159 role_table [Accessibility_ROLE_PUSH_BUTTON] = SPI_ROLE_PUSH_BUTTON;
160 role_table [Accessibility_ROLE_RADIO_BUTTON] = SPI_ROLE_RADIO_BUTTON;
161 role_table [Accessibility_ROLE_RADIO_MENU_ITEM] = SPI_ROLE_RADIO_MENU_ITEM;
162 role_table [Accessibility_ROLE_ROOT_PANE] = SPI_ROLE_ROOT_PANE;
163 role_table [Accessibility_ROLE_ROW_HEADER] = SPI_ROLE_ROW_HEADER;
164 role_table [Accessibility_ROLE_SCROLL_BAR] = SPI_ROLE_SCROLL_BAR;
165 role_table [Accessibility_ROLE_SCROLL_PANE] = SPI_ROLE_SCROLL_PANE;
166 role_table [Accessibility_ROLE_SEPARATOR] = SPI_ROLE_SEPARATOR;
167 role_table [Accessibility_ROLE_SLIDER] = SPI_ROLE_SLIDER;
168 role_table [Accessibility_ROLE_SPIN_BUTTON] = SPI_ROLE_SPIN_BUTTON;
169 role_table [Accessibility_ROLE_SPLIT_PANE] = SPI_ROLE_SPLIT_PANE;
170 role_table [Accessibility_ROLE_STATUS_BAR] = SPI_ROLE_STATUS_BAR;
171 role_table [Accessibility_ROLE_TABLE] = SPI_ROLE_TABLE;
172 role_table [Accessibility_ROLE_TABLE_CELL] = SPI_ROLE_TABLE_CELL;
173 role_table[Accessibility_ROLE_TABLE_COLUMN_HEADER] = SPI_ROLE_TABLE_COLUMN_HEADER;
174 role_table[Accessibility_ROLE_TABLE_ROW_HEADER] = SPI_ROLE_TABLE_ROW_HEADER;
175 role_table [Accessibility_ROLE_TEAROFF_MENU_ITEM] = SPI_ROLE_TEAROFF_MENU_ITEM;
176 role_table[Accessibility_ROLE_TERMINAL] = SPI_ROLE_TERMINAL;
177 role_table [Accessibility_ROLE_TEXT] = SPI_ROLE_TEXT;
178 role_table [Accessibility_ROLE_TOGGLE_BUTTON] = SPI_ROLE_TOGGLE_BUTTON;
179 role_table [Accessibility_ROLE_TOOL_BAR] = SPI_ROLE_TOOL_BAR;
180 role_table [Accessibility_ROLE_TOOL_TIP] = SPI_ROLE_TOOL_TIP;
181 role_table [Accessibility_ROLE_TREE] = SPI_ROLE_TREE;
182 role_table [Accessibility_ROLE_TREE_TABLE] = SPI_ROLE_TREE_TABLE;
183 role_table [Accessibility_ROLE_VIEWPORT] = SPI_ROLE_VIEWPORT;
184 role_table [Accessibility_ROLE_WINDOW] = SPI_ROLE_WINDOW;
185 role_table [Accessibility_ROLE_EXTENDED] = SPI_ROLE_EXTENDED;
186 role_table [Accessibility_ROLE_HEADER] = SPI_ROLE_HEADER;
187 role_table [Accessibility_ROLE_FOOTER] = SPI_ROLE_FOOTER;
188 role_table [Accessibility_ROLE_PARAGRAPH] = SPI_ROLE_PARAGRAPH;
189 role_table [Accessibility_ROLE_RULER] = SPI_ROLE_RULER;
190 role_table [Accessibility_ROLE_APPLICATION] = SPI_ROLE_APPLICATION;
195 static AccessibleRole
196 cspi_role_from_spi_role (Accessibility_Role role)
198 /* array is sized according to IDL roles because IDL roles are the index */
199 static AccessibleRole cspi_role_table [Accessibility_ROLE_LAST_DEFINED];
200 static SPIBoolean is_initialized = FALSE;
201 AccessibleRole cspi_role;
204 is_initialized = cspi_init_role_table (cspi_role_table);
206 if (role >= 0 && role < Accessibility_ROLE_LAST_DEFINED)
208 cspi_role = cspi_role_table [role];
212 cspi_role = SPI_ROLE_EXTENDED;
218 * AccessibleRole_getName:
219 * @role: an #AccessibleRole object to query.
221 * Get a localizeable string that indicates the name of an #AccessibleRole.
222 * <em>DEPRECATED.</em>
224 * Returns: a localizable string name for an #AccessibleRole enumerated type.
227 AccessibleRole_getName (AccessibleRole role)
229 if (role < MAX_ROLES && role_names [(int) role])
231 return CORBA_string_dup (role_names [(int) role]);
235 return CORBA_string_dup ("");
241 * @obj: a pointer to the #Accessible object on which to operate.
243 * Increment the reference count for an #Accessible object.
246 Accessible_ref (Accessible *obj)
248 cspi_object_ref (obj);
253 * @obj: a pointer to the #Accessible object on which to operate.
255 * Decrement the reference count for an #Accessible object.
258 Accessible_unref (Accessible *obj)
260 cspi_object_unref (obj);
264 * Accessible_getName:
265 * @obj: a pointer to the #Accessible object on which to operate.
267 * Get the name of an #Accessible object.
269 * Returns: a UTF-8 string indicating the name of the #Accessible object.
270 * or NULL on exception
273 Accessible_getName (Accessible *obj)
277 cspi_return_val_if_fail (obj != NULL, NULL);
279 retval = Accessibility_Accessible__get_name (CSPI_OBJREF (obj), cspi_ev ());
281 cspi_return_val_if_ev ("getName", NULL);
287 * Accessible_getDescription:
288 * @obj: a pointer to the #Accessible object on which to operate.
290 * Get the description of an #Accessible object.
292 * Returns: a UTF-8 string describing the #Accessible object.
293 * or NULL on exception
296 Accessible_getDescription (Accessible *obj)
300 cspi_return_val_if_fail (obj != NULL, NULL);
302 retval = Accessibility_Accessible__get_description (CSPI_OBJREF (obj),
305 cspi_return_val_if_ev ("getDescription", NULL);
311 * Accessible_getParent:
312 * @obj: a pointer to the #Accessible object to query.
314 * Get an #Accessible object's parent container.
316 * Returns: a pointer tothe #Accessible object which contains the given
317 * #Accessible instance, or NULL if the @obj has no parent container.
321 Accessible_getParent (Accessible *obj)
325 cspi_return_val_if_fail (obj != NULL, NULL);
327 retval = cspi_object_add (
328 Accessibility_Accessible__get_parent (CSPI_OBJREF (obj),
331 cspi_return_val_if_ev ("getParent", NULL);
337 * Accessible_getChildCount:
338 * @obj: a pointer to the #Accessible object on which to operate.
340 * Get the number of children contained by an #Accessible object.
342 * Returns: a #long indicating the number of #Accessible children
343 * contained by an #Accessible object. or -1 on exception
347 Accessible_getChildCount (Accessible *obj)
351 cspi_return_val_if_fail (obj != NULL, -1);
353 retval = Accessibility_Accessible__get_childCount (CSPI_OBJREF (obj),
356 cspi_return_val_if_ev ("getChildCount", -1);
362 * Accessible_getChildAtIndex:
363 * @obj: a pointer to the #Accessible object on which to operate.
364 * @childIndex: a #long indicating which child is specified.
366 * Get the #Accessible child of an #Accessible object at a given index.
368 * Returns: a pointer to the #Accessible child object at index
369 * @childIndex. or NULL on exception
372 Accessible_getChildAtIndex (Accessible *obj,
377 cspi_return_val_if_fail (obj != NULL, NULL);
379 retval = cspi_object_add (
380 Accessibility_Accessible_getChildAtIndex (CSPI_OBJREF (obj),
381 childIndex, cspi_ev ()));
383 cspi_return_val_if_ev ("getChildAtIndex", NULL);
388 * Accessible_getIndexInParent:
389 * @obj: a pointer to the #Accessible object on which to operate.
391 * Get the index of an #Accessible object in its containing #Accessible.
393 * Returns: a #long indicating the index of the #Accessible object
394 * in its parent (i.e. containing) #Accessible instance,
395 * or -1 if @obj has no containing parent or on exception.
398 Accessible_getIndexInParent (Accessible *obj)
402 cspi_return_val_if_fail (obj != NULL, -1);
404 retval = Accessibility_Accessible_getIndexInParent (CSPI_OBJREF (obj), cspi_ev ());
406 cspi_return_val_if_ev ("getIndexInparent", -1);
411 * Accessible_getRelationSet:
412 * @obj: a pointer to the #Accessible object on which to operate.
414 * Get the set of #AccessibleRelation objects which describe this #Accessible object's
415 * relationships with other #Accessible objects.
417 * Returns: an array of #AccessibleRelation pointers. or NULL on exception
419 AccessibleRelation **
420 Accessible_getRelationSet (Accessible *obj)
424 AccessibleRelation **relations;
425 Accessibility_RelationSet *relation_set;
427 cspi_return_val_if_fail (obj != NULL, NULL);
430 Accessibility_Accessible_getRelationSet (CSPI_OBJREF (obj), cspi_ev ());
432 cspi_return_val_if_ev ("getRelationSet", NULL);
434 n_relations = relation_set->_length;
435 relations = malloc (sizeof (AccessibleRelation *) * (n_relations + 1));
437 for (i = 0; i < n_relations; ++i)
439 relations[i] = cspi_object_add (CORBA_Object_duplicate (
440 relation_set->_buffer[i], cspi_ev ()));
444 CORBA_free (relation_set);
450 * Accessible_getRole:
451 * @obj: a pointer to the #Accessible object on which to operate.
453 * Get the UI role of an #Accessible object.
454 * A UTF-8 string describing this role can be obtained via Accessible_getRoleName ().
456 * Returns: the #AccessibleRole of the object.
460 Accessible_getRole (Accessible *obj)
462 Accessibility_Role retval;
464 cspi_return_val_if_fail (obj != NULL, SPI_ROLE_INVALID);
467 Accessibility_Accessible_getRole (CSPI_OBJREF (obj), cspi_ev ());
469 cspi_return_val_if_ev ("getRole", SPI_ROLE_INVALID);
471 return cspi_role_from_spi_role (retval);
475 * Accessible_getRoleName:
476 * @obj: a pointer to the #Accessible object on which to operate.
478 * Get a UTF-8 string describing the role this object plays in the UI.
479 * This method will return useful values for roles that fall outside the
480 * enumeration used in Accessible_getRole ().
482 * Returns: a UTF-8 string specifying the role of this #Accessible object.
486 Accessible_getRoleName (Accessible *obj)
490 cspi_return_val_if_fail (obj != NULL, CORBA_string_dup ("invalid"));
493 Accessibility_Accessible_getRoleName (CSPI_OBJREF (obj), cspi_ev ());
495 cspi_return_val_if_ev ("getRoleName", CORBA_string_dup ("invalid"));
501 * Accessible_getStateSet:
502 * @obj: a pointer to the #Accessible object on which to operate.
504 * Returns: a pointer to an #AccessibleStateSet representing the object's current state.
507 Accessible_getStateSet (Accessible *obj)
509 AccessibleStateSet *retval;
510 Accessibility_StateSet corba_stateset;
511 Accessibility_StateSeq *corba_seq;
513 cspi_return_val_if_fail (obj != NULL, NULL);
515 corba_stateset = Accessibility_Accessible_getState (
516 CSPI_OBJREF (obj), cspi_ev ());
517 cspi_return_val_if_ev ("getState", NULL);
519 cspi_return_val_if_fail (corba_stateset != NULL, NULL);
520 cspi_return_val_if_fail (cspi_ping (corba_stateset), NULL);
521 corba_seq = Accessibility_StateSet_getStates (corba_stateset, cspi_ev ());
522 cspi_return_val_if_ev ("getState", NULL);
524 retval = spi_state_set_cache_new (corba_seq);
526 CORBA_free (corba_seq);
527 cspi_release_unref (corba_stateset);
532 /* Interface query methods */
535 * Accessible_isAction:
536 * @obj: a pointer to the #Accessible instance to query.
538 * Query whether the specified #Accessible implements #AccessibleAction.
540 * Returns: #TRUE if @obj implements the #AccessibleAction interface,
544 Accessible_isAction (Accessible *obj)
546 return cspi_accessible_is_a (obj,
547 "IDL:Accessibility/Action:1.0");
551 * Accessible_isApplication:
552 * @obj: a pointer to the #Accessible instance to query.
554 * Query whether the specified #Accessible implements #AccessibleApplication.
556 * Returns: #TRUE if @obj implements the #AccessibleApplication interface,
560 Accessible_isApplication (Accessible *obj)
562 return cspi_accessible_is_a (obj,
563 "IDL:Accessibility/Application:1.0");
567 * Accessible_isComponent:
568 * @obj: a pointer to the #Accessible instance to query.
570 * Query whether the specified #Accessible implements #AccessibleComponent.
572 * Returns: #TRUE if @obj implements the #AccessibleComponent interface,
576 Accessible_isComponent (Accessible *obj)
578 return cspi_accessible_is_a (obj,
579 "IDL:Accessibility/Component:1.0");
583 * Accessible_isEditableText:
584 * @obj: a pointer to the #Accessible instance to query.
586 * Query whether the specified #Accessible implements #AccessibleEditableText.
588 * Returns: #TRUE if @obj implements the #AccessibleEditableText interface,
592 Accessible_isEditableText (Accessible *obj)
594 return cspi_accessible_is_a (obj,
595 "IDL:Accessibility/EditableText:1.0");
599 * Accessible_isHypertext:
600 * @obj: a pointer to the #Accessible instance to query.
602 * Query whether the specified #Accessible implements #AccessibleHypertext.
604 * Returns: #TRUE if @obj implements the #AccessibleHypertext interface,
608 Accessible_isHypertext (Accessible *obj)
610 return cspi_accessible_is_a (obj,
611 "IDL:Accessibility/Hypertext:1.0");
615 * Accessible_isImage:
616 * @obj: a pointer to the #Accessible instance to query.
618 * Query whether the specified #Accessible implements #AccessibleImage.
620 * Returns: #TRUE if @obj implements the #AccessibleImage interface,
624 Accessible_isImage (Accessible *obj)
626 return cspi_accessible_is_a (obj,
627 "IDL:Accessibility/Image:1.0");
631 * Accessible_isSelection:
632 * @obj: a pointer to the #Accessible instance to query.
634 * Query whether the specified #Accessible implements #AccessibleSelection.
636 * Returns: #TRUE if @obj implements the #AccessibleSelection interface,
640 Accessible_isSelection (Accessible *obj)
642 return cspi_accessible_is_a (obj,
643 "IDL:Accessibility/Selection:1.0");
647 * Accessible_isTable:
648 * @obj: a pointer to the #Accessible instance to query.
650 * Query whether the specified #Accessible implements #AccessibleTable.
652 * Returns: #TRUE if @obj implements the #AccessibleTable interface,
656 Accessible_isTable (Accessible *obj)
658 return cspi_accessible_is_a (obj,
659 "IDL:Accessibility/Table:1.0");
663 * Accessible_isStreamableContent:
664 * @obj: a pointer to the #Accessible instance to query.
666 * Query whether the specified #Accessible implements
667 * #AccessibleStreamableContent.
669 * Returns: #TRUE if @obj implements the #AccessibleStreamableContent interface,
673 Accessible_isStreamableContent (Accessible *obj)
675 return cspi_accessible_is_a (obj,
676 "IDL:Accessibility/StreamableContent:1.0");
681 * @obj: a pointer to the #Accessible instance to query.
683 * Query whether the specified #Accessible implements #AccessibleText.
685 * Returns: #TRUE if @obj implements the #AccessibleText interface,
689 Accessible_isText (Accessible *obj)
691 return cspi_accessible_is_a (obj,
692 "IDL:Accessibility/Text:1.0");
696 * Accessible_isValue:
697 * @obj: a pointer to the #Accessible instance to query.
699 * Query whether the specified #Accessible implements #AccessibleValue.
701 * Returns: #TRUE if @obj implements the #AccessibleValue interface,
705 Accessible_isValue (Accessible *obj)
707 return cspi_accessible_is_a (obj,
708 "IDL:Accessibility/Value:1.0");
712 * Accessible_getApplication:
713 * @obj: a pointer to the #Accessible instance to query.
715 * Get the #AccessibleApplication interface for an #Accessible.
717 * Returns: a pointer to an #AccessibleApplication interface instance, or
718 * NULL if @obj does not implement #AccessibleApplication.
720 AccessibleApplication *
721 Accessible_getApplication (Accessible *obj)
723 return (AccessibleApplication *) Accessible_queryInterface (
724 obj, "IDL:Accessibility/Application:1.0");
728 * Accessible_getAction:
729 * @obj: a pointer to the #Accessible instance to query.
731 * Get the #AccessibleAction interface for an #Accessible.
733 * Returns: a pointer to an #AccessibleAction interface instance, or
734 * NULL if @obj does not implement #AccessibleAction.
737 Accessible_getAction (Accessible *obj)
739 return (AccessibleAction *) Accessible_queryInterface (
740 obj, "IDL:Accessibility/Action:1.0");
744 * Accessible_getComponent:
745 * @obj: a pointer to the #Accessible instance to query.
747 * Get the #AccessibleComponent interface for an #Accessible.
749 * Returns: a pointer to an #AccessibleComponent interface instance, or
750 * NULL if @obj does not implement #AccessibleComponent.
752 AccessibleComponent *
753 Accessible_getComponent (Accessible *obj)
755 return (AccessibleComponent *) Accessible_queryInterface (
756 obj, "IDL:Accessibility/Component:1.0");
760 * Accessible_getEditableText:
761 * @obj: a pointer to the #Accessible instance to query.
763 * Get the #AccessibleEditableText interface for an #Accessible.
765 * Returns: a pointer to an #AccessibleEditableText interface instance, or
766 * NULL if @obj does not implement #AccessibleEditableText.
768 AccessibleEditableText *
769 Accessible_getEditableText (Accessible *obj)
771 return (AccessibleEditableText *) Accessible_queryInterface (
772 obj, "IDL:Accessibility/EditableText:1.0");
778 * Accessible_getHypertext:
779 * @obj: a pointer to the #Accessible instance to query.
781 * Get the #AccessibleHypertext interface for an #Accessible.
783 * Returns: a pointer to an #AccessibleHypertext interface instance, or
784 * NULL if @obj does not implement #AccessibleHypertext.
786 AccessibleHypertext *
787 Accessible_getHypertext (Accessible *obj)
789 return (AccessibleHypertext *) Accessible_queryInterface (
790 obj, "IDL:Accessibility/Hypertext:1.0");
796 * Accessible_getImage:
797 * @obj: a pointer to the #Accessible instance to query.
799 * Get the #AccessibleImage interface for an #Accessible.
801 * Returns: a pointer to an #AccessibleImage interface instance, or
802 * NULL if @obj does not implement #AccessibleImage.
805 Accessible_getImage (Accessible *obj)
807 return (AccessibleImage *) Accessible_queryInterface (
808 obj, "IDL:Accessibility/Image:1.0");
814 * Accessible_getSelection:
815 * @obj: a pointer to the #Accessible instance to query.
817 * Get the #AccessibleSelection interface for an #Accessible.
819 * Returns: a pointer to an #AccessibleSelection interface instance, or
820 * NULL if @obj does not implement #AccessibleSelection.
822 AccessibleSelection *
823 Accessible_getSelection (Accessible *obj)
825 return (AccessibleSelection *) Accessible_queryInterface (
826 obj, "IDL:Accessibility/Selection:1.0");
832 * Accessible_getStreamableContent:
833 * @obj: a pointer to the #Accessible instance to query.
835 * Get the #AccessibleStreamableContent interface for an #Accessible.
837 * Returns: a pointer to an #AccessibleStreamableContent interface instance, or
838 * NULL if @obj does not implement #AccessibleStreamableContent.
840 AccessibleStreamableContent *
841 Accessible_getStreamableContent (Accessible *obj)
843 return (AccessibleStreamableContent *) Accessible_queryInterface (
844 obj, "IDL:Accessibility/StreamableContent:1.0");
848 * Accessible_getTable:
849 * @obj: a pointer to the #Accessible instance to query.
851 * Get the #AccessibleTable interface for an #Accessible.
853 * Returns: a pointer to an #AccessibleTable interface instance, or
854 * NULL if @obj does not implement #AccessibleTable.
857 Accessible_getTable (Accessible *obj)
859 return (AccessibleTable *) Accessible_queryInterface (
860 obj, "IDL:Accessibility/Table:1.0");
864 * Accessible_getText:
865 * @obj: a pointer to the #Accessible instance to query.
867 * Get the #AccessibleText interface for an #Accessible.
869 * Returns: a pointer to an #AccessibleText interface instance, or
870 * NULL if @obj does not implement #AccessibleText.
873 Accessible_getText (Accessible *obj)
875 return (AccessibleText *) Accessible_queryInterface (
876 obj, "IDL:Accessibility/Text:1.0");
882 * Accessible_getValue:
883 * @obj: a pointer to the #Accessible instance to query.
885 * Get the #AccessibleValue interface for an #Accessible.
887 * Returns: a pointer to an #AccessibleValue interface instance, or
888 * NULL if @obj does not implement #AccessibleValue.
891 Accessible_getValue (Accessible *obj)
893 return (AccessibleValue *) Accessible_queryInterface (
894 obj, "IDL:Accessibility/Value:1.0");
900 * Accessible_queryInterface:
901 * @obj: a pointer to the #Accessible instance to query.
902 * @interface_name: a UTF-8 character string specifiying the requested interface.
904 * Query an #Accessible object to for a named interface.
906 * Returns: an instance of the named interface object, if it is implemented
907 * by @obj, or NULL otherwise.
911 Accessible_queryInterface (Accessible *obj,
912 const char *interface_name)
914 Bonobo_Unknown iface;
921 iface = Accessibility_Accessible_queryInterface (CSPI_OBJREF (obj),
926 cspi_return_val_if_ev ("queryInterface", NULL);
929 * FIXME: we need to be fairly sure that references are going
930 * to mach up if we are going to expose QueryInterface, ie. we
931 * can't allow people to do:
932 * b = a.qi ("b"); b.unref, b.unref to release a's reference.
933 * this should be no real problem though for this level of API
937 return cspi_object_add (iface);
942 * AccessibleRelation_ref:
943 * @obj: a pointer to the #AccessibleRelation object on which to operate.
945 * Increment the reference count for an #AccessibleRelation object.
949 AccessibleRelation_ref (AccessibleRelation *obj)
951 cspi_object_ref (obj);
955 * AccessibleRelation_unref:
956 * @obj: a pointer to the #AccessibleRelation object on which to operate.
958 * Decrement the reference count for an #AccessibleRelation object.
962 AccessibleRelation_unref (AccessibleRelation *obj)
964 cspi_object_unref (obj);
968 cspi_init_relation_type_table (AccessibleRelationType *relation_type_table)
971 for (i = 0; i < Accessibility_RELATION_LAST_DEFINED; ++i)
973 relation_type_table [i] = SPI_RELATION_NULL;
975 relation_type_table [Accessibility_RELATION_NULL] = SPI_RELATION_NULL;
976 relation_type_table [Accessibility_RELATION_LABEL_FOR] = SPI_RELATION_LABEL_FOR;
977 relation_type_table [Accessibility_RELATION_LABELLED_BY] = SPI_RELATION_LABELED_BY;
978 relation_type_table [Accessibility_RELATION_CONTROLLER_FOR] = SPI_RELATION_CONTROLLER_FOR;
979 relation_type_table [Accessibility_RELATION_CONTROLLED_BY] = SPI_RELATION_CONTROLLED_BY;
980 relation_type_table [Accessibility_RELATION_MEMBER_OF] = SPI_RELATION_MEMBER_OF;
981 relation_type_table [Accessibility_RELATION_TOOLTIP_FOR] = SPI_RELATION_NULL;
982 relation_type_table [Accessibility_RELATION_NODE_CHILD_OF] = SPI_RELATION_NODE_CHILD_OF;
983 relation_type_table [Accessibility_RELATION_EXTENDED] = SPI_RELATION_EXTENDED;
984 relation_type_table [Accessibility_RELATION_FLOWS_TO] = SPI_RELATION_FLOWS_TO;
985 relation_type_table [Accessibility_RELATION_FLOWS_FROM] = SPI_RELATION_FLOWS_FROM;
986 relation_type_table [Accessibility_RELATION_SUBWINDOW_OF] = SPI_RELATION_SUBWINDOW_OF;
987 relation_type_table [Accessibility_RELATION_EMBEDS] = SPI_RELATION_EMBEDS;
988 relation_type_table [Accessibility_RELATION_EMBEDDED_BY] = SPI_RELATION_EMBEDDED_BY;
989 relation_type_table [Accessibility_RELATION_POPUP_FOR] = SPI_RELATION_POPUP_FOR;
990 relation_type_table [Accessibility_RELATION_LAST_DEFINED] = SPI_RELATION_LAST_DEFINED;
993 static AccessibleRelationType
994 cspi_relation_type_from_spi_relation_type (Accessibility_RelationType type)
996 /* array is sized according to IDL RelationType because IDL RelationTypes are the index */
997 static AccessibleRelationType cspi_relation_type_table [Accessibility_RELATION_LAST_DEFINED];
998 static SPIBoolean is_initialized = FALSE;
999 AccessibleRelationType cspi_type;
1000 if (!is_initialized)
1002 is_initialized = cspi_init_relation_type_table (cspi_relation_type_table);
1004 if (type >= 0 && type < Accessibility_RELATION_LAST_DEFINED)
1006 cspi_type = cspi_relation_type_table [type];
1010 cspi_type = SPI_RELATION_NULL;
1015 * AccessibleRelation_getRelationType:
1016 * @obj: a pointer to the #AccessibleRelation object to query.
1018 * Get the type of relationship represented by an #AccessibleRelation.
1020 * Returns: an #AccessibleRelationType indicating the type of relation
1021 * encapsulated in this #AccessibleRelation object.
1024 AccessibleRelationType
1025 AccessibleRelation_getRelationType (AccessibleRelation *obj)
1027 Accessibility_RelationType retval;
1029 cspi_return_val_if_fail (obj, SPI_RELATION_NULL);
1031 Accessibility_Relation_getRelationType (CSPI_OBJREF (obj), cspi_ev());
1032 cspi_return_val_if_ev ("getRelationType", SPI_RELATION_NULL);
1033 return cspi_relation_type_from_spi_relation_type (retval);
1037 * AccessibleRelation_getNTargets:
1038 * @obj: a pointer to the #AccessibleRelation object to query.
1040 * Get the number of objects which this relationship has as its
1041 * target objects (the subject is the #Accessible from which this
1042 * #AccessibleRelation originated).
1044 * Returns: a short integer indicating how many target objects which the
1045 * originating #Accessible object has the #AccessibleRelation
1046 * relationship with.
1049 AccessibleRelation_getNTargets (AccessibleRelation *obj)
1053 cspi_return_val_if_fail (obj, -1);
1054 retval = Accessibility_Relation_getNTargets (CSPI_OBJREF (obj), cspi_ev());
1055 cspi_return_val_if_ev ("getNTargets", -1);
1060 * AccessibleRelation_getTarget:
1061 * @obj: a pointer to the #AccessibleRelation object to query.
1062 * @i: a (zero-index) integer indicating which (of possibly several) target is requested.
1064 * Get the @i-th target of a specified #AccessibleRelation relationship.
1066 * Returns: an #Accessible which is the @i-th object with which the
1067 * originating #Accessible has relationship specified in the
1068 * #AccessibleRelation object.
1072 AccessibleRelation_getTarget (AccessibleRelation *obj, int i)
1076 cspi_return_val_if_fail (obj, NULL);
1078 retval = cspi_object_add (
1079 Accessibility_Relation_getTarget (CSPI_OBJREF(obj),
1081 cspi_return_val_if_ev ("getTarget", NULL);
1086 * AccessibleStateSet_ref:
1087 * @obj: a pointer to the #AccessibleStateSet object on which to operate.
1089 * Increment the reference count for an #AccessibleStateSet object.
1093 AccessibleStateSet_ref (AccessibleStateSet *obj)
1095 spi_state_set_cache_ref (obj);
1099 * AccessibleStateSet_unref:
1100 * @obj: a pointer to the #AccessibleStateSet object on which to operate.
1102 * Decrement the reference count for an #AccessibleStateSet object.
1106 AccessibleStateSet_unref (AccessibleStateSet *obj)
1108 spi_state_set_cache_unref (obj);
1111 static Accessibility_StateType
1112 spi_state_to_corba (AccessibleState state)
1114 #define MAP_STATE(a) \
1115 case SPI_STATE_##a: \
1116 return Accessibility_STATE_##a
1120 MAP_STATE (INVALID);
1124 MAP_STATE (CHECKED);
1125 MAP_STATE (DEFUNCT);
1126 MAP_STATE (EDITABLE);
1127 MAP_STATE (ENABLED);
1128 MAP_STATE (EXPANDABLE);
1129 MAP_STATE (EXPANDED);
1130 MAP_STATE (FOCUSABLE);
1131 MAP_STATE (FOCUSED);
1132 MAP_STATE (HORIZONTAL);
1133 MAP_STATE (ICONIFIED);
1135 MAP_STATE (MULTI_LINE);
1136 MAP_STATE (MULTISELECTABLE);
1138 MAP_STATE (PRESSED);
1139 MAP_STATE (RESIZABLE);
1140 MAP_STATE (SELECTABLE);
1141 MAP_STATE (SELECTED);
1142 MAP_STATE (SENSITIVE);
1143 MAP_STATE (SHOWING);
1144 MAP_STATE (SINGLE_LINE);
1146 MAP_STATE (TRANSIENT);
1147 MAP_STATE (VERTICAL);
1148 MAP_STATE (VISIBLE);
1149 MAP_STATE (MANAGES_DESCENDANTS);
1150 MAP_STATE (INDETERMINATE);
1152 return Accessibility_STATE_INVALID;
1158 * AccessibleStateSet_contains:
1159 * @obj: a pointer to the #AccessibleStateSet object on which to operate.
1160 * @state: an #AccessibleState for which the specified #AccessibleStateSet
1163 * Determine whether a given #AccessibleStateSet includes a given state; that is,
1164 * whether @state is true for the stateset in question.
1166 * Returns: #TRUE if @state is true/included in the given #AccessibleStateSet,
1171 AccessibleStateSet_contains (AccessibleStateSet *obj,
1172 AccessibleState state)
1174 return spi_state_set_cache_contains (obj, spi_state_to_corba (state));
1178 * AccessibleStateSet_add:
1179 * @obj: a pointer to the #AccessibleStateSet object on which to operate.
1180 * @state: an #AccessibleState to be added to the specified #AccessibleStateSet
1182 * Add a particular #AccessibleState to an #AccessibleStateSet (i.e. set the
1183 * given state to #TRUE in the stateset.
1187 AccessibleStateSet_add (AccessibleStateSet *obj,
1188 AccessibleState state)
1190 spi_state_set_cache_add (obj, spi_state_to_corba (state));
1194 * AccessibleStateSet_remove:
1195 * @obj: a pointer to the #AccessibleStateSet object on which to operate.
1196 * @state: an #AccessibleState to be removed from the specified #AccessibleStateSet
1198 * Remove a particular #AccessibleState to an #AccessibleStateSet (i.e. set the
1199 * given state to #FALSE in the stateset.)
1203 AccessibleStateSet_remove (AccessibleStateSet *obj,
1204 AccessibleState state)
1206 spi_state_set_cache_remove (obj, spi_state_to_corba (state));
1210 * AccessibleStateSet_equals:
1211 * @obj: a pointer to the first #AccessibleStateSet object on which to operate.
1212 * @obj2: a pointer to the second #AccessibleStateSet object on which to operate.
1214 * Determine whether two instances of #AccessibleStateSet are equivalent (i.e.
1215 * consist of the same #AccessibleStates). Useful for checking multiple
1216 * state variables at once; construct the target state then compare against it.
1218 * @see AccessibleStateSet_compare().
1220 * Returns: #TRUE if the two #AccessibleStateSets are equivalent,
1225 AccessibleStateSet_equals (AccessibleStateSet *obj,
1226 AccessibleStateSet *obj2)
1236 cmp = spi_state_set_cache_xor (obj, obj2);
1237 eq = spi_state_set_cache_is_empty (cmp);
1238 spi_state_set_cache_unref (cmp);
1244 * AccessibleStateSet_compare:
1245 * @obj: a pointer to the first #AccessibleStateSet object on which to operate.
1246 * @obj2: a pointer to the second #AccessibleStateSet object on which to operate.
1248 * Determine the differences between two instances of #AccessibleStateSet.
1249 * Not Yet Implemented.
1251 * @see AccessibleStateSet_equals().
1253 * Returns: an #AccessibleStateSet object containing all states contained on one of
1254 * the two sets but not the other.
1257 AccessibleStateSet *
1258 AccessibleStateSet_compare (AccessibleStateSet *obj,
1259 AccessibleStateSet *obj2)
1261 return spi_state_set_cache_xor (obj, obj2);
1265 * AccessibleStateSet_isEmpty:
1266 * @obj: a pointer to the #AccessibleStateSet object on which to operate.
1268 * Determine whether a given #AccessibleStateSet is the empty set.
1270 * Returns: #TRUE if the given #AccessibleStateSet contains no (true) states,
1275 AccessibleStateSet_isEmpty (AccessibleStateSet *obj)
1277 return spi_state_set_cache_is_empty (obj);