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