Removing pads from interfaces
[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 #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_DOCUMENT_H__
25 #define __ATK_DOCUMENT_H__
26
27 #include <atk/atkobject.h>
28 #include <atk/atkutil.h>
29
30 G_BEGIN_DECLS
31
32 /*
33  * The AtkDocument interface should be supported by any object that is a container
34  * for 'document content' as opposed to a collection of user interface elements.
35  *
36  */
37
38 #define ATK_TYPE_DOCUMENT                   (atk_document_get_type ())
39 #define ATK_IS_DOCUMENT(obj)                G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_DOCUMENT)
40 #define ATK_DOCUMENT(obj)                   G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_DOCUMENT, AtkDocument)
41 #define ATK_DOCUMENT_GET_IFACE(obj)         (G_TYPE_INSTANCE_GET_INTERFACE ((obj), ATK_TYPE_DOCUMENT, AtkDocumentIface))
42
43 #ifndef _TYPEDEF_ATK_DOCUMENT_
44 #define _TYPEDEF_ATK_DOCUMENT_
45 typedef struct _AtkDocument AtkDocument;
46 #endif
47 typedef struct _AtkDocumentIface AtkDocumentIface;
48
49 struct _AtkDocumentIface
50 {
51   GTypeInterface parent;
52   const gchar*          ( *get_document_type) (AtkDocument              *document);
53   gpointer              ( *get_document)      (AtkDocument              *document);
54
55   const gchar*          ( *get_document_locale) (AtkDocument              *document);
56   AtkAttributeSet *     ( *get_document_attributes) (AtkDocument        *document);
57   const gchar*          ( *get_document_attribute_value) (AtkDocument   *document,
58                                                           const gchar   *attribute_name);
59   gboolean              ( *set_document_attribute) (AtkDocument         *document,
60                                                     const gchar         *attribute_name,
61                                                     const gchar         *attribute_value);
62 };
63
64 GType  atk_document_get_type             (void);
65
66 const gchar*          atk_document_get_document_type (AtkDocument   *document);
67 gpointer atk_document_get_document (AtkDocument   *document);
68 #ifndef ATK_DISABLE_DEPRECATED
69 G_DEPRECATED
70 const gchar*          atk_document_get_locale (AtkDocument *document);
71 #endif /* ATK_DISABLE_DEPRECATED */
72 AtkAttributeSet*      atk_document_get_attributes (AtkDocument *document);
73 const gchar*          atk_document_get_attribute_value (AtkDocument *document,
74                                                         const gchar *attribute_name);
75 gboolean              atk_document_set_attribute_value (AtkDocument *document,
76                                                         const gchar *attribute_name,
77                                                         const gchar *attribute_value);
78
79 G_END_DECLS
80
81 #endif /* __ATK_DOCUMENT_H__ */