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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
|
/*
* AT-SPI - Assistive Technology Service Provider Interface
* (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
*
* Copyright 2001, 2002 Sun Microsystems Inc.,
* Copyright 2001, 2002 Ximian, Inc.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the
* Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301, USA.
*/
#include "atspi-private.h"
/**
* atspi_document_get_locale:
* @obj: a pointer to the #AtspiDocument object on which to operate.
*
* Gets the locale associated with the document's content,
* e.g. the locale for LOCALE_TYPE_MESSAGES.
*
* Returns: a string compliant with the POSIX standard for locale description.
**/
gchar *
atspi_document_get_locale (AtspiDocument *obj, GError **error)
{
gchar *retval = NULL;
g_return_val_if_fail (obj != NULL, g_strdup ("C"));
_atspi_dbus_call (obj, atspi_interface_document, "GetLocale", error, "=>s", &retval);
return retval;
}
/**
* atspi_document_get_attribute_value: (rename-to atspi_document_get_document_attribute_value)
* @obj: a pointer to the #AtspiDocument object on which to operate.
* @attribute: a string indicating the name of a specific attribute.
*
* Gets the value of a single attribute, if specified for the document as a whole.
*
* Returns: a string corresponding to the value of the specified attribute, or
* an empty string if the attribute is unspecified for the object.
*
* Deprecated: 2.10: Use atspi_document_get_document_attribute_value instead.
**/
gchar *
atspi_document_get_attribute_value (AtspiDocument *obj,
gchar *attribute,
GError **error)
{
return atspi_document_get_document_attribute_value (obj, attribute, error);
}
/**
* atspi_document_get_document_attribute_value:
* @obj: a pointer to the #AtspiDocument object on which to operate.
* @attribute: a string indicating the name of a specific attribute.
*
* Gets the value of a single attribute, if specified for the document as a whole.
*
* Returns: a string corresponding to the value of the specified attribute, or
* an empty string if the attribute is unspecified for the object.
**/
gchar *
atspi_document_get_document_attribute_value (AtspiDocument *obj,
gchar *attribute,
GError **error)
{
gchar *retval = NULL;
g_return_val_if_fail (obj != NULL, NULL);
_atspi_dbus_call (obj, atspi_interface_document, "GetAttributeValue", error, "s=>s", attribute, &retval);
if (!retval)
retval = g_strdup ("");
return retval;
}
/**
* atspi_document_get_attributes: (rename-to atspi_document_get_document_attributes)
* @obj: a pointer to the #AtspiDocument object on which to operate.
*
* Gets all constant attributes for the document as a whole. For attributes
* that change within the document content, see @atspi_text_get_attribute_run instead.
*
* Returns: (element-type gchar* gchar*) (transfer full): a #GHashTable
* containing the constant attributes of the document, as name-value pairs.
*
* Deprecated: 2.10: Use atspi_document_get_document_attributes instead.
**/
GHashTable *
atspi_document_get_attributes (AtspiDocument *obj, GError **error)
{
return atspi_document_get_document_attributes (obj, error);
}
/**
* atspi_document_get_document_attributes:
* @obj: a pointer to the #AtspiDocument object on which to operate.
*
* Gets all constant attributes for the document as a whole. For attributes
* that change within the document content, see @atspi_text_get_attribute_run instead.
*
* Returns: (element-type gchar* gchar*) (transfer full): a #GHashTable
* containing the constant attributes of the document, as name-value pairs.
**/
GHashTable *
atspi_document_get_document_attributes (AtspiDocument *obj, GError **error)
{
DBusMessage *message;
g_return_val_if_fail (obj != NULL, NULL);
message = _atspi_dbus_call_partial (obj, atspi_interface_document, "GetAttributes", error, "");
return _atspi_dbus_return_hash_from_message (message);
}
/**
* atspi_document_get_page_count:
* @obj: a pointer to the #AtspiDocument object to query.
*
* Gets the page count of an #AccessibleDocument object.
*
* Returns: a #gint indicating the page count of an
* #AccessibleDocument object.
**/
gint
atspi_document_get_page_count (AtspiDocument *obj, GError **error)
{
dbus_int32_t retval = 0;
g_return_val_if_fail (obj != NULL, -1);
_atspi_dbus_get_property (obj, atspi_interface_document, "PageCount", error, "i", &retval);
return retval;
}
/**
* atspi_document_get_current_page_number:
* @obj: a pointer to the #AtspiDocument object to query.
*
* Gets the current page number of an #AccessibleDocument object.
*
* Returns: a #gint indicating the current page number in the
* #AccessibleDocument object.
**/
gint
atspi_document_get_current_page_number (AtspiDocument *obj, GError **error)
{
dbus_int32_t retval = 0;
g_return_val_if_fail (obj != NULL, -1);
_atspi_dbus_get_property (obj, atspi_interface_document, "CurrentPageNumber", error, "i", &retval);
return retval;
}
static void
atspi_document_base_init (AtspiDocument *klass)
{
}
GType
atspi_document_get_type (void)
{
static GType type = 0;
if (!type) {
static const GTypeInfo tinfo =
{
sizeof (AtspiDocument),
(GBaseInitFunc) atspi_document_base_init,
(GBaseFinalizeFunc) NULL,
};
type = g_type_register_static (G_TYPE_INTERFACE, "AtspiDocument", &tinfo, 0);
}
return type;
}
|
