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.
20 #include "atkhyperlink.h"
32 PROP_0
, /* gobject convention */
41 static void atk_hyperlink_class_init (AtkHyperlinkClass
*klass
);
42 static void atk_hyperlink_init (AtkHyperlink
*link
,
43 AtkHyperlinkClass
*klass
);
45 static void atk_hyperlink_real_get_property (GObject
*object
,
50 static void atk_hyperlink_action_iface_init (AtkActionIface
*iface
);
52 static guint atk_hyperlink_signals
[LAST_SIGNAL
] = { 0, };
54 static gpointer parent_class
= NULL
;
57 atk_hyperlink_get_type (void)
59 static GType type
= 0;
63 static const GTypeInfo typeInfo
=
65 sizeof (AtkHyperlinkClass
),
67 (GBaseFinalizeFunc
) NULL
,
68 (GClassInitFunc
) atk_hyperlink_class_init
,
69 (GClassFinalizeFunc
) NULL
,
71 sizeof (AtkHyperlink
),
73 (GInstanceInitFunc
) atk_hyperlink_init
,
76 static const GInterfaceInfo action_info
=
78 (GInterfaceInitFunc
) atk_hyperlink_action_iface_init
,
79 (GInterfaceFinalizeFunc
) NULL
,
83 type
= g_type_register_static (G_TYPE_OBJECT
, "AtkHyperlink", &typeInfo
, 0) ;
84 g_type_add_interface_static (type
, ATK_TYPE_ACTION
, &action_info
);
90 atk_hyperlink_class_init (AtkHyperlinkClass
*klass
)
92 GObjectClass
*gobject_class
= G_OBJECT_CLASS (klass
);
94 parent_class
= g_type_class_peek_parent (klass
);
96 gobject_class
->get_property
= atk_hyperlink_real_get_property
;
98 klass
->link_activated
= NULL
;
100 g_object_class_install_property (gobject_class
,
102 g_param_spec_boolean ("selected-link",
104 _("Specifies whether the AtkHyperlink object is selected"),
107 g_object_class_install_property (gobject_class
,
109 g_param_spec_int ("number-of-anchors",
110 _("Number of Anchors"),
111 _("The number of anchors associated with the AtkHyperlink object"),
116 g_object_class_install_property (gobject_class
,
118 g_param_spec_int ("end-index",
120 _("The end index of the AtkHyperlink object"),
125 g_object_class_install_property (gobject_class
,
127 g_param_spec_int ("start-index",
129 _("The start index of the AtkHyperlink object"),
134 atk_hyperlink_signals
[LINK_ACTIVATED
] =
135 g_signal_new ("link_activated",
136 G_TYPE_FROM_CLASS (klass
),
138 G_STRUCT_OFFSET (AtkHyperlinkClass
, link_activated
),
140 g_cclosure_marshal_VOID__VOID
,
147 atk_hyperlink_init (AtkHyperlink
*link
,
148 AtkHyperlinkClass
*klass
)
153 atk_hyperlink_real_get_property (GObject
*object
,
160 link
= ATK_HYPERLINK (object
);
164 case PROP_SELECTED_LINK
:
165 g_value_set_boolean (value
, atk_hyperlink_is_selected_link (link
));
167 case PROP_NUMBER_ANCHORS
:
168 g_value_set_int (value
, atk_hyperlink_get_n_anchors (link
));
171 g_value_set_int (value
, atk_hyperlink_get_end_index (link
));
173 case PROP_START_INDEX
:
174 g_value_set_int (value
, atk_hyperlink_get_start_index (link
));
182 * atk_hyperlink_get_uri:
183 * @link_: an #AtkHyperlink
184 * @i: a (zero-index) integer specifying the desired anchor
186 * Get a the URI associated with the anchor specified
189 * Multiple anchors are primarily used by client-side image maps.
191 * Returns: a string specifying the URI
194 atk_hyperlink_get_uri (AtkHyperlink
*link
,
197 AtkHyperlinkClass
*klass
;
199 g_return_val_if_fail (ATK_IS_HYPERLINK (link
), NULL
);
201 klass
= ATK_HYPERLINK_GET_CLASS (link
);
203 return (klass
->get_uri
) (link
, i
);
209 * atk_hyperlink_get_object:
210 * @link_: an #AtkHyperlink
211 * @i: a (zero-index) integer specifying the desired anchor
213 * Returns the item associated with this hyperlinks nth anchor.
214 * For instance, the returned #AtkObject will implement #AtkText
215 * if @link_ is a text hyperlink, #AtkImage if @link_ is an image
218 * Multiple anchors are primarily used by client-side image maps.
220 * Returns: (transfer none): an #AtkObject associated with this hyperlinks
224 atk_hyperlink_get_object (AtkHyperlink
*link
,
227 AtkHyperlinkClass
*klass
;
229 g_return_val_if_fail (ATK_IS_HYPERLINK (link
), NULL
);
231 klass
= ATK_HYPERLINK_GET_CLASS (link
);
232 if (klass
->get_object
)
233 return (klass
->get_object
) (link
, i
);
239 * atk_hyperlink_get_end_index:
240 * @link_: an #AtkHyperlink
242 * Gets the index with the hypertext document at which this link ends.
244 * Returns: the index with the hypertext document at which this link ends
247 atk_hyperlink_get_end_index (AtkHyperlink
*link
)
249 AtkHyperlinkClass
*klass
;
251 g_return_val_if_fail (ATK_IS_HYPERLINK (link
), 0);
253 klass
= ATK_HYPERLINK_GET_CLASS (link
);
254 if (klass
->get_end_index
)
255 return (klass
->get_end_index
) (link
);
261 * atk_hyperlink_get_start_index:
262 * @link_: an #AtkHyperlink
264 * Gets the index with the hypertext document at which this link begins.
266 * Returns: the index with the hypertext document at which this link begins
269 atk_hyperlink_get_start_index (AtkHyperlink
*link
)
271 AtkHyperlinkClass
*klass
;
273 g_return_val_if_fail (ATK_IS_HYPERLINK (link
), 0);
275 klass
= ATK_HYPERLINK_GET_CLASS (link
);
276 if (klass
->get_start_index
)
277 return (klass
->get_start_index
) (link
);
283 * atk_hyperlink_is_valid:
284 * @link_: an #AtkHyperlink
286 * Since the document that a link is associated with may have changed
287 * this method returns %TRUE if the link is still valid (with
288 * respect to the document it references) and %FALSE otherwise.
290 * Returns: whether or not this link is still valid
293 atk_hyperlink_is_valid (AtkHyperlink
*link
)
295 AtkHyperlinkClass
*klass
;
297 g_return_val_if_fail (ATK_IS_HYPERLINK (link
), FALSE
);
299 klass
= ATK_HYPERLINK_GET_CLASS (link
);
301 return (klass
->is_valid
) (link
);
307 * atk_hyperlink_is_inline:
308 * @link_: an #AtkHyperlink
310 * Indicates whether the link currently displays some or all of its
311 * content inline. Ordinary HTML links will usually return
312 * %FALSE, but an inline <src> HTML element will return
315 * Returns: whether or not this link displays its content inline.
319 atk_hyperlink_is_inline (AtkHyperlink
*link
)
321 AtkHyperlinkClass
*klass
;
323 g_return_val_if_fail (ATK_IS_HYPERLINK (link
), FALSE
);
325 klass
= ATK_HYPERLINK_GET_CLASS (link
);
326 if (klass
->link_state
)
327 return (klass
->link_state (link
) & ATK_HYPERLINK_IS_INLINE
);
333 * atk_hyperlink_get_n_anchors:
334 * @link_: an #AtkHyperlink
336 * Gets the number of anchors associated with this hyperlink.
338 * Returns: the number of anchors associated with this hyperlink
341 atk_hyperlink_get_n_anchors (AtkHyperlink
*link
)
343 AtkHyperlinkClass
*klass
;
345 g_return_val_if_fail (ATK_IS_HYPERLINK (link
), 0);
347 klass
= ATK_HYPERLINK_GET_CLASS (link
);
348 if (klass
->get_n_anchors
)
349 return (klass
->get_n_anchors
) (link
);
355 * atk_hyperlink_is_selected_link:
356 * @link_: an #AtkHyperlink
358 * Determines whether this AtkHyperlink is selected
362 * @Deprecated: This method is deprecated since ATK version 1.8.
363 * Please use ATK_STATE_SELECTED to indicate when a hyperlink within a
364 * Hypertext container is selected.
366 * Returns: True is the AtkHyperlink is selected, False otherwise
369 atk_hyperlink_is_selected_link (AtkHyperlink
*link
)
371 AtkHyperlinkClass
*klass
;
373 g_return_val_if_fail (ATK_IS_HYPERLINK (link
), FALSE
);
375 klass
= ATK_HYPERLINK_GET_CLASS (link
);
376 if (klass
->is_selected_link
)
377 return (klass
->is_selected_link
) (link
);
382 static void atk_hyperlink_action_iface_init (AtkActionIface
*iface
)
387 * When we come to derive a class from AtkHyperlink we will provide an
388 * implementation of the AtkAction interface.