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",
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 Accessibility_AttributeSet *seq)
248 AccessibleAttributeSet *set = g_new0 (AccessibleAttributeSet, 1);
251 set->len = seq->_length;
252 set->attributes = g_newa (char *, set->len);
253 for (i = 0; i < set->len; ++i)
255 set->attributes[i] = g_strdup (seq->_buffer [i]);
261 * AccessibleRole_getName:
262 * @role: an #AccessibleRole object to query.
264 * Get a localizeable string that indicates the name of an #AccessibleRole.
265 * <em>DEPRECATED.</em>
267 * Returns: a localizable string name for an #AccessibleRole enumerated type.
270 AccessibleRole_getName (AccessibleRole role)
272 if (role < MAX_ROLES && role_names [(int) role])
274 return CORBA_string_dup (role_names [(int) role]);
278 return CORBA_string_dup ("");
284 * @obj: a pointer to the #Accessible object on which to operate.
286 * Increment the reference count for an #Accessible object.
289 Accessible_ref (Accessible *obj)
291 cspi_object_ref (obj);
296 * @obj: a pointer to the #Accessible object on which to operate.
298 * Decrement the reference count for an #Accessible object.
301 Accessible_unref (Accessible *obj)
303 cspi_object_unref (obj);
307 * Accessible_getName:
308 * @obj: a pointer to the #Accessible object on which to operate.
310 * Get the name of an #Accessible object.
312 * Returns: a UTF-8 string indicating the name of the #Accessible object.
313 * or NULL on exception
316 Accessible_getName (Accessible *obj)
320 cspi_return_val_if_fail (obj != NULL, NULL);
322 retval = Accessibility_Accessible__get_name (CSPI_OBJREF (obj), cspi_ev ());
324 cspi_return_val_if_ev ("getName", NULL);
330 * Accessible_getDescription:
331 * @obj: a pointer to the #Accessible object on which to operate.
333 * Get the description of an #Accessible object.
335 * Returns: a UTF-8 string describing the #Accessible object.
336 * or NULL on exception
339 Accessible_getDescription (Accessible *obj)
343 cspi_return_val_if_fail (obj != NULL, NULL);
345 retval = Accessibility_Accessible__get_description (CSPI_OBJREF (obj),
348 cspi_return_val_if_ev ("getDescription", NULL);
354 * Accessible_getParent:
355 * @obj: a pointer to the #Accessible object to query.
357 * Get an #Accessible object's parent container.
359 * Returns: a pointer tothe #Accessible object which contains the given
360 * #Accessible instance, or NULL if the @obj has no parent container.
364 Accessible_getParent (Accessible *obj)
368 cspi_return_val_if_fail (obj != NULL, NULL);
370 retval = cspi_object_add (
371 Accessibility_Accessible__get_parent (CSPI_OBJREF (obj),
374 cspi_return_val_if_ev ("getParent", NULL);
380 * Accessible_getChildCount:
381 * @obj: a pointer to the #Accessible object on which to operate.
383 * Get the number of children contained by an #Accessible object.
385 * Returns: a #long indicating the number of #Accessible children
386 * contained by an #Accessible object. or -1 on exception
390 Accessible_getChildCount (Accessible *obj)
394 cspi_return_val_if_fail (obj != NULL, -1);
396 retval = Accessibility_Accessible__get_childCount (CSPI_OBJREF (obj),
399 cspi_return_val_if_ev ("getChildCount", -1);
405 * Accessible_getChildAtIndex:
406 * @obj: a pointer to the #Accessible object on which to operate.
407 * @childIndex: a #long indicating which child is specified.
409 * Get the #Accessible child of an #Accessible object at a given index.
411 * Returns: a pointer to the #Accessible child object at index
412 * @childIndex. or NULL on exception
415 Accessible_getChildAtIndex (Accessible *obj,
420 cspi_return_val_if_fail (obj != NULL, NULL);
422 retval = cspi_object_add (
423 Accessibility_Accessible_getChildAtIndex (CSPI_OBJREF (obj),
424 childIndex, cspi_ev ()));
426 cspi_return_val_if_ev ("getChildAtIndex", NULL);
431 * Accessible_getIndexInParent:
432 * @obj: a pointer to the #Accessible object on which to operate.
434 * Get the index of an #Accessible object in its containing #Accessible.
436 * Returns: a #long indicating the index of the #Accessible object
437 * in its parent (i.e. containing) #Accessible instance,
438 * or -1 if @obj has no containing parent or on exception.
441 Accessible_getIndexInParent (Accessible *obj)
445 cspi_return_val_if_fail (obj != NULL, -1);
447 retval = Accessibility_Accessible_getIndexInParent (CSPI_OBJREF (obj), cspi_ev ());
449 cspi_return_val_if_ev ("getIndexInparent", -1);
454 * Accessible_getRelationSet:
455 * @obj: a pointer to the #Accessible object on which to operate.
457 * Get the set of #AccessibleRelation objects which describe this #Accessible object's
458 * relationships with other #Accessible objects.
460 * Returns: an array of #AccessibleRelation pointers. or NULL on exception
462 AccessibleRelation **
463 Accessible_getRelationSet (Accessible *obj)
467 AccessibleRelation **relations;
468 Accessibility_RelationSet *relation_set;
470 cspi_return_val_if_fail (obj != NULL, NULL);
472 g_assert (!cspi_exception ());
475 Accessibility_Accessible_getRelationSet (CSPI_OBJREF (obj), cspi_ev ());
477 cspi_return_val_if_ev ("getRelationSet", NULL);
479 n_relations = relation_set->_length;
480 relations = malloc (sizeof (AccessibleRelation *) * (n_relations + 1));
482 for (i = 0; i < n_relations; ++i)
484 relations[i] = cspi_object_add (CORBA_Object_duplicate (
485 relation_set->_buffer[i], cspi_ev ()));
489 CORBA_free (relation_set);
495 * Accessible_getRole:
496 * @obj: a pointer to the #Accessible object on which to operate.
498 * Get the UI role of an #Accessible object.
499 * A UTF-8 string describing this role can be obtained via Accessible_getRoleName ().
501 * Returns: the #AccessibleRole of the object.
505 Accessible_getRole (Accessible *obj)
507 Accessibility_Role retval;
509 cspi_return_val_if_fail (obj != NULL, SPI_ROLE_INVALID);
512 Accessibility_Accessible_getRole (CSPI_OBJREF (obj), cspi_ev ());
514 cspi_return_val_if_ev ("getRole", SPI_ROLE_INVALID);
516 return cspi_role_from_spi_role (retval);
520 * Accessible_getRoleName:
521 * @obj: a pointer to the #Accessible object on which to operate.
523 * Get a UTF-8 string describing the role this object plays in the UI.
524 * This method will return useful values for roles that fall outside the
525 * enumeration used in Accessible_getRole ().
527 * Returns: a UTF-8 string specifying the role of this #Accessible object.
531 Accessible_getRoleName (Accessible *obj)
535 cspi_return_val_if_fail (obj != NULL, CORBA_string_dup ("invalid"));
538 Accessibility_Accessible_getRoleName (CSPI_OBJREF (obj), cspi_ev ());
540 cspi_return_val_if_ev ("getRoleName", CORBA_string_dup ("invalid"));
546 * Accessible_getLocalizedRoleName:
547 * @obj: a pointer to the #Accessible object on which to operate.
549 * Get a UTF-8 string describing the (localized) role this object plays in the UI.
550 * This method will return useful values for roles that fall outside the
551 * enumeration used in Accessible_getRole ().
555 * Returns: a UTF-8 string specifying the role of this #Accessible object.
559 Accessible_getLocalizedRoleName (Accessible *obj)
563 cspi_return_val_if_fail (obj != NULL, CORBA_string_dup ("invalid"));
566 Accessibility_Accessible_getLocalizedRoleName (CSPI_OBJREF (obj), cspi_ev ());
568 cspi_return_val_if_ev ("getLocalizedRoleName", CORBA_string_dup ("invalid"));
574 * Accessible_getStateSet:
575 * @obj: a pointer to the #Accessible object on which to operate.
577 * Gets the current state of an object.
579 * Returns: a pointer to an #AccessibleStateSet representing the object's current state.
582 Accessible_getStateSet (Accessible *obj)
584 AccessibleStateSet *retval;
585 Accessibility_StateSet corba_stateset;
586 Accessibility_StateSeq *corba_seq;
588 cspi_return_val_if_fail (obj != NULL, NULL);
590 corba_stateset = Accessibility_Accessible_getState (
591 CSPI_OBJREF (obj), cspi_ev ());
592 cspi_return_val_if_ev ("getState", NULL);
594 cspi_return_val_if_fail (corba_stateset != CORBA_OBJECT_NIL, NULL);
595 cspi_return_val_if_fail (cspi_ping (corba_stateset), NULL);
596 corba_seq = Accessibility_StateSet_getStates (corba_stateset, cspi_ev ());
597 cspi_return_val_if_ev ("getState", NULL);
599 retval = spi_state_set_cache_new (corba_seq);
601 CORBA_free (corba_seq);
602 cspi_release_unref (corba_stateset);
608 * Accessible_getAttributes:
609 * @obj: The #Accessible being queried.
611 * Get the #AttributeSet representing any assigned
612 * name-value pair attributes or annotations for this object.
613 * For typographic, textual, or textually-semantic attributes, see
614 * AccessibleText_getAttributes instead.
616 * Returns: The name-value-pair attributes assigned to this object.
618 AccessibleAttributeSet *
619 Accessible_getAttributes (Accessible *obj)
621 AccessibleAttributeSet *retval;
622 Accessibility_AttributeSet *corba_seq;
624 cspi_return_val_if_fail (obj != NULL, NULL);
626 corba_seq = Accessibility_Accessible_getAttributes (
627 CSPI_OBJREF (obj), cspi_ev ());
628 cspi_return_val_if_ev ("getAttributes", NULL);
630 retval = _cspi_attribute_set_from_sequence (corba_seq);
631 CORBA_free (corba_seq);
637 * Accessible_getHostApplication:
638 * @obj: The #Accessible being queried.
640 * Get the containing #AccessibleApplication for an object.
642 * Returns: the containing AccessibleApplication instance for this object.
644 AccessibleApplication *
645 Accessible_getHostApplication (Accessible *obj)
647 AccessibleApplication *retval;
649 cspi_return_val_if_fail (obj != NULL, NULL);
651 retval = Accessible_getApplication (cspi_object_add (
652 Accessibility_Accessible_getApplication (CSPI_OBJREF (obj),
654 cspi_return_val_if_ev ("getApplication", NULL);
659 /* Interface query methods */
662 * Accessible_isAction:
663 * @obj: a pointer to the #Accessible instance to query.
665 * Query whether the specified #Accessible implements #AccessibleAction.
667 * Returns: #TRUE if @obj implements the #AccessibleAction interface,
671 Accessible_isAction (Accessible *obj)
673 return cspi_accessible_is_a (obj,
674 "IDL:Accessibility/Action:1.0");
678 * Accessible_isApplication:
679 * @obj: a pointer to the #Accessible instance to query.
681 * Query whether the specified #Accessible implements #AccessibleApplication.
683 * Returns: #TRUE if @obj implements the #AccessibleApplication interface,
687 Accessible_isApplication (Accessible *obj)
689 return cspi_accessible_is_a (obj,
690 "IDL:Accessibility/Application:1.0");
694 * Accessible_isComponent:
695 * @obj: a pointer to the #Accessible instance to query.
697 * Query whether the specified #Accessible implements #AccessibleComponent.
699 * Returns: #TRUE if @obj implements the #AccessibleComponent interface,
703 Accessible_isComponent (Accessible *obj)
705 return cspi_accessible_is_a (obj,
706 "IDL:Accessibility/Component:1.0");
710 * Accessible_isDocument:
711 * @obj: a pointer to the #Accessible instance to query.
713 * Query whether the specified #Accessible implements #AccessibleDocument.
715 * Returns: #TRUE if @obj implements the #AccessibleDocument interface,
719 Accessible_isDocument (Accessible *obj)
721 return cspi_accessible_is_a (obj,
722 "IDL:Accessibility/Document:1.0");
726 * Accessible_isEditableText:
727 * @obj: a pointer to the #Accessible instance to query.
729 * Query whether the specified #Accessible implements #AccessibleEditableText.
731 * Returns: #TRUE if @obj implements the #AccessibleEditableText interface,
735 Accessible_isEditableText (Accessible *obj)
737 return cspi_accessible_is_a (obj,
738 "IDL:Accessibility/EditableText:1.0");
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 "IDL:Accessibility/Hypertext:1.0");
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 "IDL:Accessibility/Image:1.0");
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 "IDL:Accessibility/Selection:1.0");
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 "IDL:Accessibility/Table:1.0");
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)
818 return cspi_accessible_is_a (obj,
819 "IDL:Accessibility/StreamableContent:1.0");
824 * @obj: a pointer to the #Accessible instance to query.
826 * Query whether the specified #Accessible implements #AccessibleText.
828 * Returns: #TRUE if @obj implements the #AccessibleText interface,
832 Accessible_isText (Accessible *obj)
834 return cspi_accessible_is_a (obj,
835 "IDL:Accessibility/Text:1.0");
839 * Accessible_isValue:
840 * @obj: a pointer to the #Accessible instance to query.
842 * Query whether the specified #Accessible implements #AccessibleValue.
844 * Returns: #TRUE if @obj implements the #AccessibleValue interface,
848 Accessible_isValue (Accessible *obj)
850 return cspi_accessible_is_a (obj,
851 "IDL:Accessibility/Value:1.0");
855 * Accessible_getApplication:
856 * @obj: a pointer to the #Accessible instance to query.
858 * Get the #AccessibleApplication interface for an #Accessible.
860 * Returns: a pointer to an #AccessibleApplication interface instance, or
861 * NULL if @obj does not implement #AccessibleApplication.
863 AccessibleApplication *
864 Accessible_getApplication (Accessible *obj)
866 return (AccessibleApplication *) Accessible_queryInterface (
867 obj, "IDL:Accessibility/Application:1.0");
871 * Accessible_getAction:
872 * @obj: a pointer to the #Accessible instance to query.
874 * Get the #AccessibleAction interface for an #Accessible.
876 * Returns: a pointer to an #AccessibleAction interface instance, or
877 * NULL if @obj does not implement #AccessibleAction.
880 Accessible_getAction (Accessible *obj)
882 return (AccessibleAction *) Accessible_queryInterface (
883 obj, "IDL:Accessibility/Action:1.0");
887 * Accessible_getComponent:
888 * @obj: a pointer to the #Accessible instance to query.
890 * Get the #AccessibleComponent interface for an #Accessible.
892 * Returns: a pointer to an #AccessibleComponent interface instance, or
893 * NULL if @obj does not implement #AccessibleComponent.
895 AccessibleComponent *
896 Accessible_getComponent (Accessible *obj)
898 return (AccessibleComponent *) Accessible_queryInterface (
899 obj, "IDL:Accessibility/Component:1.0");
902 * Accessible_getDocument:
903 * @obj: a pointer to the #Accessible instance to query.
905 * Get the #AccessibleDocument interface for an #Accessible.
907 * Returns: a pointer to an #AccessibleDocument interface instance, or
908 * NULL if @obj does not implement #AccessibleDocument.
911 Accessible_getDocument (Accessible *obj)
913 return (AccessibleDocument *) Accessible_queryInterface (
914 obj, "IDL:Accessibility/Document:1.0");
918 * Accessible_getEditableText:
919 * @obj: a pointer to the #Accessible instance to query.
921 * Get the #AccessibleEditableText interface for an #Accessible.
923 * Returns: a pointer to an #AccessibleEditableText interface instance, or
924 * NULL if @obj does not implement #AccessibleEditableText.
926 AccessibleEditableText *
927 Accessible_getEditableText (Accessible *obj)
929 return (AccessibleEditableText *) Accessible_queryInterface (
930 obj, "IDL:Accessibility/EditableText:1.0");
936 * Accessible_getHypertext:
937 * @obj: a pointer to the #Accessible instance to query.
939 * Get the #AccessibleHypertext interface for an #Accessible.
941 * Returns: a pointer to an #AccessibleHypertext interface instance, or
942 * NULL if @obj does not implement #AccessibleHypertext.
944 AccessibleHypertext *
945 Accessible_getHypertext (Accessible *obj)
947 return (AccessibleHypertext *) Accessible_queryInterface (
948 obj, "IDL:Accessibility/Hypertext:1.0");
954 * Accessible_getImage:
955 * @obj: a pointer to the #Accessible instance to query.
957 * Get the #AccessibleImage interface for an #Accessible.
959 * Returns: a pointer to an #AccessibleImage interface instance, or
960 * NULL if @obj does not implement #AccessibleImage.
963 Accessible_getImage (Accessible *obj)
965 return (AccessibleImage *) Accessible_queryInterface (
966 obj, "IDL:Accessibility/Image:1.0");
972 * Accessible_getSelection:
973 * @obj: a pointer to the #Accessible instance to query.
975 * Get the #AccessibleSelection interface for an #Accessible.
977 * Returns: a pointer to an #AccessibleSelection interface instance, or
978 * NULL if @obj does not implement #AccessibleSelection.
980 AccessibleSelection *
981 Accessible_getSelection (Accessible *obj)
983 return (AccessibleSelection *) Accessible_queryInterface (
984 obj, "IDL:Accessibility/Selection:1.0");
990 * Accessible_getStreamableContent:
991 * @obj: a pointer to the #Accessible instance to query.
993 * Get the #AccessibleStreamableContent interface for an #Accessible.
995 * Returns: a pointer to an #AccessibleStreamableContent interface instance, or
996 * NULL if @obj does not implement #AccessibleStreamableContent.
998 AccessibleStreamableContent *
999 Accessible_getStreamableContent (Accessible *obj)
1001 return (AccessibleStreamableContent *) Accessible_queryInterface (
1002 obj, "IDL:Accessibility/StreamableContent:1.0");
1006 * Accessible_getTable:
1007 * @obj: a pointer to the #Accessible instance to query.
1009 * Get the #AccessibleTable interface for an #Accessible.
1011 * Returns: a pointer to an #AccessibleTable interface instance, or
1012 * NULL if @obj does not implement #AccessibleTable.
1015 Accessible_getTable (Accessible *obj)
1017 return (AccessibleTable *) Accessible_queryInterface (
1018 obj, "IDL:Accessibility/Table:1.0");
1022 * Accessible_getText:
1023 * @obj: a pointer to the #Accessible instance to query.
1025 * Get the #AccessibleText interface for an #Accessible.
1027 * Returns: a pointer to an #AccessibleText interface instance, or
1028 * NULL if @obj does not implement #AccessibleText.
1031 Accessible_getText (Accessible *obj)
1033 return (AccessibleText *) Accessible_queryInterface (
1034 obj, "IDL:Accessibility/Text:1.0");
1040 * Accessible_getValue:
1041 * @obj: a pointer to the #Accessible instance to query.
1043 * Get the #AccessibleValue interface for an #Accessible.
1045 * Returns: a pointer to an #AccessibleValue interface instance, or
1046 * NULL if @obj does not implement #AccessibleValue.
1049 Accessible_getValue (Accessible *obj)
1051 return (AccessibleValue *) Accessible_queryInterface (
1052 obj, "IDL:Accessibility/Value:1.0");
1058 * Accessible_queryInterface:
1059 * @obj: a pointer to the #Accessible instance to query.
1060 * @interface_name: a UTF-8 character string specifiying the requested interface.
1062 * Query an #Accessible object to for a named interface.
1064 * Returns: an instance of the named interface object, if it is implemented
1065 * by @obj, or NULL otherwise.
1069 Accessible_queryInterface (Accessible *obj,
1070 const char *interface_name)
1072 Bonobo_Unknown iface;
1079 iface = Accessibility_Accessible_queryInterface (CSPI_OBJREF (obj),
1084 cspi_return_val_if_ev ("queryInterface", NULL);
1087 * FIXME: we need to be fairly sure that references are going
1088 * to mach up if we are going to expose QueryInterface, ie. we
1089 * can't allow people to do:
1090 * b = a.qi ("b"); b.unref, b.unref to release a's reference.
1091 * this should be no real problem though for this level of API
1095 return cspi_object_add (iface);
1100 * AccessibleRelation_ref:
1101 * @obj: a pointer to the #AccessibleRelation object on which to operate.
1103 * Increment the reference count for an #AccessibleRelation object.
1107 AccessibleRelation_ref (AccessibleRelation *obj)
1109 cspi_object_ref (obj);
1113 * AccessibleRelation_unref:
1114 * @obj: a pointer to the #AccessibleRelation object on which to operate.
1116 * Decrement the reference count for an #AccessibleRelation object.
1120 AccessibleRelation_unref (AccessibleRelation *obj)
1122 cspi_object_unref (obj);
1126 cspi_init_relation_type_table (AccessibleRelationType *relation_type_table)
1129 for (i = 0; i < Accessibility_RELATION_LAST_DEFINED; ++i)
1131 relation_type_table [i] = SPI_RELATION_NULL;
1133 relation_type_table [Accessibility_RELATION_NULL] = SPI_RELATION_NULL;
1134 relation_type_table [Accessibility_RELATION_LABEL_FOR] = SPI_RELATION_LABEL_FOR;
1135 relation_type_table [Accessibility_RELATION_LABELLED_BY] = SPI_RELATION_LABELED_BY;
1136 relation_type_table [Accessibility_RELATION_CONTROLLER_FOR] = SPI_RELATION_CONTROLLER_FOR;
1137 relation_type_table [Accessibility_RELATION_CONTROLLED_BY] = SPI_RELATION_CONTROLLED_BY;
1138 relation_type_table [Accessibility_RELATION_MEMBER_OF] = SPI_RELATION_MEMBER_OF;
1139 relation_type_table [Accessibility_RELATION_TOOLTIP_FOR] = SPI_RELATION_NULL;
1140 relation_type_table [Accessibility_RELATION_NODE_CHILD_OF] = SPI_RELATION_NODE_CHILD_OF;
1141 relation_type_table [Accessibility_RELATION_EXTENDED] = SPI_RELATION_EXTENDED;
1142 relation_type_table [Accessibility_RELATION_FLOWS_TO] = SPI_RELATION_FLOWS_TO;
1143 relation_type_table [Accessibility_RELATION_FLOWS_FROM] = SPI_RELATION_FLOWS_FROM;
1144 relation_type_table [Accessibility_RELATION_SUBWINDOW_OF] = SPI_RELATION_SUBWINDOW_OF;
1145 relation_type_table [Accessibility_RELATION_EMBEDS] = SPI_RELATION_EMBEDS;
1146 relation_type_table [Accessibility_RELATION_EMBEDDED_BY] = SPI_RELATION_EMBEDDED_BY;
1147 relation_type_table [Accessibility_RELATION_POPUP_FOR] = SPI_RELATION_POPUP_FOR;
1148 relation_type_table [Accessibility_RELATION_PARENT_WINDOW_OF] = SPI_RELATION_PARENT_WINDOW_OF;
1149 relation_type_table [Accessibility_RELATION_DESCRIBED_BY] = SPI_RELATION_DESCRIBED_BY;
1150 relation_type_table [Accessibility_RELATION_DESCRIPTION_FOR] = SPI_RELATION_DESCRIPTION_FOR;
1154 static AccessibleRelationType
1155 cspi_relation_type_from_spi_relation_type (Accessibility_RelationType type)
1157 /* array is sized according to IDL RelationType because IDL RelationTypes are the index */
1158 static AccessibleRelationType cspi_relation_type_table [Accessibility_RELATION_LAST_DEFINED];
1159 static SPIBoolean is_initialized = FALSE;
1160 AccessibleRelationType cspi_type;
1161 if (!is_initialized)
1163 is_initialized = cspi_init_relation_type_table (cspi_relation_type_table);
1165 if (type >= 0 && type < Accessibility_RELATION_LAST_DEFINED)
1167 cspi_type = cspi_relation_type_table [type];
1171 cspi_type = SPI_RELATION_NULL;
1176 * AccessibleRelation_getRelationType:
1177 * @obj: a pointer to the #AccessibleRelation object to query.
1179 * Get the type of relationship represented by an #AccessibleRelation.
1181 * Returns: an #AccessibleRelationType indicating the type of relation
1182 * encapsulated in this #AccessibleRelation object.
1185 AccessibleRelationType
1186 AccessibleRelation_getRelationType (AccessibleRelation *obj)
1188 Accessibility_RelationType retval;
1190 cspi_return_val_if_fail (obj, SPI_RELATION_NULL);
1192 Accessibility_Relation_getRelationType (CSPI_OBJREF (obj), cspi_ev());
1193 cspi_return_val_if_ev ("getRelationType", SPI_RELATION_NULL);
1194 return cspi_relation_type_from_spi_relation_type (retval);
1198 * AccessibleRelation_getNTargets:
1199 * @obj: a pointer to the #AccessibleRelation object to query.
1201 * Get the number of objects which this relationship has as its
1202 * target objects (the subject is the #Accessible from which this
1203 * #AccessibleRelation originated).
1205 * Returns: a short integer indicating how many target objects which the
1206 * originating #Accessible object has the #AccessibleRelation
1207 * relationship with.
1210 AccessibleRelation_getNTargets (AccessibleRelation *obj)
1214 cspi_return_val_if_fail (obj, -1);
1215 retval = Accessibility_Relation_getNTargets (CSPI_OBJREF (obj), cspi_ev());
1216 cspi_return_val_if_ev ("getNTargets", -1);
1221 * AccessibleRelation_getTarget:
1222 * @obj: a pointer to the #AccessibleRelation object to query.
1223 * @i: a (zero-index) integer indicating which (of possibly several) target is requested.
1225 * Get the @i-th target of a specified #AccessibleRelation relationship.
1227 * Returns: an #Accessible which is the @i-th object with which the
1228 * originating #Accessible has relationship specified in the
1229 * #AccessibleRelation object.
1233 AccessibleRelation_getTarget (AccessibleRelation *obj, int i)
1237 cspi_return_val_if_fail (obj, NULL);
1239 retval = cspi_object_add (
1240 Accessibility_Relation_getTarget (CSPI_OBJREF(obj),
1242 cspi_return_val_if_ev ("getTarget", NULL);
1247 * AccessibleStateSet_ref:
1248 * @obj: a pointer to the #AccessibleStateSet object on which to operate.
1250 * Increment the reference count for an #AccessibleStateSet object.
1254 AccessibleStateSet_ref (AccessibleStateSet *obj)
1256 spi_state_set_cache_ref (obj);
1260 * AccessibleStateSet_unref:
1261 * @obj: a pointer to the #AccessibleStateSet object on which to operate.
1263 * Decrement the reference count for an #AccessibleStateSet object.
1267 AccessibleStateSet_unref (AccessibleStateSet *obj)
1269 spi_state_set_cache_unref (obj);
1272 static Accessibility_StateType
1273 spi_state_to_corba (AccessibleState state)
1275 #define MAP_STATE(a) \
1276 case SPI_STATE_##a: \
1277 return Accessibility_STATE_##a
1281 MAP_STATE (INVALID);
1285 MAP_STATE (CHECKED);
1286 MAP_STATE (DEFUNCT);
1287 MAP_STATE (EDITABLE);
1288 MAP_STATE (ENABLED);
1289 MAP_STATE (EXPANDABLE);
1290 MAP_STATE (EXPANDED);
1291 MAP_STATE (FOCUSABLE);
1292 MAP_STATE (FOCUSED);
1293 MAP_STATE (HORIZONTAL);
1294 MAP_STATE (ICONIFIED);
1296 MAP_STATE (MULTI_LINE);
1297 MAP_STATE (MULTISELECTABLE);
1299 MAP_STATE (PRESSED);
1300 MAP_STATE (RESIZABLE);
1301 MAP_STATE (SELECTABLE);
1302 MAP_STATE (SELECTED);
1303 MAP_STATE (SENSITIVE);
1304 MAP_STATE (SHOWING);
1305 MAP_STATE (SINGLE_LINE);
1307 MAP_STATE (TRANSIENT);
1308 MAP_STATE (VERTICAL);
1309 MAP_STATE (VISIBLE);
1310 MAP_STATE (MANAGES_DESCENDANTS);
1311 MAP_STATE (INDETERMINATE);
1312 MAP_STATE (TRUNCATED);
1313 MAP_STATE (REQUIRED);
1314 MAP_STATE (INVALID_ENTRY);
1315 MAP_STATE (SUPPORTS_AUTOCOMPLETION);
1316 MAP_STATE (SELECTABLE_TEXT);
1317 MAP_STATE (IS_DEFAULT);
1318 MAP_STATE (VISITED);
1320 return Accessibility_STATE_INVALID;
1326 * AccessibleStateSet_contains:
1327 * @obj: a pointer to the #AccessibleStateSet object on which to operate.
1328 * @state: an #AccessibleState for which the specified #AccessibleStateSet
1331 * Determine whether a given #AccessibleStateSet includes a given state; that is,
1332 * whether @state is true for the stateset in question.
1334 * Returns: #TRUE if @state is true/included in the given #AccessibleStateSet,
1339 AccessibleStateSet_contains (AccessibleStateSet *obj,
1340 AccessibleState state)
1342 return spi_state_set_cache_contains (obj, spi_state_to_corba (state));
1346 * AccessibleStateSet_add:
1347 * @obj: a pointer to the #AccessibleStateSet object on which to operate.
1348 * @state: an #AccessibleState to be added to the specified #AccessibleStateSet
1350 * Add a particular #AccessibleState to an #AccessibleStateSet (i.e. set the
1351 * given state to #TRUE in the stateset.
1355 AccessibleStateSet_add (AccessibleStateSet *obj,
1356 AccessibleState state)
1358 spi_state_set_cache_add (obj, spi_state_to_corba (state));
1362 * AccessibleStateSet_remove:
1363 * @obj: a pointer to the #AccessibleStateSet object on which to operate.
1364 * @state: an #AccessibleState to be removed from the specified #AccessibleStateSet
1366 * Remove a particular #AccessibleState to an #AccessibleStateSet (i.e. set the
1367 * given state to #FALSE in the stateset.)
1371 AccessibleStateSet_remove (AccessibleStateSet *obj,
1372 AccessibleState state)
1374 spi_state_set_cache_remove (obj, spi_state_to_corba (state));
1378 * AccessibleStateSet_equals:
1379 * @obj: a pointer to the first #AccessibleStateSet object on which to operate.
1380 * @obj2: a pointer to the second #AccessibleStateSet object on which to operate.
1382 * Determine whether two instances of #AccessibleStateSet are equivalent (i.e.
1383 * consist of the same #AccessibleStates). Useful for checking multiple
1384 * state variables at once; construct the target state then compare against it.
1386 * @see AccessibleStateSet_compare().
1388 * Returns: #TRUE if the two #AccessibleStateSets are equivalent,
1393 AccessibleStateSet_equals (AccessibleStateSet *obj,
1394 AccessibleStateSet *obj2)
1404 cmp = spi_state_set_cache_xor (obj, obj2);
1405 eq = spi_state_set_cache_is_empty (cmp);
1406 spi_state_set_cache_unref (cmp);
1412 * AccessibleStateSet_compare:
1413 * @obj: a pointer to the first #AccessibleStateSet object on which to operate.
1414 * @obj2: a pointer to the second #AccessibleStateSet object on which to operate.
1416 * Determine the differences between two instances of #AccessibleStateSet.
1417 * Not Yet Implemented.
1419 * @see AccessibleStateSet_equals().
1421 * Returns: an #AccessibleStateSet object containing all states contained on one of
1422 * the two sets but not the other.
1425 AccessibleStateSet *
1426 AccessibleStateSet_compare (AccessibleStateSet *obj,
1427 AccessibleStateSet *obj2)
1429 return spi_state_set_cache_xor (obj, obj2);
1433 * AccessibleStateSet_isEmpty:
1434 * @obj: a pointer to the #AccessibleStateSet object on which to operate.
1436 * Determine whether a given #AccessibleStateSet is the empty set.
1438 * Returns: #TRUE if the given #AccessibleStateSet contains no (true) states,
1443 AccessibleStateSet_isEmpty (AccessibleStateSet *obj)
1445 return spi_state_set_cache_is_empty (obj);