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
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: XAccessibleContext.idl,v $
* $Revision: 1.8 $
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org 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 version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef __com_sun_star_accessibility_XAccessibleContext_idl__
#define __com_sun_star_accessibility_XAccessibleContext_idl__
#ifndef __com_sun_star_accessibility_IllegalAccessibleComponentStateException_idl__
#include <com/sun/star/accessibility/IllegalAccessibleComponentStateException.idl>
#endif
#ifndef __com_sun_star_lang_IndexOutOfBoundsException_idl__
#include <com/sun/star/lang/IndexOutOfBoundsException.idl>
#endif
#ifndef __com_sun_star_beans_XPropertyChangeListener_idl__
#include <com/sun/star/beans/XPropertyChangeListener.idl>
#endif
#ifndef __com_sun_star_lang_Locale_idl__
#include <com/sun/star/lang/Locale.idl>
#endif
module com { module sun { module star { module accessibility {
published interface XAccessible;
published interface XAccessibleRelationSet;
published interface XAccessibleSelection;
published interface XAccessibleStateSet;
/** Implement this interface for exposing various aspects of a class'
content.
<p>This interface serves two purposes: On the one hand it gives access
to the tree structure in which all accessible objects are
organized. Each node in this tree supports this interface. On the other
hand it gives access to objects that expose the represented content.
That are role, state, name, description, and relations to other objects.
Take an OK button of a dialog as an example. Its role is
<const>AccessibleRole::BUTTON</const>, its name is 'OK', and its description
is something like 'Accepts all changes made in the dialog'.</p>
@since OOo 1.1.2
*/
published interface XAccessibleContext : ::com::sun::star::uno::XInterface
{
/** Return the number of children.
<p>Returns the number of accessible children of the object.</p>
@return
The returned value is non-negative.
*/
long getAccessibleChildCount();
/** Returns the i-th child of this object.
<p>The order in which the children are enumerated is implementation
dependend.</p>
@param i
The index may have any value. If it is outside the range from 0
to n-1, with n being the number of children as returned by
<member>XAccessibleContext::getAccessibleChild</member> an empty
reference is returned.
@return
If the object has an i-th child the returned value is a
reference to that child. Otherwise an empty reference is
returned.
@throws ::com::sun::star::lang::IndexOutOfBoundsException
If no child with the given index exists then an
<type scope="::com::sun::star::lang">IndexOutOfBoundsException</type>
exception is thrown.
*/
XAccessible getAccessibleChild ([in] long i)
raises (::com::sun::star::lang::IndexOutOfBoundsException);
/** Returns the parent of this object.
<p>This function may be called for every node, including the root
node, of the accessible tree.</p>
@return
The returned reference points to a valid object for all but the
root node. If called for the root node an empty reference is
returned.
*/
XAccessible getAccessibleParent ();
/** Returns the index of this object in its accessible parent.
<p>If you call getAccessibeChild on the object's parent with the
index returned by this function you get a reference to this
object.</p>
@return
The returned index is zero based.
*/
long getAccessibleIndexInParent ();
/** Returns the role of this object.
<p>The role is a generic description of an objects function. The
relation between role and name is similar to the relation between
class and object.</p>
@return
The returned value is a role defined in the enumeration
AccessibleRole.
@see AccessibleRole
for a list of the available roles.
*/
short getAccessibleRole ();
/** Returns the object's description.
<p>Returns the object's localized description. The description should
complement the more generic descriptions given by an object's role
and name.</p>
@return
The returned string is the object's localized description.
*/
string getAccessibleDescription ();
/** Return the object's localized name.
<p>See <member>XAccessibleContext::getAccessibleRole</member>'s
documentation for the relation between an object's name and role.
Names should be unique, at least between children of the same
parent, although the uniqueness is neither enforced nor used inside
the API.</p>
@return
The returned string is the object's localized name.
*/
string getAccessibleName ();
/** Returns the set of relations defined for this object.
<p>The returned set of relations is a copy of this objects relation
set: changing the returned object does not change this objects
relations.</p>
<p>aThere are two ways to represent an empty list of relations:
Return an empty reference or return a valid object that contains an
empty list.
@return
The returned value is either an empty referece or a reference to
a valid object that represents a copy of the objects list of
relations.
*/
XAccessibleRelationSet getAccessibleRelationSet ();
/** Returns the set of states that are currently active for this
object.
<p>The returned state set is a copy: Changing the returned state set
will not be refelected by changing the object's set of states. See
the documentation of <type>XAccessibleStateSet</type> for a
description of the individual states.</p>
@return
A reference to this object's state set or an empty reference if
states are not supported.
@see XAccessibleStateSet
*/
XAccessibleStateSet getAccessibleStateSet ();
/** Returns the locale of the component.
<p>This locale is used for example to determine the language to use
for the name and description texts.</p>
@return
If this object does not have a locale, the locale of its parent
is returned. If it does not have (yet) a parent it throws the
exception <type>IllegalAccessibleComponentStateException</type>.
@throws IllegalAccessibleComponentStateException
when this object does not (yet) have a parent.
*/
::com::sun::star::lang::Locale getLocale ()
raises (IllegalAccessibleComponentStateException);
};
}; }; }; };
#endif
|
