accessibility/source/extended/AccessibleToolPanelDeckTabBarItem.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 "accessibility/extended/AccessibleToolPanelDeckTabBarItem.hxx"
  21
  22 #include <com/sun/star/accessibility/AccessibleRole.hpp>
  23 #include <com/sun/star/accessibility/AccessibleStateType.hpp>
  24 #include <com/sun/star/accessibility/AccessibleEventId.hpp>
  25 #include <com/sun/star/lang/DisposedException.hpp>
  26
  27 #include <svtools/toolpanel/toolpaneldeck.hxx>
  28 #include <svtools/toolpanel/paneltabbar.hxx>
  29 #include <unotools/accessiblestatesethelper.hxx>
  30 #include <unotools/accessiblerelationsethelper.hxx>
  31 #include <toolkit/helper/externallock.hxx>
  32 #include <tools/diagnose_ex.h>
  33 #include <vcl/svapp.hxx>
  34 #include <osl/mutex.hxx>
  35
  36 namespace accessibility
  37 {
  38     typedef ::com::sun::star::awt::Rectangle    UnoRectangle;
  39     typedef ::com::sun::star::awt::Point        UnoPoint;
  40
  41     using ::com::sun::star::uno::Reference;
  42     using ::com::sun::star::uno::XInterface;
  43     using ::com::sun::star::uno::UNO_QUERY;
  44     using ::com::sun::star::uno::UNO_QUERY_THROW;
  45     using ::com::sun::star::uno::UNO_SET_THROW;
  46     using ::com::sun::star::uno::Exception;
  47     using ::com::sun::star::uno::RuntimeException;
  48     using ::com::sun::star::uno::Any;
  49     using ::com::sun::star::uno::makeAny;
  50     using ::com::sun::star::uno::Sequence;
  51     using ::com::sun::star::uno::Type;
  52     using ::com::sun::star::accessibility::XAccessible;
  53     using ::com::sun::star::lang::DisposedException;
  54     using ::com::sun::star::lang::IndexOutOfBoundsException;
  55     using ::com::sun::star::accessibility::XAccessibleRelationSet;
  56     using ::com::sun::star::accessibility::XAccessibleStateSet;
  57     using ::com::sun::star::accessibility::XAccessibleComponent;
  58     using ::com::sun::star::accessibility::XAccessibleExtendedComponent;
  59     using ::com::sun::star::awt::XFont;
  60
  61     namespace AccessibleRole = ::com::sun::star::accessibility::AccessibleRole;
  62     namespace AccessibleStateType = ::com::sun::star::accessibility::AccessibleStateType;
  63     namespace AccessibleEventId = ::com::sun::star::accessibility::AccessibleEventId;
  64
  65     // AccessibleToolPanelDeckTabBarItem_Impl
  66     class AccessibleToolPanelDeckTabBarItem_Impl : public ::svt::IToolPanelDeckListener
  67     {
  68     public:
  69         AccessibleToolPanelDeckTabBarItem_Impl(
  70             AccessibleToolPanelDeckTabBarItem& i_rAntiImpl,
  71             const Reference< XAccessible >& i_rAccessibleParent,
  72             ::svt::IToolPanelDeck& i_rPanelDeck,
  73             ::svt::PanelTabBar& i_rTabBar,
  74             const size_t i_nItemPos
  75         );
  76         virtual ~AccessibleToolPanelDeckTabBarItem_Impl();
  77
  78         ::svt::PanelTabBar* getTabBar() const { return m_pTabBar; }
  79
  80         // IToolPanelDeckListener
  81         virtual void PanelInserted( const ::svt::PToolPanel& i_pPanel, const size_t i_nPosition ) SAL_OVERRIDE;
  82         virtual void PanelRemoved( const size_t i_nPosition ) SAL_OVERRIDE;
  83         virtual void ActivePanelChanged( const ::boost::optional< size_t >& i_rOldActive, const ::boost::optional< size_t >& i_rNewActive ) SAL_OVERRIDE;
  84         virtual void LayouterChanged( const ::svt::PDeckLayouter& i_rNewLayouter ) SAL_OVERRIDE;
  85         virtual void Dying() SAL_OVERRIDE;
  86
  87     public:
  88         bool    isDisposed() const { return m_pPanelDeck == NULL; }
  89         void    checkDisposed() const;
  90         void    dispose();
  91
  92         const Reference< XAccessible >&
  93                 getAccessibleParent() const { return m_xAccessibleParent; }
  94         size_t  getItemPos() const { return m_nItemPos; }
  95
  96         Reference< XAccessibleComponent >   getParentAccessibleComponent() const;
  97         ::svt::IToolPanelDeck*              getPanelDeck() const { return m_pPanelDeck; }
  98         OUString                            getPanelDisplayName();
  99
 100     private:
 101         void impl_notifyBoundRectChanges();
 102         void impl_notifyStateChange( const sal_Int16 i_nLostState, const sal_Int16 i_nGainedState );
 103
 104     private:
 105         AccessibleToolPanelDeckTabBarItem&  m_rAntiImpl;
 106         Reference< XAccessible >            m_xAccessibleParent;
 107         ::svt::IToolPanelDeck*              m_pPanelDeck;
 108         VclPtr< ::svt::PanelTabBar >        m_pTabBar;
 109         size_t                              m_nItemPos;
 110     };
 111
 112     // AccessibleToolPanelDeckTabBarItem_Impl
 113     AccessibleToolPanelDeckTabBarItem_Impl::AccessibleToolPanelDeckTabBarItem_Impl( AccessibleToolPanelDeckTabBarItem& i_rAntiImpl,
 114             const Reference< XAccessible >& i_rAccessibleParent, ::svt::IToolPanelDeck& i_rPanelDeck, ::svt::PanelTabBar& i_rTabBar,
 115             const size_t i_nItemPos )
 116         :m_rAntiImpl( i_rAntiImpl )
 117         ,m_xAccessibleParent( i_rAccessibleParent )
 118         ,m_pPanelDeck( &i_rPanelDeck )
 119         ,m_pTabBar( &i_rTabBar )
 120         ,m_nItemPos( i_nItemPos )
 121     {
 122         m_pPanelDeck->AddListener( *this );
 123     }
 124
 125     AccessibleToolPanelDeckTabBarItem_Impl::~AccessibleToolPanelDeckTabBarItem_Impl()
 126     {
 127     }
 128
 129     void AccessibleToolPanelDeckTabBarItem_Impl::checkDisposed() const
 130     {
 131         if ( isDisposed() )
 132             throw DisposedException( OUString(), *&m_rAntiImpl );
 133     }
 134
 135     void AccessibleToolPanelDeckTabBarItem_Impl::dispose()
 136     {
 137         ENSURE_OR_RETURN_VOID( !isDisposed(), "AccessibleToolPanelDeckTabBarItem_Impl::dispose: disposed twice!" );
 138
 139         m_xAccessibleParent.clear();
 140         m_pPanelDeck->RemoveListener( *this );
 141         m_pPanelDeck = NULL;
 142         m_pTabBar.clear();
 143     }
 144
 145     Reference< XAccessibleComponent > AccessibleToolPanelDeckTabBarItem_Impl::getParentAccessibleComponent() const
 146     {
 147         Reference< XAccessible > xAccessibleParent( m_rAntiImpl.getAccessibleParent(), UNO_QUERY_THROW );
 148         return Reference< XAccessibleComponent >( xAccessibleParent->getAccessibleContext(), UNO_QUERY );
 149     }
 150
 151     OUString AccessibleToolPanelDeckTabBarItem_Impl::getPanelDisplayName()
 152     {
 153         const ::svt::PToolPanel pPanel( m_pPanelDeck->GetPanel( getItemPos() ) );
 154         if ( pPanel.get() == NULL )
 155             throw DisposedException();
 156         return pPanel->GetDisplayName();
 157     }
 158
 159     void AccessibleToolPanelDeckTabBarItem_Impl::impl_notifyBoundRectChanges()
 160     {
 161         m_rAntiImpl.NotifyAccessibleEvent( AccessibleEventId::BOUNDRECT_CHANGED, Any(), Any() );
 162     }
 163
 164     void AccessibleToolPanelDeckTabBarItem_Impl::impl_notifyStateChange( const sal_Int16 i_nLostState, const sal_Int16 i_nGainedState )
 165     {
 166         m_rAntiImpl.NotifyAccessibleEvent( AccessibleEventId::STATE_CHANGED,
 167             i_nLostState > -1 ? makeAny( i_nLostState ) : Any(),
 168             i_nGainedState > -1 ? makeAny( i_nGainedState ) : Any()
 169         );
 170     }
 171
 172     void AccessibleToolPanelDeckTabBarItem_Impl::PanelInserted( const ::svt::PToolPanel& i_pPanel, const size_t i_nPosition )
 173     {
 174         (void)i_pPanel;
 175         if ( i_nPosition <= m_nItemPos )
 176             ++m_nItemPos;
 177         impl_notifyBoundRectChanges();
 178     }
 179
 180     void AccessibleToolPanelDeckTabBarItem_Impl::PanelRemoved( const size_t i_nPosition )
 181     {
 182         if ( i_nPosition == m_nItemPos )
 183         {
 184             m_rAntiImpl.dispose();
 185         }
 186         else if ( i_nPosition < m_nItemPos )
 187         {
 188             --m_nItemPos;
 189             impl_notifyBoundRectChanges();
 190         }
 191     }
 192
 193     void AccessibleToolPanelDeckTabBarItem_Impl::ActivePanelChanged( const ::boost::optional< size_t >& i_rOldActive, const ::boost::optional< size_t >& i_rNewActive )
 194     {
 195         if ( m_nItemPos == i_rOldActive )
 196         {
 197             impl_notifyStateChange( AccessibleStateType::ACTIVE, -1 );
 198             impl_notifyStateChange( AccessibleStateType::SELECTED, -1 );
 199         }
 200         else if ( m_nItemPos == i_rNewActive )
 201         {
 202             impl_notifyStateChange( -1, AccessibleStateType::ACTIVE );
 203             impl_notifyStateChange( -1, AccessibleStateType::SELECTED );
 204         }
 205     }
 206
 207     void AccessibleToolPanelDeckTabBarItem_Impl::LayouterChanged( const ::svt::PDeckLayouter& i_rNewLayouter )
 208     {
 209         (void)i_rNewLayouter;
 210         // if the tool panel deck has a new layouter, then the old layouter, and thus all items it was
 211         // responsible for, died. So do we.
 212         dispose();
 213     }
 214
 215     void AccessibleToolPanelDeckTabBarItem_Impl::Dying()
 216     {
 217         // if the tool panel deck is dying, then its layouter dies, so should we.
 218         dispose();
 219     }
 220
 221     class ItemMethodGuard
 222     {
 223     public:
 224         explicit ItemMethodGuard( AccessibleToolPanelDeckTabBarItem_Impl& i_rImpl )
 225             :m_aGuard()
 226         {
 227             i_rImpl.checkDisposed();
 228         }
 229         ~ItemMethodGuard()
 230         {
 231         }
 232
 233     private:
 234         SolarMutexGuard  m_aGuard;
 235     };
 236
 237     AccessibleToolPanelDeckTabBarItem::AccessibleToolPanelDeckTabBarItem( const Reference< XAccessible >& i_rAccessibleParent,
 238             ::svt::IToolPanelDeck& i_rPanelDeck, ::svt::PanelTabBar& i_rTabBar, const size_t i_nItemPos )
 239         : ::comphelper::OAccessibleExtendedComponentHelper(
 240                 new VCLExternalSolarLock)
 241         , m_xImpl(new AccessibleToolPanelDeckTabBarItem_Impl(*this,
 242                 i_rAccessibleParent, i_rPanelDeck, i_rTabBar, i_nItemPos))
 243     {
 244     }
 245
 246     AccessibleToolPanelDeckTabBarItem::~AccessibleToolPanelDeckTabBarItem()
 247     {
 248     }
 249
 250     sal_Int32 SAL_CALL AccessibleToolPanelDeckTabBarItem::getAccessibleChildCount(  ) throw (RuntimeException, std::exception)
 251     {
 252         return 0;
 253     }
 254
 255     Reference< XAccessible > SAL_CALL AccessibleToolPanelDeckTabBarItem::getAccessibleChild( sal_Int32 i ) throw (IndexOutOfBoundsException, RuntimeException, std::exception)
 256     {
 257         (void)i;
 258         throw IndexOutOfBoundsException( OUString(), *this );
 259     }
 260
 261     Reference< XAccessible > SAL_CALL AccessibleToolPanelDeckTabBarItem::getAccessibleParent(  ) throw (RuntimeException, std::exception)
 262     {
 263         ItemMethodGuard aGuard( *m_xImpl );
 264         return m_xImpl->getAccessibleParent();
 265     }
 266
 267     sal_Int16 SAL_CALL AccessibleToolPanelDeckTabBarItem::getAccessibleRole(  ) throw (RuntimeException, std::exception)
 268     {
 269         return AccessibleRole::PAGE_TAB;
 270     }
 271
 272     OUString SAL_CALL AccessibleToolPanelDeckTabBarItem::getAccessibleDescription(  ) throw (RuntimeException, std::exception)
 273     {
 274         ItemMethodGuard aGuard( *m_xImpl );
 275         return m_xImpl->getPanelDisplayName();
 276     }
 277
 278     OUString SAL_CALL AccessibleToolPanelDeckTabBarItem::getAccessibleName(  ) throw (RuntimeException, std::exception)
 279     {
 280         ItemMethodGuard aGuard( *m_xImpl );
 281         return m_xImpl->getPanelDisplayName();
 282     }
 283
 284     Reference< XAccessibleRelationSet > SAL_CALL AccessibleToolPanelDeckTabBarItem::getAccessibleRelationSet(  ) throw (RuntimeException, std::exception)
 285     {
 286         ItemMethodGuard aGuard( *m_xImpl );
 287         ::utl::AccessibleRelationSetHelper* pRelationSet = new utl::AccessibleRelationSetHelper;
 288         return pRelationSet;
 289     }
 290
 291     Reference< XAccessibleStateSet > SAL_CALL AccessibleToolPanelDeckTabBarItem::getAccessibleStateSet(  ) throw (RuntimeException, std::exception)
 292     {
 293         ItemMethodGuard aGuard( *m_xImpl );
 294
 295         ::utl::AccessibleStateSetHelper* pStateSet( new ::utl::AccessibleStateSetHelper );
 296         pStateSet->AddState( AccessibleStateType::FOCUSABLE );
 297         pStateSet->AddState( AccessibleStateType::SELECTABLE );
 298         pStateSet->AddState( AccessibleStateType::ICONIFIED );
 299
 300         if ( m_xImpl->getItemPos() == m_xImpl->getPanelDeck()->GetActivePanel() )
 301         {
 302             pStateSet->AddState( AccessibleStateType::ACTIVE );
 303             pStateSet->AddState( AccessibleStateType::SELECTED );
 304         }
 305
 306         if ( m_xImpl->getItemPos() == m_xImpl->getTabBar()->GetFocusedPanelItem() )
 307             pStateSet->AddState( AccessibleStateType::FOCUSED );
 308
 309         if ( m_xImpl->getTabBar()->IsEnabled() )
 310             pStateSet->AddState( AccessibleStateType::ENABLED );
 311
 312         if ( m_xImpl->getTabBar()->IsVisible() )
 313         {
 314             pStateSet->AddState( AccessibleStateType::SHOWING );
 315             pStateSet->AddState( AccessibleStateType::VISIBLE );
 316         }
 317
 318         return pStateSet;
 319     }
 320
 321     Reference< XAccessible > SAL_CALL AccessibleToolPanelDeckTabBarItem::getAccessibleAtPoint( const UnoPoint& i_rLocation ) throw (RuntimeException, std::exception)
 322     {
 323         ItemMethodGuard aGuard( *m_xImpl );
 324         // we do not have children ...
 325         (void)i_rLocation;
 326         return NULL;
 327     }
 328
 329     void SAL_CALL AccessibleToolPanelDeckTabBarItem::grabFocus(  ) throw (RuntimeException, std::exception)
 330     {
 331         ItemMethodGuard aGuard( *m_xImpl );
 332         m_xImpl->getTabBar()->FocusPanelItem( m_xImpl->getItemPos() );
 333     }
 334
 335     ::sal_Int32 SAL_CALL AccessibleToolPanelDeckTabBarItem::getForeground(  ) throw (RuntimeException, std::exception)
 336     {
 337         ItemMethodGuard aGuard( *m_xImpl );
 338         Reference< XAccessibleComponent > xParentComponent( m_xImpl->getParentAccessibleComponent(), UNO_SET_THROW );
 339         return xParentComponent->getForeground();
 340     }
 341
 342     ::sal_Int32 SAL_CALL AccessibleToolPanelDeckTabBarItem::getBackground(  ) throw (RuntimeException, std::exception)
 343     {
 344         ItemMethodGuard aGuard( *m_xImpl );
 345         Reference< XAccessibleComponent > xParentComponent( m_xImpl->getParentAccessibleComponent(), UNO_SET_THROW );
 346         return xParentComponent->getBackground();
 347     }
 348
 349     Reference< XFont > SAL_CALL AccessibleToolPanelDeckTabBarItem::getFont(  ) throw (RuntimeException, std::exception)
 350     {
 351         ItemMethodGuard aGuard( *m_xImpl );
 352         Reference< XAccessibleExtendedComponent > xParentComponent( m_xImpl->getParentAccessibleComponent(), UNO_QUERY_THROW );
 353         // TODO: strictly, this is not correct: The TabBar implementation of the TabLayouter might use
 354         // a different font ...
 355         return xParentComponent->getFont();
 356     }
 357
 358     OUString SAL_CALL AccessibleToolPanelDeckTabBarItem::getTitledBorderText(  ) throw (RuntimeException, std::exception)
 359     {
 360         ItemMethodGuard aGuard( *m_xImpl );
 361         // no support
 362         return OUString();
 363     }
 364
 365     OUString SAL_CALL AccessibleToolPanelDeckTabBarItem::getToolTipText(  ) throw (RuntimeException, std::exception)
 366     {
 367         ItemMethodGuard aGuard( *m_xImpl );
 368         return m_xImpl->getPanelDisplayName();
 369     }
 370
 371     UnoRectangle AccessibleToolPanelDeckTabBarItem::implGetBounds() throw (RuntimeException)
 372     {
 373         ItemMethodGuard aGuard( *m_xImpl );
 374
 375         const ::Rectangle aItemScreenRect( m_xImpl->getTabBar()->GetItemScreenRect( m_xImpl->getItemPos() ) );
 376
 377         Reference< XAccessibleComponent > xParentComponent( m_xImpl->getParentAccessibleComponent(), UNO_SET_THROW );
 378         const UnoPoint aParentLocation( xParentComponent->getLocationOnScreen() );
 379         return UnoRectangle(
 380             aItemScreenRect.Left() - aParentLocation.X,
 381             aItemScreenRect.Top() - aParentLocation.Y,
 382             aItemScreenRect.GetWidth(),
 383             aItemScreenRect.GetHeight()
 384         );
 385     }
 386
 387     void SAL_CALL AccessibleToolPanelDeckTabBarItem::disposing()
 388     {
 389         ItemMethodGuard aGuard( *m_xImpl );
 390         m_xImpl->dispose();
 391     }
 392 } // namespace accessibility
 393
 394 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */