/* 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"
-struct _AtkHypertextIfaceClass
-{
- GObjectClass parent;
-};
+/**
+ * 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.
+ */
-typedef struct _AtkHypertextIfaceClass AtkHypertextIfaceClass;
+enum {
+ LINK_SELECTED,
+ LAST_SIGNAL
+};
-static void atk_hypertext_interface_init (AtkHypertextIfaceClass *klass);
+static void atk_hypertext_base_init (AtkHypertextIface *class);
-static gpointer parent_class = NULL;
+static guint atk_hypertext_signals[LAST_SIGNAL] = { 0 };
GType
-atk_hypertext_get_type ()
+atk_hypertext_get_type (void)
{
static GType type = 0;
static const GTypeInfo tinfo =
{
sizeof (AtkHypertextIface),
- NULL,
- NULL,
- (GInterfaceInitFunc) atk_hypertext_interface_init,
+ (GBaseInitFunc) atk_hypertext_base_init,
+ (GBaseFinalizeFunc) NULL,
+
};
type = g_type_register_static (G_TYPE_INTERFACE, "AtkHypertext", &tinfo, 0);
return type;
}
-
-/*
- */
-
static void
-atk_hypertext_interface_init (AtkHypertextIfaceClass *klass)
+atk_hypertext_base_init (AtkHypertextIface *class)
{
- parent_class = g_type_class_ref (ATK_TYPE_HYPERTEXT);
+ static gboolean initialized = FALSE;
+
+ 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,
+ G_SIGNAL_RUN_LAST,
+ G_STRUCT_OFFSET (AtkHypertextIface, link_selected),
+ (GSignalAccumulator) NULL, NULL,
+ g_cclosure_marshal_VOID__INT,
+ G_TYPE_NONE,
+ 1, G_TYPE_INT);
+
+ initialized = TRUE;
+ }
}
-AtkHyperLink*
+/**
+ * atk_hypertext_get_link:
+ * @hypertext: an #AtkHypertext
+ * @link_index: an integer specifying the desired link
+ *
+ * Gets the link in this hypertext document at index
+ * @link_index
+ *
+ * Returns: (transfer none): the link in this hypertext document at
+ * index @link_index
+ **/
+AtkHyperlink*
atk_hypertext_get_link (AtkHypertext *hypertext,
gint link_index)
{
AtkHypertextIface *iface;
- g_return_val_if_fail (hypertext != NULL, NULL);
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)
return NULL;
}
+/**
+ * atk_hypertext_get_n_links:
+ * @hypertext: an #AtkHypertext
+ *
+ * Gets the number of links within this hypertext document.
+ *
+ * Returns: the number of links within this hypertext document
+ **/
gint
atk_hypertext_get_n_links (AtkHypertext *hypertext)
{
AtkHypertextIface *iface;
- g_return_val_if_fail (hypertext != NULL, 0);
g_return_val_if_fail (ATK_IS_HYPERTEXT (hypertext), 0);
iface = ATK_HYPERTEXT_GET_IFACE (hypertext);
return 0;
}
+/**
+ * atk_hypertext_get_link_index:
+ * @hypertext: an #AtkHypertext
+ * @char_index: a character index
+ *
+ * Gets the index into the array of hyperlinks that is associated with
+ * the character specified by @char_index.
+ *
+ * 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,
gint char_index)
{
AtkHypertextIface *iface;
- g_return_val_if_fail (hypertext != NULL, -1);
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)