accessibility/source/extended/accessibleiconchoicectrl.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: accessibleiconchoicectrl.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/accessibleiconchoicectrl.hxx"
  34 #include "accessibility/extended/accessibleiconchoicectrlentry.hxx"
  35 #include <svtools/ivctrl.hxx>
  36 #include <com/sun/star/accessibility/AccessibleEventId.hpp>
  37 #include <com/sun/star/accessibility/AccessibleRole.hpp>
  38 #include <com/sun/star/accessibility/AccessibleStateType.hpp>
  39 #include <unotools/accessiblestatesethelper.hxx>
  40 #include <tools/debug.hxx>
  41 #include <vcl/svapp.hxx>
  42 #include <cppuhelper/typeprovider.hxx>
  43
  44 //........................................................................
  45 namespace accessibility
  46 {
  47 //........................................................................
  48
  49     // class AccessibleIconChoiceCtrl ----------------------------------------------
  50
  51     using namespace ::com::sun::star::accessibility;
  52     using namespace ::com::sun::star::uno;
  53     using namespace ::com::sun::star::lang;
  54     using namespace ::com::sun::star;
  55
  56     DBG_NAME(AccessibleIconChoiceCtrl)
  57
  58     // -----------------------------------------------------------------------------
  59     // Ctor() and Dtor()
  60     // -----------------------------------------------------------------------------
  61     AccessibleIconChoiceCtrl::AccessibleIconChoiceCtrl( SvtIconChoiceCtrl& _rIconCtrl, const Reference< XAccessible >& _xParent ) :
  62
  63         VCLXAccessibleComponent( _rIconCtrl.GetWindowPeer() ),
  64         m_xParent               ( _xParent )
  65     {
  66         DBG_CTOR( AccessibleIconChoiceCtrl, NULL );
  67     }
  68     // -----------------------------------------------------------------------------
  69     AccessibleIconChoiceCtrl::~AccessibleIconChoiceCtrl()
  70     {
  71         DBG_DTOR( AccessibleIconChoiceCtrl, NULL );
  72     }
  73     // -----------------------------------------------------------------------------
  74     IMPLEMENT_FORWARD_XINTERFACE2(AccessibleIconChoiceCtrl, VCLXAccessibleComponent, AccessibleIconChoiceCtrl_BASE)
  75     IMPLEMENT_FORWARD_XTYPEPROVIDER2(AccessibleIconChoiceCtrl, VCLXAccessibleComponent, AccessibleIconChoiceCtrl_BASE)
  76     // -----------------------------------------------------------------------------
  77     void AccessibleIconChoiceCtrl::ProcessWindowEvent( const VclWindowEvent& rVclWindowEvent )
  78     {
  79         if ( isAlive() )
  80         {
  81             switch ( rVclWindowEvent.GetId() )
  82             {
  83                 case VCLEVENT_LISTBOX_SELECT :
  84                 {
  85                     // First send an event that tells the listeners of a
  86                     // modified selection.  The active descendant event is
  87                     // send after that so that the receiving AT has time to
  88                     // read the text or name of the active child.
  89                     NotifyAccessibleEvent( AccessibleEventId::SELECTION_CHANGED, Any(), Any() );
  90                     SvtIconChoiceCtrl* pCtrl = getCtrl();
  91                     if ( pCtrl && pCtrl->HasFocus() )
  92                     {
  93                         SvxIconChoiceCtrlEntry* pEntry = static_cast< SvxIconChoiceCtrlEntry* >( rVclWindowEvent.GetData() );
  94                         if ( pEntry )
  95                         {
  96                             ULONG nPos = pCtrl->GetEntryListPos( pEntry );
  97                             Reference< XAccessible > xChild = new AccessibleIconChoiceCtrlEntry( *pCtrl, nPos, this );
  98                             uno::Any aOldValue, aNewValue;
  99                             aNewValue <<= xChild;
 100                             NotifyAccessibleEvent( AccessibleEventId::ACTIVE_DESCENDANT_CHANGED, aOldValue, aNewValue );
 101                         }
 102                     }
 103                     break;
 104                 }
 105                 default:
 106                     VCLXAccessibleComponent::ProcessWindowChildEvent (rVclWindowEvent);
 107             }
 108         }
 109     }
 110     // -----------------------------------------------------------------------------
 111     // XComponent
 112     // -----------------------------------------------------------------------------
 113     void SAL_CALL AccessibleIconChoiceCtrl::disposing()
 114     {
 115         ::osl::MutexGuard aGuard( m_aMutex );
 116
 117         m_xParent = NULL;
 118     }
 119     // -----------------------------------------------------------------------------
 120     // XServiceInfo
 121     // -----------------------------------------------------------------------------
 122     ::rtl::OUString SAL_CALL AccessibleIconChoiceCtrl::getImplementationName() throw (RuntimeException)
 123     {
 124         return getImplementationName_Static();
 125     }
 126     // -----------------------------------------------------------------------------
 127     Sequence< ::rtl::OUString > SAL_CALL AccessibleIconChoiceCtrl::getSupportedServiceNames() throw (RuntimeException)
 128     {
 129         return getSupportedServiceNames_Static();
 130     }
 131     // -----------------------------------------------------------------------------
 132     sal_Bool SAL_CALL AccessibleIconChoiceCtrl::supportsService( const ::rtl::OUString& _rServiceName ) throw (RuntimeException)
 133     {
 134         Sequence< ::rtl::OUString > aSupported( getSupportedServiceNames() );
 135         const ::rtl::OUString* pSupported = aSupported.getConstArray();
 136         const ::rtl::OUString* pEnd = pSupported + aSupported.getLength();
 137         for ( ; pSupported != pEnd && !pSupported->equals(_rServiceName); ++pSupported )
 138             ;
 139
 140         return pSupported != pEnd;
 141     }
 142     // -----------------------------------------------------------------------------
 143     // XServiceInfo - static methods
 144     // -----------------------------------------------------------------------------
 145     Sequence< ::rtl::OUString > AccessibleIconChoiceCtrl::getSupportedServiceNames_Static(void) throw (RuntimeException)
 146     {
 147         Sequence< ::rtl::OUString > aSupported(3);
 148         aSupported[0] = ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM("com.sun.star.accessibility.AccessibleContext") );
 149         aSupported[1] = ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM("com.sun.star.accessibility.AccessibleComponent") );
 150         aSupported[2] = ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM("com.sun.star.awt.AccessibleIconChoiceControl") );
 151         return aSupported;
 152     }
 153     // -----------------------------------------------------------------------------
 154     ::rtl::OUString AccessibleIconChoiceCtrl::getImplementationName_Static(void) throw (RuntimeException)
 155     {
 156         return ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM("com.sun.star.comp.svtools.AccessibleIconChoiceControl") );
 157     }
 158     // -----------------------------------------------------------------------------
 159     // XAccessible
 160     // -----------------------------------------------------------------------------
 161     Reference< XAccessibleContext > SAL_CALL AccessibleIconChoiceCtrl::getAccessibleContext(  ) throw (RuntimeException)
 162     {
 163         ensureAlive();
 164         return this;
 165     }
 166     // -----------------------------------------------------------------------------
 167     // XAccessibleContext
 168     // -----------------------------------------------------------------------------
 169     sal_Int32 SAL_CALL AccessibleIconChoiceCtrl::getAccessibleChildCount(  ) throw (RuntimeException)
 170     {
 171         ::comphelper::OExternalLockGuard aGuard( this );
 172
 173         ensureAlive();
 174         return getCtrl()->GetEntryCount();
 175     }
 176     // -----------------------------------------------------------------------------
 177     Reference< XAccessible > SAL_CALL AccessibleIconChoiceCtrl::getAccessibleChild( sal_Int32 i ) throw (RuntimeException, IndexOutOfBoundsException)
 178     {
 179         ::comphelper::OExternalLockGuard aGuard( this );
 180
 181         ensureAlive();
 182         SvtIconChoiceCtrl* pCtrl = getCtrl();
 183         SvxIconChoiceCtrlEntry* pEntry = pCtrl->GetEntry(i);
 184         if ( !pEntry )
 185             throw RuntimeException();
 186
 187         return new AccessibleIconChoiceCtrlEntry( *pCtrl, i, this );
 188     }
 189     // -----------------------------------------------------------------------------
 190     Reference< XAccessible > SAL_CALL AccessibleIconChoiceCtrl::getAccessibleParent(  ) throw (RuntimeException)
 191     {
 192         ::osl::MutexGuard aGuard( m_aMutex );
 193
 194         ensureAlive();
 195         return m_xParent;
 196     }
 197     // -----------------------------------------------------------------------------
 198     sal_Int16 SAL_CALL AccessibleIconChoiceCtrl::getAccessibleRole(  ) throw (RuntimeException)
 199     {
 200         return AccessibleRole::TREE;
 201     }
 202     // -----------------------------------------------------------------------------
 203     ::rtl::OUString SAL_CALL AccessibleIconChoiceCtrl::getAccessibleDescription(  ) throw (RuntimeException)
 204     {
 205         ::comphelper::OExternalLockGuard aGuard( this );
 206
 207         ensureAlive();
 208         return getCtrl()->GetAccessibleDescription();
 209     }
 210     // -----------------------------------------------------------------------------
 211     ::rtl::OUString SAL_CALL AccessibleIconChoiceCtrl::getAccessibleName(  ) throw (RuntimeException)
 212     {
 213         ::comphelper::OExternalLockGuard aGuard( this );
 214
 215         ensureAlive();
 216
 217         ::rtl::OUString sName = getCtrl()->GetAccessibleName();
 218         if ( sName.getLength() == 0 )
 219             sName = ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "IconChoiceControl" ) );
 220         return sName;
 221     }
 222     // -----------------------------------------------------------------------------
 223     // XAccessibleSelection
 224     // -----------------------------------------------------------------------------
 225     void SAL_CALL AccessibleIconChoiceCtrl::selectAccessibleChild( sal_Int32 nChildIndex ) throw (IndexOutOfBoundsException, RuntimeException)
 226     {
 227         ::comphelper::OExternalLockGuard aGuard( this );
 228
 229         ensureAlive();
 230
 231         SvtIconChoiceCtrl* pCtrl = getCtrl();
 232         SvxIconChoiceCtrlEntry* pEntry = pCtrl->GetEntry( nChildIndex );
 233         if ( !pEntry )
 234             throw IndexOutOfBoundsException();
 235
 236         pCtrl->SetCursor( pEntry );
 237     }
 238     // -----------------------------------------------------------------------------
 239     sal_Bool SAL_CALL AccessibleIconChoiceCtrl::isAccessibleChildSelected( sal_Int32 nChildIndex ) throw (IndexOutOfBoundsException, RuntimeException)
 240     {
 241         ::comphelper::OExternalLockGuard aGuard( this );
 242
 243         ensureAlive();
 244
 245         SvtIconChoiceCtrl* pCtrl = getCtrl();
 246         SvxIconChoiceCtrlEntry* pEntry = pCtrl->GetEntry( nChildIndex );
 247         if ( !pEntry )
 248             throw IndexOutOfBoundsException();
 249
 250         return ( pCtrl->GetCursor() == pEntry );
 251     }
 252     // -----------------------------------------------------------------------------
 253     void SAL_CALL AccessibleIconChoiceCtrl::clearAccessibleSelection(  ) throw (RuntimeException)
 254     {
 255         ::comphelper::OExternalLockGuard aGuard( this );
 256
 257         ensureAlive();
 258         getCtrl()->SetNoSelection();
 259     }
 260     // -----------------------------------------------------------------------------
 261     void SAL_CALL AccessibleIconChoiceCtrl::selectAllAccessibleChildren(  ) throw (RuntimeException)
 262     {
 263         ::comphelper::OExternalLockGuard aGuard( this );
 264
 265         ensureAlive();
 266
 267         sal_Int32 i, nCount = 0;
 268         SvtIconChoiceCtrl* pCtrl = getCtrl();
 269         nCount = pCtrl->GetEntryCount();
 270         for ( i = 0; i < nCount; ++i )
 271         {
 272             SvxIconChoiceCtrlEntry* pEntry = pCtrl->GetEntry( i );
 273             if ( pCtrl->GetCursor() != pEntry )
 274                 pCtrl->SetCursor( pEntry );
 275         }
 276     }
 277     // -----------------------------------------------------------------------------
 278     sal_Int32 SAL_CALL AccessibleIconChoiceCtrl::getSelectedAccessibleChildCount(  ) throw (RuntimeException)
 279     {
 280         ::comphelper::OExternalLockGuard aGuard( this );
 281
 282         ensureAlive();
 283
 284         sal_Int32 i, nSelCount = 0, nCount = 0;
 285         SvtIconChoiceCtrl* pCtrl = getCtrl();
 286         nCount = pCtrl->GetEntryCount();
 287         for ( i = 0; i < nCount; ++i )
 288         {
 289             SvxIconChoiceCtrlEntry* pEntry = pCtrl->GetEntry( i );
 290             if ( pCtrl->GetCursor() == pEntry )
 291                 ++nSelCount;
 292         }
 293
 294         return nSelCount;
 295     }
 296     // -----------------------------------------------------------------------------
 297     Reference< XAccessible > SAL_CALL AccessibleIconChoiceCtrl::getSelectedAccessibleChild( sal_Int32 nSelectedChildIndex ) throw (IndexOutOfBoundsException, RuntimeException)
 298     {
 299         ::comphelper::OExternalLockGuard aGuard( this );
 300
 301         ensureAlive();
 302
 303         if ( nSelectedChildIndex < 0 || nSelectedChildIndex >= getSelectedAccessibleChildCount() )
 304             throw IndexOutOfBoundsException();
 305
 306         Reference< XAccessible > xChild;
 307         sal_Int32 i, nSelCount = 0, nCount = 0;
 308         SvtIconChoiceCtrl* pCtrl = getCtrl();
 309         nCount = pCtrl->GetEntryCount();
 310         for ( i = 0; i < nCount; ++i )
 311         {
 312             SvxIconChoiceCtrlEntry* pEntry = pCtrl->GetEntry( i );
 313             if ( pCtrl->GetCursor() == pEntry )
 314                 ++nSelCount;
 315
 316             if ( nSelCount == ( nSelectedChildIndex + 1 ) )
 317             {
 318                 xChild = new AccessibleIconChoiceCtrlEntry( *pCtrl, i, this );
 319                 break;
 320             }
 321         }
 322
 323         return xChild;
 324     }
 325     // -----------------------------------------------------------------------------
 326     void SAL_CALL AccessibleIconChoiceCtrl::deselectAccessibleChild( sal_Int32 nSelectedChildIndex ) throw (IndexOutOfBoundsException, RuntimeException)
 327     {
 328         ::comphelper::OExternalLockGuard aGuard( this );
 329
 330         ensureAlive();
 331
 332         if ( nSelectedChildIndex < 0 || nSelectedChildIndex >= getAccessibleChildCount() )
 333             throw IndexOutOfBoundsException();
 334
 335         Reference< XAccessible > xChild;
 336         sal_Int32 i, nSelCount = 0, nCount = 0;
 337         SvtIconChoiceCtrl* pCtrl = getCtrl();
 338         nCount = pCtrl->GetEntryCount();
 339         bool bFound = false;
 340         for ( i = 0; i < nCount; ++i )
 341         {
 342             SvxIconChoiceCtrlEntry* pEntry = pCtrl->GetEntry( i );
 343             if ( pEntry->IsSelected() )
 344             {
 345                 ++nSelCount;
 346                 if ( i == nSelectedChildIndex )
 347                     bFound = true;
 348             }
 349         }
 350
 351         // if only one entry is selected and its index is choosen to deselect -> no selection anymore
 352         if ( 1 == nSelCount && bFound )
 353             pCtrl->SetNoSelection();
 354     }
 355     // -----------------------------------------------------------------------------
 356     void AccessibleIconChoiceCtrl::FillAccessibleStateSet( utl::AccessibleStateSetHelper& rStateSet )
 357     {
 358         VCLXAccessibleComponent::FillAccessibleStateSet( rStateSet );
 359         if ( isAlive() )
 360         {
 361             rStateSet.AddState( AccessibleStateType::FOCUSABLE );
 362             rStateSet.AddState( AccessibleStateType::MANAGES_DESCENDANTS );
 363             rStateSet.AddState( AccessibleStateType::SELECTABLE );
 364         }
 365     }
 366     // -----------------------------------------------------------------------------
 367     SvtIconChoiceCtrl* AccessibleIconChoiceCtrl::getCtrl()
 368     {
 369         return static_cast<SvtIconChoiceCtrl*>(GetWindow());
 370     }
 371
 372 //........................................................................
 373 }// namespace accessibility
 374 //........................................................................
 375