1 /* ATK - The Accessibility Toolkit for GTK+
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 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.
22 #include "atkhypertext.h"
25 * SECTION:atkhypertext
26 * @Short_description: The ATK interface which provides standard
27 * mechanism for manipulating hyperlinks.
30 * An interface used for objects which implement linking between
31 * multiple resource or content locations, or multiple 'markers'
32 * within a single document. A Hypertext instance is associated with
33 * one or more Hyperlinks, which are associated with particular
34 * offsets within the Hypertext's included content. While this
35 * interface is derived from Text, there is no requirement that
36 * Hypertext instances have textual content; they may implement Image
37 * as well, and Hyperlinks need not have non-zero text offsets.
45 static void atk_hypertext_base_init (AtkHypertextIface
*class);
47 static guint atk_hypertext_signals
[LAST_SIGNAL
] = { 0 };
51 atk_hypertext_get_type (void)
53 static GType type
= 0;
56 static const GTypeInfo tinfo
=
58 sizeof (AtkHypertextIface
),
59 (GBaseInitFunc
) atk_hypertext_base_init
,
60 (GBaseFinalizeFunc
) NULL
,
64 type
= g_type_register_static (G_TYPE_INTERFACE
, "AtkHypertext", &tinfo
, 0);
71 atk_hypertext_base_init (AtkHypertextIface
*class)
73 static gboolean initialized
= FALSE
;
78 * AtkHypertext::link-selected:
79 * @atkhypertext: the object which received the signal.
80 * @arg1: the index of the hyperlink which is selected
82 * The "link-selected" signal is emitted by an AtkHyperText
83 * object when one of the hyperlinks associated with the object
86 atk_hypertext_signals
[LINK_SELECTED
] =
87 g_signal_new ("link_selected",
90 G_STRUCT_OFFSET (AtkHypertextIface
, link_selected
),
91 (GSignalAccumulator
) NULL
, NULL
,
92 g_cclosure_marshal_VOID__INT
,
101 * atk_hypertext_get_link:
102 * @hypertext: an #AtkHypertext
103 * @link_index: an integer specifying the desired link
105 * Gets the link in this hypertext document at index
108 * Returns: (transfer none): the link in this hypertext document at
112 atk_hypertext_get_link (AtkHypertext
*hypertext
,
115 AtkHypertextIface
*iface
;
117 g_return_val_if_fail (ATK_IS_HYPERTEXT (hypertext
), NULL
);
122 iface
= ATK_HYPERTEXT_GET_IFACE (hypertext
);
125 return (*(iface
->get_link
)) (hypertext
, link_index
);
131 * atk_hypertext_get_n_links:
132 * @hypertext: an #AtkHypertext
134 * Gets the number of links within this hypertext document.
136 * Returns: the number of links within this hypertext document
139 atk_hypertext_get_n_links (AtkHypertext
*hypertext
)
141 AtkHypertextIface
*iface
;
143 g_return_val_if_fail (ATK_IS_HYPERTEXT (hypertext
), 0);
145 iface
= ATK_HYPERTEXT_GET_IFACE (hypertext
);
147 if (iface
->get_n_links
)
148 return (*(iface
->get_n_links
)) (hypertext
);
154 * atk_hypertext_get_link_index:
155 * @hypertext: an #AtkHypertext
156 * @char_index: a character index
158 * Gets the index into the array of hyperlinks that is associated with
159 * the character specified by @char_index.
161 * Returns: an index into the array of hyperlinks in @hypertext,
162 * or -1 if there is no hyperlink associated with this character.
165 atk_hypertext_get_link_index (AtkHypertext
*hypertext
,
168 AtkHypertextIface
*iface
;
170 g_return_val_if_fail (ATK_IS_HYPERTEXT (hypertext
), -1);
175 iface
= ATK_HYPERTEXT_GET_IFACE (hypertext
);
177 if (iface
->get_link_index
)
178 return (*(iface
->get_link_index
)) (hypertext
, char_index
);