accessibility/source/extended/accessibletabbarpage.cxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: accessibletabbarpage.cxx,v $
  10  * $Revision: 1.3 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 // MARKER(update_precomp.py): autogen include statement, do not remove
  32 #include "precompiled_accessibility.hxx"
  33 #include <accessibility/extended/accessibletabbarpage.hxx>
  34 #include <svtools/tabbar.hxx>
  35 #include <com/sun/star/accessibility/AccessibleEventId.hpp>
  36 #include <com/sun/star/accessibility/AccessibleRole.hpp>
  37 #include <com/sun/star/accessibility/AccessibleStateType.hpp>
  38 #include <unotools/accessiblestatesethelper.hxx>
  39 #include <unotools/accessiblerelationsethelper.hxx>
  40 #include <vcl/svapp.hxx>
  41 #include <toolkit/helper/convert.hxx>
  42
  43
  44 //.........................................................................
  45 namespace accessibility
  46 {
  47 //.........................................................................
  48
  49     using namespace ::com::sun::star::accessibility;
  50     using namespace ::com::sun::star::uno;
  51     using namespace ::com::sun::star::lang;
  52     using namespace ::com::sun::star;
  53     using namespace ::comphelper;
  54
  55     // -----------------------------------------------------------------------------
  56     // class AccessibleTabBarPage
  57     // -----------------------------------------------------------------------------
  58
  59     AccessibleTabBarPage::AccessibleTabBarPage( TabBar* pTabBar, sal_uInt16 nPageId, const Reference< XAccessible >& rxParent )
  60         :AccessibleTabBarBase( pTabBar )
  61         ,m_nPageId( nPageId )
  62         ,m_xParent( rxParent )
  63     {
  64         m_bEnabled      = IsEnabled();
  65         m_bShowing      = IsShowing();
  66         m_bSelected = IsSelected();
  67
  68         if ( m_pTabBar )
  69             m_sPageText = m_pTabBar->GetPageText( m_nPageId );
  70     }
  71
  72     // -----------------------------------------------------------------------------
  73
  74     AccessibleTabBarPage::~AccessibleTabBarPage()
  75     {
  76     }
  77
  78     // -----------------------------------------------------------------------------
  79
  80     sal_Bool AccessibleTabBarPage::IsEnabled()
  81     {
  82         OExternalLockGuard aGuard( this );
  83
  84         sal_Bool bEnabled = sal_False;
  85         if ( m_pTabBar )
  86             bEnabled = m_pTabBar->IsPageEnabled( m_nPageId );
  87
  88         return bEnabled;
  89     }
  90
  91     // -----------------------------------------------------------------------------
  92
  93     sal_Bool AccessibleTabBarPage::IsShowing()
  94     {
  95         sal_Bool bShowing = sal_False;
  96
  97         if ( m_pTabBar && m_pTabBar->IsVisible() )
  98             bShowing = sal_True;
  99
 100         return bShowing;
 101     }
 102
 103     // -----------------------------------------------------------------------------
 104
 105     sal_Bool AccessibleTabBarPage::IsSelected()
 106     {
 107         sal_Bool bSelected = sal_False;
 108
 109         if ( m_pTabBar && m_pTabBar->GetCurPageId() == m_nPageId )
 110             bSelected = sal_True;
 111
 112         return bSelected;
 113     }
 114
 115     // -----------------------------------------------------------------------------
 116
 117     void AccessibleTabBarPage::SetEnabled( sal_Bool bEnabled )
 118     {
 119         if ( m_bEnabled != bEnabled )
 120         {
 121             Any aOldValue[2], aNewValue[2];
 122             if ( m_bEnabled )
 123             {
 124                 aOldValue[0] <<= AccessibleStateType::SENSITIVE;
 125                 aOldValue[1] <<= AccessibleStateType::ENABLED;
 126             }
 127             else
 128             {
 129
 130                 aNewValue[0] <<= AccessibleStateType::ENABLED;
 131                 aNewValue[1] <<= AccessibleStateType::SENSITIVE;
 132             }
 133             m_bEnabled = bEnabled;
 134             NotifyAccessibleEvent( AccessibleEventId::STATE_CHANGED, aOldValue[0], aNewValue[0] );
 135             NotifyAccessibleEvent( AccessibleEventId::STATE_CHANGED, aOldValue[1], aNewValue[1] );
 136         }
 137     }
 138
 139     // -----------------------------------------------------------------------------
 140
 141     void AccessibleTabBarPage::SetShowing( sal_Bool bShowing )
 142     {
 143         if ( m_bShowing != bShowing )
 144         {
 145             Any aOldValue, aNewValue;
 146             if ( m_bShowing )
 147                 aOldValue <<= AccessibleStateType::SHOWING;
 148             else
 149                 aNewValue <<= AccessibleStateType::SHOWING;
 150             m_bShowing = bShowing;
 151             NotifyAccessibleEvent( AccessibleEventId::STATE_CHANGED, aOldValue, aNewValue );
 152         }
 153     }
 154
 155     // -----------------------------------------------------------------------------
 156
 157     void AccessibleTabBarPage::SetSelected( sal_Bool bSelected )
 158     {
 159         if ( m_bSelected != bSelected )
 160         {
 161             Any aOldValue, aNewValue;
 162             if ( m_bSelected )
 163                 aOldValue <<= AccessibleStateType::SELECTED;
 164             else
 165                 aNewValue <<= AccessibleStateType::SELECTED;
 166             m_bSelected = bSelected;
 167             NotifyAccessibleEvent( AccessibleEventId::STATE_CHANGED, aOldValue, aNewValue );
 168         }
 169     }
 170
 171     // -----------------------------------------------------------------------------
 172
 173     void AccessibleTabBarPage::SetPageText( const ::rtl::OUString& sPageText )
 174     {
 175         if ( !m_sPageText.equals( sPageText ) )
 176         {
 177             Any aOldValue, aNewValue;
 178             aOldValue <<= m_sPageText;
 179             aNewValue <<= sPageText;
 180             m_sPageText = sPageText;
 181             NotifyAccessibleEvent( AccessibleEventId::NAME_CHANGED, aOldValue, aNewValue );
 182         }
 183     }
 184
 185     // -----------------------------------------------------------------------------
 186
 187     void AccessibleTabBarPage::FillAccessibleStateSet( utl::AccessibleStateSetHelper& rStateSet )
 188     {
 189         if ( IsEnabled() )
 190         {
 191             rStateSet.AddState( AccessibleStateType::ENABLED );
 192             rStateSet.AddState( AccessibleStateType::SENSITIVE );
 193         }
 194
 195         rStateSet.AddState( AccessibleStateType::VISIBLE );
 196
 197         if ( IsShowing() )
 198             rStateSet.AddState( AccessibleStateType::SHOWING );
 199
 200         rStateSet.AddState( AccessibleStateType::SELECTABLE );
 201
 202         if ( IsSelected() )
 203             rStateSet.AddState( AccessibleStateType::SELECTED );
 204     }
 205
 206     // -----------------------------------------------------------------------------
 207     // OCommonAccessibleComponent
 208     // -----------------------------------------------------------------------------
 209
 210     awt::Rectangle AccessibleTabBarPage::implGetBounds() throw (RuntimeException)
 211     {
 212         awt::Rectangle aBounds;
 213         if ( m_pTabBar )
 214         {
 215             // get bounding rectangle relative to the AccessibleTabBar
 216             aBounds = AWTRectangle( m_pTabBar->GetPageRect( m_nPageId ) );
 217
 218             // get position of the AccessibleTabBarPageList relative to the AccessibleTabBar
 219             Reference< XAccessible > xParent = getAccessibleParent();
 220             if ( xParent.is() )
 221             {
 222                 Reference< XAccessibleComponent > xParentComponent( xParent->getAccessibleContext(), UNO_QUERY );
 223                 if ( xParentComponent.is() )
 224                 {
 225                     awt::Point aParentLoc = xParentComponent->getLocation();
 226
 227                     // calculate bounding rectangle relative to the AccessibleTabBarPageList
 228                     aBounds.X -= aParentLoc.X;
 229                     aBounds.Y -= aParentLoc.Y;
 230                 }
 231             }
 232         }
 233
 234         return aBounds;
 235     }
 236
 237     // -----------------------------------------------------------------------------
 238     // XInterface
 239     // -----------------------------------------------------------------------------
 240
 241     IMPLEMENT_FORWARD_XINTERFACE2( AccessibleTabBarPage, AccessibleExtendedComponentHelper_BASE, AccessibleTabBarPage_BASE )
 242
 243     // -----------------------------------------------------------------------------
 244     // XTypeProvider
 245     // -----------------------------------------------------------------------------
 246
 247     IMPLEMENT_FORWARD_XTYPEPROVIDER2( AccessibleTabBarPage, AccessibleExtendedComponentHelper_BASE, AccessibleTabBarPage_BASE )
 248
 249     // -----------------------------------------------------------------------------
 250     // XComponent
 251     // -----------------------------------------------------------------------------
 252
 253     void AccessibleTabBarPage::disposing()
 254     {
 255         AccessibleTabBarBase::disposing();
 256         m_sPageText = ::rtl::OUString();
 257     }
 258
 259     // -----------------------------------------------------------------------------
 260     // XServiceInfo
 261     // -----------------------------------------------------------------------------
 262
 263     ::rtl::OUString AccessibleTabBarPage::getImplementationName() throw (RuntimeException)
 264     {
 265         return ::rtl::OUString::createFromAscii( "com.sun.star.comp.svtools.AccessibleTabBarPage" );
 266     }
 267
 268     // -----------------------------------------------------------------------------
 269
 270     sal_Bool AccessibleTabBarPage::supportsService( const ::rtl::OUString& rServiceName ) throw (RuntimeException)
 271     {
 272         Sequence< ::rtl::OUString > aNames( getSupportedServiceNames() );
 273         const ::rtl::OUString* pNames = aNames.getConstArray();
 274         const ::rtl::OUString* pEnd = pNames + aNames.getLength();
 275         for ( ; pNames != pEnd && !pNames->equals( rServiceName ); ++pNames )
 276             ;
 277
 278         return pNames != pEnd;
 279     }
 280
 281     // -----------------------------------------------------------------------------
 282
 283     Sequence< ::rtl::OUString > AccessibleTabBarPage::getSupportedServiceNames() throw (RuntimeException)
 284     {
 285         Sequence< ::rtl::OUString > aNames(1);
 286         aNames[0] = ::rtl::OUString::createFromAscii( "com.sun.star.awt.AccessibleTabBarPage" );
 287         return aNames;
 288     }
 289
 290     // -----------------------------------------------------------------------------
 291     // XAccessible
 292     // -----------------------------------------------------------------------------
 293
 294     Reference< XAccessibleContext > AccessibleTabBarPage::getAccessibleContext(  ) throw (RuntimeException)
 295     {
 296         OExternalLockGuard aGuard( this );
 297
 298         return this;
 299     }
 300
 301     // -----------------------------------------------------------------------------
 302     // XAccessibleContext
 303     // -----------------------------------------------------------------------------
 304
 305     sal_Int32 AccessibleTabBarPage::getAccessibleChildCount() throw (RuntimeException)
 306     {
 307         OExternalLockGuard aGuard( this );
 308
 309         return 0;
 310     }
 311
 312     // -----------------------------------------------------------------------------
 313
 314     Reference< XAccessible > AccessibleTabBarPage::getAccessibleChild( sal_Int32 i ) throw (IndexOutOfBoundsException, RuntimeException)
 315     {
 316         OExternalLockGuard aGuard( this );
 317
 318         if ( i < 0 || i >= getAccessibleChildCount() )
 319             throw IndexOutOfBoundsException();
 320
 321         return Reference< XAccessible >();
 322     }
 323
 324     // -----------------------------------------------------------------------------
 325
 326     Reference< XAccessible > AccessibleTabBarPage::getAccessibleParent(  ) throw (RuntimeException)
 327     {
 328         OExternalLockGuard aGuard( this );
 329
 330         return m_xParent;
 331     }
 332
 333     // -----------------------------------------------------------------------------
 334
 335     sal_Int32 AccessibleTabBarPage::getAccessibleIndexInParent(  ) throw (RuntimeException)
 336     {
 337         OExternalLockGuard aGuard( this );
 338
 339         sal_Int32 nIndexInParent = -1;
 340         if ( m_pTabBar )
 341             nIndexInParent = m_pTabBar->GetPagePos( m_nPageId );
 342
 343         return nIndexInParent;
 344     }
 345
 346     // -----------------------------------------------------------------------------
 347
 348     sal_Int16 AccessibleTabBarPage::getAccessibleRole(  ) throw (RuntimeException)
 349     {
 350         OExternalLockGuard aGuard( this );
 351
 352         return AccessibleRole::PAGE_TAB;
 353     }
 354
 355     // -----------------------------------------------------------------------------
 356
 357     ::rtl::OUString AccessibleTabBarPage::getAccessibleDescription(     ) throw (RuntimeException)
 358     {
 359         OExternalLockGuard aGuard( this );
 360
 361         ::rtl::OUString sDescription;
 362         if ( m_pTabBar )
 363             sDescription = m_pTabBar->GetHelpText( m_nPageId );
 364
 365         return sDescription;
 366     }
 367
 368     // -----------------------------------------------------------------------------
 369
 370     ::rtl::OUString AccessibleTabBarPage::getAccessibleName(  ) throw (RuntimeException)
 371     {
 372         OExternalLockGuard aGuard( this );
 373
 374         return m_sPageText;
 375     }
 376
 377     // -----------------------------------------------------------------------------
 378
 379     Reference< XAccessibleRelationSet > AccessibleTabBarPage::getAccessibleRelationSet(  ) throw (RuntimeException)
 380     {
 381         OExternalLockGuard aGuard( this );
 382
 383         utl::AccessibleRelationSetHelper* pRelationSetHelper = new utl::AccessibleRelationSetHelper;
 384         Reference< XAccessibleRelationSet > xSet = pRelationSetHelper;
 385         return xSet;
 386     }
 387
 388     // -----------------------------------------------------------------------------
 389
 390     Reference< XAccessibleStateSet > AccessibleTabBarPage::getAccessibleStateSet(  ) throw (RuntimeException)
 391     {
 392         OExternalLockGuard aGuard( this );
 393
 394         utl::AccessibleStateSetHelper* pStateSetHelper = new utl::AccessibleStateSetHelper;
 395         Reference< XAccessibleStateSet > xSet = pStateSetHelper;
 396
 397         if ( !rBHelper.bDisposed && !rBHelper.bInDispose )
 398         {
 399             FillAccessibleStateSet( *pStateSetHelper );
 400         }
 401         else
 402         {
 403             pStateSetHelper->AddState( AccessibleStateType::DEFUNC );
 404         }
 405
 406         return xSet;
 407     }
 408
 409     // -----------------------------------------------------------------------------
 410
 411     Locale AccessibleTabBarPage::getLocale(  ) throw (IllegalAccessibleComponentStateException, RuntimeException)
 412     {
 413         OExternalLockGuard aGuard( this );
 414
 415         return Application::GetSettings().GetLocale();
 416     }
 417
 418     // -----------------------------------------------------------------------------
 419     // XAccessibleComponent
 420     // -----------------------------------------------------------------------------
 421
 422     Reference< XAccessible > AccessibleTabBarPage::getAccessibleAtPoint( const awt::Point& ) throw (RuntimeException)
 423     {
 424         OExternalLockGuard aGuard( this );
 425
 426         return Reference< XAccessible >();
 427     }
 428
 429     // -----------------------------------------------------------------------------
 430
 431     void AccessibleTabBarPage::grabFocus(  ) throw (RuntimeException)
 432     {
 433         // no focus
 434     }
 435
 436     // -----------------------------------------------------------------------------
 437
 438     sal_Int32 AccessibleTabBarPage::getForeground(      ) throw (RuntimeException)
 439     {
 440         OExternalLockGuard aGuard( this );
 441
 442         sal_Int32 nColor = 0;
 443         Reference< XAccessible > xParent = getAccessibleParent();
 444         if ( xParent.is() )
 445         {
 446             Reference< XAccessibleComponent > xParentComp( xParent->getAccessibleContext(), UNO_QUERY );
 447             if ( xParentComp.is() )
 448                 nColor = xParentComp->getForeground();
 449         }
 450
 451         return nColor;
 452     }
 453
 454     // -----------------------------------------------------------------------------
 455
 456     sal_Int32 AccessibleTabBarPage::getBackground(  ) throw (RuntimeException)
 457     {
 458         OExternalLockGuard aGuard( this );
 459
 460         sal_Int32 nColor = 0;
 461         Reference< XAccessible > xParent = getAccessibleParent();
 462         if ( xParent.is() )
 463         {
 464             Reference< XAccessibleComponent > xParentComp( xParent->getAccessibleContext(), UNO_QUERY );
 465             if ( xParentComp.is() )
 466                 nColor = xParentComp->getBackground();
 467         }
 468
 469         return nColor;
 470     }
 471
 472     // -----------------------------------------------------------------------------
 473     // XAccessibleExtendedComponent
 474     // -----------------------------------------------------------------------------
 475
 476     Reference< awt::XFont > AccessibleTabBarPage::getFont(  ) throw (RuntimeException)
 477     {
 478         OExternalLockGuard aGuard( this );
 479
 480         Reference< awt::XFont > xFont;
 481         Reference< XAccessible > xParent = getAccessibleParent();
 482         if ( xParent.is() )
 483         {
 484             Reference< XAccessibleExtendedComponent > xParentComp( xParent->getAccessibleContext(), UNO_QUERY );
 485             if ( xParentComp.is() )
 486                 xFont = xParentComp->getFont();
 487         }
 488
 489         return xFont;
 490     }
 491
 492     // -----------------------------------------------------------------------------
 493
 494     ::rtl::OUString AccessibleTabBarPage::getTitledBorderText(  ) throw (RuntimeException)
 495     {
 496         OExternalLockGuard aGuard( this );
 497
 498         return m_sPageText;
 499     }
 500
 501     // -----------------------------------------------------------------------------
 502
 503     ::rtl::OUString AccessibleTabBarPage::getToolTipText(  ) throw (RuntimeException)
 504     {
 505         OExternalLockGuard aGuard( this );
 506
 507         return ::rtl::OUString();
 508     }
 509
 510     // -----------------------------------------------------------------------------
 511
 512 //.........................................................................
 513 }       // namespace accessibility
 514 //.........................................................................