AccessibleBrowseBoxTableCell.cxx

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
 
 
#include <extended/AccessibleBrowseBoxTableCell.hxx>
#include <toolkit/helper/convert.hxx>
#include <vcl/accessibletableprovider.hxx>
#include <com/sun/star/accessibility/AccessibleStateType.hpp>
#include <com/sun/star/lang/IndexOutOfBoundsException.hpp>
 
namespace accessibility
{
    namespace
    {
        void checkIndex_Impl( sal_Int32 _nIndex, std::u16string_view _sText )
        {
            if ( _nIndex >= static_cast<sal_Int32>(_sText.size()) )
                throw css::lang::IndexOutOfBoundsException();
        }
 
        sal_Int32 getIndex_Impl( sal_Int32 _nRow, sal_uInt16 _nColumn, sal_uInt16 _nColumnCount )
        {
            return _nRow * _nColumnCount + _nColumn;
        }
    }
    using namespace ::com::sun::star::lang;
    using namespace comphelper;
    using namespace ::com::sun::star::uno;
    using ::com::sun::star::accessibility::XAccessible;
    using namespace ::com::sun::star::accessibility;
 
 
    // implementation of a table cell
    OUString AccessibleBrowseBoxTableCell::implGetText()
    {
        return mpBrowseBox->GetAccessibleCellText( getRowPos(), static_cast< sal_uInt16 >( getColumnPos() ) );
    }
 
    css::lang::Locale AccessibleBrowseBoxTableCell::implGetLocale()
    {
        return mpBrowseBox->GetAccessible()->getAccessibleContext()->getLocale();
    }
 
    void AccessibleBrowseBoxTableCell::implGetSelection( sal_Int32& nStartIndex, sal_Int32& nEndIndex )
    {
        nStartIndex = 0;
        nEndIndex = 0;
    }
 
    AccessibleBrowseBoxTableCell::AccessibleBrowseBoxTableCell(const Reference<XAccessible >& _rxParent,
                                vcl::IAccessibleTableProvider& _rBrowseBox,
                                const css::uno::Reference< css::awt::XWindow >& _xFocusWindow,
                                sal_Int32 _nRowPos,
                                sal_uInt16 _nColPos,
                                sal_Int32 _nOffset )
        :AccessibleBrowseBoxCell( _rxParent, _rBrowseBox, _xFocusWindow, _nRowPos, _nColPos )
    {
        m_nOffset = ( _nOffset == OFFSET_DEFAULT ) ? sal_Int32(vcl::BBINDEX_FIRSTCONTROL) : _nOffset;
        sal_Int32 nIndex = getIndex_Impl( _nRowPos, _nColPos, _rBrowseBox.GetColumnCount() );
        setAccessibleName( _rBrowseBox.GetAccessibleObjectName( AccessibleBrowseBoxObjType::TableCell, nIndex ) );
        setAccessibleDescription( _rBrowseBox.GetAccessibleObjectDescription( AccessibleBrowseBoxObjType::TableCell, nIndex ) );
        // Need to register as event listener
        Reference< XComponent > xComponent(_rxParent, UNO_QUERY);
        if( xComponent.is() )
            xComponent->addEventListener(static_cast< XEventListener *> (this));
    }
 
    // XInterface -------------------------------------------------------------
 
    css::uno::Any SAL_CALL AccessibleBrowseBoxTableCell::queryInterface( const css::uno::Type& rType )
    {
        Any aRet = AccessibleBrowseBoxCell::queryInterface(rType);
        if ( !aRet.hasValue() )
            aRet = AccessibleTextHelper_BASE::queryInterface(rType);
        return aRet;
    }
 
    void SAL_CALL AccessibleBrowseBoxTableCell::acquire() noexcept
    {
        AccessibleBrowseBoxCell::acquire();
    }
 
    void SAL_CALL AccessibleBrowseBoxTableCell::release() noexcept
    {
        AccessibleBrowseBoxCell::release();
    }
 
    css::awt::Rectangle SAL_CALL AccessibleBrowseBoxTableCell::getCharacterBounds( sal_Int32 nIndex )
    {
        SolarMethodGuard aGuard(getMutex());
        ensureIsAlive();
 
        css::awt::Rectangle aRect;
 
        if ( mpBrowseBox )
        {
            if ( !implIsValidIndex( nIndex, implGetText().getLength() ) )
                throw IndexOutOfBoundsException();
 
            aRect = AWTRectangle( mpBrowseBox->GetFieldCharacterBounds( getRowPos(), getColumnPos(), nIndex ) );
        }
 
        return aRect;
    }
 
    sal_Int32 SAL_CALL AccessibleBrowseBoxTableCell::getIndexAtPoint( const css::awt::Point& _aPoint )
    {
        // OSL_FAIL("Need to be done by base class!");
        SolarMethodGuard aGuard(getMutex());
        ensureIsAlive();
 
        return mpBrowseBox->GetFieldIndexAtPoint( getRowPos(), getColumnPos(), VCLPoint( _aPoint ) );
    }
 
    OUString SAL_CALL AccessibleBrowseBoxTableCell::getImplementationName()
    {
        return "com.sun.star.comp.svtools.AccessibleBrowseBoxTableCell";
    }
 
    sal_Int64 SAL_CALL AccessibleBrowseBoxTableCell::getAccessibleChildCount()
    {
        return 0;
    }
 
    css::uno::Reference< css::accessibility::XAccessible > SAL_CALL
        AccessibleBrowseBoxTableCell::getAccessibleChild( sal_Int64 )
    {
        throw css::lang::IndexOutOfBoundsException();
    }
 
    sal_Int64 AccessibleBrowseBoxTableCell::implCreateStateSet()
    {
        SolarMethodGuard aGuard(getMutex());
 
        sal_Int64 nStateSet = 0;
 
        if( isAlive() )
        {
            // SHOWING done with mxParent
            if( implIsShowing() )
                nStateSet |= AccessibleStateType::SHOWING;
 
            mpBrowseBox->FillAccessibleStateSetForCell( nStateSet, getRowPos(), static_cast< sal_uInt16 >( getColumnPos() ) );
        }
        else
            nStateSet |= AccessibleStateType::DEFUNC;
 
        return nStateSet;
    }
 
 
    // XAccessible ------------------------------------------------------------
 
    Reference< XAccessibleContext > SAL_CALL AccessibleBrowseBoxTableCell::getAccessibleContext()
    {
        osl::MutexGuard aGuard( getMutex() );
        ensureIsAlive();
        return this;
    }
 
    // XAccessibleContext -----------------------------------------------------
 
    sal_Int64 SAL_CALL AccessibleBrowseBoxTableCell::getAccessibleIndexInParent()
    {
        SolarMethodGuard aGuard(getMutex());
        ensureIsAlive();
 
        return /*vcl::BBINDEX_FIRSTCONTROL*/ m_nOffset + (static_cast<sal_Int64>(getRowPos()) * static_cast<sal_Int64>(mpBrowseBox->GetColumnCount())) + getColumnPos();
    }
 
    sal_Int32 SAL_CALL AccessibleBrowseBoxTableCell::getCaretPosition(  )
    {
        return -1;
    }
 
    sal_Bool SAL_CALL AccessibleBrowseBoxTableCell::setCaretPosition ( sal_Int32 nIndex )
    {
        SolarMethodGuard aGuard(getMutex());
        ensureIsAlive();
 
        if ( !implIsValidRange( nIndex, nIndex, implGetText().getLength() ) )
            throw IndexOutOfBoundsException();
 
        return false;
    }
    sal_Unicode SAL_CALL AccessibleBrowseBoxTableCell::getCharacter( sal_Int32 nIndex )
    {
        SolarMethodGuard aGuard(getMutex());
        ensureIsAlive();
 
        return OCommonAccessibleText::implGetCharacter( implGetText(), nIndex );
    }
    css::uno::Sequence< css::beans::PropertyValue > SAL_CALL AccessibleBrowseBoxTableCell::getCharacterAttributes( sal_Int32 nIndex, const css::uno::Sequence< OUString >& )
    {
        SolarMethodGuard aGuard(getMutex());
        ensureIsAlive();
 
        OUString sText( implGetText() );
 
        if ( !implIsValidIndex( nIndex, sText.getLength() ) )
            throw IndexOutOfBoundsException();
 
        return css::uno::Sequence< css::beans::PropertyValue >();
    }
    sal_Int32 SAL_CALL AccessibleBrowseBoxTableCell::getCharacterCount(  )
    {
        SolarMethodGuard aGuard(getMutex());
        ensureIsAlive();
 
        return implGetText().getLength();
    }
 
    OUString SAL_CALL AccessibleBrowseBoxTableCell::getSelectedText(  )
    {
        SolarMethodGuard aGuard(getMutex());
        ensureIsAlive();
 
        return OCommonAccessibleText::getSelectedText(  );
    }
    sal_Int32 SAL_CALL AccessibleBrowseBoxTableCell::getSelectionStart(  )
    {
        SolarMethodGuard aGuard(getMutex());
        ensureIsAlive();
 
        return OCommonAccessibleText::getSelectionStart(  );
    }
    sal_Int32 SAL_CALL AccessibleBrowseBoxTableCell::getSelectionEnd(  )
    {
        SolarMethodGuard aGuard(getMutex());
        ensureIsAlive();
 
        return OCommonAccessibleText::getSelectionEnd(  );
    }
    sal_Bool SAL_CALL AccessibleBrowseBoxTableCell::setSelection( sal_Int32 nStartIndex, sal_Int32 nEndIndex )
    {
        SolarMethodGuard aGuard(getMutex());
        ensureIsAlive();
 
        if ( !implIsValidRange( nStartIndex, nEndIndex, implGetText().getLength() ) )
            throw IndexOutOfBoundsException();
 
        return false;
    }
    OUString SAL_CALL AccessibleBrowseBoxTableCell::getText(  )
    {
        SolarMethodGuard aGuard(getMutex());
        ensureIsAlive();
 
        return implGetText(  );
    }
    OUString SAL_CALL AccessibleBrowseBoxTableCell::getTextRange( sal_Int32 nStartIndex, sal_Int32 nEndIndex )
    {
        SolarMethodGuard aGuard(getMutex());
        ensureIsAlive();
 
        return OCommonAccessibleText::implGetTextRange( implGetText(), nStartIndex, nEndIndex );
    }
    css::accessibility::TextSegment SAL_CALL AccessibleBrowseBoxTableCell::getTextAtIndex( sal_Int32 nIndex, sal_Int16 aTextType )
    {
        SolarMethodGuard aGuard(getMutex());
        ensureIsAlive();
 
        return OCommonAccessibleText::getTextAtIndex( nIndex ,aTextType);
    }
    css::accessibility::TextSegment SAL_CALL AccessibleBrowseBoxTableCell::getTextBeforeIndex( sal_Int32 nIndex, sal_Int16 aTextType )
    {
        SolarMethodGuard aGuard(getMutex());
        ensureIsAlive();
 
        return OCommonAccessibleText::getTextBeforeIndex( nIndex ,aTextType);
    }
    css::accessibility::TextSegment SAL_CALL AccessibleBrowseBoxTableCell::getTextBehindIndex( sal_Int32 nIndex, sal_Int16 aTextType )
    {
        SolarMethodGuard aGuard(getMutex());
        ensureIsAlive();
 
        return OCommonAccessibleText::getTextBehindIndex( nIndex ,aTextType);
    }
    sal_Bool SAL_CALL AccessibleBrowseBoxTableCell::copyText( sal_Int32 nStartIndex, sal_Int32 nEndIndex )
    {
        SolarMethodGuard aGuard(getMutex());
        ensureIsAlive();
 
        OUString sText = implGetText();
        checkIndex_Impl( nStartIndex, sText );
        checkIndex_Impl( nEndIndex, sText );
 
        return false;
    }
    sal_Bool SAL_CALL AccessibleBrowseBoxTableCell::scrollSubstringTo( sal_Int32, sal_Int32, AccessibleScrollType )
    {
        return false;
    }
    void AccessibleBrowseBoxTableCell::disposing( const EventObject& _rSource )
    {
            if ( _rSource.Source == mxParent )
            {
                dispose();
            }
    }
 
}
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */