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