sw/source/core/access/acctable.hxx

   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 #pragma once
  21
  22 #include <com/sun/star/accessibility/XAccessibleTable.hpp>
  23 #include <com/sun/star/accessibility/XAccessibleTableSelection.hpp>
  24 #include <vector>
  25 #include <com/sun/star/accessibility/XAccessibleSelection.hpp>
  26
  27 #include <svl/listener.hxx>
  28
  29 #include "acccontext.hxx"
  30
  31 class SwTabFrame;
  32 class SwAccessibleTableData_Impl;
  33 class SwTableBox;
  34 class SwSelBoxes;
  35
  36 namespace sw::access {
  37     class SwAccessibleChild;
  38 }
  39
  40 class SwAccessibleTable :
  41         public SwAccessibleContext,
  42         public css::accessibility::XAccessibleTable,
  43         public css::accessibility::XAccessibleSelection,
  44         public css::accessibility::XAccessibleTableSelection,
  45         public SvtListener
  46 {
  47     std::unique_ptr<SwAccessibleTableData_Impl> mpTableData;    // the table's data, protected by SolarMutex
  48     OUString m_sDesc;
  49     typedef std::vector< std::pair<SwAccessibleContext*,
  50         css::uno::WeakReference<css::accessibility::XAccessible> > > Cells_t;
  51     Cells_t m_vecCellAdd;
  52     Cells_t m_vecCellRemove;
  53
  54     const SwSelBoxes *GetSelBoxes() const;
  55
  56     void FireTableChangeEvent( const SwAccessibleTableData_Impl& rTableData );
  57
  58     /** get the SwTableBox* for the given child */
  59     const SwTableBox* GetTableBox( sal_Int64 ) const;
  60
  61     bool IsChildSelected( sal_Int64 nChildIndex ) const;
  62
  63     sal_Int64 GetIndexOfSelectedChild( sal_Int64 nSelectedChildIndex ) const;
  64
  65 protected:
  66     // Set states for getAccessibleStateSet.
  67     // This derived class additionally sets MULTISELECTABLE(+)
  68     virtual void GetStates( sal_Int64& rStateSet ) override;
  69
  70     virtual ~SwAccessibleTable() override;
  71
  72     // #i77106#
  73     void SetDesc( const OUString& sNewDesc )
  74     {
  75         m_sDesc = sNewDesc;
  76     }
  77
  78     virtual std::unique_ptr<SwAccessibleTableData_Impl> CreateNewTableData(); // #i77106#
  79
  80     // force update of table data
  81     void UpdateTableData();
  82
  83     // remove the current table data
  84     void ClearTableData();
  85
  86     // get table data, update if necessary
  87     inline SwAccessibleTableData_Impl& GetTableData();
  88
  89     // Is table data evailable?
  90     bool HasTableData() const { return (mpTableData != nullptr); }
  91
  92     virtual void Notify(const SfxHint&) override;
  93
  94 public:
  95     SwAccessibleTable(std::shared_ptr<SwAccessibleMap> const& pInitMap,
  96                       const SwTabFrame* pTableFrame);
  97
  98     // XInterface
  99
 100     // (XInterface methods need to be implemented to disambiguate
 101     // between those inherited through SwAccessibleContext and
 102     // XAccessibleTable).
 103
 104     virtual css::uno::Any SAL_CALL queryInterface(
 105         const css::uno::Type& aType ) override;
 106
 107     virtual void SAL_CALL acquire(  ) noexcept override
 108         { SwAccessibleContext::acquire(); };
 109
 110     virtual void SAL_CALL release(  ) noexcept override
 111         { SwAccessibleContext::release(); };
 112
 113     // XTypeProvider
 114     virtual css::uno::Sequence< css::uno::Type > SAL_CALL getTypes(  ) override;
 115     virtual css::uno::Sequence< sal_Int8 > SAL_CALL getImplementationId(  ) override;
 116
 117     // XAccessibleContext
 118
 119     /// Return this object's description.
 120     virtual OUString SAL_CALL
 121         getAccessibleDescription() override;
 122
 123     // XAccessibleTable
 124
 125     virtual sal_Int32 SAL_CALL getAccessibleRowCount() override;
 126     virtual sal_Int32 SAL_CALL getAccessibleColumnCount(  ) override;
 127     virtual OUString SAL_CALL getAccessibleRowDescription(
 128             sal_Int32 nRow ) override;
 129     virtual OUString SAL_CALL getAccessibleColumnDescription(
 130             sal_Int32 nColumn ) override;
 131     virtual sal_Int32 SAL_CALL getAccessibleRowExtentAt(
 132             sal_Int32 nRow, sal_Int32 nColumn ) override;
 133     virtual sal_Int32 SAL_CALL getAccessibleColumnExtentAt(
 134                sal_Int32 nRow, sal_Int32 nColumn ) override;
 135     virtual css::uno::Reference<
 136                 css::accessibility::XAccessibleTable >
 137         SAL_CALL getAccessibleRowHeaders(  ) override;
 138     virtual css::uno::Reference<
 139                 css::accessibility::XAccessibleTable >
 140         SAL_CALL getAccessibleColumnHeaders(  ) override;
 141     virtual css::uno::Sequence< sal_Int32 > SAL_CALL
 142         getSelectedAccessibleRows(  ) override;
 143     virtual css::uno::Sequence< sal_Int32 > SAL_CALL
 144         getSelectedAccessibleColumns(  ) override;
 145     virtual sal_Bool SAL_CALL isAccessibleRowSelected( sal_Int32 nRow ) override;
 146     virtual sal_Bool SAL_CALL isAccessibleColumnSelected( sal_Int32 nColumn ) override;
 147     virtual css::uno::Reference<
 148         css::accessibility::XAccessible > SAL_CALL
 149         getAccessibleCellAt( sal_Int32 nRow, sal_Int32 nColumn ) override;
 150     virtual css::uno::Reference<
 151         css::accessibility::XAccessible > SAL_CALL
 152         getAccessibleCaption(  ) override;
 153     virtual css::uno::Reference<
 154         css::accessibility::XAccessible > SAL_CALL
 155         getAccessibleSummary(  ) override;
 156     virtual sal_Bool SAL_CALL isAccessibleSelected(
 157             sal_Int32 nRow, sal_Int32 nColumn ) override;
 158     virtual sal_Int64 SAL_CALL getAccessibleIndex(
 159             sal_Int32 nRow, sal_Int32 nColumn ) override;
 160     virtual sal_Int32 SAL_CALL getAccessibleRow( sal_Int64 nChildIndex ) override;
 161     virtual sal_Int32 SAL_CALL getAccessibleColumn( sal_Int64 nChildIndex ) override;
 162     // XAccessibleTableSelection
 163     virtual sal_Bool SAL_CALL selectRow( sal_Int32 row ) override ;
 164     virtual sal_Bool SAL_CALL selectColumn( sal_Int32 column ) override ;
 165     virtual sal_Bool SAL_CALL unselectRow( sal_Int32 row ) override;
 166     virtual sal_Bool SAL_CALL unselectColumn( sal_Int32 column ) override;
 167     // XServiceInfo
 168
 169     /** Returns an identifier for the implementation of this object.
 170     */
 171     virtual OUString SAL_CALL
 172         getImplementationName() override;
 173
 174     /** Return whether the specified service is supported by this class.
 175     */
 176     virtual sal_Bool SAL_CALL
 177         supportsService (const OUString& sServiceName) override;
 178
 179     /** Returns a list of all supported services.  In this case that is just
 180         the AccessibleContext service.
 181     */
 182     virtual css::uno::Sequence< OUString> SAL_CALL
 183         getSupportedServiceNames() override;
 184
 185     // C++ interface
 186
 187     // The object has been moved by the layout
 188     virtual void InvalidatePosOrSize( const SwRect& rOldBox ) override;
 189
 190     // The object is not visible any longer and should be destroyed
 191     virtual void Dispose(bool bRecursive, bool bCanSkipInvisible = true) override;
 192
 193     virtual void DisposeChild( const sw::access::SwAccessibleChild& rFrameOrObj,
 194                                bool bRecursive, bool bCanSkipInvisible ) override;
 195     virtual void InvalidateChildPosOrSize( const sw::access::SwAccessibleChild& rFrameOrObj,
 196                                            const SwRect& rFrame ) override;
 197
 198     // XAccessibleSelection
 199
 200     virtual void SAL_CALL selectAccessibleChild(
 201         sal_Int64 nChildIndex ) override;
 202
 203     virtual sal_Bool SAL_CALL isAccessibleChildSelected(
 204         sal_Int64 nChildIndex ) override;
 205
 206     virtual void SAL_CALL clearAccessibleSelection(  ) override;
 207
 208     virtual void SAL_CALL selectAllAccessibleChildren(  ) override;
 209
 210     virtual sal_Int64 SAL_CALL getSelectedAccessibleChildCount(  ) override;
 211
 212     virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL getSelectedAccessibleChild(
 213         sal_Int64 nSelectedChildIndex ) override;
 214
 215     // index has to be treated as global child index.
 216     virtual void SAL_CALL deselectAccessibleChild(
 217         sal_Int64 nChildIndex ) override;
 218
 219     // XAccessibleComponent
 220     sal_Int32 SAL_CALL getBackground() override;
 221
 222     void FireSelectionEvent( );
 223     void AddSelectionCell(SwAccessibleContext*, bool bAddOrRemove);
 224 };
 225
 226 inline SwAccessibleTableData_Impl& SwAccessibleTable::GetTableData()
 227 {
 228     if( !mpTableData )
 229         UpdateTableData();
 230     return *mpTableData;
 231 }
 232
 233 // #i77106# - subclass to represent table column headers
 234 class SwAccessibleTableColHeaders : public SwAccessibleTable
 235 {
 236 protected:
 237     virtual ~SwAccessibleTableColHeaders() override
 238     {}
 239
 240     virtual std::unique_ptr<SwAccessibleTableData_Impl> CreateNewTableData() override;
 241     virtual void Notify(const SfxHint&) override;
 242
 243 public:
 244     SwAccessibleTableColHeaders(std::shared_ptr<SwAccessibleMap> const& pMap,
 245                                 const SwTabFrame *pTabFrame);
 246
 247     // XInterface
 248
 249     virtual css::uno::Any SAL_CALL queryInterface(
 250         const css::uno::Type& aType ) override;
 251
 252     // XAccessibleContext
 253
 254     /// Return the number of currently visible children.
 255     virtual sal_Int64 SAL_CALL getAccessibleChildCount() override;
 256
 257     /// Return the specified child or NULL if index is invalid.
 258     virtual css::uno::Reference< css::accessibility::XAccessible> SAL_CALL
 259         getAccessibleChild (sal_Int64 nIndex) override;
 260
 261     // XAccessibleTable
 262
 263     virtual css::uno::Reference<
 264                 css::accessibility::XAccessibleTable >
 265         SAL_CALL getAccessibleRowHeaders(  ) override;
 266     virtual css::uno::Reference<
 267                 css::accessibility::XAccessibleTable >
 268         SAL_CALL getAccessibleColumnHeaders(  ) override;
 269
 270     // XServiceInfo
 271
 272     /** Returns an identifier for the implementation of this object.
 273     */
 274     virtual OUString SAL_CALL
 275         getImplementationName() override;
 276
 277 };
 278
 279 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */