accessibility/source/extended/accessibletabbarpagelist.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/accessibletabbarpagelist.hxx>
  21 #include <svtools/tabbar.hxx>
  22 #include <com/sun/star/accessibility/AccessibleEventId.hpp>
  23 #include <com/sun/star/accessibility/AccessibleRole.hpp>
  24 #include <com/sun/star/accessibility/AccessibleStateType.hpp>
  25 #include <com/sun/star/lang/IndexOutOfBoundsException.hpp>
  26 #include <comphelper/accessiblecontexthelper.hxx>
  27 #include <cppuhelper/supportsservice.hxx>
  28 #include <o3tl/safeint.hxx>
  29 #include <unotools/accessiblerelationsethelper.hxx>
  30 #include <vcl/svapp.hxx>
  31 #include <vcl/settings.hxx>
  32 #include <vcl/unohelp.hxx>
  33 #include <i18nlangtag/languagetag.hxx>
  34
  35
  36 namespace accessibility
  37 {
  38
  39
  40     using namespace ::com::sun::star::accessibility;
  41     using namespace ::com::sun::star::uno;
  42     using namespace ::com::sun::star::lang;
  43     using namespace ::com::sun::star;
  44     using namespace ::comphelper;
  45
  46
  47
  48
  49     AccessibleTabBarPageList::AccessibleTabBarPageList( TabBar* pTabBar, sal_Int32 nIndexInParent )
  50         :ImplInheritanceHelper( pTabBar )
  51         ,m_nIndexInParent( nIndexInParent )
  52     {
  53         if ( m_pTabBar )
  54             m_aAccessibleChildren.assign( m_pTabBar->GetPageCount(), rtl::Reference< AccessibleTabBarPage >() );
  55     }
  56
  57
  58     void AccessibleTabBarPageList::UpdateShowing( bool bShowing )
  59     {
  60         for (const rtl::Reference<AccessibleTabBarPage>& xChild : m_aAccessibleChildren)
  61         {
  62             if ( xChild.is() )
  63                 xChild->SetShowing( bShowing );
  64         }
  65     }
  66
  67
  68     void AccessibleTabBarPageList::UpdateSelected( sal_Int32 i, bool bSelected )
  69     {
  70         NotifyAccessibleEvent( AccessibleEventId::SELECTION_CHANGED, Any(), Any() );
  71
  72         if ( i >= 0 && o3tl::make_unsigned(i) < m_aAccessibleChildren.size() )
  73         {
  74             rtl::Reference< AccessibleTabBarPage > xChild( m_aAccessibleChildren[i] );
  75             if ( xChild.is() )
  76                 xChild->SetSelected( bSelected );
  77         }
  78     }
  79
  80
  81     void AccessibleTabBarPageList::UpdatePageText( sal_Int32 i )
  82     {
  83         if ( i < 0 || o3tl::make_unsigned(i) >= m_aAccessibleChildren.size() )
  84             return;
  85
  86         if ( m_pTabBar )
  87         {
  88             rtl::Reference< AccessibleTabBarPage > pAccessibleTabBarPage( m_aAccessibleChildren[i] );
  89             if ( pAccessibleTabBarPage.is() )
  90             {
  91                 OUString sPageText = m_pTabBar->GetPageText( m_pTabBar->GetPageId( static_cast<sal_uInt16>(i) ) );
  92                 pAccessibleTabBarPage->SetPageText( sPageText );
  93             }
  94         }
  95     }
  96
  97
  98     void AccessibleTabBarPageList::InsertChild( sal_Int32 i )
  99     {
 100         if ( i < 0 || o3tl::make_unsigned(i) > m_aAccessibleChildren.size() )
 101             return;
 102
 103         // insert entry in child list
 104         m_aAccessibleChildren.insert( m_aAccessibleChildren.begin() + i, rtl::Reference< AccessibleTabBarPage >() );
 105
 106         // send accessible child event
 107         Reference< XAccessible > xChild( getAccessibleChild( i ) );
 108         if ( xChild.is() )
 109         {
 110             Any aOldValue, aNewValue;
 111             aNewValue <<= xChild;
 112             NotifyAccessibleEvent( AccessibleEventId::CHILD, aOldValue, aNewValue );
 113         }
 114     }
 115
 116
 117     void AccessibleTabBarPageList::RemoveChild( sal_Int32 i )
 118     {
 119         if ( i < 0 || o3tl::make_unsigned(i) >= m_aAccessibleChildren.size() )
 120             return;
 121
 122         // get the accessible of the removed page
 123         rtl::Reference< AccessibleTabBarPage > xChild( m_aAccessibleChildren[i] );
 124
 125         // remove entry in child list
 126         m_aAccessibleChildren.erase( m_aAccessibleChildren.begin() + i );
 127
 128         // send accessible child event
 129         if ( xChild.is() )
 130         {
 131             Any aOldValue, aNewValue;
 132             aOldValue <<= uno::Reference<XAccessible>(xChild);
 133             NotifyAccessibleEvent( AccessibleEventId::CHILD, aOldValue, aNewValue );
 134
 135             xChild->dispose();
 136         }
 137     }
 138
 139
 140     void AccessibleTabBarPageList::MoveChild( sal_Int32 i, sal_Int32 j )
 141     {
 142         if ( !(i >= 0 && o3tl::make_unsigned(i) < m_aAccessibleChildren.size() &&
 143              j >= 0 && o3tl::make_unsigned(j) <= m_aAccessibleChildren.size()) )
 144             return;
 145
 146         if ( i < j )
 147             --j;
 148
 149         // get the accessible of the moved page
 150         rtl::Reference< AccessibleTabBarPage > xChild( m_aAccessibleChildren[i] );
 151
 152         // remove entry in child list at old position
 153         m_aAccessibleChildren.erase( m_aAccessibleChildren.begin() + i );
 154
 155         // insert entry in child list at new position
 156         m_aAccessibleChildren.insert( m_aAccessibleChildren.begin() + j, xChild );
 157     }
 158
 159
 160     void AccessibleTabBarPageList::ProcessWindowEvent( const VclWindowEvent& rVclWindowEvent )
 161     {
 162          switch ( rVclWindowEvent.GetId() )
 163          {
 164             case VclEventId::WindowEnabled:
 165             {
 166                 Any aNewValue;
 167                 aNewValue <<= AccessibleStateType::SENSITIVE;
 168                 NotifyAccessibleEvent( AccessibleEventId::STATE_CHANGED, Any(), aNewValue );
 169                 aNewValue <<= AccessibleStateType::ENABLED;
 170                 NotifyAccessibleEvent( AccessibleEventId::STATE_CHANGED, Any(), aNewValue );
 171             }
 172             break;
 173             case VclEventId::WindowDisabled:
 174             {
 175                 Any aOldValue;
 176                 aOldValue <<= AccessibleStateType::ENABLED;
 177                 NotifyAccessibleEvent( AccessibleEventId::STATE_CHANGED, aOldValue, Any() );
 178                 aOldValue <<= AccessibleStateType::SENSITIVE;
 179                 NotifyAccessibleEvent( AccessibleEventId::STATE_CHANGED, aOldValue, Any() );
 180             }
 181             break;
 182             case VclEventId::WindowShow:
 183             {
 184                 Any aOldValue, aNewValue;
 185                 aNewValue <<= AccessibleStateType::SHOWING;
 186                 NotifyAccessibleEvent( AccessibleEventId::STATE_CHANGED, aOldValue, aNewValue );
 187                 UpdateShowing( true );
 188             }
 189             break;
 190             case VclEventId::WindowHide:
 191             {
 192                 Any aOldValue, aNewValue;
 193                 aOldValue <<= AccessibleStateType::SHOWING;
 194                 NotifyAccessibleEvent( AccessibleEventId::STATE_CHANGED, aOldValue, aNewValue );
 195                 UpdateShowing( false );
 196             }
 197             break;
 198             case VclEventId::TabbarPageSelected:
 199             {
 200                 // do nothing
 201             }
 202             break;
 203             case VclEventId::TabbarPageActivated:
 204             {
 205                 if ( m_pTabBar )
 206                 {
 207                     sal_uInt16 nPageId = static_cast<sal_uInt16>(reinterpret_cast<sal_IntPtr>(rVclWindowEvent.GetData()));
 208                     sal_uInt16 nPagePos = m_pTabBar->GetPagePos( nPageId );
 209                     UpdateSelected( nPagePos, true );
 210                 }
 211             }
 212             break;
 213             case VclEventId::TabbarPageDeactivated:
 214             {
 215                 if ( m_pTabBar )
 216                 {
 217                     sal_uInt16 nPageId = static_cast<sal_uInt16>(reinterpret_cast<sal_IntPtr>(rVclWindowEvent.GetData()));
 218                     sal_uInt16 nPagePos = m_pTabBar->GetPagePos( nPageId );
 219                     UpdateSelected( nPagePos, false );
 220                 }
 221             }
 222             break;
 223             case VclEventId::TabbarPageInserted:
 224             {
 225                 if ( m_pTabBar )
 226                 {
 227                     sal_uInt16 nPageId = static_cast<sal_uInt16>(reinterpret_cast<sal_IntPtr>(rVclWindowEvent.GetData()));
 228                     sal_uInt16 nPagePos = m_pTabBar->GetPagePos( nPageId );
 229                     InsertChild( nPagePos );
 230                 }
 231             }
 232             break;
 233             case VclEventId::TabbarPageRemoved:
 234             {
 235                 if ( m_pTabBar )
 236                 {
 237                     sal_uInt16 nPageId = static_cast<sal_uInt16>(reinterpret_cast<sal_IntPtr>(rVclWindowEvent.GetData()));
 238
 239                     OExternalLockGuard aGuard( this );
 240
 241                     if ( nPageId == TabBar::PAGE_NOT_FOUND )
 242                     {
 243                         for ( sal_Int32 i = m_aAccessibleChildren.size() - 1; i >= 0; --i )
 244                             RemoveChild( i );
 245                     }
 246                     else
 247                     {
 248                         for ( sal_Int64 i = 0, nCount = m_aAccessibleChildren.size(); i < nCount; ++i )
 249                         {
 250                             sal_uInt16 nChildPageId = m_pTabBar->GetPageId( static_cast<sal_uInt16>(i) );
 251                             if (nPageId == nChildPageId)
 252                             {
 253                                 RemoveChild( i );
 254                                 break;
 255                             }
 256                         }
 257                     }
 258                 }
 259             }
 260             break;
 261             case VclEventId::TabbarPageMoved:
 262             {
 263                 Pair* pPair = static_cast<Pair*>(rVclWindowEvent.GetData());
 264                 if ( pPair )
 265                     MoveChild( pPair->A(), pPair->B() );
 266             }
 267             break;
 268             case VclEventId::TabbarPageTextChanged:
 269             {
 270                 sal_uInt16 nPageId = static_cast<sal_uInt16>(reinterpret_cast<sal_IntPtr>(rVclWindowEvent.GetData()));
 271                 sal_uInt16 nPagePos = m_pTabBar->GetPagePos( nPageId );
 272                 UpdatePageText( nPagePos );
 273             }
 274             break;
 275             default:
 276             {
 277                 AccessibleTabBarBase::ProcessWindowEvent( rVclWindowEvent );
 278             }
 279             break;
 280         }
 281     }
 282
 283
 284     void AccessibleTabBarPageList::FillAccessibleStateSet( sal_Int64& rStateSet )
 285     {
 286         if ( !m_pTabBar )
 287             return;
 288
 289         if ( m_pTabBar->IsEnabled() )
 290         {
 291             rStateSet |= AccessibleStateType::ENABLED;
 292             rStateSet |= AccessibleStateType::SENSITIVE;
 293         }
 294
 295         rStateSet |= AccessibleStateType::VISIBLE;
 296
 297         if ( m_pTabBar->IsVisible() )
 298             rStateSet |= AccessibleStateType::SHOWING;
 299     }
 300
 301
 302     // OCommonAccessibleComponent
 303
 304
 305     awt::Rectangle AccessibleTabBarPageList::implGetBounds()
 306     {
 307         awt::Rectangle aBounds;
 308         if ( m_pTabBar )
 309             aBounds = vcl::unohelper::ConvertToAWTRect(m_pTabBar->GetPageArea());
 310
 311         return aBounds;
 312     }
 313
 314
 315     // XComponent
 316
 317
 318     void AccessibleTabBarPageList::disposing()
 319     {
 320         AccessibleTabBarBase::disposing();
 321
 322         // dispose all children
 323         for (const rtl::Reference<AccessibleTabBarPage>& xComponent : m_aAccessibleChildren)
 324         {
 325             if ( xComponent.is() )
 326                 xComponent->dispose();
 327         }
 328         m_aAccessibleChildren.clear();
 329     }
 330
 331
 332     // XServiceInfo
 333
 334
 335     OUString AccessibleTabBarPageList::getImplementationName()
 336     {
 337         return u"com.sun.star.comp.svtools.AccessibleTabBarPageList"_ustr;
 338     }
 339
 340
 341     sal_Bool AccessibleTabBarPageList::supportsService( const OUString& rServiceName )
 342     {
 343         return cppu::supportsService(this, rServiceName);
 344     }
 345
 346
 347     Sequence< OUString > AccessibleTabBarPageList::getSupportedServiceNames()
 348     {
 349         return { u"com.sun.star.awt.AccessibleTabBarPageList"_ustr };
 350     }
 351
 352
 353     // XAccessible
 354
 355
 356     Reference< XAccessibleContext > AccessibleTabBarPageList::getAccessibleContext(  )
 357     {
 358         OExternalLockGuard aGuard( this );
 359
 360         return this;
 361     }
 362
 363
 364     // XAccessibleContext
 365
 366
 367     sal_Int64 AccessibleTabBarPageList::getAccessibleChildCount()
 368     {
 369         OExternalLockGuard aGuard( this );
 370
 371         return m_aAccessibleChildren.size();
 372     }
 373
 374
 375     Reference< XAccessible > AccessibleTabBarPageList::getAccessibleChild( sal_Int64 i )
 376     {
 377         OExternalLockGuard aGuard( this );
 378
 379         return getAccessibleChildImpl(i);
 380     }
 381
 382     rtl::Reference< AccessibleTabBarPage > AccessibleTabBarPageList::getAccessibleChildImpl( sal_Int64 i )
 383     {
 384         if ( i < 0 || i >= getAccessibleChildCount() )
 385             throw IndexOutOfBoundsException();
 386
 387         rtl::Reference< AccessibleTabBarPage > xChild = m_aAccessibleChildren[i];
 388         if ( !xChild.is() )
 389         {
 390             if ( m_pTabBar )
 391             {
 392                 sal_uInt16 nPageId = m_pTabBar->GetPageId( static_cast<sal_uInt16>(i) );
 393
 394                 xChild = new AccessibleTabBarPage( m_pTabBar, nPageId, this );
 395
 396                 // insert into child list
 397                 m_aAccessibleChildren[i] = xChild;
 398             }
 399         }
 400
 401         return xChild;
 402     }
 403
 404
 405     Reference< XAccessible > AccessibleTabBarPageList::getAccessibleParent(  )
 406     {
 407         OExternalLockGuard aGuard( this );
 408
 409         Reference< XAccessible > xParent;
 410         if ( m_pTabBar )
 411             xParent = m_pTabBar->GetAccessible();
 412
 413         return xParent;
 414     }
 415
 416
 417     sal_Int64 AccessibleTabBarPageList::getAccessibleIndexInParent(  )
 418     {
 419         OExternalLockGuard aGuard( this );
 420
 421         return m_nIndexInParent;
 422     }
 423
 424
 425     sal_Int16 AccessibleTabBarPageList::getAccessibleRole(  )
 426     {
 427         return AccessibleRole::PAGE_TAB_LIST;
 428     }
 429
 430
 431     OUString AccessibleTabBarPageList::getAccessibleDescription( )
 432     {
 433         return OUString();
 434     }
 435
 436
 437     OUString AccessibleTabBarPageList::getAccessibleName(  )
 438     {
 439         return OUString();
 440     }
 441
 442
 443     Reference< XAccessibleRelationSet > AccessibleTabBarPageList::getAccessibleRelationSet(  )
 444     {
 445         OExternalLockGuard aGuard( this );
 446
 447         return new utl::AccessibleRelationSetHelper;
 448     }
 449
 450
 451     sal_Int64 AccessibleTabBarPageList::getAccessibleStateSet(  )
 452     {
 453         OExternalLockGuard aGuard( this );
 454
 455         sal_Int64 nStateSet = 0;
 456
 457         if ( !rBHelper.bDisposed && !rBHelper.bInDispose )
 458         {
 459             FillAccessibleStateSet( nStateSet );
 460         }
 461         else
 462         {
 463             nStateSet |= AccessibleStateType::DEFUNC;
 464         }
 465
 466         return nStateSet;
 467     }
 468
 469
 470     Locale AccessibleTabBarPageList::getLocale(  )
 471     {
 472         OExternalLockGuard aGuard( this );
 473
 474         return Application::GetSettings().GetLanguageTag().getLocale();
 475     }
 476
 477
 478     // XAccessibleComponent
 479
 480
 481     Reference< XAccessible > AccessibleTabBarPageList::getAccessibleAtPoint( const awt::Point& rPoint )
 482     {
 483         OExternalLockGuard aGuard( this );
 484
 485         Reference< XAccessible > xChild;
 486         for ( size_t i = 0; i < m_aAccessibleChildren.size(); ++i )
 487         {
 488             rtl::Reference< AccessibleTabBarPage > xAcc = getAccessibleChildImpl( i );
 489             if ( xAcc.is() )
 490             {
 491                 Reference< XAccessibleComponent > xComp( xAcc->getAccessibleContext(), UNO_QUERY );
 492                 if ( xComp.is() )
 493                 {
 494                     tools::Rectangle aRect = vcl::unohelper::ConvertToVCLRect(xComp->getBounds());
 495                     Point aPos = vcl::unohelper::ConvertToVCLPoint(rPoint);
 496                     if ( aRect.Contains( aPos ) )
 497                     {
 498                         xChild = xAcc;
 499                         break;
 500                     }
 501                 }
 502             }
 503         }
 504
 505         return xChild;
 506     }
 507
 508
 509     void AccessibleTabBarPageList::grabFocus(  )
 510     {
 511         // no focus
 512     }
 513
 514
 515     sal_Int32 AccessibleTabBarPageList::getForeground(  )
 516     {
 517         OExternalLockGuard aGuard( this );
 518
 519         sal_Int32 nColor = 0;
 520         Reference< XAccessible > xParent = getAccessibleParent();
 521         if ( xParent.is() )
 522         {
 523             Reference< XAccessibleComponent > xParentComp( xParent->getAccessibleContext(), UNO_QUERY );
 524             if ( xParentComp.is() )
 525                 nColor = xParentComp->getForeground();
 526         }
 527
 528         return nColor;
 529     }
 530
 531
 532     sal_Int32 AccessibleTabBarPageList::getBackground(  )
 533     {
 534         OExternalLockGuard aGuard( this );
 535
 536         sal_Int32 nColor = 0;
 537         Reference< XAccessible > xParent = getAccessibleParent();
 538         if ( xParent.is() )
 539         {
 540             Reference< XAccessibleComponent > xParentComp( xParent->getAccessibleContext(), UNO_QUERY );
 541             if ( xParentComp.is() )
 542                 nColor = xParentComp->getBackground();
 543         }
 544
 545         return nColor;
 546     }
 547
 548
 549     // XAccessibleExtendedComponent
 550
 551     OUString AccessibleTabBarPageList::getTitledBorderText(  )
 552     {
 553         return OUString();
 554     }
 555
 556
 557     OUString AccessibleTabBarPageList::getToolTipText(  )
 558     {
 559         return OUString();
 560     }
 561
 562
 563     // XAccessibleSelection
 564
 565
 566     void AccessibleTabBarPageList::selectAccessibleChild( sal_Int64 nChildIndex )
 567     {
 568         OExternalLockGuard aGuard( this );
 569
 570         if ( nChildIndex < 0 || nChildIndex >= getAccessibleChildCount() )
 571             throw IndexOutOfBoundsException();
 572
 573         if ( m_pTabBar )
 574         {
 575             m_pTabBar->SetCurPageId( m_pTabBar->GetPageId( static_cast<sal_uInt16>(nChildIndex) ) );
 576             m_pTabBar->PaintImmediately();
 577             m_pTabBar->ActivatePage();
 578             m_pTabBar->Select();
 579         }
 580     }
 581
 582
 583     sal_Bool AccessibleTabBarPageList::isAccessibleChildSelected( sal_Int64 nChildIndex )
 584     {
 585         OExternalLockGuard aGuard( this );
 586
 587         if ( nChildIndex < 0 || nChildIndex >= getAccessibleChildCount() )
 588             throw IndexOutOfBoundsException();
 589
 590         bool bSelected = false;
 591         if ( m_pTabBar && m_pTabBar->GetCurPageId() == m_pTabBar->GetPageId( static_cast<sal_uInt16>(nChildIndex) ) )
 592             bSelected = true;
 593
 594         return bSelected;
 595     }
 596
 597
 598     void AccessibleTabBarPageList::clearAccessibleSelection(  )
 599     {
 600         // This method makes no sense in a TabBar, and so does nothing.
 601     }
 602
 603
 604     void AccessibleTabBarPageList::selectAllAccessibleChildren(  )
 605     {
 606         selectAccessibleChild( 0 );
 607     }
 608
 609
 610     sal_Int64 AccessibleTabBarPageList::getSelectedAccessibleChildCount(  )
 611     {
 612         return 1;
 613     }
 614
 615
 616     Reference< XAccessible > AccessibleTabBarPageList::getSelectedAccessibleChild( sal_Int64 nSelectedChildIndex )
 617     {
 618         OExternalLockGuard aGuard( this );
 619
 620         if ( nSelectedChildIndex < 0 || nSelectedChildIndex >= getSelectedAccessibleChildCount() )
 621             throw IndexOutOfBoundsException();
 622
 623         Reference< XAccessible > xChild;
 624
 625         for ( sal_Int64 i = 0, j = 0, nCount = getAccessibleChildCount(); i < nCount; i++ )
 626         {
 627             if ( isAccessibleChildSelected( i ) && ( j++ == nSelectedChildIndex ) )
 628             {
 629                 xChild = getAccessibleChild( i );
 630                 break;
 631             }
 632         }
 633
 634         return xChild;
 635     }
 636
 637
 638     void AccessibleTabBarPageList::deselectAccessibleChild( sal_Int64 nChildIndex )
 639     {
 640         OExternalLockGuard aGuard( this );
 641
 642         if ( nChildIndex < 0 || nChildIndex >= getAccessibleChildCount() )
 643             throw IndexOutOfBoundsException();
 644
 645         // This method makes no sense in a TabBar, and so does nothing.
 646     }
 647
 648
 649 }   // namespace accessibility
 650
 651
 652 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */