atk-1.0/atk/atkhypertext.h

0001 /* ATK -  Accessibility Toolkit
0002  * Copyright 2001 Sun Microsystems Inc.
0003  *
0004  * This library is free software; you can redistribute it and/or
0005  * modify it under the terms of the GNU Library General Public
0006  * License as published by the Free Software Foundation; either
0007  * version 2 of the License, or (at your option) any later version.
0008  *
0009  * This library is distributed in the hope that it will be useful,
0010  * but WITHOUT ANY WARRANTY; without even the implied warranty of
0011  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
0012  * Library General Public License for more details.
0013  *
0014  * You should have received a copy of the GNU Library General Public
0015  * License along with this library; if not, write to the
0016  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
0017  * Boston, MA 02111-1307, USA.
0018  */
0019
0020 #ifndef __ATK_HYPERTEXT_H__
0021 #define __ATK_HYPERTEXT_H__
0022
0023 #if defined(ATK_DISABLE_SINGLE_INCLUDES) && !defined(__ATK_H_INSIDE__) && !defined(ATK_COMPILATION)
0024 #error "Only <atk/atk.h> can be included directly."
0025 #endif
0026
0027 #include <atk/atkhyperlink.h>
0028 #include <atk/atkobject.h>
0029
0030 G_BEGIN_DECLS
0031
0032 /*
0033  * The AtkHypertext interface provides standard  mechanisms for manipulating
0034  * hyperlinks.
0035  */
0036
0037 #define ATK_TYPE_HYPERTEXT (atk_hypertext_get_type ())
0038 #define ATK_IS_HYPERTEXT(obj) G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_HYPERTEXT)
0039 #define ATK_HYPERTEXT(obj) G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_HYPERTEXT, AtkHypertext)
0040 #define ATK_HYPERTEXT_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), ATK_TYPE_HYPERTEXT, AtkHypertextIface))
0041
0042 #ifndef _TYPEDEF_ATK_HYPERTEXT_
0043 #define _TYPEDEF_ATK_HYPERTEXT_
0044 typedef struct _AtkHypertext AtkHypertext;
0045 #endif
0046 typedef struct _AtkHypertextIface AtkHypertextIface;
0047
0048 struct _AtkHypertextIface
0049 {
0050   GTypeInterface parent;
0051
0052   AtkHyperlink *(*get_link) (AtkHypertext *hypertext,
0053                              gint link_index);
0054   gint (*get_n_links) (AtkHypertext *hypertext);
0055   gint (*get_link_index) (AtkHypertext *hypertext,
0056                           gint char_index);
0057
0058   /*
0059    * signal handlers
0060    */
0061   void (*link_selected) (AtkHypertext *hypertext,
0062                          gint link_index);
0063 };
0064 ATK_AVAILABLE_IN_ALL
0065 GType atk_hypertext_get_type (void);
0066
0067 ATK_AVAILABLE_IN_ALL
0068 AtkHyperlink *atk_hypertext_get_link (AtkHypertext *hypertext,
0069                                       gint link_index);
0070 ATK_AVAILABLE_IN_ALL
0071 gint atk_hypertext_get_n_links (AtkHypertext *hypertext);
0072 ATK_AVAILABLE_IN_ALL
0073 gint atk_hypertext_get_link_index (AtkHypertext *hypertext,
0074                                    gint char_index);
0075
0076 G_END_DECLS
0077
0078 #endif /* __ATK_HYPERTEXT_H__ */