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