atk/atkhyperlinkimpl.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 #if defined(ATK_DISABLE_SINGLE_INCLUDES) && !defined (__ATK_H_INSIDE__) && !defined (ATK_COMPILATION)
  21 #error "Only <atk/atk.h> can be included directly."
  22 #endif
  23
  24 #ifndef __ATK_HYPERLINK_IMPL_H__
  25 #define __ATK_HYPERLINK_IMPL_H__
  26
  27 #include <atk/atkobject.h>
  28 #include <atk/atkhyperlink.h>
  29
  30 G_BEGIN_DECLS
  31
  32 /*
  33  * The AtkHyperlinkImpl interface should be supported by objects
  34  * exposed within the hierarchy as children of an AtkHypertext container
  35  * which correspond to "links" or embedded content within the text.
  36  * HTML anchors are not, for instance, normally exposed this way,
  37  * but embedded images and components which appear inline in the
  38  * content of a text object are. The AtkHyperlinkIface interface
  39  * allows a means of determining which children are hyperlinks in this
  40  * sense of the word, and for obtaining their corresponding AtkHyperlink
  41  * object, from which the embedding range, URI, etc. can be obtained.
  42  *
  43  * To some extent this interface exists because, for historical
  44  * reasons, AtkHyperlink was defined as an object type, not an interface.
  45  * Thus, in order to interact with AtkObjects via AtkHyperlink semantics,
  46  * a new interface was required.
  47  */
  48
  49 #define ATK_TYPE_HYPERLINK_IMPL          (atk_hyperlink_impl_get_type ())
  50 #define ATK_IS_HYPERLINK_IMPL(obj)       G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_HYPERLINK_IMPL)
  51 #define ATK_HYPERLINK_IMPL(obj)             G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_HYPERLINK_IMPL, AtkHyperlinkImpl)
  52 #define ATK_HYPERLINK_IMPL_GET_IFACE(obj)   G_TYPE_INSTANCE_GET_INTERFACE ((obj), ATK_TYPE_HYPERLINK_IMPL, AtkHyperlinkImplIface)
  53
  54 #ifndef _TYPEDEF_ATK_HYPERLINK_IMPL_
  55 #define _TYPEDEF_ATK_HYPERLINK_IMPL__
  56 typedef struct _AtkHyperlinkImpl AtkHyperlinkImpl;
  57 #endif
  58 typedef struct _AtkHyperlinkImplIface AtkHyperlinkImplIface;
  59
  60 struct _AtkHyperlinkImplIface
  61 {
  62   GTypeInterface parent;
  63
  64   AtkHyperlink*  (* get_hyperlink) (AtkHyperlinkImpl *impl);
  65
  66   AtkFunction pad1;
  67 };
  68
  69 GType            atk_hyperlink_impl_get_type (void);
  70
  71 AtkHyperlink    *atk_hyperlink_impl_get_hyperlink (AtkHyperlinkImpl *obj);
  72
  73 G_END_DECLS
  74
  75 #endif /* __ATK_HYPERLINK_IMPL_H__ */