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
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef INCLUDED_EDITENG_ACCESSIBLECONTEXTBASE_HXX
#define INCLUDED_EDITENG_ACCESSIBLECONTEXTBASE_HXX
#include <com/sun/star/accessibility/XAccessible.hpp>
#include <com/sun/star/accessibility/XAccessibleContext.hpp>
#include <com/sun/star/accessibility/XAccessibleEventBroadcaster.hpp>
#include <com/sun/star/accessibility/XAccessibleStateSet.hpp>
#include <com/sun/star/accessibility/XAccessibleRelationSet.hpp>
#include <com/sun/star/accessibility/AccessibleEventObject.hpp>
#include <com/sun/star/accessibility/AccessibleEventId.hpp>
#include <com/sun/star/accessibility/IllegalAccessibleComponentStateException.hpp>
#include <com/sun/star/uno/Reference.hxx>
#include <com/sun/star/lang/XComponent.hpp>
#include <cppuhelper/weak.hxx>
#include <com/sun/star/lang/XServiceInfo.hpp>
#include <com/sun/star/lang/XTypeProvider.hpp>
#include <com/sun/star/lang/IndexOutOfBoundsException.hpp>
#include <com/sun/star/lang/DisposedException.hpp>
#include <osl/mutex.hxx>
#include <cppuhelper/compbase4.hxx>
#include <editeng/editengdllapi.h>
namespace accessibility {
struct MutexOwner {mutable ::osl::Mutex maMutex;};
/** @descr
This base class provides an implementation of the
AccessibleContext service. Appart from the
<type>XXAccessible<type> and XAccessibleContextContext
interfaces it supports the XServiceInfo interface.
*/
class EDITENG_DLLPUBLIC AccessibleContextBase
: public MutexOwner,
public cppu::PartialWeakComponentImplHelper4<
::com::sun::star::accessibility::XAccessible,
::com::sun::star::accessibility::XAccessibleContext,
::com::sun::star::accessibility::XAccessibleEventBroadcaster,
::com::sun::star::lang::XServiceInfo
>
{
public:
//===== internal ========================================================
/** The origin of the accessible name or description.
*/
enum StringOrigin {
ManuallySet,
FromShape,
AutomaticallyCreated,
NotSet
};
AccessibleContextBase (
const ::com::sun::star::uno::Reference<
::com::sun::star::accessibility::XAccessible>& rxParent,
const sal_Int16 aRole);
virtual ~AccessibleContextBase (void);
/** Call all accessiblity event listeners to inform them about the
specified event.
@param aEventId
Id of the event type.
@param rNewValue
New value of the modified attribute. Pass empty structure if
not applicable.
@param rOldValue
Old value of the modified attribute. Pass empty structure if
not applicable.
*/
void CommitChange (sal_Int16 aEventId,
const ::com::sun::star::uno::Any& rNewValue,
const ::com::sun::star::uno::Any& rOldValue);
/** Set a new description and, provided that the new name differs from
the old one, broadcast an accessibility event.
@param rsDescription
The new description.
@param eDescriptionOrigin
The origin of the description. This is used to determine
whether the given description overrules the existing one. An
origin with a lower numerical value overrides one with a higher
value.
*/
void SetAccessibleDescription (
const OUString& rsDescription,
StringOrigin eDescriptionOrigin)
throw (::com::sun::star::uno::RuntimeException);
/** Set a new description and, provided that the new name differs from
the old one, broadcast an accessibility event.
@param rsName
The new name.
@param eNameOrigin
The origin of the name. This is used to determine whether the
given name overrules the existing one. An origin with a lower
numerical value overrides one with a higher value.
*/
void SetAccessibleName (
const OUString& rsName,
StringOrigin eNameOrigin)
throw (::com::sun::star::uno::RuntimeException);
/** Set the specified state (turn it on) and send events to all
listeners to inform them of the change.
@param aState
The state to turn on.
@return
If the specified state changed its value due to this call
<TRUE/> is returned, otherwise <FALSE/>.
*/
virtual bool SetState (sal_Int16 aState);
/** Reset the specified state (turn it off) and send events to all
listeners to inform them of the change.
@param aState
The state to turn off.
@return
If the specified state changed its value due to this call
<TRUE/> is returned, otherwise <FALSE/>.
*/
virtual bool ResetState (sal_Int16 aState);
/** Return the state of the specified state.
@param aState
The state for which to return its value.
@return
A value of <TRUE/> indicates that the state is set. A <FALSE/>
value indicates an unset state.
*/
bool GetState (sal_Int16 aState);
/** Replace the current relation set with the specified one. Send
events for relations that are not in both sets.
@param rRelationSet
The new relation set that replaces the old one.
*/
virtual void SetRelationSet (
const ::com::sun::star::uno::Reference<
::com::sun::star::accessibility::XAccessibleRelationSet>& rxRelationSet)
throw (::com::sun::star::uno::RuntimeException);
//===== XAccessible =====================================================
/// Return the XAccessibleContext.
virtual ::com::sun::star::uno::Reference<
::com::sun::star::accessibility::XAccessibleContext> SAL_CALL
getAccessibleContext (void) throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
//===== XAccessibleContext ==============================================
/// Return the number of currently visible children.
virtual sal_Int32 SAL_CALL
getAccessibleChildCount (void) throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
/// Return the specified child or throw exception.
virtual ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessible> SAL_CALL
getAccessibleChild (sal_Int32 nIndex)
throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
/// Return a reference to the parent.
virtual ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessible> SAL_CALL
getAccessibleParent (void)
throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
/// Return this objects index among the parents children.
virtual sal_Int32 SAL_CALL
getAccessibleIndexInParent (void)
throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
/// Return this object's role.
virtual sal_Int16 SAL_CALL
getAccessibleRole (void)
throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
/// Return this object's description.
virtual OUString SAL_CALL
getAccessibleDescription (void)
throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
/// Return the object's current name.
virtual OUString SAL_CALL
getAccessibleName (void)
throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
/// Return NULL to indicate that an empty relation set.
virtual ::com::sun::star::uno::Reference<
::com::sun::star::accessibility::XAccessibleRelationSet> SAL_CALL
getAccessibleRelationSet (void)
throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
/// Return the set of current states.
virtual ::com::sun::star::uno::Reference<
::com::sun::star::accessibility::XAccessibleStateSet> SAL_CALL
getAccessibleStateSet (void)
throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
/** Return the parents locale or throw exception if this object has no
parent yet/anymore.
*/
virtual ::com::sun::star::lang::Locale SAL_CALL
getLocale (void)
throw (::com::sun::star::uno::RuntimeException,
::com::sun::star::accessibility::IllegalAccessibleComponentStateException, std::exception) SAL_OVERRIDE;
//===== XAccessibleEventBroadcaster ========================================
virtual void SAL_CALL
addAccessibleEventListener (
const ::com::sun::star::uno::Reference<
::com::sun::star::accessibility::XAccessibleEventListener >& xListener)
throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual void SAL_CALL
removeAccessibleEventListener (
const ::com::sun::star::uno::Reference<
::com::sun::star::accessibility::XAccessibleEventListener >& xListener)
throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
//===== XServiceInfo ====================================================
/** Returns an identifier for the implementation of this object.
*/
virtual OUString SAL_CALL
getImplementationName (void)
throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
/** Return whether the specified service is supported by this class.
*/
virtual sal_Bool SAL_CALL
supportsService (const OUString& sServiceName)
throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
/** Returns a list of all supported services. In this case that is just
the AccessibleContext service.
*/
virtual ::com::sun::star::uno::Sequence< OUString> SAL_CALL
getSupportedServiceNames (void)
throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
//===== XTypeProvider ===================================================
/** Returns a sequence of all supported interfaces.
*/
virtual ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Type> SAL_CALL
getTypes (void)
throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
/** Returns a implementation id.
*/
virtual ::com::sun::star::uno::Sequence<sal_Int8> SAL_CALL
getImplementationId (void)
throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
protected:
/** The state set.
*/
::com::sun::star::uno::Reference<
::com::sun::star::accessibility::XAccessibleStateSet> mxStateSet;
/** The relation set. Relations can be set or removed by calling the
<member>AddRelation</member> and <member>RemoveRelation</member> methods.
*/
::com::sun::star::uno::Reference<
::com::sun::star::accessibility::XAccessibleRelationSet> mxRelationSet;
// This method is called from the component helper base class while disposing.
virtual void SAL_CALL disposing (void) SAL_OVERRIDE;
/** Create the accessible object's name. This method may be called more
than once for a single object.
@return
The returned string is a unique (among the accessible object's
siblings) name.
*/
virtual OUString CreateAccessibleName (void)
throw (::com::sun::star::uno::RuntimeException);
/** Create the accessible object's descriptive string. May be called
more than once.
@return
Descriptive string. Not necessarily unique.
*/
virtual OUString
CreateAccessibleDescription (void)
throw (::com::sun::star::uno::RuntimeException);
void FireEvent (const ::com::sun::star::accessibility::AccessibleEventObject& aEvent);
/** Check whether or not the object has been disposed (or is in the
state of beeing disposed). If that is the case then
DisposedException is thrown to inform the (indirect) caller of the
foul deed.
*/
void ThrowIfDisposed (void)
throw (::com::sun::star::lang::DisposedException);
/** Check whether or not the object has been disposed (or is in the
state of beeing disposed).
@return TRUE, if the object is disposed or in the course
of being disposed. Otherwise, FALSE is returned.
*/
bool IsDisposed (void);
/** sets the role as returned by XaccessibleContext::getAccessibleRole
<p>Caution: This is only to be used in the construction phase (means within
the ctor or late ctor), <em>never</em> when the object is still alive and part
of an Accessibility hierarchy.</p>
*/
void SetAccessibleRole( sal_Int16 _nRole );
private:
/// Reference to the parent object.
::com::sun::star::uno::Reference<
::com::sun::star::accessibility::XAccessible> mxParent;
/** Description of this object. This is not a constant because it can
be set from the outside. Furthermore, it changes according the the
draw page's display mode.
*/
OUString msDescription;
/** The origin of the description is used to determine whether new
descriptions given to the SetAccessibleDescription is ignored or
whether that replaces the old value in msDescription.
*/
StringOrigin meDescriptionOrigin;
/** Name of this object. It changes according the draw page's
display mode.
*/
OUString msName;
/** The origin of the name is used to determine whether new
name given to the SetAccessibleName is ignored or
whether that replaces the old value in msName.
*/
StringOrigin meNameOrigin;
/** client id in the AccessibleEventNotifier queue
*/
sal_uInt32 mnClientId;
/** This is the role of this object.
*/
sal_Int16 maRole;
};
}
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
