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