-#include "spi-util.h"
-
-int
+/*
+ * AT-SPI - Assistive Technology Service Provider Interface
+ * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
+ *
+ * Copyright 2001, 2002 Sun Microsystems Inc.,
+ * Copyright 2001, 2002 Ximian, Inc.
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Library General Public
+ * License as published by the Free Software Foundation; either
+ * version 2 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Library General Public License for more details.
+ *
+ * You should have received a copy of the GNU Library General Public
+ * License along with this library; if not, write to the
+ * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+ * Boston, MA 02111-1307, USA.
+ */
+
+#include <cspi/spi-private.h>
+
+/**
+ * AccessibleHyperlink_ref:
+ * @obj: a pointer to the #AccessibleHyperlink object on which to operate.
+ *
+ * Increment the reference count for an #AccessibleHyperlink object.
+ **/
+void
AccessibleHyperlink_ref (AccessibleHyperlink *obj)
{
- Accessibility_Hyperlink_ref (*obj, &ev);
- return 0;
+ cspi_object_ref (obj);
}
-
-
-int
+/**
+ * AccessibleHyperlink_unref:
+ * @obj: a pointer to the #AccessibleHyperlink object on which to operate.
+ *
+ * Decrement the reference count for an #AccessibleHyperlink object.
+ **/
+void
AccessibleHyperlink_unref (AccessibleHyperlink *obj)
{
- Accessibility_Hyperlink_unref (*obj, &ev);
- return 0;
+ cspi_object_ref (obj);
}
-
-
+/**
+ * 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)
{
- return (long)
- Accessibility_Hyperlink__get_nAnchors (*obj, &ev);
-}
+ long retval;
+
+ cspi_return_val_if_fail (obj != NULL, -1);
+
+ retval =
+ Accessibility_Hyperlink__get_nAnchors (CSPI_OBJREF (obj), cspi_ev ());
+ cspi_return_val_if_ev ("getNAnchors", -1);
+ return retval;
+}
+/**
+ * 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 string_from_corba_string (
- Accessibility_Hyperlink_getURI (*obj,
- (CORBA_long) i, &ev));
-}
+ char *retval;
+ cspi_return_val_if_fail (obj != NULL, NULL);
+ retval =
+ Accessibility_Hyperlink_getURI (CSPI_OBJREF (obj),
+ i, cspi_ev ());
-Accessible
-AccessibleHyperlink_getObject (AccessibleHyperlink *obj,
- long i)
-{
- return (Accessible)
- Accessibility_Hyperlink_getObject (*obj,
- (CORBA_long) i, &ev);
+ cspi_return_val_if_ev ("getURI", NULL);
+
+ return retval;
}
+/**
+ * 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 int i)
+{
+ cspi_return_val_if_fail (obj != NULL, NULL);
+ return cspi_object_add (
+ Accessibility_Hyperlink_getObject (CSPI_OBJREF (obj),
+ i, cspi_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);
- *endIndex = (long)
- Accessibility_Hyperlink__get_endIndex (*obj, &ev);
-}
+ CORBA_long si, ei;
+ cspi_return_if_fail (obj != NULL);
+si = Accessibility_Hyperlink__get_startIndex (CSPI_OBJREF (obj), cspi_ev ());
+ cspi_return_if_ev ("startIndex");
+ ei = Accessibility_Hyperlink__get_endIndex (CSPI_OBJREF (obj), cspi_ev ());
-boolean
+ cspi_return_if_ev ("endIndex");
+ *startIndex = si;
+ *endIndex = ei;
+}
+
+/**
+ * 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.
+ **/
+SPIBoolean
AccessibleHyperlink_isValid (AccessibleHyperlink *obj)
{
- return (boolean)
- Accessibility_Hyperlink_isValid (*obj, &ev);
+ SPIBoolean retval;
+
+ cspi_return_val_if_fail (obj != NULL, FALSE);
+
+ retval =
+ Accessibility_Hyperlink_isValid (CSPI_OBJREF (obj), cspi_ev ());
+
+ cspi_return_val_if_ev ("isValid", FALSE);
+
+ return retval;
}
projects / platform / core / uifw / at-spi2-atk.git / blobdiff