Line data Source code
1 : /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 : /*
3 : * This file is part of the LibreOffice project.
4 : *
5 : * This Source Code Form is subject to the terms of the Mozilla Public
6 : * License, v. 2.0. If a copy of the MPL was not distributed with this
7 : * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 : *
9 : * This file incorporates work covered by the following license notice:
10 : *
11 : * Licensed to the Apache Software Foundation (ASF) under one or more
12 : * contributor license agreements. See the NOTICE file distributed
13 : * with this work for additional information regarding copyright
14 : * ownership. The ASF licenses this file to you under the Apache
15 : * License, Version 2.0 (the "License"); you may not use this file
16 : * except in compliance with the License. You may obtain a copy of
17 : * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 : */
19 :
20 : #include "accessibility/extended/AccessibleGridControlBase.hxx"
21 : #include <svtools/accessibletable.hxx>
22 : #include <comphelper/servicehelper.hxx>
23 : #include <cppuhelper/supportsservice.hxx>
24 :
25 : #include <com/sun/star/accessibility/AccessibleEventId.hpp>
26 : #include <com/sun/star/accessibility/AccessibleStateType.hpp>
27 : #include <unotools/accessiblerelationsethelper.hxx>
28 :
29 : // ============================================================================
30 :
31 : using ::com::sun::star::uno::Reference;
32 : using ::com::sun::star::uno::Sequence;
33 : using ::com::sun::star::uno::Any;
34 :
35 : using namespace ::com::sun::star;
36 : using namespace ::com::sun::star::accessibility;
37 : using namespace ::comphelper;
38 : using namespace ::svt;
39 : using namespace ::svt::table;
40 :
41 :
42 : // ============================================================================
43 :
44 : namespace accessibility {
45 :
46 : using namespace com::sun::star::accessibility::AccessibleStateType;
47 : // ============================================================================
48 :
49 0 : AccessibleGridControlBase::AccessibleGridControlBase(
50 : const Reference< XAccessible >& rxParent,
51 : svt::table::IAccessibleTable& rTable,
52 : AccessibleTableControlObjType eObjType ) :
53 : AccessibleGridControlImplHelper( m_aMutex ),
54 : m_xParent( rxParent ),
55 : m_aTable( rTable),
56 : m_eObjType( eObjType ),
57 0 : m_aName( rTable.GetAccessibleObjectName( eObjType, 0, 0 ) ),
58 0 : m_aDescription( rTable.GetAccessibleObjectDescription( eObjType ) ),
59 0 : m_aClientId(0)
60 : {
61 0 : }
62 :
63 0 : AccessibleGridControlBase::~AccessibleGridControlBase()
64 : {
65 0 : if( isAlive() )
66 : {
67 : // increment ref count to prevent double call of Dtor
68 0 : osl_atomic_increment( &m_refCount );
69 0 : dispose();
70 : }
71 0 : }
72 :
73 0 : void SAL_CALL AccessibleGridControlBase::disposing()
74 : {
75 0 : ::osl::MutexGuard aGuard( getOslMutex() );
76 :
77 0 : if ( getClientId( ) )
78 : {
79 0 : AccessibleEventNotifier::TClientId nId( getClientId( ) );
80 0 : setClientId( 0 );
81 0 : AccessibleEventNotifier::revokeClientNotifyDisposing( nId, *this );
82 : }
83 :
84 0 : m_xParent = NULL;
85 : //m_aTable = NULL;
86 0 : }
87 :
88 : // XAccessibleContext ---------------------------------------------------------
89 :
90 0 : Reference< XAccessible > SAL_CALL AccessibleGridControlBase::getAccessibleParent()
91 : throw ( uno::RuntimeException )
92 : {
93 0 : ::osl::MutexGuard aGuard( getOslMutex() );
94 0 : ensureIsAlive();
95 0 : return m_xParent;
96 : }
97 :
98 0 : sal_Int32 SAL_CALL AccessibleGridControlBase::getAccessibleIndexInParent()
99 : throw ( uno::RuntimeException )
100 : {
101 0 : ::osl::MutexGuard aGuard( getOslMutex() );
102 0 : ensureIsAlive();
103 :
104 : // -1 for child not found/no parent (according to specification)
105 0 : sal_Int32 nRet = -1;
106 :
107 0 : Reference< uno::XInterface > xMeMyselfAndI( static_cast< XAccessibleContext* >( this ), uno::UNO_QUERY );
108 :
109 : // iterate over parent's children and search for this object
110 0 : if( m_xParent.is() )
111 : {
112 : Reference< XAccessibleContext >
113 0 : xParentContext( m_xParent->getAccessibleContext() );
114 0 : if( xParentContext.is() )
115 : {
116 0 : Reference< uno::XInterface > xChild;
117 :
118 0 : sal_Int32 nChildCount = xParentContext->getAccessibleChildCount();
119 0 : for( sal_Int32 nChild = 0; nChild < nChildCount; ++nChild )
120 : {
121 0 : xChild = xChild.query( xParentContext->getAccessibleChild( nChild ) );
122 0 : if ( xMeMyselfAndI.get() == xChild.get() )
123 : {
124 0 : nRet = nChild;
125 0 : break;
126 : }
127 0 : }
128 0 : }
129 : }
130 0 : return nRet;
131 : }
132 :
133 0 : OUString SAL_CALL AccessibleGridControlBase::getAccessibleDescription()
134 : throw ( uno::RuntimeException )
135 : {
136 0 : ::osl::MutexGuard aGuard( getOslMutex() );
137 0 : ensureIsAlive();
138 0 : return m_aDescription;
139 : }
140 :
141 0 : OUString SAL_CALL AccessibleGridControlBase::getAccessibleName()
142 : throw ( uno::RuntimeException )
143 : {
144 0 : ::osl::MutexGuard aGuard( getOslMutex() );
145 0 : ensureIsAlive();
146 0 : return m_aName;
147 : }
148 :
149 : Reference< XAccessibleRelationSet > SAL_CALL
150 0 : AccessibleGridControlBase::getAccessibleRelationSet()
151 : throw ( uno::RuntimeException )
152 : {
153 0 : ensureIsAlive();
154 : // GridControl does not have relations.
155 0 : return new utl::AccessibleRelationSetHelper;
156 : }
157 :
158 : Reference< XAccessibleStateSet > SAL_CALL
159 0 : AccessibleGridControlBase::getAccessibleStateSet()
160 : throw ( uno::RuntimeException )
161 : {
162 0 : SolarMutexGuard aSolarGuard;
163 0 : ::osl::MutexGuard aGuard( getOslMutex() );
164 : // don't check whether alive -> StateSet may contain DEFUNC
165 0 : return implCreateStateSetHelper();
166 : }
167 :
168 0 : lang::Locale SAL_CALL AccessibleGridControlBase::getLocale()
169 : throw ( IllegalAccessibleComponentStateException, uno::RuntimeException )
170 : {
171 0 : ::osl::MutexGuard aGuard( getOslMutex() );
172 0 : ensureIsAlive();
173 0 : if( m_xParent.is() )
174 : {
175 : Reference< XAccessibleContext >
176 0 : xParentContext( m_xParent->getAccessibleContext() );
177 0 : if( xParentContext.is() )
178 0 : return xParentContext->getLocale();
179 : }
180 0 : throw IllegalAccessibleComponentStateException();
181 : }
182 :
183 : // XAccessibleComponent -------------------------------------------------------
184 :
185 0 : sal_Bool SAL_CALL AccessibleGridControlBase::containsPoint( const awt::Point& rPoint )
186 : throw ( uno::RuntimeException )
187 : {
188 0 : return Rectangle( Point(), getBoundingBox().GetSize() ).IsInside( VCLPoint( rPoint ) );
189 : }
190 :
191 0 : awt::Rectangle SAL_CALL AccessibleGridControlBase::getBounds()
192 : throw ( uno::RuntimeException )
193 : {
194 0 : return AWTRectangle( getBoundingBox() );
195 : }
196 :
197 0 : awt::Point SAL_CALL AccessibleGridControlBase::getLocation()
198 : throw ( uno::RuntimeException )
199 : {
200 0 : return AWTPoint( getBoundingBox().TopLeft() );
201 : }
202 :
203 0 : awt::Point SAL_CALL AccessibleGridControlBase::getLocationOnScreen()
204 : throw ( uno::RuntimeException )
205 : {
206 0 : return AWTPoint( getBoundingBoxOnScreen().TopLeft() );
207 : }
208 :
209 0 : awt::Size SAL_CALL AccessibleGridControlBase::getSize()
210 : throw ( uno::RuntimeException )
211 : {
212 0 : return AWTSize( getBoundingBox().GetSize() );
213 : }
214 :
215 0 : sal_Bool SAL_CALL AccessibleGridControlBase::isShowing()
216 : throw ( uno::RuntimeException )
217 : {
218 0 : SolarMutexGuard aSolarGuard;
219 0 : ::osl::MutexGuard aGuard( getOslMutex() );
220 0 : ensureIsAlive();
221 0 : return implIsShowing();
222 : }
223 :
224 0 : sal_Bool SAL_CALL AccessibleGridControlBase::isVisible()
225 : throw ( uno::RuntimeException )
226 : {
227 0 : Reference< XAccessibleStateSet > xStateSet = getAccessibleStateSet();
228 0 : return xStateSet.is() ?
229 0 : xStateSet->contains( AccessibleStateType::VISIBLE ) : sal_False;
230 : }
231 :
232 0 : sal_Bool SAL_CALL AccessibleGridControlBase::isFocusTraversable()
233 : throw ( uno::RuntimeException )
234 : {
235 0 : Reference< XAccessibleStateSet > xStateSet = getAccessibleStateSet();
236 0 : return xStateSet.is() ?
237 0 : xStateSet->contains( AccessibleStateType::FOCUSABLE ) : sal_False;
238 : }
239 : // XAccessibleEventBroadcaster ------------------------------------------------
240 :
241 0 : void SAL_CALL AccessibleGridControlBase::addAccessibleEventListener(
242 : const Reference< XAccessibleEventListener>& _rxListener )
243 : throw ( uno::RuntimeException )
244 : {
245 0 : if ( _rxListener.is() )
246 : {
247 0 : ::osl::MutexGuard aGuard( getOslMutex() );
248 0 : if ( !getClientId( ) )
249 0 : setClientId( AccessibleEventNotifier::registerClient( ) );
250 :
251 0 : AccessibleEventNotifier::addEventListener( getClientId( ), _rxListener );
252 : }
253 0 : }
254 :
255 0 : void SAL_CALL AccessibleGridControlBase::removeAccessibleEventListener(
256 : const Reference< XAccessibleEventListener>& _rxListener )
257 : throw ( uno::RuntimeException )
258 : {
259 0 : if( _rxListener.is() && getClientId( ) )
260 : {
261 0 : ::osl::MutexGuard aGuard( getOslMutex() );
262 0 : sal_Int32 nListenerCount = AccessibleEventNotifier::removeEventListener( getClientId( ), _rxListener );
263 0 : if ( !nListenerCount )
264 : {
265 : // no listeners anymore
266 : // -> revoke ourself. This may lead to the notifier thread dying (if we were the last client),
267 : // and at least to us not firing any events anymore, in case somebody calls
268 : // NotifyAccessibleEvent, again
269 0 : AccessibleEventNotifier::TClientId nId( getClientId( ) );
270 0 : setClientId( 0 );
271 0 : AccessibleEventNotifier::revokeClient( nId );
272 0 : }
273 : }
274 0 : }
275 :
276 : // XTypeProvider --------------------------------------------------------------
277 :
278 : namespace
279 : {
280 : class theAccessibleGridControlBaseImplementationId : public rtl::Static< UnoTunnelIdInit, theAccessibleGridControlBaseImplementationId > {};
281 : }
282 :
283 0 : Sequence< sal_Int8 > SAL_CALL AccessibleGridControlBase::getImplementationId()
284 : throw ( uno::RuntimeException )
285 : {
286 0 : return theAccessibleGridControlBaseImplementationId::get().getSeq();
287 : }
288 :
289 : // XServiceInfo ---------------------------------------------------------------
290 :
291 0 : sal_Bool SAL_CALL AccessibleGridControlBase::supportsService(
292 : const OUString& rServiceName )
293 : throw ( uno::RuntimeException )
294 : {
295 0 : return cppu::supportsService(this, rServiceName);
296 : }
297 :
298 0 : Sequence< OUString > SAL_CALL AccessibleGridControlBase::getSupportedServiceNames()
299 : throw ( uno::RuntimeException )
300 : {
301 0 : const OUString aServiceName( "com.sun.star.accessibility.AccessibleContext" );
302 0 : return Sequence< OUString >( &aServiceName, 1 );
303 : }
304 : // internal virtual methods ---------------------------------------------------
305 :
306 0 : sal_Bool AccessibleGridControlBase::implIsShowing()
307 : {
308 0 : sal_Bool bShowing = sal_False;
309 0 : if( m_xParent.is() )
310 : {
311 : Reference< XAccessibleComponent >
312 0 : xParentComp( m_xParent->getAccessibleContext(), uno::UNO_QUERY );
313 0 : if( xParentComp.is() )
314 0 : bShowing = implGetBoundingBox().IsOver(
315 0 : VCLRectangle( xParentComp->getBounds() ) );
316 : }
317 0 : return bShowing;
318 : }
319 :
320 0 : ::utl::AccessibleStateSetHelper* AccessibleGridControlBase::implCreateStateSetHelper()
321 : {
322 : ::utl::AccessibleStateSetHelper*
323 0 : pStateSetHelper = new ::utl::AccessibleStateSetHelper;
324 :
325 0 : if( isAlive() )
326 : {
327 : // SHOWING done with m_xParent
328 0 : if( implIsShowing() )
329 0 : pStateSetHelper->AddState( AccessibleStateType::SHOWING );
330 : // GridControl fills StateSet with states depending on object type
331 0 : m_aTable.FillAccessibleStateSet( *pStateSetHelper, getType() );
332 : }
333 : else
334 0 : pStateSetHelper->AddState( AccessibleStateType::DEFUNC );
335 0 : return pStateSetHelper;
336 : }
337 :
338 : // internal helper methods ----------------------------------------------------
339 :
340 0 : sal_Bool AccessibleGridControlBase::isAlive() const
341 : {
342 0 : return !rBHelper.bDisposed && !rBHelper.bInDispose && &m_aTable;
343 : }
344 :
345 0 : void AccessibleGridControlBase::ensureIsAlive() const
346 : throw ( lang::DisposedException )
347 : {
348 0 : if( !isAlive() )
349 0 : throw lang::DisposedException();
350 0 : }
351 :
352 0 : Rectangle AccessibleGridControlBase::getBoundingBox()
353 : throw ( lang::DisposedException )
354 : {
355 0 : SolarMutexGuard aSolarGuard;
356 0 : ::osl::MutexGuard aGuard( getOslMutex() );
357 0 : ensureIsAlive();
358 0 : Rectangle aRect = implGetBoundingBox();
359 0 : if ( 0 == aRect.Left() && 0 == aRect.Top() && 0 == aRect.Right() && 0 == aRect.Bottom() )
360 : {
361 : SAL_WARN( "accessibility", "rectangle doesn't exist" );
362 : }
363 0 : return aRect;
364 : }
365 :
366 0 : Rectangle AccessibleGridControlBase::getBoundingBoxOnScreen()
367 : throw ( lang::DisposedException )
368 : {
369 0 : SolarMutexGuard aSolarGuard;
370 0 : ::osl::MutexGuard aGuard( getOslMutex() );
371 0 : ensureIsAlive();
372 0 : Rectangle aRect = implGetBoundingBoxOnScreen();
373 0 : if ( 0 == aRect.Left() && 0 == aRect.Top() && 0 == aRect.Right() && 0 == aRect.Bottom() )
374 : {
375 : SAL_WARN( "accessibility", "rectangle doesn't exist" );
376 : }
377 0 : return aRect;
378 : }
379 :
380 0 : void AccessibleGridControlBase::commitEvent(
381 : sal_Int16 _nEventId, const Any& _rNewValue, const Any& _rOldValue )
382 : {
383 0 : ::osl::ClearableMutexGuard aGuard( getOslMutex() );
384 0 : if ( !getClientId( ) )
385 : // if we don't have a client id for the notifier, then we don't have listeners, then
386 : // we don't need to notify anything
387 0 : return;
388 :
389 : // build an event object
390 0 : AccessibleEventObject aEvent;
391 0 : aEvent.Source = *this;
392 0 : aEvent.EventId = _nEventId;
393 0 : aEvent.OldValue = _rOldValue;
394 0 : aEvent.NewValue = _rNewValue;
395 :
396 : // let the notifier handle this event
397 :
398 0 : AccessibleEventNotifier::addEvent( getClientId( ), aEvent );
399 : }
400 :
401 0 : sal_Int16 SAL_CALL AccessibleGridControlBase::getAccessibleRole()
402 : throw ( uno::RuntimeException )
403 : {
404 0 : ensureIsAlive();
405 0 : sal_Int16 nRole = AccessibleRole::UNKNOWN;
406 0 : switch ( m_eObjType )
407 : {
408 : case TCTYPE_ROWHEADERCELL:
409 0 : nRole = AccessibleRole::ROW_HEADER;
410 0 : break;
411 : case TCTYPE_COLUMNHEADERCELL:
412 0 : nRole = AccessibleRole::COLUMN_HEADER;
413 0 : break;
414 : case TCTYPE_COLUMNHEADERBAR:
415 : case TCTYPE_ROWHEADERBAR:
416 : case TCTYPE_TABLE:
417 0 : nRole = AccessibleRole::TABLE;
418 0 : break;
419 : case TCTYPE_TABLECELL:
420 0 : nRole = AccessibleRole::TABLE_CELL;
421 0 : break;
422 : case TCTYPE_GRIDCONTROL:
423 0 : nRole = AccessibleRole::PANEL;
424 0 : break;
425 : }
426 0 : return nRole;
427 : }
428 : // -----------------------------------------------------------------------------
429 0 : Any SAL_CALL AccessibleGridControlBase::getAccessibleKeyBinding()
430 : throw ( uno::RuntimeException )
431 : {
432 0 : return Any();
433 : }
434 : // -----------------------------------------------------------------------------
435 0 : Reference<XAccessible > SAL_CALL AccessibleGridControlBase::getAccessibleAtPoint( const ::com::sun::star::awt::Point& )
436 : throw ( uno::RuntimeException )
437 : {
438 0 : return NULL;
439 : }
440 : //// -----------------------------------------------------------------------------
441 0 : sal_Int32 SAL_CALL AccessibleGridControlBase::getForeground( ) throw (::com::sun::star::uno::RuntimeException)
442 : {
443 0 : SolarMutexGuard aSolarGuard;
444 0 : ::osl::MutexGuard aGuard( getOslMutex() );
445 0 : ensureIsAlive();
446 :
447 0 : sal_Int32 nColor = 0;
448 0 : Window* pInst = m_aTable.GetWindowInstance();
449 0 : if ( pInst )
450 : {
451 0 : if ( pInst->IsControlForeground() )
452 0 : nColor = pInst->GetControlForeground().GetColor();
453 : else
454 : {
455 0 : Font aFont;
456 0 : if ( pInst->IsControlFont() )
457 0 : aFont = pInst->GetControlFont();
458 : else
459 0 : aFont = pInst->GetFont();
460 0 : nColor = aFont.GetColor().GetColor();
461 : }
462 : }
463 0 : return nColor;
464 : }
465 : // -----------------------------------------------------------------------------
466 0 : sal_Int32 SAL_CALL AccessibleGridControlBase::getBackground( ) throw (::com::sun::star::uno::RuntimeException)
467 : {
468 0 : SolarMutexGuard aSolarGuard;
469 0 : ::osl::MutexGuard aGuard( getOslMutex() );
470 0 : ensureIsAlive();
471 0 : sal_Int32 nColor = 0;
472 0 : Window* pInst = m_aTable.GetWindowInstance();
473 0 : if ( pInst )
474 : {
475 0 : if ( pInst->IsControlBackground() )
476 0 : nColor = pInst->GetControlBackground().GetColor();
477 : else
478 0 : nColor = pInst->GetBackground().GetColor().GetColor();
479 : }
480 0 : return nColor;
481 : }
482 :
483 : //// ============================================================================
484 0 : GridControlAccessibleElement::GridControlAccessibleElement( const Reference< XAccessible >& rxParent,
485 : IAccessibleTable& rTable,
486 : AccessibleTableControlObjType eObjType )
487 0 : :AccessibleGridControlBase( rxParent, rTable, eObjType )
488 : {
489 0 : }
490 :
491 : // XInterface -----------------------------------------------------------------
492 0 : IMPLEMENT_FORWARD_XINTERFACE2( GridControlAccessibleElement, AccessibleGridControlBase, GridControlAccessibleElement_Base)
493 :
494 : // XTypeProvider --------------------------------------------------------------
495 0 : IMPLEMENT_FORWARD_XTYPEPROVIDER2( GridControlAccessibleElement, AccessibleGridControlBase, GridControlAccessibleElement_Base )
496 :
497 : // XAccessible ----------------------------------------------------------------
498 :
499 0 : Reference< XAccessibleContext > SAL_CALL GridControlAccessibleElement::getAccessibleContext() throw ( uno::RuntimeException )
500 : {
501 0 : ensureIsAlive();
502 0 : return this;
503 : }
504 : // ----------------------------------------------------------------------------
505 0 : GridControlAccessibleElement::~GridControlAccessibleElement( )
506 : {
507 0 : }
508 :
509 : // ============================================================================
510 :
511 : } // namespace accessibility
512 :
513 : // ============================================================================
514 :
515 : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
