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