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 #if defined(ATK_DISABLE_SINGLE_INCLUDES) && !defined (__ATK_H_INSIDE__) && !defined (ATK_COMPILATION)
  24 #error "Only <atk/atk.h> can be included directly."
  25 #endif
  26
  27 #include <atk/atkobject.h>
  28 #include <atk/atkhyperlink.h>
  29
  30 G_BEGIN_DECLS
  31
  32 /*
  33  * The AtkHypertext interface provides standard  mechanisms for manipulating
  34  * hyperlinks.
  35  */
  36
  37 #define ATK_TYPE_HYPERTEXT                    (atk_hypertext_get_type ())
  38 #define ATK_IS_HYPERTEXT(obj)                 G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_HYPERTEXT)
  39 #define ATK_HYPERTEXT(obj)                    G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_HYPERTEXT, AtkHypertext)
  40 #define ATK_HYPERTEXT_GET_IFACE(obj)          (G_TYPE_INSTANCE_GET_INTERFACE ((obj), ATK_TYPE_HYPERTEXT, AtkHypertextIface))
  41
  42 #ifndef _TYPEDEF_ATK_HYPERTEXT_
  43 #define _TYPEDEF_ATK_HYPERTEXT_
  44 typedef struct _AtkHypertext AtkHypertext;
  45 #endif
  46 typedef struct _AtkHypertextIface AtkHypertextIface;
  47
  48 struct _AtkHypertextIface
  49 {
  50   GTypeInterface parent;
  51
  52   AtkHyperlink*(* get_link)                 (AtkHypertext       *hypertext,
  53                                              gint               link_index);
  54   gint         (* get_n_links)              (AtkHypertext       *hypertext);
  55   gint         (* get_link_index)           (AtkHypertext       *hypertext,
  56                                              gint               char_index);
  57
  58   /*
  59    * signal handlers
  60    */
  61   void         (* link_selected)            (AtkHypertext       *hypertext,
  62                                              gint               link_index);
  63 };
  64 ATK_AVAILABLE_IN_ALL
  65 GType atk_hypertext_get_type (void);
  66
  67 ATK_AVAILABLE_IN_ALL
  68 AtkHyperlink* atk_hypertext_get_link       (AtkHypertext *hypertext,
  69                                             gint          link_index);
  70 ATK_AVAILABLE_IN_ALL
  71 gint          atk_hypertext_get_n_links    (AtkHypertext *hypertext);
  72 ATK_AVAILABLE_IN_ALL
  73 gint          atk_hypertext_get_link_index (AtkHypertext *hypertext,
  74                                             gint          char_index);
  75
  76 G_END_DECLS
  77
  78 #endif /* __ATK_HYPERTEXT_H__ */