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