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