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
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
|
/* -*- 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_SVX_ACCESSIBLESHAPE_HXX
#define INCLUDED_SVX_ACCESSIBLESHAPE_HXX
#include <editeng/AccessibleContextBase.hxx>
#include <editeng/AccessibleComponentBase.hxx>
#include <svx/IAccessibleViewForwarderListener.hxx>
#include <com/sun/star/document/XEventListener.hpp>
#include <com/sun/star/accessibility/XAccessible.hpp>
#include <com/sun/star/accessibility/XAccessibleExtendedComponent.hpp>
#include <com/sun/star/accessibility/AccessibleRole.hpp>
#include <com/sun/star/accessibility/XAccessibleSelection.hpp>
#include <com/sun/star/accessibility/XAccessibleText.hpp>
#include <com/sun/star/accessibility/XAccessibleExtendedAttributes.hpp>
#include <com/sun/star/accessibility/XAccessibleGroupPosition.hpp>
#include <com/sun/star/accessibility/XAccessibleHyperlink.hpp>
#include <com/sun/star/accessibility/XAccessibleHypertext.hpp>
#include <com/sun/star/drawing/XShape.hpp>
#include <com/sun/star/lang/XEventListener.hpp>
#include <com/sun/star/lang/XUnoTunnel.hpp>
#include <svx/AccessibleTextHelper.hxx>
#include <svx/svxdllapi.h>
#include <svx/ChildrenManager.hxx>
class SdrObject;
namespace accessibility {
class AccessibleShapeInfo;
class AccessibleShapeTreeInfo;
class IAccessibleParent;
/** This base class provides a base implementation for all shapes. For more
detailed documentation about the methods refer to the descriptions of
the implemented interfaces. These are, among others,
XAccessible, <type>XAccessibleContext</type>,
XAccessibleComponent and
XAccessibleExtendedComponent.
<p>The children of a shape can stem from two sources which, in case of
SVX and SD shapes, are mutually exclusive. This implementation,
however, handles both simultaniously to cope with future extensions or
shapes from other projects.
<ul>
<li>If this shape is a group shape, i.e. a
SvxShapeGroup or a <type>Svx3DSceneObject</type>, it
can have nested shapes.</li>
<li>If this shape is a descendant from SvxShapeText
then the text paragraphs are its children.</li>
</ul>
</p>
<p>Accessible shapes do not listen for disposing() calls of the UNO
shapes they make accessible. This is the task of their owner, usually a
container, who can then call dispose() at the accessible object.</p>
*/
class SVX_DLLPUBLIC AccessibleShape
: public AccessibleContextBase,
public AccessibleComponentBase,
public ::com::sun::star::accessibility::XAccessibleSelection,
public ::com::sun::star::accessibility::XAccessibleExtendedAttributes,
public ::com::sun::star::accessibility::XAccessibleGroupPosition,
public com::sun::star::accessibility::XAccessibleHypertext,
public IAccessibleViewForwarderListener,
public ::com::sun::star::document::XEventListener,
public ::com::sun::star::lang::XUnoTunnel
{
public:
//===== internal ========================================================
/** Create a new accessible object that makes the given shape accessible.
@param rShapeInfo
This object contains all information specific to the new
accessible shape. That are e.g. the shape to be made accessible
and the accessible object that will become the parent of the new
object.
@param rShapeTreeInfo
Bundel of information passed to this shape and all of its desendants.
@attention
Always call the <member>init</member> method after creating a
new accessible shape. This is one way to overcome the potential
problem of registering the new object with e.g. event
broadcasters. That would delete the new object if a broadcaster
would not keep a strong reference to the new object.
*/
AccessibleShape (
const AccessibleShapeInfo& rShapeInfo,
const AccessibleShapeTreeInfo& rShapeTreeInfo);
//Solution: Overwrite the object's current name.
virtual OUString SAL_CALL getAccessibleName (void) throw (::com::sun::star::uno::RuntimeException, std::exception);
virtual OUString SAL_CALL getAccessibleDescription() throw (::com::sun::star::uno::RuntimeException, std::exception);
virtual ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessibleRelationSet> SAL_CALL getAccessibleRelationSet (void) throw (::com::sun::star::uno::RuntimeException, std::exception);
//===== XAccessibleSelection ============================================
virtual void SAL_CALL selectAccessibleChild(
sal_Int32 nChildIndex )
throw ( ::com::sun::star::lang::IndexOutOfBoundsException,
::com::sun::star::uno::RuntimeException, std::exception );
virtual sal_Bool SAL_CALL isAccessibleChildSelected(
sal_Int32 nChildIndex )
throw ( ::com::sun::star::lang::IndexOutOfBoundsException,
::com::sun::star::uno::RuntimeException, std::exception );
virtual void SAL_CALL clearAccessibleSelection( )
throw ( ::com::sun::star::uno::RuntimeException, std::exception );
virtual void SAL_CALL selectAllAccessibleChildren( )
throw ( ::com::sun::star::uno::RuntimeException, std::exception );
virtual sal_Int32 SAL_CALL getSelectedAccessibleChildCount( )
throw ( ::com::sun::star::uno::RuntimeException, std::exception );
virtual ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessible > SAL_CALL getSelectedAccessibleChild(
sal_Int32 nSelectedChildIndex )
throw ( ::com::sun::star::lang::IndexOutOfBoundsException,
::com::sun::star::uno::RuntimeException, std::exception);
virtual void SAL_CALL deselectAccessibleChild(
sal_Int32 nSelectedChildIndex )
throw ( ::com::sun::star::lang::IndexOutOfBoundsException,
::com::sun::star::uno::RuntimeException, std::exception );
// ====== XAccessibleExtendedAttributes =====================================
virtual ::com::sun::star::uno::Any SAL_CALL getExtendedAttributes()
throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException, std::exception) ;
/// Return this object's role.
virtual sal_Int16 SAL_CALL getAccessibleRole (void) throw (::com::sun::star::uno::RuntimeException, std::exception);
//===== XAccessibleGroupPosition =========================================
virtual ::com::sun::star::uno::Sequence< sal_Int32 > SAL_CALL
getGroupPosition( const ::com::sun::star::uno::Any& rAny )
throw (::com::sun::star::uno::RuntimeException, std::exception);
virtual OUString SAL_CALL getObjectLink( const ::com::sun::star::uno::Any& accoject )
throw (::com::sun::star::uno::RuntimeException, std::exception);
/** The destructor releases its children manager and text engine if
still existent. These are responsible to send appropriate events.
*/
virtual ~AccessibleShape (void);
/** Initialize a new shape. See the documentation of the constructor
for the reason of this method's existence.
*/
virtual void Init (void);
/** Compare two accessible shapes using object identity
@param rShape
This is the second operand.
@return
Returns true if both shapes are the same object.
*/
virtual bool operator== (const AccessibleShape& rShape);
/** Set the specified state. If the state is <const>FOCUSED</const>
then, additionally to the inherited functionality, the focus
listeners registered with the XAccessibleComponent
interface are called (if that state really changes).
@param aState
The state to turn on.
@return
The returned flag indicates whether the specified state has been
changed (<TRUE/>), i.e. it has formerly not been set.
*/
virtual bool SetState (sal_Int16 aState);
/** Reset the specified state. If the state is <const>FOCUSED</const>
then, additionally to the inherited functionality, the focus
listeners registered with the XAccessibleComponent
interface are called (if that state really changes).
@param aState
The state to turn off.
@return
The returned flag indicates whether the specified state has been
changed (<TRUE/>), i.e. it has formerly been set.
*/
virtual bool ResetState (sal_Int16 aState);
/** Return the state of the specified state. Take the
<const>FOCUSED</const> state from the accessible edit engine.
@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 or the inability to access the
entity that manages the state set.
*/
bool GetState (sal_Int16 aState);
//===== XAccessibleContext ==============================================
/// Return the number of currently visible children.
virtual sal_Int32 SAL_CALL
getAccessibleChildCount (void)
throw (::com::sun::star::uno::RuntimeException, std::exception);
/** Return the specified child.
@param nIndex
Index of the requested child.
@return
Reference of the requested child which is the accessible object
of a visible shape.
@raises IndexOutOfBoundsException
Throws an exception if the index is not valid.
*/
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);
/// 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);
/// Return this objects index among the parents children.
virtual sal_Int32 SAL_CALL
getAccessibleIndexInParent (void)
throw (::com::sun::star::uno::RuntimeException, std::exception);
//===== XAccessibleComponent ============================================
virtual ::com::sun::star::uno::Reference<
::com::sun::star::accessibility::XAccessible > SAL_CALL
getAccessibleAtPoint (const ::com::sun::star::awt::Point& aPoint)
throw (::com::sun::star::uno::RuntimeException, std::exception);
virtual ::com::sun::star::awt::Rectangle SAL_CALL getBounds (void)
throw (::com::sun::star::uno::RuntimeException, std::exception);
virtual ::com::sun::star::awt::Point SAL_CALL getLocation (void)
throw (::com::sun::star::uno::RuntimeException, std::exception);
virtual ::com::sun::star::awt::Point SAL_CALL getLocationOnScreen (void)
throw (::com::sun::star::uno::RuntimeException, std::exception);
virtual ::com::sun::star::awt::Size SAL_CALL getSize (void)
throw (::com::sun::star::uno::RuntimeException, std::exception);
virtual sal_Int32 SAL_CALL getForeground (void)
throw (::com::sun::star::uno::RuntimeException, std::exception);
virtual sal_Int32 SAL_CALL getBackground (void)
throw (::com::sun::star::uno::RuntimeException, std::exception);
//===== XAccessibleEventBroadcaster =====================================
/** This call is forwarded to a) the base class and b) to the
accessible edit engine if it is present.
@param rxListener
This listener is informed about accessibility events.
*/
virtual void SAL_CALL
addAccessibleEventListener (
const ::com::sun::star::uno::Reference<
::com::sun::star::accessibility::XAccessibleEventListener >& rxListener)
throw (::com::sun::star::uno::RuntimeException, std::exception);
/** This call is forwarded to a) the base class and b) to the
accessible edit engine if it is present.
@param rxListener
This listener will not be informed about accessibility events
anymore.
*/
virtual void SAL_CALL
removeAccessibleEventListener (
const ::com::sun::star::uno::Reference<
::com::sun::star::accessibility::XAccessibleEventListener >& rxListener)
throw (::com::sun::star::uno::RuntimeException, std::exception);
//===== XInterface ======================================================
virtual com::sun::star::uno::Any SAL_CALL
queryInterface (const com::sun::star::uno::Type & rType)
throw (::com::sun::star::uno::RuntimeException, std::exception);
virtual void SAL_CALL
acquire (void)
throw ();
virtual void SAL_CALL
release (void)
throw ();
//===== XServiceInfo ====================================================
/** Returns an identifier for the implementation of this object.
*/
virtual OUString SAL_CALL
getImplementationName (void)
throw (::com::sun::star::uno::RuntimeException, std::exception);
virtual ::com::sun::star::uno::Sequence< OUString> SAL_CALL
getSupportedServiceNames (void)
throw (::com::sun::star::uno::RuntimeException, std::exception);
//===== XTypeProvider ===================================================
virtual ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Type> SAL_CALL
getTypes (void)
throw (::com::sun::star::uno::RuntimeException, std::exception);
//===== IAccessibleViewForwarderListener ================================
virtual void ViewForwarderChanged (ChangeType aChangeType,
const IAccessibleViewForwarder* pViewForwarder);
//===== lang::XEventListener ============================================
/** Listen for disposing events of the model. The accessible shape
remains functional when this happens.
*/
virtual void SAL_CALL
disposing (const ::com::sun::star::lang::EventObject& Source)
throw (::com::sun::star::uno::RuntimeException, std::exception);
//===== document::XEventListener ========================================
virtual void SAL_CALL
notifyEvent (const ::com::sun::star::document::EventObject& rEventObject)
throw (::com::sun::star::uno::RuntimeException, std::exception);
//===== XUnoTunnel ========================================================
static const ::com::sun::star::uno::Sequence< sal_Int8 >& getUnoTunnelImplementationId() throw();
static AccessibleShape* getImplementation( const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >& _rxIFace ) throw();
sal_Int64 SAL_CALL getSomething( const ::com::sun::star::uno::Sequence< sal_Int8 >& _rIdentifier ) throw(::com::sun::star::uno::RuntimeException, std::exception);
//===== XAccessibleHypertext ========================================================
virtual sal_Int32 SAL_CALL getHyperLinkCount() throw (::com::sun::star::uno::RuntimeException, std::exception);
virtual ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessibleHyperlink >
SAL_CALL getHyperLink( sal_Int32 nLinkIndex )
throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException, std::exception);
virtual sal_Int32 SAL_CALL getHyperLinkIndex( sal_Int32 nCharIndex )
throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException, std::exception);
//===== XAccesibleText ==================================================
virtual sal_Int32 SAL_CALL getCaretPosition( ) throw (::com::sun::star::uno::RuntimeException, std::exception);
virtual sal_Bool SAL_CALL setCaretPosition( sal_Int32 nIndex ) throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException, std::exception);
virtual sal_Unicode SAL_CALL getCharacter( sal_Int32 nIndex ) throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException, std::exception);//Shen Zhen Jie changed sal_Unicode to sal_uInt32; change back to sal_Unicode
virtual ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue > SAL_CALL getCharacterAttributes( sal_Int32 nIndex, const ::com::sun::star::uno::Sequence< OUString >& aRequestedAttributes ) throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException, std::exception);
virtual ::com::sun::star::awt::Rectangle SAL_CALL getCharacterBounds( sal_Int32 nIndex ) throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException, std::exception);
virtual sal_Int32 SAL_CALL getCharacterCount( ) throw (::com::sun::star::uno::RuntimeException, std::exception);
virtual sal_Int32 SAL_CALL getIndexAtPoint( const ::com::sun::star::awt::Point& aPoint ) throw (::com::sun::star::uno::RuntimeException, std::exception);
virtual OUString SAL_CALL getSelectedText( ) throw (::com::sun::star::uno::RuntimeException, std::exception);
virtual sal_Int32 SAL_CALL getSelectionStart( ) throw (::com::sun::star::uno::RuntimeException, std::exception);
virtual sal_Int32 SAL_CALL getSelectionEnd( ) throw (::com::sun::star::uno::RuntimeException, std::exception);
virtual sal_Bool SAL_CALL setSelection( sal_Int32 nStartIndex, sal_Int32 nEndIndex ) throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException, std::exception);
virtual OUString SAL_CALL getText( ) throw (::com::sun::star::uno::RuntimeException, std::exception);
virtual OUString SAL_CALL getTextRange( sal_Int32 nStartIndex, sal_Int32 nEndIndex ) throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException, std::exception);
virtual ::com::sun::star::accessibility::TextSegment SAL_CALL getTextAtIndex( sal_Int32 nIndex, sal_Int16 aTextType ) throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::uno::RuntimeException, std::exception);
virtual ::com::sun::star::accessibility::TextSegment SAL_CALL getTextBeforeIndex( sal_Int32 nIndex, sal_Int16 aTextType ) throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::uno::RuntimeException, std::exception);
virtual ::com::sun::star::accessibility::TextSegment SAL_CALL getTextBehindIndex( sal_Int32 nIndex, sal_Int16 aTextType ) throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::uno::RuntimeException, std::exception);
virtual sal_Bool SAL_CALL copyText( sal_Int32 nStartIndex, sal_Int32 nEndIndex ) throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException, std::exception);
//===== Misc ========================================================
::com::sun::star::uno::Reference< ::com::sun::star::drawing::XShape >
GetXShape();
/** set the index _nIndex at the accessible shape
@param _nIndex
The new index in parent.
*/
inline void setIndexInParent(sal_Int32 _nIndex) { m_nIndexInParent = _nIndex; }
protected:
/// Children manager. May be empty if there are no children.
ChildrenManager* mpChildrenManager;
/// Reference to the actual shape.
::com::sun::star::uno::Reference<
::com::sun::star::drawing::XShape> mxShape;
/** Bundle of information passed to all shapes in a document tree.
*/
AccessibleShapeTreeInfo maShapeTreeInfo;
/** Index that is appended to the object's name to disambiguate between
different names with the otherwise same name.
*/
long mnIndex;
/** the index in parent.
*/
sal_Int32 m_nIndexInParent;
/** The accessible text engine. May be NULL if it can not be created.
*/
AccessibleTextHelper* mpText;
/** This object can be used to modify the child list of our parent.
*/
IAccessibleParent* mpParent;
/** This object can be removed when we have an extra interface to ask if the shape is selected
*/
SdrObject* m_pShape;
/** This method is called from the component helper base class while
disposing.
*/
virtual void SAL_CALL disposing (void);
/** Create a base name string that contains the accessible name.
*/
virtual OUString
CreateAccessibleBaseName (void)
throw (::com::sun::star::uno::RuntimeException);
/** Create a unique name string that contains the accessible name. The
name consists of the base name and the index.
*/
virtual OUString
CreateAccessibleName (void)
throw (::com::sun::star::uno::RuntimeException);
/// Create a description string that contains the accessible description.
virtual OUString
CreateAccessibleDescription (void)
throw (::com::sun::star::uno::RuntimeException);
virtual OUString
GetFullAccessibleName(AccessibleShape *shape)
throw (::com::sun::star::uno::RuntimeException);
virtual OUString GetStyle();
void UpdateDocumentAllSelState(::com::sun::star::uno::Reference<
::com::sun::star::accessibility::XAccessibleStateSet > &xStateSet);
/** Update the <const>OPAQUE</const> and <const>SELECTED</const> state.
*/
virtual void UpdateStates (void);
private:
/** Don't use the default constructor. Use the public constructor that
takes the original shape and the parent as arguments instead.
*/
SVX_DLLPRIVATE explicit AccessibleShape (void);
/// Don't use the copy constructor. Is there any use for it?
SVX_DLLPRIVATE explicit AccessibleShape (const AccessibleShape&);
/// Don't use the assignment operator. Do we need this?
SVX_DLLPRIVATE AccessibleShape& operator= (const AccessibleShape&);
//Old accessible name
OUString aAccName;
/** Call this method when the title, name, or description of the mxShape
member (may) have been changed.
This method adapts the name and description members of the
AccessibleContextBase base class.
*/
void UpdateNameAndDescription (void);
};
} // end of namespace accessibility
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
