f326d896bd0157e706725728a0c0e6fb5380e8c0
[platform/upstream/at-spi2-core.git] / atspi / atspi-document.h
1 /*
2  * AT-SPI - Assistive Technology Service Provider Interface
3  * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
4  *
5  * Copyright 2002 Ximian, Inc.
6  *           2002 Sun Microsystems Inc.
7  *           
8  *
9  * This library is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU Library General Public
11  * License as published by the Free Software Foundation; either
12  * version 2 of the License, or (at your option) any later version.
13  *
14  * This library is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17  * Library General Public License for more details.
18  *
19  * You should have received a copy of the GNU Library General Public
20  * License along with this library; if not, write to the
21  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
22  * Boston, MA 02111-1307, USA.
23  */
24
25 #ifndef _ATSPI_DOCUMENT_H_
26 #define _ATSPI_DOCUMENT_H_
27
28 #include "glib-object.h"
29
30 #include "atspi-constants.h"
31
32 #include "atspi-types.h"
33
34 G_BEGIN_DECLS
35
36 #define ATSPI_TYPE_DOCUMENT                    (atspi_document_get_type ())
37 #define ATSPI_IS_DOCUMENT(obj)                 G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATSPI_TYPE_DOCUMENT)
38 #define ATSPI_DOCUMENT(obj)                    G_TYPE_CHECK_INSTANCE_CAST ((obj), ATSPI_TYPE_DOCUMENT, AtspiDocument)
39 #define ATSPI_DOCUMENT_GET_IFACE(obj)          (G_TYPE_INSTANCE_GET_INTERFACE ((obj), ATSPI_TYPE_DOCUMENT, AtspiDocument))
40
41 GType atspi_document_get_type ();
42
43 struct _AtspiDocument
44 {
45   GTypeInterface parent;
46 };
47
48 gchar * atspi_document_get_locale (AtspiDocument *obj, GError **error);
49
50 #ifndef ATSPI_DISABLE_DEPRECATED
51 gchar * atspi_document_get_attribute_value (AtspiDocument *obj, gchar *attribute, GError **error);
52 #endif
53
54 gchar * atspi_document_get_document_attribute_value (AtspiDocument *obj, gchar *attribute, GError **error);
55
56 #ifndef ATSPI_DISABLE_DEPRECATED
57 GHashTable * atspi_document_get_attributes (AtspiDocument *obj, GError **error);
58 #endif
59
60 GHashTable * atspi_document_get_document_attributes (AtspiDocument *obj, GError **error);
61
62 gint atspi_document_get_page_count (AtspiDocument *obj, GError **error);
63 gint atspi_document_get_current_page_number (AtspiDocument *obj, GError **error);
64
65
66 G_END_DECLS
67
68 #endif  /* _ATSPI_DOCUMENT_H_ */