1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
|
/* ATK - Accessibility Toolkit
* Copyright 2001 Sun Microsystems Inc.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public
* License along with this library; if not, write to the
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA.
*/
#if defined(ATK_DISABLE_SINGLE_INCLUDES) && !defined (__ATK_H_INSIDE__) && !defined (ATK_COMPILATION)
#error "Only <atk/atk.h> can be included directly."
#endif
#ifndef __ATK_DOCUMENT_H__
#define __ATK_DOCUMENT_H__
#include <atk/atkobject.h>
#include <atk/atkutil.h>
G_BEGIN_DECLS
/*
* The AtkDocument interface should be supported by any object that is a container
* for 'document content' as opposed to a collection of user interface elements.
*
*/
#define ATK_TYPE_DOCUMENT (atk_document_get_type ())
#define ATK_IS_DOCUMENT(obj) G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_DOCUMENT)
#define ATK_DOCUMENT(obj) G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_DOCUMENT, AtkDocument)
#define ATK_DOCUMENT_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), ATK_TYPE_DOCUMENT, AtkDocumentIface))
#ifndef _TYPEDEF_ATK_DOCUMENT_
#define _TYPEDEF_ATK_DOCUMENT_
typedef struct _AtkDocument AtkDocument;
#endif
typedef struct _AtkDocumentIface AtkDocumentIface;
/**
* AtkDocumentIface:
* @get_document_type: gets a string indicating the document
* type. This virtual function is deprecated since 2.12 and it
* should not be overriden.
* @get_document: a #GObject instance that implements
* AtkDocumentIface. This virtual method is deprecated since 2.12
* and it should not be overriden.
* @get_document_locale: gets locale. This virtual function is
* deprecated since 2.7.90 and it should not be overriden.
* @get_document_attributes: gets an AtkAttributeSet which describes
* document-wide attributes as name-value pairs.
* @get_document_attribute_value: returns a string value assocciated
* with the named attribute for this document, or NULL
* @set_document_attribute: sets the value of an attribute. Returns
* TRUE on success, FALSE otherwise
* @get_current_page_number: gets the current page number. Since 2.12
* @get_page_count: gets the page count of the document. Since 2.12
*/
struct _AtkDocumentIface
{
GTypeInterface parent;
const gchar* ( *get_document_type) (AtkDocument *document);
gpointer ( *get_document) (AtkDocument *document);
const gchar* ( *get_document_locale) (AtkDocument *document);
AtkAttributeSet * ( *get_document_attributes) (AtkDocument *document);
const gchar* ( *get_document_attribute_value) (AtkDocument *document,
const gchar *attribute_name);
gboolean ( *set_document_attribute) (AtkDocument *document,
const gchar *attribute_name,
const gchar *attribute_value);
gint ( *get_current_page_number) (AtkDocument *document);
gint ( *get_page_count) (AtkDocument *document);
};
GType atk_document_get_type (void);
G_DEPRECATED
const gchar* atk_document_get_document_type (AtkDocument *document);
G_DEPRECATED
gpointer atk_document_get_document (AtkDocument *document);
G_DEPRECATED
const gchar* atk_document_get_locale (AtkDocument *document);
AtkAttributeSet* atk_document_get_attributes (AtkDocument *document);
const gchar* atk_document_get_attribute_value (AtkDocument *document,
const gchar *attribute_name);
gboolean atk_document_set_attribute_value (AtkDocument *document,
const gchar *attribute_name,
const gchar *attribute_value);
gint atk_document_get_current_page_number (AtkDocument *document);
gint atk_document_get_page_count (AtkDocument *document);
G_END_DECLS
#endif /* __ATK_DOCUMENT_H__ */
|