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