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/toolkit/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             return;
  58
  59         switch ( rVclWindowEvent.GetId() )
  60         {
  61             case VclEventId::ListboxSelect :
  62             {
  63                 // First send an event that tells the listeners of a
  64                 // modified selection.  The active descendant event is
  65                 // send after that so that the receiving AT has time to
  66                 // read the text or name of the active child.
  67 //                  NotifyAccessibleEvent( AccessibleEventId::SELECTION_CHANGED, Any(), Any() );
  68
  69                 if ( getCtrl() && getCtrl()->HasFocus() )
  70                 {
  71                     SvxIconChoiceCtrlEntry* pEntry = static_cast< SvxIconChoiceCtrlEntry* >( rVclWindowEvent.GetData() );
  72                     if ( pEntry )
  73                     {
  74                         sal_Int32 nPos = getCtrl()->GetEntryListPos( pEntry );
  75                         Reference< XAccessible > xChild = new AccessibleIconChoiceCtrlEntry( *getCtrl(), nPos, this );
  76                         uno::Any aOldValue, aNewValue;
  77                         aNewValue <<= xChild;
  78                         NotifyAccessibleEvent( AccessibleEventId::ACTIVE_DESCENDANT_CHANGED, aOldValue, aNewValue );
  79
  80                         NotifyAccessibleEvent( AccessibleEventId::SELECTION_CHANGED, aOldValue, aNewValue );
  81
  82                     }
  83                 }
  84                 break;
  85             }
  86             case VclEventId::WindowGetFocus :
  87             {
  88                 VclPtr<SvtIconChoiceCtrl> pCtrl = getCtrl();
  89                 if ( pCtrl && pCtrl->HasFocus() )
  90                 {
  91                     SvxIconChoiceCtrlEntry* pEntry = static_cast< SvxIconChoiceCtrlEntry* >( rVclWindowEvent.GetData() );
  92                     if ( pEntry == nullptr )
  93                     {
  94                         pEntry = getCtrl()->GetSelectedEntry();
  95                     }
  96                     if ( pEntry )
  97                     {
  98                         sal_Int32 nPos = pCtrl->GetEntryListPos( pEntry );
  99                         Reference< XAccessible > xChild = new AccessibleIconChoiceCtrlEntry( *pCtrl, nPos, this );
 100                         uno::Any aOldValue, aNewValue;
 101                         aNewValue <<= xChild;
 102                         NotifyAccessibleEvent( AccessibleEventId::ACTIVE_DESCENDANT_CHANGED, aOldValue, aNewValue );
 103                         NotifyAccessibleEvent( AccessibleEventId::SELECTION_CHANGED, aOldValue, aNewValue );
 104                     }
 105                 }
 106                 break;
 107             }
 108             default:
 109                 VCLXAccessibleComponent::ProcessWindowChildEvent (rVclWindowEvent);
 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("getAccessibleChild: Entry "
 166                                    + OUString::number(i) + " not found",
 167                 static_cast<css::lang::XTypeProvider*>(
 168                     static_cast<VCLXAccessibleComponent_BASE*>(this)));
 169
 170         return new AccessibleIconChoiceCtrlEntry( *pCtrl, i, this );
 171     }
 172
 173     Reference< XAccessible > SAL_CALL AccessibleIconChoiceCtrl::getAccessibleParent(  )
 174     {
 175         ::osl::MutexGuard aGuard( m_aMutex );
 176
 177         ensureAlive();
 178         return m_xParent;
 179     }
 180
 181     sal_Int16 SAL_CALL AccessibleIconChoiceCtrl::getAccessibleRole(  )
 182     {
 183         //return AccessibleRole::TREE;
 184         return AccessibleRole::LIST;
 185     }
 186
 187     OUString SAL_CALL AccessibleIconChoiceCtrl::getAccessibleDescription(  )
 188     {
 189         ::comphelper::OExternalLockGuard aGuard( this );
 190
 191         return getCtrl()->GetAccessibleDescription();
 192     }
 193
 194     OUString SAL_CALL AccessibleIconChoiceCtrl::getAccessibleName(  )
 195     {
 196         ::comphelper::OExternalLockGuard aGuard( this );
 197
 198         OUString sName = getCtrl()->GetAccessibleName();
 199         if ( sName.isEmpty() )
 200             sName = "IconChoiceControl";
 201         return sName;
 202     }
 203
 204     // XAccessibleSelection
 205
 206     void SAL_CALL AccessibleIconChoiceCtrl::selectAccessibleChild( sal_Int32 nChildIndex )
 207     {
 208         ::comphelper::OExternalLockGuard aGuard( this );
 209
 210         VclPtr<SvtIconChoiceCtrl> pCtrl = getCtrl();
 211         SvxIconChoiceCtrlEntry* pEntry = pCtrl->GetEntry( nChildIndex );
 212         if ( !pEntry )
 213             throw IndexOutOfBoundsException();
 214
 215         pCtrl->SetCursor( pEntry );
 216     }
 217
 218     sal_Bool SAL_CALL AccessibleIconChoiceCtrl::isAccessibleChildSelected( sal_Int32 nChildIndex )
 219     {
 220         ::comphelper::OExternalLockGuard aGuard( this );
 221
 222         VclPtr<SvtIconChoiceCtrl> pCtrl = getCtrl();
 223         SvxIconChoiceCtrlEntry* pEntry = pCtrl->GetEntry( nChildIndex );
 224         if ( !pEntry )
 225             throw IndexOutOfBoundsException();
 226
 227         return ( pCtrl->GetCursor() == pEntry );
 228     }
 229
 230     void SAL_CALL AccessibleIconChoiceCtrl::clearAccessibleSelection(  )
 231     {
 232         ::comphelper::OExternalLockGuard aGuard( this );
 233         getCtrl()->SetNoSelection();
 234     }
 235
 236     void SAL_CALL AccessibleIconChoiceCtrl::selectAllAccessibleChildren(  )
 237     {
 238         ::comphelper::OExternalLockGuard aGuard( this );
 239
 240         VclPtr<SvtIconChoiceCtrl> pCtrl = getCtrl();
 241         sal_Int32 nCount = pCtrl->GetEntryCount();
 242         for ( sal_Int32 i = 0; i < nCount; ++i )
 243         {
 244             SvxIconChoiceCtrlEntry* pEntry = pCtrl->GetEntry( i );
 245             if ( pCtrl->GetCursor() != pEntry )
 246                 pCtrl->SetCursor( pEntry );
 247         }
 248     }
 249
 250     sal_Int32 SAL_CALL AccessibleIconChoiceCtrl::getSelectedAccessibleChildCount(  )
 251     {
 252         ::comphelper::OExternalLockGuard aGuard( this );
 253
 254         sal_Int32 nSelCount = 0;
 255         VclPtr<SvtIconChoiceCtrl> pCtrl = getCtrl();
 256         sal_Int32 nCount = pCtrl->GetEntryCount();
 257         for ( sal_Int32 i = 0; i < nCount; ++i )
 258         {
 259             SvxIconChoiceCtrlEntry* pEntry = pCtrl->GetEntry( i );
 260             if ( pCtrl->GetCursor() == pEntry )
 261                 ++nSelCount;
 262         }
 263
 264         return nSelCount;
 265     }
 266
 267     Reference< XAccessible > SAL_CALL AccessibleIconChoiceCtrl::getSelectedAccessibleChild( sal_Int32 nSelectedChildIndex )
 268     {
 269         ::comphelper::OExternalLockGuard aGuard( this );
 270
 271         if ( nSelectedChildIndex < 0 || nSelectedChildIndex >= getSelectedAccessibleChildCount() )
 272             throw IndexOutOfBoundsException();
 273
 274         Reference< XAccessible > xChild;
 275         sal_Int32 nSelCount = 0;
 276         VclPtr<SvtIconChoiceCtrl> pCtrl = getCtrl();
 277         sal_Int32 nCount = pCtrl->GetEntryCount();
 278         for ( sal_Int32 i = 0; i < nCount; ++i )
 279         {
 280             SvxIconChoiceCtrlEntry* pEntry = pCtrl->GetEntry( i );
 281             if ( pCtrl->GetCursor() == pEntry )
 282                 ++nSelCount;
 283
 284             if ( nSelCount == ( nSelectedChildIndex + 1 ) )
 285             {
 286                 xChild = new AccessibleIconChoiceCtrlEntry( *pCtrl, i, this );
 287                 break;
 288             }
 289         }
 290
 291         return xChild;
 292     }
 293
 294     void SAL_CALL AccessibleIconChoiceCtrl::deselectAccessibleChild( sal_Int32 nSelectedChildIndex )
 295     {
 296         ::comphelper::OExternalLockGuard aGuard( this );
 297
 298         if ( nSelectedChildIndex < 0 || nSelectedChildIndex >= getAccessibleChildCount() )
 299             throw IndexOutOfBoundsException();
 300
 301         sal_Int32 nSelCount = 0;
 302         VclPtr<SvtIconChoiceCtrl> pCtrl = getCtrl();
 303         sal_Int32 nCount = pCtrl->GetEntryCount();
 304         bool bFound = false;
 305         for ( sal_Int32 i = 0; i < nCount; ++i )
 306         {
 307             SvxIconChoiceCtrlEntry* pEntry = pCtrl->GetEntry( i );
 308             if ( pEntry->IsSelected() )
 309             {
 310                 ++nSelCount;
 311                 if ( i == nSelectedChildIndex )
 312                     bFound = true;
 313             }
 314         }
 315
 316         // if only one entry is selected and its index is chosen to deselect -> no selection anymore
 317         if ( nSelCount == 1 && bFound )
 318             pCtrl->SetNoSelection();
 319     }
 320
 321     void AccessibleIconChoiceCtrl::FillAccessibleStateSet( utl::AccessibleStateSetHelper& rStateSet )
 322     {
 323         VCLXAccessibleComponent::FillAccessibleStateSet( rStateSet );
 324         if ( isAlive() )
 325         {
 326             rStateSet.AddState( AccessibleStateType::FOCUSABLE );
 327             rStateSet.AddState( AccessibleStateType::MANAGES_DESCENDANTS );
 328             rStateSet.AddState( AccessibleStateType::SELECTABLE );
 329         }
 330     }
 331
 332     VclPtr< SvtIconChoiceCtrl > AccessibleIconChoiceCtrl::getCtrl() const
 333     {
 334         return GetAs<SvtIconChoiceCtrl >();
 335     }
 336
 337 }// namespace accessibility
 338
 339
 340 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */