Added docs and C bindings for AccessibleStateSet and AccessibleRelationSet.

[platform/core/uifw/at-spi2-atk.git] / cspi / spi_hyperlink.c

diff --git a/cspi/spi_hyperlink.c b/cspi/spi_hyperlink.c
index 7df6612..4d039b6 100644 (file)
--- a/cspi/spi_hyperlink.c
+++ b/cspi/spi_hyperlink.c
@@ -1,3 +1,12 @@
+/**
+ * AccessibleHyperlink_ref:
+ * @obj: a pointer to the #AccessibleHyperlink object on which to operate.
+ *
+ * Increment the reference count for an #AccessibleHyperlink object.
+ *
+ * Returns: (no return code implemented yet).
+ *
+ **/
 int
 AccessibleHyperlink_ref (AccessibleHyperlink *obj)
 {
@@ -7,6 +16,15 @@ AccessibleHyperlink_ref (AccessibleHyperlink *obj)
 
 
 
+/**
+ * AccessibleHyperlink_unref:
+ * @obj: a pointer to the #AccessibleHyperlink object on which to operate.
+ *
+ * Decrement the reference count for an #AccessibleHyperlink object.
+ *
+ * Returns: (no return code implemented yet).
+ *
+ **/
 int
 AccessibleHyperlink_unref (AccessibleHyperlink *obj)
 {
@@ -14,8 +32,19 @@ AccessibleHyperlink_unref (AccessibleHyperlink *obj)
   return 0;
 }
 
-
-
+/**
+ * AccessibleHyperlink_getNAnchors:
+ * @obj: a pointer to the #AccessibleHyperlink object on which to operate.
+ *
+ * Get the total number of anchors which an #AccessibleHyperlink implementor has.
+ *       Though typical hyperlinks have only one anchor, client-side image maps and
+ *       other hypertext objects may potentially activate or refer to multiple
+ *       URIs.  For each anchor there is a corresponding URI and object.
+ * @see AccessibleHyperlink_getURI() and AccessibleHyperlink_getObject().
+ *
+ * Returns: a #long indicating the number of anchors in this hyperlink.
+ *
+ **/
 long
 AccessibleHyperlink_getNAnchors (AccessibleHyperlink *obj)
 {
@@ -24,33 +53,62 @@ AccessibleHyperlink_getNAnchors (AccessibleHyperlink *obj)
 }
 
 
-
+/**
+ * AccessibleHyperlink_getURI:
+ * @obj: a pointer to the #AccessibleHyperlink implementor on which to operate.
+ * @i: a (zero-index) long integer indicating which hyperlink anchor to query.
+ *
+ * Get the URI associated with a particular hyperlink anchor.  
+ *
+ * Returns: a UTF-8 string giving the URI of the @ith hyperlink anchor.
+ *
+ **/
 char *
 AccessibleHyperlink_getURI (AccessibleHyperlink *obj,
-                            long i)
+                            long int i)
 {
   return (char *)
     Accessibility_Hyperlink_getURI (*obj,
                                    (CORBA_long) i, &ev);
 }
 
-
-
-Accessible
+/**
+ * AccessibleHyperlink_getObject:
+ * @obj: a pointer to the #AccessibleHyperlink implementor on which to operate.
+ * @i: a (zero-index) long integer indicating which hyperlink anchor to query.
+ *
+ * Get the object associated with a particular hyperlink anchor, as an #Accessible. 
+ *
+ * Returns: an #Accessible that represents the object associated with the @ith anchor
+ *        of the specified #AccessibleHyperlink.
+ *
+ **/
+Accessible*
 AccessibleHyperlink_getObject (AccessibleHyperlink *obj,
-                               long i)
+                               long int i)
 {
-  return (Accessible)
+  return Obj_Add (
     Accessibility_Hyperlink_getObject (*obj,
-                                      (CORBA_long) i, &ev);
+                                      (CORBA_long) i, &ev));
 }
 
-
-
+/**
+ * AccessibleHyperlink_getIndexRange:
+ * @obj: a pointer to the #AccessibleHyperlink implementor on which to operate.
+ * @startIndex: a pointer to a long integer into which the starting
+ *       offset of the text associated with this #AccessibleHyperlink is returned.
+ * @endIndex: a pointer to a long integer into which the offset of the first character
+ *       after the text associated with this #AccessibleHyperlink is returned.
+ *
+ *
+ * Get the starting and ending character offsets of the text range associated with
+ *       a #AccessibleHyperlink, in its originating #AccessibleHypertext.
+ *
+ **/
 void
 AccessibleHyperlink_getIndexRange (AccessibleHyperlink *obj,
-                                   long *startIndex,
-                                   long *endIndex)
+                                   long int *startIndex,
+                                   long int *endIndex)
 {
   *startIndex = (long)
     Accessibility_Hyperlink__get_startIndex (*obj, &ev);
@@ -60,6 +118,17 @@ AccessibleHyperlink_getIndexRange (AccessibleHyperlink *obj,
 
 
 
+/**
+ * AccessibleHyperlink_isValid:
+ * @obj: a pointer to the #AccessibleHyperlink on which to operate.
+ *
+ * Tell whether an #AccessibleHyperlink object is still valid with respect to its
+ *          originating hypertext object.
+ *
+ * Returns: #TRUE of the specified #AccessibleHyperlink is still valid with respect
+ *          to its originating #AccessibleHypertext object, #FALSE otherwise.
+ *
+ **/
 boolean
 AccessibleHyperlink_isValid (AccessibleHyperlink *obj)
 {