accessibility/source/extended/accessibletabbar.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/accessibletabbar.hxx>
  21 #include <svtools/tabbar.hxx>
  22 #include <extended/accessibletabbarpagelist.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/awt/XDevice.hpp>
  27 #include <com/sun/star/awt/XVclWindowPeer.hpp>
  28 #include <com/sun/star/lang/IndexOutOfBoundsException.hpp>
  29 #include <comphelper/accessiblecontexthelper.hxx>
  30 #include <cppuhelper/supportsservice.hxx>
  31 #include <unotools/accessiblerelationsethelper.hxx>
  32 #include <i18nlangtag/languagetag.hxx>
  33 #include <o3tl/safeint.hxx>
  34 #include <vcl/svapp.hxx>
  35 #include <vcl/settings.hxx>
  36 #include <vcl/unohelp.hxx>
  37
  38 namespace accessibility
  39 {
  40
  41
  42     using namespace ::com::sun::star;
  43     using namespace ::com::sun::star::uno;
  44     using namespace ::com::sun::star::lang;
  45     using namespace ::com::sun::star::accessibility;
  46     using namespace ::comphelper;
  47
  48
  49
  50
  51     AccessibleTabBar::AccessibleTabBar( TabBar* pTabBar )
  52         :ImplInheritanceHelper( pTabBar )
  53     {
  54         if ( m_pTabBar )
  55             m_aAccessibleChildren.assign( m_pTabBar->GetAccessibleChildWindowCount() + 1, Reference< XAccessible >() );
  56     }
  57
  58
  59     void AccessibleTabBar::ProcessWindowEvent( const VclWindowEvent& rVclWindowEvent )
  60     {
  61         Any aOldValue, aNewValue;
  62
  63         switch ( rVclWindowEvent.GetId() )
  64         {
  65             case VclEventId::WindowEnabled:
  66             {
  67                 aNewValue <<= AccessibleStateType::SENSITIVE;
  68                 NotifyAccessibleEvent( AccessibleEventId::STATE_CHANGED, aOldValue, aNewValue );
  69                 aNewValue <<= AccessibleStateType::ENABLED;
  70                 NotifyAccessibleEvent( AccessibleEventId::STATE_CHANGED, aOldValue, aNewValue );
  71             }
  72             break;
  73             case VclEventId::WindowDisabled:
  74             {
  75                 aOldValue <<= AccessibleStateType::ENABLED;
  76                 NotifyAccessibleEvent( AccessibleEventId::STATE_CHANGED, aOldValue, aNewValue );
  77                 aOldValue <<= AccessibleStateType::SENSITIVE;
  78                 NotifyAccessibleEvent( AccessibleEventId::STATE_CHANGED, aOldValue, aNewValue );
  79             }
  80             break;
  81             case VclEventId::WindowGetFocus:
  82             {
  83                 aNewValue <<= AccessibleStateType::FOCUSED;
  84                 NotifyAccessibleEvent( AccessibleEventId::STATE_CHANGED, aOldValue, aNewValue );
  85             }
  86             break;
  87             case VclEventId::WindowLoseFocus:
  88             {
  89                 aOldValue <<= AccessibleStateType::FOCUSED;
  90                 NotifyAccessibleEvent( AccessibleEventId::STATE_CHANGED, aOldValue, aNewValue );
  91             }
  92             break;
  93             case VclEventId::WindowShow:
  94             {
  95                 aNewValue <<= AccessibleStateType::SHOWING;
  96                 NotifyAccessibleEvent( AccessibleEventId::STATE_CHANGED, aOldValue, aNewValue );
  97             }
  98             break;
  99             case VclEventId::WindowHide:
 100             {
 101                 aOldValue <<= AccessibleStateType::SHOWING;
 102                 NotifyAccessibleEvent( AccessibleEventId::STATE_CHANGED, aOldValue, aNewValue );
 103             }
 104             break;
 105             default:
 106             {
 107                 AccessibleTabBarBase::ProcessWindowEvent( rVclWindowEvent );
 108             }
 109             break;
 110         }
 111     }
 112
 113
 114     void AccessibleTabBar::FillAccessibleStateSet( sal_Int64& rStateSet )
 115     {
 116         if ( !m_pTabBar )
 117             return;
 118
 119         if ( m_pTabBar->IsEnabled() )
 120         {
 121             rStateSet |= AccessibleStateType::ENABLED;
 122             rStateSet |= AccessibleStateType::SENSITIVE;
 123         }
 124
 125         rStateSet |= AccessibleStateType::FOCUSABLE;
 126
 127         if ( m_pTabBar->HasFocus() )
 128             rStateSet |= AccessibleStateType::FOCUSED;
 129
 130         rStateSet |= AccessibleStateType::VISIBLE;
 131
 132         if ( m_pTabBar->IsVisible() )
 133             rStateSet |= AccessibleStateType::SHOWING;
 134
 135         if ( m_pTabBar->GetStyle() & WB_SIZEABLE )
 136             rStateSet |= AccessibleStateType::RESIZABLE;
 137     }
 138
 139
 140     // OCommonAccessibleComponent
 141
 142
 143     awt::Rectangle AccessibleTabBar::implGetBounds()
 144     {
 145         awt::Rectangle aBounds;
 146         if ( m_pTabBar )
 147             aBounds = vcl::unohelper::ConvertToAWTRect(
 148                 tools::Rectangle(m_pTabBar->GetPosPixel(), m_pTabBar->GetSizePixel()));
 149
 150         return aBounds;
 151     }
 152
 153
 154     // XComponent
 155
 156
 157     void AccessibleTabBar::disposing()
 158     {
 159         AccessibleTabBarBase::disposing();
 160
 161         // dispose all children
 162         for (const Reference<XAccessible>& i : m_aAccessibleChildren)
 163         {
 164             Reference< XComponent > xComponent( i, UNO_QUERY );
 165             if ( xComponent.is() )
 166                 xComponent->dispose();
 167         }
 168         m_aAccessibleChildren.clear();
 169     }
 170
 171
 172     // XServiceInfo
 173
 174
 175     OUString AccessibleTabBar::getImplementationName()
 176     {
 177         return u"com.sun.star.comp.svtools.AccessibleTabBar"_ustr;
 178     }
 179
 180
 181     sal_Bool AccessibleTabBar::supportsService( const OUString& rServiceName )
 182     {
 183         return cppu::supportsService(this, rServiceName);
 184     }
 185
 186
 187     Sequence< OUString > AccessibleTabBar::getSupportedServiceNames()
 188     {
 189         return  { u"com.sun.star.awt.AccessibleTabBar"_ustr };
 190     }
 191
 192
 193     // XAccessible
 194
 195
 196     Reference< XAccessibleContext > AccessibleTabBar::getAccessibleContext(  )
 197     {
 198         OExternalLockGuard aGuard( this );
 199
 200         return this;
 201     }
 202
 203
 204     // XAccessibleContext
 205
 206
 207     sal_Int64 AccessibleTabBar::getAccessibleChildCount()
 208     {
 209         OExternalLockGuard aGuard( this );
 210
 211         return m_aAccessibleChildren.size();
 212     }
 213
 214
 215     Reference< XAccessible > AccessibleTabBar::getAccessibleChild( sal_Int64 i )
 216     {
 217         OExternalLockGuard aGuard( this );
 218
 219         if ( i < 0 || o3tl::make_unsigned(i) >= m_aAccessibleChildren.size() )
 220             throw IndexOutOfBoundsException();
 221
 222         Reference< XAccessible > xChild = m_aAccessibleChildren[i];
 223         if ( !xChild.is() )
 224         {
 225             if ( m_pTabBar )
 226             {
 227                 sal_Int32 nCount = m_pTabBar->GetAccessibleChildWindowCount();
 228
 229                 if ( i < nCount )
 230                 {
 231                     vcl::Window* pChild = m_pTabBar->GetAccessibleChildWindow( static_cast<sal_uInt16>(i) );
 232                     if ( pChild )
 233                         xChild = pChild->GetAccessible();
 234                 }
 235                 else if ( i == nCount )
 236                 {
 237                     xChild = new AccessibleTabBarPageList( m_pTabBar, i );
 238                 }
 239
 240                 // insert into child list
 241                 m_aAccessibleChildren[i] = xChild;
 242             }
 243         }
 244
 245         return xChild;
 246     }
 247
 248
 249     Reference< XAccessible > AccessibleTabBar::getAccessibleParent(  )
 250     {
 251         OExternalLockGuard aGuard( this );
 252
 253         Reference< XAccessible > xParent;
 254         if ( m_pTabBar )
 255         {
 256             vcl::Window* pParent = m_pTabBar->GetAccessibleParentWindow();
 257             if ( pParent )
 258                 xParent = pParent->GetAccessible();
 259         }
 260
 261         return xParent;
 262     }
 263
 264
 265     sal_Int64 AccessibleTabBar::getAccessibleIndexInParent(  )
 266     {
 267         OExternalLockGuard aGuard( this );
 268
 269         sal_Int64 nIndexInParent = -1;
 270         if ( m_pTabBar )
 271         {
 272             vcl::Window* pParent = m_pTabBar->GetAccessibleParentWindow();
 273             if ( pParent )
 274             {
 275                 for ( sal_uInt16 i = 0, nCount = pParent->GetAccessibleChildWindowCount(); i < nCount; ++i )
 276                 {
 277                     vcl::Window* pChild = pParent->GetAccessibleChildWindow( i );
 278                     if ( pChild == static_cast< vcl::Window* >( m_pTabBar ) )
 279                     {
 280                         nIndexInParent = i;
 281                         break;
 282                     }
 283                 }
 284             }
 285         }
 286
 287         return nIndexInParent;
 288     }
 289
 290
 291     sal_Int16 AccessibleTabBar::getAccessibleRole(  )
 292     {
 293         OExternalLockGuard aGuard( this );
 294
 295         return AccessibleRole::PANEL;
 296     }
 297
 298     OUString AccessibleTabBar::getAccessibleDescription( )
 299     {
 300         OExternalLockGuard aGuard( this );
 301
 302         if (m_pTabBar)
 303             return m_pTabBar->GetAccessibleDescription();
 304
 305         return OUString();
 306     }
 307
 308     OUString AccessibleTabBar::getAccessibleName(  )
 309     {
 310         OExternalLockGuard aGuard( this );
 311
 312         if (m_pTabBar)
 313             return m_pTabBar->GetAccessibleName();
 314
 315         return OUString();
 316     }
 317
 318     Reference< XAccessibleRelationSet > AccessibleTabBar::getAccessibleRelationSet(  )
 319     {
 320         OExternalLockGuard aGuard( this );
 321
 322         return new utl::AccessibleRelationSetHelper;
 323     }
 324
 325     sal_Int64 AccessibleTabBar::getAccessibleStateSet(  )
 326     {
 327         OExternalLockGuard aGuard( this );
 328
 329         sal_Int64 nStateSet = 0;
 330
 331         if ( !rBHelper.bDisposed && !rBHelper.bInDispose )
 332         {
 333             FillAccessibleStateSet( nStateSet );
 334         }
 335         else
 336         {
 337             nStateSet |= AccessibleStateType::DEFUNC;
 338         }
 339
 340         return nStateSet;
 341     }
 342
 343
 344     Locale AccessibleTabBar::getLocale(  )
 345     {
 346         OExternalLockGuard aGuard( this );
 347
 348         return Application::GetSettings().GetLanguageTag().getLocale();
 349     }
 350
 351     // XAccessibleComponent
 352     Reference< XAccessible > AccessibleTabBar::getAccessibleAtPoint( const awt::Point& rPoint )
 353     {
 354         OExternalLockGuard aGuard( this );
 355
 356         for( sal_Int64 i = 0; i < getAccessibleChildCount(); ++i )
 357         {
 358             Reference< XAccessible > xAcc = getAccessibleChild( i );
 359             if ( xAcc.is() )
 360             {
 361                 Reference< XAccessibleComponent > xComp( xAcc->getAccessibleContext(), UNO_QUERY );
 362                 if ( xComp.is() )
 363                 {
 364                     tools::Rectangle aRect = vcl::unohelper::ConvertToVCLRect(xComp->getBounds());
 365                     Point aPos = vcl::unohelper::ConvertToVCLPoint(rPoint);
 366                     if ( aRect.Contains( aPos ) )
 367                     {
 368                         return xAcc;
 369                     }
 370                 }
 371             }
 372         }
 373
 374         return nullptr;
 375     }
 376
 377     void AccessibleTabBar::grabFocus(  )
 378     {
 379         OExternalLockGuard aGuard( this );
 380
 381         if ( m_pTabBar )
 382             m_pTabBar->GrabFocus();
 383     }
 384
 385
 386     sal_Int32 AccessibleTabBar::getForeground(  )
 387     {
 388         OExternalLockGuard aGuard( this );
 389
 390         Color nColor;
 391         if ( m_pTabBar )
 392         {
 393             if ( m_pTabBar->IsControlForeground() )
 394                 nColor = m_pTabBar->GetControlForeground();
 395             else
 396             {
 397                 vcl::Font aFont;
 398                 if ( m_pTabBar->IsControlFont() )
 399                     aFont = m_pTabBar->GetControlFont();
 400                 else
 401                     aFont = m_pTabBar->GetFont();
 402                 nColor = aFont.GetColor();
 403             }
 404         }
 405
 406         return sal_Int32(nColor);
 407     }
 408
 409
 410     sal_Int32 AccessibleTabBar::getBackground(  )
 411     {
 412         OExternalLockGuard aGuard( this );
 413
 414         Color nColor;
 415         if ( m_pTabBar )
 416         {
 417             if ( m_pTabBar->IsControlBackground() )
 418                 nColor = m_pTabBar->GetControlBackground();
 419             else
 420                 nColor = m_pTabBar->GetBackground().GetColor();
 421         }
 422
 423         return sal_Int32(nColor);
 424     }
 425
 426
 427     // XAccessibleExtendedComponent
 428
 429     OUString AccessibleTabBar::getTitledBorderText(  )
 430     {
 431         OExternalLockGuard aGuard( this );
 432
 433         OUString sText;
 434         if ( m_pTabBar )
 435             sText = m_pTabBar->GetText();
 436
 437         return sText;
 438     }
 439
 440
 441     OUString AccessibleTabBar::getToolTipText(  )
 442     {
 443         OExternalLockGuard aGuard( this );
 444
 445         OUString sText;
 446         if ( m_pTabBar )
 447             sText = m_pTabBar->GetQuickHelpText();
 448
 449         return sText;
 450     }
 451
 452
 453 }   // namespace accessibility
 454
 455
 456 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */