atk/atkhypertext.c

   1 /* ATK - The Accessibility Toolkit for GTK+
   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 Library 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  * Library General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Library 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 "atkhypertext.h"
  21
  22 struct _AtkHypertextIfaceClass
  23 {
  24   GObjectClass parent;
  25 };
  26
  27 typedef struct _AtkHypertextIfaceClass AtkHypertextIfaceClass;
  28
  29 static void atk_hypertext_interface_init (AtkHypertextIfaceClass *klass);
  30
  31 static gpointer parent_class = NULL;
  32
  33
  34 GType
  35 atk_hypertext_get_type ()
  36 {
  37   static GType type = 0;
  38
  39   if (!type) {
  40     static const GTypeInfo tinfo =
  41     {
  42       sizeof (AtkHypertextIface),
  43       NULL,
  44       NULL,
  45       (GInterfaceInitFunc) atk_hypertext_interface_init,
  46     };
  47
  48     type = g_type_register_static (G_TYPE_INTERFACE, "AtkHypertext", &tinfo, 0);
  49   }
  50
  51   return type;
  52 }
  53
  54
  55 /*
  56  */
  57
  58 static void
  59 atk_hypertext_interface_init (AtkHypertextIfaceClass *klass)
  60 {
  61   parent_class = g_type_class_ref (ATK_TYPE_HYPERTEXT);
  62 }
  63
  64 /**
  65  *atk_hypertext_get_link:
  66  *@hypertext: an #AtkHypertext
  67  *@link_index: the index of the link to be returned
  68  *
  69  * Gets the link in this hypertext document at index
  70  * @link_index
  71  *
  72  *Returns: the link in this hypertext document at
  73  * index @link_index
  74  **/
  75 AtkHyperLink*
  76 atk_hypertext_get_link (AtkHypertext  *hypertext,
  77                         gint          link_index)
  78 {
  79   AtkHypertextIface *iface;
  80
  81   g_return_val_if_fail (hypertext != NULL, NULL);
  82   g_return_val_if_fail (ATK_IS_HYPERTEXT (hypertext), NULL);
  83
  84   iface = ATK_HYPERTEXT_GET_IFACE (hypertext);
  85
  86   if (iface->get_link)
  87     return (*(iface->get_link)) (hypertext, link_index);
  88   else
  89     return NULL;
  90 }
  91
  92 /**
  93  *atk_hypertext_get_n_links:
  94  *@hypertext: an #AtkHypertext
  95  *
  96  * Gets the number of links within this hypertext document.
  97  *
  98  *Returns: the number of links within this hypertext document
  99  **/
 100 gint
 101 atk_hypertext_get_n_links (AtkHypertext  *hypertext)
 102 {
 103   AtkHypertextIface *iface;
 104
 105   g_return_val_if_fail (hypertext != NULL, 0);
 106   g_return_val_if_fail (ATK_IS_HYPERTEXT (hypertext), 0);
 107
 108   iface = ATK_HYPERTEXT_GET_IFACE (hypertext);
 109
 110   if (iface->get_n_links)
 111     return (*(iface->get_n_links)) (hypertext);
 112   else
 113     return 0;
 114 }
 115
 116 /**
 117  *atk_hypertext_get_link_index:
 118  *@hypertext: an #AtkHypertext
 119  *@char_index: a character index
 120  *
 121  * Gets the index into the array of hyperlinks that is associated with
 122  * @char_index character index, or -1 if there is no hyperlink associated with
 123  * @char_index.
 124  *
 125  * Returns: the index into the array of hyperlinks that is associated with
 126  * @char_index character index, or -1 if there is no hyperlink associated with
 127  * @char_index.
 128  **/
 129 gint
 130 atk_hypertext_get_link_index (AtkHypertext  *hypertext,
 131                               gint          char_index)
 132 {
 133   AtkHypertextIface *iface;
 134
 135   g_return_val_if_fail (hypertext != NULL, -1);
 136   g_return_val_if_fail (ATK_IS_HYPERTEXT (hypertext), -1);
 137
 138   iface = ATK_HYPERTEXT_GET_IFACE (hypertext);
 139
 140   if (iface->get_link_index)
 141     return (*(iface->get_link_index)) (hypertext, char_index);
 142   else
 143     return -1;
 144 }