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. For instance,
111 * the returned #AtkObject will implement #AtkText if @link is a text hyperlink,
112 * #AtkImage if @link is an image hyperlink etc.
114 * Multiple anchors are primarily used by client-side image maps.
116 * Returns: an #AtkObject associated with this hyperlinks i-th anchor.
119 atk_hyperlink_get_object (AtkHyperlink *link,
122 AtkHyperlinkClass *klass;
124 g_return_val_if_fail (link != NULL, NULL);
125 g_return_val_if_fail (ATK_IS_HYPERLINK (link), NULL);
127 klass = ATK_HYPERLINK_GET_CLASS (link);
128 if (klass->get_object)
129 return (klass->get_object) (link, i);
135 * atk_hyperlink_get_end_index:
136 * @link: an #AtkHyperlink
138 * Gets the index with the hypertext document at which this link ends
140 * Returns: the index with the hypertext document at which this link ends
143 atk_hyperlink_get_end_index (AtkHyperlink *link)
145 AtkHyperlinkClass *klass;
147 g_return_val_if_fail (link != NULL, 0);
148 g_return_val_if_fail (ATK_IS_HYPERLINK (link), 0);
150 klass = ATK_HYPERLINK_GET_CLASS (link);
151 if (klass->get_end_index)
152 return (klass->get_end_index) (link);
158 * atk_hyperlink_get_start_index:
159 * @link: an #AtkHyperlink
161 * Gets the index with the hypertext document at which this link begins
163 * Returns: the index with the hypertext document at which this link begins
166 atk_hyperlink_get_start_index (AtkHyperlink *link)
168 AtkHyperlinkClass *klass;
170 g_return_val_if_fail (link != NULL, 0);
171 g_return_val_if_fail (ATK_IS_HYPERLINK (link), 0);
173 klass = ATK_HYPERLINK_GET_CLASS (link);
174 if (klass->get_start_index)
175 return (klass->get_start_index) (link);
181 * atk_hyperlink_is_valid:
182 * @link: an #AtkHyperlink
184 * Since the document a link is associated with may have changed, this
185 * method returns whether or not this link is still valid (with respect
186 * to the document is references)
188 * Returns: whether or not this link is still valid.
191 atk_hyperlink_is_valid (AtkHyperlink *link)
193 AtkHyperlinkClass *klass;
195 g_return_val_if_fail (link != NULL, FALSE);
196 g_return_val_if_fail (ATK_IS_HYPERLINK (link), FALSE);
198 klass = ATK_HYPERLINK_GET_CLASS (link);
200 return (klass->is_valid) (link);
206 * atk_hyperlink_get_n_anchors:
207 * @link: an #AtkHyperlink
209 * Gets the number of anchors associated with this hyperlink
211 * Returns: the number of anchors associated with this hyperlink
214 atk_hyperlink_get_n_anchors (AtkHyperlink *link)
216 AtkHyperlinkClass *klass;
218 g_return_val_if_fail (link != NULL, 0);
219 g_return_val_if_fail (ATK_IS_HYPERLINK (link), 0);
221 klass = ATK_HYPERLINK_GET_CLASS (link);
222 if (klass->get_n_anchors)
223 return (klass->get_n_anchors) (link);
228 static void atk_hyperlink_action_iface_init (AtkActionIface *iface)
233 * When we come to derive a class from AtkHyperlink we will provide an
234 * implementation of the AtkAction interface.
236 * This depends on being able to override an interface in a derived class
237 * which currently (March 2001) is not implemented but will be in GTK+ 2.0.