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