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