accessibility/source/extended/accessiblelistbox.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/accessiblelistbox.hxx>
  21 #include <accessibility/extended/accessiblelistboxentry.hxx>
  22 #include <svtools/treelistbox.hxx>
  23 #include <com/sun/star/awt/Point.hpp>
  24 #include <com/sun/star/awt/Rectangle.hpp>
  25 #include <com/sun/star/awt/Size.hpp>
  26 #include <com/sun/star/accessibility/AccessibleEventId.hpp>
  27 #include <com/sun/star/accessibility/AccessibleRole.hpp>
  28 #include <com/sun/star/accessibility/AccessibleStateType.hpp>
  29 #include <cppuhelper/supportsservice.hxx>
  30 #include <vcl/svapp.hxx>
  31 #include <toolkit/awt/vclxwindow.hxx>
  32 #include <toolkit/helper/convert.hxx>
  33 #include <unotools/accessiblestatesethelper.hxx>
  34
  35 //........................................................................
  36 namespace accessibility
  37 {
  38 //........................................................................
  39
  40     // class AccessibleListBox -----------------------------------------------------
  41
  42     using namespace ::com::sun::star::accessibility;
  43     using namespace ::com::sun::star::uno;
  44     using namespace ::com::sun::star::lang;
  45     using namespace ::com::sun::star;
  46
  47     // -----------------------------------------------------------------------------
  48     // Ctor() and Dtor()
  49     // -----------------------------------------------------------------------------
  50     AccessibleListBox::AccessibleListBox( SvTreeListBox& _rListBox, const Reference< XAccessible >& _xParent ) :
  51
  52         VCLXAccessibleComponent( _rListBox.GetWindowPeer() ),
  53         m_xParent( _xParent )
  54     {
  55     }
  56     // -----------------------------------------------------------------------------
  57     AccessibleListBox::~AccessibleListBox()
  58     {
  59         if ( isAlive() )
  60         {
  61             // increment ref count to prevent double call of Dtor
  62             osl_atomic_increment( &m_refCount );
  63             dispose();
  64         }
  65     }
  66     IMPLEMENT_FORWARD_XINTERFACE2(AccessibleListBox, VCLXAccessibleComponent, AccessibleListBox_BASE)
  67     IMPLEMENT_FORWARD_XTYPEPROVIDER2(AccessibleListBox, VCLXAccessibleComponent, AccessibleListBox_BASE)
  68     // -----------------------------------------------------------------------------
  69     SvTreeListBox* AccessibleListBox::getListBox() const
  70     {
  71         return  static_cast< SvTreeListBox* >( const_cast<AccessibleListBox*>(this)->GetWindow() );
  72     }
  73     // -----------------------------------------------------------------------------
  74     void AccessibleListBox::ProcessWindowEvent( const VclWindowEvent& rVclWindowEvent )
  75     {
  76         if ( isAlive() )
  77         {
  78             switch ( rVclWindowEvent.GetId() )
  79             {
  80                 case  VCLEVENT_CHECKBOX_TOGGLE :
  81                 {
  82                     if ( getListBox() && getListBox()->HasFocus() )
  83                     {
  84                         SvTreeListEntry* pEntry = static_cast< SvTreeListEntry* >( rVclWindowEvent.GetData() );
  85                         if ( !pEntry )
  86                             pEntry = getListBox()->GetCurEntry();
  87
  88                         if ( pEntry )
  89                         {
  90                             Reference< XAccessible > xChild = new AccessibleListBoxEntry( *getListBox(), pEntry, this );
  91                             uno::Any aOldValue, aNewValue;
  92                             aNewValue <<= xChild;
  93                             NotifyAccessibleEvent( AccessibleEventId::ACTIVE_DESCENDANT_CHANGED, aOldValue, aNewValue );
  94                         }
  95                     }
  96                     break;
  97                 }
  98
  99                 case VCLEVENT_LISTBOX_SELECT :
 100                 {
 101                     // First send an event that tells the listeners of a
 102                     // modified selection.  The active descendant event is
 103                     // send after that so that the receiving AT has time to
 104                     // read the text or name of the active child.
 105                     NotifyAccessibleEvent( AccessibleEventId::SELECTION_CHANGED, Any(), Any() );
 106                     if ( getListBox() && getListBox()->HasFocus() )
 107                     {
 108                         SvTreeListEntry* pEntry = static_cast< SvTreeListEntry* >( rVclWindowEvent.GetData() );
 109                         if ( pEntry )
 110                         {
 111                             Reference< XAccessible > xChild = new AccessibleListBoxEntry( *getListBox(), pEntry, this );
 112                             uno::Any aOldValue, aNewValue;
 113                             aNewValue <<= xChild;
 114                             NotifyAccessibleEvent( AccessibleEventId::ACTIVE_DESCENDANT_CHANGED, aOldValue, aNewValue );
 115                         }
 116                     }
 117                     break;
 118
 119                 // #i92103#
 120                 case VCLEVENT_ITEM_EXPANDED :
 121                 case VCLEVENT_ITEM_COLLAPSED :
 122                 {
 123                     SvTreeListEntry* pEntry = static_cast< SvTreeListEntry* >( rVclWindowEvent.GetData() );
 124                     if ( pEntry )
 125                     {
 126                         AccessibleListBoxEntry* pAccListBoxEntry =
 127                             new AccessibleListBoxEntry( *getListBox(), pEntry, this );
 128                         Reference< XAccessible > xChild = pAccListBoxEntry;
 129                         const short nAccEvent =
 130                                 ( rVclWindowEvent.GetId() == VCLEVENT_ITEM_EXPANDED )
 131                                 ? AccessibleEventId::LISTBOX_ENTRY_EXPANDED
 132                                 : AccessibleEventId::LISTBOX_ENTRY_COLLAPSED;
 133                         uno::Any aListBoxEntry;
 134                         aListBoxEntry <<= xChild;
 135                         NotifyAccessibleEvent( nAccEvent, Any(), aListBoxEntry );
 136                         if ( getListBox() && getListBox()->HasFocus() )
 137                         {
 138                             NotifyAccessibleEvent( AccessibleEventId::ACTIVE_DESCENDANT_CHANGED, Any(), aListBoxEntry );
 139                         }
 140                     }
 141                     break;
 142                 }
 143                 }
 144                 default:
 145                     VCLXAccessibleComponent::ProcessWindowEvent (rVclWindowEvent);
 146             }
 147         }
 148     }
 149     // -----------------------------------------------------------------------------
 150     void AccessibleListBox::ProcessWindowChildEvent( const VclWindowEvent& rVclWindowEvent )
 151     {
 152         switch ( rVclWindowEvent.GetId() )
 153         {
 154             case VCLEVENT_WINDOW_SHOW:
 155             case VCLEVENT_WINDOW_HIDE:
 156             {
 157             }
 158             break;
 159             default:
 160             {
 161                 VCLXAccessibleComponent::ProcessWindowChildEvent( rVclWindowEvent );
 162             }
 163             break;
 164         }
 165     }
 166
 167     // -----------------------------------------------------------------------------
 168     // XComponent
 169     // -----------------------------------------------------------------------------
 170     void SAL_CALL AccessibleListBox::disposing()
 171     {
 172         ::osl::MutexGuard aGuard( m_aMutex );
 173
 174         VCLXAccessibleComponent::disposing();
 175         m_xParent = NULL;
 176     }
 177     // -----------------------------------------------------------------------------
 178     // XServiceInfo
 179     // -----------------------------------------------------------------------------
 180     OUString SAL_CALL AccessibleListBox::getImplementationName() throw(RuntimeException)
 181     {
 182         return getImplementationName_Static();
 183     }
 184     // -----------------------------------------------------------------------------
 185     Sequence< OUString > SAL_CALL AccessibleListBox::getSupportedServiceNames() throw(RuntimeException)
 186     {
 187         return getSupportedServiceNames_Static();
 188     }
 189     // -----------------------------------------------------------------------------
 190     sal_Bool SAL_CALL AccessibleListBox::supportsService( const OUString& _rServiceName ) throw (RuntimeException)
 191     {
 192         return cppu::supportsService(this, _rServiceName);
 193     }
 194     // -----------------------------------------------------------------------------
 195     // XServiceInfo - static methods
 196     // -----------------------------------------------------------------------------
 197     Sequence< OUString > AccessibleListBox::getSupportedServiceNames_Static(void) throw( RuntimeException )
 198     {
 199         Sequence< OUString > aSupported(3);
 200         aSupported[0] = "com.sun.star.accessibility.AccessibleContext";
 201         aSupported[1] = "com.sun.star.accessibility.AccessibleComponent";
 202         aSupported[2] = "com.sun.star.awt.AccessibleTreeListBox";
 203         return aSupported;
 204     }
 205     // -----------------------------------------------------------------------------
 206     OUString AccessibleListBox::getImplementationName_Static(void) throw( RuntimeException )
 207     {
 208         return OUString( "com.sun.star.comp.svtools.AccessibleTreeListBox" );
 209     }
 210     // -----------------------------------------------------------------------------
 211     // XAccessible
 212     // -----------------------------------------------------------------------------
 213     Reference< XAccessibleContext > SAL_CALL AccessibleListBox::getAccessibleContext(  ) throw (RuntimeException)
 214     {
 215         ensureAlive();
 216         return this;
 217     }
 218     // -----------------------------------------------------------------------------
 219     // XAccessibleContext
 220     // -----------------------------------------------------------------------------
 221     sal_Int32 SAL_CALL AccessibleListBox::getAccessibleChildCount(  ) throw (RuntimeException)
 222     {
 223         ::comphelper::OExternalLockGuard aGuard( this );
 224
 225         ensureAlive();
 226
 227         sal_Int32 nCount = 0;
 228         SvTreeListBox* pSvTreeListBox = getListBox();
 229         if ( pSvTreeListBox )
 230             nCount = pSvTreeListBox->GetLevelChildCount( NULL );
 231
 232         return nCount;
 233     }
 234     // -----------------------------------------------------------------------------
 235     Reference< XAccessible > SAL_CALL AccessibleListBox::getAccessibleChild( sal_Int32 i ) throw (IndexOutOfBoundsException,RuntimeException)
 236     {
 237         ::comphelper::OExternalLockGuard aGuard( this );
 238
 239         ensureAlive();
 240         SvTreeListEntry* pEntry = getListBox()->GetEntry(i);
 241         if ( !pEntry )
 242             throw IndexOutOfBoundsException();
 243
 244         return new AccessibleListBoxEntry( *getListBox(), pEntry, this );
 245     }
 246     // -----------------------------------------------------------------------------
 247     Reference< XAccessible > SAL_CALL AccessibleListBox::getAccessibleParent(  ) throw (RuntimeException)
 248     {
 249         ::osl::MutexGuard aGuard( m_aMutex );
 250
 251         ensureAlive();
 252         return m_xParent;
 253     }
 254     // -----------------------------------------------------------------------------
 255     sal_Int16 SAL_CALL AccessibleListBox::getAccessibleRole(  ) throw (RuntimeException)
 256     {
 257         return AccessibleRole::TREE;
 258     }
 259     // -----------------------------------------------------------------------------
 260     OUString SAL_CALL AccessibleListBox::getAccessibleDescription(  ) throw (RuntimeException)
 261     {
 262         ::comphelper::OExternalLockGuard aGuard( this );
 263
 264         ensureAlive();
 265         return getListBox()->GetAccessibleDescription();
 266     }
 267     // -----------------------------------------------------------------------------
 268     OUString SAL_CALL AccessibleListBox::getAccessibleName(  ) throw (RuntimeException)
 269     {
 270         ::comphelper::OExternalLockGuard aGuard( this );
 271
 272         ensureAlive();
 273         return getListBox()->GetAccessibleName();
 274     }
 275     // -----------------------------------------------------------------------------
 276     // XAccessibleSelection
 277     // -----------------------------------------------------------------------------
 278     void SAL_CALL AccessibleListBox::selectAccessibleChild( sal_Int32 nChildIndex ) throw (IndexOutOfBoundsException, RuntimeException)
 279     {
 280         ::comphelper::OExternalLockGuard aGuard( this );
 281
 282         ensureAlive();
 283
 284         SvTreeListEntry* pEntry = getListBox()->GetEntry( nChildIndex );
 285         if ( !pEntry )
 286             throw IndexOutOfBoundsException();
 287
 288         getListBox()->Select( pEntry, sal_True );
 289     }
 290     // -----------------------------------------------------------------------------
 291     sal_Bool SAL_CALL AccessibleListBox::isAccessibleChildSelected( sal_Int32 nChildIndex ) throw (IndexOutOfBoundsException, RuntimeException)
 292     {
 293         ::comphelper::OExternalLockGuard aGuard( this );
 294
 295         ensureAlive();
 296
 297         SvTreeListEntry* pEntry = getListBox()->GetEntry( nChildIndex );
 298         if ( !pEntry )
 299             throw IndexOutOfBoundsException();
 300
 301         return getListBox()->IsSelected( pEntry );
 302     }
 303     // -----------------------------------------------------------------------------
 304     void SAL_CALL AccessibleListBox::clearAccessibleSelection(  ) throw (RuntimeException)
 305     {
 306         ::comphelper::OExternalLockGuard aGuard( this );
 307
 308         ensureAlive();
 309
 310         sal_Int32 nCount = getListBox()->GetLevelChildCount( NULL );
 311         for ( sal_Int32 i = 0; i < nCount; ++i )
 312         {
 313             SvTreeListEntry* pEntry = getListBox()->GetEntry( i );
 314             if ( getListBox()->IsSelected( pEntry ) )
 315                 getListBox()->Select( pEntry, sal_False );
 316         }
 317     }
 318     // -----------------------------------------------------------------------------
 319     void SAL_CALL AccessibleListBox::selectAllAccessibleChildren(  ) throw (RuntimeException)
 320     {
 321         ::comphelper::OExternalLockGuard aGuard( this );
 322
 323         ensureAlive();
 324
 325         sal_Int32 nCount = getListBox()->GetLevelChildCount( NULL );
 326         for ( sal_Int32 i = 0; i < nCount; ++i )
 327         {
 328             SvTreeListEntry* pEntry = getListBox()->GetEntry( i );
 329             if ( !getListBox()->IsSelected( pEntry ) )
 330                 getListBox()->Select( pEntry, sal_True );
 331         }
 332     }
 333     // -----------------------------------------------------------------------------
 334     sal_Int32 SAL_CALL AccessibleListBox::getSelectedAccessibleChildCount(  ) throw (RuntimeException)
 335     {
 336         ::comphelper::OExternalLockGuard aGuard( this );
 337
 338         ensureAlive();
 339
 340         sal_Int32 nSelCount = 0;
 341         sal_Int32 nCount = getListBox()->GetLevelChildCount( NULL );
 342         for ( sal_Int32 i = 0; i < nCount; ++i )
 343         {
 344             SvTreeListEntry* pEntry = getListBox()->GetEntry( i );
 345             if ( getListBox()->IsSelected( pEntry ) )
 346                 ++nSelCount;
 347         }
 348
 349         return nSelCount;
 350     }
 351     // -----------------------------------------------------------------------------
 352     Reference< XAccessible > SAL_CALL AccessibleListBox::getSelectedAccessibleChild( sal_Int32 nSelectedChildIndex ) throw (IndexOutOfBoundsException, RuntimeException)
 353     {
 354         ::comphelper::OExternalLockGuard aGuard( this );
 355
 356         ensureAlive();
 357
 358         if ( nSelectedChildIndex < 0 || nSelectedChildIndex >= getSelectedAccessibleChildCount() )
 359             throw IndexOutOfBoundsException();
 360
 361         Reference< XAccessible > xChild;
 362         sal_Int32 nSelCount= 0;
 363         sal_Int32 nCount = getListBox()->GetLevelChildCount( NULL );
 364         for ( sal_Int32 i = 0; i < nCount; ++i )
 365         {
 366             SvTreeListEntry* pEntry = getListBox()->GetEntry( i );
 367             if ( getListBox()->IsSelected( pEntry ) )
 368                 ++nSelCount;
 369
 370             if ( nSelCount == ( nSelectedChildIndex + 1 ) )
 371             {
 372                 xChild = new AccessibleListBoxEntry( *getListBox(), pEntry, this );
 373                 break;
 374             }
 375         }
 376
 377         return xChild;
 378     }
 379     // -----------------------------------------------------------------------------
 380     void SAL_CALL AccessibleListBox::deselectAccessibleChild( sal_Int32 nSelectedChildIndex ) throw (IndexOutOfBoundsException, RuntimeException)
 381     {
 382         ::comphelper::OExternalLockGuard aGuard( this );
 383
 384         ensureAlive();
 385
 386         SvTreeListEntry* pEntry = getListBox()->GetEntry( nSelectedChildIndex );
 387         if ( !pEntry )
 388             throw IndexOutOfBoundsException();
 389
 390         getListBox()->Select( pEntry, sal_False );
 391     }
 392     // -----------------------------------------------------------------------------
 393     void AccessibleListBox::FillAccessibleStateSet( utl::AccessibleStateSetHelper& rStateSet )
 394     {
 395         VCLXAccessibleComponent::FillAccessibleStateSet( rStateSet );
 396         if ( getListBox() && isAlive() )
 397         {
 398             rStateSet.AddState( AccessibleStateType::FOCUSABLE );
 399             rStateSet.AddState( AccessibleStateType::MANAGES_DESCENDANTS );
 400             if ( getListBox()->GetSelectionMode() == MULTIPLE_SELECTION )
 401                 rStateSet.AddState( AccessibleStateType::MULTI_SELECTABLE );
 402         }
 403     }
 404
 405
 406 //........................................................................
 407 }// namespace accessibility
 408 //........................................................................
 409
 410 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */