accessibility/source/extended/AccessibleGridControl.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/AccessibleGridControl.hxx>
  21 #include <extended/AccessibleGridControlTable.hxx>
  22 #include <extended/AccessibleGridControlHeader.hxx>
  23 #include <com/sun/star/accessibility/AccessibleEventId.hpp>
  24 #include <com/sun/star/accessibility/AccessibleRole.hpp>
  25 #include <com/sun/star/lang/IndexOutOfBoundsException.hpp>
  26 #include <utility>
  27 #include <vcl/accessibletable.hxx>
  28 #include <vcl/svapp.hxx>
  29 #include <vcl/unohelp.hxx>
  30
  31 namespace accessibility
  32 {
  33
  34 using namespace ::com::sun::star::uno;
  35 using namespace ::com::sun::star;
  36 using namespace ::com::sun::star::lang;
  37 using namespace ::com::sun::star::accessibility;
  38 using namespace ::vcl;
  39 using namespace ::vcl::table;
  40
  41 AccessibleGridControl::AccessibleGridControl(
  42             const css::uno::Reference< css::accessibility::XAccessible >& _rxParent, const css::uno::Reference< css::accessibility::XAccessible >& _rxCreator,
  43             ::vcl::table::IAccessibleTable& _rTable )
  44     : AccessibleGridControlBase(_rxParent, _rTable, AccessibleTableControlObjType::GRIDCONTROL),
  45       m_aCreator(_rxCreator)
  46 {
  47 }
  48
  49
  50 void SAL_CALL AccessibleGridControl::disposing()
  51 {
  52     SolarMutexGuard g;
  53
  54     m_aCreator.clear();
  55
  56     if ( m_xTable.is() )
  57     {
  58         m_xTable->dispose();
  59         m_xTable.clear();
  60     }
  61     if ( m_xRowHeaderBar.is() )
  62     {
  63         m_xRowHeaderBar->dispose();
  64         m_xRowHeaderBar.clear();
  65     }
  66     if ( m_xColumnHeaderBar.is() )
  67     {
  68         m_xColumnHeaderBar->dispose();
  69         m_xColumnHeaderBar.clear();
  70     }
  71     AccessibleGridControlBase::disposing();
  72 }
  73
  74 sal_Int64 AccessibleGridControl::implGetAccessibleChildCount()
  75 {
  76     return m_aTable.GetAccessibleControlCount();
  77 }
  78
  79 // css::accessibility::XAccessibleContext ---------------------------------------------------------
  80
  81
  82 sal_Int64 SAL_CALL AccessibleGridControl::getAccessibleChildCount()
  83 {
  84     SolarMutexGuard aSolarGuard;
  85     ensureIsAlive();
  86     return implGetAccessibleChildCount();
  87 }
  88
  89
  90 css::uno::Reference< css::accessibility::XAccessible > SAL_CALL
  91 AccessibleGridControl::getAccessibleChild( sal_Int64 nChildIndex )
  92 {
  93     SolarMutexGuard aSolarGuard;
  94
  95     if (nChildIndex<0 || nChildIndex>=implGetAccessibleChildCount())
  96         throw IndexOutOfBoundsException();
  97
  98     css::uno::Reference< css::accessibility::XAccessible > xChild;
  99     if (isAlive())
 100     {
 101         if(nChildIndex == 0 && m_aTable.HasColHeader())
 102         {
 103             if(!m_xColumnHeaderBar.is())
 104             {
 105                 m_xColumnHeaderBar = new AccessibleGridControlHeader(m_aCreator, m_aTable,
 106                                                                      vcl::table::AccessibleTableControlObjType::COLUMNHEADERBAR);
 107             }
 108             xChild = m_xColumnHeaderBar.get();
 109         }
 110         else if(m_aTable.HasRowHeader() && (nChildIndex == 1 || nChildIndex == 0))
 111         {
 112             if(!m_xRowHeaderBar.is())
 113             {
 114                 m_xRowHeaderBar = new AccessibleGridControlHeader(m_aCreator, m_aTable,
 115                                                                   vcl::table::AccessibleTableControlObjType::ROWHEADERBAR);
 116             }
 117             xChild = m_xRowHeaderBar.get();
 118         }
 119         else
 120         {
 121             if(!m_xTable.is())
 122             {
 123                 m_xTable = new AccessibleGridControlTable(m_aCreator, m_aTable);
 124             }
 125             xChild = m_xTable.get();
 126         }
 127     }
 128     return xChild;
 129 }
 130
 131
 132 sal_Int16 SAL_CALL AccessibleGridControl::getAccessibleRole()
 133 {
 134     SolarMutexGuard g;
 135
 136     ensureIsAlive();
 137     return AccessibleRole::PANEL;
 138 }
 139
 140
 141 // css::accessibility::XAccessibleComponent -------------------------------------------------------
 142
 143 css::uno::Reference< css::accessibility::XAccessible > SAL_CALL
 144 AccessibleGridControl::getAccessibleAtPoint( const awt::Point& rPoint )
 145 {
 146     SolarMutexGuard aSolarGuard;
 147     ensureIsAlive();
 148
 149     sal_Int32 nIndex = 0;
 150     if (m_aTable.ConvertPointToControlIndex(nIndex, vcl::unohelper::ConvertToVCLPoint(rPoint)))
 151         return m_aTable.CreateAccessibleControl(nIndex);
 152     else
 153     {
 154         // try whether point is in one of the fixed children
 155         // (table, header bars, corner control)
 156         Point aPoint(vcl::unohelper::ConvertToVCLPoint(rPoint));
 157         for (nIndex = 0; nIndex < 3; ++nIndex)
 158         {
 159             css::uno::Reference< css::accessibility::XAccessible > xCurrChild( implGetFixedChild( nIndex ) );
 160             css::uno::Reference< css::accessibility::XAccessibleComponent >
 161             xCurrChildComp( xCurrChild, uno::UNO_QUERY );
 162
 163             if (xCurrChildComp.is()
 164                 && vcl::unohelper::ConvertToVCLRect(xCurrChildComp->getBounds()).Contains(aPoint))
 165                 return xCurrChild;
 166         }
 167     }
 168     return nullptr;
 169 }
 170
 171
 172 void SAL_CALL AccessibleGridControl::grabFocus()
 173 {
 174     SolarMutexGuard aSolarGuard;
 175     ensureIsAlive();
 176     m_aTable.GrabFocus();
 177 }
 178
 179 // XServiceInfo ---------------------------------------------------------------
 180 OUString SAL_CALL AccessibleGridControl::getImplementationName()
 181 {
 182     return u"com.sun.star.accessibility.AccessibleGridControl"_ustr;
 183 }
 184
 185 // internal virtual methods ---------------------------------------------------
 186
 187 tools::Rectangle AccessibleGridControl::implGetBoundingBox()
 188 {
 189     vcl::Window* pParent = m_aTable.GetAccessibleParentWindow();
 190     assert(pParent && "implGetBoundingBox - missing parent window");
 191     return m_aTable.GetWindowExtentsRelative( *pParent );
 192 }
 193
 194 AbsoluteScreenPixelRectangle AccessibleGridControl::implGetBoundingBoxOnScreen()
 195 {
 196     return m_aTable.GetWindowExtentsAbsolute();
 197 }
 198
 199 // internal helper methods ----------------------------------------------------
 200
 201 css::uno::Reference< css::accessibility::XAccessible > AccessibleGridControl::implGetTable()
 202 {
 203     if( !m_xTable.is() )
 204     {
 205         m_xTable = createAccessibleTable();
 206     }
 207     return m_xTable;
 208 }
 209
 210 css::uno::Reference< css::accessibility::XAccessible >
 211 AccessibleGridControl::implGetHeaderBar( AccessibleTableControlObjType eObjType )
 212 {
 213     css::uno::Reference< css::accessibility::XAccessible > xRet;
 214     rtl::Reference< AccessibleGridControlHeader >* pxMember = nullptr;
 215
 216     if (eObjType == AccessibleTableControlObjType::ROWHEADERBAR)
 217         pxMember = &m_xRowHeaderBar;
 218     else if (eObjType ==  AccessibleTableControlObjType::COLUMNHEADERBAR)
 219         pxMember = &m_xColumnHeaderBar;
 220
 221     if( pxMember )
 222     {
 223         if( !pxMember->is() )
 224         {
 225             *pxMember = new AccessibleGridControlHeader(
 226                 m_aCreator, m_aTable, eObjType );
 227         }
 228         xRet = pxMember->get();
 229     }
 230     return xRet;
 231 }
 232
 233 css::uno::Reference< css::accessibility::XAccessible >
 234 AccessibleGridControl::implGetFixedChild( sal_Int64 nChildIndex )
 235 {
 236     css::uno::Reference< css::accessibility::XAccessible > xRet;
 237     switch( nChildIndex )
 238     {
 239         /** Child index of the column header bar (first row). */
 240         case 0:
 241             xRet = implGetHeaderBar(AccessibleTableControlObjType::COLUMNHEADERBAR);
 242         break;
 243         /** Child index of the row header bar ("handle column"). */
 244         case 1:
 245             xRet = implGetHeaderBar(AccessibleTableControlObjType::ROWHEADERBAR);
 246         break;
 247         /** Child index of the data table. */
 248         case 2:
 249             xRet = implGetTable();
 250         break;
 251     }
 252     return xRet;
 253 }
 254
 255 rtl::Reference<AccessibleGridControlTable> AccessibleGridControl::createAccessibleTable()
 256 {
 257     css::uno::Reference< css::accessibility::XAccessible > xCreator(m_aCreator);
 258     OSL_ENSURE( xCreator.is(), "extended/AccessibleGridControl::createAccessibleTable: my creator died - how this?" );
 259     return new AccessibleGridControlTable( xCreator, m_aTable );
 260 }
 261
 262 void AccessibleGridControl::commitCellEvent(sal_Int16 _nEventId,const Any& _rNewValue,const Any& _rOldValue)
 263 {
 264     sal_Int64 nChildCount = implGetAccessibleChildCount();
 265     if(nChildCount != 0)
 266     {
 267         for(sal_Int64 i=0;i<nChildCount;i++)
 268         {
 269             css::uno::Reference< css::accessibility::XAccessible > xAccessible = getAccessibleChild(i);
 270             if(css::uno::Reference< css::accessibility::XAccessible >(m_xTable) == xAccessible)
 271             {
 272                 Reference<XAccessible> xCell = m_xTable->getAccessibleCellAt(
 273                     m_aTable.GetCurrentRow(), m_aTable.GetCurrentColumn());
 274                 AccessibleGridControlTableCell* pCell = static_cast<AccessibleGridControlTableCell*>(xCell.get());
 275                 pCell->commitEvent(_nEventId, _rNewValue, _rOldValue);
 276             }
 277         }
 278     }
 279     else
 280     {
 281         if ( m_xTable.is() )
 282             m_xTable->commitEvent(_nEventId,_rNewValue,_rOldValue);
 283     }
 284 }
 285
 286 void AccessibleGridControl::commitTableEvent(sal_Int16 _nEventId,const Any& _rNewValue,const Any& _rOldValue)
 287 {
 288     if ( !m_xTable.is() )
 289         return;
 290
 291     if(_nEventId == AccessibleEventId::ACTIVE_DESCENDANT_CHANGED)
 292     {
 293         const sal_Int32 nCurrentRow = m_aTable.GetCurrentRow();
 294         const sal_Int32 nCurrentCol = m_aTable.GetCurrentColumn();
 295         css::uno::Reference< css::accessibility::XAccessible > xChild;
 296         if (nCurrentRow > -1 && nCurrentCol > -1)
 297             xChild = m_xTable->getAccessibleCellAt(nCurrentRow, nCurrentCol);
 298
 299         m_xTable->commitEvent(_nEventId, Any(xChild),_rOldValue);
 300     }
 301     else
 302         m_xTable->commitEvent(_nEventId,_rNewValue,_rOldValue);
 303 }
 304
 305 // = AccessibleGridControlAccess
 306
 307
 308 AccessibleGridControlAccess::AccessibleGridControlAccess(
 309         css::uno::Reference< css::accessibility::XAccessible > xParent, ::vcl::table::IAccessibleTable& rTable )
 310     : m_xParent(std::move( xParent ))
 311     , m_pTable( & rTable )
 312 {
 313 }
 314
 315
 316 AccessibleGridControlAccess::~AccessibleGridControlAccess()
 317 {
 318 }
 319
 320
 321 void AccessibleGridControlAccess::DisposeAccessImpl()
 322 {
 323     SolarMutexGuard g;
 324
 325     m_pTable = nullptr;
 326     if (m_xContext.is())
 327     {
 328         m_xContext->dispose();
 329         m_xContext.clear();
 330     }
 331 }
 332
 333
 334 css::uno::Reference< css::accessibility::XAccessibleContext > SAL_CALL AccessibleGridControlAccess::getAccessibleContext()
 335 {
 336     SolarMutexGuard g;
 337
 338     // if the context died meanwhile (we're no listener, so it won't tell us explicitly when this happens),
 339     // then reset and re-create.
 340     if ( m_xContext.is() && !m_xContext->isAlive() )
 341         m_xContext = nullptr;
 342
 343     if (!m_xContext.is() && m_pTable)
 344         m_xContext = new AccessibleGridControl(m_xParent, this, *m_pTable);
 345
 346     return m_xContext;
 347 }
 348
 349
 350 }   // namespace accessibility
 351
 352 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */