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
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* 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 _ACCBASE_HXX
#define _ACCBASE_HXX
#include <accframe.hxx>
#include <accmap.hxx>
#include <com/sun/star/accessibility/XAccessibleComponent.hpp>
#include <com/sun/star/accessibility/XAccessibleEventBroadcaster.hpp>
#include <com/sun/star/lang/DisposedException.hpp>
#include <com/sun/star/lang/XServiceInfo.hpp>
#include <cppuhelper/implbase5.hxx>
#include <cppuhelper/interfacecontainer.hxx>
class Window;
class SwAccessibleMap;
class SwCrsrShell;
class SdrObject;
class SwPaM;
namespace utl {
class AccessibleStateSetHelper;
}
namespace accessibility {
class AccessibleShape;
}
class SwFmtFld;
class SwAccessibleChildContainer;
const sal_Char sAccessibleServiceName[] = "com.sun.star.accessibility.Accessible";
class SwAccessibleContext :
public ::cppu::WeakImplHelper5<
::com::sun::star::accessibility::XAccessible,
::com::sun::star::accessibility::XAccessibleContext,
::com::sun::star::accessibility::XAccessibleComponent,
::com::sun::star::accessibility::XAccessibleEventBroadcaster,
::com::sun::star::lang::XServiceInfo
>,
public SwAccessibleFrame
{
// The implements for the XAccessibleSelection interface has been
// 'externalized' and wants access to the protected members like
// GetMap, GetChild, GetParent, and GetFrm.
friend class SwAccessibleSelectionHelper;
protected:
mutable ::osl::Mutex aListenerMutex;
mutable ::osl::Mutex aMutex;
private:
::rtl::OUString sName; // immutable outside constructor
// The parent if it has been retrieved. This is always an
// SwAccessibleContext. (protected by Mutex)
::com::sun::star::uno::WeakReference <
::com::sun::star::accessibility::XAccessible > xWeakParent;
SwAccessibleMap *pMap; // must be protected by solar mutex
sal_uInt32 nClientId; // client id in the AccessibleEventNotifier queue
sal_Int16 nRole; // immutable outside constructor
// The current states (protected by mutex)
sal_Bool bIsShowingState : 1;
sal_Bool bIsEditableState : 1;
sal_Bool bIsOpaqueState : 1;
sal_Bool bIsDefuncState : 1;
// Are we currently disposing that object (protected by solar mutex)?
sal_Bool bDisposing : 1;
// #i85634# - boolean, indicating if the accessible context is
// in general registered at the accessible map.
bool bRegisteredAtAccessibleMap;
void InitStates();
protected:
void SetName( const ::rtl::OUString& rName ) { sName = rName; }
inline sal_Int16 GetRole() const
{
return nRole;
}
void SetParent( SwAccessibleContext *pParent );
::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessible> GetWeakParent() const;
sal_Bool IsDisposing() const { return bDisposing; }
Window *GetWindow();
SwAccessibleMap *GetMap() { return pMap; }
const SwAccessibleMap *GetMap() const { return pMap; }
/** convenience method to get the SwViewShell through accessibility map */
inline ViewShell* GetShell()
{
return GetMap()->GetShell();
}
inline const ViewShell* GetShell() const
{
return GetMap()->GetShell();
}
/** convenience method to get SwCrsrShell through accessibility map
* @returns SwCrsrShell, or NULL if none is found */
SwCrsrShell* GetCrsrShell();
const SwCrsrShell* GetCrsrShell() const;
// Notify all children that the vis araea has changed.
// The SwFrm might belong to the current object or to any other child or
// grandchild.
void ChildrenScrolled( const SwFrm *pFrm, const SwRect& rOldVisArea );
// The context's showing state changed. May only be called for context that
// exist even if they aren't visible.
void Scrolled( const SwRect& rOldVisArea );
// A child has been moved while setting the vis area
void ScrolledWithin( const SwRect& rOldVisArea );
// The has been added while setting the vis area
void ScrolledIn();
// The context has to be removed while setting the vis area
void ScrolledOut( const SwRect& rOldVisArea );
// Invalidate the states of all children of the specified SwFrm. The
// SwFrm might belong the the current object or to any child or grandchild!
// #i27301# - use new type definition for <_nStates>
void InvalidateChildrenStates( const SwFrm* _pFrm,
tAccessibleStates _nStates );
// Dispose children of the specified SwFrm. The SwFrm might belong to
// the current object or to any other child or grandchild.
void DisposeChildren( const SwFrm *pFrm,
sal_Bool bRecursive );
void DisposeShape( const SdrObject *pObj,
::accessibility::AccessibleShape *pAccImpl );
void ScrolledInShape( const SdrObject *pObj,
::accessibility::AccessibleShape *pAccImpl );
virtual void _InvalidateContent( sal_Bool bVisibleDataFired );
virtual void _InvalidateCursorPos();
virtual void _InvalidateFocus();
public:
void FireAccessibleEvent( ::com::sun::star::accessibility::AccessibleEventObject& rEvent );
protected:
// broadcast visual data event
void FireVisibleDataEvent();
// broadcast state change event
void FireStateChangedEvent( sal_Int16 nState, sal_Bool bNewState );
// Set states for getAccessibleStateSet.
// This base class sets DEFUNC(0/1), EDITABLE(0/1), ENABLED(1),
// SHOWING(0/1), OPAQUE(0/1) and VISIBLE(1).
virtual void GetStates( ::utl::AccessibleStateSetHelper& rStateSet );
sal_Bool IsEditableState();
virtual ::com::sun::star::awt::Rectangle SAL_CALL
getBoundsImpl(sal_Bool bRelative)
throw (::com::sun::star::uno::RuntimeException);
// #i85634#
inline void NotRegisteredAtAccessibleMap()
{
bRegisteredAtAccessibleMap = false;
}
void RemoveFrmFromAccessibleMap();
virtual ~SwAccessibleContext();
public:
SwAccessibleContext( SwAccessibleMap *pMap, sal_Int16 nRole,
const SwFrm *pFrm );
//===== 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);
//===== XAccessibleContext ==============================================
/// Return the number of currently visible children.
virtual sal_Int32 SAL_CALL getAccessibleChildCount (void)
throw (::com::sun::star::uno::RuntimeException);
/// Return the specified child or NULL if index is invalid.
virtual ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessible> SAL_CALL
getAccessibleChild (sal_Int32 nIndex)
throw (::com::sun::star::uno::RuntimeException,
::com::sun::star::lang::IndexOutOfBoundsException);
/// 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);
/// Return this objects index among the parents children.
virtual sal_Int32 SAL_CALL
getAccessibleIndexInParent (void)
throw (::com::sun::star::uno::RuntimeException);
/// Return this object's role.
virtual sal_Int16 SAL_CALL
getAccessibleRole (void)
throw (::com::sun::star::uno::RuntimeException);
/// Return this object's description.
virtual ::rtl::OUString SAL_CALL
getAccessibleDescription (void)
throw (::com::sun::star::uno::RuntimeException);
/// Return the object's current name.
virtual ::rtl::OUString SAL_CALL
getAccessibleName (void)
throw (::com::sun::star::uno::RuntimeException);
/// 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);
/// 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);
/** 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::accessibility::IllegalAccessibleComponentStateException, ::com::sun::star::uno::RuntimeException);
//===== XAccessibleEventBroadcaster =====================================
virtual void SAL_CALL addEventListener(
const ::com::sun::star::uno::Reference<
::com::sun::star::accessibility::XAccessibleEventListener >& xListener )
throw (::com::sun::star::uno::RuntimeException);
virtual void SAL_CALL removeEventListener(
const ::com::sun::star::uno::Reference<
::com::sun::star::accessibility::XAccessibleEventListener >& xListener )
throw (::com::sun::star::uno::RuntimeException);
//===== XAccessibleComponent ============================================
virtual sal_Bool SAL_CALL containsPoint(
const ::com::sun::star::awt::Point& aPoint )
throw (::com::sun::star::uno::RuntimeException);
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);
virtual ::com::sun::star::awt::Rectangle SAL_CALL getBounds()
throw (::com::sun::star::uno::RuntimeException);
virtual ::com::sun::star::awt::Point SAL_CALL getLocation()
throw (::com::sun::star::uno::RuntimeException);
virtual ::com::sun::star::awt::Point SAL_CALL getLocationOnScreen()
throw (::com::sun::star::uno::RuntimeException);
virtual ::com::sun::star::awt::Size SAL_CALL getSize()
throw (::com::sun::star::uno::RuntimeException);
virtual void SAL_CALL grabFocus()
throw (::com::sun::star::uno::RuntimeException);
virtual ::com::sun::star::uno::Any SAL_CALL getAccessibleKeyBinding()
throw (::com::sun::star::uno::RuntimeException);
virtual sal_Int32 SAL_CALL getForeground()
throw (::com::sun::star::uno::RuntimeException);
virtual sal_Int32 SAL_CALL getBackground()
throw (::com::sun::star::uno::RuntimeException);
//===== XServiceInfo ====================================================
/** Returns an identifier for the implementation of this object.
*/
virtual ::rtl::OUString SAL_CALL
getImplementationName (void)
throw (::com::sun::star::uno::RuntimeException);
/** Return whether the specified service is supported by this class.
*/
virtual sal_Bool SAL_CALL
supportsService (const ::rtl::OUString& sServiceName)
throw (::com::sun::star::uno::RuntimeException);
/** Returns a list of all supported services. In this case that is just
the AccessibleContext service.
*/
virtual ::com::sun::star::uno::Sequence< ::rtl::OUString> SAL_CALL
getSupportedServiceNames (void)
throw (::com::sun::star::uno::RuntimeException);
//====== thread safe C++ interface ========================================
// The object is not visible an longer and should be destroyed
virtual void Dispose( sal_Bool bRecursive = sal_False );
// The child object is not visible an longer and should be destroyed
virtual void DisposeChild( const sw::access::SwAccessibleChild& rFrmOrObj, sal_Bool bRecursive );
// The object has been moved by the layout
virtual void InvalidatePosOrSize( const SwRect& rFrm );
// The vhild object has been moved by the layout
virtual void InvalidateChildPosOrSize( const sw::access::SwAccessibleChild& rFrmOrObj,
const SwRect& rFrm );
// The content may have changed (but it hasn't tohave changed)
void InvalidateContent();
// The caretPos has changed
void InvalidateCursorPos();
// The Focus state has changed
void InvalidateFocus();
// Check states
// #i27301# - use new type definition for <_nStates>
void InvalidateStates( tAccessibleStates _nStates );
// the XAccessibleRelationSet may have changed
void InvalidateRelation( sal_uInt16 nType );
void InvalidateTextSelection(); // #i27301# - text selection has changed
void InvalidateAttr(); // #i88069# - attributes has changed
bool HasAdditionalAccessibleChildren();
// #i88070# - get additional child by index
Window* GetAdditionalAccessibleChild( const sal_Int32 nIndex );
// #i88070# - get all additional accessible children
void GetAdditionalAccessibleChildren( std::vector< Window* >* pChildren );
const ::rtl::OUString& GetName() const { return sName; }
virtual sal_Bool HasCursor(); // required by map to remember that object
sal_Bool Select( SwPaM *pPaM, SdrObject *pObj, sal_Bool bAdd );
inline sal_Bool Select( SwPaM& rPaM )
{
return Select( &rPaM, 0, sal_False );
}
inline sal_Bool Select( SdrObject *pObj, sal_Bool bAdd )
{
return Select( 0, pObj, bAdd );
}
static ::rtl::OUString GetResource( sal_uInt16 nResId,
const ::rtl::OUString *pArg1 = 0,
const ::rtl::OUString *pArg2 = 0 );
};
// some heaviliy used exception support
const sal_Char sDefunc[] = "object is defunctional";
const sal_Char sMissingWindow[] = "window is missing";
#define THROW_RUNTIME_EXCEPTION( ifc, msg ) \
::com::sun::star::uno::Reference < ifc > xThis( this ); \
::com::sun::star::uno::RuntimeException aExcept( \
::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM(msg) ), xThis ); \
throw aExcept;
#define CHECK_FOR_DEFUNC_THIS( ifc, ths ) \
if( !(GetFrm() && GetMap()) ) \
{ \
::com::sun::star::uno::Reference < ifc > xThis( ths ); \
::com::sun::star::lang::DisposedException aExcept( \
::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM(sDefunc) ), \
xThis ); \
throw aExcept; \
}
#define CHECK_FOR_DEFUNC( ifc ) \
CHECK_FOR_DEFUNC_THIS( ifc, this )
#define CHECK_FOR_WINDOW( i, w ) \
if( !(w) ) \
{ \
THROW_RUNTIME_EXCEPTION( i, sMissingWindow ); \
}
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
