1
0
Fork 0
libreoffice/sc/source/ui/Accessibility/AccessiblePreviewTable.cxx
Daniel Baumann 8e63e14cf6
Adding upstream version 4:25.2.3.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
2025-06-22 16:20:04 +02:00

640 lines
19 KiB
C++

/* -*- 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 <scitems.hxx>
#include <AccessiblePreviewTable.hxx>
#include <AccessiblePreviewCell.hxx>
#include <AccessiblePreviewHeaderCell.hxx>
#include <prevwsh.hxx>
#include <prevloc.hxx>
#include <attrib.hxx>
#include <document.hxx>
#include <scresid.hxx>
#include <strings.hrc>
#include <strings.hxx>
#include <com/sun/star/accessibility/AccessibleRole.hpp>
#include <com/sun/star/accessibility/AccessibleStateType.hpp>
#include <com/sun/star/accessibility/AccessibleEventId.hpp>
#include <com/sun/star/lang/IndexOutOfBoundsException.hpp>
#include <vcl/window.hxx>
#include <vcl/svapp.hxx>
#include <svl/hint.hxx>
#include <comphelper/sequence.hxx>
using namespace ::com::sun::star;
using namespace ::com::sun::star::accessibility;
//===== internal ============================================================
ScAccessiblePreviewTable::ScAccessiblePreviewTable( const css::uno::Reference<css::accessibility::XAccessible>& rxParent,
ScPreviewShell* pViewShell, sal_Int32 nIndex ) :
ScAccessibleContextBase( rxParent, AccessibleRole::TABLE ),
mpViewShell( pViewShell ),
mnIndex( nIndex )
{
if (mpViewShell)
mpViewShell->AddAccessibilityObject(*this);
}
ScAccessiblePreviewTable::~ScAccessiblePreviewTable()
{
if (!ScAccessibleContextBase::IsDefunc() && !rBHelper.bInDispose)
{
// increment refcount to prevent double call off dtor
osl_atomic_increment( &m_refCount );
dispose();
}
}
void SAL_CALL ScAccessiblePreviewTable::disposing()
{
SolarMutexGuard aGuard;
if (mpViewShell)
{
mpViewShell->RemoveAccessibilityObject(*this);
mpViewShell = nullptr;
}
mpTableInfo.reset();
ScAccessibleContextBase::disposing();
}
//===== SfxListener =====================================================
void ScAccessiblePreviewTable::Notify( SfxBroadcaster& rBC, const SfxHint& rHint )
{
const SfxHintId nId = rHint.GetId();
if ( nId == SfxHintId::DataChanged )
{
// column / row layout may change with any document change,
// so it must be invalidated
mpTableInfo.reset();
}
else if (nId == SfxHintId::ScAccVisAreaChanged)
{
AccessibleEventObject aEvent;
aEvent.EventId = AccessibleEventId::VISIBLE_DATA_CHANGED;
aEvent.Source = uno::Reference< XAccessibleContext >(this);
CommitChange(aEvent);
}
ScAccessibleContextBase::Notify(rBC, rHint);
}
//===== XInterface =====================================================
uno::Any SAL_CALL ScAccessiblePreviewTable::queryInterface( uno::Type const & rType )
{
uno::Any aAny (ScAccessiblePreviewTableImpl::queryInterface(rType));
return aAny.hasValue() ? aAny : ScAccessibleContextBase::queryInterface(rType);
}
void SAL_CALL ScAccessiblePreviewTable::acquire()
noexcept
{
ScAccessibleContextBase::acquire();
}
void SAL_CALL ScAccessiblePreviewTable::release()
noexcept
{
ScAccessibleContextBase::release();
}
//===== XAccessibleTable ================================================
sal_Int32 SAL_CALL ScAccessiblePreviewTable::getAccessibleRowCount()
{
SolarMutexGuard aGuard;
IsObjectValid();
FillTableInfo();
sal_Int32 nRet = 0;
if ( mpTableInfo )
nRet = mpTableInfo->GetRows();
return nRet;
}
sal_Int32 SAL_CALL ScAccessiblePreviewTable::getAccessibleColumnCount()
{
SolarMutexGuard aGuard;
IsObjectValid();
FillTableInfo();
sal_Int32 nRet = 0;
if ( mpTableInfo )
nRet = mpTableInfo->GetCols();
return nRet;
}
OUString SAL_CALL ScAccessiblePreviewTable::getAccessibleRowDescription( sal_Int32 nRow )
{
SolarMutexGuard aGuard;
FillTableInfo();
if ( nRow < 0 || (mpTableInfo && nRow >= mpTableInfo->GetRows()) )
throw lang::IndexOutOfBoundsException();
return OUString();
}
OUString SAL_CALL ScAccessiblePreviewTable::getAccessibleColumnDescription( sal_Int32 nColumn )
{
SolarMutexGuard aGuard;
FillTableInfo();
if ( nColumn < 0 || (mpTableInfo && nColumn >= mpTableInfo->GetCols()) )
throw lang::IndexOutOfBoundsException();
return OUString();
}
sal_Int32 SAL_CALL ScAccessiblePreviewTable::getAccessibleRowExtentAt( sal_Int32 nRow, sal_Int32 nColumn )
{
SolarMutexGuard aGuard;
IsObjectValid();
FillTableInfo();
sal_Int32 nRows = 1;
if ( !mpViewShell || !mpTableInfo || nColumn < 0 || nRow < 0 ||
nColumn >= mpTableInfo->GetCols() || nRow >= mpTableInfo->GetRows() )
throw lang::IndexOutOfBoundsException();
const ScPreviewColRowInfo& rColInfo = mpTableInfo->GetColInfo()[nColumn];
const ScPreviewColRowInfo& rRowInfo = mpTableInfo->GetRowInfo()[nRow];
if ( rColInfo.bIsHeader || rRowInfo.bIsHeader )
{
// header cells only span a single cell
}
else
{
ScDocument& rDoc = mpViewShell->GetDocument();
const ScMergeAttr* pItem = rDoc.GetAttr(
static_cast<SCCOL>(rColInfo.nDocIndex), static_cast<SCROW>(rRowInfo.nDocIndex), mpTableInfo->GetTab(), ATTR_MERGE );
if ( pItem && pItem->GetRowMerge() > 0 )
nRows = pItem->GetRowMerge();
}
return nRows;
}
sal_Int32 SAL_CALL ScAccessiblePreviewTable::getAccessibleColumnExtentAt( sal_Int32 nRow, sal_Int32 nColumn )
{
SolarMutexGuard aGuard;
IsObjectValid();
FillTableInfo();
sal_Int32 nColumns = 1;
if ( !mpViewShell || !mpTableInfo || nColumn < 0 || nRow < 0 ||
nColumn >= mpTableInfo->GetCols() || nRow >= mpTableInfo->GetRows() )
throw lang::IndexOutOfBoundsException();
const ScPreviewColRowInfo& rColInfo = mpTableInfo->GetColInfo()[nColumn];
const ScPreviewColRowInfo& rRowInfo = mpTableInfo->GetRowInfo()[nRow];
if ( rColInfo.bIsHeader || rRowInfo.bIsHeader )
{
// header cells only span a single cell
}
else
{
ScDocument& rDoc = mpViewShell->GetDocument();
const ScMergeAttr* pItem = rDoc.GetAttr(
static_cast<SCCOL>(rColInfo.nDocIndex), static_cast<SCROW>(rRowInfo.nDocIndex), mpTableInfo->GetTab(), ATTR_MERGE );
if ( pItem && pItem->GetColMerge() > 0 )
nColumns = pItem->GetColMerge();
}
return nColumns;
}
uno::Reference< XAccessibleTable > SAL_CALL ScAccessiblePreviewTable::getAccessibleRowHeaders()
{
//! missing
return nullptr;
}
uno::Reference< XAccessibleTable > SAL_CALL ScAccessiblePreviewTable::getAccessibleColumnHeaders()
{
//! missing
return nullptr;
}
uno::Sequence< sal_Int32 > SAL_CALL ScAccessiblePreviewTable::getSelectedAccessibleRows()
{
// in the page preview, there is no selection
return {};
}
uno::Sequence< sal_Int32 > SAL_CALL ScAccessiblePreviewTable::getSelectedAccessibleColumns()
{
// in the page preview, there is no selection
return {};
}
sal_Bool SAL_CALL ScAccessiblePreviewTable::isAccessibleRowSelected( sal_Int32 nRow )
{
// in the page preview, there is no selection
SolarMutexGuard aGuard;
FillTableInfo();
if ( nRow < 0 || (mpTableInfo && nRow >= mpTableInfo->GetRows()) )
throw lang::IndexOutOfBoundsException();
return false;
}
sal_Bool SAL_CALL ScAccessiblePreviewTable::isAccessibleColumnSelected( sal_Int32 nColumn )
{
// in the page preview, there is no selection
SolarMutexGuard aGuard;
FillTableInfo();
if ( nColumn < 0 || (mpTableInfo && nColumn >= mpTableInfo->GetCols()) )
throw lang::IndexOutOfBoundsException();
return false;
}
uno::Reference< XAccessible > SAL_CALL ScAccessiblePreviewTable::getAccessibleCellAt( sal_Int32 nRow, sal_Int32 nColumn )
{
SolarMutexGuard aGuard;
IsObjectValid();
FillTableInfo();
uno::Reference<XAccessible> xRet;
if ( mpTableInfo && nColumn >= 0 && nRow >= 0 && nColumn < mpTableInfo->GetCols() && nRow < mpTableInfo->GetRows() )
{
// index iterates horizontally
tools::Long nNewIndex = nRow * mpTableInfo->GetCols() + nColumn;
const ScPreviewColRowInfo& rColInfo = mpTableInfo->GetColInfo()[nColumn];
const ScPreviewColRowInfo& rRowInfo = mpTableInfo->GetRowInfo()[nRow];
ScAddress aCellPos( static_cast<SCCOL>(rColInfo.nDocIndex), static_cast<SCROW>(rRowInfo.nDocIndex), mpTableInfo->GetTab() );
if ( rColInfo.bIsHeader || rRowInfo.bIsHeader )
{
const bool bRotatedColHeader = rRowInfo.bIsHeader;
const bool bRotatedRowHeader = rColInfo.bIsHeader;
rtl::Reference<ScAccessiblePreviewHeaderCell> pHeaderCell(new ScAccessiblePreviewHeaderCell(this, mpViewShell, aCellPos,
bRotatedColHeader, bRotatedRowHeader, nNewIndex));
xRet = pHeaderCell.get();
pHeaderCell->Init();
}
else
{
rtl::Reference<ScAccessiblePreviewCell> pCell(new ScAccessiblePreviewCell( this, mpViewShell, aCellPos, nNewIndex ));
xRet = pCell.get();
pCell->Init();
}
}
if ( !xRet.is() )
throw lang::IndexOutOfBoundsException();
return xRet;
}
uno::Reference< XAccessible > SAL_CALL ScAccessiblePreviewTable::getAccessibleCaption()
{
//! missing
return nullptr;
}
uno::Reference< XAccessible > SAL_CALL ScAccessiblePreviewTable::getAccessibleSummary()
{
//! missing
return nullptr;
}
sal_Bool SAL_CALL ScAccessiblePreviewTable::isAccessibleSelected( sal_Int32 nRow, sal_Int32 nColumn )
{
// in the page preview, there is no selection
SolarMutexGuard aGuard;
IsObjectValid();
FillTableInfo();
if ( !mpTableInfo || nColumn < 0 || nRow < 0 || nColumn >= mpTableInfo->GetCols() || nRow >= mpTableInfo->GetRows() )
throw lang::IndexOutOfBoundsException();
// index iterates horizontally
return false;
}
sal_Int64 SAL_CALL ScAccessiblePreviewTable::getAccessibleIndex( sal_Int32 nRow, sal_Int32 nColumn )
{
SolarMutexGuard aGuard;
IsObjectValid();
FillTableInfo();
if ( !mpTableInfo || nColumn < 0 || nRow < 0 || nColumn >= mpTableInfo->GetCols() || nRow >= mpTableInfo->GetRows() )
throw lang::IndexOutOfBoundsException();
// index iterates horizontally
sal_Int64 nRet = static_cast<sal_Int64>(nRow) * static_cast<sal_Int64>(mpTableInfo->GetCols()) + nColumn;
return nRet;
}
sal_Int32 SAL_CALL ScAccessiblePreviewTable::getAccessibleRow( sal_Int64 nChildIndex )
{
SolarMutexGuard aGuard;
IsObjectValid();
FillTableInfo();
if ( !mpTableInfo || nChildIndex < 0 || nChildIndex >= static_cast<sal_Int64>(mpTableInfo->GetRows()) * mpTableInfo->GetCols() )
throw lang::IndexOutOfBoundsException();
sal_Int32 nRow = nChildIndex / mpTableInfo->GetCols();
return nRow;
}
sal_Int32 SAL_CALL ScAccessiblePreviewTable::getAccessibleColumn( sal_Int64 nChildIndex )
{
SolarMutexGuard aGuard;
IsObjectValid();
FillTableInfo();
if ( !mpTableInfo || nChildIndex < 0 || nChildIndex >= static_cast<sal_Int64>(mpTableInfo->GetRows()) * mpTableInfo->GetCols() )
throw lang::IndexOutOfBoundsException();
sal_Int32 nCol = nChildIndex % static_cast<sal_Int32>(mpTableInfo->GetCols());
return nCol;
}
//===== XAccessibleComponent ============================================
uno::Reference< XAccessible > SAL_CALL ScAccessiblePreviewTable::getAccessibleAtPoint( const awt::Point& aPoint )
{
uno::Reference<XAccessible> xRet;
if (containsPoint(aPoint))
{
SolarMutexGuard aGuard;
IsObjectValid();
FillTableInfo();
if ( mpTableInfo )
{
SCCOL nCols = mpTableInfo->GetCols();
SCROW nRows = mpTableInfo->GetRows();
const ScPreviewColRowInfo* pColInfo = mpTableInfo->GetColInfo();
const ScPreviewColRowInfo* pRowInfo = mpTableInfo->GetRowInfo();
tools::Rectangle aScreenRect(GetBoundingBox());
awt::Point aMovedPoint = aPoint;
aMovedPoint.X += aScreenRect.Left();
aMovedPoint.Y += aScreenRect.Top();
if ( nCols > 0 && nRows > 0 && aMovedPoint.X >= pColInfo[0].nPixelStart && aMovedPoint.Y >= pRowInfo[0].nPixelStart )
{
SCCOL nColIndex = 0;
while ( nColIndex < nCols && aMovedPoint.X > pColInfo[nColIndex].nPixelEnd )
++nColIndex;
SCROW nRowIndex = 0;
while ( nRowIndex < nRows && aMovedPoint.Y > pRowInfo[nRowIndex].nPixelEnd )
++nRowIndex;
if ( nColIndex < nCols && nRowIndex < nRows )
{
try
{
xRet = getAccessibleCellAt( nRowIndex, nColIndex );
}
catch (uno::Exception&)
{
}
}
}
}
}
return xRet;
}
void SAL_CALL ScAccessiblePreviewTable::grabFocus()
{
SolarMutexGuard aGuard;
IsObjectValid();
if (getAccessibleParent().is())
{
uno::Reference<XAccessibleComponent> xAccessibleComponent(getAccessibleParent()->getAccessibleContext(), uno::UNO_QUERY);
if (xAccessibleComponent.is())
xAccessibleComponent->grabFocus();
}
}
//===== XAccessibleContext ==============================================
sal_Int64 SAL_CALL ScAccessiblePreviewTable::getAccessibleChildCount()
{
SolarMutexGuard aGuard;
IsObjectValid();
FillTableInfo();
tools::Long nRet = 0;
if ( mpTableInfo )
nRet = static_cast<sal_Int64>(mpTableInfo->GetCols()) * mpTableInfo->GetRows();
return nRet;
}
uno::Reference< XAccessible > SAL_CALL ScAccessiblePreviewTable::getAccessibleChild( sal_Int64 nIndex )
{
SolarMutexGuard aGuard;
IsObjectValid();
FillTableInfo();
uno::Reference<XAccessible> xRet;
if ( mpTableInfo )
{
sal_Int32 nColumns = mpTableInfo->GetCols();
if ( nColumns > 0 )
{
// nCol, nRow are within the visible table, not the document
sal_Int32 nCol = nIndex % nColumns;
sal_Int64 nRow = nIndex / nColumns;
assert(nRow <= std::numeric_limits<sal_Int32>::max());
xRet = getAccessibleCellAt( nRow, nCol );
}
}
if ( !xRet.is() )
throw lang::IndexOutOfBoundsException();
return xRet;
}
sal_Int64 SAL_CALL ScAccessiblePreviewTable::getAccessibleIndexInParent()
{
return mnIndex;
}
sal_Int64 SAL_CALL ScAccessiblePreviewTable::getAccessibleStateSet()
{
SolarMutexGuard aGuard;
sal_Int64 nParentStates = 0;
if (getAccessibleParent().is())
{
uno::Reference<XAccessibleContext> xParentContext = getAccessibleParent()->getAccessibleContext();
nParentStates = xParentContext->getAccessibleStateSet();
}
sal_Int64 nStateSet = 0;
if (IsDefunc(nParentStates))
nStateSet |= AccessibleStateType::DEFUNC;
else
{
nStateSet |= AccessibleStateType::MANAGES_DESCENDANTS;
nStateSet |= AccessibleStateType::ENABLED;
nStateSet |= AccessibleStateType::OPAQUE;
if (isShowing())
nStateSet |= AccessibleStateType::SHOWING;
if (isVisible())
nStateSet |= AccessibleStateType::VISIBLE;
}
return nStateSet;
}
//===== XServiceInfo ====================================================
OUString SAL_CALL ScAccessiblePreviewTable::getImplementationName()
{
return u"ScAccessiblePreviewTable"_ustr;
}
uno::Sequence<OUString> SAL_CALL ScAccessiblePreviewTable::getSupportedServiceNames()
{
uno::Sequence< OUString > aSequence = ScAccessibleContextBase::getSupportedServiceNames();
sal_Int32 nOldSize(aSequence.getLength());
aSequence.realloc(nOldSize + 1);
aSequence.getArray()[nOldSize] = "com.sun.star.table.AccessibleTableView";
return aSequence;
}
//===== XTypeProvider ===================================================
uno::Sequence< uno::Type > SAL_CALL ScAccessiblePreviewTable::getTypes()
{
return comphelper::concatSequences(ScAccessiblePreviewTableImpl::getTypes(), ScAccessibleContextBase::getTypes());
}
uno::Sequence<sal_Int8> SAL_CALL ScAccessiblePreviewTable::getImplementationId()
{
return css::uno::Sequence<sal_Int8>();
}
//==== internal =========================================================
OUString ScAccessiblePreviewTable::createAccessibleDescription()
{
return STR_ACC_TABLE_DESCR;
}
OUString ScAccessiblePreviewTable::createAccessibleName()
{
OUString sName(ScResId(STR_ACC_TABLE_NAME));
if (mpViewShell)
{
FillTableInfo();
if ( mpTableInfo )
{
OUString sCoreName;
if (mpViewShell->GetDocument().GetName( mpTableInfo->GetTab(), sCoreName ))
sName = sName.replaceFirst("%1", sCoreName);
}
}
return sName;
}
AbsoluteScreenPixelRectangle ScAccessiblePreviewTable::GetBoundingBoxOnScreen() const
{
tools::Rectangle aCellRect(GetBoundingBox());
if (mpViewShell)
{
vcl::Window* pWindow = mpViewShell->GetWindow();
if (pWindow)
{
AbsoluteScreenPixelRectangle aRect = pWindow->GetWindowExtentsAbsolute();
aCellRect.Move(aRect.Left(), aRect.Top());
}
}
return AbsoluteScreenPixelRectangle(aCellRect);
}
tools::Rectangle ScAccessiblePreviewTable::GetBoundingBox() const
{
FillTableInfo();
tools::Rectangle aRect;
if ( mpTableInfo )
{
SCCOL nColumns = mpTableInfo->GetCols();
SCROW nRows = mpTableInfo->GetRows();
if ( nColumns > 0 && nRows > 0 )
{
const ScPreviewColRowInfo* pColInfo = mpTableInfo->GetColInfo();
const ScPreviewColRowInfo* pRowInfo = mpTableInfo->GetRowInfo();
aRect = tools::Rectangle( pColInfo[0].nPixelStart,
pRowInfo[0].nPixelStart,
pColInfo[nColumns-1].nPixelEnd,
pRowInfo[nRows-1].nPixelEnd );
}
}
return aRect;
}
bool ScAccessiblePreviewTable::IsDefunc( sal_Int64 nParentStates )
{
return ScAccessibleContextBase::IsDefunc() || (mpViewShell == nullptr) || !getAccessibleParent().is() ||
(nParentStates & AccessibleStateType::DEFUNC);
}
void ScAccessiblePreviewTable::FillTableInfo() const
{
if ( mpViewShell && !mpTableInfo )
{
Size aOutputSize;
vcl::Window* pWindow = mpViewShell->GetWindow();
if ( pWindow )
aOutputSize = pWindow->GetOutputSizePixel();
tools::Rectangle aVisRect( Point(), aOutputSize );
mpTableInfo.reset( new ScPreviewTableInfo );
mpViewShell->GetLocationData().GetTableInfo( aVisRect, *mpTableInfo );
}
}
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */