svtools/source/control/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 "accessibletabbarpage.hxx"
  21
  22 #include <svtools/tabbar.hxx>
  23 #include <com/sun/star/accessibility/AccessibleEventId.hpp>
  24 #include <com/sun/star/accessibility/AccessibleRole.hpp>
  25 #include <com/sun/star/accessibility/AccessibleStateType.hpp>
  26 #include <com/sun/star/lang/IndexOutOfBoundsException.hpp>
  27 #include <comphelper/accessiblecontexthelper.hxx>
  28 #include <cppuhelper/supportsservice.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     AccessibleTabBarPage::AccessibleTabBarPage( TabBar* pTabBar, sal_uInt16 nPageId, const Reference< XAccessible >& rxParent )
  50         :ImplInheritanceHelper( 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( sal_Int64& rStateSet )
 140     {
 141         if ( IsEnabled() )
 142         {
 143             rStateSet |=  AccessibleStateType::ENABLED;
 144             rStateSet |=  AccessibleStateType::SENSITIVE;
 145         }
 146
 147         rStateSet |=  AccessibleStateType::VISIBLE;
 148
 149         if ( IsShowing() )
 150             rStateSet |=  AccessibleStateType::SHOWING;
 151
 152         rStateSet |=  AccessibleStateType::SELECTABLE;
 153
 154         if ( IsSelected() )
 155             rStateSet |=  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 = vcl::unohelper::ConvertToAWTRect(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     // XComponent
 191
 192
 193     void AccessibleTabBarPage::disposing()
 194     {
 195         AccessibleTabBarBase::disposing();
 196         m_sPageText.clear();
 197     }
 198
 199
 200     // XServiceInfo
 201
 202
 203     OUString AccessibleTabBarPage::getImplementationName()
 204     {
 205         return u"com.sun.star.comp.svtools.AccessibleTabBarPage"_ustr;
 206     }
 207
 208
 209     sal_Bool AccessibleTabBarPage::supportsService( const OUString& rServiceName )
 210     {
 211         return cppu::supportsService(this, rServiceName);
 212     }
 213
 214
 215     Sequence< OUString > AccessibleTabBarPage::getSupportedServiceNames()
 216     {
 217         return { u"com.sun.star.awt.AccessibleTabBarPage"_ustr };
 218     }
 219
 220
 221     // XAccessible
 222
 223
 224     Reference< XAccessibleContext > AccessibleTabBarPage::getAccessibleContext(  )
 225     {
 226         OExternalLockGuard aGuard( this );
 227
 228         return this;
 229     }
 230
 231
 232     // XAccessibleContext
 233
 234
 235     sal_Int64 AccessibleTabBarPage::getAccessibleChildCount()
 236     {
 237         return 0;
 238     }
 239
 240
 241     Reference< XAccessible > AccessibleTabBarPage::getAccessibleChild( sal_Int64 )
 242     {
 243         OExternalLockGuard aGuard( this );
 244
 245         throw IndexOutOfBoundsException();
 246     }
 247
 248
 249     Reference< XAccessible > AccessibleTabBarPage::getAccessibleParent(  )
 250     {
 251         OExternalLockGuard aGuard( this );
 252
 253         return m_xParent;
 254     }
 255
 256
 257     sal_Int64 AccessibleTabBarPage::getAccessibleIndexInParent(  )
 258     {
 259         OExternalLockGuard aGuard( this );
 260
 261         sal_Int64 nIndexInParent = -1;
 262         if ( m_pTabBar )
 263             nIndexInParent = m_pTabBar->GetPagePos( m_nPageId );
 264
 265         return nIndexInParent;
 266     }
 267
 268     sal_Int16 AccessibleTabBarPage::getAccessibleRole(  )
 269     {
 270         return AccessibleRole::PAGE_TAB;
 271     }
 272
 273     OUString AccessibleTabBarPage::getAccessibleDescription( )
 274     {
 275         OExternalLockGuard aGuard( this );
 276
 277         if (m_pTabBar)
 278             return m_pTabBar->GetHelpText(m_nPageId);
 279
 280         return OUString();
 281     }
 282
 283     OUString AccessibleTabBarPage::getAccessibleName(  )
 284     {
 285         OExternalLockGuard aGuard( this );
 286
 287         return m_sPageText;
 288     }
 289
 290     Reference< XAccessibleRelationSet > AccessibleTabBarPage::getAccessibleRelationSet(  )
 291     {
 292         OExternalLockGuard aGuard( this );
 293
 294         return new utl::AccessibleRelationSetHelper;
 295     }
 296
 297     sal_Int64 AccessibleTabBarPage::getAccessibleStateSet(  )
 298     {
 299         OExternalLockGuard aGuard( this );
 300
 301         sal_Int64 nStateSet = 0;
 302
 303         if ( !rBHelper.bDisposed && !rBHelper.bInDispose )
 304         {
 305             FillAccessibleStateSet( nStateSet );
 306         }
 307         else
 308         {
 309             nStateSet |= AccessibleStateType::DEFUNC;
 310         }
 311
 312         return nStateSet;
 313     }
 314
 315
 316     Locale AccessibleTabBarPage::getLocale(  )
 317     {
 318         OExternalLockGuard aGuard( this );
 319
 320         return Application::GetSettings().GetLanguageTag().getLocale();
 321     }
 322
 323
 324     // XAccessibleComponent
 325
 326
 327     Reference< XAccessible > AccessibleTabBarPage::getAccessibleAtPoint( const awt::Point& )
 328     {
 329         return Reference< XAccessible >();
 330     }
 331
 332
 333     void AccessibleTabBarPage::grabFocus(  )
 334     {
 335         // no focus
 336     }
 337
 338
 339     sal_Int32 AccessibleTabBarPage::getForeground(  )
 340     {
 341         OExternalLockGuard aGuard( this );
 342
 343         sal_Int32 nColor = 0;
 344         Reference< XAccessible > xParent = getAccessibleParent();
 345         if ( xParent.is() )
 346         {
 347             Reference< XAccessibleComponent > xParentComp( xParent->getAccessibleContext(), UNO_QUERY );
 348             if ( xParentComp.is() )
 349                 nColor = xParentComp->getForeground();
 350         }
 351
 352         return nColor;
 353     }
 354
 355
 356     sal_Int32 AccessibleTabBarPage::getBackground(  )
 357     {
 358         OExternalLockGuard aGuard( this );
 359
 360         sal_Int32 nColor = 0;
 361         Reference< XAccessible > xParent = getAccessibleParent();
 362         if ( xParent.is() )
 363         {
 364             Reference< XAccessibleComponent > xParentComp( xParent->getAccessibleContext(), UNO_QUERY );
 365             if ( xParentComp.is() )
 366                 nColor = xParentComp->getBackground();
 367         }
 368
 369         return nColor;
 370     }
 371
 372
 373     // XAccessibleExtendedComponent
 374
 375     OUString AccessibleTabBarPage::getTitledBorderText(  )
 376     {
 377         OExternalLockGuard aGuard( this );
 378
 379         return m_sPageText;
 380     }
 381
 382
 383     OUString AccessibleTabBarPage::getToolTipText(  )
 384     {
 385         return OUString();
 386     }
 387
 388
 389 }   // namespace accessibility
 390
 391
 392 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */