odfstudio/toolkit/source/controls/table/AccessibleGridControlTableCell.cxx

/* -*- 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 <controls/table/AccessibleGridControlTable.hxx>
#include <controls/table/AccessibleGridControlTableCell.hxx>
#include <vcl/svapp.hxx>
#include <vcl/unohelp.hxx>
#include <tools/gen.hxx>
#include <tools/debug.hxx>
#include <com/sun/star/accessibility/AccessibleStateType.hpp>
#include <com/sun/star/lang/IndexOutOfBoundsException.hpp>

namespace accessibility
{
namespace
{
// FIXME this is a copy'n'paste from
// source/accessibility/AccessibleBrowseBoxTableCell.cxx, get rid of that...
/// @throws css::lang::IndexOutOfBoundsException
void checkIndex_Impl(sal_Int32 _nIndex, std::u16string_view _sText)
{
    if (_nIndex >= static_cast<sal_Int32>(_sText.size()))
        throw css::lang::IndexOutOfBoundsException();
}
}
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;
using namespace ::vcl;

// = AccessibleGridControlCell

AccessibleGridControlCell::AccessibleGridControlCell(
    const rtl::Reference<comphelper::OAccessible>& rpParent, svt::table::TableControl& _rTable,
    sal_Int32 _nRowPos, sal_uInt16 _nColPos, AccessibleTableControlObjType _eType)
    : AccessibleGridControlBase(rpParent, _rTable, _eType)
    , m_nRowPos(_nRowPos)
    , m_nColPos(_nColPos)
{
    assert(((m_eObjType == AccessibleTableControlObjType::TABLECELL)
            || ((m_eObjType == AccessibleTableControlObjType::ROWHEADERCELL) && _nColPos == 0)
            || ((m_eObjType == AccessibleTableControlObjType::COLUMNHEADERCELL) && _nRowPos == 0))
           && "Unhandled table cell type");
}

void SAL_CALL AccessibleGridControlCell::grabFocus()
{
    SolarMutexGuard aSolarGuard;

    m_rTable.GoToCell(m_nColPos, m_nRowPos);
}

OUString SAL_CALL AccessibleGridControlCell::getAccessibleName()
{
    SolarMutexGuard g;

    ensureAlive();
    return m_rTable.GetAccessibleObjectName(m_eObjType, m_nRowPos, m_nColPos);
}

// implementation of a table cell
OUString AccessibleGridControlTableCell::implGetText()
{
    ensureAlive();
    return m_rTable.GetAccessibleCellText(getRowPos(), getColumnPos());
}

css::lang::Locale AccessibleGridControlTableCell::implGetLocale()
{
    ensureAlive();
    return m_rTable.GetAccessible()->getLocale();
}

void AccessibleGridControlTableCell::implGetSelection(sal_Int32& nStartIndex, sal_Int32& nEndIndex)
{
    nStartIndex = 0;
    nEndIndex = 0;
}

AccessibleGridControlTableCell::AccessibleGridControlTableCell(
    const rtl::Reference<AccessibleGridControlTable>& rpParent, svt::table::TableControl& _rTable,
    sal_Int32 _nRowPos, sal_uInt16 _nColPos)
    : ImplInheritanceHelper(rpParent, _rTable, _nRowPos, _nColPos,
                            AccessibleTableControlObjType::TABLECELL)
{
}

css::awt::Rectangle SAL_CALL AccessibleGridControlTableCell::getCharacterBounds(sal_Int32 nIndex)
{
    SolarMutexGuard aSolarGuard;

    ensureAlive();
    if (!implIsValidIndex(nIndex, implGetText().getLength()))
        throw IndexOutOfBoundsException();

    return vcl::unohelper::ConvertToAWTRect(m_rTable.GetCharacterBounds(nIndex));
}

sal_Int32 SAL_CALL AccessibleGridControlTableCell::getIndexAtPoint(const css::awt::Point& _aPoint)
{
    SolarMutexGuard aSolarGuard;

    ensureAlive();

    return m_rTable.GetIndexForPoint(vcl::unohelper::ConvertToVCLPoint(_aPoint));
}

/** @return  The count of visible children. */
sal_Int64 SAL_CALL AccessibleGridControlTableCell::getAccessibleChildCount() { return 0; }

/** @return  The css::accessibility::XAccessible interface of the specified child. */
css::uno::Reference<css::accessibility::XAccessible>
    SAL_CALL AccessibleGridControlTableCell::getAccessibleChild(sal_Int64)
{
    throw css::lang::IndexOutOfBoundsException();
}

/** Return a bitset of states of the current object.
    */
sal_Int64 AccessibleGridControlTableCell::implCreateStateSet()
{
    sal_Int64 nStateSet = 0;

    if (isAlive())
    {
        // SHOWING done with mxParent
        if (implIsShowing())
            nStateSet |= AccessibleStateType::SHOWING;

        m_rTable.FillAccessibleStateSetForCell(nStateSet, getRowPos(),
                                               static_cast<sal_uInt16>(getColumnPos()));
    }
    else
        nStateSet |= AccessibleStateType::DEFUNC;

    return nStateSet;
}

// css::accessibility::XAccessibleContext

sal_Int64 SAL_CALL AccessibleGridControlTableCell::getAccessibleIndexInParent()
{
    SolarMutexGuard aSolarGuard;

    ensureAlive();

    return (static_cast<sal_Int64>(getRowPos()) * static_cast<sal_Int64>(m_rTable.GetColumnCount()))
           + getColumnPos();
}

sal_Int32 SAL_CALL AccessibleGridControlTableCell::getCaretPosition() { return -1; }
sal_Bool SAL_CALL AccessibleGridControlTableCell::setCaretPosition(sal_Int32 nIndex)
{
    SolarMutexGuard aSolarGuard;

    if (!implIsValidRange(nIndex, nIndex, implGetText().getLength()))
        throw IndexOutOfBoundsException();

    return false;
}
sal_Unicode SAL_CALL AccessibleGridControlTableCell::getCharacter(sal_Int32 nIndex)
{
    SolarMutexGuard aSolarGuard;

    return OCommonAccessibleText::implGetCharacter(implGetText(), nIndex);
}
css::uno::Sequence<css::beans::PropertyValue> SAL_CALL
AccessibleGridControlTableCell::getCharacterAttributes(sal_Int32 nIndex,
                                                       const css::uno::Sequence<OUString>&)
{
    SolarMutexGuard aSolarGuard;

    OUString sText(implGetText());

    if (!implIsValidIndex(nIndex, sText.getLength()))
        throw IndexOutOfBoundsException();

    return css::uno::Sequence<css::beans::PropertyValue>();
}
sal_Int32 SAL_CALL AccessibleGridControlTableCell::getCharacterCount()
{
    SolarMutexGuard aSolarGuard;

    return implGetText().getLength();
}

OUString SAL_CALL AccessibleGridControlTableCell::getSelectedText() { return OUString(); }
sal_Int32 SAL_CALL AccessibleGridControlTableCell::getSelectionStart() { return 0; }
sal_Int32 SAL_CALL AccessibleGridControlTableCell::getSelectionEnd() { return 0; }
sal_Bool SAL_CALL AccessibleGridControlTableCell::setSelection(sal_Int32 nStartIndex,
                                                               sal_Int32 nEndIndex)
{
    SolarMutexGuard aSolarGuard;

    if (!implIsValidRange(nStartIndex, nEndIndex, implGetText().getLength()))
        throw IndexOutOfBoundsException();

    return false;
}
OUString SAL_CALL AccessibleGridControlTableCell::getText()
{
    SolarMutexGuard aSolarGuard;

    return implGetText();
}
OUString SAL_CALL AccessibleGridControlTableCell::getTextRange(sal_Int32 nStartIndex,
                                                               sal_Int32 nEndIndex)
{
    SolarMutexGuard aSolarGuard;

    return OCommonAccessibleText::implGetTextRange(implGetText(), nStartIndex, nEndIndex);
}
css::accessibility::TextSegment SAL_CALL
AccessibleGridControlTableCell::getTextAtIndex(sal_Int32 nIndex, sal_Int16 aTextType)
{
    SolarMutexGuard aSolarGuard;

    return OCommonAccessibleText::getTextAtIndex(nIndex, aTextType);
}
css::accessibility::TextSegment SAL_CALL
AccessibleGridControlTableCell::getTextBeforeIndex(sal_Int32 nIndex, sal_Int16 aTextType)
{
    SolarMutexGuard aSolarGuard;

    return OCommonAccessibleText::getTextBeforeIndex(nIndex, aTextType);
}
css::accessibility::TextSegment SAL_CALL
AccessibleGridControlTableCell::getTextBehindIndex(sal_Int32 nIndex, sal_Int16 aTextType)
{
    SolarMutexGuard aSolarGuard;

    return OCommonAccessibleText::getTextBehindIndex(nIndex, aTextType);
}
sal_Bool SAL_CALL AccessibleGridControlTableCell::copyText(sal_Int32 nStartIndex,
                                                           sal_Int32 nEndIndex)
{
    SolarMutexGuard aSolarGuard;

    OUString sText = implGetText();
    checkIndex_Impl(nStartIndex, sText);
    checkIndex_Impl(nEndIndex, sText);

    //!!! don't know how to put a string into the clipboard
    return false;
}
sal_Bool SAL_CALL AccessibleGridControlTableCell::scrollSubstringTo(sal_Int32, sal_Int32,
                                                                    AccessibleScrollType)
{
    return false;
}

AbsoluteScreenPixelRectangle AccessibleGridControlTableCell::implGetBoundingBoxOnScreen()
{
    AbsoluteScreenPixelRectangle aGridRect = m_rTable.GetWindowExtentsAbsolute();
    tools::Rectangle aCellRect = m_rTable.calcCellRect(getRowPos(), getColumnPos());
    tools::Long nX = aGridRect.Left() + aCellRect.Left();
    tools::Long nY = aGridRect.Top() + aCellRect.Top();
    AbsoluteScreenPixelRectangle aCell(AbsoluteScreenPixelPoint(nX, nY), aCellRect.GetSize());
    return aCell;
}
}

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */