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