Added new atk document interface.
[platform/upstream/atk.git] / atk / atkdocument.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 #ifndef __ATK_DOCUMENT_H__
21 #define __ATK_DOCUMENT_H__
22
23 #include <atk/atkobject.h>
24 #include <atk/atkutil.h>
25
26 #ifdef __cplusplus
27 extern "C" {
28 #endif /* __cplusplus */
29
30 /*
31  * The AtkDocument interface should be supported by any object that has an 
32  * associated document object model (DOM). This interface provides the
33  * standard mechanism allowing an assistive technology access to the DOM.
34  */
35
36 #define ATK_TYPE_DOCUMENT                   (atk_document_get_type ())
37 #define ATK_IS_DOCUMENT(obj)                G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_DOCUMENT)
38 #define ATK_DOCUMENT(obj)                   G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_DOCUMENT, AtkDocument)
39 #define ATK_DOCUMENT_GET_IFACE(obj)         (G_TYPE_INSTANCE_GET_INTERFACE ((obj), ATK_TYPE_DOCUMENT, AtkDocumentIface))
40
41 #ifndef _TYPEDEF_ATK_DOCUMENT_
42 #define _TYPEDEF_ATK_DOCUMENT_
43 typedef struct _AtkDocument AtkDocument;
44 #endif
45 typedef struct _AtkDocumentIface AtkDocumentIface;
46
47 struct _AtkDocumentIface
48 {
49   GTypeInterface parent;
50   G_CONST_RETURN gchar* ( *get_document_type) (AtkDocument              *document);
51   gpointer              ( *get_document)      (AtkDocument              *document);
52 };
53
54 GType  atk_document_get_type             (void);
55
56 G_CONST_RETURN gchar* atk_document_get_document_type (AtkDocument   *document);
57 gpointer atk_document_get_document (AtkDocument   *document);
58
59 #ifdef __cplusplus
60 }
61 #endif /* __cplusplus */
62 #endif /* __ATK_DOCUMENT_H__ */