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
  25 #ifdef __cplusplus
  26 extern "C" {
  27 #endif /* __cplusplus */
  28
  29 /* The AtkHypertext class is the base class for all classes that present
  30  * hypertext information on the display. This class provides the standard
  31  * mechanism for an assistive technology to access that text via its
  32  * content, attributes, and spatial location. It also provides standard
  33  * mechanisms for manipulating hyperlinks.
  34  *
  35  * I do not think that there is a GTK+ widget for this but I assume that
  36  * there will be a custom widget so we define the interface.
  37  */
  38
  39 #define ATK_TYPE_HYPERTEXT                    (atk_hypertext_get_type ())
  40 #define ATK_IS_HYPERTEXT(obj)                 G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_HYPERTEXT)
  41 #define ATK_HYPERTEXT(obj)                    G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_HYPERTEXT, AtkHypertext)
  42 #define ATK_HYPERTEXT_GET_IFACE(obj)          (G_TYPE_INSTANCE_GET_INTERFACE ((obj), ATK_TYPE_HYPERTEXT, AtkHypertextIface))
  43
  44 #ifndef _TYPEDEF_ATK_HYPERTEXT_
  45 #define _TYPEDEF_ATK_HYPERTEXT_
  46 typedef struct _AtkHypertext AtkHypertext;
  47 #endif
  48 typedef struct _AtkHypertextIface AtkHypertextIface;
  49
  50 typedef struct _AtkHyperLink  AtkHyperLink;
  51
  52 struct _AtkHypertextIface
  53 {
  54   GTypeInterface parent;
  55
  56   /*
  57    * Returns the nth link of this hypertext document
  58    */
  59   AtkHyperLink*(* get_link)                 (AtkHypertext       *hypertext,
  60                                              gint               link_index);
  61   /*
  62    * Returns the number of links within this hypertext document.
  63    */
  64   gint         (* get_n_links)              (AtkHypertext       *hypertext);
  65   /*
  66    * Returns the index into the array of hyperlinks that is associated
  67    * this character index, or -1 if there is no hyperlink associated with
  68    * this index.
  69    */
  70   gint         (* get_link_index)           (AtkHypertext       *hypertext,
  71                                              gint               char_index);
  72
  73 };
  74 GType atk_hypertext_get_type (void);
  75
  76 AtkHyperLink* atk_hypertext_get_link       (AtkHypertext *hypertext,
  77                                             gint          link_index);
  78 gint          atk_hypertext_get_n_links    (AtkHypertext *hypertext);
  79 gint          atk_hypertext_get_link_index (AtkHypertext *hypertext,
  80                                             gint          char_index);
  81
  82
  83 #ifdef __cplusplus
  84 }
  85 #endif /* __cplusplus */
  86
  87
  88 #endif /* __ATK_HYPERTEXT_H__ */