1 /* ATK - Accessibility Toolkit
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 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.
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.
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.
20 #include "atkhyperlink.h"
23 static void atk_hyperlink_class_init (AtkHyperlinkClass *klass);
24 static void atk_hyperlink_init (AtkHyperlink *link,
25 AtkHyperlinkClass *klass);
27 static void atk_hyperlink_action_iface_init (AtkActionIface *iface);
29 static gpointer parent_class = NULL;
32 atk_hyperlink_get_type (void)
34 static GType type = 0;
38 static const GTypeInfo typeInfo =
40 sizeof (AtkHyperlinkClass),
42 (GBaseFinalizeFunc) NULL,
43 (GClassInitFunc) atk_hyperlink_class_init,
44 (GClassFinalizeFunc) NULL,
48 (GInstanceInitFunc) atk_hyperlink_init,
51 static const GInterfaceInfo action_info =
53 (GInterfaceInitFunc) atk_hyperlink_action_iface_init,
54 (GInterfaceFinalizeFunc) NULL,
58 type = g_type_register_static (G_TYPE_OBJECT, "AtkHyperlink", &typeInfo, 0) ;
59 g_type_add_interface_static (type, ATK_TYPE_ACTION, &action_info);
65 atk_hyperlink_class_init (AtkHyperlinkClass *klass)
67 parent_class = g_type_class_ref (G_TYPE_OBJECT);
72 atk_hyperlink_init (AtkHyperlink *link,
73 AtkHyperlinkClass *klass)
78 * atk_hyperlink_get_uri:
79 * @link: an #AtkHyperlink
80 * @i: a (zero-index) integer specifying the desired anchor
82 * Get a the URI associated with the anchor specified
85 * Multiple anchors are primarily used by client-side image maps.
87 * Returns: a string specifying the URI
90 atk_hyperlink_get_uri (AtkHyperlink *link,
93 AtkHyperlinkClass *klass;
95 g_return_val_if_fail (link != NULL, NULL);
96 g_return_val_if_fail (ATK_IS_HYPERLINK (link), NULL);
98 klass = ATK_HYPERLINK_GET_CLASS (link);
100 return (klass->get_uri) (link, i);
106 * atk_hyperlink_get_object:
107 * @link: an #AtkHyperlink
108 * @i: a (zero-index) integer specifying the desired anchor
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
115 * Multiple anchors are primarily used by client-side image maps.
117 * Returns: an #AtkObject associated with this hyperlinks i-th anchor
120 atk_hyperlink_get_object (AtkHyperlink *link,
123 AtkHyperlinkClass *klass;
125 g_return_val_if_fail (link != NULL, NULL);
126 g_return_val_if_fail (ATK_IS_HYPERLINK (link), NULL);
128 klass = ATK_HYPERLINK_GET_CLASS (link);
129 if (klass->get_object)
130 return (klass->get_object) (link, i);
136 * atk_hyperlink_get_end_index:
137 * @link: an #AtkHyperlink
139 * Gets the index with the hypertext document at which this link ends.
141 * Returns: the index with the hypertext document at which this link ends
144 atk_hyperlink_get_end_index (AtkHyperlink *link)
146 AtkHyperlinkClass *klass;
148 g_return_val_if_fail (link != NULL, 0);
149 g_return_val_if_fail (ATK_IS_HYPERLINK (link), 0);
151 klass = ATK_HYPERLINK_GET_CLASS (link);
152 if (klass->get_end_index)
153 return (klass->get_end_index) (link);
159 * atk_hyperlink_get_start_index:
160 * @link: an #AtkHyperlink
162 * Gets the index with the hypertext document at which this link begins.
164 * Returns: the index with the hypertext document at which this link begins
167 atk_hyperlink_get_start_index (AtkHyperlink *link)
169 AtkHyperlinkClass *klass;
171 g_return_val_if_fail (link != NULL, 0);
172 g_return_val_if_fail (ATK_IS_HYPERLINK (link), 0);
174 klass = ATK_HYPERLINK_GET_CLASS (link);
175 if (klass->get_start_index)
176 return (klass->get_start_index) (link);
182 * atk_hyperlink_is_valid:
183 * @link: an #AtkHyperlink
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.
189 * Returns: whether or not this link is still valid
192 atk_hyperlink_is_valid (AtkHyperlink *link)
194 AtkHyperlinkClass *klass;
196 g_return_val_if_fail (link != NULL, FALSE);
197 g_return_val_if_fail (ATK_IS_HYPERLINK (link), FALSE);
199 klass = ATK_HYPERLINK_GET_CLASS (link);
201 return (klass->is_valid) (link);
207 * atk_hyperlink_get_n_anchors:
208 * @link: an #AtkHyperlink
210 * Gets the number of anchors associated with this hyperlink.
212 * Returns: the number of anchors associated with this hyperlink
215 atk_hyperlink_get_n_anchors (AtkHyperlink *link)
217 AtkHyperlinkClass *klass;
219 g_return_val_if_fail (link != NULL, 0);
220 g_return_val_if_fail (ATK_IS_HYPERLINK (link), 0);
222 klass = ATK_HYPERLINK_GET_CLASS (link);
223 if (klass->get_n_anchors)
224 return (klass->get_n_anchors) (link);
229 static void atk_hyperlink_action_iface_init (AtkActionIface *iface)
234 * When we come to derive a class from AtkHyperlink we will provide an
235 * implementation of the AtkAction interface.
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.