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, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 #if defined(ATK_DISABLE_SINGLE_INCLUDES) && !defined (__ATK_H_INSIDE__) && !defined (ATK_COMPILATION)
  19 #error "Only <atk/atk.h> can be included directly."
  20 #endif
  21
  22 #ifndef __ATK_HYPERLINK_H__
  23 #define __ATK_HYPERLINK_H__
  24
  25 #include <atk/atkaction.h>
  26
  27 G_BEGIN_DECLS
  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 /**
  36  *AtkHyperlinkStateFlags:
  37  *@ATK_HYPERLINK_IS_INLINE: Link is inline
  38  *
  39  *Describes the type of link
  40  **/
  41 typedef enum
  42 {
  43   ATK_HYPERLINK_IS_INLINE = 1 << 0
  44 } AtkHyperlinkStateFlags;
  45
  46 #define ATK_TYPE_HYPERLINK                        (atk_hyperlink_get_type ())
  47 #define ATK_HYPERLINK(obj)                        (G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_HYPERLINK, AtkHyperlink))
  48 #define ATK_HYPERLINK_CLASS(klass)                (G_TYPE_CHECK_CLASS_CAST ((klass), ATK_TYPE_HYPERLINK, AtkHyperlinkClass))
  49 #define ATK_IS_HYPERLINK(obj)                     (G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_HYPERLINK))
  50 #define ATK_IS_HYPERLINK_CLASS(klass)             (G_TYPE_CHECK_CLASS_TYPE ((klass), ATK_TYPE_HYPERLINK))
  51 #define ATK_HYPERLINK_GET_CLASS(obj)              (G_TYPE_INSTANCE_GET_CLASS ((obj), ATK_TYPE_HYPERLINK, AtkHyperlinkClass))
  52
  53 typedef struct _AtkHyperlink                      AtkHyperlink;
  54 typedef struct _AtkHyperlinkClass                 AtkHyperlinkClass;
  55
  56 struct _AtkHyperlink
  57 {
  58   GObject parent;
  59 };
  60
  61 struct _AtkHyperlinkClass
  62 {
  63   GObjectClass parent;
  64
  65   gchar*           (* get_uri)             (AtkHyperlink     *link_,
  66                                             gint             i);
  67   AtkObject*       (* get_object)          (AtkHyperlink     *link_,
  68                                             gint             i);
  69   gint             (* get_end_index)       (AtkHyperlink     *link_);
  70   gint             (* get_start_index)     (AtkHyperlink     *link_);
  71   gboolean         (* is_valid)            (AtkHyperlink     *link_);
  72   gint             (* get_n_anchors)       (AtkHyperlink     *link_);
  73   guint            (* link_state)          (AtkHyperlink     *link_);
  74   gboolean         (* is_selected_link)    (AtkHyperlink     *link_);
  75
  76   /* Signals */
  77   void             ( *link_activated)      (AtkHyperlink     *link_);
  78   AtkFunction      pad1;
  79 };
  80
  81 GType            atk_hyperlink_get_type             (void);
  82
  83 gchar*           atk_hyperlink_get_uri              (AtkHyperlink     *link_,
  84                                                      gint             i);
  85
  86 AtkObject*       atk_hyperlink_get_object           (AtkHyperlink     *link_,
  87                                                      gint             i);
  88
  89 gint             atk_hyperlink_get_end_index        (AtkHyperlink     *link_);
  90
  91 gint             atk_hyperlink_get_start_index      (AtkHyperlink     *link_);
  92
  93 gboolean         atk_hyperlink_is_valid             (AtkHyperlink     *link_);
  94
  95 gboolean         atk_hyperlink_is_inline             (AtkHyperlink     *link_);
  96
  97 gint             atk_hyperlink_get_n_anchors        (AtkHyperlink     *link_);
  98
  99 G_DEPRECATED
 100 gboolean         atk_hyperlink_is_selected_link     (AtkHyperlink     *link_);
 101
 102 G_END_DECLS
 103
 104 #endif /* __ATK_HYPERLINK_H__ */