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_LAST_DEFINED] = SPI_ROLE_EXTENDED;
185 static AccessibleRole
186 cspi_role_from_spi_role (Accessibility_Role role)
188 /* array is sized according to IDL roles because IDL roles are the index */
189 static AccessibleRole cspi_role_table [Accessibility_ROLE_LAST_DEFINED];
190 static SPIBoolean is_initialized = FALSE;
191 AccessibleRole cspi_role;
194 is_initialized = cspi_init_role_table (cspi_role_table);
196 if (role >= 0 && role < Accessibility_ROLE_LAST_DEFINED)
198 cspi_role = cspi_role_table [role];
202 cspi_role = SPI_ROLE_EXTENDED;
208 init_state_table (Accessibility_StateType *state_table)
212 for (i = 0; i < Accessibility_STATE_LAST_DEFINED; i++)
213 state_table[i] = SPI_STATE_INVALID;
215 state_table[SPI_STATE_ACTIVE] = Accessibility_STATE_ACTIVE;
216 state_table[SPI_STATE_ARMED] = Accessibility_STATE_ARMED;
217 state_table[SPI_STATE_BUSY] = Accessibility_STATE_BUSY;
218 state_table[SPI_STATE_CHECKED] = Accessibility_STATE_CHECKED;
219 state_table[SPI_STATE_DEFUNCT] = Accessibility_STATE_DEFUNCT;
220 state_table[SPI_STATE_EDITABLE] = Accessibility_STATE_EDITABLE;
221 state_table[SPI_STATE_ENABLED] = Accessibility_STATE_ENABLED;
222 state_table[SPI_STATE_EXPANDABLE] = Accessibility_STATE_EXPANDABLE;
223 state_table[SPI_STATE_EXPANDED] = Accessibility_STATE_EXPANDED;
224 state_table[SPI_STATE_FOCUSABLE] = Accessibility_STATE_FOCUSABLE;
225 state_table[SPI_STATE_FOCUSED] = Accessibility_STATE_FOCUSED;
226 state_table[SPI_STATE_HORIZONTAL] = Accessibility_STATE_HORIZONTAL;
227 state_table[SPI_STATE_ICONIFIED] = Accessibility_STATE_ICONIFIED;
228 state_table[SPI_STATE_MODAL] = Accessibility_STATE_MODAL;
229 state_table[SPI_STATE_MULTI_LINE] = Accessibility_STATE_MULTI_LINE;
230 state_table[SPI_STATE_MULTISELECTABLE] = Accessibility_STATE_MULTISELECTABLE;
231 state_table[SPI_STATE_OPAQUE] = Accessibility_STATE_OPAQUE;
232 state_table[SPI_STATE_PRESSED] = Accessibility_STATE_PRESSED;
233 state_table[SPI_STATE_RESIZABLE] = Accessibility_STATE_RESIZABLE;
234 state_table[SPI_STATE_SELECTABLE] = Accessibility_STATE_SELECTABLE;
235 state_table[SPI_STATE_SELECTED] = Accessibility_STATE_SELECTED;
236 state_table[SPI_STATE_SENSITIVE] = Accessibility_STATE_SENSITIVE;
237 state_table[SPI_STATE_SHOWING] = Accessibility_STATE_SHOWING;
238 state_table[SPI_STATE_SINGLE_LINE] = Accessibility_STATE_SINGLE_LINE;
239 state_table[SPI_STATE_STALE] = Accessibility_STATE_STALE;
240 state_table[SPI_STATE_TRANSIENT] = Accessibility_STATE_TRANSIENT;
241 state_table[SPI_STATE_VERTICAL] = Accessibility_STATE_VERTICAL;
242 state_table[SPI_STATE_VISIBLE] = Accessibility_STATE_VISIBLE;
249 static Accessibility_StateType
250 spi_state_type_from_accessible_state (AccessibleState type)
252 static Accessibility_StateType state_table[Accessibility_STATE_LAST_DEFINED];
253 static SPIBoolean table_initialized = FALSE;
254 Accessibility_StateType rv;
256 if (!table_initialized)
257 table_initialized = init_state_table (state_table);
258 if (type > SPI_STATE_INVALID && type < SPI_STATE_LAST_DEFINED)
259 rv = state_table[type];
261 rv = Accessibility_STATE_INVALID;
269 * AccessibleRole_getName:
270 * @role: an #AccessibleRole object to query.
272 * Get a localizeable string that indicates the name of an #AccessibleRole.
273 * <em>DEPRECATED.</em>
275 * Returns: a localizable string name for an #AccessibleRole enumerated type.
278 AccessibleRole_getName (AccessibleRole role)
280 if (role < MAX_ROLES)
282 return CORBA_string_dup (role_names [(int) role]);
286 return g_strdup ("");
292 * @obj: a pointer to the #Accessible object on which to operate.
294 * Increment the reference count for an #Accessible object.
297 Accessible_ref (Accessible *obj)
299 cspi_object_ref (obj);
304 * @obj: a pointer to the #Accessible object on which to operate.
306 * Decrement the reference count for an #Accessible object.
309 Accessible_unref (Accessible *obj)
311 cspi_object_unref (obj);
315 * Accessible_getName:
316 * @obj: a pointer to the #Accessible object on which to operate.
318 * Get the name of an #Accessible object.
320 * Returns: a UTF-8 string indicating the name of the #Accessible object.
321 * or NULL on exception
324 Accessible_getName (Accessible *obj)
328 cspi_return_val_if_fail (obj != NULL, NULL);
330 retval = Accessibility_Accessible__get_name (CSPI_OBJREF (obj), cspi_ev ());
332 cspi_return_val_if_ev ("getName", NULL);
338 * Accessible_getDescription:
339 * @obj: a pointer to the #Accessible object on which to operate.
341 * Get the description of an #Accessible object.
343 * Returns: a UTF-8 string describing the #Accessible object.
344 * or NULL on exception
347 Accessible_getDescription (Accessible *obj)
351 cspi_return_val_if_fail (obj != NULL, NULL);
353 retval = Accessibility_Accessible__get_description (CSPI_OBJREF (obj),
356 cspi_return_val_if_ev ("getDescription", NULL);
362 * Accessible_getParent:
363 * @obj: a pointer to the #Accessible object to query.
365 * Get an #Accessible object's parent container.
367 * Returns: a pointer tothe #Accessible object which contains the given
368 * #Accessible instance, or NULL if the @obj has no parent container.
372 Accessible_getParent (Accessible *obj)
376 cspi_return_val_if_fail (obj != NULL, NULL);
378 retval = cspi_object_add (
379 Accessibility_Accessible__get_parent (CSPI_OBJREF (obj),
382 cspi_return_val_if_ev ("getParent", NULL);
388 * Accessible_getChildCount:
389 * @obj: a pointer to the #Accessible object on which to operate.
391 * Get the number of children contained by an #Accessible object.
393 * Returns: a #long indicating the number of #Accessible children
394 * contained by an #Accessible object. or -1 on exception
398 Accessible_getChildCount (Accessible *obj)
402 cspi_return_val_if_fail (obj != NULL, -1);
404 retval = Accessibility_Accessible__get_childCount (CSPI_OBJREF (obj),
407 cspi_return_val_if_ev ("getChildCount", -1);
413 * Accessible_getChildAtIndex:
414 * @obj: a pointer to the #Accessible object on which to operate.
415 * @childIndex: a #long indicating which child is specified.
417 * Get the #Accessible child of an #Accessible object at a given index.
419 * Returns: a pointer to the #Accessible child object at index
420 * @childIndex. or NULL on exception
423 Accessible_getChildAtIndex (Accessible *obj,
428 cspi_return_val_if_fail (obj != NULL, NULL);
430 retval = cspi_object_add (
431 Accessibility_Accessible_getChildAtIndex (CSPI_OBJREF (obj),
432 childIndex, cspi_ev ()));
434 cspi_return_val_if_ev ("getChildAtIndex", NULL);
439 * Accessible_getIndexInParent:
440 * @obj: a pointer to the #Accessible object on which to operate.
442 * Get the index of an #Accessible object in its containing #Accessible.
444 * Returns: a #long indicating the index of the #Accessible object
445 * in its parent (i.e. containing) #Accessible instance,
446 * or -1 if @obj has no containing parent or on exception.
449 Accessible_getIndexInParent (Accessible *obj)
453 cspi_return_val_if_fail (obj != NULL, -1);
455 retval = Accessibility_Accessible_getIndexInParent (CSPI_OBJREF (obj), cspi_ev ());
457 cspi_return_val_if_ev ("getIndexInparent", -1);
462 * Accessible_getRelationSet:
463 * @obj: a pointer to the #Accessible object on which to operate.
465 * Get the set of #AccessibleRelation objects which describe this #Accessible object's
466 * relationships with other #Accessible objects.
468 * Returns: an array of #AccessibleRelation pointers. or NULL on exception
470 AccessibleRelation **
471 Accessible_getRelationSet (Accessible *obj)
475 AccessibleRelation **relations;
476 Accessibility_RelationSet *relation_set;
478 cspi_return_val_if_fail (obj != NULL, NULL);
481 Accessibility_Accessible_getRelationSet (CSPI_OBJREF (obj), cspi_ev ());
483 cspi_return_val_if_ev ("getRelationSet", NULL);
485 n_relations = relation_set->_length;
486 relations = malloc (sizeof (AccessibleRelation *) * (n_relations + 1));
488 for (i = 0; i < n_relations; ++i)
490 relations[i] = cspi_object_add (CORBA_Object_duplicate (
491 relation_set->_buffer[i], cspi_ev ()));
495 CORBA_free (relation_set);
501 * Accessible_getRole:
502 * @obj: a pointer to the #Accessible object on which to operate.
504 * Get the UI role of an #Accessible object.
505 * A UTF-8 string describing this role can be obtained via Accessible_getRoleName ().
507 * Returns: the #AccessibleRole of the object.
511 Accessible_getRole (Accessible *obj)
513 AccessibleRole retval;
515 cspi_return_val_if_fail (obj != NULL, SPI_ROLE_INVALID);
518 Accessibility_Accessible_getRole (CSPI_OBJREF (obj), cspi_ev ());
520 cspi_return_val_if_ev ("getRole", SPI_ROLE_INVALID);
522 return cspi_role_from_spi_role (retval);
526 * Accessible_getRoleName:
527 * @obj: a pointer to the #Accessible object on which to operate.
529 * Get a UTF-8 string describing the role this object plays in the UI.
530 * This method will return useful values for roles that fall outside the
531 * enumeration used in Accessible_getRole ().
533 * Returns: a UTF-8 string specifying the role of this #Accessible object.
537 Accessible_getRoleName (Accessible *obj)
541 cspi_return_val_if_fail (obj != NULL, CORBA_string_dup ("invalid"));
544 Accessibility_Accessible_getRoleName (CSPI_OBJREF (obj), cspi_ev ());
546 cspi_return_val_if_ev ("getRoleName", CORBA_string_dup ("invalid"));
552 * Accessible_getStateSet:
553 * @obj: a pointer to the #Accessible object on which to operate.
555 * Not Yet Implemented.
557 * Returns: a pointer to an #AccessibleStateSet representing the object's current state.
560 Accessible_getStateSet (Accessible *obj)
562 AccessibleStateSet *retval;
564 cspi_return_val_if_fail (obj != NULL, NULL);
566 retval = cspi_object_add (
567 Accessibility_Accessible_getState (CSPI_OBJREF (obj),
570 cspi_return_val_if_ev ("getState", NULL);
574 /* Interface query methods */
577 * Accessible_isAction:
578 * @obj: a pointer to the #Accessible instance to query.
580 * Query whether the specified #Accessible implements #AccessibleAction.
582 * Returns: #TRUE if @obj implements the #AccessibleAction interface,
586 Accessible_isAction (Accessible *obj)
588 return cspi_accessible_is_a (obj,
589 "IDL:Accessibility/Action:1.0");
593 * Accessible_isApplication:
594 * @obj: a pointer to the #Accessible instance to query.
596 * Query whether the specified #Accessible implements #AccessibleApplication.
598 * Returns: #TRUE if @obj implements the #AccessibleApplication interface,
602 Accessible_isApplication (Accessible *obj)
604 return cspi_accessible_is_a (obj,
605 "IDL:Accessibility/Application:1.0");
609 * Accessible_isComponent:
610 * @obj: a pointer to the #Accessible instance to query.
612 * Query whether the specified #Accessible implements #AccessibleComponent.
614 * Returns: #TRUE if @obj implements the #AccessibleComponent interface,
618 Accessible_isComponent (Accessible *obj)
620 return cspi_accessible_is_a (obj,
621 "IDL:Accessibility/Component:1.0");
625 * Accessible_isEditableText:
626 * @obj: a pointer to the #Accessible instance to query.
628 * Query whether the specified #Accessible implements #AccessibleEditableText.
630 * Returns: #TRUE if @obj implements the #AccessibleEditableText interface,
634 Accessible_isEditableText (Accessible *obj)
636 return cspi_accessible_is_a (obj,
637 "IDL:Accessibility/EditableText:1.0");
641 * Accessible_isHypertext:
642 * @obj: a pointer to the #Accessible instance to query.
644 * Query whether the specified #Accessible implements #AccessibleHypertext.
646 * Returns: #TRUE if @obj implements the #AccessibleHypertext interface,
650 Accessible_isHypertext (Accessible *obj)
652 return cspi_accessible_is_a (obj,
653 "IDL:Accessibility/Hypertext:1.0");
657 * Accessible_isImage:
658 * @obj: a pointer to the #Accessible instance to query.
660 * Query whether the specified #Accessible implements #AccessibleImage.
662 * Returns: #TRUE if @obj implements the #AccessibleImage interface,
666 Accessible_isImage (Accessible *obj)
668 return cspi_accessible_is_a (obj,
669 "IDL:Accessibility/Image:1.0");
673 * Accessible_isSelection:
674 * @obj: a pointer to the #Accessible instance to query.
676 * Query whether the specified #Accessible implements #AccessibleSelection.
678 * Returns: #TRUE if @obj implements the #AccessibleSelection interface,
682 Accessible_isSelection (Accessible *obj)
684 return cspi_accessible_is_a (obj,
685 "IDL:Accessibility/Selection:1.0");
689 * Accessible_isTable:
690 * @obj: a pointer to the #Accessible instance to query.
692 * Query whether the specified #Accessible implements #AccessibleTable.
694 * Returns: #TRUE if @obj implements the #AccessibleTable interface,
698 Accessible_isTable (Accessible *obj)
700 return cspi_accessible_is_a (obj,
701 "IDL:Accessibility/Table:1.0");
705 * Accessible_isStreamableContent:
706 * @obj: a pointer to the #Accessible instance to query.
708 * Query whether the specified #Accessible implements
709 * #AccessibleStreamableContent.
711 * Returns: #TRUE if @obj implements the #AccessibleStreamableContent interface,
715 Accessible_isStreamableContent (Accessible *obj)
717 return cspi_accessible_is_a (obj,
718 "IDL:Accessibility/StreamableContent:1.0");
723 * @obj: a pointer to the #Accessible instance to query.
725 * Query whether the specified #Accessible implements #AccessibleText.
727 * Returns: #TRUE if @obj implements the #AccessibleText interface,
731 Accessible_isText (Accessible *obj)
733 return cspi_accessible_is_a (obj,
734 "IDL:Accessibility/Text:1.0");
738 * Accessible_isValue:
739 * @obj: a pointer to the #Accessible instance to query.
741 * Query whether the specified #Accessible implements #AccessibleValue.
743 * Returns: #TRUE if @obj implements the #AccessibleValue interface,
747 Accessible_isValue (Accessible *obj)
749 return cspi_accessible_is_a (obj,
750 "IDL:Accessibility/Value:1.0");
754 * Accessible_getApplication:
755 * @obj: a pointer to the #Accessible instance to query.
757 * Get the #AccessibleApplication interface for an #Accessible.
759 * Returns: a pointer to an #AccessibleApplication interface instance, or
760 * NULL if @obj does not implement #AccessibleApplication.
762 AccessibleApplication *
763 Accessible_getApplication (Accessible *obj)
765 return (AccessibleApplication *) Accessible_queryInterface (
766 obj, "IDL:Accessibility/Application:1.0");
770 * Accessible_getAction:
771 * @obj: a pointer to the #Accessible instance to query.
773 * Get the #AccessibleAction interface for an #Accessible.
775 * Returns: a pointer to an #AccessibleAction interface instance, or
776 * NULL if @obj does not implement #AccessibleAction.
779 Accessible_getAction (Accessible *obj)
781 return (AccessibleAction *) Accessible_queryInterface (
782 obj, "IDL:Accessibility/Action:1.0");
786 * Accessible_getComponent:
787 * @obj: a pointer to the #Accessible instance to query.
789 * Get the #AccessibleComponent interface for an #Accessible.
791 * Returns: a pointer to an #AccessibleComponent interface instance, or
792 * NULL if @obj does not implement #AccessibleComponent.
794 AccessibleComponent *
795 Accessible_getComponent (Accessible *obj)
797 return (AccessibleComponent *) Accessible_queryInterface (
798 obj, "IDL:Accessibility/Component:1.0");
802 * Accessible_getEditableText:
803 * @obj: a pointer to the #Accessible instance to query.
805 * Get the #AccessibleEditableText interface for an #Accessible.
807 * Returns: a pointer to an #AccessibleEditableText interface instance, or
808 * NULL if @obj does not implement #AccessibleEditableText.
810 AccessibleEditableText *
811 Accessible_getEditableText (Accessible *obj)
813 return (AccessibleEditableText *) Accessible_queryInterface (
814 obj, "IDL:Accessibility/EditableText:1.0");
820 * Accessible_getHypertext:
821 * @obj: a pointer to the #Accessible instance to query.
823 * Get the #AccessibleHypertext interface for an #Accessible.
825 * Returns: a pointer to an #AccessibleHypertext interface instance, or
826 * NULL if @obj does not implement #AccessibleHypertext.
828 AccessibleHypertext *
829 Accessible_getHypertext (Accessible *obj)
831 return (AccessibleHypertext *) Accessible_queryInterface (
832 obj, "IDL:Accessibility/Hypertext:1.0");
838 * Accessible_getImage:
839 * @obj: a pointer to the #Accessible instance to query.
841 * Get the #AccessibleImage interface for an #Accessible.
843 * Returns: a pointer to an #AccessibleImage interface instance, or
844 * NULL if @obj does not implement #AccessibleImage.
847 Accessible_getImage (Accessible *obj)
849 return (AccessibleImage *) Accessible_queryInterface (
850 obj, "IDL:Accessibility/Image:1.0");
856 * Accessible_getSelection:
857 * @obj: a pointer to the #Accessible instance to query.
859 * Get the #AccessibleSelection interface for an #Accessible.
861 * Returns: a pointer to an #AccessibleSelection interface instance, or
862 * NULL if @obj does not implement #AccessibleSelection.
864 AccessibleSelection *
865 Accessible_getSelection (Accessible *obj)
867 return (AccessibleSelection *) Accessible_queryInterface (
868 obj, "IDL:Accessibility/Selection:1.0");
874 * Accessible_getStreamableContent:
875 * @obj: a pointer to the #Accessible instance to query.
877 * Get the #AccessibleStreamableContent interface for an #Accessible.
879 * Returns: a pointer to an #AccessibleStreamableContent interface instance, or
880 * NULL if @obj does not implement #AccessibleStreamableContent.
882 AccessibleStreamableContent *
883 Accessible_getStreamableContent (Accessible *obj)
885 return (AccessibleStreamableContent *) Accessible_queryInterface (
886 obj, "IDL:Accessibility/StreamableContent:1.0");
890 * Accessible_getTable:
891 * @obj: a pointer to the #Accessible instance to query.
893 * Get the #AccessibleTable interface for an #Accessible.
895 * Returns: a pointer to an #AccessibleTable interface instance, or
896 * NULL if @obj does not implement #AccessibleTable.
899 Accessible_getTable (Accessible *obj)
901 return (AccessibleTable *) Accessible_queryInterface (
902 obj, "IDL:Accessibility/Table:1.0");
906 * Accessible_getText:
907 * @obj: a pointer to the #Accessible instance to query.
909 * Get the #AccessibleText interface for an #Accessible.
911 * Returns: a pointer to an #AccessibleText interface instance, or
912 * NULL if @obj does not implement #AccessibleText.
915 Accessible_getText (Accessible *obj)
917 return (AccessibleText *) Accessible_queryInterface (
918 obj, "IDL:Accessibility/Text:1.0");
924 * Accessible_getValue:
925 * @obj: a pointer to the #Accessible instance to query.
927 * Get the #AccessibleValue interface for an #Accessible.
929 * Returns: a pointer to an #AccessibleValue interface instance, or
930 * NULL if @obj does not implement #AccessibleValue.
933 Accessible_getValue (Accessible *obj)
935 return (AccessibleValue *) Accessible_queryInterface (
936 obj, "IDL:Accessibility/Value:1.0");
942 * Accessible_queryInterface:
943 * @obj: a pointer to the #Accessible instance to query.
944 * @interface_name: a UTF-8 character string specifiying the requested interface.
946 * Query an #Accessible object to for a named interface.
948 * Returns: an instance of the named interface object, if it is implemented
949 * by @obj, or NULL otherwise.
953 Accessible_queryInterface (Accessible *obj,
954 const char *interface_name)
956 Bonobo_Unknown iface;
963 iface = Accessibility_Accessible_queryInterface (CSPI_OBJREF (obj),
968 cspi_return_val_if_ev ("queryInterface", NULL);
971 * FIXME: we need to be fairly sure that references are going
972 * to mach up if we are going to expose QueryInterface, ie. we
973 * can't allow people to do:
974 * b = a.qi ("b"); b.unref, b.unref to release a's reference.
975 * this should be no real problem though for this level of API
979 return cspi_object_add (iface);
984 * AccessibleRelation_ref:
985 * @obj: a pointer to the #AccessibleRelation object on which to operate.
987 * Increment the reference count for an #AccessibleRelation object.
991 AccessibleRelation_ref (AccessibleRelation *obj)
993 cspi_object_ref (obj);
997 * AccessibleRelation_unref:
998 * @obj: a pointer to the #AccessibleRelation object on which to operate.
1000 * Decrement the reference count for an #AccessibleRelation object.
1004 AccessibleRelation_unref (AccessibleRelation *obj)
1006 cspi_object_unref (obj);
1010 * AccessibleRelation_getRelationType:
1011 * @obj: a pointer to the #AccessibleRelation object to query.
1013 * Get the type of relationship represented by an #AccessibleRelation.
1015 * Returns: an #AccessibleRelationType indicating the type of relation
1016 * encapsulated in this #AccessibleRelation object.
1019 AccessibleRelationType
1020 AccessibleRelation_getRelationType (AccessibleRelation *obj)
1022 AccessibleRelationType retval;
1024 cspi_return_val_if_fail (obj, SPI_RELATION_NULL);
1026 Accessibility_Relation_getRelationType (CSPI_OBJREF (obj), cspi_ev());
1027 cspi_return_val_if_ev ("getRelationType", SPI_RELATION_NULL);
1032 * AccessibleRelation_getNTargets:
1033 * @obj: a pointer to the #AccessibleRelation object to query.
1035 * Get the number of objects which this relationship has as its
1036 * target objects (the subject is the #Accessible from which this
1037 * #AccessibleRelation originated).
1039 * Returns: a short integer indicating how many target objects which the
1040 * originating #Accessible object has the #AccessibleRelation
1041 * relationship with.
1044 AccessibleRelation_getNTargets (AccessibleRelation *obj)
1048 cspi_return_val_if_fail (obj, -1);
1049 retval = Accessibility_Relation_getNTargets (CSPI_OBJREF (obj), cspi_ev());
1050 cspi_return_val_if_ev ("getNTargets", -1);
1055 * AccessibleRelation_getTarget:
1056 * @obj: a pointer to the #AccessibleRelation object to query.
1057 * @i: a (zero-index) integer indicating which (of possibly several) target is requested.
1059 * Get the @i-th target of a specified #AccessibleRelation relationship.
1061 * Returns: an #Accessible which is the @i-th object with which the
1062 * originating #Accessible has relationship specified in the
1063 * #AccessibleRelation object.
1067 AccessibleRelation_getTarget (AccessibleRelation *obj, int i)
1071 cspi_return_val_if_fail (obj, NULL);
1073 retval = cspi_object_add (
1074 Accessibility_Relation_getTarget (CSPI_OBJREF(obj),
1076 cspi_return_val_if_ev ("getTarget", NULL);
1081 * AccessibleStateSet_ref:
1082 * @obj: a pointer to the #AccessibleStateSet object on which to operate.
1084 * Increment the reference count for an #AccessibleStateSet object.
1088 AccessibleStateSet_ref (AccessibleStateSet *obj)
1090 cspi_object_ref (obj);
1094 * AccessibleStateSet_unref:
1095 * @obj: a pointer to the #AccessibleStateSet object on which to operate.
1097 * Decrement the reference count for an #AccessibleStateSet object.
1101 AccessibleStateSet_unref (AccessibleStateSet *obj)
1103 cspi_object_unref (obj);
1107 * AccessibleStateSet_contains:
1108 * @obj: a pointer to the #AccessibleStateSet object on which to operate.
1109 * @state: an #AccessibleState for which the specified #AccessibleStateSet
1112 * Determine whether a given #AccessibleStateSet includes a given state; that is,
1113 * whether @state is true for the stateset in question.
1115 * Returns: #TRUE if @state is true/included in the given #AccessibleStateSet,
1120 AccessibleStateSet_contains (AccessibleStateSet *obj,
1121 AccessibleState state)
1123 CORBA_boolean retval;
1124 Accessibility_StateType spi_state;
1126 cspi_return_val_if_fail (obj != NULL, FALSE);
1128 spi_state = spi_state_type_from_accessible_state (state);
1129 retval = Accessibility_StateSet_contains (CSPI_OBJREF (obj),
1130 spi_state, cspi_ev ());
1132 cspi_return_val_if_ev ("contains", FALSE);
1138 * AccessibleStateSet_add:
1139 * @obj: a pointer to the #AccessibleStateSet object on which to operate.
1140 * @state: an #AccessibleState to be added to the specified #AccessibleStateSet
1142 * Add a particular #AccessibleState to an #AccessibleStateSet (i.e. set the
1143 * given state to #TRUE in the stateset.
1147 AccessibleStateSet_add (AccessibleStateSet *obj,
1148 AccessibleState state)
1150 Accessibility_StateType spi_state;
1152 cspi_return_if_fail (obj != NULL);
1154 spi_state = spi_state_type_from_accessible_state (state);
1155 Accessibility_StateSet_add (CSPI_OBJREF (obj), spi_state, cspi_ev ());
1156 cspi_check_ev ("StateSet_add");
1160 * AccessibleStateSet_remove:
1161 * @obj: a pointer to the #AccessibleStateSet object on which to operate.
1162 * @state: an #AccessibleState to be removed from the specified #AccessibleStateSet
1164 * Remove a particular #AccessibleState to an #AccessibleStateSet (i.e. set the
1165 * given state to #FALSE in the stateset.)
1169 AccessibleStateSet_remove (AccessibleStateSet *obj,
1170 AccessibleState state)
1172 Accessibility_StateType spi_state;
1174 cspi_return_if_fail (obj != NULL);
1176 spi_state = spi_state_type_from_accessible_state (state);
1177 Accessibility_StateSet_remove (CSPI_OBJREF (obj), spi_state, cspi_ev ());
1178 cspi_check_ev ("StateSet_remove");
1182 * AccessibleStateSet_equals:
1183 * @obj: a pointer to the first #AccessibleStateSet object on which to operate.
1184 * @obj2: a pointer to the second #AccessibleStateSet object on which to operate.
1186 * Determine whether two instances of #AccessibleStateSet are equivalent (i.e.
1187 * consist of the same #AccessibleStates). Useful for checking multiple
1188 * state variables at once; construct the target state then compare against it.
1190 * @see AccessibleStateSet_compare().
1192 * Returns: #TRUE if the two #AccessibleStateSets are equivalent,
1197 AccessibleStateSet_equals (AccessibleStateSet *obj,
1198 AccessibleStateSet *obj2)
1205 cspi_return_val_if_fail (obj != NULL, FALSE);
1206 cspi_return_val_if_fail (obj2 != NULL, FALSE);
1208 return Accessibility_StateSet_equals (CSPI_OBJREF (obj),
1209 CSPI_OBJREF (obj2), cspi_ev ());
1213 * AccessibleStateSet_compare:
1214 * @obj: a pointer to the first #AccessibleStateSet object on which to operate.
1215 * @obj2: a pointer to the second #AccessibleStateSet object on which to operate.
1217 * Determine the differences between two instances of #AccessibleStateSet.
1218 * Not Yet Implemented.
1220 * @see AccessibleStateSet_equals().
1222 * Returns: an #AccessibleStateSet object containing all states contained on one of
1223 * the two sets but not the other.
1226 AccessibleStateSet *
1227 AccessibleStateSet_compare (AccessibleStateSet *obj,
1228 AccessibleStateSet *obj2)
1230 AccessibleStateSet *retval;
1232 cspi_return_val_if_fail (obj != NULL, NULL);
1233 cspi_return_val_if_fail (obj2 != NULL, NULL);
1234 retval = cspi_object_add (
1235 Accessibility_StateSet_compare (CSPI_OBJREF(obj), CSPI_OBJREF(obj2), cspi_ev ()));
1237 cspi_return_val_if_ev ("compare", NULL);
1242 * AccessibleStateSet_isEmpty:
1243 * @obj: a pointer to the #AccessibleStateSet object on which to operate.
1245 * Determine whether a given #AccessibleStateSet is the empty set.
1247 * Returns: #TRUE if the given #AccessibleStateSet contains no (true) states,
1252 AccessibleStateSet_isEmpty (AccessibleStateSet *obj)
1254 CORBA_boolean retval;
1256 cspi_return_val_if_fail (obj != NULL, FALSE);
1257 retval = Accessibility_StateSet_isEmpty (CSPI_OBJREF (obj), cspi_ev ());
1259 cspi_return_val_if_ev ("isEmpty", TRUE);