/* ATK - The Accessibility Toolkit for GTK+
- * Copyright 2001 Sun Microsystems Inc.
+ * Copyright 2001, 2002, 2003 Sun Microsystems Inc.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* Boston, MA 02111-1307, USA.
*/
+#include "config.h"
+
#include "atkhypertext.h"
+/**
+ * SECTION:atkhypertext
+ * @Short_description: The ATK interface which provides standard
+ * mechanism for manipulating hyperlinks.
+ * @Title:AtkHypertext
+ *
+ * An interface used for objects which implement linking between
+ * multiple resource or content locations, or multiple 'markers'
+ * within a single document. A Hypertext instance is associated with
+ * one or more Hyperlinks, which are associated with particular
+ * offsets within the Hypertext's included content. While this
+ * interface is derived from Text, there is no requirement that
+ * Hypertext instances have textual content; they may implement Image
+ * as well, and Hyperlinks need not have non-zero text offsets.
+ */
+
enum {
LINK_SELECTED,
LAST_SIGNAL
GType
-atk_hypertext_get_type ()
+atk_hypertext_get_type (void)
{
static GType type = 0;
if (!initialized)
{
+ /**
+ * AtkHypertext::link-selected:
+ * @atkhypertext: the object which received the signal.
+ * @arg1: the index of the hyperlink which is selected
+ *
+ * The "link-selected" signal is emitted by an AtkHyperText
+ * object when one of the hyperlinks associated with the object
+ * is selected.
+ */
atk_hypertext_signals[LINK_SELECTED] =
g_signal_new ("link_selected",
ATK_TYPE_HYPERTEXT,
* Gets the link in this hypertext document at index
* @link_index
*
- * Returns: the link in this hypertext document at
+ * Returns: (transfer none): the link in this hypertext document at
* index @link_index
**/
AtkHyperlink*
g_return_val_if_fail (ATK_IS_HYPERTEXT (hypertext), NULL);
+ if (link_index < 0)
+ return NULL;
+
iface = ATK_HYPERTEXT_GET_IFACE (hypertext);
if (iface->get_link)
* @char_index: a character index
*
* Gets the index into the array of hyperlinks that is associated with
- * the character specified by @char_index, or -1 if there is no hyperlink
- * associated with this character.
+ * the character specified by @char_index.
*
- * Returns: an index into the array of hyperlinks in @hypertext
+ * Returns: an index into the array of hyperlinks in @hypertext,
+ * or -1 if there is no hyperlink associated with this character.
**/
gint
atk_hypertext_get_link_index (AtkHypertext *hypertext,
g_return_val_if_fail (ATK_IS_HYPERTEXT (hypertext), -1);
+ if (char_index < 0)
+ return -1;
+
iface = ATK_HYPERTEXT_GET_IFACE (hypertext);
if (iface->get_link_index)