diff options
Diffstat (limited to 'sc/source/ui/inc/AccessibleTableBase.hxx')
| -rw-r--r-- | sc/source/ui/inc/AccessibleTableBase.hxx | 234 |
1 files changed, 234 insertions, 0 deletions
diff --git a/sc/source/ui/inc/AccessibleTableBase.hxx b/sc/source/ui/inc/AccessibleTableBase.hxx new file mode 100644 index 000000000..a9b56ff68 --- /dev/null +++ b/sc/source/ui/inc/AccessibleTableBase.hxx @@ -0,0 +1,234 @@ +/* -*- 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 . + */ + +#pragma once + +#include "AccessibleContextBase.hxx" +#include <address.hxx> +#include <com/sun/star/accessibility/XAccessibleTable.hpp> +#include <com/sun/star/accessibility/XAccessibleSelection.hpp> +#include <com/sun/star/accessibility/XAccessibleTableSelection.hpp> +#include <cppuhelper/implbase2.hxx> + +/** @descr + This base class provides an implementation of the + <code>AccessibleTable</code> service. +*/ + +typedef cppu::ImplHelper2< css::accessibility::XAccessibleTable, + css::accessibility::XAccessibleSelection> + ScAccessibleTableBaseImpl; + +class ScAccessibleTableBase : + public ScAccessibleContextBase, + public css::accessibility::XAccessibleTableSelection, + public ScAccessibleTableBaseImpl +{ +public: + //===== internal ======================================================== + ScAccessibleTableBase( + const css::uno::Reference<css::accessibility::XAccessible>& rxParent, + ScDocument* pDoc, + const ScRange& rRange); +protected: + virtual ~ScAccessibleTableBase() override; +public: + + using ScAccessibleContextBase::disposing; + virtual void SAL_CALL disposing() override; + + ///===== XInterface ===================================================== + + virtual css::uno::Any SAL_CALL queryInterface( + css::uno::Type const & rType ) override; + + virtual void SAL_CALL acquire() noexcept override; + + virtual void SAL_CALL release() noexcept override; + + ///===== XAccessibleTable ================================================ + + /// Returns the number of rows in the table. + virtual sal_Int32 SAL_CALL + getAccessibleRowCount( ) override; + + /// Returns the number of columns in the table. + virtual sal_Int32 SAL_CALL + getAccessibleColumnCount( ) override; + + /// Returns the description of the specified row in the table. + virtual OUString SAL_CALL + getAccessibleRowDescription( sal_Int32 nRow ) override; + + /// Returns the description text of the specified column in the table. + virtual OUString SAL_CALL + getAccessibleColumnDescription( sal_Int32 nColumn ) override; + + /** Returns the number of rows occupied by the Accessible at a specified row and column in the table. + Returns 1 if it is only a cell and the number of rows the cell is merged if the cell is a merged cell. + */ + virtual sal_Int32 SAL_CALL + getAccessibleRowExtentAt( sal_Int32 nRow, sal_Int32 nColumn ) override; + + /** Returns the number of columns occupied by the Accessible at a specified row and column in the table. + Returns 1 if it is only a cell and the number of columns the cell is merged if the cell is a merged cell. + */ + virtual sal_Int32 SAL_CALL + getAccessibleColumnExtentAt( sal_Int32 nRow, sal_Int32 nColumn ) override; + + /// Returns the row headers as an AccessibleTable. + virtual css::uno::Reference< css::accessibility::XAccessibleTable > SAL_CALL + getAccessibleRowHeaders( ) override; + + /// Returns the column headers as an AccessibleTable. + virtual css::uno::Reference< css::accessibility::XAccessibleTable > SAL_CALL + getAccessibleColumnHeaders( ) override; + + /// Returns the selected rows in a table. + virtual css::uno::Sequence< sal_Int32 > SAL_CALL + getSelectedAccessibleRows( ) override; + + /// Returns the selected columns in a table. + virtual css::uno::Sequence< sal_Int32 > SAL_CALL + getSelectedAccessibleColumns( ) override; + + /// Returns a boolean value indicating whether the specified row is selected. + virtual sal_Bool SAL_CALL + isAccessibleRowSelected( sal_Int32 nRow ) override; + + /// Returns a boolean value indicating whether the specified column is selected. + virtual sal_Bool SAL_CALL + isAccessibleColumnSelected( sal_Int32 nColumn ) override; + + /// Returns the Accessible at a specified row and column in the table. + virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL + getAccessibleCellAt( sal_Int32 nRow, sal_Int32 nColumn ) override; + + /// Returns the caption for the table. + virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL + getAccessibleCaption( ) override; + + /// Returns the summary description of the table. + virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL + getAccessibleSummary( ) override; + + /// Returns a boolean value indicating whether the accessible at a specified row and column is selected. + virtual sal_Bool SAL_CALL + isAccessibleSelected( sal_Int32 nRow, sal_Int32 nColumn ) override; + + ///===== XAccessibleExtendedTable ======================================== + + /// Returns the index of the cell on the given position. + virtual sal_Int32 SAL_CALL + getAccessibleIndex( sal_Int32 nRow, sal_Int32 nColumn ) override; + + /// Returns the row number of an index in the table. + virtual sal_Int32 SAL_CALL + getAccessibleRow( sal_Int32 nChildIndex ) override; + + /// Returns the column number of an index in the table. + virtual sal_Int32 SAL_CALL + getAccessibleColumn( sal_Int32 nChildIndex ) override; + + //===== XAccessibleContext ============================================== + + /// Return the number of currently visible children. + /// override to calculate this on demand + virtual sal_Int32 SAL_CALL + getAccessibleChildCount() override; + + /// Return the specified child or NULL if index is invalid. + /// override to calculate this on demand + virtual css::uno::Reference< css::accessibility::XAccessible> SAL_CALL + getAccessibleChild(sal_Int32 nIndex) override; + virtual sal_Bool SAL_CALL selectRow( sal_Int32 row ) override; + virtual sal_Bool SAL_CALL selectColumn( sal_Int32 column ) override; + virtual sal_Bool SAL_CALL unselectRow( sal_Int32 row ) override; + virtual sal_Bool SAL_CALL unselectColumn( sal_Int32 column ) override; + +protected: + /// Return this object's description. + virtual OUString + createAccessibleDescription() override; + + /// Return the object's current name. + virtual OUString + createAccessibleName() override; + +public: + /// Return NULL to indicate that an empty relation set. + virtual css::uno::Reference<css::accessibility::XAccessibleRelationSet> SAL_CALL + getAccessibleRelationSet() override; + + /// Return the set of current states. + // perhaps sometimes to be implemented + virtual css::uno::Reference<css::accessibility::XAccessibleStateSet> SAL_CALL + getAccessibleStateSet() override; + + ///===== XAccessibleSelection =========================================== + + virtual void SAL_CALL + selectAccessibleChild( sal_Int32 nChildIndex ) override; + + virtual sal_Bool SAL_CALL + isAccessibleChildSelected( sal_Int32 nChildIndex ) override; + + virtual void SAL_CALL + clearAccessibleSelection( ) override; + + virtual void SAL_CALL + selectAllAccessibleChildren( ) override; + + virtual sal_Int32 SAL_CALL + getSelectedAccessibleChildCount( ) override; + + virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL + getSelectedAccessibleChild( sal_Int32 nSelectedChildIndex ) override; + + virtual void SAL_CALL + deselectAccessibleChild( sal_Int32 nSelectedChildIndex ) override; + + ///===== XServiceInfo =================================================== + + /** Returns an identifier for the implementation of this object. + */ + virtual OUString SAL_CALL + getImplementationName() override; + + ///===== XTypeProvider =================================================== + + /// returns the possible types + virtual css::uno::Sequence< css::uno::Type > SAL_CALL + getTypes() override; + + /** Returns an implementation id. + */ + virtual css::uno::Sequence<sal_Int8> SAL_CALL + getImplementationId() override; + +protected: + /// contains the range of the table, because it could be a subrange of the complete table + ScRange maRange; + + ScDocument* mpDoc; + + void CommitTableModelChange(sal_Int32 nStartRow, sal_Int32 nStartCol, sal_Int32 nEndRow, sal_Int32 nEndCol, sal_uInt16 nId); +}; + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |