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_IMPL_H__
michael@0: #define __ATK_HYPERLINK_IMPL_H__
michael@0: 
michael@0: #include <atk/atkobject.h>
michael@0: #include <atk/atkhyperlink.h>
michael@0: 
michael@0: #ifdef __cplusplus
michael@0: extern "C" {
michael@0: #endif /* __cplusplus */
michael@0: 
michael@0: /*
michael@0:  * The AtkHyperlinkImpl interface should be supported by objects
michael@0:  * exposed within the hierarchy as children of an AtkHypertext container
michael@0:  * which correspond to "links" or embedded content within the text.
michael@0:  * HTML anchors are not, for instance, normally exposed this way,
michael@0:  * but embedded images and components which appear inline in the
michael@0:  * content of a text object are. The AtkHyperlinkIface interface
michael@0:  * allows a means of determining which children are hyperlinks in this
michael@0:  * sense of the word, and for obtaining their corresponding AtkHyperlink 
michael@0:  * object, from which the embedding range, URI, etc. can be obtained.
michael@0:  *
michael@0:  * To some extent this interface exists because, for historical 
michael@0:  * reasons, AtkHyperlink was defined as an object type, not an interface.
michael@0:  * Thus, in order to interact with AtkObjects via AtkHyperlink semantics,
michael@0:  * a new interface was required.
michael@0:  */
michael@0: 
michael@0: #define ATK_TYPE_HYPERLINK_IMPL          (atk_hyperlink_impl_get_type ())
michael@0: #define ATK_IS_HYPERLINK_IMPL(obj)       G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_HYPERLINK_IMPL)
michael@0: #define ATK_HYPERLINK_IMPL(obj)             G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_HYPERLINK_IMPL, AtkHyperlinkImpl)
michael@0: #define ATK_HYPERLINK_IMPL_GET_IFACE(obj)   G_TYPE_INSTANCE_GET_INTERFACE ((obj), ATK_TYPE_HYPERLINK_IMPL, AtkHyperlinkImplIface)
michael@0: 
michael@0: #ifndef _TYPEDEF_ATK_HYPERLINK_IMPL_
michael@0: #define _TYPEDEF_ATK_HYPERLINK_IMPL__
michael@0: typedef struct _AtkHyperlinkImpl AtkHyperlinkImpl;
michael@0: #endif
michael@0: typedef struct _AtkHyperlinkImplIface AtkHyperlinkImplIface;
michael@0: 
michael@0: struct _AtkHyperlinkImplIface
michael@0: {
michael@0:   GTypeInterface parent;
michael@0:     
michael@0:   AtkHyperlink*  (* get_hyperlink) (AtkHyperlinkImpl *impl);
michael@0: 
michael@0:   AtkFunction pad1;
michael@0: };
michael@0: 
michael@0: GType            atk_hyperlink_impl_get_type (void);
michael@0: 
michael@0: AtkHyperlink    *atk_hyperlink_impl_get_hyperlink (AtkHyperlinkImpl *obj);
michael@0: 
michael@0: #ifdef __cplusplus
michael@0: }
michael@0: #endif /* __cplusplus */
michael@0: 
michael@0: 
michael@0: #endif /* __ATK_HYPERLINK_IMPL_H__ */