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_DOCUMENT_H__
michael@0: #define __ATK_DOCUMENT_H__
michael@0: 
michael@0: #include <atk/atkobject.h>
michael@0: #include <atk/atkutil.h>
michael@0: 
michael@0: #ifdef __cplusplus
michael@0: extern "C" {
michael@0: #endif /* __cplusplus */
michael@0: 
michael@0: /*
michael@0:  * The AtkDocument interface should be supported by any object that is a container
michael@0:  * for 'document content' as opposed to a collection of user interface elements.
michael@0:  *
michael@0:  */
michael@0: 
michael@0: #define ATK_TYPE_DOCUMENT                   (atk_document_get_type ())
michael@0: #define ATK_IS_DOCUMENT(obj)                G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_DOCUMENT)
michael@0: #define ATK_DOCUMENT(obj)                   G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_DOCUMENT, AtkDocument)
michael@0: #define ATK_DOCUMENT_GET_IFACE(obj)         (G_TYPE_INSTANCE_GET_INTERFACE ((obj), ATK_TYPE_DOCUMENT, AtkDocumentIface))
michael@0: 
michael@0: #ifndef _TYPEDEF_ATK_DOCUMENT_
michael@0: #define _TYPEDEF_ATK_DOCUMENT_
michael@0: typedef struct _AtkDocument AtkDocument;
michael@0: #endif
michael@0: typedef struct _AtkDocumentIface AtkDocumentIface;
michael@0: 
michael@0: struct _AtkDocumentIface
michael@0: {
michael@0:   GTypeInterface parent;
michael@0:   G_CONST_RETURN gchar* ( *get_document_type) (AtkDocument              *document);
michael@0:   gpointer              ( *get_document)      (AtkDocument              *document);
michael@0: 
michael@0:   G_CONST_RETURN gchar* ( *get_document_locale) (AtkDocument              *document);
michael@0:   AtkAttributeSet *     ( *get_document_attributes) (AtkDocument        *document);
michael@0:   G_CONST_RETURN gchar* ( *get_document_attribute_value) (AtkDocument   *document,
michael@0:                                                           const gchar   *attribute_name);
michael@0:   gboolean              ( *set_document_attribute) (AtkDocument         *document,
michael@0:                                                     const gchar         *attribute_name,
michael@0:                                                     const gchar         *attribute_value);
michael@0:   AtkFunction pad1;
michael@0:   AtkFunction pad2;
michael@0:   AtkFunction pad3;
michael@0:   AtkFunction pad4;
michael@0: };
michael@0: 
michael@0: GType  atk_document_get_type             (void);
michael@0: 
michael@0: G_CONST_RETURN gchar* atk_document_get_document_type (AtkDocument   *document);
michael@0: gpointer atk_document_get_document (AtkDocument   *document);
michael@0: G_CONST_RETURN gchar* atk_document_get_locale (AtkDocument *document);
michael@0: AtkAttributeSet*      atk_document_get_attributes (AtkDocument *document);
michael@0: G_CONST_RETURN gchar* atk_document_get_attribute_value (AtkDocument *document, 
michael@0:                                                         const gchar *attribute_name);
michael@0: gboolean              atk_document_set_attribute_value (AtkDocument *document,
michael@0:                                                         const gchar *attribute_name,
michael@0:                                                         const gchar *attribute_value);
michael@0: #ifdef __cplusplus
michael@0: }
michael@0: #endif /* __cplusplus */
michael@0: #endif /* __ATK_DOCUMENT_H__ */