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_CHECK_MENU_ITEM] = SPI_ROLE_CHECK_MENU_ITEM;
95 role_table [Accessibility_ROLE_COLOR_CHOOSER] = SPI_ROLE_COLOR_CHOOSER;
96 role_table [Accessibility_ROLE_COLUMN_HEADER] = SPI_ROLE_COLUMN_HEADER;
97 role_table [Accessibility_ROLE_COMBO_BOX] = SPI_ROLE_COMBO_BOX;
98 role_table [Accessibility_ROLE_DATE_EDITOR] = SPI_ROLE_DATE_EDITOR;
99 role_table [Accessibility_ROLE_DESKTOP_ICON] = SPI_ROLE_DESKTOP_ICON;
100 role_table [Accessibility_ROLE_DESKTOP_FRAME] = SPI_ROLE_DESKTOP_FRAME;
101 role_table [Accessibility_ROLE_DIAL] = SPI_ROLE_DIAL;
102 role_table [Accessibility_ROLE_DIALOG] = SPI_ROLE_DIALOG;
103 role_table [Accessibility_ROLE_DIRECTORY_PANE] = SPI_ROLE_DIRECTORY_PANE;
104 role_table [Accessibility_ROLE_FILE_CHOOSER] = SPI_ROLE_FILE_CHOOSER;
105 role_table [Accessibility_ROLE_FILLER] = SPI_ROLE_FILLER;
106 role_table [Accessibility_ROLE_FONT_CHOOSER] = SPI_ROLE_FONT_CHOOSER;
107 role_table [Accessibility_ROLE_FRAME] = SPI_ROLE_FRAME;
108 role_table [Accessibility_ROLE_GLASS_PANE] = SPI_ROLE_GLASS_PANE;
109 role_table [Accessibility_ROLE_HTML_CONTAINER] = SPI_ROLE_HTML_CONTAINER;
110 role_table [Accessibility_ROLE_ICON] = SPI_ROLE_ICON;
111 role_table [Accessibility_ROLE_IMAGE] = SPI_ROLE_IMAGE;
112 role_table [Accessibility_ROLE_INTERNAL_FRAME] = SPI_ROLE_INTERNAL_FRAME;
113 role_table [Accessibility_ROLE_LABEL] = SPI_ROLE_LABEL;
114 role_table [Accessibility_ROLE_LAYERED_PANE] = SPI_ROLE_LAYERED_PANE;
115 role_table [Accessibility_ROLE_LIST] = SPI_ROLE_LIST;
116 role_table [Accessibility_ROLE_LIST_ITEM] = SPI_ROLE_LIST_ITEM;
117 role_table [Accessibility_ROLE_MENU] = SPI_ROLE_MENU;
118 role_table [Accessibility_ROLE_MENU_BAR] = SPI_ROLE_MENU_BAR;
119 role_table [Accessibility_ROLE_MENU_ITEM] = SPI_ROLE_MENU_ITEM;
120 role_table [Accessibility_ROLE_OPTION_PANE] = SPI_ROLE_OPTION_PANE;
121 role_table [Accessibility_ROLE_PAGE_TAB] = SPI_ROLE_PAGE_TAB;
122 role_table [Accessibility_ROLE_PAGE_TAB_LIST] = SPI_ROLE_PAGE_TAB_LIST;
123 role_table [Accessibility_ROLE_PANEL] = SPI_ROLE_PANEL;
124 role_table [Accessibility_ROLE_PASSWORD_TEXT] = SPI_ROLE_PASSWORD_TEXT;
125 role_table [Accessibility_ROLE_POPUP_MENU] = SPI_ROLE_POPUP_MENU;
126 role_table [Accessibility_ROLE_PROGRESS_BAR] = SPI_ROLE_PROGRESS_BAR;
127 role_table [Accessibility_ROLE_PUSH_BUTTON] = SPI_ROLE_PUSH_BUTTON;
128 role_table [Accessibility_ROLE_RADIO_BUTTON] = SPI_ROLE_RADIO_BUTTON;
129 role_table [Accessibility_ROLE_RADIO_MENU_ITEM] = SPI_ROLE_RADIO_MENU_ITEM;
130 role_table [Accessibility_ROLE_ROOT_PANE] = SPI_ROLE_ROOT_PANE;
131 role_table [Accessibility_ROLE_ROW_HEADER] = SPI_ROLE_ROW_HEADER;
132 role_table [Accessibility_ROLE_SCROLL_BAR] = SPI_ROLE_SCROLL_BAR;
133 role_table [Accessibility_ROLE_SCROLL_PANE] = SPI_ROLE_SCROLL_PANE;
134 role_table [Accessibility_ROLE_SEPARATOR] = SPI_ROLE_SEPARATOR;
135 role_table [Accessibility_ROLE_SLIDER] = SPI_ROLE_SLIDER;
136 role_table [Accessibility_ROLE_SPIN_BUTTON] = SPI_ROLE_SPIN_BUTTON;
137 role_table [Accessibility_ROLE_SPLIT_PANE] = SPI_ROLE_SPLIT_PANE;
138 role_table [Accessibility_ROLE_STATUS_BAR] = SPI_ROLE_STATUS_BAR;
139 role_table [Accessibility_ROLE_TABLE] = SPI_ROLE_TABLE;
140 role_table [Accessibility_ROLE_TABLE_CELL] = SPI_ROLE_TABLE_CELL;
141 role_table [Accessibility_ROLE_TEAROFF_MENU_ITEM] = SPI_ROLE_TEAROFF_MENU_ITEM;
142 role_table [Accessibility_ROLE_TEXT] = SPI_ROLE_TEXT;
143 role_table [Accessibility_ROLE_TOGGLE_BUTTON] = SPI_ROLE_TOGGLE_BUTTON;
144 role_table [Accessibility_ROLE_TOOL_BAR] = SPI_ROLE_TOOL_BAR;
145 role_table [Accessibility_ROLE_TOOL_TIP] = SPI_ROLE_TOOL_TIP;
146 role_table [Accessibility_ROLE_TREE] = SPI_ROLE_TREE;
147 role_table [Accessibility_ROLE_TREE_TABLE] = SPI_ROLE_TREE_TABLE;
148 role_table [Accessibility_ROLE_UNKNOWN] = SPI_ROLE_UNKNOWN;
149 role_table [Accessibility_ROLE_VIEWPORT] = SPI_ROLE_VIEWPORT;
150 role_table [Accessibility_ROLE_WINDOW] = SPI_ROLE_WINDOW;
151 role_table [Accessibility_ROLE_EXTENDED] = SPI_ROLE_EXTENDED;
152 role_table [Accessibility_ROLE_LAST_DEFINED] = SPI_ROLE_EXTENDED;
157 static AccessibleRole
158 cspi_role_from_spi_role (Accessibility_Role role)
160 /* array is sized according to IDL roles because IDL roles are the index */
161 static AccessibleRole cspi_role_table [Accessibility_ROLE_LAST_DEFINED];
162 static SPIBoolean is_initialized = FALSE;
163 AccessibleRole cspi_role;
166 is_initialized = cspi_init_role_table (cspi_role_table);
168 if (role >= 0 && role < Accessibility_ROLE_LAST_DEFINED)
170 cspi_role = cspi_role_table [role];
174 cspi_role = SPI_ROLE_EXTENDED;
180 * AccessibleRole_getName:
181 * @role: an #AccessibleRole object to query.
183 * Get a localizeable string that indicates the name of an #AccessibleRole.
184 * <em>DEPRECATED.</em>
186 * Returns: a localizable string name for an #AccessibleRole enumerated type.
189 AccessibleRole_getName (AccessibleRole role)
191 if (role < MAX_ROLES)
193 return g_strdup (role_names [(int) role]);
197 return g_strdup ("");
203 * @obj: a pointer to the #Accessible object on which to operate.
205 * Increment the reference count for an #Accessible object.
208 Accessible_ref (Accessible *obj)
210 cspi_object_ref (obj);
215 * @obj: a pointer to the #Accessible object on which to operate.
217 * Decrement the reference count for an #Accessible object.
220 Accessible_unref (Accessible *obj)
222 cspi_object_unref (obj);
226 * Accessible_getName:
227 * @obj: a pointer to the #Accessible object on which to operate.
229 * Get the name of an #Accessible object.
231 * Returns: a UTF-8 string indicating the name of the #Accessible object.
232 * or NULL on exception
235 Accessible_getName (Accessible *obj)
239 cspi_return_val_if_fail (obj != NULL, NULL);
242 Accessibility_Accessible__get_name (CSPI_OBJREF (obj), cspi_ev ());
244 cspi_return_val_if_ev ("getName", NULL);
250 * Accessible_getDescription:
251 * @obj: a pointer to the #Accessible object on which to operate.
253 * Get the description of an #Accessible object.
255 * Returns: a UTF-8 string describing the #Accessible object.
256 * or NULL on exception
259 Accessible_getDescription (Accessible *obj)
263 cspi_return_val_if_fail (obj != NULL, NULL);
266 Accessibility_Accessible__get_description (CSPI_OBJREF (obj),
269 cspi_return_val_if_ev ("getDescription", NULL);
275 * Accessible_getParent:
276 * @obj: a pointer to the #Accessible object to query.
278 * Get an #Accessible object's parent container.
280 * Returns: a pointer tothe #Accessible object which contains the given
281 * #Accessible instance, or NULL if the @obj has no parent container.
285 Accessible_getParent (Accessible *obj)
289 cspi_return_val_if_fail (obj != NULL, NULL);
291 retval = cspi_object_add (
292 Accessibility_Accessible__get_parent (CSPI_OBJREF (obj),
295 cspi_return_val_if_ev ("getParent", NULL);
301 * Accessible_getChildCount:
302 * @obj: a pointer to the #Accessible object on which to operate.
304 * Get the number of children contained by an #Accessible object.
306 * Returns: a #long indicating the number of #Accessible children
307 * contained by an #Accessible object. or -1 on exception
311 Accessible_getChildCount (Accessible *obj)
315 cspi_return_val_if_fail (obj != NULL, -1);
318 Accessibility_Accessible__get_childCount (CSPI_OBJREF (obj),
321 cspi_return_val_if_ev ("getChildCount", -1);
327 * Accessible_getChildAtIndex:
328 * @obj: a pointer to the #Accessible object on which to operate.
329 * @childIndex: a #long indicating which child is specified.
331 * Get the #Accessible child of an #Accessible object at a given index.
333 * Returns: a pointer to the #Accessible child object at index
334 * @childIndex. or NULL on exception
337 Accessible_getChildAtIndex (Accessible *obj,
342 cspi_return_val_if_fail (obj != NULL, NULL);
344 retval = cspi_object_add (
345 Accessibility_Accessible_getChildAtIndex (CSPI_OBJREF (obj),
346 childIndex, cspi_ev ()));
352 * Accessible_getIndexInParent:
353 * @obj: a pointer to the #Accessible object on which to operate.
355 * Get the index of an #Accessible object in its containing #Accessible.
357 * Returns: a #long indicating the index of the #Accessible object
358 * in its parent (i.e. containing) #Accessible instance,
359 * or -1 if @obj has no containing parent or on exception.
362 Accessible_getIndexInParent (Accessible *obj)
366 cspi_return_val_if_fail (obj != NULL, -1);
369 Accessibility_Accessible_getIndexInParent (CSPI_OBJREF (obj), cspi_ev ());
371 cspi_return_val_if_ev ("getIndexInparent", -1);
376 * Accessible_getRelationSet:
377 * @obj: a pointer to the #Accessible object on which to operate.
379 * Get the set of #AccessibleRelation objects which describe this #Accessible object's
380 * relationships with other #Accessible objects.
382 * Returns: an array of #AccessibleRelation pointers. or NULL on exception
384 AccessibleRelation **
385 Accessible_getRelationSet (Accessible *obj)
389 AccessibleRelation **relations;
390 Accessibility_RelationSet *relation_set;
392 cspi_return_val_if_fail (obj != NULL, NULL);
395 Accessibility_Accessible_getRelationSet (CSPI_OBJREF (obj), cspi_ev ());
397 cspi_return_val_if_ev ("getRelationSet", NULL);
399 /* this looks hack-ish, but it's based on the CORBA C bindings spec */
400 n_relations = relation_set->_length;
401 relations = malloc (sizeof (AccessibleRelation *) * n_relations);
403 for (i = 0; i < n_relations; ++i)
405 relations[i] = cspi_object_add (CORBA_Object_duplicate (
406 relation_set->_buffer[i], cspi_ev ()));
408 relations[i] = CORBA_OBJECT_NIL;
410 CORBA_free (relation_set);
416 * Accessible_getRole:
417 * @obj: a pointer to the #Accessible object on which to operate.
419 * Get the UI role of an #Accessible object.
420 * A UTF-8 string describing this role can be obtained via Accessible_getRoleName ().
422 * Returns: the #AccessibleRole of the object.
426 Accessible_getRole (Accessible *obj)
428 AccessibleRole retval;
430 cspi_return_val_if_fail (obj != NULL, SPI_ROLE_INVALID);
433 Accessibility_Accessible_getRole (CSPI_OBJREF (obj), cspi_ev ());
435 cspi_return_val_if_ev ("getRole", SPI_ROLE_INVALID);
437 return cspi_role_from_spi_role (retval);
441 * Accessible_getRoleName:
442 * @obj: a pointer to the #Accessible object on which to operate.
444 * Get a UTF-8 string describing the role this object plays in the UI.
445 * This method will return useful values for roles that fall outside the
446 * enumeration used in Accessible_getRole ().
448 * Returns: a UTF-8 string specifying the role of this #Accessible object.
452 Accessible_getRoleName (Accessible *obj)
456 cspi_return_val_if_fail (obj != NULL, CORBA_string_dup ("invalid"));
459 Accessibility_Accessible_getRoleName (CSPI_OBJREF (obj), cspi_ev ());
461 cspi_return_val_if_ev ("getRoleName", CORBA_string_dup ("invalid"));
467 * Accessible_getStateSet:
468 * @obj: a pointer to the #Accessible object on which to operate.
470 * Not Yet Implemented.
472 * Returns: a pointer to an #AccessibleStateSet representing the object's current state.
475 Accessible_getStateSet (Accessible *obj)
480 /* Interface query methods */
483 * Accessible_isAction:
484 * @obj: a pointer to the #Accessible instance to query.
486 * Query whether the specified #Accessible implements #AccessibleAction.
488 * Returns: #TRUE if @obj implements the #AccessibleAction interface,
492 Accessible_isAction (Accessible *obj)
494 return cspi_accessible_is_a (obj,
495 "IDL:Accessibility/Action:1.0");
499 * Accessible_isApplication:
500 * @obj: a pointer to the #Accessible instance to query.
502 * Query whether the specified #Accessible implements #AccessibleApplication.
504 * Returns: #TRUE if @obj implements the #AccessibleApplication interface,
508 Accessible_isApplication (Accessible *obj)
510 return cspi_accessible_is_a (obj,
511 "IDL:Accessibility/Application:1.0");
515 * Accessible_isComponent:
516 * @obj: a pointer to the #Accessible instance to query.
518 * Query whether the specified #Accessible implements #AccessibleComponent.
520 * Returns: #TRUE if @obj implements the #AccessibleComponent interface,
524 Accessible_isComponent (Accessible *obj)
526 return cspi_accessible_is_a (obj,
527 "IDL:Accessibility/Component:1.0");
531 * Accessible_isEditableText:
532 * @obj: a pointer to the #Accessible instance to query.
534 * Query whether the specified #Accessible implements #AccessibleEditableText.
536 * Returns: #TRUE if @obj implements the #AccessibleEditableText interface,
540 Accessible_isEditableText (Accessible *obj)
542 return cspi_accessible_is_a (obj,
543 "IDL:Accessibility/EditableText:1.0");
547 * Accessible_isHypertext:
548 * @obj: a pointer to the #Accessible instance to query.
550 * Query whether the specified #Accessible implements #AccessibleHypertext.
552 * Returns: #TRUE if @obj implements the #AccessibleHypertext interface,
556 Accessible_isHypertext (Accessible *obj)
558 return cspi_accessible_is_a (obj,
559 "IDL:Accessibility/Hypertext:1.0");
563 * Accessible_isImage:
564 * @obj: a pointer to the #Accessible instance to query.
566 * Query whether the specified #Accessible implements #AccessibleImage.
568 * Returns: #TRUE if @obj implements the #AccessibleImage interface,
572 Accessible_isImage (Accessible *obj)
574 return cspi_accessible_is_a (obj,
575 "IDL:Accessibility/Image:1.0");
579 * Accessible_isSelection:
580 * @obj: a pointer to the #Accessible instance to query.
582 * Query whether the specified #Accessible implements #AccessibleSelection.
584 * Returns: #TRUE if @obj implements the #AccessibleSelection interface,
588 Accessible_isSelection (Accessible *obj)
590 return cspi_accessible_is_a (obj,
591 "IDL:Accessibility/Selection:1.0");
595 * Accessible_isTable:
596 * @obj: a pointer to the #Accessible instance to query.
598 * Query whether the specified #Accessible implements #AccessibleTable.
600 * Returns: #TRUE if @obj implements the #AccessibleTable interface,
604 Accessible_isTable (Accessible *obj)
606 return cspi_accessible_is_a (obj,
607 "IDL:Accessibility/Table:1.0");
611 * Accessible_isStreamableContent:
612 * @obj: a pointer to the #Accessible instance to query.
614 * Query whether the specified #Accessible implements
615 * #AccessibleStreamableContent.
617 * Returns: #TRUE if @obj implements the #AccessibleStreamableContent interface,
621 Accessible_isStreamableContent (Accessible *obj)
623 return cspi_accessible_is_a (obj,
624 "IDL:Accessibility/StreamableContent:1.0");
629 * @obj: a pointer to the #Accessible instance to query.
631 * Query whether the specified #Accessible implements #AccessibleText.
633 * Returns: #TRUE if @obj implements the #AccessibleText interface,
637 Accessible_isText (Accessible *obj)
639 return cspi_accessible_is_a (obj,
640 "IDL:Accessibility/Text:1.0");
644 * Accessible_isValue:
645 * @obj: a pointer to the #Accessible instance to query.
647 * Query whether the specified #Accessible implements #AccessibleValue.
649 * Returns: #TRUE if @obj implements the #AccessibleValue interface,
653 Accessible_isValue (Accessible *obj)
655 return cspi_accessible_is_a (obj,
656 "IDL:Accessibility/Value:1.0");
660 * Accessible_getApplication:
661 * @obj: a pointer to the #Accessible instance to query.
663 * Get the #AccessibleApplication interface for an #Accessible.
665 * Returns: a pointer to an #AccessibleApplication interface instance, or
666 * NULL if @obj does not implement #AccessibleApplication.
668 AccessibleApplication *
669 Accessible_getApplication (Accessible *obj)
671 return (AccessibleApplication *) Accessible_queryInterface (
672 obj, "IDL:Accessibility/Application:1.0");
676 * Accessible_getAction:
677 * @obj: a pointer to the #Accessible instance to query.
679 * Get the #AccessibleAction interface for an #Accessible.
681 * Returns: a pointer to an #AccessibleAction interface instance, or
682 * NULL if @obj does not implement #AccessibleAction.
685 Accessible_getAction (Accessible *obj)
687 return (AccessibleAction *) Accessible_queryInterface (
688 obj, "IDL:Accessibility/Action:1.0");
692 * Accessible_getComponent:
693 * @obj: a pointer to the #Accessible instance to query.
695 * Get the #AccessibleComponent interface for an #Accessible.
697 * Returns: a pointer to an #AccessibleComponent interface instance, or
698 * NULL if @obj does not implement #AccessibleComponent.
700 AccessibleComponent *
701 Accessible_getComponent (Accessible *obj)
703 return (AccessibleComponent *) Accessible_queryInterface (
704 obj, "IDL:Accessibility/Component:1.0");
708 * Accessible_getEditableText:
709 * @obj: a pointer to the #Accessible instance to query.
711 * Get the #AccessibleEditableText interface for an #Accessible.
713 * Returns: a pointer to an #AccessibleEditableText interface instance, or
714 * NULL if @obj does not implement #AccessibleEditableText.
716 AccessibleEditableText *
717 Accessible_getEditableText (Accessible *obj)
719 return (AccessibleEditableText *) Accessible_queryInterface (
720 obj, "IDL:Accessibility/EditableText:1.0");
726 * Accessible_getHypertext:
727 * @obj: a pointer to the #Accessible instance to query.
729 * Get the #AccessibleHypertext interface for an #Accessible.
731 * Returns: a pointer to an #AccessibleHypertext interface instance, or
732 * NULL if @obj does not implement #AccessibleHypertext.
734 AccessibleHypertext *
735 Accessible_getHypertext (Accessible *obj)
737 return (AccessibleHypertext *) Accessible_queryInterface (
738 obj, "IDL:Accessibility/Hypertext:1.0");
744 * Accessible_getImage:
745 * @obj: a pointer to the #Accessible instance to query.
747 * Get the #AccessibleImage interface for an #Accessible.
749 * Returns: a pointer to an #AccessibleImage interface instance, or
750 * NULL if @obj does not implement #AccessibleImage.
753 Accessible_getImage (Accessible *obj)
755 return (AccessibleImage *) Accessible_queryInterface (
756 obj, "IDL:Accessibility/Image:1.0");
762 * Accessible_getSelection:
763 * @obj: a pointer to the #Accessible instance to query.
765 * Get the #AccessibleSelection interface for an #Accessible.
767 * Returns: a pointer to an #AccessibleSelection interface instance, or
768 * NULL if @obj does not implement #AccessibleSelection.
770 AccessibleSelection *
771 Accessible_getSelection (Accessible *obj)
773 return (AccessibleSelection *) Accessible_queryInterface (
774 obj, "IDL:Accessibility/Selection:1.0");
780 * Accessible_getStreamableContent:
781 * @obj: a pointer to the #Accessible instance to query.
783 * Get the #AccessibleStreamableContent interface for an #Accessible.
785 * Returns: a pointer to an #AccessibleStreamableContent interface instance, or
786 * NULL if @obj does not implement #AccessibleStreamableContent.
788 AccessibleStreamableContent *
789 Accessible_getStreamableContent (Accessible *obj)
791 return (AccessibleStreamableContent *) Accessible_queryInterface (
792 obj, "IDL:Accessibility/StreamableContent:1.0");
796 * Accessible_getTable:
797 * @obj: a pointer to the #Accessible instance to query.
799 * Get the #AccessibleTable interface for an #Accessible.
801 * Returns: a pointer to an #AccessibleTable interface instance, or
802 * NULL if @obj does not implement #AccessibleTable.
805 Accessible_getTable (Accessible *obj)
807 return (AccessibleTable *) Accessible_queryInterface (
808 obj, "IDL:Accessibility/Table:1.0");
812 * Accessible_getText:
813 * @obj: a pointer to the #Accessible instance to query.
815 * Get the #AccessibleText interface for an #Accessible.
817 * Returns: a pointer to an #AccessibleText interface instance, or
818 * NULL if @obj does not implement #AccessibleText.
821 Accessible_getText (Accessible *obj)
823 return (AccessibleText *) Accessible_queryInterface (
824 obj, "IDL:Accessibility/Text:1.0");
830 * Accessible_getValue:
831 * @obj: a pointer to the #Accessible instance to query.
833 * Get the #AccessibleValue interface for an #Accessible.
835 * Returns: a pointer to an #AccessibleValue interface instance, or
836 * NULL if @obj does not implement #AccessibleValue.
839 Accessible_getValue (Accessible *obj)
841 return (AccessibleValue *) Accessible_queryInterface (
842 obj, "IDL:Accessibility/Value:1.0");
848 * Accessible_queryInterface:
849 * @obj: a pointer to the #Accessible instance to query.
850 * @interface_name: a UTF-8 character string specifiying the requested interface.
852 * Query an #Accessible object to for a named interface.
854 * Returns: an instance of the named interface object, if it is implemented
855 * by @obj, or NULL otherwise.
859 Accessible_queryInterface (Accessible *obj,
860 const char *interface_name)
862 Bonobo_Unknown iface;
869 iface = Accessibility_Accessible_queryInterface (CSPI_OBJREF (obj),
874 cspi_return_val_if_ev ("queryInterface", NULL);
877 * FIXME: we need to be fairly sure that references are going
878 * to mach up if we are going to expose QueryInterface, ie. we
879 * can't allow people to do:
880 * b = a.qi ("b"); b.unref, b.unref to release a's reference.
881 * this should be no real problem though for this level of API
885 return cspi_object_add (iface);
890 * AccessibleRelation_ref:
891 * @obj: a pointer to the #AccessibleRelation object on which to operate.
893 * Increment the reference count for an #AccessibleRelation object.
897 AccessibleRelation_ref (AccessibleRelation *obj)
899 cspi_object_ref (obj);
903 * AccessibleRelation_unref:
904 * @obj: a pointer to the #AccessibleRelation object on which to operate.
906 * Decrement the reference count for an #AccessibleRelation object.
910 AccessibleRelation_unref (AccessibleRelation *obj)
912 cspi_object_unref (obj);
916 * AccessibleRelation_getRelationType:
917 * @obj: a pointer to the #AccessibleRelation object to query.
919 * Get the type of relationship represented by an #AccessibleRelation.
921 * Returns: an #AccessibleRelationType indicating the type of relation
922 * encapsulated in this #AccessibleRelation object.
925 AccessibleRelationType
926 AccessibleRelation_getRelationType (AccessibleRelation *obj)
928 AccessibleRelationType retval;
930 cspi_return_val_if_fail (obj, SPI_RELATION_NULL);
932 Accessibility_Relation_getRelationType (CSPI_OBJREF (obj), cspi_ev());
933 cspi_return_val_if_ev ("getRelationType", SPI_RELATION_NULL);
938 * AccessibleRelation_getNTargets:
939 * @obj: a pointer to the #AccessibleRelation object to query.
941 * Get the number of objects which this relationship has as its
942 * target objects (the subject is the #Accessible from which this
943 * #AccessibleRelation originated).
945 * Returns: a short integer indicating how many target objects which the
946 * originating #Accessible object has the #AccessibleRelation
950 AccessibleRelation_getNTargets (AccessibleRelation *obj)
954 cspi_return_val_if_fail (obj, -1);
956 Accessibility_Relation_getNTargets (CSPI_OBJREF (obj), cspi_ev());
957 cspi_return_val_if_ev ("getNTargets", -1);
962 * AccessibleRelation_getTarget:
963 * @obj: a pointer to the #AccessibleRelation object to query.
964 * @i: a (zero-index) integer indicating which (of possibly several) target is requested.
966 * Get the @i-th target of a specified #AccessibleRelation relationship.
968 * Returns: an #Accessible which is the @i-th object with which the
969 * originating #Accessible has relationship specified in the
970 * #AccessibleRelation object.
974 AccessibleRelation_getTarget (AccessibleRelation *obj, int i)
978 cspi_return_val_if_fail (obj, NULL);
980 retval = cspi_object_add (
981 Accessibility_Relation_getTarget (CSPI_OBJREF(obj),
982 (CORBA_short) i, cspi_ev()));
983 cspi_return_val_if_ev ("getTarget", NULL);
988 * AccessibleStateSet_ref:
989 * @obj: a pointer to the #AccessibleStateSet object on which to operate.
991 * Increment the reference count for an #AccessibleStateSet object.
995 AccessibleStateSet_ref (AccessibleStateSet *obj)
997 cspi_object_ref (obj);
1001 * AccessibleStateSet_unref:
1002 * @obj: a pointer to the #AccessibleStateSet object on which to operate.
1004 * Decrement the reference count for an #AccessibleStateSet object.
1008 AccessibleStateSet_unref (AccessibleStateSet *obj)
1010 cspi_object_unref (obj);
1014 * AccessibleStateSet_contains:
1015 * @obj: a pointer to the #AccessibleStateSet object on which to operate.
1016 * @state: an #AccessibleState for which the specified #AccessibleStateSet
1019 * Determine whether a given #AccessibleStateSet includes a given state; that is,
1020 * whether @state is true for the stateset in question.
1022 * Returns: #TRUE if @state is true/included in the given #AccessibleStateSet,
1027 AccessibleStateSet_contains (AccessibleStateSet *obj,
1028 AccessibleState state)
1030 CORBA_boolean retval;
1032 cspi_return_val_if_fail (obj != NULL, FALSE);
1034 retval = Accessibility_StateSet_contains (CSPI_OBJREF (obj),
1037 cspi_return_val_if_ev ("contains", FALSE);
1039 return (SPIBoolean) retval;
1043 * AccessibleStateSet_add:
1044 * @obj: a pointer to the #AccessibleStateSet object on which to operate.
1045 * @state: an #AccessibleState to be added to the specified #AccessibleStateSet
1047 * Add a particular #AccessibleState to an #AccessibleStateSet (i.e. set the
1048 * given state to #TRUE in the stateset.
1052 AccessibleStateSet_add (AccessibleStateSet *obj,
1053 AccessibleState state)
1055 cspi_return_if_fail (obj != NULL);
1057 Accessibility_StateSet_add (CSPI_OBJREF (obj), state, cspi_ev ());
1058 cspi_check_ev ("add");
1062 * AccessibleStateSet_remove:
1063 * @obj: a pointer to the #AccessibleStateSet object on which to operate.
1064 * @state: an #AccessibleState to be removed from the specified #AccessibleStateSet
1066 * Remove a particular #AccessibleState to an #AccessibleStateSet (i.e. set the
1067 * given state to #FALSE in the stateset.)
1071 AccessibleStateSet_remove (AccessibleStateSet *obj,
1072 AccessibleState state)
1074 cspi_return_if_fail (obj != NULL);
1076 Accessibility_StateSet_remove (CSPI_OBJREF (obj), state, cspi_ev ());
1077 cspi_check_ev ("remove");
1081 * AccessibleStateSet_equals:
1082 * @obj: a pointer to the first #AccessibleStateSet object on which to operate.
1083 * @obj2: a pointer to the second #AccessibleStateSet object on which to operate.
1085 * Determine whether two instances of #AccessibleStateSet are equivalent (i.e.
1086 * consist of the same #AccessibleStates). Useful for checking multiple
1087 * state variables at once; construct the target state then compare against it.
1089 * @see AccessibleStateSet_compare().
1091 * Returns: #TRUE if the two #AccessibleStateSets are equivalent,
1096 AccessibleStateSet_equals (AccessibleStateSet *obj,
1097 AccessibleStateSet *obj2)
1104 cspi_return_val_if_fail (obj != NULL, FALSE);
1105 cspi_return_val_if_fail (obj2 != NULL, FALSE);
1107 return Accessibility_StateSet_equals (CSPI_OBJREF (obj),
1108 CSPI_OBJREF (obj2), cspi_ev ());
1112 * AccessibleStateSet_compare:
1113 * @obj: a pointer to the first #AccessibleStateSet object on which to operate.
1114 * @obj2: a pointer to the second #AccessibleStateSet object on which to operate.
1116 * Determine the differences between two instances of #AccessibleStateSet.
1117 * Not Yet Implemented.
1119 * @see AccessibleStateSet_equals().
1121 * Returns: an #AccessibleStateSet object containing all states contained on one of
1122 * the two sets but not the other.
1125 AccessibleStateSet *
1126 AccessibleStateSet_compare (AccessibleStateSet *obj,
1127 AccessibleStateSet *obj2)
1129 cspi_return_val_if_fail (obj != NULL, NULL);
1130 cspi_return_val_if_fail (obj2 != NULL, NULL);
1135 * AccessibleStateSet_isEmpty:
1136 * @obj: a pointer to the #AccessibleStateSet object on which to operate.
1138 * Determine whether a given #AccessibleStateSet is the empty set.
1140 * Returns: #TRUE if the given #AccessibleStateSet contains no (true) states,
1145 AccessibleStateSet_isEmpty (AccessibleStateSet *obj)
1147 cspi_return_val_if_fail (obj != NULL, FALSE);
1149 /* return Accessibility_StateSet_isEmpty (CSPI_OBJREF (obj), cspi_ev ());*/