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