1 /* ATK - Accessibility Toolkit
2 * Copyright 2001 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.
20 #ifndef __ATK_HYPERLINK_H__
21 #define __ATK_HYPERLINK_H__
25 #endif /* __cplusplus */
27 #include <atk/atkaction.h>
30 * AtkHyperlink encapsulates a link or set of links in a hypertext document.
32 * It implements the AtkAction interface.
35 #define ATK_TYPE_HYPERLINK (atk_hyperlink_get_type ())
36 #define ATK_HYPERLINK(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_HYPERLINK, AtkHyperlink))
37 #define ATK_HYPERLINK_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), ATK_TYPE_HYPERLINK, AtkHyperlinkClass))
38 #define ATK_IS_HYPERLINK(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_HYPERLINK))
39 #define ATK_IS_HYPERLINK_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), ATK_TYPE_HYPERLINK))
40 #define ATK_HYPERLINK_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), ATK_TYPE_HYPERLINK, AtkHyperlinkClass))
42 typedef struct _AtkHyperlink AtkHyperlink;
43 typedef struct _AtkHyperlinkClass AtkHyperlinkClass;
50 struct _AtkHyperlinkClass
55 * Returns a string specifying the URI associated with the nth anchor
58 gchar* (* get_uri) (AtkHyperlink *link,
61 * Returns an object which represents the link action, as appropriate for
64 AtkObject* (* get_object) (AtkHyperlink *link,
67 * Gets the index with the hypertext document at which this link ends
69 gint (* get_end_index) (AtkHyperlink *link);
72 * Gets the index with the hypertext document at which this link begins
74 gint (* get_start_index) (AtkHyperlink *link);
77 * Since the document a link is associated with may have changed, this
78 * method returns whether or not this link is still valid (with respect
79 * to the document is references)
81 gboolean (* is_valid) (AtkHyperlink *link);
84 * Returns the number of anchors associated with this link
86 gint (* get_n_anchors) (AtkHyperlink *link);
94 GType atk_hyperlink_get_type (void);
96 gchar* atk_hyperlink_get_uri (AtkHyperlink *link,
99 AtkObject* atk_hyperlink_get_object (AtkHyperlink *link,
102 gint atk_hyperlink_get_end_index (AtkHyperlink *link);
104 gint atk_hyperlink_get_start_index (AtkHyperlink *link);
106 gboolean atk_hyperlink_is_valid (AtkHyperlink *link);
108 gint atk_hyperlink_get_n_anchors (AtkHyperlink *link);
113 #endif /* __cplusplus */
116 #endif /* __ATK_HYPERLINK_H__ */