atk/atkhyperlink.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_HYPERLINK_H__
  21 #define __ATK_HYPERLINK_H__
  22
  23 #ifdef __cplusplus
  24 extern "C" {
  25 #endif /* __cplusplus */
  26
  27 #include <atk/atkaction.h>
  28
  29 /*
  30  * AtkHyperlink encapsulates a link or set of links in a hypertext document.
  31  *
  32  * It implements the AtkAction interface.
  33  */
  34
  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))
  41
  42 typedef struct _AtkHyperlink                      AtkHyperlink;
  43 typedef struct _AtkHyperlinkClass                 AtkHyperlinkClass;
  44
  45 struct _AtkHyperlink
  46 {
  47   GObject parent;
  48 };
  49
  50 struct _AtkHyperlinkClass
  51 {
  52   GObjectClass parent;
  53
  54   /*
  55    * Returns a string specifying the URI associated with the nth anchor
  56    * of this link.
  57    */
  58   gchar*           (* get_uri)             (AtkHyperlink     *link_,
  59                                             gint             i);
  60   /*
  61    * Returns an object which represents the link action, as appropriate for
  62    * that link.
  63    */
  64   AtkObject*       (* get_object)          (AtkHyperlink     *link_,
  65                                             gint             i);
  66   /*
  67    * Gets the index with the hypertext document at which this link ends
  68    */
  69   gint             (* get_end_index)       (AtkHyperlink     *link_);
  70
  71   /*
  72    * Gets the index with the hypertext document at which this link begins
  73    */
  74   gint             (* get_start_index)     (AtkHyperlink     *link_);
  75
  76   /*
  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)
  80    */
  81   gboolean         (* is_valid)            (AtkHyperlink     *link_);
  82
  83   /*
  84    * Returns the number of anchors associated with this link
  85    */
  86   gint             (* get_n_anchors)       (AtkHyperlink     *link_);
  87
  88   AtkFunction      pad1;
  89   AtkFunction      pad2;
  90   AtkFunction      pad3;
  91   AtkFunction      pad4;
  92 };
  93
  94 GType            atk_hyperlink_get_type             (void);
  95
  96 gchar*           atk_hyperlink_get_uri              (AtkHyperlink     *link_,
  97                                                      gint             i);
  98
  99 AtkObject*       atk_hyperlink_get_object           (AtkHyperlink     *link_,
 100                                                      gint             i);
 101
 102 gint             atk_hyperlink_get_end_index        (AtkHyperlink     *link_);
 103
 104 gint             atk_hyperlink_get_start_index      (AtkHyperlink     *link_);
 105
 106 gboolean         atk_hyperlink_is_valid             (AtkHyperlink     *link_);
 107
 108 gint             atk_hyperlink_get_n_anchors        (AtkHyperlink     *link_);
 109
 110
 111 #ifdef __cplusplus
 112 }
 113 #endif /* __cplusplus */
 114
 115
 116 #endif /* __ATK_HYPERLINK_H__ */