accessibility/source/extended/AccessibleGridControlTableCell.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/AccessibleGridControlTableCell.hxx>
  21 #include <toolkit/helper/convert.hxx>
  22 #include <vcl/accessibletable.hxx>
  23 #include <vcl/svapp.hxx>
  24 #include <tools/gen.hxx>
  25 #include <tools/debug.hxx>
  26 #include <com/sun/star/accessibility/AccessibleStateType.hpp>
  27 #include <com/sun/star/lang/IndexOutOfBoundsException.hpp>
  28
  29 namespace accessibility
  30 {
  31     namespace
  32     {
  33         // FIXME this is a copy'n'paste from
  34         // source/extended/AccessibleBrowseBoxTableCell.cxx, get rid of that...
  35         /// @throws css::lang::IndexOutOfBoundsException
  36         void checkIndex_Impl( sal_Int32 _nIndex, std::u16string_view _sText )
  37         {
  38             if ( _nIndex >= static_cast<sal_Int32>(_sText.size()) )
  39                 throw css::lang::IndexOutOfBoundsException();
  40         }
  41     }
  42     using namespace ::com::sun::star::lang;
  43     using namespace comphelper;
  44     using namespace ::com::sun::star::uno;
  45     using ::com::sun::star::accessibility::XAccessible;
  46     using namespace ::com::sun::star::accessibility;
  47     using namespace ::vcl;
  48     using namespace ::vcl::table;
  49
  50
  51     // = AccessibleGridControlCell
  52
  53
  54     AccessibleGridControlCell::AccessibleGridControlCell(
  55             const css::uno::Reference< css::accessibility::XAccessible >& _rxParent, ::vcl::table::IAccessibleTable& _rTable,
  56             sal_Int32 _nRowPos, sal_uInt16 _nColPos, ::vcl::table::AccessibleTableControlObjType _eType )
  57         :AccessibleGridControlBase( _rxParent, _rTable, _eType )
  58         ,m_nRowPos( _nRowPos )
  59         ,m_nColPos( _nColPos )
  60     {
  61     }
  62
  63     void SAL_CALL AccessibleGridControlCell::grabFocus()
  64     {
  65         SolarMutexGuard aSolarGuard;
  66
  67         m_aTable.GoToCell( m_nColPos, m_nRowPos );
  68     }
  69
  70     OUString SAL_CALL AccessibleGridControlCell::getAccessibleName()
  71     {
  72         SolarMutexGuard g;
  73
  74         ensureIsAlive();
  75
  76         OUString sAccName;
  77         if (m_eObjType == TCTYPE_TABLECELL)
  78             sAccName = m_aTable.GetAccessibleObjectName(TCTYPE_TABLECELL, m_nRowPos, m_nColPos);
  79         else if (m_eObjType == TCTYPE_ROWHEADERCELL)
  80             sAccName = m_aTable.GetAccessibleObjectName(TCTYPE_ROWHEADERCELL, m_nRowPos, 0);
  81         else if (m_eObjType == TCTYPE_COLUMNHEADERCELL)
  82             sAccName = m_aTable.GetAccessibleObjectName(TCTYPE_COLUMNHEADERCELL, 0, m_nRowPos);
  83         else
  84             assert(false && "Unhandled table cell type");
  85         return sAccName;
  86     }
  87
  88     // implementation of a table cell
  89     OUString AccessibleGridControlTableCell::implGetText()
  90     {
  91         ensureIsAlive();
  92         return m_aTable.GetAccessibleCellText( getRowPos(),  getColumnPos() );
  93     }
  94
  95     css::lang::Locale AccessibleGridControlTableCell::implGetLocale()
  96     {
  97         ensureIsAlive();
  98         return m_aTable.GetAccessible()->getAccessibleContext()->getLocale();
  99     }
 100
 101     void AccessibleGridControlTableCell::implGetSelection( sal_Int32& nStartIndex, sal_Int32& nEndIndex )
 102     {
 103         nStartIndex = 0;
 104         nEndIndex = 0;
 105     }
 106
 107     AccessibleGridControlTableCell::AccessibleGridControlTableCell(const css::uno::Reference<XAccessible >& _rxParent,
 108                                 ::vcl::table::IAccessibleTable& _rTable,
 109                                 sal_Int32 _nRowPos,
 110                                 sal_uInt16 _nColPos)
 111         :AccessibleGridControlCell( _rxParent, _rTable, _nRowPos, _nColPos, TCTYPE_TABLECELL )
 112     {
 113     }
 114
 115     // XInterface
 116
 117     /** Queries for a new interface. */
 118     css::uno::Any SAL_CALL AccessibleGridControlTableCell::queryInterface(
 119             const css::uno::Type& rType )
 120     {
 121         Any aRet = AccessibleGridControlCell::queryInterface(rType);
 122         if ( !aRet.hasValue() )
 123             aRet = AccessibleTextHelper_BASE::queryInterface(rType);
 124         return aRet;
 125     }
 126
 127     /** Acquires the object (calls acquire() on base class). */
 128     void SAL_CALL AccessibleGridControlTableCell::acquire() noexcept
 129     {
 130         AccessibleGridControlCell::acquire();
 131     }
 132
 133     /** Releases the object (calls release() on base class). */
 134     void SAL_CALL AccessibleGridControlTableCell::release() noexcept
 135     {
 136         AccessibleGridControlCell::release();
 137     }
 138
 139     css::awt::Rectangle SAL_CALL AccessibleGridControlTableCell::getCharacterBounds( sal_Int32 nIndex )
 140     {
 141         SolarMutexGuard aSolarGuard;
 142
 143         ensureIsAlive();
 144         if ( !implIsValidIndex( nIndex, implGetText().getLength() ) )
 145             throw IndexOutOfBoundsException();
 146
 147         return AWTRectangle( m_aTable.GetFieldCharacterBounds( getRowPos(), getColumnPos(), nIndex ) );
 148     }
 149
 150     sal_Int32 SAL_CALL AccessibleGridControlTableCell::getIndexAtPoint( const css::awt::Point& _aPoint )
 151     {
 152         SolarMutexGuard aSolarGuard;
 153
 154         ensureIsAlive();
 155
 156         return m_aTable.GetFieldIndexAtPoint( getRowPos(), getColumnPos(), VCLPoint( _aPoint ) );
 157     }
 158
 159     /** @return
 160             The name of this class.
 161     */
 162     OUString SAL_CALL AccessibleGridControlTableCell::getImplementationName()
 163     {
 164         return "com.sun.star.accessibility.AccessibleGridControlTableCell";
 165     }
 166
 167     /** @return  The count of visible children. */
 168     sal_Int64 SAL_CALL AccessibleGridControlTableCell::getAccessibleChildCount()
 169     {
 170         return 0;
 171     }
 172
 173     /** @return  The css::accessibility::XAccessible interface of the specified child. */
 174     css::uno::Reference< css::accessibility::XAccessible > SAL_CALL AccessibleGridControlTableCell::getAccessibleChild( sal_Int64 )
 175     {
 176         throw css::lang::IndexOutOfBoundsException();
 177     }
 178
 179     /** Return a bitset of states of the current object.
 180     */
 181     sal_Int64 AccessibleGridControlTableCell::implCreateStateSet()
 182     {
 183         sal_Int64 nStateSet = 0;
 184
 185         if( isAlive() )
 186         {
 187             // SHOWING done with mxParent
 188             if( implIsShowing() )
 189                 nStateSet |= AccessibleStateType::SHOWING;
 190
 191             m_aTable.FillAccessibleStateSetForCell( nStateSet, getRowPos(), static_cast< sal_uInt16 >( getColumnPos() ) );
 192         }
 193         else
 194             nStateSet |= AccessibleStateType::DEFUNC;
 195
 196         return nStateSet;
 197     }
 198
 199
 200     // css::accessibility::XAccessible
 201
 202     /** @return  The css::accessibility::XAccessibleContext interface of this object. */
 203     css::uno::Reference< css::accessibility::XAccessibleContext > SAL_CALL AccessibleGridControlTableCell::getAccessibleContext()
 204     {
 205         SolarMutexGuard g;
 206
 207         ensureIsAlive();
 208         return this;
 209     }
 210
 211     // css::accessibility::XAccessibleContext
 212
 213     sal_Int64 SAL_CALL AccessibleGridControlTableCell::getAccessibleIndexInParent()
 214     {
 215         SolarMutexGuard aSolarGuard;
 216
 217         ensureIsAlive();
 218
 219         return (static_cast<sal_Int64>(getRowPos()) * static_cast<sal_Int64>(m_aTable.GetColumnCount())) + getColumnPos();
 220     }
 221
 222     sal_Int32 SAL_CALL AccessibleGridControlTableCell::getCaretPosition(  )
 223     {
 224         return -1;
 225     }
 226     sal_Bool SAL_CALL AccessibleGridControlTableCell::setCaretPosition ( sal_Int32 nIndex )
 227     {
 228         SolarMutexGuard aSolarGuard;
 229
 230         if ( !implIsValidRange( nIndex, nIndex, implGetText().getLength() ) )
 231             throw IndexOutOfBoundsException();
 232
 233         return false;
 234     }
 235     sal_Unicode SAL_CALL AccessibleGridControlTableCell::getCharacter( sal_Int32 nIndex )
 236     {
 237         SolarMutexGuard aSolarGuard;
 238
 239         return OCommonAccessibleText::implGetCharacter( implGetText(), nIndex );
 240     }
 241     css::uno::Sequence< css::beans::PropertyValue > SAL_CALL AccessibleGridControlTableCell::getCharacterAttributes( sal_Int32 nIndex, const css::uno::Sequence< OUString >& )
 242     {
 243         SolarMutexGuard aSolarGuard;
 244
 245         OUString sText( implGetText() );
 246
 247         if ( !implIsValidIndex( nIndex, sText.getLength() ) )
 248             throw IndexOutOfBoundsException();
 249
 250         return css::uno::Sequence< css::beans::PropertyValue >();
 251     }
 252     sal_Int32 SAL_CALL AccessibleGridControlTableCell::getCharacterCount(  )
 253     {
 254         SolarMutexGuard aSolarGuard;
 255
 256         return implGetText().getLength();
 257     }
 258
 259     OUString SAL_CALL AccessibleGridControlTableCell::getSelectedText(  )
 260     {
 261         return OUString();
 262     }
 263     sal_Int32 SAL_CALL AccessibleGridControlTableCell::getSelectionStart(  )
 264     {
 265         return 0;
 266     }
 267     sal_Int32 SAL_CALL AccessibleGridControlTableCell::getSelectionEnd(  )
 268     {
 269         return 0;
 270     }
 271     sal_Bool SAL_CALL AccessibleGridControlTableCell::setSelection( sal_Int32 nStartIndex, sal_Int32 nEndIndex )
 272     {
 273         SolarMutexGuard aSolarGuard;
 274
 275         if ( !implIsValidRange( nStartIndex, nEndIndex, implGetText().getLength() ) )
 276             throw IndexOutOfBoundsException();
 277
 278         return false;
 279     }
 280     OUString SAL_CALL AccessibleGridControlTableCell::getText(  )
 281     {
 282         SolarMutexGuard aSolarGuard;
 283
 284         return implGetText(  );
 285     }
 286     OUString SAL_CALL AccessibleGridControlTableCell::getTextRange( sal_Int32 nStartIndex, sal_Int32 nEndIndex )
 287     {
 288         SolarMutexGuard aSolarGuard;
 289
 290         return OCommonAccessibleText::implGetTextRange( implGetText(), nStartIndex, nEndIndex );
 291     }
 292     css::accessibility::TextSegment SAL_CALL AccessibleGridControlTableCell::getTextAtIndex( sal_Int32 nIndex, sal_Int16 aTextType )
 293     {
 294         SolarMutexGuard aSolarGuard;
 295
 296         return OCommonAccessibleText::getTextAtIndex( nIndex ,aTextType);
 297     }
 298     css::accessibility::TextSegment SAL_CALL AccessibleGridControlTableCell::getTextBeforeIndex( sal_Int32 nIndex, sal_Int16 aTextType )
 299     {
 300         SolarMutexGuard aSolarGuard;
 301
 302         return OCommonAccessibleText::getTextBeforeIndex( nIndex ,aTextType);
 303     }
 304     css::accessibility::TextSegment SAL_CALL AccessibleGridControlTableCell::getTextBehindIndex( sal_Int32 nIndex, sal_Int16 aTextType )
 305     {
 306         SolarMutexGuard aSolarGuard;
 307
 308         return OCommonAccessibleText::getTextBehindIndex( nIndex ,aTextType);
 309     }
 310     sal_Bool SAL_CALL AccessibleGridControlTableCell::copyText( sal_Int32 nStartIndex, sal_Int32 nEndIndex )
 311     {
 312         SolarMutexGuard aSolarGuard;
 313
 314         OUString sText = implGetText();
 315         checkIndex_Impl( nStartIndex, sText );
 316         checkIndex_Impl( nEndIndex, sText );
 317
 318         //!!! don't know how to put a string into the clipboard
 319         return false;
 320     }
 321     sal_Bool SAL_CALL AccessibleGridControlTableCell::scrollSubstringTo( sal_Int32, sal_Int32, AccessibleScrollType )
 322     {
 323         return false;
 324     }
 325
 326     tools::Rectangle AccessibleGridControlTableCell::implGetBoundingBox()
 327     {
 328         vcl::Window* pParent = m_aTable.GetAccessibleParentWindow();
 329         DBG_ASSERT( pParent, "implGetBoundingBox - missing parent window" );
 330         tools::Rectangle aGridRect = m_aTable.GetWindowExtentsRelative( pParent );
 331         sal_Int64 nIndex = getAccessibleIndexInParent();
 332         tools::Rectangle aCellRect = m_aTable.calcCellRect(nIndex%m_aTable.GetColumnCount(), nIndex/m_aTable.GetColumnCount());
 333         tools::Long nX = aGridRect.Left() + aCellRect.Left();
 334         tools::Long nY = aGridRect.Top() + aCellRect.Top();
 335         tools::Rectangle aCell( Point( nX, nY ), aCellRect.GetSize());
 336         return aCell;
 337     }
 338
 339     tools::Rectangle AccessibleGridControlTableCell::implGetBoundingBoxOnScreen()
 340     {
 341         tools::Rectangle aGridRect = m_aTable.GetWindowExtentsRelative( nullptr );
 342         sal_Int64 nIndex = getAccessibleIndexInParent();
 343         tools::Rectangle aCellRect = m_aTable.calcCellRect(nIndex%m_aTable.GetColumnCount(), nIndex/m_aTable.GetColumnCount());
 344         tools::Long nX = aGridRect.Left() + aCellRect.Left();
 345         tools::Long nY = aGridRect.Top() + aCellRect.Top();
 346         tools::Rectangle aCell( Point( nX, nY ), aCellRect.GetSize());
 347         return aCell;
 348     }
 349 }
 350
 351 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */