Change AtkHyperLink to AtkHyperlink in comment Change AtkHyperLink to
[platform/upstream/atk.git] / atk / atkhypertext.h
1 /* ATK -  Accessibility Toolkit
2  * Copyright 2001 Sun Microsystems Inc.
3  *
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.
8  *
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.
13  *
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.
18  */
19
20 #ifndef __ATK_HYPERTEXT_H__
21 #define __ATK_HYPERTEXT_H__
22
23 #include <atk/atkobject.h>
24 #include <atk/atkhyperlink.h>
25
26 #ifdef __cplusplus
27 extern "C" {
28 #endif /* __cplusplus */
29
30 /* The AtkHypertext class is the base class for all classes that present 
31  * hypertext information on the display. This class provides the standard 
32  * mechanism for an assistive technology to access that text via its 
33  * content, attributes, and spatial location. It also provides standard 
34  * mechanisms for manipulating hyperlinks.
35  *
36  * I do not think that there is a GTK+ widget for this but I assume that 
37  * there will be a custom widget so we define the interface.
38  */
39
40 #define ATK_TYPE_HYPERTEXT                    (atk_hypertext_get_type ())
41 #define ATK_IS_HYPERTEXT(obj)                 G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_HYPERTEXT)
42 #define ATK_HYPERTEXT(obj)                    G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_HYPERTEXT, AtkHypertext)
43 #define ATK_HYPERTEXT_GET_IFACE(obj)          (G_TYPE_INSTANCE_GET_INTERFACE ((obj), ATK_TYPE_HYPERTEXT, AtkHypertextIface))
44
45 #ifndef _TYPEDEF_ATK_HYPERTEXT_
46 #define _TYPEDEF_ATK_HYPERTEXT_
47 typedef struct _AtkHypertext AtkHypertext;
48 #endif
49 typedef struct _AtkHypertextIface AtkHypertextIface;
50
51 struct _AtkHypertextIface
52 {
53   GTypeInterface parent;
54
55   AtkHyperlink*(* get_link)                 (AtkHypertext       *hypertext,
56                                              gint               link_index);
57   gint         (* get_n_links)              (AtkHypertext       *hypertext);
58   gint         (* get_link_index)           (AtkHypertext       *hypertext,
59                                              gint               char_index);
60
61 };
62 GType atk_hypertext_get_type (void);
63
64 AtkHyperlink* atk_hypertext_get_link       (AtkHypertext *hypertext,
65                                             gint          link_index);
66 gint          atk_hypertext_get_n_links    (AtkHypertext *hypertext);
67 gint          atk_hypertext_get_link_index (AtkHypertext *hypertext,
68                                             gint          char_index);
69
70
71 #ifdef __cplusplus
72 }
73 #endif /* __cplusplus */
74
75
76 #endif /* __ATK_HYPERTEXT_H__ */