1 /* ATK - Accessibility Toolkit
2 * Copyright 2001, 2002, 2003 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.
21 #include "atkhyperlink.h"
22 #include <glib/gi18n-lib.h>
25 * SECTION:atkhyperlink
26 * @Short_description: An ATK object which encapsulates a link or set
27 * of links in a hypertext document.
30 * An ATK object which encapsulates a link or set of links (for
31 * instance in the case of client-side image maps) in a hypertext
32 * document. It may implement the AtkAction interface. AtkHyperlink
33 * may also be used to refer to inline embedded content, since it
34 * allows specification of a start and end offset within the host
35 * AtkHypertext object.
47 PROP_0
, /* gobject convention */
56 static void atk_hyperlink_class_init (AtkHyperlinkClass
*klass
);
57 static void atk_hyperlink_init (AtkHyperlink
*link
,
58 AtkHyperlinkClass
*klass
);
60 static void atk_hyperlink_real_get_property (GObject
*object
,
65 static void atk_hyperlink_action_iface_init (AtkActionIface
*iface
);
67 static guint atk_hyperlink_signals
[LAST_SIGNAL
] = { 0, };
69 static gpointer parent_class
= NULL
;
72 atk_hyperlink_get_type (void)
74 static GType type
= 0;
78 static const GTypeInfo typeInfo
=
80 sizeof (AtkHyperlinkClass
),
82 (GBaseFinalizeFunc
) NULL
,
83 (GClassInitFunc
) atk_hyperlink_class_init
,
84 (GClassFinalizeFunc
) NULL
,
86 sizeof (AtkHyperlink
),
88 (GInstanceInitFunc
) atk_hyperlink_init
,
91 static const GInterfaceInfo action_info
=
93 (GInterfaceInitFunc
) atk_hyperlink_action_iface_init
,
94 (GInterfaceFinalizeFunc
) NULL
,
98 type
= g_type_register_static (G_TYPE_OBJECT
, "AtkHyperlink", &typeInfo
, 0) ;
99 g_type_add_interface_static (type
, ATK_TYPE_ACTION
, &action_info
);
105 atk_hyperlink_class_init (AtkHyperlinkClass
*klass
)
107 GObjectClass
*gobject_class
= G_OBJECT_CLASS (klass
);
109 parent_class
= g_type_class_peek_parent (klass
);
111 gobject_class
->get_property
= atk_hyperlink_real_get_property
;
113 klass
->link_activated
= NULL
;
116 * AtkHyperlink:selected-link:
120 * Deprecated: 1.8: Please use ATK_STATE_FOCUSABLE for all links, and
121 * ATK_STATE_FOCUSED for focused links.
123 g_object_class_install_property (gobject_class
,
125 g_param_spec_boolean ("selected-link",
127 _("Specifies whether the AtkHyperlink object is selected"),
130 g_object_class_install_property (gobject_class
,
132 g_param_spec_int ("number-of-anchors",
133 _("Number of Anchors"),
134 _("The number of anchors associated with the AtkHyperlink object"),
139 g_object_class_install_property (gobject_class
,
141 g_param_spec_int ("end-index",
143 _("The end index of the AtkHyperlink object"),
148 g_object_class_install_property (gobject_class
,
150 g_param_spec_int ("start-index",
152 _("The start index of the AtkHyperlink object"),
159 * AtkHyperlink::link-activated:
160 * @atkhyperlink: the object which received the signal.
162 * The signal link-activated is emitted when a link is activated.
164 atk_hyperlink_signals
[LINK_ACTIVATED
] =
165 g_signal_new ("link_activated",
166 G_TYPE_FROM_CLASS (klass
),
168 G_STRUCT_OFFSET (AtkHyperlinkClass
, link_activated
),
170 g_cclosure_marshal_VOID__VOID
,
177 atk_hyperlink_init (AtkHyperlink
*link
,
178 AtkHyperlinkClass
*klass
)
183 atk_hyperlink_real_get_property (GObject
*object
,
190 link
= ATK_HYPERLINK (object
);
194 case PROP_SELECTED_LINK
:
195 // This property is deprecated, also the method to get the value
196 g_value_set_boolean (value
, FALSE
);
198 case PROP_NUMBER_ANCHORS
:
199 g_value_set_int (value
, atk_hyperlink_get_n_anchors (link
));
202 g_value_set_int (value
, atk_hyperlink_get_end_index (link
));
204 case PROP_START_INDEX
:
205 g_value_set_int (value
, atk_hyperlink_get_start_index (link
));
213 * atk_hyperlink_get_uri:
214 * @link_: an #AtkHyperlink
215 * @i: a (zero-index) integer specifying the desired anchor
217 * Get a the URI associated with the anchor specified
220 * Multiple anchors are primarily used by client-side image maps.
222 * Returns: a string specifying the URI
225 atk_hyperlink_get_uri (AtkHyperlink
*link
,
228 AtkHyperlinkClass
*klass
;
230 g_return_val_if_fail (ATK_IS_HYPERLINK (link
), NULL
);
232 klass
= ATK_HYPERLINK_GET_CLASS (link
);
234 return (klass
->get_uri
) (link
, i
);
240 * atk_hyperlink_get_object:
241 * @link_: an #AtkHyperlink
242 * @i: a (zero-index) integer specifying the desired anchor
244 * Returns the item associated with this hyperlinks nth anchor.
245 * For instance, the returned #AtkObject will implement #AtkText
246 * if @link_ is a text hyperlink, #AtkImage if @link_ is an image
249 * Multiple anchors are primarily used by client-side image maps.
251 * Returns: (transfer none): an #AtkObject associated with this hyperlinks
255 atk_hyperlink_get_object (AtkHyperlink
*link
,
258 AtkHyperlinkClass
*klass
;
260 g_return_val_if_fail (ATK_IS_HYPERLINK (link
), NULL
);
262 klass
= ATK_HYPERLINK_GET_CLASS (link
);
263 if (klass
->get_object
)
264 return (klass
->get_object
) (link
, i
);
270 * atk_hyperlink_get_end_index:
271 * @link_: an #AtkHyperlink
273 * Gets the index with the hypertext document at which this link ends.
275 * Returns: the index with the hypertext document at which this link ends
278 atk_hyperlink_get_end_index (AtkHyperlink
*link
)
280 AtkHyperlinkClass
*klass
;
282 g_return_val_if_fail (ATK_IS_HYPERLINK (link
), 0);
284 klass
= ATK_HYPERLINK_GET_CLASS (link
);
285 if (klass
->get_end_index
)
286 return (klass
->get_end_index
) (link
);
292 * atk_hyperlink_get_start_index:
293 * @link_: an #AtkHyperlink
295 * Gets the index with the hypertext document at which this link begins.
297 * Returns: the index with the hypertext document at which this link begins
300 atk_hyperlink_get_start_index (AtkHyperlink
*link
)
302 AtkHyperlinkClass
*klass
;
304 g_return_val_if_fail (ATK_IS_HYPERLINK (link
), 0);
306 klass
= ATK_HYPERLINK_GET_CLASS (link
);
307 if (klass
->get_start_index
)
308 return (klass
->get_start_index
) (link
);
314 * atk_hyperlink_is_valid:
315 * @link_: an #AtkHyperlink
317 * Since the document that a link is associated with may have changed
318 * this method returns %TRUE if the link is still valid (with
319 * respect to the document it references) and %FALSE otherwise.
321 * Returns: whether or not this link is still valid
324 atk_hyperlink_is_valid (AtkHyperlink
*link
)
326 AtkHyperlinkClass
*klass
;
328 g_return_val_if_fail (ATK_IS_HYPERLINK (link
), FALSE
);
330 klass
= ATK_HYPERLINK_GET_CLASS (link
);
332 return (klass
->is_valid
) (link
);
338 * atk_hyperlink_is_inline:
339 * @link_: an #AtkHyperlink
341 * Indicates whether the link currently displays some or all of its
342 * content inline. Ordinary HTML links will usually return
343 * %FALSE, but an inline <src> HTML element will return
346 * Returns: whether or not this link displays its content inline.
350 atk_hyperlink_is_inline (AtkHyperlink
*link
)
352 AtkHyperlinkClass
*klass
;
354 g_return_val_if_fail (ATK_IS_HYPERLINK (link
), FALSE
);
356 klass
= ATK_HYPERLINK_GET_CLASS (link
);
357 if (klass
->link_state
)
358 return (klass
->link_state (link
) & ATK_HYPERLINK_IS_INLINE
);
364 * atk_hyperlink_get_n_anchors:
365 * @link_: an #AtkHyperlink
367 * Gets the number of anchors associated with this hyperlink.
369 * Returns: the number of anchors associated with this hyperlink
372 atk_hyperlink_get_n_anchors (AtkHyperlink
*link
)
374 AtkHyperlinkClass
*klass
;
376 g_return_val_if_fail (ATK_IS_HYPERLINK (link
), 0);
378 klass
= ATK_HYPERLINK_GET_CLASS (link
);
379 if (klass
->get_n_anchors
)
380 return (klass
->get_n_anchors
) (link
);
386 * atk_hyperlink_is_selected_link:
387 * @link_: an #AtkHyperlink
389 * Determines whether this AtkHyperlink is selected
393 * Deprecated: 1.8: Please use ATK_STATE_FOCUSABLE for all links,
394 * and ATK_STATE_FOCUSED for focused links.
396 * Returns: True if the AtkHyperlink is selected, False otherwise
399 atk_hyperlink_is_selected_link (AtkHyperlink
*link
)
401 AtkHyperlinkClass
*klass
;
403 g_return_val_if_fail (ATK_IS_HYPERLINK (link
), FALSE
);
405 klass
= ATK_HYPERLINK_GET_CLASS (link
);
406 if (klass
->is_selected_link
)
407 return (klass
->is_selected_link
) (link
);
412 static void atk_hyperlink_action_iface_init (AtkActionIface
*iface
)
417 * When we come to derive a class from AtkHyperlink we will provide an
418 * implementation of the AtkAction interface.