michael@0: /* ATK -  Accessibility Toolkit
michael@0:  * Copyright 2001 Sun Microsystems Inc.
michael@0:  *
michael@0:  * This library is free software; you can redistribute it and/or
michael@0:  * modify it under the terms of the GNU Library General Public
michael@0:  * License as published by the Free Software Foundation; either
michael@0:  * version 2 of the License, or (at your option) any later version.
michael@0:  *
michael@0:  * This library is distributed in the hope that it will be useful,
michael@0:  * but WITHOUT ANY WARRANTY; without even the implied warranty of
michael@0:  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
michael@0:  * Library General Public License for more details.
michael@0:  *
michael@0:  * You should have received a copy of the GNU Library General Public
michael@0:  * License along with this library; if not, write to the
michael@0:  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
michael@0:  * Boston, MA 02111-1307, USA.
michael@0:  */
michael@0: 
michael@0: #ifndef __ATK_HYPERLINK_H__
michael@0: #define __ATK_HYPERLINK_H__
michael@0: 
michael@0: #ifdef __cplusplus
michael@0: extern "C" {
michael@0: #endif /* __cplusplus */
michael@0: 
michael@0: #include <atk/atkaction.h>
michael@0: 
michael@0: /*
michael@0:  * AtkHyperlink encapsulates a link or set of links in a hypertext document.
michael@0:  *
michael@0:  * It implements the AtkAction interface.
michael@0:  */
michael@0: 
michael@0: /**
michael@0:  *AtkHyperlinkStateFlags
michael@0:  *@ATK_HYPERLINK_IS_INLINE: Link is inline
michael@0:  *
michael@0:  *Describes the type of link
michael@0:  **/ 
michael@0: typedef enum 
michael@0: {
michael@0:   ATK_HYPERLINK_IS_INLINE = 1 << 0
michael@0: } AtkHyperlinkStateFlags;
michael@0: 
michael@0: #define ATK_TYPE_HYPERLINK                        (atk_hyperlink_get_type ())
michael@0: #define ATK_HYPERLINK(obj)                        (G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_HYPERLINK, AtkHyperlink))
michael@0: #define ATK_HYPERLINK_CLASS(klass)                (G_TYPE_CHECK_CLASS_CAST ((klass), ATK_TYPE_HYPERLINK, AtkHyperlinkClass))
michael@0: #define ATK_IS_HYPERLINK(obj)                     (G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_HYPERLINK))
michael@0: #define ATK_IS_HYPERLINK_CLASS(klass)             (G_TYPE_CHECK_CLASS_TYPE ((klass), ATK_TYPE_HYPERLINK))
michael@0: #define ATK_HYPERLINK_GET_CLASS(obj)              (G_TYPE_INSTANCE_GET_CLASS ((obj), ATK_TYPE_HYPERLINK, AtkHyperlinkClass))
michael@0: 
michael@0: typedef struct _AtkHyperlink                      AtkHyperlink;
michael@0: typedef struct _AtkHyperlinkClass                 AtkHyperlinkClass;
michael@0: 
michael@0: struct _AtkHyperlink
michael@0: {
michael@0:   GObject parent;
michael@0: };
michael@0: 
michael@0: struct _AtkHyperlinkClass
michael@0: {
michael@0:   GObjectClass parent;
michael@0: 
michael@0:   gchar*           (* get_uri)             (AtkHyperlink     *link_,
michael@0:                                             gint             i);
michael@0:   AtkObject*       (* get_object)          (AtkHyperlink     *link_,
michael@0:                                             gint             i);
michael@0:   gint             (* get_end_index)       (AtkHyperlink     *link_);
michael@0:   gint             (* get_start_index)     (AtkHyperlink     *link_);
michael@0:   gboolean         (* is_valid)            (AtkHyperlink     *link_);
michael@0:   gint	           (* get_n_anchors)	   (AtkHyperlink     *link_);
michael@0:   guint	           (* link_state)	   (AtkHyperlink     *link_);
michael@0:   gboolean         (* is_selected_link)    (AtkHyperlink     *link_);
michael@0: 
michael@0:   /* Signals */
michael@0:   void             ( *link_activated)      (AtkHyperlink     *link_);
michael@0:   AtkFunction      pad1;
michael@0: };
michael@0: 
michael@0: GType            atk_hyperlink_get_type             (void);
michael@0: 
michael@0: gchar*           atk_hyperlink_get_uri              (AtkHyperlink     *link_,
michael@0:                                                      gint             i);
michael@0: 
michael@0: AtkObject*       atk_hyperlink_get_object           (AtkHyperlink     *link_,
michael@0:                                                      gint             i);
michael@0: 
michael@0: gint             atk_hyperlink_get_end_index        (AtkHyperlink     *link_);
michael@0: 
michael@0: gint             atk_hyperlink_get_start_index      (AtkHyperlink     *link_);
michael@0: 
michael@0: gboolean         atk_hyperlink_is_valid             (AtkHyperlink     *link_);
michael@0: 
michael@0: gboolean         atk_hyperlink_is_inline             (AtkHyperlink     *link_);
michael@0: 
michael@0: gint		 atk_hyperlink_get_n_anchors        (AtkHyperlink     *link_);
michael@0: gboolean         atk_hyperlink_is_selected_link     (AtkHyperlink     *link_);
michael@0: 
michael@0: 
michael@0: #ifdef __cplusplus
michael@0: }
michael@0: #endif /* __cplusplus */
michael@0: 
michael@0: 
michael@0: #endif /* __ATK_HYPERLINK_H__ */