atk/atkhyperlink.c

   1 /* ATK -  Accessibility Toolkit
   2  * Copyright 2001 Sun Microsystems Inc.
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19
  20 #include "atkhyperlink.h"
  21
  22
  23 static void atk_hyperlink_class_init (AtkHyperlinkClass *klass);
  24 static void atk_hyperlink_init       (AtkHyperlink      *link,
  25                                       AtkHyperlinkClass *klass);
  26
  27 static void atk_hyperlink_action_iface_init (AtkActionIface *iface);
  28
  29 static gpointer  parent_class = NULL;
  30
  31 GType
  32 atk_hyperlink_get_type (void)
  33 {
  34   static GType type = 0;
  35
  36   if (!type)
  37     {
  38       static const GTypeInfo typeInfo =
  39       {
  40         sizeof (AtkHyperlinkClass),
  41         (GBaseInitFunc) NULL,
  42         (GBaseFinalizeFunc) NULL,
  43         (GClassInitFunc) atk_hyperlink_class_init,
  44         (GClassFinalizeFunc) NULL,
  45         NULL,
  46         sizeof (AtkObject),
  47         0,
  48         (GInstanceInitFunc) atk_hyperlink_init,
  49       } ;
  50
  51       static const GInterfaceInfo action_info =
  52       {
  53         (GInterfaceInitFunc) atk_hyperlink_action_iface_init,
  54         (GInterfaceFinalizeFunc) NULL,
  55         NULL
  56       };
  57
  58       type = g_type_register_static (G_TYPE_OBJECT, "AtkHyperlink", &typeInfo, 0) ;
  59       g_type_add_interface_static (type, ATK_TYPE_ACTION, &action_info);
  60     }
  61   return type;
  62 }
  63
  64 static void
  65 atk_hyperlink_class_init (AtkHyperlinkClass *klass)
  66 {
  67   parent_class = g_type_class_ref (G_TYPE_OBJECT);
  68
  69 }
  70
  71 static void
  72 atk_hyperlink_init  (AtkHyperlink        *link,
  73                      AtkHyperlinkClass   *klass)
  74 {
  75 }
  76
  77 /**
  78  * atk_hyperlink_get_uri:
  79  * @link: an #AtkHyperlink
  80  * @i: a (zero-index) integer specifying the desired anchor
  81  *
  82  * Get a the URI associated with the anchor specified
  83  * by @i of @link.
  84  *
  85  * Multiple anchors are primarily used by client-side image maps.
  86  *
  87  * Returns: a string specifying the URI
  88  **/
  89 gchar*
  90 atk_hyperlink_get_uri (AtkHyperlink *link,
  91                        gint         i)
  92 {
  93   AtkHyperlinkClass *klass;
  94
  95   g_return_val_if_fail (link != NULL, NULL);
  96   g_return_val_if_fail (ATK_IS_HYPERLINK (link), NULL);
  97
  98   klass = ATK_HYPERLINK_GET_CLASS (link);
  99   if (klass->get_uri)
 100     return (klass->get_uri) (link, i);
 101   else
 102     return NULL;
 103 }
 104
 105 /**
 106  * atk_hyperlink_get_object:
 107  * @link: an #AtkHyperlink
 108  * @i: a (zero-index) integer specifying the desired anchor
 109  *
 110  * Returns the item associated with this hyperlinks nth anchor.
 111  * For instance, the returned #AtkObject will implement #AtkText
 112  * if @link is a text hyperlink, #AtkImage if @link is an image
 113  * hyperlink etc.
 114  *
 115  * Multiple anchors are primarily used by client-side image maps.
 116  *
 117  * Returns: an #AtkObject associated with this hyperlinks i-th anchor
 118  **/
 119 AtkObject*
 120 atk_hyperlink_get_object (AtkHyperlink *link,
 121                           gint         i)
 122 {
 123   AtkHyperlinkClass *klass;
 124
 125   g_return_val_if_fail (link != NULL, NULL);
 126   g_return_val_if_fail (ATK_IS_HYPERLINK (link), NULL);
 127
 128   klass = ATK_HYPERLINK_GET_CLASS (link);
 129   if (klass->get_object)
 130     return (klass->get_object) (link, i);
 131   else
 132     return NULL;
 133 }
 134
 135 /**
 136  * atk_hyperlink_get_end_index:
 137  * @link: an #AtkHyperlink
 138  *
 139  * Gets the index with the hypertext document at which this link ends.
 140  *
 141  * Returns: the index with the hypertext document at which this link ends
 142  **/
 143 gint
 144 atk_hyperlink_get_end_index (AtkHyperlink *link)
 145 {
 146   AtkHyperlinkClass *klass;
 147
 148   g_return_val_if_fail (link != NULL, 0);
 149   g_return_val_if_fail (ATK_IS_HYPERLINK (link), 0);
 150
 151   klass = ATK_HYPERLINK_GET_CLASS (link);
 152   if (klass->get_end_index)
 153     return (klass->get_end_index) (link);
 154   else
 155     return 0;
 156 }
 157
 158 /**
 159  * atk_hyperlink_get_start_index:
 160  * @link: an #AtkHyperlink
 161  *
 162  * Gets the index with the hypertext document at which this link begins.
 163  *
 164  * Returns: the index with the hypertext document at which this link begins
 165  **/
 166 gint
 167 atk_hyperlink_get_start_index (AtkHyperlink *link)
 168 {
 169   AtkHyperlinkClass *klass;
 170
 171   g_return_val_if_fail (link != NULL, 0);
 172   g_return_val_if_fail (ATK_IS_HYPERLINK (link), 0);
 173
 174   klass = ATK_HYPERLINK_GET_CLASS (link);
 175   if (klass->get_start_index)
 176     return (klass->get_start_index) (link);
 177   else
 178     return 0;
 179 }
 180
 181 /**
 182  * atk_hyperlink_is_valid:
 183  * @link: an #AtkHyperlink
 184  *
 185  * Since the document that a link is associated with may have changed
 186  * this method returns %TRUE if the link is still valid (with
 187  * respect to the document it references) and %FALSE otherwise.
 188  *
 189  * Returns: whether or not this link is still valid
 190  **/
 191 gboolean
 192 atk_hyperlink_is_valid (AtkHyperlink *link)
 193 {
 194   AtkHyperlinkClass *klass;
 195
 196   g_return_val_if_fail (link != NULL, FALSE);
 197   g_return_val_if_fail (ATK_IS_HYPERLINK (link), FALSE);
 198
 199   klass = ATK_HYPERLINK_GET_CLASS (link);
 200   if (klass->is_valid)
 201     return (klass->is_valid) (link);
 202   else
 203     return FALSE;
 204 }
 205
 206 /**
 207  * atk_hyperlink_get_n_anchors:
 208  * @link: an #AtkHyperlink
 209  *
 210  * Gets the number of anchors associated with this hyperlink.
 211  *
 212  * Returns: the number of anchors associated with this hyperlink
 213  **/
 214 gint
 215 atk_hyperlink_get_n_anchors (AtkHyperlink *link)
 216 {
 217   AtkHyperlinkClass *klass;
 218
 219   g_return_val_if_fail (link != NULL, 0);
 220   g_return_val_if_fail (ATK_IS_HYPERLINK (link), 0);
 221
 222   klass = ATK_HYPERLINK_GET_CLASS (link);
 223   if (klass->get_n_anchors)
 224     return (klass->get_n_anchors) (link);
 225   else
 226     return 0;
 227 }
 228
 229 static void atk_hyperlink_action_iface_init (AtkActionIface *iface)
 230 {
 231   /*
 232    * We do nothing here
 233    *
 234    * When we come to derive a class from AtkHyperlink we will provide an
 235    * implementation of the AtkAction interface.
 236    *
 237    * This depends on being able to override an interface in a derived class
 238    * which currently (March 2001) is not implemented but will be in GTK+ 2.0.
 239    */
 240 }