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