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",
106 #define MAX_ROLES (sizeof (role_names) / sizeof (char *))
109 cspi_init_role_table (AccessibleRole *role_table)
112 for (i = 0; i < Accessibility_ROLE_LAST_DEFINED; ++i)
114 role_table [i] = SPI_ROLE_UNKNOWN;
116 role_table [Accessibility_ROLE_INVALID] = SPI_ROLE_INVALID;
117 role_table [Accessibility_ROLE_ACCELERATOR_LABEL] = SPI_ROLE_ACCEL_LABEL;
118 role_table [Accessibility_ROLE_ALERT] = SPI_ROLE_ALERT;
119 role_table [Accessibility_ROLE_ANIMATION] = SPI_ROLE_ANIMATION;
120 role_table [Accessibility_ROLE_ARROW] = SPI_ROLE_ARROW;
121 role_table [Accessibility_ROLE_CALENDAR] = SPI_ROLE_CALENDAR;
122 role_table [Accessibility_ROLE_CANVAS] = SPI_ROLE_CANVAS;
123 role_table [Accessibility_ROLE_CHECK_BOX] = SPI_ROLE_CHECK_BOX;
124 role_table [Accessibility_ROLE_CHECK_MENU_ITEM] = SPI_ROLE_CHECK_MENU_ITEM;
125 role_table [Accessibility_ROLE_COLOR_CHOOSER] = SPI_ROLE_COLOR_CHOOSER;
126 role_table [Accessibility_ROLE_COLUMN_HEADER] = SPI_ROLE_COLUMN_HEADER;
127 role_table [Accessibility_ROLE_COMBO_BOX] = SPI_ROLE_COMBO_BOX;
128 role_table [Accessibility_ROLE_DATE_EDITOR] = SPI_ROLE_DATE_EDITOR;
129 role_table [Accessibility_ROLE_DESKTOP_ICON] = SPI_ROLE_DESKTOP_ICON;
130 role_table [Accessibility_ROLE_DESKTOP_FRAME] = SPI_ROLE_DESKTOP_FRAME;
131 role_table [Accessibility_ROLE_DIAL] = SPI_ROLE_DIAL;
132 role_table [Accessibility_ROLE_DIALOG] = SPI_ROLE_DIALOG;
133 role_table [Accessibility_ROLE_DIRECTORY_PANE] = SPI_ROLE_DIRECTORY_PANE;
134 role_table [Accessibility_ROLE_DRAWING_AREA] = SPI_ROLE_DRAWING_AREA;
135 role_table [Accessibility_ROLE_FILE_CHOOSER] = SPI_ROLE_FILE_CHOOSER;
136 role_table [Accessibility_ROLE_FILLER] = SPI_ROLE_FILLER;
137 role_table [Accessibility_ROLE_FONT_CHOOSER] = SPI_ROLE_FONT_CHOOSER;
138 role_table [Accessibility_ROLE_FRAME] = SPI_ROLE_FRAME;
139 role_table [Accessibility_ROLE_GLASS_PANE] = SPI_ROLE_GLASS_PANE;
140 role_table [Accessibility_ROLE_HTML_CONTAINER] = SPI_ROLE_HTML_CONTAINER;
141 role_table [Accessibility_ROLE_ICON] = SPI_ROLE_ICON;
142 role_table [Accessibility_ROLE_IMAGE] = SPI_ROLE_IMAGE;
143 role_table [Accessibility_ROLE_INTERNAL_FRAME] = SPI_ROLE_INTERNAL_FRAME;
144 role_table [Accessibility_ROLE_LABEL] = SPI_ROLE_LABEL;
145 role_table [Accessibility_ROLE_LAYERED_PANE] = SPI_ROLE_LAYERED_PANE;
146 role_table [Accessibility_ROLE_LIST] = SPI_ROLE_LIST;
147 role_table [Accessibility_ROLE_LIST_ITEM] = SPI_ROLE_LIST_ITEM;
148 role_table [Accessibility_ROLE_MENU] = SPI_ROLE_MENU;
149 role_table [Accessibility_ROLE_MENU_BAR] = SPI_ROLE_MENU_BAR;
150 role_table [Accessibility_ROLE_MENU_ITEM] = SPI_ROLE_MENU_ITEM;
151 role_table [Accessibility_ROLE_OPTION_PANE] = SPI_ROLE_OPTION_PANE;
152 role_table [Accessibility_ROLE_PAGE_TAB] = SPI_ROLE_PAGE_TAB;
153 role_table [Accessibility_ROLE_PAGE_TAB_LIST] = SPI_ROLE_PAGE_TAB_LIST;
154 role_table [Accessibility_ROLE_PANEL] = SPI_ROLE_PANEL;
155 role_table [Accessibility_ROLE_PASSWORD_TEXT] = SPI_ROLE_PASSWORD_TEXT;
156 role_table [Accessibility_ROLE_POPUP_MENU] = SPI_ROLE_POPUP_MENU;
157 role_table [Accessibility_ROLE_PROGRESS_BAR] = SPI_ROLE_PROGRESS_BAR;
158 role_table [Accessibility_ROLE_PUSH_BUTTON] = SPI_ROLE_PUSH_BUTTON;
159 role_table [Accessibility_ROLE_RADIO_BUTTON] = SPI_ROLE_RADIO_BUTTON;
160 role_table [Accessibility_ROLE_RADIO_MENU_ITEM] = SPI_ROLE_RADIO_MENU_ITEM;
161 role_table [Accessibility_ROLE_ROOT_PANE] = SPI_ROLE_ROOT_PANE;
162 role_table [Accessibility_ROLE_ROW_HEADER] = SPI_ROLE_ROW_HEADER;
163 role_table [Accessibility_ROLE_SCROLL_BAR] = SPI_ROLE_SCROLL_BAR;
164 role_table [Accessibility_ROLE_SCROLL_PANE] = SPI_ROLE_SCROLL_PANE;
165 role_table [Accessibility_ROLE_SEPARATOR] = SPI_ROLE_SEPARATOR;
166 role_table [Accessibility_ROLE_SLIDER] = SPI_ROLE_SLIDER;
167 role_table [Accessibility_ROLE_SPIN_BUTTON] = SPI_ROLE_SPIN_BUTTON;
168 role_table [Accessibility_ROLE_SPLIT_PANE] = SPI_ROLE_SPLIT_PANE;
169 role_table [Accessibility_ROLE_STATUS_BAR] = SPI_ROLE_STATUS_BAR;
170 role_table [Accessibility_ROLE_TABLE] = SPI_ROLE_TABLE;
171 role_table [Accessibility_ROLE_TABLE_CELL] = SPI_ROLE_TABLE_CELL;
172 role_table[Accessibility_ROLE_TABLE_COLUMN_HEADER] = SPI_ROLE_TABLE_COLUMN_HEADER;
173 role_table[Accessibility_ROLE_TABLE_ROW_HEADER] = SPI_ROLE_TABLE_ROW_HEADER;
174 role_table [Accessibility_ROLE_TEAROFF_MENU_ITEM] = SPI_ROLE_TEAROFF_MENU_ITEM;
175 role_table[Accessibility_ROLE_TERMINAL] = SPI_ROLE_TERMINAL;
176 role_table [Accessibility_ROLE_TEXT] = SPI_ROLE_TEXT;
177 role_table [Accessibility_ROLE_TOGGLE_BUTTON] = SPI_ROLE_TOGGLE_BUTTON;
178 role_table [Accessibility_ROLE_TOOL_BAR] = SPI_ROLE_TOOL_BAR;
179 role_table [Accessibility_ROLE_TOOL_TIP] = SPI_ROLE_TOOL_TIP;
180 role_table [Accessibility_ROLE_TREE] = SPI_ROLE_TREE;
181 role_table [Accessibility_ROLE_TREE_TABLE] = SPI_ROLE_TREE_TABLE;
182 role_table [Accessibility_ROLE_VIEWPORT] = SPI_ROLE_VIEWPORT;
183 role_table [Accessibility_ROLE_WINDOW] = SPI_ROLE_WINDOW;
184 role_table [Accessibility_ROLE_EXTENDED] = SPI_ROLE_EXTENDED;
185 role_table [Accessibility_ROLE_HEADER] = SPI_ROLE_HEADER;
186 role_table [Accessibility_ROLE_FOOTER] = SPI_ROLE_FOOTER;
187 role_table [Accessibility_ROLE_PARAGRAPH] = SPI_ROLE_PARAGRAPH;
188 role_table [Accessibility_ROLE_RULER] = SPI_ROLE_RULER;
189 role_table [Accessibility_ROLE_APPLICATION] = SPI_ROLE_APPLICATION;
194 static AccessibleRole
195 cspi_role_from_spi_role (Accessibility_Role role)
197 /* array is sized according to IDL roles because IDL roles are the index */
198 static AccessibleRole cspi_role_table [Accessibility_ROLE_LAST_DEFINED];
199 static SPIBoolean is_initialized = FALSE;
200 AccessibleRole cspi_role;
203 is_initialized = cspi_init_role_table (cspi_role_table);
205 if (role >= 0 && role < Accessibility_ROLE_LAST_DEFINED)
207 cspi_role = cspi_role_table [role];
211 cspi_role = SPI_ROLE_EXTENDED;
217 init_state_table (Accessibility_StateType *state_table)
221 for (i = 0; i < Accessibility_STATE_LAST_DEFINED; i++)
222 state_table[i] = SPI_STATE_INVALID;
224 state_table[SPI_STATE_ACTIVE] = Accessibility_STATE_ACTIVE;
225 state_table[SPI_STATE_ARMED] = Accessibility_STATE_ARMED;
226 state_table[SPI_STATE_BUSY] = Accessibility_STATE_BUSY;
227 state_table[SPI_STATE_CHECKED] = Accessibility_STATE_CHECKED;
228 state_table[SPI_STATE_DEFUNCT] = Accessibility_STATE_DEFUNCT;
229 state_table[SPI_STATE_EDITABLE] = Accessibility_STATE_EDITABLE;
230 state_table[SPI_STATE_ENABLED] = Accessibility_STATE_ENABLED;
231 state_table[SPI_STATE_EXPANDABLE] = Accessibility_STATE_EXPANDABLE;
232 state_table[SPI_STATE_EXPANDED] = Accessibility_STATE_EXPANDED;
233 state_table[SPI_STATE_FOCUSABLE] = Accessibility_STATE_FOCUSABLE;
234 state_table[SPI_STATE_FOCUSED] = Accessibility_STATE_FOCUSED;
235 state_table[SPI_STATE_HORIZONTAL] = Accessibility_STATE_HORIZONTAL;
236 state_table[SPI_STATE_ICONIFIED] = Accessibility_STATE_ICONIFIED;
237 state_table[SPI_STATE_MODAL] = Accessibility_STATE_MODAL;
238 state_table[SPI_STATE_MULTI_LINE] = Accessibility_STATE_MULTI_LINE;
239 state_table[SPI_STATE_MULTISELECTABLE] = Accessibility_STATE_MULTISELECTABLE;
240 state_table[SPI_STATE_OPAQUE] = Accessibility_STATE_OPAQUE;
241 state_table[SPI_STATE_PRESSED] = Accessibility_STATE_PRESSED;
242 state_table[SPI_STATE_RESIZABLE] = Accessibility_STATE_RESIZABLE;
243 state_table[SPI_STATE_SELECTABLE] = Accessibility_STATE_SELECTABLE;
244 state_table[SPI_STATE_SELECTED] = Accessibility_STATE_SELECTED;
245 state_table[SPI_STATE_SENSITIVE] = Accessibility_STATE_SENSITIVE;
246 state_table[SPI_STATE_SHOWING] = Accessibility_STATE_SHOWING;
247 state_table[SPI_STATE_SINGLE_LINE] = Accessibility_STATE_SINGLE_LINE;
248 state_table[SPI_STATE_STALE] = Accessibility_STATE_STALE;
249 state_table[SPI_STATE_TRANSIENT] = Accessibility_STATE_TRANSIENT;
250 state_table[SPI_STATE_VERTICAL] = Accessibility_STATE_VERTICAL;
251 state_table[SPI_STATE_VISIBLE] = Accessibility_STATE_VISIBLE;
252 state_table[SPI_STATE_MANAGES_DESCENDANTS] = Accessibility_STATE_MANAGES_DESCENDANTS;
259 static Accessibility_StateType
260 spi_state_type_from_accessible_state (AccessibleState type)
262 static Accessibility_StateType state_table[Accessibility_STATE_LAST_DEFINED];
263 static SPIBoolean table_initialized = FALSE;
264 Accessibility_StateType rv;
266 if (!table_initialized)
267 table_initialized = init_state_table (state_table);
268 if (type > SPI_STATE_INVALID && type < SPI_STATE_LAST_DEFINED)
269 rv = state_table[type];
271 rv = Accessibility_STATE_INVALID;
279 * AccessibleRole_getName:
280 * @role: an #AccessibleRole object to query.
282 * Get a localizeable string that indicates the name of an #AccessibleRole.
283 * <em>DEPRECATED.</em>
285 * Returns: a localizable string name for an #AccessibleRole enumerated type.
288 AccessibleRole_getName (AccessibleRole role)
290 if (role < MAX_ROLES && role_names [(int) role])
292 return CORBA_string_dup (role_names [(int) role]);
296 return g_strdup ("");
302 * @obj: a pointer to the #Accessible object on which to operate.
304 * Increment the reference count for an #Accessible object.
307 Accessible_ref (Accessible *obj)
309 cspi_object_ref (obj);
314 * @obj: a pointer to the #Accessible object on which to operate.
316 * Decrement the reference count for an #Accessible object.
319 Accessible_unref (Accessible *obj)
321 cspi_object_unref (obj);
325 * Accessible_getName:
326 * @obj: a pointer to the #Accessible object on which to operate.
328 * Get the name of an #Accessible object.
330 * Returns: a UTF-8 string indicating the name of the #Accessible object.
331 * or NULL on exception
334 Accessible_getName (Accessible *obj)
338 cspi_return_val_if_fail (obj != NULL, NULL);
340 retval = Accessibility_Accessible__get_name (CSPI_OBJREF (obj), cspi_ev ());
342 cspi_return_val_if_ev ("getName", NULL);
348 * Accessible_getDescription:
349 * @obj: a pointer to the #Accessible object on which to operate.
351 * Get the description of an #Accessible object.
353 * Returns: a UTF-8 string describing the #Accessible object.
354 * or NULL on exception
357 Accessible_getDescription (Accessible *obj)
361 cspi_return_val_if_fail (obj != NULL, NULL);
363 retval = Accessibility_Accessible__get_description (CSPI_OBJREF (obj),
366 cspi_return_val_if_ev ("getDescription", NULL);
372 * Accessible_getParent:
373 * @obj: a pointer to the #Accessible object to query.
375 * Get an #Accessible object's parent container.
377 * Returns: a pointer tothe #Accessible object which contains the given
378 * #Accessible instance, or NULL if the @obj has no parent container.
382 Accessible_getParent (Accessible *obj)
386 cspi_return_val_if_fail (obj != NULL, NULL);
388 retval = cspi_object_add (
389 Accessibility_Accessible__get_parent (CSPI_OBJREF (obj),
392 cspi_return_val_if_ev ("getParent", NULL);
398 * Accessible_getChildCount:
399 * @obj: a pointer to the #Accessible object on which to operate.
401 * Get the number of children contained by an #Accessible object.
403 * Returns: a #long indicating the number of #Accessible children
404 * contained by an #Accessible object. or -1 on exception
408 Accessible_getChildCount (Accessible *obj)
412 cspi_return_val_if_fail (obj != NULL, -1);
414 retval = Accessibility_Accessible__get_childCount (CSPI_OBJREF (obj),
417 cspi_return_val_if_ev ("getChildCount", -1);
423 * Accessible_getChildAtIndex:
424 * @obj: a pointer to the #Accessible object on which to operate.
425 * @childIndex: a #long indicating which child is specified.
427 * Get the #Accessible child of an #Accessible object at a given index.
429 * Returns: a pointer to the #Accessible child object at index
430 * @childIndex. or NULL on exception
433 Accessible_getChildAtIndex (Accessible *obj,
438 cspi_return_val_if_fail (obj != NULL, NULL);
440 retval = cspi_object_add (
441 Accessibility_Accessible_getChildAtIndex (CSPI_OBJREF (obj),
442 childIndex, cspi_ev ()));
444 cspi_return_val_if_ev ("getChildAtIndex", NULL);
449 * Accessible_getIndexInParent:
450 * @obj: a pointer to the #Accessible object on which to operate.
452 * Get the index of an #Accessible object in its containing #Accessible.
454 * Returns: a #long indicating the index of the #Accessible object
455 * in its parent (i.e. containing) #Accessible instance,
456 * or -1 if @obj has no containing parent or on exception.
459 Accessible_getIndexInParent (Accessible *obj)
463 cspi_return_val_if_fail (obj != NULL, -1);
465 retval = Accessibility_Accessible_getIndexInParent (CSPI_OBJREF (obj), cspi_ev ());
467 cspi_return_val_if_ev ("getIndexInparent", -1);
472 * Accessible_getRelationSet:
473 * @obj: a pointer to the #Accessible object on which to operate.
475 * Get the set of #AccessibleRelation objects which describe this #Accessible object's
476 * relationships with other #Accessible objects.
478 * Returns: an array of #AccessibleRelation pointers. or NULL on exception
480 AccessibleRelation **
481 Accessible_getRelationSet (Accessible *obj)
485 AccessibleRelation **relations;
486 Accessibility_RelationSet *relation_set;
488 cspi_return_val_if_fail (obj != NULL, NULL);
491 Accessibility_Accessible_getRelationSet (CSPI_OBJREF (obj), cspi_ev ());
493 cspi_return_val_if_ev ("getRelationSet", NULL);
495 n_relations = relation_set->_length;
496 relations = malloc (sizeof (AccessibleRelation *) * (n_relations + 1));
498 for (i = 0; i < n_relations; ++i)
500 relations[i] = cspi_object_add (CORBA_Object_duplicate (
501 relation_set->_buffer[i], cspi_ev ()));
505 CORBA_free (relation_set);
511 * Accessible_getRole:
512 * @obj: a pointer to the #Accessible object on which to operate.
514 * Get the UI role of an #Accessible object.
515 * A UTF-8 string describing this role can be obtained via Accessible_getRoleName ().
517 * Returns: the #AccessibleRole of the object.
521 Accessible_getRole (Accessible *obj)
523 Accessibility_Role retval;
525 cspi_return_val_if_fail (obj != NULL, SPI_ROLE_INVALID);
528 Accessibility_Accessible_getRole (CSPI_OBJREF (obj), cspi_ev ());
530 cspi_return_val_if_ev ("getRole", SPI_ROLE_INVALID);
532 return cspi_role_from_spi_role (retval);
536 * Accessible_getRoleName:
537 * @obj: a pointer to the #Accessible object on which to operate.
539 * Get a UTF-8 string describing the role this object plays in the UI.
540 * This method will return useful values for roles that fall outside the
541 * enumeration used in Accessible_getRole ().
543 * Returns: a UTF-8 string specifying the role of this #Accessible object.
547 Accessible_getRoleName (Accessible *obj)
551 cspi_return_val_if_fail (obj != NULL, CORBA_string_dup ("invalid"));
554 Accessibility_Accessible_getRoleName (CSPI_OBJREF (obj), cspi_ev ());
556 cspi_return_val_if_ev ("getRoleName", CORBA_string_dup ("invalid"));
562 * Accessible_getStateSet:
563 * @obj: a pointer to the #Accessible object on which to operate.
565 * Not Yet Implemented.
567 * Returns: a pointer to an #AccessibleStateSet representing the object's current state.
570 Accessible_getStateSet (Accessible *obj)
572 AccessibleStateSet *retval;
574 cspi_return_val_if_fail (obj != NULL, NULL);
576 retval = cspi_object_add (
577 Accessibility_Accessible_getState (CSPI_OBJREF (obj),
580 cspi_return_val_if_ev ("getState", NULL);
584 /* Interface query methods */
587 * Accessible_isAction:
588 * @obj: a pointer to the #Accessible instance to query.
590 * Query whether the specified #Accessible implements #AccessibleAction.
592 * Returns: #TRUE if @obj implements the #AccessibleAction interface,
596 Accessible_isAction (Accessible *obj)
598 return cspi_accessible_is_a (obj,
599 "IDL:Accessibility/Action:1.0");
603 * Accessible_isApplication:
604 * @obj: a pointer to the #Accessible instance to query.
606 * Query whether the specified #Accessible implements #AccessibleApplication.
608 * Returns: #TRUE if @obj implements the #AccessibleApplication interface,
612 Accessible_isApplication (Accessible *obj)
614 return cspi_accessible_is_a (obj,
615 "IDL:Accessibility/Application:1.0");
619 * Accessible_isComponent:
620 * @obj: a pointer to the #Accessible instance to query.
622 * Query whether the specified #Accessible implements #AccessibleComponent.
624 * Returns: #TRUE if @obj implements the #AccessibleComponent interface,
628 Accessible_isComponent (Accessible *obj)
630 return cspi_accessible_is_a (obj,
631 "IDL:Accessibility/Component:1.0");
635 * Accessible_isEditableText:
636 * @obj: a pointer to the #Accessible instance to query.
638 * Query whether the specified #Accessible implements #AccessibleEditableText.
640 * Returns: #TRUE if @obj implements the #AccessibleEditableText interface,
644 Accessible_isEditableText (Accessible *obj)
646 return cspi_accessible_is_a (obj,
647 "IDL:Accessibility/EditableText:1.0");
651 * Accessible_isHypertext:
652 * @obj: a pointer to the #Accessible instance to query.
654 * Query whether the specified #Accessible implements #AccessibleHypertext.
656 * Returns: #TRUE if @obj implements the #AccessibleHypertext interface,
660 Accessible_isHypertext (Accessible *obj)
662 return cspi_accessible_is_a (obj,
663 "IDL:Accessibility/Hypertext:1.0");
667 * Accessible_isImage:
668 * @obj: a pointer to the #Accessible instance to query.
670 * Query whether the specified #Accessible implements #AccessibleImage.
672 * Returns: #TRUE if @obj implements the #AccessibleImage interface,
676 Accessible_isImage (Accessible *obj)
678 return cspi_accessible_is_a (obj,
679 "IDL:Accessibility/Image:1.0");
683 * Accessible_isSelection:
684 * @obj: a pointer to the #Accessible instance to query.
686 * Query whether the specified #Accessible implements #AccessibleSelection.
688 * Returns: #TRUE if @obj implements the #AccessibleSelection interface,
692 Accessible_isSelection (Accessible *obj)
694 return cspi_accessible_is_a (obj,
695 "IDL:Accessibility/Selection:1.0");
699 * Accessible_isTable:
700 * @obj: a pointer to the #Accessible instance to query.
702 * Query whether the specified #Accessible implements #AccessibleTable.
704 * Returns: #TRUE if @obj implements the #AccessibleTable interface,
708 Accessible_isTable (Accessible *obj)
710 return cspi_accessible_is_a (obj,
711 "IDL:Accessibility/Table:1.0");
715 * Accessible_isStreamableContent:
716 * @obj: a pointer to the #Accessible instance to query.
718 * Query whether the specified #Accessible implements
719 * #AccessibleStreamableContent.
721 * Returns: #TRUE if @obj implements the #AccessibleStreamableContent interface,
725 Accessible_isStreamableContent (Accessible *obj)
727 return cspi_accessible_is_a (obj,
728 "IDL:Accessibility/StreamableContent:1.0");
733 * @obj: a pointer to the #Accessible instance to query.
735 * Query whether the specified #Accessible implements #AccessibleText.
737 * Returns: #TRUE if @obj implements the #AccessibleText interface,
741 Accessible_isText (Accessible *obj)
743 return cspi_accessible_is_a (obj,
744 "IDL:Accessibility/Text:1.0");
748 * Accessible_isValue:
749 * @obj: a pointer to the #Accessible instance to query.
751 * Query whether the specified #Accessible implements #AccessibleValue.
753 * Returns: #TRUE if @obj implements the #AccessibleValue interface,
757 Accessible_isValue (Accessible *obj)
759 return cspi_accessible_is_a (obj,
760 "IDL:Accessibility/Value:1.0");
764 * Accessible_getApplication:
765 * @obj: a pointer to the #Accessible instance to query.
767 * Get the #AccessibleApplication interface for an #Accessible.
769 * Returns: a pointer to an #AccessibleApplication interface instance, or
770 * NULL if @obj does not implement #AccessibleApplication.
772 AccessibleApplication *
773 Accessible_getApplication (Accessible *obj)
775 return (AccessibleApplication *) Accessible_queryInterface (
776 obj, "IDL:Accessibility/Application:1.0");
780 * Accessible_getAction:
781 * @obj: a pointer to the #Accessible instance to query.
783 * Get the #AccessibleAction interface for an #Accessible.
785 * Returns: a pointer to an #AccessibleAction interface instance, or
786 * NULL if @obj does not implement #AccessibleAction.
789 Accessible_getAction (Accessible *obj)
791 return (AccessibleAction *) Accessible_queryInterface (
792 obj, "IDL:Accessibility/Action:1.0");
796 * Accessible_getComponent:
797 * @obj: a pointer to the #Accessible instance to query.
799 * Get the #AccessibleComponent interface for an #Accessible.
801 * Returns: a pointer to an #AccessibleComponent interface instance, or
802 * NULL if @obj does not implement #AccessibleComponent.
804 AccessibleComponent *
805 Accessible_getComponent (Accessible *obj)
807 return (AccessibleComponent *) Accessible_queryInterface (
808 obj, "IDL:Accessibility/Component:1.0");
812 * Accessible_getEditableText:
813 * @obj: a pointer to the #Accessible instance to query.
815 * Get the #AccessibleEditableText interface for an #Accessible.
817 * Returns: a pointer to an #AccessibleEditableText interface instance, or
818 * NULL if @obj does not implement #AccessibleEditableText.
820 AccessibleEditableText *
821 Accessible_getEditableText (Accessible *obj)
823 return (AccessibleEditableText *) Accessible_queryInterface (
824 obj, "IDL:Accessibility/EditableText:1.0");
830 * Accessible_getHypertext:
831 * @obj: a pointer to the #Accessible instance to query.
833 * Get the #AccessibleHypertext interface for an #Accessible.
835 * Returns: a pointer to an #AccessibleHypertext interface instance, or
836 * NULL if @obj does not implement #AccessibleHypertext.
838 AccessibleHypertext *
839 Accessible_getHypertext (Accessible *obj)
841 return (AccessibleHypertext *) Accessible_queryInterface (
842 obj, "IDL:Accessibility/Hypertext:1.0");
848 * Accessible_getImage:
849 * @obj: a pointer to the #Accessible instance to query.
851 * Get the #AccessibleImage interface for an #Accessible.
853 * Returns: a pointer to an #AccessibleImage interface instance, or
854 * NULL if @obj does not implement #AccessibleImage.
857 Accessible_getImage (Accessible *obj)
859 return (AccessibleImage *) Accessible_queryInterface (
860 obj, "IDL:Accessibility/Image:1.0");
866 * Accessible_getSelection:
867 * @obj: a pointer to the #Accessible instance to query.
869 * Get the #AccessibleSelection interface for an #Accessible.
871 * Returns: a pointer to an #AccessibleSelection interface instance, or
872 * NULL if @obj does not implement #AccessibleSelection.
874 AccessibleSelection *
875 Accessible_getSelection (Accessible *obj)
877 return (AccessibleSelection *) Accessible_queryInterface (
878 obj, "IDL:Accessibility/Selection:1.0");
884 * Accessible_getStreamableContent:
885 * @obj: a pointer to the #Accessible instance to query.
887 * Get the #AccessibleStreamableContent interface for an #Accessible.
889 * Returns: a pointer to an #AccessibleStreamableContent interface instance, or
890 * NULL if @obj does not implement #AccessibleStreamableContent.
892 AccessibleStreamableContent *
893 Accessible_getStreamableContent (Accessible *obj)
895 return (AccessibleStreamableContent *) Accessible_queryInterface (
896 obj, "IDL:Accessibility/StreamableContent:1.0");
900 * Accessible_getTable:
901 * @obj: a pointer to the #Accessible instance to query.
903 * Get the #AccessibleTable interface for an #Accessible.
905 * Returns: a pointer to an #AccessibleTable interface instance, or
906 * NULL if @obj does not implement #AccessibleTable.
909 Accessible_getTable (Accessible *obj)
911 return (AccessibleTable *) Accessible_queryInterface (
912 obj, "IDL:Accessibility/Table:1.0");
916 * Accessible_getText:
917 * @obj: a pointer to the #Accessible instance to query.
919 * Get the #AccessibleText interface for an #Accessible.
921 * Returns: a pointer to an #AccessibleText interface instance, or
922 * NULL if @obj does not implement #AccessibleText.
925 Accessible_getText (Accessible *obj)
927 return (AccessibleText *) Accessible_queryInterface (
928 obj, "IDL:Accessibility/Text:1.0");
934 * Accessible_getValue:
935 * @obj: a pointer to the #Accessible instance to query.
937 * Get the #AccessibleValue interface for an #Accessible.
939 * Returns: a pointer to an #AccessibleValue interface instance, or
940 * NULL if @obj does not implement #AccessibleValue.
943 Accessible_getValue (Accessible *obj)
945 return (AccessibleValue *) Accessible_queryInterface (
946 obj, "IDL:Accessibility/Value:1.0");
952 * Accessible_queryInterface:
953 * @obj: a pointer to the #Accessible instance to query.
954 * @interface_name: a UTF-8 character string specifiying the requested interface.
956 * Query an #Accessible object to for a named interface.
958 * Returns: an instance of the named interface object, if it is implemented
959 * by @obj, or NULL otherwise.
963 Accessible_queryInterface (Accessible *obj,
964 const char *interface_name)
966 Bonobo_Unknown iface;
973 iface = Accessibility_Accessible_queryInterface (CSPI_OBJREF (obj),
978 cspi_return_val_if_ev ("queryInterface", NULL);
981 * FIXME: we need to be fairly sure that references are going
982 * to mach up if we are going to expose QueryInterface, ie. we
983 * can't allow people to do:
984 * b = a.qi ("b"); b.unref, b.unref to release a's reference.
985 * this should be no real problem though for this level of API
989 return cspi_object_add (iface);
994 * AccessibleRelation_ref:
995 * @obj: a pointer to the #AccessibleRelation object on which to operate.
997 * Increment the reference count for an #AccessibleRelation object.
1001 AccessibleRelation_ref (AccessibleRelation *obj)
1003 cspi_object_ref (obj);
1007 * AccessibleRelation_unref:
1008 * @obj: a pointer to the #AccessibleRelation object on which to operate.
1010 * Decrement the reference count for an #AccessibleRelation object.
1014 AccessibleRelation_unref (AccessibleRelation *obj)
1016 cspi_object_unref (obj);
1020 * AccessibleRelation_getRelationType:
1021 * @obj: a pointer to the #AccessibleRelation object to query.
1023 * Get the type of relationship represented by an #AccessibleRelation.
1025 * Returns: an #AccessibleRelationType indicating the type of relation
1026 * encapsulated in this #AccessibleRelation object.
1029 AccessibleRelationType
1030 AccessibleRelation_getRelationType (AccessibleRelation *obj)
1032 AccessibleRelationType retval;
1034 cspi_return_val_if_fail (obj, SPI_RELATION_NULL);
1036 Accessibility_Relation_getRelationType (CSPI_OBJREF (obj), cspi_ev());
1037 cspi_return_val_if_ev ("getRelationType", SPI_RELATION_NULL);
1042 * AccessibleRelation_getNTargets:
1043 * @obj: a pointer to the #AccessibleRelation object to query.
1045 * Get the number of objects which this relationship has as its
1046 * target objects (the subject is the #Accessible from which this
1047 * #AccessibleRelation originated).
1049 * Returns: a short integer indicating how many target objects which the
1050 * originating #Accessible object has the #AccessibleRelation
1051 * relationship with.
1054 AccessibleRelation_getNTargets (AccessibleRelation *obj)
1058 cspi_return_val_if_fail (obj, -1);
1059 retval = Accessibility_Relation_getNTargets (CSPI_OBJREF (obj), cspi_ev());
1060 cspi_return_val_if_ev ("getNTargets", -1);
1065 * AccessibleRelation_getTarget:
1066 * @obj: a pointer to the #AccessibleRelation object to query.
1067 * @i: a (zero-index) integer indicating which (of possibly several) target is requested.
1069 * Get the @i-th target of a specified #AccessibleRelation relationship.
1071 * Returns: an #Accessible which is the @i-th object with which the
1072 * originating #Accessible has relationship specified in the
1073 * #AccessibleRelation object.
1077 AccessibleRelation_getTarget (AccessibleRelation *obj, int i)
1081 cspi_return_val_if_fail (obj, NULL);
1083 retval = cspi_object_add (
1084 Accessibility_Relation_getTarget (CSPI_OBJREF(obj),
1086 cspi_return_val_if_ev ("getTarget", NULL);
1091 * AccessibleStateSet_ref:
1092 * @obj: a pointer to the #AccessibleStateSet object on which to operate.
1094 * Increment the reference count for an #AccessibleStateSet object.
1098 AccessibleStateSet_ref (AccessibleStateSet *obj)
1100 cspi_object_ref (obj);
1104 * AccessibleStateSet_unref:
1105 * @obj: a pointer to the #AccessibleStateSet object on which to operate.
1107 * Decrement the reference count for an #AccessibleStateSet object.
1111 AccessibleStateSet_unref (AccessibleStateSet *obj)
1113 cspi_object_unref (obj);
1117 * AccessibleStateSet_contains:
1118 * @obj: a pointer to the #AccessibleStateSet object on which to operate.
1119 * @state: an #AccessibleState for which the specified #AccessibleStateSet
1122 * Determine whether a given #AccessibleStateSet includes a given state; that is,
1123 * whether @state is true for the stateset in question.
1125 * Returns: #TRUE if @state is true/included in the given #AccessibleStateSet,
1130 AccessibleStateSet_contains (AccessibleStateSet *obj,
1131 AccessibleState state)
1133 CORBA_boolean retval;
1134 Accessibility_StateType spi_state;
1136 cspi_return_val_if_fail (obj != NULL, FALSE);
1138 spi_state = spi_state_type_from_accessible_state (state);
1139 retval = Accessibility_StateSet_contains (CSPI_OBJREF (obj),
1140 spi_state, cspi_ev ());
1142 cspi_return_val_if_ev ("contains", FALSE);
1148 * AccessibleStateSet_add:
1149 * @obj: a pointer to the #AccessibleStateSet object on which to operate.
1150 * @state: an #AccessibleState to be added to the specified #AccessibleStateSet
1152 * Add a particular #AccessibleState to an #AccessibleStateSet (i.e. set the
1153 * given state to #TRUE in the stateset.
1157 AccessibleStateSet_add (AccessibleStateSet *obj,
1158 AccessibleState state)
1160 Accessibility_StateType spi_state;
1162 cspi_return_if_fail (obj != NULL);
1164 spi_state = spi_state_type_from_accessible_state (state);
1165 Accessibility_StateSet_add (CSPI_OBJREF (obj), spi_state, cspi_ev ());
1166 cspi_check_ev ("StateSet_add");
1170 * AccessibleStateSet_remove:
1171 * @obj: a pointer to the #AccessibleStateSet object on which to operate.
1172 * @state: an #AccessibleState to be removed from the specified #AccessibleStateSet
1174 * Remove a particular #AccessibleState to an #AccessibleStateSet (i.e. set the
1175 * given state to #FALSE in the stateset.)
1179 AccessibleStateSet_remove (AccessibleStateSet *obj,
1180 AccessibleState state)
1182 Accessibility_StateType spi_state;
1184 cspi_return_if_fail (obj != NULL);
1186 spi_state = spi_state_type_from_accessible_state (state);
1187 Accessibility_StateSet_remove (CSPI_OBJREF (obj), spi_state, cspi_ev ());
1188 cspi_check_ev ("StateSet_remove");
1192 * AccessibleStateSet_equals:
1193 * @obj: a pointer to the first #AccessibleStateSet object on which to operate.
1194 * @obj2: a pointer to the second #AccessibleStateSet object on which to operate.
1196 * Determine whether two instances of #AccessibleStateSet are equivalent (i.e.
1197 * consist of the same #AccessibleStates). Useful for checking multiple
1198 * state variables at once; construct the target state then compare against it.
1200 * @see AccessibleStateSet_compare().
1202 * Returns: #TRUE if the two #AccessibleStateSets are equivalent,
1207 AccessibleStateSet_equals (AccessibleStateSet *obj,
1208 AccessibleStateSet *obj2)
1215 cspi_return_val_if_fail (obj != NULL, FALSE);
1216 cspi_return_val_if_fail (obj2 != NULL, FALSE);
1218 return Accessibility_StateSet_equals (CSPI_OBJREF (obj),
1219 CSPI_OBJREF (obj2), cspi_ev ());
1223 * AccessibleStateSet_compare:
1224 * @obj: a pointer to the first #AccessibleStateSet object on which to operate.
1225 * @obj2: a pointer to the second #AccessibleStateSet object on which to operate.
1227 * Determine the differences between two instances of #AccessibleStateSet.
1228 * Not Yet Implemented.
1230 * @see AccessibleStateSet_equals().
1232 * Returns: an #AccessibleStateSet object containing all states contained on one of
1233 * the two sets but not the other.
1236 AccessibleStateSet *
1237 AccessibleStateSet_compare (AccessibleStateSet *obj,
1238 AccessibleStateSet *obj2)
1240 AccessibleStateSet *retval;
1242 cspi_return_val_if_fail (obj != NULL, NULL);
1243 cspi_return_val_if_fail (obj2 != NULL, NULL);
1244 retval = cspi_object_add (
1245 Accessibility_StateSet_compare (CSPI_OBJREF(obj), CSPI_OBJREF(obj2), cspi_ev ()));
1247 cspi_return_val_if_ev ("compare", NULL);
1252 * AccessibleStateSet_isEmpty:
1253 * @obj: a pointer to the #AccessibleStateSet object on which to operate.
1255 * Determine whether a given #AccessibleStateSet is the empty set.
1257 * Returns: #TRUE if the given #AccessibleStateSet contains no (true) states,
1262 AccessibleStateSet_isEmpty (AccessibleStateSet *obj)
1264 CORBA_boolean retval;
1266 cspi_return_val_if_fail (obj != NULL, FALSE);
1267 retval = Accessibility_StateSet_isEmpty (CSPI_OBJREF (obj), cspi_ev ());
1269 cspi_return_val_if_ev ("isEmpty", TRUE);