1 #include <stdlib.h> /* for malloc */
2 #include <cspi/spi-private.h>
4 static const char *role_names [] =
61 "table column header",
76 #define MAX_ROLES (sizeof (role_names) / sizeof (char *))
79 cspi_init_role_table (AccessibleRole *role_table)
82 for (i = 0; i < Accessibility_ROLE_LAST_DEFINED; ++i)
84 role_table [i] = SPI_ROLE_UNKNOWN;
86 role_table [Accessibility_ROLE_INVALID] = SPI_ROLE_INVALID;
87 role_table [Accessibility_ROLE_ACCELERATOR_LABEL] = SPI_ROLE_ACCEL_LABEL;
88 role_table [Accessibility_ROLE_ALERT] = SPI_ROLE_ALERT;
89 role_table [Accessibility_ROLE_ANIMATION] = SPI_ROLE_ANIMATION;
90 role_table [Accessibility_ROLE_ARROW] = SPI_ROLE_ARROW;
91 role_table [Accessibility_ROLE_CALENDAR] = SPI_ROLE_CALENDAR;
92 role_table [Accessibility_ROLE_CANVAS] = SPI_ROLE_CANVAS;
93 role_table [Accessibility_ROLE_CHECK_BOX] = SPI_ROLE_CHECK_BOX;
94 role_table [Accessibility_ROLE_COLOR_CHOOSER] = SPI_ROLE_COLOR_CHOOSER;
95 role_table [Accessibility_ROLE_COLUMN_HEADER] = SPI_ROLE_COLUMN_HEADER;
96 role_table [Accessibility_ROLE_COMBO_BOX] = SPI_ROLE_COMBO_BOX;
97 role_table [Accessibility_ROLE_DATE_EDITOR] = SPI_ROLE_DATE_EDITOR;
98 role_table [Accessibility_ROLE_DESKTOP_ICON] = SPI_ROLE_DESKTOP_ICON;
99 role_table [Accessibility_ROLE_DESKTOP_FRAME] = SPI_ROLE_DESKTOP_FRAME;
100 role_table [Accessibility_ROLE_DIAL] = SPI_ROLE_DIAL;
101 role_table [Accessibility_ROLE_DIALOG] = SPI_ROLE_DIALOG;
102 role_table [Accessibility_ROLE_DIRECTORY_PANE] = SPI_ROLE_DIRECTORY_PANE;
103 role_table [Accessibility_ROLE_FILE_CHOOSER] = SPI_ROLE_FILE_CHOOSER;
104 role_table [Accessibility_ROLE_FILLER] = SPI_ROLE_FILLER;
105 role_table [Accessibility_ROLE_FONT_CHOOSER] = SPI_ROLE_FONT_CHOOSER;
106 role_table [Accessibility_ROLE_FRAME] = SPI_ROLE_FRAME;
107 role_table [Accessibility_ROLE_GLASS_PANE] = SPI_ROLE_GLASS_PANE;
108 role_table [Accessibility_ROLE_HTML_CONTAINER] = SPI_ROLE_HTML_CONTAINER;
109 role_table [Accessibility_ROLE_ICON] = SPI_ROLE_ICON;
110 role_table [Accessibility_ROLE_IMAGE] = SPI_ROLE_IMAGE;
111 role_table [Accessibility_ROLE_INTERNAL_FRAME] = SPI_ROLE_INTERNAL_FRAME;
112 role_table [Accessibility_ROLE_LABEL] = SPI_ROLE_LABEL;
113 role_table [Accessibility_ROLE_LAYERED_PANE] = SPI_ROLE_LAYERED_PANE;
114 role_table [Accessibility_ROLE_LIST] = SPI_ROLE_LIST;
115 role_table [Accessibility_ROLE_LIST_ITEM] = SPI_ROLE_LIST_ITEM;
116 role_table [Accessibility_ROLE_MENU] = SPI_ROLE_MENU;
117 role_table [Accessibility_ROLE_MENU_BAR] = SPI_ROLE_MENU_BAR;
118 role_table [Accessibility_ROLE_MENU_ITEM] = SPI_ROLE_MENU_ITEM;
119 role_table [Accessibility_ROLE_OPTION_PANE] = SPI_ROLE_OPTION_PANE;
120 role_table [Accessibility_ROLE_PAGE_TAB] = SPI_ROLE_PAGE_TAB;
121 role_table [Accessibility_ROLE_PAGE_TAB_LIST] = SPI_ROLE_PAGE_TAB_LIST;
122 role_table [Accessibility_ROLE_PANEL] = SPI_ROLE_PANEL;
123 role_table [Accessibility_ROLE_PASSWORD_TEXT] = SPI_ROLE_PASSWORD_TEXT;
124 role_table [Accessibility_ROLE_POPUP_MENU] = SPI_ROLE_POPUP_MENU;
125 role_table [Accessibility_ROLE_PROGRESS_BAR] = SPI_ROLE_PROGRESS_BAR;
126 role_table [Accessibility_ROLE_PUSH_BUTTON] = SPI_ROLE_PUSH_BUTTON;
127 role_table [Accessibility_ROLE_RADIO_BUTTON] = SPI_ROLE_RADIO_BUTTON;
128 role_table [Accessibility_ROLE_RADIO_MENU_ITEM] = SPI_ROLE_RADIO_MENU_ITEM;
129 role_table [Accessibility_ROLE_ROOT_PANE] = SPI_ROLE_ROOT_PANE;
130 role_table [Accessibility_ROLE_ROW_HEADER] = SPI_ROLE_ROW_HEADER;
131 role_table [Accessibility_ROLE_SCROLL_BAR] = SPI_ROLE_SCROLL_BAR;
132 role_table [Accessibility_ROLE_SCROLL_PANE] = SPI_ROLE_SCROLL_PANE;
133 role_table [Accessibility_ROLE_SEPARATOR] = SPI_ROLE_SEPARATOR;
134 role_table [Accessibility_ROLE_SLIDER] = SPI_ROLE_SLIDER;
135 role_table [Accessibility_ROLE_SPIN_BUTTON] = SPI_ROLE_SPIN_BUTTON;
136 role_table [Accessibility_ROLE_SPLIT_PANE] = SPI_ROLE_SPLIT_PANE;
137 role_table [Accessibility_ROLE_STATUS_BAR] = SPI_ROLE_STATUS_BAR;
138 role_table [Accessibility_ROLE_TABLE] = SPI_ROLE_TABLE;
139 role_table [Accessibility_ROLE_TABLE_CELL] = SPI_ROLE_TABLE_CELL;
140 role_table [Accessibility_ROLE_TEAROFF_MENU_ITEM] = SPI_ROLE_TEAROFF_MENU_ITEM;
141 role_table [Accessibility_ROLE_TEXT] = SPI_ROLE_TEXT;
142 role_table [Accessibility_ROLE_TOGGLE_BUTTON] = SPI_ROLE_TOGGLE_BUTTON;
143 role_table [Accessibility_ROLE_TOOL_BAR] = SPI_ROLE_TOOL_BAR;
144 role_table [Accessibility_ROLE_TOOL_TIP] = SPI_ROLE_TOOL_TIP;
145 role_table [Accessibility_ROLE_TREE] = SPI_ROLE_TREE;
146 role_table [Accessibility_ROLE_TREE_TABLE] = SPI_ROLE_TREE_TABLE;
147 role_table [Accessibility_ROLE_UNKNOWN] = SPI_ROLE_UNKNOWN;
148 role_table [Accessibility_ROLE_VIEWPORT] = SPI_ROLE_VIEWPORT;
149 role_table [Accessibility_ROLE_WINDOW] = SPI_ROLE_WINDOW;
150 role_table [Accessibility_ROLE_EXTENDED] = SPI_ROLE_EXTENDED;
151 role_table [Accessibility_ROLE_LAST_DEFINED] = SPI_ROLE_EXTENDED;
156 static AccessibleRole
157 cspi_role_from_spi_role (Accessibility_Role role)
159 /* array is sized according to IDL roles because IDL roles are the index */
160 static AccessibleRole cspi_role_table [Accessibility_ROLE_LAST_DEFINED];
161 static SPIBoolean is_initialized = FALSE;
162 AccessibleRole cspi_role;
165 is_initialized = cspi_init_role_table (cspi_role_table);
167 if (role >= 0 && role < Accessibility_ROLE_LAST_DEFINED)
169 cspi_role = cspi_role_table [role];
173 cspi_role = SPI_ROLE_EXTENDED;
179 * AccessibleRole_getName:
180 * @role: an #AccessibleRole object to query.
182 * Get a localizeable string that indicates the name of an #AccessibleRole.
183 * <em>DEPRECATED.</em>
185 * Returns: a localizable string name for an #AccessibleRole enumerated type.
188 AccessibleRole_getName (AccessibleRole role)
190 if (role < MAX_ROLES)
192 return g_strdup (role_names [(int) role]);
196 return g_strdup ("");
202 * @obj: a pointer to the #Accessible object on which to operate.
204 * Increment the reference count for an #Accessible object.
207 Accessible_ref (Accessible *obj)
209 cspi_object_ref (obj);
214 * @obj: a pointer to the #Accessible object on which to operate.
216 * Decrement the reference count for an #Accessible object.
219 Accessible_unref (Accessible *obj)
221 cspi_object_unref (obj);
225 * Accessible_getName:
226 * @obj: a pointer to the #Accessible object on which to operate.
228 * Get the name of an #Accessible object.
230 * Returns: a UTF-8 string indicating the name of the #Accessible object.
231 * or NULL on exception
234 Accessible_getName (Accessible *obj)
238 cspi_return_val_if_fail (obj != NULL, NULL);
241 Accessibility_Accessible__get_name (CSPI_OBJREF (obj), cspi_ev ());
243 cspi_return_val_if_ev ("getName", NULL);
249 * Accessible_getDescription:
250 * @obj: a pointer to the #Accessible object on which to operate.
252 * Get the description of an #Accessible object.
254 * Returns: a UTF-8 string describing the #Accessible object.
255 * or NULL on exception
258 Accessible_getDescription (Accessible *obj)
262 cspi_return_val_if_fail (obj != NULL, NULL);
265 Accessibility_Accessible__get_description (CSPI_OBJREF (obj),
268 cspi_return_val_if_ev ("getDescription", NULL);
274 * Accessible_getParent:
275 * @obj: a pointer to the #Accessible object to query.
277 * Get an #Accessible object's parent container.
279 * Returns: a pointer tothe #Accessible object which contains the given
280 * #Accessible instance, or NULL if the @obj has no parent container.
284 Accessible_getParent (Accessible *obj)
288 cspi_return_val_if_fail (obj != NULL, NULL);
290 retval = cspi_object_add (
291 Accessibility_Accessible__get_parent (CSPI_OBJREF (obj),
294 cspi_return_val_if_ev ("getParent", NULL);
300 * Accessible_getChildCount:
301 * @obj: a pointer to the #Accessible object on which to operate.
303 * Get the number of children contained by an #Accessible object.
305 * Returns: a #long indicating the number of #Accessible children
306 * contained by an #Accessible object. or -1 on exception
310 Accessible_getChildCount (Accessible *obj)
314 cspi_return_val_if_fail (obj != NULL, -1);
317 Accessibility_Accessible__get_childCount (CSPI_OBJREF (obj),
320 cspi_return_val_if_ev ("getChildCount", -1);
326 * Accessible_getChildAtIndex:
327 * @obj: a pointer to the #Accessible object on which to operate.
328 * @childIndex: a #long indicating which child is specified.
330 * Get the #Accessible child of an #Accessible object at a given index.
332 * Returns: a pointer to the #Accessible child object at index
333 * @childIndex. or NULL on exception
336 Accessible_getChildAtIndex (Accessible *obj,
341 cspi_return_val_if_fail (obj != NULL, NULL);
343 retval = cspi_object_add (
344 Accessibility_Accessible_getChildAtIndex (CSPI_OBJREF (obj),
345 childIndex, cspi_ev ()));
351 * Accessible_getIndexInParent:
352 * @obj: a pointer to the #Accessible object on which to operate.
354 * Get the index of an #Accessible object in its containing #Accessible.
356 * Returns: a #long indicating the index of the #Accessible object
357 * in its parent (i.e. containing) #Accessible instance,
358 * or -1 if @obj has no containing parent or on exception.
361 Accessible_getIndexInParent (Accessible *obj)
365 cspi_return_val_if_fail (obj != NULL, -1);
368 Accessibility_Accessible_getIndexInParent (CSPI_OBJREF (obj), cspi_ev ());
370 cspi_return_val_if_ev ("getIndexInparent", -1);
375 * Accessible_getRelationSet:
376 * @obj: a pointer to the #Accessible object on which to operate.
378 * Get the set of #AccessibleRelation objects which describe this #Accessible object's
379 * relationships with other #Accessible objects.
381 * Returns: an array of #AccessibleRelation pointers. or NULL on exception
383 AccessibleRelation **
384 Accessible_getRelationSet (Accessible *obj)
388 AccessibleRelation **relations;
389 Accessibility_RelationSet *relation_set;
391 cspi_return_val_if_fail (obj != NULL, NULL);
394 Accessibility_Accessible_getRelationSet (CSPI_OBJREF (obj), cspi_ev ());
396 cspi_return_val_if_ev ("getRelationSet", NULL);
398 /* this looks hack-ish, but it's based on the CORBA C bindings spec */
399 n_relations = relation_set->_length;
400 relations = malloc (sizeof (AccessibleRelation *) * n_relations);
402 for (i = 0; i < n_relations; ++i)
404 relations[i] = cspi_object_add (CORBA_Object_duplicate (
405 relation_set->_buffer[i], cspi_ev ()));
407 relations[i] = CORBA_OBJECT_NIL;
409 CORBA_free (relation_set);
415 * Accessible_getRole:
416 * @obj: a pointer to the #Accessible object on which to operate.
418 * Get the UI role of an #Accessible object.
419 * A UTF-8 string describing this role can be obtained via Accessible_getRoleName ().
421 * Returns: the #AccessibleRole of the object.
425 Accessible_getRole (Accessible *obj)
427 AccessibleRole retval;
429 cspi_return_val_if_fail (obj != NULL, SPI_ROLE_INVALID);
432 Accessibility_Accessible_getRole (CSPI_OBJREF (obj), cspi_ev ());
434 cspi_return_val_if_ev ("getRole", SPI_ROLE_INVALID);
436 return cspi_role_from_spi_role (retval);
440 * Accessible_getRoleName:
441 * @obj: a pointer to the #Accessible object on which to operate.
443 * Get a UTF-8 string describing the role this object plays in the UI.
444 * This method will return useful values for roles that fall outside the
445 * enumeration used in Accessible_getRole ().
447 * Returns: a UTF-8 string specifying the role of this #Accessible object.
451 Accessible_getRoleName (Accessible *obj)
455 cspi_return_val_if_fail (obj != NULL, CORBA_string_dup ("invalid"));
458 Accessibility_Accessible_getRoleName (CSPI_OBJREF (obj), cspi_ev ());
460 cspi_return_val_if_ev ("getRoleName", CORBA_string_dup ("invalid"));
466 * Accessible_getStateSet:
467 * @obj: a pointer to the #Accessible object on which to operate.
469 * Not Yet Implemented.
471 * Returns: a pointer to an #AccessibleStateSet representing the object's current state.
474 Accessible_getStateSet (Accessible *obj)
479 /* Interface query methods */
482 * Accessible_isAction:
483 * @obj: a pointer to the #Accessible instance to query.
485 * Query whether the specified #Accessible implements #AccessibleAction.
487 * Returns: #TRUE if @obj implements the #AccessibleAction interface,
491 Accessible_isAction (Accessible *obj)
493 return cspi_accessible_is_a (obj,
494 "IDL:Accessibility/Action:1.0");
498 * Accessible_isApplication:
499 * @obj: a pointer to the #Accessible instance to query.
501 * Query whether the specified #Accessible implements #AccessibleApplication.
503 * Returns: #TRUE if @obj implements the #AccessibleApplication interface,
507 Accessible_isApplication (Accessible *obj)
509 return cspi_accessible_is_a (obj,
510 "IDL:Accessibility/Application:1.0");
514 * Accessible_isComponent:
515 * @obj: a pointer to the #Accessible instance to query.
517 * Query whether the specified #Accessible implements #AccessibleComponent.
519 * Returns: #TRUE if @obj implements the #AccessibleComponent interface,
523 Accessible_isComponent (Accessible *obj)
525 return cspi_accessible_is_a (obj,
526 "IDL:Accessibility/Component:1.0");
530 * Accessible_isEditableText:
531 * @obj: a pointer to the #Accessible instance to query.
533 * Query whether the specified #Accessible implements #AccessibleEditableText.
535 * Returns: #TRUE if @obj implements the #AccessibleEditableText interface,
539 Accessible_isEditableText (Accessible *obj)
541 return cspi_accessible_is_a (obj,
542 "IDL:Accessibility/EditableText:1.0");
546 * Accessible_isHypertext:
547 * @obj: a pointer to the #Accessible instance to query.
549 * Query whether the specified #Accessible implements #AccessibleHypertext.
551 * Returns: #TRUE if @obj implements the #AccessibleHypertext interface,
555 Accessible_isHypertext (Accessible *obj)
557 return cspi_accessible_is_a (obj,
558 "IDL:Accessibility/Hypertext:1.0");
562 * Accessible_isImage:
563 * @obj: a pointer to the #Accessible instance to query.
565 * Query whether the specified #Accessible implements #AccessibleImage.
567 * Returns: #TRUE if @obj implements the #AccessibleImage interface,
571 Accessible_isImage (Accessible *obj)
573 return cspi_accessible_is_a (obj,
574 "IDL:Accessibility/Image:1.0");
578 * Accessible_isSelection:
579 * @obj: a pointer to the #Accessible instance to query.
581 * Query whether the specified #Accessible implements #AccessibleSelection.
583 * Returns: #TRUE if @obj implements the #AccessibleSelection interface,
587 Accessible_isSelection (Accessible *obj)
589 return cspi_accessible_is_a (obj,
590 "IDL:Accessibility/Selection:1.0");
594 * Accessible_isTable:
595 * @obj: a pointer to the #Accessible instance to query.
597 * Query whether the specified #Accessible implements #AccessibleTable.
599 * Returns: #TRUE if @obj implements the #AccessibleTable interface,
603 Accessible_isTable (Accessible *obj)
605 return cspi_accessible_is_a (obj,
606 "IDL:Accessibility/Table:1.0");
610 * Accessible_isStreamableContent:
611 * @obj: a pointer to the #Accessible instance to query.
613 * Query whether the specified #Accessible implements
614 * #AccessibleStreamableContent.
616 * Returns: #TRUE if @obj implements the #AccessibleStreamableContent interface,
620 Accessible_isStreamableContent (Accessible *obj)
622 return cspi_accessible_is_a (obj,
623 "IDL:Accessibility/StreamableContent:1.0");
628 * @obj: a pointer to the #Accessible instance to query.
630 * Query whether the specified #Accessible implements #AccessibleText.
632 * Returns: #TRUE if @obj implements the #AccessibleText interface,
636 Accessible_isText (Accessible *obj)
638 return cspi_accessible_is_a (obj,
639 "IDL:Accessibility/Text:1.0");
643 * Accessible_isValue:
644 * @obj: a pointer to the #Accessible instance to query.
646 * Query whether the specified #Accessible implements #AccessibleValue.
648 * Returns: #TRUE if @obj implements the #AccessibleValue interface,
652 Accessible_isValue (Accessible *obj)
654 return cspi_accessible_is_a (obj,
655 "IDL:Accessibility/Value:1.0");
659 * Accessible_getApplication:
660 * @obj: a pointer to the #Accessible instance to query.
662 * Get the #AccessibleApplication interface for an #Accessible.
664 * Returns: a pointer to an #AccessibleApplication interface instance, or
665 * NULL if @obj does not implement #AccessibleApplication.
667 AccessibleApplication *
668 Accessible_getApplication (Accessible *obj)
670 return (AccessibleApplication *) Accessible_queryInterface (
671 obj, "IDL:Accessibility/Application:1.0");
675 * Accessible_getAction:
676 * @obj: a pointer to the #Accessible instance to query.
678 * Get the #AccessibleAction interface for an #Accessible.
680 * Returns: a pointer to an #AccessibleAction interface instance, or
681 * NULL if @obj does not implement #AccessibleAction.
684 Accessible_getAction (Accessible *obj)
686 return (AccessibleAction *) Accessible_queryInterface (
687 obj, "IDL:Accessibility/Action:1.0");
691 * Accessible_getComponent:
692 * @obj: a pointer to the #Accessible instance to query.
694 * Get the #AccessibleComponent interface for an #Accessible.
696 * Returns: a pointer to an #AccessibleComponent interface instance, or
697 * NULL if @obj does not implement #AccessibleComponent.
699 AccessibleComponent *
700 Accessible_getComponent (Accessible *obj)
702 return (AccessibleComponent *) Accessible_queryInterface (
703 obj, "IDL:Accessibility/Component:1.0");
707 * Accessible_getEditableText:
708 * @obj: a pointer to the #Accessible instance to query.
710 * Get the #AccessibleEditableText interface for an #Accessible.
712 * Returns: a pointer to an #AccessibleEditableText interface instance, or
713 * NULL if @obj does not implement #AccessibleEditableText.
715 AccessibleEditableText *
716 Accessible_getEditableText (Accessible *obj)
718 return (AccessibleEditableText *) Accessible_queryInterface (
719 obj, "IDL:Accessibility/EditableText:1.0");
725 * Accessible_getHypertext:
726 * @obj: a pointer to the #Accessible instance to query.
728 * Get the #AccessibleHypertext interface for an #Accessible.
730 * Returns: a pointer to an #AccessibleHypertext interface instance, or
731 * NULL if @obj does not implement #AccessibleHypertext.
733 AccessibleHypertext *
734 Accessible_getHypertext (Accessible *obj)
736 return (AccessibleHypertext *) Accessible_queryInterface (
737 obj, "IDL:Accessibility/Hypertext:1.0");
743 * Accessible_getImage:
744 * @obj: a pointer to the #Accessible instance to query.
746 * Get the #AccessibleImage interface for an #Accessible.
748 * Returns: a pointer to an #AccessibleImage interface instance, or
749 * NULL if @obj does not implement #AccessibleImage.
752 Accessible_getImage (Accessible *obj)
754 return (AccessibleImage *) Accessible_queryInterface (
755 obj, "IDL:Accessibility/Image:1.0");
761 * Accessible_getSelection:
762 * @obj: a pointer to the #Accessible instance to query.
764 * Get the #AccessibleSelection interface for an #Accessible.
766 * Returns: a pointer to an #AccessibleSelection interface instance, or
767 * NULL if @obj does not implement #AccessibleSelection.
769 AccessibleSelection *
770 Accessible_getSelection (Accessible *obj)
772 return (AccessibleSelection *) Accessible_queryInterface (
773 obj, "IDL:Accessibility/Selection:1.0");
779 * Accessible_getStreamableContent:
780 * @obj: a pointer to the #Accessible instance to query.
782 * Get the #AccessibleStreamableContent interface for an #Accessible.
784 * Returns: a pointer to an #AccessibleStreamableContent interface instance, or
785 * NULL if @obj does not implement #AccessibleStreamableContent.
787 AccessibleStreamableContent *
788 Accessible_getStreamableContent (Accessible *obj)
790 return (AccessibleStreamableContent *) Accessible_queryInterface (
791 obj, "IDL:Accessibility/StreamableContent:1.0");
795 * Accessible_getTable:
796 * @obj: a pointer to the #Accessible instance to query.
798 * Get the #AccessibleTable interface for an #Accessible.
800 * Returns: a pointer to an #AccessibleTable interface instance, or
801 * NULL if @obj does not implement #AccessibleTable.
804 Accessible_getTable (Accessible *obj)
806 return (AccessibleTable *) Accessible_queryInterface (
807 obj, "IDL:Accessibility/Table:1.0");
811 * Accessible_getText:
812 * @obj: a pointer to the #Accessible instance to query.
814 * Get the #AccessibleText interface for an #Accessible.
816 * Returns: a pointer to an #AccessibleText interface instance, or
817 * NULL if @obj does not implement #AccessibleText.
820 Accessible_getText (Accessible *obj)
822 return (AccessibleText *) Accessible_queryInterface (
823 obj, "IDL:Accessibility/Text:1.0");
829 * Accessible_getValue:
830 * @obj: a pointer to the #Accessible instance to query.
832 * Get the #AccessibleValue interface for an #Accessible.
834 * Returns: a pointer to an #AccessibleValue interface instance, or
835 * NULL if @obj does not implement #AccessibleValue.
838 Accessible_getValue (Accessible *obj)
840 return (AccessibleValue *) Accessible_queryInterface (
841 obj, "IDL:Accessibility/Value:1.0");
847 * Accessible_queryInterface:
848 * @obj: a pointer to the #Accessible instance to query.
849 * @interface_name: a UTF-8 character string specifiying the requested interface.
851 * Query an #Accessible object to for a named interface.
853 * Returns: an instance of the named interface object, if it is implemented
854 * by @obj, or NULL otherwise.
858 Accessible_queryInterface (Accessible *obj,
859 const char *interface_name)
861 Bonobo_Unknown iface;
868 iface = Accessibility_Accessible_queryInterface (CSPI_OBJREF (obj),
873 cspi_return_val_if_ev ("queryInterface", NULL);
876 * FIXME: we need to be fairly sure that references are going
877 * to mach up if we are going to expose QueryInterface, ie. we
878 * can't allow people to do:
879 * b = a.qi ("b"); b.unref, b.unref to release a's reference.
880 * this should be no real problem though for this level of API
884 return cspi_object_add (iface);
889 * AccessibleRelation_ref:
890 * @obj: a pointer to the #AccessibleRelation object on which to operate.
892 * Increment the reference count for an #AccessibleRelation object.
896 AccessibleRelation_ref (AccessibleRelation *obj)
898 cspi_object_ref (obj);
902 * AccessibleRelation_unref:
903 * @obj: a pointer to the #AccessibleRelation object on which to operate.
905 * Decrement the reference count for an #AccessibleRelation object.
909 AccessibleRelation_unref (AccessibleRelation *obj)
911 cspi_object_unref (obj);
915 * AccessibleRelation_getRelationType:
916 * @obj: a pointer to the #AccessibleRelation object to query.
918 * Get the type of relationship represented by an #AccessibleRelation.
920 * Returns: an #AccessibleRelationType indicating the type of relation
921 * encapsulated in this #AccessibleRelation object.
924 AccessibleRelationType
925 AccessibleRelation_getRelationType (AccessibleRelation *obj)
927 AccessibleRelationType retval;
929 cspi_return_val_if_fail (obj, SPI_RELATION_NULL);
931 Accessibility_Relation_getRelationType (CSPI_OBJREF (obj), cspi_ev());
932 cspi_return_val_if_ev ("getRelationType", SPI_RELATION_NULL);
937 * AccessibleRelation_getNTargets:
938 * @obj: a pointer to the #AccessibleRelation object to query.
940 * Get the number of objects which this relationship has as its
941 * target objects (the subject is the #Accessible from which this
942 * #AccessibleRelation originated).
944 * Returns: a short integer indicating how many target objects which the
945 * originating #Accessible object has the #AccessibleRelation
949 AccessibleRelation_getNTargets (AccessibleRelation *obj)
953 cspi_return_val_if_fail (obj, -1);
955 Accessibility_Relation_getNTargets (CSPI_OBJREF (obj), cspi_ev());
956 cspi_return_val_if_ev ("getNTargets", -1);
961 * AccessibleRelation_getTarget:
962 * @obj: a pointer to the #AccessibleRelation object to query.
963 * @i: a (zero-index) integer indicating which (of possibly several) target is requested.
965 * Get the @i-th target of a specified #AccessibleRelation relationship.
967 * Returns: an #Accessible which is the @i-th object with which the
968 * originating #Accessible has relationship specified in the
969 * #AccessibleRelation object.
973 AccessibleRelation_getTarget (AccessibleRelation *obj, int i)
977 cspi_return_val_if_fail (obj, NULL);
979 retval = cspi_object_add (
980 Accessibility_Relation_getTarget (CSPI_OBJREF(obj),
981 (CORBA_short) i, cspi_ev()));
982 cspi_return_val_if_ev ("getTarget", NULL);
987 * AccessibleStateSet_ref:
988 * @obj: a pointer to the #AccessibleStateSet object on which to operate.
990 * Increment the reference count for an #AccessibleStateSet object.
994 AccessibleStateSet_ref (AccessibleStateSet *obj)
996 cspi_object_ref (obj);
1000 * AccessibleStateSet_unref:
1001 * @obj: a pointer to the #AccessibleStateSet object on which to operate.
1003 * Decrement the reference count for an #AccessibleStateSet object.
1007 AccessibleStateSet_unref (AccessibleStateSet *obj)
1009 cspi_object_unref (obj);
1013 * AccessibleStateSet_contains:
1014 * @obj: a pointer to the #AccessibleStateSet object on which to operate.
1015 * @state: an #AccessibleState for which the specified #AccessibleStateSet
1018 * Determine whether a given #AccessibleStateSet includes a given state; that is,
1019 * whether @state is true for the stateset in question.
1021 * Returns: #TRUE if @state is true/included in the given #AccessibleStateSet,
1026 AccessibleStateSet_contains (AccessibleStateSet *obj,
1027 AccessibleState state)
1029 CORBA_boolean retval;
1031 cspi_return_val_if_fail (obj != NULL, FALSE);
1033 retval = Accessibility_StateSet_contains (CSPI_OBJREF (obj),
1036 cspi_return_val_if_ev ("contains", FALSE);
1038 return (SPIBoolean) retval;
1042 * AccessibleStateSet_add:
1043 * @obj: a pointer to the #AccessibleStateSet object on which to operate.
1044 * @state: an #AccessibleState to be added to the specified #AccessibleStateSet
1046 * Add a particular #AccessibleState to an #AccessibleStateSet (i.e. set the
1047 * given state to #TRUE in the stateset.
1051 AccessibleStateSet_add (AccessibleStateSet *obj,
1052 AccessibleState state)
1054 cspi_return_if_fail (obj != NULL);
1056 Accessibility_StateSet_add (CSPI_OBJREF (obj), state, cspi_ev ());
1057 cspi_check_ev ("add");
1061 * AccessibleStateSet_remove:
1062 * @obj: a pointer to the #AccessibleStateSet object on which to operate.
1063 * @state: an #AccessibleState to be removed from the specified #AccessibleStateSet
1065 * Remove a particular #AccessibleState to an #AccessibleStateSet (i.e. set the
1066 * given state to #FALSE in the stateset.)
1070 AccessibleStateSet_remove (AccessibleStateSet *obj,
1071 AccessibleState state)
1073 cspi_return_if_fail (obj != NULL);
1075 Accessibility_StateSet_remove (CSPI_OBJREF (obj), state, cspi_ev ());
1076 cspi_check_ev ("remove");
1080 * AccessibleStateSet_equals:
1081 * @obj: a pointer to the first #AccessibleStateSet object on which to operate.
1082 * @obj2: a pointer to the second #AccessibleStateSet object on which to operate.
1084 * Determine whether two instances of #AccessibleStateSet are equivalent (i.e.
1085 * consist of the same #AccessibleStates). Useful for checking multiple
1086 * state variables at once; construct the target state then compare against it.
1088 * @see AccessibleStateSet_compare().
1090 * Returns: #TRUE if the two #AccessibleStateSets are equivalent,
1095 AccessibleStateSet_equals (AccessibleStateSet *obj,
1096 AccessibleStateSet *obj2)
1103 cspi_return_val_if_fail (obj != NULL, FALSE);
1104 cspi_return_val_if_fail (obj2 != NULL, FALSE);
1106 return Accessibility_StateSet_equals (CSPI_OBJREF (obj),
1107 CSPI_OBJREF (obj2), cspi_ev ());
1111 * AccessibleStateSet_compare:
1112 * @obj: a pointer to the first #AccessibleStateSet object on which to operate.
1113 * @obj2: a pointer to the second #AccessibleStateSet object on which to operate.
1115 * Determine the differences between two instances of #AccessibleStateSet.
1116 * Not Yet Implemented.
1118 * @see AccessibleStateSet_equals().
1120 * Returns: an #AccessibleStateSet object containing all states contained on one of
1121 * the two sets but not the other.
1124 AccessibleStateSet *
1125 AccessibleStateSet_compare (AccessibleStateSet *obj,
1126 AccessibleStateSet *obj2)
1128 cspi_return_val_if_fail (obj != NULL, NULL);
1129 cspi_return_val_if_fail (obj2 != NULL, NULL);
1134 * AccessibleStateSet_isEmpty:
1135 * @obj: a pointer to the #AccessibleStateSet object on which to operate.
1137 * Determine whether a given #AccessibleStateSet is the empty set.
1139 * Returns: #TRUE if the given #AccessibleStateSet contains no (true) states,
1144 AccessibleStateSet_isEmpty (AccessibleStateSet *obj)
1146 cspi_return_val_if_fail (obj != NULL, FALSE);
1148 /* return Accessibility_StateSet_isEmpty (CSPI_OBJREF (obj), cspi_ev ());*/