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;
191 role_table [Accessibility_ROLE_AUTOCOMPLETE] = SPI_ROLE_AUTOCOMPLETE;
192 role_table [Accessibility_ROLE_EDITBAR] = SPI_ROLE_EDITBAR;
197 static AccessibleRole
198 cspi_role_from_spi_role (Accessibility_Role role)
200 /* array is sized according to IDL roles because IDL roles are the index */
201 static AccessibleRole cspi_role_table [Accessibility_ROLE_LAST_DEFINED];
202 static SPIBoolean is_initialized = FALSE;
203 AccessibleRole cspi_role;
206 is_initialized = cspi_init_role_table (cspi_role_table);
208 if (role >= 0 && role < Accessibility_ROLE_LAST_DEFINED)
210 cspi_role = cspi_role_table [role];
214 cspi_role = SPI_ROLE_EXTENDED;
220 * AccessibleRole_getName:
221 * @role: an #AccessibleRole object to query.
223 * Get a localizeable string that indicates the name of an #AccessibleRole.
224 * <em>DEPRECATED.</em>
226 * Returns: a localizable string name for an #AccessibleRole enumerated type.
229 AccessibleRole_getName (AccessibleRole role)
231 if (role < MAX_ROLES && role_names [(int) role])
233 return CORBA_string_dup (role_names [(int) role]);
237 return CORBA_string_dup ("");
243 * @obj: a pointer to the #Accessible object on which to operate.
245 * Increment the reference count for an #Accessible object.
248 Accessible_ref (Accessible *obj)
250 cspi_object_ref (obj);
255 * @obj: a pointer to the #Accessible object on which to operate.
257 * Decrement the reference count for an #Accessible object.
260 Accessible_unref (Accessible *obj)
262 cspi_object_unref (obj);
266 * Accessible_getName:
267 * @obj: a pointer to the #Accessible object on which to operate.
269 * Get the name of an #Accessible object.
271 * Returns: a UTF-8 string indicating the name of the #Accessible object.
272 * or NULL on exception
275 Accessible_getName (Accessible *obj)
279 cspi_return_val_if_fail (obj != NULL, NULL);
281 retval = Accessibility_Accessible__get_name (CSPI_OBJREF (obj), cspi_ev ());
283 cspi_return_val_if_ev ("getName", NULL);
289 * Accessible_getDescription:
290 * @obj: a pointer to the #Accessible object on which to operate.
292 * Get the description of an #Accessible object.
294 * Returns: a UTF-8 string describing the #Accessible object.
295 * or NULL on exception
298 Accessible_getDescription (Accessible *obj)
302 cspi_return_val_if_fail (obj != NULL, NULL);
304 retval = Accessibility_Accessible__get_description (CSPI_OBJREF (obj),
307 cspi_return_val_if_ev ("getDescription", NULL);
313 * Accessible_getParent:
314 * @obj: a pointer to the #Accessible object to query.
316 * Get an #Accessible object's parent container.
318 * Returns: a pointer tothe #Accessible object which contains the given
319 * #Accessible instance, or NULL if the @obj has no parent container.
323 Accessible_getParent (Accessible *obj)
327 cspi_return_val_if_fail (obj != NULL, NULL);
329 retval = cspi_object_add (
330 Accessibility_Accessible__get_parent (CSPI_OBJREF (obj),
333 cspi_return_val_if_ev ("getParent", NULL);
339 * Accessible_getChildCount:
340 * @obj: a pointer to the #Accessible object on which to operate.
342 * Get the number of children contained by an #Accessible object.
344 * Returns: a #long indicating the number of #Accessible children
345 * contained by an #Accessible object. or -1 on exception
349 Accessible_getChildCount (Accessible *obj)
353 cspi_return_val_if_fail (obj != NULL, -1);
355 retval = Accessibility_Accessible__get_childCount (CSPI_OBJREF (obj),
358 cspi_return_val_if_ev ("getChildCount", -1);
364 * Accessible_getChildAtIndex:
365 * @obj: a pointer to the #Accessible object on which to operate.
366 * @childIndex: a #long indicating which child is specified.
368 * Get the #Accessible child of an #Accessible object at a given index.
370 * Returns: a pointer to the #Accessible child object at index
371 * @childIndex. or NULL on exception
374 Accessible_getChildAtIndex (Accessible *obj,
379 cspi_return_val_if_fail (obj != NULL, NULL);
381 retval = cspi_object_add (
382 Accessibility_Accessible_getChildAtIndex (CSPI_OBJREF (obj),
383 childIndex, cspi_ev ()));
385 cspi_return_val_if_ev ("getChildAtIndex", NULL);
390 * Accessible_getIndexInParent:
391 * @obj: a pointer to the #Accessible object on which to operate.
393 * Get the index of an #Accessible object in its containing #Accessible.
395 * Returns: a #long indicating the index of the #Accessible object
396 * in its parent (i.e. containing) #Accessible instance,
397 * or -1 if @obj has no containing parent or on exception.
400 Accessible_getIndexInParent (Accessible *obj)
404 cspi_return_val_if_fail (obj != NULL, -1);
406 retval = Accessibility_Accessible_getIndexInParent (CSPI_OBJREF (obj), cspi_ev ());
408 cspi_return_val_if_ev ("getIndexInparent", -1);
413 * Accessible_getRelationSet:
414 * @obj: a pointer to the #Accessible object on which to operate.
416 * Get the set of #AccessibleRelation objects which describe this #Accessible object's
417 * relationships with other #Accessible objects.
419 * Returns: an array of #AccessibleRelation pointers. or NULL on exception
421 AccessibleRelation **
422 Accessible_getRelationSet (Accessible *obj)
426 AccessibleRelation **relations;
427 Accessibility_RelationSet *relation_set;
429 cspi_return_val_if_fail (obj != NULL, NULL);
431 g_assert (!cspi_exception ());
434 Accessibility_Accessible_getRelationSet (CSPI_OBJREF (obj), cspi_ev ());
436 cspi_return_val_if_ev ("getRelationSet", NULL);
438 n_relations = relation_set->_length;
439 relations = malloc (sizeof (AccessibleRelation *) * (n_relations + 1));
441 for (i = 0; i < n_relations; ++i)
443 relations[i] = cspi_object_add (CORBA_Object_duplicate (
444 relation_set->_buffer[i], cspi_ev ()));
448 CORBA_free (relation_set);
454 * Accessible_getRole:
455 * @obj: a pointer to the #Accessible object on which to operate.
457 * Get the UI role of an #Accessible object.
458 * A UTF-8 string describing this role can be obtained via Accessible_getRoleName ().
460 * Returns: the #AccessibleRole of the object.
464 Accessible_getRole (Accessible *obj)
466 Accessibility_Role retval;
468 cspi_return_val_if_fail (obj != NULL, SPI_ROLE_INVALID);
471 Accessibility_Accessible_getRole (CSPI_OBJREF (obj), cspi_ev ());
473 cspi_return_val_if_ev ("getRole", SPI_ROLE_INVALID);
475 return cspi_role_from_spi_role (retval);
479 * Accessible_getRoleName:
480 * @obj: a pointer to the #Accessible object on which to operate.
482 * Get a UTF-8 string describing the role this object plays in the UI.
483 * This method will return useful values for roles that fall outside the
484 * enumeration used in Accessible_getRole ().
486 * Returns: a UTF-8 string specifying the role of this #Accessible object.
490 Accessible_getRoleName (Accessible *obj)
494 cspi_return_val_if_fail (obj != NULL, CORBA_string_dup ("invalid"));
497 Accessibility_Accessible_getRoleName (CSPI_OBJREF (obj), cspi_ev ());
499 cspi_return_val_if_ev ("getRoleName", CORBA_string_dup ("invalid"));
505 * Accessible_getLocalizedRoleName:
506 * @obj: a pointer to the #Accessible object on which to operate.
508 * Get a UTF-8 string describing the (localized) role this object plays in the UI.
509 * This method will return useful values for roles that fall outside the
510 * enumeration used in Accessible_getRole ().
512 * Returns: a UTF-8 string specifying the role of this #Accessible object.
516 Accessible_getLocalizedRoleName (Accessible *obj)
520 cspi_return_val_if_fail (obj != NULL, CORBA_string_dup ("invalid"));
523 Accessibility_Accessible_getLocalizedRoleName (CSPI_OBJREF (obj), cspi_ev ());
525 cspi_return_val_if_ev ("getLocalizedRoleName", CORBA_string_dup ("invalid"));
531 * Accessible_getStateSet:
532 * @obj: a pointer to the #Accessible object on which to operate.
534 * Returns: a pointer to an #AccessibleStateSet representing the object's current state.
537 Accessible_getStateSet (Accessible *obj)
539 AccessibleStateSet *retval;
540 Accessibility_StateSet corba_stateset;
541 Accessibility_StateSeq *corba_seq;
543 cspi_return_val_if_fail (obj != NULL, NULL);
545 corba_stateset = Accessibility_Accessible_getState (
546 CSPI_OBJREF (obj), cspi_ev ());
547 cspi_return_val_if_ev ("getState", NULL);
549 cspi_return_val_if_fail (corba_stateset != CORBA_OBJECT_NIL, NULL);
550 cspi_return_val_if_fail (cspi_ping (corba_stateset), NULL);
551 corba_seq = Accessibility_StateSet_getStates (corba_stateset, cspi_ev ());
552 cspi_return_val_if_ev ("getState", NULL);
554 retval = spi_state_set_cache_new (corba_seq);
556 CORBA_free (corba_seq);
557 cspi_release_unref (corba_stateset);
562 /* Interface query methods */
565 * Accessible_isAction:
566 * @obj: a pointer to the #Accessible instance to query.
568 * Query whether the specified #Accessible implements #AccessibleAction.
570 * Returns: #TRUE if @obj implements the #AccessibleAction interface,
574 Accessible_isAction (Accessible *obj)
576 return cspi_accessible_is_a (obj,
577 "IDL:Accessibility/Action:1.0");
581 * Accessible_isApplication:
582 * @obj: a pointer to the #Accessible instance to query.
584 * Query whether the specified #Accessible implements #AccessibleApplication.
586 * Returns: #TRUE if @obj implements the #AccessibleApplication interface,
590 Accessible_isApplication (Accessible *obj)
592 return cspi_accessible_is_a (obj,
593 "IDL:Accessibility/Application:1.0");
597 * Accessible_isComponent:
598 * @obj: a pointer to the #Accessible instance to query.
600 * Query whether the specified #Accessible implements #AccessibleComponent.
602 * Returns: #TRUE if @obj implements the #AccessibleComponent interface,
606 Accessible_isComponent (Accessible *obj)
608 return cspi_accessible_is_a (obj,
609 "IDL:Accessibility/Component:1.0");
613 * Accessible_isEditableText:
614 * @obj: a pointer to the #Accessible instance to query.
616 * Query whether the specified #Accessible implements #AccessibleEditableText.
618 * Returns: #TRUE if @obj implements the #AccessibleEditableText interface,
622 Accessible_isEditableText (Accessible *obj)
624 return cspi_accessible_is_a (obj,
625 "IDL:Accessibility/EditableText:1.0");
629 * Accessible_isHypertext:
630 * @obj: a pointer to the #Accessible instance to query.
632 * Query whether the specified #Accessible implements #AccessibleHypertext.
634 * Returns: #TRUE if @obj implements the #AccessibleHypertext interface,
638 Accessible_isHypertext (Accessible *obj)
640 return cspi_accessible_is_a (obj,
641 "IDL:Accessibility/Hypertext:1.0");
645 * Accessible_isImage:
646 * @obj: a pointer to the #Accessible instance to query.
648 * Query whether the specified #Accessible implements #AccessibleImage.
650 * Returns: #TRUE if @obj implements the #AccessibleImage interface,
654 Accessible_isImage (Accessible *obj)
656 return cspi_accessible_is_a (obj,
657 "IDL:Accessibility/Image:1.0");
661 * Accessible_isSelection:
662 * @obj: a pointer to the #Accessible instance to query.
664 * Query whether the specified #Accessible implements #AccessibleSelection.
666 * Returns: #TRUE if @obj implements the #AccessibleSelection interface,
670 Accessible_isSelection (Accessible *obj)
672 return cspi_accessible_is_a (obj,
673 "IDL:Accessibility/Selection:1.0");
677 * Accessible_isTable:
678 * @obj: a pointer to the #Accessible instance to query.
680 * Query whether the specified #Accessible implements #AccessibleTable.
682 * Returns: #TRUE if @obj implements the #AccessibleTable interface,
686 Accessible_isTable (Accessible *obj)
688 return cspi_accessible_is_a (obj,
689 "IDL:Accessibility/Table:1.0");
693 * Accessible_isStreamableContent:
694 * @obj: a pointer to the #Accessible instance to query.
696 * Query whether the specified #Accessible implements
697 * #AccessibleStreamableContent.
699 * Returns: #TRUE if @obj implements the #AccessibleStreamableContent interface,
703 Accessible_isStreamableContent (Accessible *obj)
705 return cspi_accessible_is_a (obj,
706 "IDL:Accessibility/StreamableContent:1.0");
711 * @obj: a pointer to the #Accessible instance to query.
713 * Query whether the specified #Accessible implements #AccessibleText.
715 * Returns: #TRUE if @obj implements the #AccessibleText interface,
719 Accessible_isText (Accessible *obj)
721 return cspi_accessible_is_a (obj,
722 "IDL:Accessibility/Text:1.0");
726 * Accessible_isValue:
727 * @obj: a pointer to the #Accessible instance to query.
729 * Query whether the specified #Accessible implements #AccessibleValue.
731 * Returns: #TRUE if @obj implements the #AccessibleValue interface,
735 Accessible_isValue (Accessible *obj)
737 return cspi_accessible_is_a (obj,
738 "IDL:Accessibility/Value:1.0");
742 * Accessible_getApplication:
743 * @obj: a pointer to the #Accessible instance to query.
745 * Get the #AccessibleApplication interface for an #Accessible.
747 * Returns: a pointer to an #AccessibleApplication interface instance, or
748 * NULL if @obj does not implement #AccessibleApplication.
750 AccessibleApplication *
751 Accessible_getApplication (Accessible *obj)
753 return (AccessibleApplication *) Accessible_queryInterface (
754 obj, "IDL:Accessibility/Application:1.0");
758 * Accessible_getAction:
759 * @obj: a pointer to the #Accessible instance to query.
761 * Get the #AccessibleAction interface for an #Accessible.
763 * Returns: a pointer to an #AccessibleAction interface instance, or
764 * NULL if @obj does not implement #AccessibleAction.
767 Accessible_getAction (Accessible *obj)
769 return (AccessibleAction *) Accessible_queryInterface (
770 obj, "IDL:Accessibility/Action:1.0");
774 * Accessible_getComponent:
775 * @obj: a pointer to the #Accessible instance to query.
777 * Get the #AccessibleComponent interface for an #Accessible.
779 * Returns: a pointer to an #AccessibleComponent interface instance, or
780 * NULL if @obj does not implement #AccessibleComponent.
782 AccessibleComponent *
783 Accessible_getComponent (Accessible *obj)
785 return (AccessibleComponent *) Accessible_queryInterface (
786 obj, "IDL:Accessibility/Component:1.0");
790 * Accessible_getEditableText:
791 * @obj: a pointer to the #Accessible instance to query.
793 * Get the #AccessibleEditableText interface for an #Accessible.
795 * Returns: a pointer to an #AccessibleEditableText interface instance, or
796 * NULL if @obj does not implement #AccessibleEditableText.
798 AccessibleEditableText *
799 Accessible_getEditableText (Accessible *obj)
801 return (AccessibleEditableText *) Accessible_queryInterface (
802 obj, "IDL:Accessibility/EditableText:1.0");
808 * Accessible_getHypertext:
809 * @obj: a pointer to the #Accessible instance to query.
811 * Get the #AccessibleHypertext interface for an #Accessible.
813 * Returns: a pointer to an #AccessibleHypertext interface instance, or
814 * NULL if @obj does not implement #AccessibleHypertext.
816 AccessibleHypertext *
817 Accessible_getHypertext (Accessible *obj)
819 return (AccessibleHypertext *) Accessible_queryInterface (
820 obj, "IDL:Accessibility/Hypertext:1.0");
826 * Accessible_getImage:
827 * @obj: a pointer to the #Accessible instance to query.
829 * Get the #AccessibleImage interface for an #Accessible.
831 * Returns: a pointer to an #AccessibleImage interface instance, or
832 * NULL if @obj does not implement #AccessibleImage.
835 Accessible_getImage (Accessible *obj)
837 return (AccessibleImage *) Accessible_queryInterface (
838 obj, "IDL:Accessibility/Image:1.0");
844 * Accessible_getSelection:
845 * @obj: a pointer to the #Accessible instance to query.
847 * Get the #AccessibleSelection interface for an #Accessible.
849 * Returns: a pointer to an #AccessibleSelection interface instance, or
850 * NULL if @obj does not implement #AccessibleSelection.
852 AccessibleSelection *
853 Accessible_getSelection (Accessible *obj)
855 return (AccessibleSelection *) Accessible_queryInterface (
856 obj, "IDL:Accessibility/Selection:1.0");
862 * Accessible_getStreamableContent:
863 * @obj: a pointer to the #Accessible instance to query.
865 * Get the #AccessibleStreamableContent interface for an #Accessible.
867 * Returns: a pointer to an #AccessibleStreamableContent interface instance, or
868 * NULL if @obj does not implement #AccessibleStreamableContent.
870 AccessibleStreamableContent *
871 Accessible_getStreamableContent (Accessible *obj)
873 return (AccessibleStreamableContent *) Accessible_queryInterface (
874 obj, "IDL:Accessibility/StreamableContent:1.0");
878 * Accessible_getTable:
879 * @obj: a pointer to the #Accessible instance to query.
881 * Get the #AccessibleTable interface for an #Accessible.
883 * Returns: a pointer to an #AccessibleTable interface instance, or
884 * NULL if @obj does not implement #AccessibleTable.
887 Accessible_getTable (Accessible *obj)
889 return (AccessibleTable *) Accessible_queryInterface (
890 obj, "IDL:Accessibility/Table:1.0");
894 * Accessible_getText:
895 * @obj: a pointer to the #Accessible instance to query.
897 * Get the #AccessibleText interface for an #Accessible.
899 * Returns: a pointer to an #AccessibleText interface instance, or
900 * NULL if @obj does not implement #AccessibleText.
903 Accessible_getText (Accessible *obj)
905 return (AccessibleText *) Accessible_queryInterface (
906 obj, "IDL:Accessibility/Text:1.0");
912 * Accessible_getValue:
913 * @obj: a pointer to the #Accessible instance to query.
915 * Get the #AccessibleValue interface for an #Accessible.
917 * Returns: a pointer to an #AccessibleValue interface instance, or
918 * NULL if @obj does not implement #AccessibleValue.
921 Accessible_getValue (Accessible *obj)
923 return (AccessibleValue *) Accessible_queryInterface (
924 obj, "IDL:Accessibility/Value:1.0");
930 * Accessible_queryInterface:
931 * @obj: a pointer to the #Accessible instance to query.
932 * @interface_name: a UTF-8 character string specifiying the requested interface.
934 * Query an #Accessible object to for a named interface.
936 * Returns: an instance of the named interface object, if it is implemented
937 * by @obj, or NULL otherwise.
941 Accessible_queryInterface (Accessible *obj,
942 const char *interface_name)
944 Bonobo_Unknown iface;
951 iface = Accessibility_Accessible_queryInterface (CSPI_OBJREF (obj),
956 cspi_return_val_if_ev ("queryInterface", NULL);
959 * FIXME: we need to be fairly sure that references are going
960 * to mach up if we are going to expose QueryInterface, ie. we
961 * can't allow people to do:
962 * b = a.qi ("b"); b.unref, b.unref to release a's reference.
963 * this should be no real problem though for this level of API
967 return cspi_object_add (iface);
972 * AccessibleRelation_ref:
973 * @obj: a pointer to the #AccessibleRelation object on which to operate.
975 * Increment the reference count for an #AccessibleRelation object.
979 AccessibleRelation_ref (AccessibleRelation *obj)
981 cspi_object_ref (obj);
985 * AccessibleRelation_unref:
986 * @obj: a pointer to the #AccessibleRelation object on which to operate.
988 * Decrement the reference count for an #AccessibleRelation object.
992 AccessibleRelation_unref (AccessibleRelation *obj)
994 cspi_object_unref (obj);
998 cspi_init_relation_type_table (AccessibleRelationType *relation_type_table)
1001 for (i = 0; i < Accessibility_RELATION_LAST_DEFINED; ++i)
1003 relation_type_table [i] = SPI_RELATION_NULL;
1005 relation_type_table [Accessibility_RELATION_NULL] = SPI_RELATION_NULL;
1006 relation_type_table [Accessibility_RELATION_LABEL_FOR] = SPI_RELATION_LABEL_FOR;
1007 relation_type_table [Accessibility_RELATION_LABELLED_BY] = SPI_RELATION_LABELED_BY;
1008 relation_type_table [Accessibility_RELATION_CONTROLLER_FOR] = SPI_RELATION_CONTROLLER_FOR;
1009 relation_type_table [Accessibility_RELATION_CONTROLLED_BY] = SPI_RELATION_CONTROLLED_BY;
1010 relation_type_table [Accessibility_RELATION_MEMBER_OF] = SPI_RELATION_MEMBER_OF;
1011 relation_type_table [Accessibility_RELATION_TOOLTIP_FOR] = SPI_RELATION_NULL;
1012 relation_type_table [Accessibility_RELATION_NODE_CHILD_OF] = SPI_RELATION_NODE_CHILD_OF;
1013 relation_type_table [Accessibility_RELATION_EXTENDED] = SPI_RELATION_EXTENDED;
1014 relation_type_table [Accessibility_RELATION_FLOWS_TO] = SPI_RELATION_FLOWS_TO;
1015 relation_type_table [Accessibility_RELATION_FLOWS_FROM] = SPI_RELATION_FLOWS_FROM;
1016 relation_type_table [Accessibility_RELATION_SUBWINDOW_OF] = SPI_RELATION_SUBWINDOW_OF;
1017 relation_type_table [Accessibility_RELATION_EMBEDS] = SPI_RELATION_EMBEDS;
1018 relation_type_table [Accessibility_RELATION_EMBEDDED_BY] = SPI_RELATION_EMBEDDED_BY;
1019 relation_type_table [Accessibility_RELATION_POPUP_FOR] = SPI_RELATION_POPUP_FOR;
1023 static AccessibleRelationType
1024 cspi_relation_type_from_spi_relation_type (Accessibility_RelationType type)
1026 /* array is sized according to IDL RelationType because IDL RelationTypes are the index */
1027 static AccessibleRelationType cspi_relation_type_table [Accessibility_RELATION_LAST_DEFINED];
1028 static SPIBoolean is_initialized = FALSE;
1029 AccessibleRelationType cspi_type;
1030 if (!is_initialized)
1032 is_initialized = cspi_init_relation_type_table (cspi_relation_type_table);
1034 if (type >= 0 && type < Accessibility_RELATION_LAST_DEFINED)
1036 cspi_type = cspi_relation_type_table [type];
1040 cspi_type = SPI_RELATION_NULL;
1045 * AccessibleRelation_getRelationType:
1046 * @obj: a pointer to the #AccessibleRelation object to query.
1048 * Get the type of relationship represented by an #AccessibleRelation.
1050 * Returns: an #AccessibleRelationType indicating the type of relation
1051 * encapsulated in this #AccessibleRelation object.
1054 AccessibleRelationType
1055 AccessibleRelation_getRelationType (AccessibleRelation *obj)
1057 Accessibility_RelationType retval;
1059 cspi_return_val_if_fail (obj, SPI_RELATION_NULL);
1061 Accessibility_Relation_getRelationType (CSPI_OBJREF (obj), cspi_ev());
1062 cspi_return_val_if_ev ("getRelationType", SPI_RELATION_NULL);
1063 return cspi_relation_type_from_spi_relation_type (retval);
1067 * AccessibleRelation_getNTargets:
1068 * @obj: a pointer to the #AccessibleRelation object to query.
1070 * Get the number of objects which this relationship has as its
1071 * target objects (the subject is the #Accessible from which this
1072 * #AccessibleRelation originated).
1074 * Returns: a short integer indicating how many target objects which the
1075 * originating #Accessible object has the #AccessibleRelation
1076 * relationship with.
1079 AccessibleRelation_getNTargets (AccessibleRelation *obj)
1083 cspi_return_val_if_fail (obj, -1);
1084 retval = Accessibility_Relation_getNTargets (CSPI_OBJREF (obj), cspi_ev());
1085 cspi_return_val_if_ev ("getNTargets", -1);
1090 * AccessibleRelation_getTarget:
1091 * @obj: a pointer to the #AccessibleRelation object to query.
1092 * @i: a (zero-index) integer indicating which (of possibly several) target is requested.
1094 * Get the @i-th target of a specified #AccessibleRelation relationship.
1096 * Returns: an #Accessible which is the @i-th object with which the
1097 * originating #Accessible has relationship specified in the
1098 * #AccessibleRelation object.
1102 AccessibleRelation_getTarget (AccessibleRelation *obj, int i)
1106 cspi_return_val_if_fail (obj, NULL);
1108 retval = cspi_object_add (
1109 Accessibility_Relation_getTarget (CSPI_OBJREF(obj),
1111 cspi_return_val_if_ev ("getTarget", NULL);
1116 * AccessibleStateSet_ref:
1117 * @obj: a pointer to the #AccessibleStateSet object on which to operate.
1119 * Increment the reference count for an #AccessibleStateSet object.
1123 AccessibleStateSet_ref (AccessibleStateSet *obj)
1125 spi_state_set_cache_ref (obj);
1129 * AccessibleStateSet_unref:
1130 * @obj: a pointer to the #AccessibleStateSet object on which to operate.
1132 * Decrement the reference count for an #AccessibleStateSet object.
1136 AccessibleStateSet_unref (AccessibleStateSet *obj)
1138 spi_state_set_cache_unref (obj);
1141 static Accessibility_StateType
1142 spi_state_to_corba (AccessibleState state)
1144 #define MAP_STATE(a) \
1145 case SPI_STATE_##a: \
1146 return Accessibility_STATE_##a
1150 MAP_STATE (INVALID);
1154 MAP_STATE (CHECKED);
1155 MAP_STATE (DEFUNCT);
1156 MAP_STATE (EDITABLE);
1157 MAP_STATE (ENABLED);
1158 MAP_STATE (EXPANDABLE);
1159 MAP_STATE (EXPANDED);
1160 MAP_STATE (FOCUSABLE);
1161 MAP_STATE (FOCUSED);
1162 MAP_STATE (HORIZONTAL);
1163 MAP_STATE (ICONIFIED);
1165 MAP_STATE (MULTI_LINE);
1166 MAP_STATE (MULTISELECTABLE);
1168 MAP_STATE (PRESSED);
1169 MAP_STATE (RESIZABLE);
1170 MAP_STATE (SELECTABLE);
1171 MAP_STATE (SELECTED);
1172 MAP_STATE (SENSITIVE);
1173 MAP_STATE (SHOWING);
1174 MAP_STATE (SINGLE_LINE);
1176 MAP_STATE (TRANSIENT);
1177 MAP_STATE (VERTICAL);
1178 MAP_STATE (VISIBLE);
1179 MAP_STATE (MANAGES_DESCENDANTS);
1180 MAP_STATE (INDETERMINATE);
1182 return Accessibility_STATE_INVALID;
1188 * AccessibleStateSet_contains:
1189 * @obj: a pointer to the #AccessibleStateSet object on which to operate.
1190 * @state: an #AccessibleState for which the specified #AccessibleStateSet
1193 * Determine whether a given #AccessibleStateSet includes a given state; that is,
1194 * whether @state is true for the stateset in question.
1196 * Returns: #TRUE if @state is true/included in the given #AccessibleStateSet,
1201 AccessibleStateSet_contains (AccessibleStateSet *obj,
1202 AccessibleState state)
1204 return spi_state_set_cache_contains (obj, spi_state_to_corba (state));
1208 * AccessibleStateSet_add:
1209 * @obj: a pointer to the #AccessibleStateSet object on which to operate.
1210 * @state: an #AccessibleState to be added to the specified #AccessibleStateSet
1212 * Add a particular #AccessibleState to an #AccessibleStateSet (i.e. set the
1213 * given state to #TRUE in the stateset.
1217 AccessibleStateSet_add (AccessibleStateSet *obj,
1218 AccessibleState state)
1220 spi_state_set_cache_add (obj, spi_state_to_corba (state));
1224 * AccessibleStateSet_remove:
1225 * @obj: a pointer to the #AccessibleStateSet object on which to operate.
1226 * @state: an #AccessibleState to be removed from the specified #AccessibleStateSet
1228 * Remove a particular #AccessibleState to an #AccessibleStateSet (i.e. set the
1229 * given state to #FALSE in the stateset.)
1233 AccessibleStateSet_remove (AccessibleStateSet *obj,
1234 AccessibleState state)
1236 spi_state_set_cache_remove (obj, spi_state_to_corba (state));
1240 * AccessibleStateSet_equals:
1241 * @obj: a pointer to the first #AccessibleStateSet object on which to operate.
1242 * @obj2: a pointer to the second #AccessibleStateSet object on which to operate.
1244 * Determine whether two instances of #AccessibleStateSet are equivalent (i.e.
1245 * consist of the same #AccessibleStates). Useful for checking multiple
1246 * state variables at once; construct the target state then compare against it.
1248 * @see AccessibleStateSet_compare().
1250 * Returns: #TRUE if the two #AccessibleStateSets are equivalent,
1255 AccessibleStateSet_equals (AccessibleStateSet *obj,
1256 AccessibleStateSet *obj2)
1266 cmp = spi_state_set_cache_xor (obj, obj2);
1267 eq = spi_state_set_cache_is_empty (cmp);
1268 spi_state_set_cache_unref (cmp);
1274 * AccessibleStateSet_compare:
1275 * @obj: a pointer to the first #AccessibleStateSet object on which to operate.
1276 * @obj2: a pointer to the second #AccessibleStateSet object on which to operate.
1278 * Determine the differences between two instances of #AccessibleStateSet.
1279 * Not Yet Implemented.
1281 * @see AccessibleStateSet_equals().
1283 * Returns: an #AccessibleStateSet object containing all states contained on one of
1284 * the two sets but not the other.
1287 AccessibleStateSet *
1288 AccessibleStateSet_compare (AccessibleStateSet *obj,
1289 AccessibleStateSet *obj2)
1291 return spi_state_set_cache_xor (obj, obj2);
1295 * AccessibleStateSet_isEmpty:
1296 * @obj: a pointer to the #AccessibleStateSet object on which to operate.
1298 * Determine whether a given #AccessibleStateSet is the empty set.
1300 * Returns: #TRUE if the given #AccessibleStateSet contains no (true) states,
1305 AccessibleStateSet_isEmpty (AccessibleStateSet *obj)
1307 return spi_state_set_cache_is_empty (obj);