1 /* ATK - The Accessibility Toolkit for GTK+
2 * Copyright 2001 Sun Microsystems Inc.
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.
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.
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.
20 #include "atkhypertext.h"
22 struct _AtkHypertextIfaceClass
27 typedef struct _AtkHypertextIfaceClass AtkHypertextIfaceClass;
29 static void atk_hypertext_interface_init (AtkHypertextIfaceClass *klass);
31 static gpointer parent_class = NULL;
35 atk_hypertext_get_type ()
37 static GType type = 0;
40 static const GTypeInfo tinfo =
42 sizeof (AtkHypertextIface),
44 (GBaseFinalizeFunc) NULL,
45 (GInterfaceInitFunc) atk_hypertext_interface_init,
48 type = g_type_register_static (G_TYPE_INTERFACE, "AtkHypertext", &tinfo, 0);
55 atk_hypertext_interface_init (AtkHypertextIfaceClass *klass)
57 parent_class = g_type_class_ref (ATK_TYPE_HYPERTEXT);
61 * atk_hypertext_get_link:
62 * @hypertext: an #AtkHypertext
63 * @link_index: an integer specifying the desired link
65 * Gets the link in this hypertext document at index
68 * Returns: the link in this hypertext document at
72 atk_hypertext_get_link (AtkHypertext *hypertext,
75 AtkHypertextIface *iface;
77 g_return_val_if_fail (hypertext != NULL, NULL);
78 g_return_val_if_fail (ATK_IS_HYPERTEXT (hypertext), NULL);
80 iface = ATK_HYPERTEXT_GET_IFACE (hypertext);
83 return (*(iface->get_link)) (hypertext, link_index);
89 * atk_hypertext_get_n_links:
90 * @hypertext: an #AtkHypertext
92 * Gets the number of links within this hypertext document.
94 * Returns: the number of links within this hypertext document
97 atk_hypertext_get_n_links (AtkHypertext *hypertext)
99 AtkHypertextIface *iface;
101 g_return_val_if_fail (hypertext != NULL, 0);
102 g_return_val_if_fail (ATK_IS_HYPERTEXT (hypertext), 0);
104 iface = ATK_HYPERTEXT_GET_IFACE (hypertext);
106 if (iface->get_n_links)
107 return (*(iface->get_n_links)) (hypertext);
113 * atk_hypertext_get_link_index:
114 * @hypertext: an #AtkHypertext
115 * @char_index: a character index
117 * Gets the index into the array of hyperlinks that is associated with
118 * the character specified by @char_index, or -1 if there is no hyperlink
119 * associated with this character.
121 * Returns: an index into the array of hyperlinks in @hypertext
124 atk_hypertext_get_link_index (AtkHypertext *hypertext,
127 AtkHypertextIface *iface;
129 g_return_val_if_fail (hypertext != NULL, -1);
130 g_return_val_if_fail (ATK_IS_HYPERTEXT (hypertext), -1);
132 iface = ATK_HYPERTEXT_GET_IFACE (hypertext);
134 if (iface->get_link_index)
135 return (*(iface->get_link_index)) (hypertext, char_index);