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
|
/*************************************************************************
* 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.
*
************************************************************************/
#include "precompiled_accessibility.hxx"
#include "accessibility/extended/AccessibleToolPanelDeck.hxx"
/** === begin UNO includes === **/
#include <com/sun/star/accessibility/AccessibleRole.hpp>
#include <com/sun/star/accessibility/AccessibleEventId.hpp>
#include <com/sun/star/accessibility/AccessibleStateType.hpp>
#include <com/sun/star/lang/DisposedException.hpp>
/** === end UNO includes === **/
#include <svtools/toolpanel/toolpaneldeck.hxx>
#include <comphelper/sharedmutex.hxx>
#include <toolkit/helper/externallock.hxx>
#include <toolkit/helper/vclunohelper.hxx>
#include <toolkit/awt/vclxwindow.hxx>
#include <vcl/svapp.hxx>
#include <vos/mutex.hxx>
#include <unotools/accessiblestatesethelper.hxx>
#include <tools/diagnose_ex.h>
#include <boost/noncopyable.hpp>
#include <vector>
//......................................................................................................................
namespace accessibility
{
//......................................................................................................................
/** === begin UNO using === **/
using ::com::sun::star::uno::Reference;
using ::com::sun::star::uno::XInterface;
using ::com::sun::star::uno::UNO_QUERY;
using ::com::sun::star::uno::UNO_QUERY_THROW;
using ::com::sun::star::uno::UNO_SET_THROW;
using ::com::sun::star::uno::Exception;
using ::com::sun::star::uno::RuntimeException;
using ::com::sun::star::uno::Any;
using ::com::sun::star::uno::makeAny;
using ::com::sun::star::uno::Sequence;
using ::com::sun::star::uno::Type;
using ::com::sun::star::accessibility::XAccessible;
using ::com::sun::star::accessibility::XAccessibleContext;
using ::com::sun::star::lang::DisposedException;
using ::com::sun::star::lang::IndexOutOfBoundsException;
using ::com::sun::star::lang::Locale;
using ::com::sun::star::accessibility::XAccessibleRelationSet;
using ::com::sun::star::accessibility::XAccessibleStateSet;
using ::com::sun::star::accessibility::IllegalAccessibleComponentStateException;
using ::com::sun::star::awt::XFont;
/** === end UNO using === **/
namespace AccessibleRole = ::com::sun::star::accessibility::AccessibleRole;
namespace AccessibleEventId = ::com::sun::star::accessibility::AccessibleEventId;
namespace AccessibleStateType = ::com::sun::star::accessibility::AccessibleStateType;
typedef ::com::sun::star::awt::Rectangle UnoRectangle;
typedef ::com::sun::star::awt::Point UnoPoint;
//==================================================================================================================
//= AccessibleToolPanelDeck_Impl - declaration
//==================================================================================================================
class AccessibleToolPanelDeck_Impl :public ::boost::noncopyable
,public ::svt::IToolPanelDeckListener
{
public:
AccessibleToolPanelDeck_Impl(
AccessibleToolPanelDeck& i_rAntiImpl,
const Reference< XAccessible >& i_rAccessibleParent,
::svt::ToolPanelDeck& i_rPanelDeck
);
void checkDisposed();
bool isDisposed() const { return m_pPanelDeck == NULL; }
void dispose();
~AccessibleToolPanelDeck_Impl();
Reference< XAccessible > getOwnAccessible() const;
Reference< XAccessible > getPanelItemAccessible( const size_t i_nPosition, const bool i_bCreate );
protected:
// IToolPanelDeckListener
virtual void PanelInserted( const ::svt::PToolPanel& i_pPanel, const size_t i_nPosition );
virtual void PanelRemoved( const size_t i_nPosition );
virtual void ActivePanelChanged( const ::boost::optional< size_t >& i_rOldActive, const ::boost::optional< size_t >& i_rNewActive );
virtual void LayouterChanged( const ::svt::PDeckLayouter& i_rNewLayouter );
virtual void Dying();
public:
AccessibleToolPanelDeck& m_rAntiImpl;
const Reference< XAccessible > m_xAccessibleParent;
::svt::ToolPanelDeck* m_pPanelDeck;
typedef ::std::vector< Reference< XAccessible > > AccessibleChildren;
AccessibleChildren m_aPanelItemCache;
};
//==================================================================================================================
//= MethodGuard
//==================================================================================================================
class MethodGuard
{
public:
MethodGuard( AccessibleToolPanelDeck_Impl& i_rImpl )
:m_aGuard( Application::GetSolarMutex() )
{
i_rImpl.checkDisposed();
}
~MethodGuard()
{
}
void clear()
{
m_aGuard.clear();
}
private:
::vos::OClearableGuard m_aGuard;
};
//==================================================================================================================
//= AccessibleToolPanelDeck_Impl - implementation
//==================================================================================================================
//------------------------------------------------------------------------------------------------------------------
AccessibleToolPanelDeck_Impl::AccessibleToolPanelDeck_Impl( AccessibleToolPanelDeck& i_rAntiImpl, const Reference< XAccessible >& i_rAccessibleParent,
::svt::ToolPanelDeck& i_rPanelDeck )
:m_rAntiImpl( i_rAntiImpl )
,m_xAccessibleParent( i_rAccessibleParent )
,m_pPanelDeck( &i_rPanelDeck )
{
m_pPanelDeck->AddListener( *this );
m_aPanelItemCache.resize( m_pPanelDeck->GetPanelCount() );
}
//------------------------------------------------------------------------------------------------------------------
AccessibleToolPanelDeck_Impl::~AccessibleToolPanelDeck_Impl()
{
if ( !isDisposed() )
dispose();
}
//------------------------------------------------------------------------------------------------------------------
void AccessibleToolPanelDeck_Impl::dispose()
{
ENSURE_OR_RETURN_VOID( !isDisposed(), "disposed twice" );
m_pPanelDeck->RemoveListener( *this );
m_pPanelDeck = NULL;
}
//------------------------------------------------------------------------------------------------------------------
void AccessibleToolPanelDeck_Impl::checkDisposed()
{
if ( isDisposed() )
throw DisposedException( ::rtl::OUString(), *&m_rAntiImpl );
}
//------------------------------------------------------------------------------------------------------------------
Reference< XAccessible > AccessibleToolPanelDeck_Impl::getOwnAccessible() const
{
Reference< XAccessible > xOwnAccessible( static_cast< XAccessible* >( m_rAntiImpl.GetVCLXWindow() ) );
OSL_ENSURE( xOwnAccessible->getAccessibleContext() == Reference< XAccessibleContext >( &m_rAntiImpl ),
"AccessibleToolPanelDeck_Impl::getOwnAccessible: could not retrieve proper XAccessible for /myself!" );
return xOwnAccessible;
}
//------------------------------------------------------------------------------------------------------------------
Reference< XAccessible > AccessibleToolPanelDeck_Impl::getPanelItemAccessible( const size_t i_nPosition, const bool i_bCreate )
{
ENSURE_OR_RETURN( !isDisposed(), "AccessibleToolPanelDeck_Impl::getPanelItemAccessible: already disposed!", NULL );
ENSURE_OR_RETURN( i_nPosition < m_pPanelDeck->GetPanelCount(), "AccessibleToolPanelDeck_Impl::getPanelItemAccessible: invalid position!", NULL );
ENSURE_OR_RETURN( i_nPosition < m_aPanelItemCache.size(), "AccessibleToolPanelDeck_Impl::getPanelItemAccessible: invalid cache!", NULL );
Reference< XAccessible >& rxChildAccessible( m_aPanelItemCache[ i_nPosition ] );
if ( !rxChildAccessible.is() && i_bCreate )
{
::svt::PDeckLayouter pLayouter( m_pPanelDeck->GetLayouter() );
ENSURE_OR_THROW( pLayouter.get() != NULL, "unexpected NULL layouter for the panel deck" );
rxChildAccessible.set(
pLayouter->GetPanelItemAccessible( i_nPosition, getOwnAccessible() )
);
OSL_ENSURE( rxChildAccessible.is(), "AccessibleToolPanelDeck_Impl::getPanelItemAccessible: illegal accessible returned by the deck layouter!" );
}
return rxChildAccessible;
}
//------------------------------------------------------------------------------------------------------------------
void AccessibleToolPanelDeck_Impl::PanelInserted( const ::svt::PToolPanel& i_pPanel, const size_t i_nPosition )
{
(void)i_pPanel;
MethodGuard aGuard( *this );
// reserve some space in our cache
m_aPanelItemCache.insert( m_aPanelItemCache.begin() + i_nPosition, NULL );
const Reference< XAccessible > xNewPanelItemChild( getPanelItemAccessible( i_nPosition, true ) );
aGuard.clear();
m_rAntiImpl.NotifyAccessibleEvent( AccessibleEventId::CHILD, Any(), makeAny( xNewPanelItemChild ) );
}
//------------------------------------------------------------------------------------------------------------------
void AccessibleToolPanelDeck_Impl::PanelRemoved( const size_t i_nPosition )
{
MethodGuard aGuard( *this );
ENSURE_OR_RETURN_VOID( i_nPosition < m_aPanelItemCache.size(), "AccessibleToolPanelDeck_Impl::PanelRemoved: invalid cache!" );
// *first* obtain the cached XAccessible of the child
const Reference< XAccessible > xOldPanelItemChild( getPanelItemAccessible( i_nPosition, false ) );
// *then* update the cache
m_aPanelItemCache.erase( m_aPanelItemCache.begin() + i_nPosition );
// finally notify
aGuard.clear();
OSL_ENSURE( xOldPanelItemChild.is(), "AccessibleToolPanelDeck_Impl::PanelRemoved: hmmm ..." );
if ( !xOldPanelItemChild.is() )
{
// this might, in theory, happen when the respective child has never been accessed before. Since we do
// not have *any* chance of retrieving the child, we broadcast a ... more generic event
m_rAntiImpl.NotifyAccessibleEvent( AccessibleEventId::INVALIDATE_ALL_CHILDREN, Any(), Any() );
}
else
{
m_rAntiImpl.NotifyAccessibleEvent( AccessibleEventId::CHILD, makeAny( xOldPanelItemChild ), Any() );
}
}
//------------------------------------------------------------------------------------------------------------------
void AccessibleToolPanelDeck_Impl::ActivePanelChanged( const ::boost::optional< size_t >& i_rOldActive, const ::boost::optional< size_t >& i_rNewActive )
{
// TODO
(void)i_rOldActive;
(void)i_rNewActive;
}
//------------------------------------------------------------------------------------------------------------------
void AccessibleToolPanelDeck_Impl::LayouterChanged( const ::svt::PDeckLayouter& i_rNewLayouter )
{
MethodGuard aGuard( *this );
m_rAntiImpl.NotifyAccessibleEvent( AccessibleEventId::INVALIDATE_ALL_CHILDREN, Any(), Any() );
}
//------------------------------------------------------------------------------------------------------------------
void AccessibleToolPanelDeck_Impl::Dying()
{
// the tool panel deck is dying, so dispose ourself
m_rAntiImpl.dispose();
}
//==================================================================================================================
//= AccessibleToolPanelDeck
//==================================================================================================================
//------------------------------------------------------------------------------------------------------------------
AccessibleToolPanelDeck::AccessibleToolPanelDeck( const Reference< XAccessible >& i_rAccessibleParent,
::svt::ToolPanelDeck& i_rPanelDeck )
:AccessibleToolPanelDeck_Base( i_rPanelDeck.GetWindowPeer() )
,m_pImpl( new AccessibleToolPanelDeck_Impl( *this, i_rAccessibleParent, i_rPanelDeck ) )
{
}
//------------------------------------------------------------------------------------------------------------------
AccessibleToolPanelDeck::~AccessibleToolPanelDeck()
{
}
//------------------------------------------------------------------------------------------------------------------
sal_Int32 SAL_CALL AccessibleToolPanelDeck::getAccessibleChildCount( ) throw (RuntimeException)
{
MethodGuard aGuard( *m_pImpl );
return sal_Int32( m_pImpl->m_pPanelDeck->GetPanelCount() );
// TODO: this should probably be +1 - the active panel itself should also be a child ...
}
//------------------------------------------------------------------------------------------------------------------
Reference< XAccessible > SAL_CALL AccessibleToolPanelDeck::getAccessibleChild( sal_Int32 i_nIndex ) throw (IndexOutOfBoundsException, RuntimeException)
{
MethodGuard aGuard( *m_pImpl );
if ( ( i_nIndex < 0 ) || ( i_nIndex >= m_pImpl->m_pPanelDeck->GetPanelCount() ) )
throw IndexOutOfBoundsException( ::rtl::OUString(), *this );
return m_pImpl->getPanelItemAccessible( i_nIndex, true );
}
//------------------------------------------------------------------------------------------------------------------
Reference< XAccessible > SAL_CALL AccessibleToolPanelDeck::getAccessibleParent( ) throw (RuntimeException)
{
MethodGuard aGuard( *m_pImpl );
return m_pImpl->m_xAccessibleParent;
}
//------------------------------------------------------------------------------------------------------------------
sal_Int16 SAL_CALL AccessibleToolPanelDeck::getAccessibleRole( ) throw (RuntimeException)
{
MethodGuard aGuard( *m_pImpl );
return AccessibleRole::PANEL;
}
//------------------------------------------------------------------------------------------------------------------
Reference< XAccessible > SAL_CALL AccessibleToolPanelDeck::getAccessibleAtPoint( const UnoPoint& i_rPoint ) throw (RuntimeException)
{
MethodGuard aGuard( *m_pImpl );
// check whether the given point contains a panel item
::svt::PDeckLayouter pLayouter( m_pImpl->m_pPanelDeck->GetLayouter() );
ENSURE_OR_THROW( pLayouter.get() != NULL, "unexpected NULL layouter for the panel deck" );
const UnoPoint aLocation( getLocationOnScreen() );
const ::Point aRequestedScreenLocation( i_rPoint.X + aLocation.X, i_rPoint.Y + aLocation.Y );
::boost::optional< size_t > aPanelItemPos( pLayouter->GetPanelItemFromScreenPos( aRequestedScreenLocation ) );
if ( !aPanelItemPos )
// TODO: check the panel window itself
return NULL;
return getAccessibleChild( *aPanelItemPos );
}
//------------------------------------------------------------------------------------------------------------------
void SAL_CALL AccessibleToolPanelDeck::grabFocus( ) throw (RuntimeException)
{
MethodGuard aGuard( *m_pImpl );
m_pImpl->m_pPanelDeck->GrabFocus();
}
//------------------------------------------------------------------------------------------------------------------
void SAL_CALL AccessibleToolPanelDeck::disposing()
{
AccessibleToolPanelDeck_Base::disposing();
m_pImpl->dispose();
}
//------------------------------------------------------------------------------------------------------------------
Reference< XAccessible > AccessibleToolPanelDeck::GetChildAccessible( const VclWindowEvent& i_rVclWindowEvent )
{
// don't let the base class generate any A11Y events from VclWindowEvent, we completely manage those
// A11Y events ourself
return NULL;
}
//------------------------------------------------------------------------------------------------------------------
void AccessibleToolPanelDeck::FillAccessibleStateSet( ::utl::AccessibleStateSetHelper& i_rStateSet )
{
AccessibleToolPanelDeck_Base::FillAccessibleStateSet( i_rStateSet );
if ( m_pImpl->isDisposed() )
{
i_rStateSet.AddState( AccessibleStateType::DEFUNC );
}
else
{
i_rStateSet.AddState( AccessibleStateType::FOCUSABLE );
}
}
//......................................................................................................................
} // namespace accessibility
//......................................................................................................................
|
