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