accessibility/source/extended/AccessibleGridControlBase.cxx

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