atspi/atspi-hyperlink.c

   1 /*
   2  * AT-SPI - Assistive Technology Service Provider Interface
   3  * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
   4  *
   5  * Copyright 2001, 2002 Sun Microsystems Inc.,
   6  * Copyright 2001, 2002 Ximian, Inc.
   7  * Copyright 2010, 2011 Novell, Inc.
   8  *
   9  * This library is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Library General Public
  11  * License as published by the Free Software Foundation; either
  12  * version 2 of the License, or (at your option) any later version.
  13  *
  14  * This library is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Library General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Library General Public
  20  * License along with this library; if not, write to the
  21  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  22  * Boston, MA 02111-1307, USA.
  23  */
  24
  25 #include "atspi-private.h"
  26
  27 G_DEFINE_TYPE (AtspiHyperlink, atspi_hyperlink, ATSPI_TYPE_OBJECT)
  28
  29 static void
  30 atspi_hyperlink_init (AtspiHyperlink *hyperlink)
  31 {
  32 }
  33
  34 static void
  35 atspi_hyperlink_class_init (AtspiHyperlinkClass *klass)
  36 {
  37 }
  38
  39 AtspiHyperlink *
  40 _atspi_hyperlink_new (AtspiApplication *app, const gchar *path)
  41 {
  42   AtspiHyperlink *hyperlink;
  43
  44   hyperlink = g_object_new (ATSPI_TYPE_HYPERLINK, NULL);
  45   hyperlink->parent.app = g_object_ref (app);
  46   hyperlink->parent.path = g_strdup (path);
  47
  48   return hyperlink;
  49 }
  50
  51 /**
  52  * atspi_hyperlink_get_n_anchors:
  53  * @obj: a pointer to the #AtspiHyperlink object on which to operate.
  54  *
  55  * Gets the total number of anchors which an #AtspiHyperlink implementor has.
  56  * Though typical hyperlinks have only one anchor, client-side image maps and
  57  * other hypertext objects may potentially activate or refer to multiple
  58  * URIs.  For each anchor there is a corresponding URI and object.
  59  *
  60  * see: #atspi_hyperlink_get_uri and #atspi_hyperlink_get_object.
  61  *
  62  * Returns: a #gint indicating the number of anchors in this hyperlink.
  63  **/
  64 gint
  65 atspi_hyperlink_get_n_anchors (AtspiHyperlink *obj, GError **error)
  66 {
  67   dbus_int32_t retval = -1;
  68
  69   g_return_val_if_fail (obj != NULL, -1);
  70
  71   _atspi_dbus_get_property (obj, atspi_interface_hyperlink, "NAnchors", error, "i", &retval);
  72
  73   return retval;
  74 }
  75
  76 /**
  77  * atspi_hyperlink_get_uri:
  78  * @obj: a pointer to the #AtspiHyperlink implementor on which to operate.
  79  * @i: a (zero-index) integer indicating which hyperlink anchor to query.
  80  *
  81  * Gets the URI associated with a particular hyperlink anchor.
  82  *
  83  * Returns: a UTF-8 string giving the URI of the @ith hyperlink anchor.
  84  **/
  85 gchar *
  86 atspi_hyperlink_get_uri (AtspiHyperlink *obj, int i, GError **error)
  87 {
  88   dbus_int32_t d_i = i;
  89   char *retval = NULL;
  90
  91   g_return_val_if_fail (obj != NULL, NULL);
  92
  93   _atspi_dbus_call (obj, atspi_interface_hyperlink, "GetURI", error, "i=>s", d_i, &retval);
  94
  95   if (!retval)
  96     retval = g_strdup ("");
  97
  98   return retval;
  99 }
 100
 101 /**
 102  * atspi_hyperlink_get_object:
 103  * @obj: a pointer to the #AtspiHyperlink implementor on which to operate.
 104  * @i: a (zero-index) #gint indicating which hyperlink anchor to query.
 105  *
 106  * Gets the object associated with a particular hyperlink anchor, as an
 107  * #AtspiAccessible.
 108  *
 109  * Returns: (transfer full): an #AtspiAccessible that represents the object
 110  *        associated with the @ith anchor of the specified #AtspiHyperlink.
 111  **/
 112 AtspiAccessible*
 113 atspi_hyperlink_get_object (AtspiHyperlink *obj, gint i, GError **error)
 114 {
 115   dbus_int32_t d_i = i;
 116   DBusMessage *reply;
 117
 118   g_return_val_if_fail (obj != NULL, NULL);
 119
 120   reply = _atspi_dbus_call_partial (obj, atspi_interface_hyperlink, "GetObject", error, "i", d_i);
 121
 122   return _atspi_dbus_return_accessible_from_message (reply);
 123 }
 124
 125 /**
 126  * atspi_hyperlink_get_index_range:
 127  * @obj: a pointer to the #AtspiHyperlink implementor on which to operate.
 128  *
 129  *
 130  * Gets the starting and ending character offsets of the text range
 131  * associated with an #AtspiHyperlink, in its originating #AtspiHypertext.
 132  **/
 133 AtspiRange *
 134 atspi_hyperlink_get_index_range (AtspiHyperlink *obj, GError **error)
 135 {
 136   dbus_int32_t d_start_offset, d_end_offset;
 137   AtspiRange *ret = g_new (AtspiRange, 1);
 138
 139   ret->start_offset = ret->end_offset = -1;
 140
 141   if (!obj)
 142     return ret;
 143
 144   _atspi_dbus_call (obj, atspi_interface_hyperlink, "GetIndexRange", error, "=>ii", &d_start_offset, &d_end_offset);
 145
 146   ret->start_offset = d_start_offset;
 147   ret->end_offset = d_end_offset;
 148   return ret;
 149 }
 150
 151 /**
 152  * atspi_hyperlink_get_start_index:
 153  * @obj: a pointer to the #AtspiHyperlink implementor on which to operate.
 154  *
 155  *
 156  * Gets the starting character offset of the text range associated with
 157  *       an #AtspiHyperlink, in its originating #AtspiHypertext.
 158  **/
 159 gint
 160 atspi_hyperlink_get_start_index (AtspiHyperlink *obj, GError **error)
 161 {
 162   dbus_int32_t d_start_offset = -1;
 163
 164   if (!obj)
 165     return -1;
 166
 167   _atspi_dbus_get_property (obj, atspi_interface_hyperlink, "StartIndex",
 168                             error, "i", &d_start_offset);
 169
 170   return d_start_offset;
 171 }
 172 /**
 173  * atspi_hyperlink_get_end_index:
 174  * @obj: a pointer to the #AtspiHyperlink implementor on which to operate.
 175  *
 176  *
 177  * Gets the ending character offset of the text range associated with
 178  *       an #AtspiHyperlink, in its originating #AtspiHypertext.
 179  **/
 180 gint
 181 atspi_hyperlink_get_end_index (AtspiHyperlink *obj, GError **error)
 182 {
 183   dbus_int32_t d_end_offset = -1;
 184
 185   if (!obj)
 186     return -1;
 187
 188   _atspi_dbus_get_property (obj, atspi_interface_hyperlink, "EndIndex", error,
 189                             "i", &d_end_offset);
 190
 191   return d_end_offset;
 192 }
 193
 194
 195 /**
 196  * atspi_hyperlink_is_valid:
 197  * @obj: a pointer to the #AtspiHyperlink on which to operate.
 198  *
 199  * Tells whether an #AtspiHyperlink object is still valid with respect to its
 200  *          originating hypertext object.
 201  *
 202  * Returns: #TRUE if the specified #AtspiHyperlink is still valid with respect
 203  *          to its originating #AtspiHypertext object, #FALSE otherwise.
 204  **/
 205 gboolean
 206 atspi_hyperlink_is_valid (AtspiHyperlink *obj, GError **error)
 207 {
 208   dbus_bool_t retval = FALSE;
 209
 210   g_return_val_if_fail (obj != NULL, FALSE);
 211
 212   _atspi_dbus_call (obj, atspi_interface_hyperlink, "IsValid", error, "=>b", &retval);
 213
 214   return retval;
 215 }