accessibility/source/standard/vclxaccessiblestatusbar.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: vclxaccessiblestatusbar.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/standard/vclxaccessiblestatusbar.hxx>
  34 #include <accessibility/standard/vclxaccessiblestatusbaritem.hxx>
  35 #include <toolkit/helper/convert.hxx>
  36 #include <com/sun/star/accessibility/AccessibleEventId.hpp>
  37 #include <vcl/status.hxx>
  38
  39
  40 using namespace ::com::sun::star;
  41 using namespace ::com::sun::star::uno;
  42 using namespace ::com::sun::star::lang;
  43 using namespace ::com::sun::star::accessibility;
  44 using namespace ::comphelper;
  45
  46
  47 //      ----------------------------------------------------
  48 //      class VCLXAccessibleStatusBar
  49 //      ----------------------------------------------------
  50
  51 VCLXAccessibleStatusBar::VCLXAccessibleStatusBar( VCLXWindow* pVCLXWindow )
  52     :VCLXAccessibleComponent( pVCLXWindow )
  53 {
  54     m_pStatusBar = static_cast< StatusBar* >( GetWindow() );
  55
  56     if ( m_pStatusBar )
  57         m_aAccessibleChildren.assign( m_pStatusBar->GetItemCount(), Reference< XAccessible >() );
  58 }
  59
  60 // -----------------------------------------------------------------------------
  61
  62 VCLXAccessibleStatusBar::~VCLXAccessibleStatusBar()
  63 {
  64 }
  65
  66 // -----------------------------------------------------------------------------
  67
  68 void VCLXAccessibleStatusBar::UpdateShowing( sal_Int32 i, sal_Bool bShowing )
  69 {
  70     if ( i >= 0 && i < (sal_Int32)m_aAccessibleChildren.size() )
  71     {
  72         Reference< XAccessible > xChild( m_aAccessibleChildren[i] );
  73         if ( xChild.is() )
  74         {
  75             VCLXAccessibleStatusBarItem* pVCLXAccessibleStatusBarItem = static_cast< VCLXAccessibleStatusBarItem* >( xChild.get() );
  76             if ( pVCLXAccessibleStatusBarItem )
  77                 pVCLXAccessibleStatusBarItem->SetShowing( bShowing );
  78         }
  79     }
  80 }
  81
  82 // -----------------------------------------------------------------------------
  83
  84 void VCLXAccessibleStatusBar::UpdateItemName( sal_Int32 i )
  85 {
  86     if ( i >= 0 && i < (sal_Int32)m_aAccessibleChildren.size() )
  87     {
  88         Reference< XAccessible > xChild( m_aAccessibleChildren[i] );
  89         if ( xChild.is() )
  90         {
  91             VCLXAccessibleStatusBarItem* pVCLXAccessibleStatusBarItem = static_cast< VCLXAccessibleStatusBarItem* >( xChild.get() );
  92             if ( pVCLXAccessibleStatusBarItem )
  93             {
  94                 ::rtl::OUString sItemName = pVCLXAccessibleStatusBarItem->GetItemName();
  95                 pVCLXAccessibleStatusBarItem->SetItemName( sItemName );
  96             }
  97         }
  98     }
  99 }
 100
 101 // -----------------------------------------------------------------------------
 102
 103 void VCLXAccessibleStatusBar::UpdateItemText( sal_Int32 i )
 104 {
 105     if ( i >= 0 && i < (sal_Int32)m_aAccessibleChildren.size() )
 106     {
 107         Reference< XAccessible > xChild( m_aAccessibleChildren[i] );
 108         if ( xChild.is() )
 109         {
 110             VCLXAccessibleStatusBarItem* pVCLXAccessibleStatusBarItem = static_cast< VCLXAccessibleStatusBarItem* >( xChild.get() );
 111             if ( pVCLXAccessibleStatusBarItem )
 112             {
 113                 ::rtl::OUString sItemText = pVCLXAccessibleStatusBarItem->GetItemText();
 114                 pVCLXAccessibleStatusBarItem->SetItemText( sItemText );
 115             }
 116         }
 117     }
 118 }
 119
 120 // -----------------------------------------------------------------------------
 121
 122 void VCLXAccessibleStatusBar::InsertChild( sal_Int32 i )
 123 {
 124     if ( i >= 0 && i <= (sal_Int32)m_aAccessibleChildren.size() )
 125     {
 126         // insert entry in child list
 127         m_aAccessibleChildren.insert( m_aAccessibleChildren.begin() + i, Reference< XAccessible >() );
 128
 129         // send accessible child event
 130         Reference< XAccessible > xChild( getAccessibleChild( i ) );
 131         if ( xChild.is() )
 132         {
 133             Any aOldValue, aNewValue;
 134             aNewValue <<= xChild;
 135             NotifyAccessibleEvent( AccessibleEventId::CHILD, aOldValue, aNewValue );
 136         }
 137     }
 138 }
 139
 140 // -----------------------------------------------------------------------------
 141
 142 void VCLXAccessibleStatusBar::RemoveChild( sal_Int32 i )
 143 {
 144     if ( i >= 0 && i < (sal_Int32)m_aAccessibleChildren.size() )
 145     {
 146         // get the accessible of the removed page
 147         Reference< XAccessible > xChild( m_aAccessibleChildren[i] );
 148
 149         // remove entry in child list
 150         m_aAccessibleChildren.erase( m_aAccessibleChildren.begin() + i );
 151
 152         // send accessible child event
 153         if ( xChild.is() )
 154         {
 155             Any aOldValue, aNewValue;
 156             aOldValue <<= xChild;
 157             NotifyAccessibleEvent( AccessibleEventId::CHILD, aOldValue, aNewValue );
 158
 159             Reference< XComponent > xComponent( xChild, UNO_QUERY );
 160             if ( xComponent.is() )
 161                 xComponent->dispose();
 162         }
 163     }
 164 }
 165
 166 // -----------------------------------------------------------------------------
 167
 168 void VCLXAccessibleStatusBar::ProcessWindowEvent( const VclWindowEvent& rVclWindowEvent )
 169 {
 170     switch ( rVclWindowEvent.GetId() )
 171     {
 172         case VCLEVENT_STATUSBAR_ITEMADDED:
 173         {
 174             if ( m_pStatusBar )
 175             {
 176                 sal_uInt16 nItemId = (sal_uInt16)(sal_IntPtr) rVclWindowEvent.GetData();
 177                 sal_uInt16 nItemPos = m_pStatusBar->GetItemPos( nItemId );
 178                 InsertChild( nItemPos );
 179             }
 180         }
 181         break;
 182         case VCLEVENT_STATUSBAR_ITEMREMOVED:
 183         {
 184             if ( m_pStatusBar )
 185             {
 186                 sal_uInt16 nItemId = (sal_uInt16)(sal_IntPtr) rVclWindowEvent.GetData();
 187                 for ( sal_Int32 i = 0, nCount = getAccessibleChildCount(); i < nCount; ++i )
 188                 {
 189                     Reference< XAccessible > xChild( getAccessibleChild( i ) );
 190                     if ( xChild.is() )
 191                     {
 192                         VCLXAccessibleStatusBarItem* pVCLXAccessibleStatusBarItem = static_cast< VCLXAccessibleStatusBarItem* >( xChild.get() );
 193                         if ( pVCLXAccessibleStatusBarItem && pVCLXAccessibleStatusBarItem->GetItemId() == nItemId )
 194                         {
 195                             RemoveChild( i );
 196                             break;
 197                         }
 198                     }
 199                 }
 200             }
 201         }
 202         break;
 203         case VCLEVENT_STATUSBAR_ALLITEMSREMOVED:
 204         {
 205             for ( sal_Int32 i = m_aAccessibleChildren.size() - 1; i >= 0; --i )
 206                 RemoveChild( i );
 207         }
 208         break;
 209         case VCLEVENT_STATUSBAR_SHOWITEM:
 210         case VCLEVENT_STATUSBAR_HIDEITEM:
 211         {
 212             if ( m_pStatusBar )
 213             {
 214                 sal_uInt16 nItemId = (sal_uInt16)(sal_IntPtr) rVclWindowEvent.GetData();
 215                 sal_uInt16 nItemPos = m_pStatusBar->GetItemPos( nItemId );
 216                 UpdateShowing( nItemPos, rVclWindowEvent.GetId() == VCLEVENT_STATUSBAR_SHOWITEM );
 217             }
 218         }
 219         break;
 220         case VCLEVENT_STATUSBAR_SHOWALLITEMS:
 221         case VCLEVENT_STATUSBAR_HIDEALLITEMS:
 222         {
 223             for ( sal_uInt32 i = 0; i < m_aAccessibleChildren.size(); ++i )
 224                 UpdateShowing( i, rVclWindowEvent.GetId() == VCLEVENT_STATUSBAR_SHOWALLITEMS );
 225         }
 226         break;
 227         case VCLEVENT_STATUSBAR_NAMECHANGED:
 228         {
 229             if ( m_pStatusBar )
 230             {
 231                 sal_uInt16 nItemId = (sal_uInt16)(sal_IntPtr) rVclWindowEvent.GetData();
 232                 sal_uInt16 nItemPos = m_pStatusBar->GetItemPos( nItemId );
 233                 UpdateItemName( nItemPos );
 234             }
 235         }
 236         break;
 237         case VCLEVENT_STATUSBAR_DRAWITEM:
 238         {
 239             if ( m_pStatusBar )
 240             {
 241                 sal_uInt16 nItemId = (sal_uInt16)(sal_IntPtr) rVclWindowEvent.GetData();
 242                 sal_uInt16 nItemPos = m_pStatusBar->GetItemPos( nItemId );
 243                 UpdateItemText( nItemPos );
 244             }
 245         }
 246         break;
 247         case VCLEVENT_OBJECT_DYING:
 248         {
 249             if ( m_pStatusBar )
 250             {
 251                 m_pStatusBar = NULL;
 252
 253                 // dispose all children
 254                 for ( sal_uInt32 i = 0; i < m_aAccessibleChildren.size(); ++i )
 255                 {
 256                     Reference< XComponent > xComponent( m_aAccessibleChildren[i], UNO_QUERY );
 257                     if ( xComponent.is() )
 258                         xComponent->dispose();
 259                 }
 260                 m_aAccessibleChildren.clear();
 261             }
 262
 263             VCLXAccessibleComponent::ProcessWindowEvent( rVclWindowEvent );
 264         }
 265         break;
 266         default:
 267             VCLXAccessibleComponent::ProcessWindowEvent( rVclWindowEvent );
 268    }
 269 }
 270
 271 // -----------------------------------------------------------------------------
 272 // XComponent
 273 // -----------------------------------------------------------------------------
 274
 275 void VCLXAccessibleStatusBar::disposing()
 276 {
 277     VCLXAccessibleComponent::disposing();
 278
 279     if ( m_pStatusBar )
 280     {
 281         m_pStatusBar = NULL;
 282
 283         // dispose all children
 284         for ( sal_uInt32 i = 0; i < m_aAccessibleChildren.size(); ++i )
 285         {
 286             Reference< XComponent > xComponent( m_aAccessibleChildren[i], UNO_QUERY );
 287             if ( xComponent.is() )
 288                 xComponent->dispose();
 289         }
 290         m_aAccessibleChildren.clear();
 291     }
 292 }
 293
 294 // -----------------------------------------------------------------------------
 295 // XServiceInfo
 296 // -----------------------------------------------------------------------------
 297
 298 ::rtl::OUString VCLXAccessibleStatusBar::getImplementationName() throw (RuntimeException)
 299 {
 300     return ::rtl::OUString::createFromAscii( "com.sun.star.comp.toolkit.AccessibleStatusBar" );
 301 }
 302
 303 // -----------------------------------------------------------------------------
 304
 305 Sequence< ::rtl::OUString > VCLXAccessibleStatusBar::getSupportedServiceNames() throw (RuntimeException)
 306 {
 307     Sequence< ::rtl::OUString > aNames(1);
 308     aNames[0] = ::rtl::OUString::createFromAscii( "com.sun.star.awt.AccessibleStatusBar" );
 309     return aNames;
 310 }
 311
 312 // -----------------------------------------------------------------------------
 313 // XAccessibleContext
 314 // -----------------------------------------------------------------------------
 315
 316 sal_Int32 VCLXAccessibleStatusBar::getAccessibleChildCount() throw (RuntimeException)
 317 {
 318     OExternalLockGuard aGuard( this );
 319
 320     return m_aAccessibleChildren.size();
 321 }
 322
 323 // -----------------------------------------------------------------------------
 324
 325 Reference< XAccessible > VCLXAccessibleStatusBar::getAccessibleChild( sal_Int32 i ) throw (IndexOutOfBoundsException, RuntimeException)
 326 {
 327     OExternalLockGuard aGuard( this );
 328
 329     if ( i < 0 || i >= getAccessibleChildCount() )
 330         throw IndexOutOfBoundsException();
 331
 332     Reference< XAccessible > xChild = m_aAccessibleChildren[i];
 333     if ( !xChild.is() )
 334     {
 335         if ( m_pStatusBar )
 336         {
 337             sal_uInt16 nItemId = m_pStatusBar->GetItemId( (USHORT)i );
 338
 339             xChild = new VCLXAccessibleStatusBarItem( m_pStatusBar, nItemId );
 340
 341             // insert into status bar item list
 342             m_aAccessibleChildren[i] = xChild;
 343         }
 344     }
 345
 346     return xChild;
 347 }
 348
 349 // -----------------------------------------------------------------------------
 350 // XAccessibleComponent
 351 // -----------------------------------------------------------------------------
 352
 353 Reference< XAccessible > VCLXAccessibleStatusBar::getAccessibleAtPoint( const awt::Point& rPoint ) throw (RuntimeException)
 354 {
 355     OExternalLockGuard aGuard( this );
 356
 357     Reference< XAccessible > xChild;
 358     if ( m_pStatusBar )
 359     {
 360         sal_uInt16 nItemId = m_pStatusBar->GetItemId( VCLPoint( rPoint ) );
 361         sal_Int32 nItemPos = m_pStatusBar->GetItemPos( nItemId );
 362         if ( nItemPos >= 0 && nItemPos < (sal_Int32)m_aAccessibleChildren.size() )
 363             xChild = getAccessibleChild( nItemPos );
 364     }
 365
 366     return xChild;
 367 }
 368
 369 // -----------------------------------------------------------------------------