accessibility/source/extended/accessibletabbarpage.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 <accessibility/extended/accessibletabbarpage.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 <cppuhelper/supportsservice.hxx>
  26 #include <unotools/accessiblestatesethelper.hxx>
  27 #include <unotools/accessiblerelationsethelper.hxx>
  28 #include <vcl/svapp.hxx>
  29 #include <toolkit/helper/convert.hxx>
  30
  31
  32 //.........................................................................
  33 namespace accessibility
  34 {
  35 //.........................................................................
  36
  37     using namespace ::com::sun::star::accessibility;
  38     using namespace ::com::sun::star::uno;
  39     using namespace ::com::sun::star::lang;
  40     using namespace ::com::sun::star;
  41     using namespace ::comphelper;
  42
  43     // -----------------------------------------------------------------------------
  44     // class AccessibleTabBarPage
  45     // -----------------------------------------------------------------------------
  46
  47     AccessibleTabBarPage::AccessibleTabBarPage( TabBar* pTabBar, sal_uInt16 nPageId, const Reference< XAccessible >& rxParent )
  48         :AccessibleTabBarBase( pTabBar )
  49         ,m_nPageId( nPageId )
  50         ,m_xParent( rxParent )
  51     {
  52         m_bEnabled  = IsEnabled();
  53         m_bShowing  = IsShowing();
  54         m_bSelected = IsSelected();
  55
  56         if ( m_pTabBar )
  57             m_sPageText = m_pTabBar->GetPageText( m_nPageId );
  58     }
  59
  60     // -----------------------------------------------------------------------------
  61
  62     AccessibleTabBarPage::~AccessibleTabBarPage()
  63     {
  64     }
  65
  66     // -----------------------------------------------------------------------------
  67
  68     sal_Bool AccessibleTabBarPage::IsEnabled()
  69     {
  70         OExternalLockGuard aGuard( this );
  71
  72         sal_Bool bEnabled = sal_False;
  73         if ( m_pTabBar )
  74             bEnabled = m_pTabBar->IsPageEnabled( m_nPageId );
  75
  76         return bEnabled;
  77     }
  78
  79     // -----------------------------------------------------------------------------
  80
  81     sal_Bool AccessibleTabBarPage::IsShowing()
  82     {
  83         sal_Bool bShowing = sal_False;
  84
  85         if ( m_pTabBar && m_pTabBar->IsVisible() )
  86             bShowing = sal_True;
  87
  88         return bShowing;
  89     }
  90
  91     // -----------------------------------------------------------------------------
  92
  93     sal_Bool AccessibleTabBarPage::IsSelected()
  94     {
  95         sal_Bool bSelected = sal_False;
  96
  97         if ( m_pTabBar && m_pTabBar->GetCurPageId() == m_nPageId )
  98             bSelected = sal_True;
  99
 100         return bSelected;
 101     }
 102
 103     // -----------------------------------------------------------------------------
 104
 105     void AccessibleTabBarPage::SetEnabled( sal_Bool bEnabled )
 106     {
 107         if ( m_bEnabled != bEnabled )
 108         {
 109             Any aOldValue[2], aNewValue[2];
 110             if ( m_bEnabled )
 111             {
 112                 aOldValue[0] <<= AccessibleStateType::SENSITIVE;
 113                 aOldValue[1] <<= AccessibleStateType::ENABLED;
 114             }
 115             else
 116             {
 117
 118                 aNewValue[0] <<= AccessibleStateType::ENABLED;
 119                 aNewValue[1] <<= AccessibleStateType::SENSITIVE;
 120             }
 121             m_bEnabled = bEnabled;
 122             NotifyAccessibleEvent( AccessibleEventId::STATE_CHANGED, aOldValue[0], aNewValue[0] );
 123             NotifyAccessibleEvent( AccessibleEventId::STATE_CHANGED, aOldValue[1], aNewValue[1] );
 124         }
 125     }
 126
 127     // -----------------------------------------------------------------------------
 128
 129     void AccessibleTabBarPage::SetShowing( sal_Bool bShowing )
 130     {
 131         if ( m_bShowing != bShowing )
 132         {
 133             Any aOldValue, aNewValue;
 134             if ( m_bShowing )
 135                 aOldValue <<= AccessibleStateType::SHOWING;
 136             else
 137                 aNewValue <<= AccessibleStateType::SHOWING;
 138             m_bShowing = bShowing;
 139             NotifyAccessibleEvent( AccessibleEventId::STATE_CHANGED, aOldValue, aNewValue );
 140         }
 141     }
 142
 143     // -----------------------------------------------------------------------------
 144
 145     void AccessibleTabBarPage::SetSelected( sal_Bool bSelected )
 146     {
 147         if ( m_bSelected != bSelected )
 148         {
 149             Any aOldValue, aNewValue;
 150             if ( m_bSelected )
 151                 aOldValue <<= AccessibleStateType::SELECTED;
 152             else
 153                 aNewValue <<= AccessibleStateType::SELECTED;
 154             m_bSelected = bSelected;
 155             NotifyAccessibleEvent( AccessibleEventId::STATE_CHANGED, aOldValue, aNewValue );
 156         }
 157     }
 158
 159     // -----------------------------------------------------------------------------
 160
 161     void AccessibleTabBarPage::SetPageText( const OUString& sPageText )
 162     {
 163         if ( !m_sPageText.equals( sPageText ) )
 164         {
 165             Any aOldValue, aNewValue;
 166             aOldValue <<= m_sPageText;
 167             aNewValue <<= sPageText;
 168             m_sPageText = sPageText;
 169             NotifyAccessibleEvent( AccessibleEventId::NAME_CHANGED, aOldValue, aNewValue );
 170         }
 171     }
 172
 173     // -----------------------------------------------------------------------------
 174
 175     void AccessibleTabBarPage::FillAccessibleStateSet( utl::AccessibleStateSetHelper& rStateSet )
 176     {
 177         if ( IsEnabled() )
 178         {
 179             rStateSet.AddState( AccessibleStateType::ENABLED );
 180             rStateSet.AddState( AccessibleStateType::SENSITIVE );
 181         }
 182
 183         rStateSet.AddState( AccessibleStateType::VISIBLE );
 184
 185         if ( IsShowing() )
 186             rStateSet.AddState( AccessibleStateType::SHOWING );
 187
 188         rStateSet.AddState( AccessibleStateType::SELECTABLE );
 189
 190         if ( IsSelected() )
 191             rStateSet.AddState( AccessibleStateType::SELECTED );
 192     }
 193
 194     // -----------------------------------------------------------------------------
 195     // OCommonAccessibleComponent
 196     // -----------------------------------------------------------------------------
 197
 198     awt::Rectangle AccessibleTabBarPage::implGetBounds() throw (RuntimeException)
 199     {
 200         awt::Rectangle aBounds;
 201         if ( m_pTabBar )
 202         {
 203             // get bounding rectangle relative to the AccessibleTabBar
 204             aBounds = AWTRectangle( m_pTabBar->GetPageRect( m_nPageId ) );
 205
 206             // get position of the AccessibleTabBarPageList relative to the AccessibleTabBar
 207             Reference< XAccessible > xParent = getAccessibleParent();
 208             if ( xParent.is() )
 209             {
 210                 Reference< XAccessibleComponent > xParentComponent( xParent->getAccessibleContext(), UNO_QUERY );
 211                 if ( xParentComponent.is() )
 212                 {
 213                     awt::Point aParentLoc = xParentComponent->getLocation();
 214
 215                     // calculate bounding rectangle relative to the AccessibleTabBarPageList
 216                     aBounds.X -= aParentLoc.X;
 217                     aBounds.Y -= aParentLoc.Y;
 218                 }
 219             }
 220         }
 221
 222         return aBounds;
 223     }
 224
 225     // -----------------------------------------------------------------------------
 226     // XInterface
 227     // -----------------------------------------------------------------------------
 228
 229     IMPLEMENT_FORWARD_XINTERFACE2( AccessibleTabBarPage, AccessibleExtendedComponentHelper_BASE, AccessibleTabBarPage_BASE )
 230
 231     // -----------------------------------------------------------------------------
 232     // XTypeProvider
 233     // -----------------------------------------------------------------------------
 234
 235     IMPLEMENT_FORWARD_XTYPEPROVIDER2( AccessibleTabBarPage, AccessibleExtendedComponentHelper_BASE, AccessibleTabBarPage_BASE )
 236
 237     // -----------------------------------------------------------------------------
 238     // XComponent
 239     // -----------------------------------------------------------------------------
 240
 241     void AccessibleTabBarPage::disposing()
 242     {
 243         AccessibleTabBarBase::disposing();
 244         m_sPageText = OUString();
 245     }
 246
 247     // -----------------------------------------------------------------------------
 248     // XServiceInfo
 249     // -----------------------------------------------------------------------------
 250
 251     OUString AccessibleTabBarPage::getImplementationName() throw (RuntimeException)
 252     {
 253         return OUString( "com.sun.star.comp.svtools.AccessibleTabBarPage" );
 254     }
 255
 256     // -----------------------------------------------------------------------------
 257
 258     sal_Bool AccessibleTabBarPage::supportsService( const OUString& rServiceName ) throw (RuntimeException)
 259     {
 260         return cppu::supportsService(this, rServiceName);
 261     }
 262
 263     // -----------------------------------------------------------------------------
 264
 265     Sequence< OUString > AccessibleTabBarPage::getSupportedServiceNames() throw (RuntimeException)
 266     {
 267         Sequence< OUString > aNames(1);
 268         aNames[0] = "com.sun.star.awt.AccessibleTabBarPage";
 269         return aNames;
 270     }
 271
 272     // -----------------------------------------------------------------------------
 273     // XAccessible
 274     // -----------------------------------------------------------------------------
 275
 276     Reference< XAccessibleContext > AccessibleTabBarPage::getAccessibleContext(  ) throw (RuntimeException)
 277     {
 278         OExternalLockGuard aGuard( this );
 279
 280         return this;
 281     }
 282
 283     // -----------------------------------------------------------------------------
 284     // XAccessibleContext
 285     // -----------------------------------------------------------------------------
 286
 287     sal_Int32 AccessibleTabBarPage::getAccessibleChildCount() throw (RuntimeException)
 288     {
 289         OExternalLockGuard aGuard( this );
 290
 291         return 0;
 292     }
 293
 294     // -----------------------------------------------------------------------------
 295
 296     Reference< XAccessible > AccessibleTabBarPage::getAccessibleChild( sal_Int32 i ) throw (IndexOutOfBoundsException, RuntimeException)
 297     {
 298         OExternalLockGuard aGuard( this );
 299
 300         if ( i < 0 || i >= getAccessibleChildCount() )
 301             throw IndexOutOfBoundsException();
 302
 303         return Reference< XAccessible >();
 304     }
 305
 306     // -----------------------------------------------------------------------------
 307
 308     Reference< XAccessible > AccessibleTabBarPage::getAccessibleParent(  ) throw (RuntimeException)
 309     {
 310         OExternalLockGuard aGuard( this );
 311
 312         return m_xParent;
 313     }
 314
 315     // -----------------------------------------------------------------------------
 316
 317     sal_Int32 AccessibleTabBarPage::getAccessibleIndexInParent(  ) throw (RuntimeException)
 318     {
 319         OExternalLockGuard aGuard( this );
 320
 321         sal_Int32 nIndexInParent = -1;
 322         if ( m_pTabBar )
 323             nIndexInParent = m_pTabBar->GetPagePos( m_nPageId );
 324
 325         return nIndexInParent;
 326     }
 327
 328     // -----------------------------------------------------------------------------
 329
 330     sal_Int16 AccessibleTabBarPage::getAccessibleRole(  ) throw (RuntimeException)
 331     {
 332         OExternalLockGuard aGuard( this );
 333
 334         return AccessibleRole::PAGE_TAB;
 335     }
 336
 337     // -----------------------------------------------------------------------------
 338
 339     OUString AccessibleTabBarPage::getAccessibleDescription( ) throw (RuntimeException)
 340     {
 341         OExternalLockGuard aGuard( this );
 342
 343         OUString sDescription;
 344         if ( m_pTabBar )
 345             sDescription = m_pTabBar->GetHelpText( m_nPageId );
 346
 347         return sDescription;
 348     }
 349
 350     // -----------------------------------------------------------------------------
 351
 352     OUString AccessibleTabBarPage::getAccessibleName(  ) throw (RuntimeException)
 353     {
 354         OExternalLockGuard aGuard( this );
 355
 356         return m_sPageText;
 357     }
 358
 359     // -----------------------------------------------------------------------------
 360
 361     Reference< XAccessibleRelationSet > AccessibleTabBarPage::getAccessibleRelationSet(  ) throw (RuntimeException)
 362     {
 363         OExternalLockGuard aGuard( this );
 364
 365         utl::AccessibleRelationSetHelper* pRelationSetHelper = new utl::AccessibleRelationSetHelper;
 366         Reference< XAccessibleRelationSet > xSet = pRelationSetHelper;
 367         return xSet;
 368     }
 369
 370     // -----------------------------------------------------------------------------
 371
 372     Reference< XAccessibleStateSet > AccessibleTabBarPage::getAccessibleStateSet(  ) throw (RuntimeException)
 373     {
 374         OExternalLockGuard aGuard( this );
 375
 376         utl::AccessibleStateSetHelper* pStateSetHelper = new utl::AccessibleStateSetHelper;
 377         Reference< XAccessibleStateSet > xSet = pStateSetHelper;
 378
 379         if ( !rBHelper.bDisposed && !rBHelper.bInDispose )
 380         {
 381             FillAccessibleStateSet( *pStateSetHelper );
 382         }
 383         else
 384         {
 385             pStateSetHelper->AddState( AccessibleStateType::DEFUNC );
 386         }
 387
 388         return xSet;
 389     }
 390
 391     // -----------------------------------------------------------------------------
 392
 393     Locale AccessibleTabBarPage::getLocale(  ) throw (IllegalAccessibleComponentStateException, RuntimeException)
 394     {
 395         OExternalLockGuard aGuard( this );
 396
 397         return Application::GetSettings().GetLanguageTag().getLocale();
 398     }
 399
 400     // -----------------------------------------------------------------------------
 401     // XAccessibleComponent
 402     // -----------------------------------------------------------------------------
 403
 404     Reference< XAccessible > AccessibleTabBarPage::getAccessibleAtPoint( const awt::Point& ) throw (RuntimeException)
 405     {
 406         OExternalLockGuard aGuard( this );
 407
 408         return Reference< XAccessible >();
 409     }
 410
 411     // -----------------------------------------------------------------------------
 412
 413     void AccessibleTabBarPage::grabFocus(  ) throw (RuntimeException)
 414     {
 415         // no focus
 416     }
 417
 418     // -----------------------------------------------------------------------------
 419
 420     sal_Int32 AccessibleTabBarPage::getForeground(  ) throw (RuntimeException)
 421     {
 422         OExternalLockGuard aGuard( this );
 423
 424         sal_Int32 nColor = 0;
 425         Reference< XAccessible > xParent = getAccessibleParent();
 426         if ( xParent.is() )
 427         {
 428             Reference< XAccessibleComponent > xParentComp( xParent->getAccessibleContext(), UNO_QUERY );
 429             if ( xParentComp.is() )
 430                 nColor = xParentComp->getForeground();
 431         }
 432
 433         return nColor;
 434     }
 435
 436     // -----------------------------------------------------------------------------
 437
 438     sal_Int32 AccessibleTabBarPage::getBackground(  ) throw (RuntimeException)
 439     {
 440         OExternalLockGuard aGuard( this );
 441
 442         sal_Int32 nColor = 0;
 443         Reference< XAccessible > xParent = getAccessibleParent();
 444         if ( xParent.is() )
 445         {
 446             Reference< XAccessibleComponent > xParentComp( xParent->getAccessibleContext(), UNO_QUERY );
 447             if ( xParentComp.is() )
 448                 nColor = xParentComp->getBackground();
 449         }
 450
 451         return nColor;
 452     }
 453
 454     // -----------------------------------------------------------------------------
 455     // XAccessibleExtendedComponent
 456     // -----------------------------------------------------------------------------
 457
 458     Reference< awt::XFont > AccessibleTabBarPage::getFont(  ) throw (RuntimeException)
 459     {
 460         OExternalLockGuard aGuard( this );
 461
 462         Reference< awt::XFont > xFont;
 463         Reference< XAccessible > xParent = getAccessibleParent();
 464         if ( xParent.is() )
 465         {
 466             Reference< XAccessibleExtendedComponent > xParentComp( xParent->getAccessibleContext(), UNO_QUERY );
 467             if ( xParentComp.is() )
 468                 xFont = xParentComp->getFont();
 469         }
 470
 471         return xFont;
 472     }
 473
 474     // -----------------------------------------------------------------------------
 475
 476     OUString AccessibleTabBarPage::getTitledBorderText(  ) throw (RuntimeException)
 477     {
 478         OExternalLockGuard aGuard( this );
 479
 480         return m_sPageText;
 481     }
 482
 483     // -----------------------------------------------------------------------------
 484
 485     OUString AccessibleTabBarPage::getToolTipText(  ) throw (RuntimeException)
 486     {
 487         OExternalLockGuard aGuard( this );
 488
 489         return OUString();
 490     }
 491
 492     // -----------------------------------------------------------------------------
 493
 494 //.........................................................................
 495 }   // namespace accessibility
 496 //.........................................................................
 497
 498 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */