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