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 <cspi/spi-private.h>
27 static const char *role_names [] =
85 "table-column-header",
101 #define MAX_ROLES (sizeof (role_names) / sizeof (char *))
104 cspi_init_role_table (AccessibleRole *role_table)
107 for (i = 0; i < Accessibility_ROLE_LAST_DEFINED; ++i)
109 role_table [i] = SPI_ROLE_UNKNOWN;
111 role_table [Accessibility_ROLE_INVALID] = SPI_ROLE_INVALID;
112 role_table [Accessibility_ROLE_ACCELERATOR_LABEL] = SPI_ROLE_ACCEL_LABEL;
113 role_table [Accessibility_ROLE_ALERT] = SPI_ROLE_ALERT;
114 role_table [Accessibility_ROLE_ANIMATION] = SPI_ROLE_ANIMATION;
115 role_table [Accessibility_ROLE_ARROW] = SPI_ROLE_ARROW;
116 role_table [Accessibility_ROLE_CALENDAR] = SPI_ROLE_CALENDAR;
117 role_table [Accessibility_ROLE_CANVAS] = SPI_ROLE_CANVAS;
118 role_table [Accessibility_ROLE_CHECK_BOX] = SPI_ROLE_CHECK_BOX;
119 role_table [Accessibility_ROLE_CHECK_MENU_ITEM] = SPI_ROLE_CHECK_MENU_ITEM;
120 role_table [Accessibility_ROLE_COLOR_CHOOSER] = SPI_ROLE_COLOR_CHOOSER;
121 role_table [Accessibility_ROLE_COLUMN_HEADER] = SPI_ROLE_COLUMN_HEADER;
122 role_table [Accessibility_ROLE_COMBO_BOX] = SPI_ROLE_COMBO_BOX;
123 role_table [Accessibility_ROLE_DATE_EDITOR] = SPI_ROLE_DATE_EDITOR;
124 role_table [Accessibility_ROLE_DESKTOP_ICON] = SPI_ROLE_DESKTOP_ICON;
125 role_table [Accessibility_ROLE_DESKTOP_FRAME] = SPI_ROLE_DESKTOP_FRAME;
126 role_table [Accessibility_ROLE_DIAL] = SPI_ROLE_DIAL;
127 role_table [Accessibility_ROLE_DIALOG] = SPI_ROLE_DIALOG;
128 role_table [Accessibility_ROLE_DIRECTORY_PANE] = SPI_ROLE_DIRECTORY_PANE;
129 role_table [Accessibility_ROLE_DRAWING_AREA] = SPI_ROLE_DRAWING_AREA;
130 role_table [Accessibility_ROLE_FILE_CHOOSER] = SPI_ROLE_FILE_CHOOSER;
131 role_table [Accessibility_ROLE_FILLER] = SPI_ROLE_FILLER;
132 role_table [Accessibility_ROLE_FONT_CHOOSER] = SPI_ROLE_FONT_CHOOSER;
133 role_table [Accessibility_ROLE_FRAME] = SPI_ROLE_FRAME;
134 role_table [Accessibility_ROLE_GLASS_PANE] = SPI_ROLE_GLASS_PANE;
135 role_table [Accessibility_ROLE_HTML_CONTAINER] = SPI_ROLE_HTML_CONTAINER;
136 role_table [Accessibility_ROLE_ICON] = SPI_ROLE_ICON;
137 role_table [Accessibility_ROLE_IMAGE] = SPI_ROLE_IMAGE;
138 role_table [Accessibility_ROLE_INTERNAL_FRAME] = SPI_ROLE_INTERNAL_FRAME;
139 role_table [Accessibility_ROLE_LABEL] = SPI_ROLE_LABEL;
140 role_table [Accessibility_ROLE_LAYERED_PANE] = SPI_ROLE_LAYERED_PANE;
141 role_table [Accessibility_ROLE_LIST] = SPI_ROLE_LIST;
142 role_table [Accessibility_ROLE_LIST_ITEM] = SPI_ROLE_LIST_ITEM;
143 role_table [Accessibility_ROLE_MENU] = SPI_ROLE_MENU;
144 role_table [Accessibility_ROLE_MENU_BAR] = SPI_ROLE_MENU_BAR;
145 role_table [Accessibility_ROLE_MENU_ITEM] = SPI_ROLE_MENU_ITEM;
146 role_table [Accessibility_ROLE_OPTION_PANE] = SPI_ROLE_OPTION_PANE;
147 role_table [Accessibility_ROLE_PAGE_TAB] = SPI_ROLE_PAGE_TAB;
148 role_table [Accessibility_ROLE_PAGE_TAB_LIST] = SPI_ROLE_PAGE_TAB_LIST;
149 role_table [Accessibility_ROLE_PANEL] = SPI_ROLE_PANEL;
150 role_table [Accessibility_ROLE_PASSWORD_TEXT] = SPI_ROLE_PASSWORD_TEXT;
151 role_table [Accessibility_ROLE_POPUP_MENU] = SPI_ROLE_POPUP_MENU;
152 role_table [Accessibility_ROLE_PROGRESS_BAR] = SPI_ROLE_PROGRESS_BAR;
153 role_table [Accessibility_ROLE_PUSH_BUTTON] = SPI_ROLE_PUSH_BUTTON;
154 role_table [Accessibility_ROLE_RADIO_BUTTON] = SPI_ROLE_RADIO_BUTTON;
155 role_table [Accessibility_ROLE_RADIO_MENU_ITEM] = SPI_ROLE_RADIO_MENU_ITEM;
156 role_table [Accessibility_ROLE_ROOT_PANE] = SPI_ROLE_ROOT_PANE;
157 role_table [Accessibility_ROLE_ROW_HEADER] = SPI_ROLE_ROW_HEADER;
158 role_table [Accessibility_ROLE_SCROLL_BAR] = SPI_ROLE_SCROLL_BAR;
159 role_table [Accessibility_ROLE_SCROLL_PANE] = SPI_ROLE_SCROLL_PANE;
160 role_table [Accessibility_ROLE_SEPARATOR] = SPI_ROLE_SEPARATOR;
161 role_table [Accessibility_ROLE_SLIDER] = SPI_ROLE_SLIDER;
162 role_table [Accessibility_ROLE_SPIN_BUTTON] = SPI_ROLE_SPIN_BUTTON;
163 role_table [Accessibility_ROLE_SPLIT_PANE] = SPI_ROLE_SPLIT_PANE;
164 role_table [Accessibility_ROLE_STATUS_BAR] = SPI_ROLE_STATUS_BAR;
165 role_table [Accessibility_ROLE_TABLE] = SPI_ROLE_TABLE;
166 role_table [Accessibility_ROLE_TABLE_CELL] = SPI_ROLE_TABLE_CELL;
167 role_table[Accessibility_ROLE_TABLE_COLUMN_HEADER] = SPI_ROLE_TABLE_COLUMN_HEADER;
168 role_table[Accessibility_ROLE_TABLE_ROW_HEADER] = SPI_ROLE_TABLE_ROW_HEADER;
169 role_table [Accessibility_ROLE_TEAROFF_MENU_ITEM] = SPI_ROLE_TEAROFF_MENU_ITEM;
170 role_table[Accessibility_ROLE_TERMINAL] = SPI_ROLE_TERMINAL;
171 role_table [Accessibility_ROLE_TEXT] = SPI_ROLE_TEXT;
172 role_table [Accessibility_ROLE_TOGGLE_BUTTON] = SPI_ROLE_TOGGLE_BUTTON;
173 role_table [Accessibility_ROLE_TOOL_BAR] = SPI_ROLE_TOOL_BAR;
174 role_table [Accessibility_ROLE_TOOL_TIP] = SPI_ROLE_TOOL_TIP;
175 role_table [Accessibility_ROLE_TREE] = SPI_ROLE_TREE;
176 role_table [Accessibility_ROLE_TREE_TABLE] = SPI_ROLE_TREE_TABLE;
177 role_table [Accessibility_ROLE_VIEWPORT] = SPI_ROLE_VIEWPORT;
178 role_table [Accessibility_ROLE_WINDOW] = SPI_ROLE_WINDOW;
179 role_table [Accessibility_ROLE_EXTENDED] = SPI_ROLE_EXTENDED;
180 role_table [Accessibility_ROLE_HEADER] = SPI_ROLE_HEADER;
181 role_table [Accessibility_ROLE_FOOTER] = SPI_ROLE_FOOTER;
182 role_table [Accessibility_ROLE_PARAGRAPH] = SPI_ROLE_PARAGRAPH;
183 role_table [Accessibility_ROLE_RULER] = SPI_ROLE_RULER;
188 static AccessibleRole
189 cspi_role_from_spi_role (Accessibility_Role role)
191 /* array is sized according to IDL roles because IDL roles are the index */
192 static AccessibleRole cspi_role_table [Accessibility_ROLE_LAST_DEFINED];
193 static SPIBoolean is_initialized = FALSE;
194 AccessibleRole cspi_role;
197 is_initialized = cspi_init_role_table (cspi_role_table);
199 if (role >= 0 && role < Accessibility_ROLE_LAST_DEFINED)
201 cspi_role = cspi_role_table [role];
205 cspi_role = SPI_ROLE_EXTENDED;
211 init_state_table (Accessibility_StateType *state_table)
215 for (i = 0; i < Accessibility_STATE_LAST_DEFINED; i++)
216 state_table[i] = SPI_STATE_INVALID;
218 state_table[SPI_STATE_ACTIVE] = Accessibility_STATE_ACTIVE;
219 state_table[SPI_STATE_ARMED] = Accessibility_STATE_ARMED;
220 state_table[SPI_STATE_BUSY] = Accessibility_STATE_BUSY;
221 state_table[SPI_STATE_CHECKED] = Accessibility_STATE_CHECKED;
222 state_table[SPI_STATE_DEFUNCT] = Accessibility_STATE_DEFUNCT;
223 state_table[SPI_STATE_EDITABLE] = Accessibility_STATE_EDITABLE;
224 state_table[SPI_STATE_ENABLED] = Accessibility_STATE_ENABLED;
225 state_table[SPI_STATE_EXPANDABLE] = Accessibility_STATE_EXPANDABLE;
226 state_table[SPI_STATE_EXPANDED] = Accessibility_STATE_EXPANDED;
227 state_table[SPI_STATE_FOCUSABLE] = Accessibility_STATE_FOCUSABLE;
228 state_table[SPI_STATE_FOCUSED] = Accessibility_STATE_FOCUSED;
229 state_table[SPI_STATE_HORIZONTAL] = Accessibility_STATE_HORIZONTAL;
230 state_table[SPI_STATE_ICONIFIED] = Accessibility_STATE_ICONIFIED;
231 state_table[SPI_STATE_MODAL] = Accessibility_STATE_MODAL;
232 state_table[SPI_STATE_MULTI_LINE] = Accessibility_STATE_MULTI_LINE;
233 state_table[SPI_STATE_MULTISELECTABLE] = Accessibility_STATE_MULTISELECTABLE;
234 state_table[SPI_STATE_OPAQUE] = Accessibility_STATE_OPAQUE;
235 state_table[SPI_STATE_PRESSED] = Accessibility_STATE_PRESSED;
236 state_table[SPI_STATE_RESIZABLE] = Accessibility_STATE_RESIZABLE;
237 state_table[SPI_STATE_SELECTABLE] = Accessibility_STATE_SELECTABLE;
238 state_table[SPI_STATE_SELECTED] = Accessibility_STATE_SELECTED;
239 state_table[SPI_STATE_SENSITIVE] = Accessibility_STATE_SENSITIVE;
240 state_table[SPI_STATE_SHOWING] = Accessibility_STATE_SHOWING;
241 state_table[SPI_STATE_SINGLE_LINE] = Accessibility_STATE_SINGLE_LINE;
242 state_table[SPI_STATE_STALE] = Accessibility_STATE_STALE;
243 state_table[SPI_STATE_TRANSIENT] = Accessibility_STATE_TRANSIENT;
244 state_table[SPI_STATE_VERTICAL] = Accessibility_STATE_VERTICAL;
245 state_table[SPI_STATE_VISIBLE] = Accessibility_STATE_VISIBLE;
246 state_table[SPI_STATE_MANAGES_DESCENDANTS] = Accessibility_STATE_MANAGES_DESCENDANTS;
253 static Accessibility_StateType
254 spi_state_type_from_accessible_state (AccessibleState type)
256 static Accessibility_StateType state_table[Accessibility_STATE_LAST_DEFINED];
257 static SPIBoolean table_initialized = FALSE;
258 Accessibility_StateType rv;
260 if (!table_initialized)
261 table_initialized = init_state_table (state_table);
262 if (type > SPI_STATE_INVALID && type < SPI_STATE_LAST_DEFINED)
263 rv = state_table[type];
265 rv = Accessibility_STATE_INVALID;
273 * AccessibleRole_getName:
274 * @role: an #AccessibleRole object to query.
276 * Get a localizeable string that indicates the name of an #AccessibleRole.
277 * <em>DEPRECATED.</em>
279 * Returns: a localizable string name for an #AccessibleRole enumerated type.
282 AccessibleRole_getName (AccessibleRole role)
284 if (role < MAX_ROLES)
286 return CORBA_string_dup (role_names [(int) role]);
290 return g_strdup ("");
296 * @obj: a pointer to the #Accessible object on which to operate.
298 * Increment the reference count for an #Accessible object.
301 Accessible_ref (Accessible *obj)
303 cspi_object_ref (obj);
308 * @obj: a pointer to the #Accessible object on which to operate.
310 * Decrement the reference count for an #Accessible object.
313 Accessible_unref (Accessible *obj)
315 cspi_object_unref (obj);
319 * Accessible_getName:
320 * @obj: a pointer to the #Accessible object on which to operate.
322 * Get the name of an #Accessible object.
324 * Returns: a UTF-8 string indicating the name of the #Accessible object.
325 * or NULL on exception
328 Accessible_getName (Accessible *obj)
332 cspi_return_val_if_fail (obj != NULL, NULL);
334 retval = Accessibility_Accessible__get_name (CSPI_OBJREF (obj), cspi_ev ());
336 cspi_return_val_if_ev ("getName", NULL);
342 * Accessible_getDescription:
343 * @obj: a pointer to the #Accessible object on which to operate.
345 * Get the description of an #Accessible object.
347 * Returns: a UTF-8 string describing the #Accessible object.
348 * or NULL on exception
351 Accessible_getDescription (Accessible *obj)
355 cspi_return_val_if_fail (obj != NULL, NULL);
357 retval = Accessibility_Accessible__get_description (CSPI_OBJREF (obj),
360 cspi_return_val_if_ev ("getDescription", NULL);
366 * Accessible_getParent:
367 * @obj: a pointer to the #Accessible object to query.
369 * Get an #Accessible object's parent container.
371 * Returns: a pointer tothe #Accessible object which contains the given
372 * #Accessible instance, or NULL if the @obj has no parent container.
376 Accessible_getParent (Accessible *obj)
380 cspi_return_val_if_fail (obj != NULL, NULL);
382 retval = cspi_object_add (
383 Accessibility_Accessible__get_parent (CSPI_OBJREF (obj),
386 cspi_return_val_if_ev ("getParent", NULL);
392 * Accessible_getChildCount:
393 * @obj: a pointer to the #Accessible object on which to operate.
395 * Get the number of children contained by an #Accessible object.
397 * Returns: a #long indicating the number of #Accessible children
398 * contained by an #Accessible object. or -1 on exception
402 Accessible_getChildCount (Accessible *obj)
406 cspi_return_val_if_fail (obj != NULL, -1);
408 retval = Accessibility_Accessible__get_childCount (CSPI_OBJREF (obj),
411 cspi_return_val_if_ev ("getChildCount", -1);
417 * Accessible_getChildAtIndex:
418 * @obj: a pointer to the #Accessible object on which to operate.
419 * @childIndex: a #long indicating which child is specified.
421 * Get the #Accessible child of an #Accessible object at a given index.
423 * Returns: a pointer to the #Accessible child object at index
424 * @childIndex. or NULL on exception
427 Accessible_getChildAtIndex (Accessible *obj,
432 cspi_return_val_if_fail (obj != NULL, NULL);
434 retval = cspi_object_add (
435 Accessibility_Accessible_getChildAtIndex (CSPI_OBJREF (obj),
436 childIndex, cspi_ev ()));
438 cspi_return_val_if_ev ("getChildAtIndex", NULL);
443 * Accessible_getIndexInParent:
444 * @obj: a pointer to the #Accessible object on which to operate.
446 * Get the index of an #Accessible object in its containing #Accessible.
448 * Returns: a #long indicating the index of the #Accessible object
449 * in its parent (i.e. containing) #Accessible instance,
450 * or -1 if @obj has no containing parent or on exception.
453 Accessible_getIndexInParent (Accessible *obj)
457 cspi_return_val_if_fail (obj != NULL, -1);
459 retval = Accessibility_Accessible_getIndexInParent (CSPI_OBJREF (obj), cspi_ev ());
461 cspi_return_val_if_ev ("getIndexInparent", -1);
466 * Accessible_getRelationSet:
467 * @obj: a pointer to the #Accessible object on which to operate.
469 * Get the set of #AccessibleRelation objects which describe this #Accessible object's
470 * relationships with other #Accessible objects.
472 * Returns: an array of #AccessibleRelation pointers. or NULL on exception
474 AccessibleRelation **
475 Accessible_getRelationSet (Accessible *obj)
479 AccessibleRelation **relations;
480 Accessibility_RelationSet *relation_set;
482 cspi_return_val_if_fail (obj != NULL, NULL);
485 Accessibility_Accessible_getRelationSet (CSPI_OBJREF (obj), cspi_ev ());
487 cspi_return_val_if_ev ("getRelationSet", NULL);
489 n_relations = relation_set->_length;
490 relations = malloc (sizeof (AccessibleRelation *) * (n_relations + 1));
492 for (i = 0; i < n_relations; ++i)
494 relations[i] = cspi_object_add (CORBA_Object_duplicate (
495 relation_set->_buffer[i], cspi_ev ()));
499 CORBA_free (relation_set);
505 * Accessible_getRole:
506 * @obj: a pointer to the #Accessible object on which to operate.
508 * Get the UI role of an #Accessible object.
509 * A UTF-8 string describing this role can be obtained via Accessible_getRoleName ().
511 * Returns: the #AccessibleRole of the object.
515 Accessible_getRole (Accessible *obj)
517 Accessibility_Role retval;
519 cspi_return_val_if_fail (obj != NULL, SPI_ROLE_INVALID);
522 Accessibility_Accessible_getRole (CSPI_OBJREF (obj), cspi_ev ());
524 cspi_return_val_if_ev ("getRole", SPI_ROLE_INVALID);
526 return cspi_role_from_spi_role (retval);
530 * Accessible_getRoleName:
531 * @obj: a pointer to the #Accessible object on which to operate.
533 * Get a UTF-8 string describing the role this object plays in the UI.
534 * This method will return useful values for roles that fall outside the
535 * enumeration used in Accessible_getRole ().
537 * Returns: a UTF-8 string specifying the role of this #Accessible object.
541 Accessible_getRoleName (Accessible *obj)
545 cspi_return_val_if_fail (obj != NULL, CORBA_string_dup ("invalid"));
548 Accessibility_Accessible_getRoleName (CSPI_OBJREF (obj), cspi_ev ());
550 cspi_return_val_if_ev ("getRoleName", CORBA_string_dup ("invalid"));
556 * Accessible_getStateSet:
557 * @obj: a pointer to the #Accessible object on which to operate.
559 * Not Yet Implemented.
561 * Returns: a pointer to an #AccessibleStateSet representing the object's current state.
564 Accessible_getStateSet (Accessible *obj)
566 AccessibleStateSet *retval;
568 cspi_return_val_if_fail (obj != NULL, NULL);
570 retval = cspi_object_add (
571 Accessibility_Accessible_getState (CSPI_OBJREF (obj),
574 cspi_return_val_if_ev ("getState", NULL);
578 /* Interface query methods */
581 * Accessible_isAction:
582 * @obj: a pointer to the #Accessible instance to query.
584 * Query whether the specified #Accessible implements #AccessibleAction.
586 * Returns: #TRUE if @obj implements the #AccessibleAction interface,
590 Accessible_isAction (Accessible *obj)
592 return cspi_accessible_is_a (obj,
593 "IDL:Accessibility/Action:1.0");
597 * Accessible_isApplication:
598 * @obj: a pointer to the #Accessible instance to query.
600 * Query whether the specified #Accessible implements #AccessibleApplication.
602 * Returns: #TRUE if @obj implements the #AccessibleApplication interface,
606 Accessible_isApplication (Accessible *obj)
608 return cspi_accessible_is_a (obj,
609 "IDL:Accessibility/Application:1.0");
613 * Accessible_isComponent:
614 * @obj: a pointer to the #Accessible instance to query.
616 * Query whether the specified #Accessible implements #AccessibleComponent.
618 * Returns: #TRUE if @obj implements the #AccessibleComponent interface,
622 Accessible_isComponent (Accessible *obj)
624 return cspi_accessible_is_a (obj,
625 "IDL:Accessibility/Component:1.0");
629 * Accessible_isEditableText:
630 * @obj: a pointer to the #Accessible instance to query.
632 * Query whether the specified #Accessible implements #AccessibleEditableText.
634 * Returns: #TRUE if @obj implements the #AccessibleEditableText interface,
638 Accessible_isEditableText (Accessible *obj)
640 return cspi_accessible_is_a (obj,
641 "IDL:Accessibility/EditableText:1.0");
645 * Accessible_isHypertext:
646 * @obj: a pointer to the #Accessible instance to query.
648 * Query whether the specified #Accessible implements #AccessibleHypertext.
650 * Returns: #TRUE if @obj implements the #AccessibleHypertext interface,
654 Accessible_isHypertext (Accessible *obj)
656 return cspi_accessible_is_a (obj,
657 "IDL:Accessibility/Hypertext:1.0");
661 * Accessible_isImage:
662 * @obj: a pointer to the #Accessible instance to query.
664 * Query whether the specified #Accessible implements #AccessibleImage.
666 * Returns: #TRUE if @obj implements the #AccessibleImage interface,
670 Accessible_isImage (Accessible *obj)
672 return cspi_accessible_is_a (obj,
673 "IDL:Accessibility/Image:1.0");
677 * Accessible_isSelection:
678 * @obj: a pointer to the #Accessible instance to query.
680 * Query whether the specified #Accessible implements #AccessibleSelection.
682 * Returns: #TRUE if @obj implements the #AccessibleSelection interface,
686 Accessible_isSelection (Accessible *obj)
688 return cspi_accessible_is_a (obj,
689 "IDL:Accessibility/Selection:1.0");
693 * Accessible_isTable:
694 * @obj: a pointer to the #Accessible instance to query.
696 * Query whether the specified #Accessible implements #AccessibleTable.
698 * Returns: #TRUE if @obj implements the #AccessibleTable interface,
702 Accessible_isTable (Accessible *obj)
704 return cspi_accessible_is_a (obj,
705 "IDL:Accessibility/Table:1.0");
709 * Accessible_isStreamableContent:
710 * @obj: a pointer to the #Accessible instance to query.
712 * Query whether the specified #Accessible implements
713 * #AccessibleStreamableContent.
715 * Returns: #TRUE if @obj implements the #AccessibleStreamableContent interface,
719 Accessible_isStreamableContent (Accessible *obj)
721 return cspi_accessible_is_a (obj,
722 "IDL:Accessibility/StreamableContent:1.0");
727 * @obj: a pointer to the #Accessible instance to query.
729 * Query whether the specified #Accessible implements #AccessibleText.
731 * Returns: #TRUE if @obj implements the #AccessibleText interface,
735 Accessible_isText (Accessible *obj)
737 return cspi_accessible_is_a (obj,
738 "IDL:Accessibility/Text:1.0");
742 * Accessible_isValue:
743 * @obj: a pointer to the #Accessible instance to query.
745 * Query whether the specified #Accessible implements #AccessibleValue.
747 * Returns: #TRUE if @obj implements the #AccessibleValue interface,
751 Accessible_isValue (Accessible *obj)
753 return cspi_accessible_is_a (obj,
754 "IDL:Accessibility/Value:1.0");
758 * Accessible_getApplication:
759 * @obj: a pointer to the #Accessible instance to query.
761 * Get the #AccessibleApplication interface for an #Accessible.
763 * Returns: a pointer to an #AccessibleApplication interface instance, or
764 * NULL if @obj does not implement #AccessibleApplication.
766 AccessibleApplication *
767 Accessible_getApplication (Accessible *obj)
769 return (AccessibleApplication *) Accessible_queryInterface (
770 obj, "IDL:Accessibility/Application:1.0");
774 * Accessible_getAction:
775 * @obj: a pointer to the #Accessible instance to query.
777 * Get the #AccessibleAction interface for an #Accessible.
779 * Returns: a pointer to an #AccessibleAction interface instance, or
780 * NULL if @obj does not implement #AccessibleAction.
783 Accessible_getAction (Accessible *obj)
785 return (AccessibleAction *) Accessible_queryInterface (
786 obj, "IDL:Accessibility/Action:1.0");
790 * Accessible_getComponent:
791 * @obj: a pointer to the #Accessible instance to query.
793 * Get the #AccessibleComponent interface for an #Accessible.
795 * Returns: a pointer to an #AccessibleComponent interface instance, or
796 * NULL if @obj does not implement #AccessibleComponent.
798 AccessibleComponent *
799 Accessible_getComponent (Accessible *obj)
801 return (AccessibleComponent *) Accessible_queryInterface (
802 obj, "IDL:Accessibility/Component:1.0");
806 * Accessible_getEditableText:
807 * @obj: a pointer to the #Accessible instance to query.
809 * Get the #AccessibleEditableText interface for an #Accessible.
811 * Returns: a pointer to an #AccessibleEditableText interface instance, or
812 * NULL if @obj does not implement #AccessibleEditableText.
814 AccessibleEditableText *
815 Accessible_getEditableText (Accessible *obj)
817 return (AccessibleEditableText *) Accessible_queryInterface (
818 obj, "IDL:Accessibility/EditableText:1.0");
824 * Accessible_getHypertext:
825 * @obj: a pointer to the #Accessible instance to query.
827 * Get the #AccessibleHypertext interface for an #Accessible.
829 * Returns: a pointer to an #AccessibleHypertext interface instance, or
830 * NULL if @obj does not implement #AccessibleHypertext.
832 AccessibleHypertext *
833 Accessible_getHypertext (Accessible *obj)
835 return (AccessibleHypertext *) Accessible_queryInterface (
836 obj, "IDL:Accessibility/Hypertext:1.0");
842 * Accessible_getImage:
843 * @obj: a pointer to the #Accessible instance to query.
845 * Get the #AccessibleImage interface for an #Accessible.
847 * Returns: a pointer to an #AccessibleImage interface instance, or
848 * NULL if @obj does not implement #AccessibleImage.
851 Accessible_getImage (Accessible *obj)
853 return (AccessibleImage *) Accessible_queryInterface (
854 obj, "IDL:Accessibility/Image:1.0");
860 * Accessible_getSelection:
861 * @obj: a pointer to the #Accessible instance to query.
863 * Get the #AccessibleSelection interface for an #Accessible.
865 * Returns: a pointer to an #AccessibleSelection interface instance, or
866 * NULL if @obj does not implement #AccessibleSelection.
868 AccessibleSelection *
869 Accessible_getSelection (Accessible *obj)
871 return (AccessibleSelection *) Accessible_queryInterface (
872 obj, "IDL:Accessibility/Selection:1.0");
878 * Accessible_getStreamableContent:
879 * @obj: a pointer to the #Accessible instance to query.
881 * Get the #AccessibleStreamableContent interface for an #Accessible.
883 * Returns: a pointer to an #AccessibleStreamableContent interface instance, or
884 * NULL if @obj does not implement #AccessibleStreamableContent.
886 AccessibleStreamableContent *
887 Accessible_getStreamableContent (Accessible *obj)
889 return (AccessibleStreamableContent *) Accessible_queryInterface (
890 obj, "IDL:Accessibility/StreamableContent:1.0");
894 * Accessible_getTable:
895 * @obj: a pointer to the #Accessible instance to query.
897 * Get the #AccessibleTable interface for an #Accessible.
899 * Returns: a pointer to an #AccessibleTable interface instance, or
900 * NULL if @obj does not implement #AccessibleTable.
903 Accessible_getTable (Accessible *obj)
905 return (AccessibleTable *) Accessible_queryInterface (
906 obj, "IDL:Accessibility/Table:1.0");
910 * Accessible_getText:
911 * @obj: a pointer to the #Accessible instance to query.
913 * Get the #AccessibleText interface for an #Accessible.
915 * Returns: a pointer to an #AccessibleText interface instance, or
916 * NULL if @obj does not implement #AccessibleText.
919 Accessible_getText (Accessible *obj)
921 return (AccessibleText *) Accessible_queryInterface (
922 obj, "IDL:Accessibility/Text:1.0");
928 * Accessible_getValue:
929 * @obj: a pointer to the #Accessible instance to query.
931 * Get the #AccessibleValue interface for an #Accessible.
933 * Returns: a pointer to an #AccessibleValue interface instance, or
934 * NULL if @obj does not implement #AccessibleValue.
937 Accessible_getValue (Accessible *obj)
939 return (AccessibleValue *) Accessible_queryInterface (
940 obj, "IDL:Accessibility/Value:1.0");
946 * Accessible_queryInterface:
947 * @obj: a pointer to the #Accessible instance to query.
948 * @interface_name: a UTF-8 character string specifiying the requested interface.
950 * Query an #Accessible object to for a named interface.
952 * Returns: an instance of the named interface object, if it is implemented
953 * by @obj, or NULL otherwise.
957 Accessible_queryInterface (Accessible *obj,
958 const char *interface_name)
960 Bonobo_Unknown iface;
967 iface = Accessibility_Accessible_queryInterface (CSPI_OBJREF (obj),
972 cspi_return_val_if_ev ("queryInterface", NULL);
975 * FIXME: we need to be fairly sure that references are going
976 * to mach up if we are going to expose QueryInterface, ie. we
977 * can't allow people to do:
978 * b = a.qi ("b"); b.unref, b.unref to release a's reference.
979 * this should be no real problem though for this level of API
983 return cspi_object_add (iface);
988 * AccessibleRelation_ref:
989 * @obj: a pointer to the #AccessibleRelation object on which to operate.
991 * Increment the reference count for an #AccessibleRelation object.
995 AccessibleRelation_ref (AccessibleRelation *obj)
997 cspi_object_ref (obj);
1001 * AccessibleRelation_unref:
1002 * @obj: a pointer to the #AccessibleRelation object on which to operate.
1004 * Decrement the reference count for an #AccessibleRelation object.
1008 AccessibleRelation_unref (AccessibleRelation *obj)
1010 cspi_object_unref (obj);
1014 * AccessibleRelation_getRelationType:
1015 * @obj: a pointer to the #AccessibleRelation object to query.
1017 * Get the type of relationship represented by an #AccessibleRelation.
1019 * Returns: an #AccessibleRelationType indicating the type of relation
1020 * encapsulated in this #AccessibleRelation object.
1023 AccessibleRelationType
1024 AccessibleRelation_getRelationType (AccessibleRelation *obj)
1026 AccessibleRelationType retval;
1028 cspi_return_val_if_fail (obj, SPI_RELATION_NULL);
1030 Accessibility_Relation_getRelationType (CSPI_OBJREF (obj), cspi_ev());
1031 cspi_return_val_if_ev ("getRelationType", SPI_RELATION_NULL);
1036 * AccessibleRelation_getNTargets:
1037 * @obj: a pointer to the #AccessibleRelation object to query.
1039 * Get the number of objects which this relationship has as its
1040 * target objects (the subject is the #Accessible from which this
1041 * #AccessibleRelation originated).
1043 * Returns: a short integer indicating how many target objects which the
1044 * originating #Accessible object has the #AccessibleRelation
1045 * relationship with.
1048 AccessibleRelation_getNTargets (AccessibleRelation *obj)
1052 cspi_return_val_if_fail (obj, -1);
1053 retval = Accessibility_Relation_getNTargets (CSPI_OBJREF (obj), cspi_ev());
1054 cspi_return_val_if_ev ("getNTargets", -1);
1059 * AccessibleRelation_getTarget:
1060 * @obj: a pointer to the #AccessibleRelation object to query.
1061 * @i: a (zero-index) integer indicating which (of possibly several) target is requested.
1063 * Get the @i-th target of a specified #AccessibleRelation relationship.
1065 * Returns: an #Accessible which is the @i-th object with which the
1066 * originating #Accessible has relationship specified in the
1067 * #AccessibleRelation object.
1071 AccessibleRelation_getTarget (AccessibleRelation *obj, int i)
1075 cspi_return_val_if_fail (obj, NULL);
1077 retval = cspi_object_add (
1078 Accessibility_Relation_getTarget (CSPI_OBJREF(obj),
1080 cspi_return_val_if_ev ("getTarget", NULL);
1085 * AccessibleStateSet_ref:
1086 * @obj: a pointer to the #AccessibleStateSet object on which to operate.
1088 * Increment the reference count for an #AccessibleStateSet object.
1092 AccessibleStateSet_ref (AccessibleStateSet *obj)
1094 cspi_object_ref (obj);
1098 * AccessibleStateSet_unref:
1099 * @obj: a pointer to the #AccessibleStateSet object on which to operate.
1101 * Decrement the reference count for an #AccessibleStateSet object.
1105 AccessibleStateSet_unref (AccessibleStateSet *obj)
1107 cspi_object_unref (obj);
1111 * AccessibleStateSet_contains:
1112 * @obj: a pointer to the #AccessibleStateSet object on which to operate.
1113 * @state: an #AccessibleState for which the specified #AccessibleStateSet
1116 * Determine whether a given #AccessibleStateSet includes a given state; that is,
1117 * whether @state is true for the stateset in question.
1119 * Returns: #TRUE if @state is true/included in the given #AccessibleStateSet,
1124 AccessibleStateSet_contains (AccessibleStateSet *obj,
1125 AccessibleState state)
1127 CORBA_boolean retval;
1128 Accessibility_StateType spi_state;
1130 cspi_return_val_if_fail (obj != NULL, FALSE);
1132 spi_state = spi_state_type_from_accessible_state (state);
1133 retval = Accessibility_StateSet_contains (CSPI_OBJREF (obj),
1134 spi_state, cspi_ev ());
1136 cspi_return_val_if_ev ("contains", FALSE);
1142 * AccessibleStateSet_add:
1143 * @obj: a pointer to the #AccessibleStateSet object on which to operate.
1144 * @state: an #AccessibleState to be added to the specified #AccessibleStateSet
1146 * Add a particular #AccessibleState to an #AccessibleStateSet (i.e. set the
1147 * given state to #TRUE in the stateset.
1151 AccessibleStateSet_add (AccessibleStateSet *obj,
1152 AccessibleState state)
1154 Accessibility_StateType spi_state;
1156 cspi_return_if_fail (obj != NULL);
1158 spi_state = spi_state_type_from_accessible_state (state);
1159 Accessibility_StateSet_add (CSPI_OBJREF (obj), spi_state, cspi_ev ());
1160 cspi_check_ev ("StateSet_add");
1164 * AccessibleStateSet_remove:
1165 * @obj: a pointer to the #AccessibleStateSet object on which to operate.
1166 * @state: an #AccessibleState to be removed from the specified #AccessibleStateSet
1168 * Remove a particular #AccessibleState to an #AccessibleStateSet (i.e. set the
1169 * given state to #FALSE in the stateset.)
1173 AccessibleStateSet_remove (AccessibleStateSet *obj,
1174 AccessibleState state)
1176 Accessibility_StateType spi_state;
1178 cspi_return_if_fail (obj != NULL);
1180 spi_state = spi_state_type_from_accessible_state (state);
1181 Accessibility_StateSet_remove (CSPI_OBJREF (obj), spi_state, cspi_ev ());
1182 cspi_check_ev ("StateSet_remove");
1186 * AccessibleStateSet_equals:
1187 * @obj: a pointer to the first #AccessibleStateSet object on which to operate.
1188 * @obj2: a pointer to the second #AccessibleStateSet object on which to operate.
1190 * Determine whether two instances of #AccessibleStateSet are equivalent (i.e.
1191 * consist of the same #AccessibleStates). Useful for checking multiple
1192 * state variables at once; construct the target state then compare against it.
1194 * @see AccessibleStateSet_compare().
1196 * Returns: #TRUE if the two #AccessibleStateSets are equivalent,
1201 AccessibleStateSet_equals (AccessibleStateSet *obj,
1202 AccessibleStateSet *obj2)
1209 cspi_return_val_if_fail (obj != NULL, FALSE);
1210 cspi_return_val_if_fail (obj2 != NULL, FALSE);
1212 return Accessibility_StateSet_equals (CSPI_OBJREF (obj),
1213 CSPI_OBJREF (obj2), cspi_ev ());
1217 * AccessibleStateSet_compare:
1218 * @obj: a pointer to the first #AccessibleStateSet object on which to operate.
1219 * @obj2: a pointer to the second #AccessibleStateSet object on which to operate.
1221 * Determine the differences between two instances of #AccessibleStateSet.
1222 * Not Yet Implemented.
1224 * @see AccessibleStateSet_equals().
1226 * Returns: an #AccessibleStateSet object containing all states contained on one of
1227 * the two sets but not the other.
1230 AccessibleStateSet *
1231 AccessibleStateSet_compare (AccessibleStateSet *obj,
1232 AccessibleStateSet *obj2)
1234 AccessibleStateSet *retval;
1236 cspi_return_val_if_fail (obj != NULL, NULL);
1237 cspi_return_val_if_fail (obj2 != NULL, NULL);
1238 retval = cspi_object_add (
1239 Accessibility_StateSet_compare (CSPI_OBJREF(obj), CSPI_OBJREF(obj2), cspi_ev ()));
1241 cspi_return_val_if_ev ("compare", NULL);
1246 * AccessibleStateSet_isEmpty:
1247 * @obj: a pointer to the #AccessibleStateSet object on which to operate.
1249 * Determine whether a given #AccessibleStateSet is the empty set.
1251 * Returns: #TRUE if the given #AccessibleStateSet contains no (true) states,
1256 AccessibleStateSet_isEmpty (AccessibleStateSet *obj)
1258 CORBA_boolean retval;
1260 cspi_return_val_if_fail (obj != NULL, FALSE);
1261 retval = Accessibility_StateSet_isEmpty (CSPI_OBJREF (obj), cspi_ev ());
1263 cspi_return_val_if_ev ("isEmpty", TRUE);