sc/source/ui/inc/AccessibleSpreadsheet.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 #ifndef INCLUDED_SC_SOURCE_UI_INC_ACCESSIBLESPREADSHEET_HXX
  21 #define INCLUDED_SC_SOURCE_UI_INC_ACCESSIBLESPREADSHEET_HXX
  22
  23 #include <sal/config.h>
  24
  25 #include <rtl/ref.hxx>
  26
  27 #include "AccessibleTableBase.hxx"
  28 #include "viewdata.hxx"
  29
  30 #include <vector>
  31
  32 #include "rangelst.hxx"
  33 #include <map>
  34
  35 class ScMyAddress : public ScAddress
  36 {
  37 public:
  38     ScMyAddress(SCCOL nColP, SCROW nRowP, SCTAB nTabP) : ScAddress(nColP, nRowP, nTabP) {}
  39     ScMyAddress(const ScAddress& rAddress) : ScAddress(rAddress) {}
  40
  41     bool operator< ( const ScMyAddress& rAddress ) const
  42     {
  43         if( Row() != rAddress.Row() )
  44             return (Row() < rAddress.Row());
  45         else
  46             return (Col() < rAddress.Col());
  47     }
  48 };
  49
  50 class ScTabViewShell;
  51 class ScAccessibleDocument;
  52 class ScAccessibleCell;
  53 class ScRangeList;
  54
  55 /** @descr
  56         This base class provides an implementation of the
  57         <code>AccessibleTable</code> service.
  58 */
  59 class ScAccessibleSpreadsheet
  60     :   public  ScAccessibleTableBase
  61 {
  62 public:
  63     //=====  internal  ========================================================
  64     ScAccessibleSpreadsheet(
  65         ScAccessibleDocument* pAccDoc,
  66         ScTabViewShell* pViewShell,
  67         SCTAB   nTab,
  68         ScSplitPos eSplitPos);
  69 protected:
  70     ScAccessibleSpreadsheet(
  71         ScAccessibleSpreadsheet& rParent,
  72         const ScRange& rRange );
  73
  74     virtual ~ScAccessibleSpreadsheet();
  75
  76     void ConstructScAccessibleSpreadsheet(
  77         ScAccessibleDocument* pAccDoc,
  78         ScTabViewShell* pViewShell,
  79         SCTAB nTab,
  80         ScSplitPos eSplitPos);
  81
  82     using ScAccessibleTableBase::IsDefunc;
  83
  84 public:
  85     using ScAccessibleTableBase::disposing;
  86
  87      virtual void SAL_CALL disposing() override;
  88
  89     void CompleteSelectionChanged(bool bNewState);
  90
  91     void LostFocus();
  92     void GotFocus();
  93
  94     void BoundingBoxChanged();
  95     void VisAreaChanged();
  96
  97 private:
  98     ///=====  SfxListener  =====================================================
  99     virtual void Notify( SfxBroadcaster& rBC, const SfxHint& rHint ) override;
 100
 101     ///=====  XAccessibleTable  ================================================
 102
 103     /// Returns the row headers as an AccessibleTable.
 104     virtual css::uno::Reference< css::accessibility::XAccessibleTable > SAL_CALL
 105                 getAccessibleRowHeaders(  )
 106                     throw (css::uno::RuntimeException, std::exception) override;
 107
 108     /// Returns the column headers as an AccessibleTable.
 109     virtual css::uno::Reference< css::accessibility::XAccessibleTable > SAL_CALL
 110                 getAccessibleColumnHeaders(  )
 111                     throw (css::uno::RuntimeException, std::exception) override;
 112
 113     /// Returns the selected rows in a table.
 114     virtual css::uno::Sequence< sal_Int32 > SAL_CALL
 115                 getSelectedAccessibleRows(  )
 116                     throw (css::uno::RuntimeException, std::exception) override;
 117
 118     /// Returns the selected columns in a table.
 119     virtual css::uno::Sequence< sal_Int32 > SAL_CALL
 120                 getSelectedAccessibleColumns(  )
 121                     throw (css::uno::RuntimeException, std::exception) override;
 122
 123     /// Returns a boolean value indicating whether the specified row is selected.
 124     virtual sal_Bool SAL_CALL
 125                 isAccessibleRowSelected( sal_Int32 nRow )
 126                     throw (css::uno::RuntimeException,
 127                     css::lang::IndexOutOfBoundsException, std::exception) override;
 128
 129     /// Returns a boolean value indicating whether the specified column is selected.
 130     virtual sal_Bool SAL_CALL
 131                 isAccessibleColumnSelected( sal_Int32 nColumn )
 132                     throw (css::uno::RuntimeException,
 133                     css::lang::IndexOutOfBoundsException, std::exception) override;
 134
 135     /// Returns the Accessible at a specified row and column in the table.
 136     virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL
 137                 getAccessibleCellAt( sal_Int32 nRow, sal_Int32 nColumn )
 138                     throw (css::uno::RuntimeException,
 139                             css::lang::IndexOutOfBoundsException, std::exception) override;
 140
 141     rtl::Reference<ScAccessibleCell> GetAccessibleCellAt(sal_Int32 nRow, sal_Int32 nColumn);
 142
 143     /// Returns a boolean value indicating whether the accessible at a specified row and column is selected.
 144     virtual sal_Bool SAL_CALL
 145                 isAccessibleSelected( sal_Int32 nRow, sal_Int32 nColumn )
 146                     throw (css::uno::RuntimeException,
 147                     css::lang::IndexOutOfBoundsException, std::exception) override;
 148
 149     ///=====  XAccessibleComponent  ============================================
 150
 151     virtual css::uno::Reference< css::accessibility::XAccessible >
 152         SAL_CALL getAccessibleAtPoint(
 153         const css::awt::Point& rPoint )
 154         throw (css::uno::RuntimeException, std::exception) override;
 155
 156     virtual void SAL_CALL grabFocus(  )
 157         throw (css::uno::RuntimeException, std::exception) override;
 158
 159     virtual sal_Int32 SAL_CALL getForeground(  )
 160         throw (css::uno::RuntimeException, std::exception) override;
 161
 162     virtual sal_Int32 SAL_CALL getBackground(  )
 163         throw (css::uno::RuntimeException, std::exception) override;
 164
 165     ///=====  XAccessibleContext  ==============================================
 166
 167     /// Return NULL to indicate that an empty relation set.
 168     virtual css::uno::Reference<css::accessibility::XAccessibleRelationSet> SAL_CALL
 169         getAccessibleRelationSet()
 170         throw (css::uno::RuntimeException, std::exception) override;
 171
 172     /// Return the set of current states.
 173     virtual css::uno::Reference<css::accessibility::XAccessibleStateSet> SAL_CALL
 174         getAccessibleStateSet()
 175         throw (css::uno::RuntimeException, std::exception) override;
 176
 177     ///=====  XAccessibleSelection  ===========================================
 178
 179     virtual void SAL_CALL
 180         selectAccessibleChild( sal_Int32 nChildIndex )
 181         throw (css::lang::IndexOutOfBoundsException,
 182                css::uno::RuntimeException,
 183                std::exception) override;
 184
 185     virtual void SAL_CALL
 186         clearAccessibleSelection(  )
 187         throw (css::uno::RuntimeException, std::exception) override;
 188
 189     virtual void SAL_CALL
 190         selectAllAccessibleChildren(  )
 191         throw (css::uno::RuntimeException, std::exception) override;
 192
 193     virtual sal_Int32 SAL_CALL
 194         getSelectedAccessibleChildCount(  )
 195         throw (css::uno::RuntimeException, std::exception) override;
 196
 197     virtual css::uno::Reference<css::accessibility::XAccessible > SAL_CALL
 198         getSelectedAccessibleChild( sal_Int32 nSelectedChildIndex )
 199         throw (css::lang::IndexOutOfBoundsException,
 200         css::uno::RuntimeException, std::exception) override;
 201
 202     virtual void SAL_CALL
 203         deselectAccessibleChild( sal_Int32 nChildIndex )
 204         throw (css::lang::IndexOutOfBoundsException,
 205                css::uno::RuntimeException,
 206                std::exception) override;
 207
 208     ///=====  XServiceInfo  ====================================================
 209
 210     /** Returns an identifier for the implementation of this object.
 211     */
 212     virtual OUString SAL_CALL
 213         getImplementationName()
 214         throw (css::uno::RuntimeException, std::exception) override;
 215
 216     /** Returns a list of all supported services.
 217     */
 218     virtual css::uno::Sequence< OUString> SAL_CALL
 219         getSupportedServiceNames()
 220         throw (css::uno::RuntimeException, std::exception) override;
 221
 222     ///=====  XTypeProvider  ===================================================
 223
 224     /** Returns a implementation id.
 225     */
 226     virtual css::uno::Sequence<sal_Int8> SAL_CALL
 227         getImplementationId()
 228         throw (css::uno::RuntimeException, std::exception) override;
 229
 230     ///=====  XAccessibleEventBroadcaster  =====================================
 231
 232     /** Add listener that is informed of future changes of name,
 233           description and so on events.
 234     */
 235     virtual void SAL_CALL
 236         addAccessibleEventListener(
 237             const css::uno::Reference<css::accessibility::XAccessibleEventListener>& xListener)
 238         throw (css::uno::RuntimeException, std::exception) override;
 239     //=====  XAccessibleTableSelection  ============================================
 240     virtual sal_Bool SAL_CALL selectRow( sal_Int32 row )
 241         throw (css::lang::IndexOutOfBoundsException, css::uno::RuntimeException,
 242                std::exception) override;
 243     virtual sal_Bool SAL_CALL selectColumn( sal_Int32 column )
 244         throw (css::lang::IndexOutOfBoundsException, css::uno::RuntimeException,
 245                std::exception) override;
 246     virtual sal_Bool SAL_CALL unselectRow( sal_Int32 row )
 247         throw (css::lang::IndexOutOfBoundsException, css::uno::RuntimeException,
 248                std::exception) override;
 249     virtual sal_Bool SAL_CALL unselectColumn( sal_Int32 column )
 250         throw (css::lang::IndexOutOfBoundsException, css::uno::RuntimeException,
 251                std::exception) override;
 252
 253 protected:
 254     /// Return the object's current bounding box relative to the desktop.
 255     virtual Rectangle GetBoundingBoxOnScreen() const
 256         throw (css::uno::RuntimeException, std::exception) override;
 257
 258     /// Return the object's current bounding box relative to the parent object.
 259     virtual Rectangle GetBoundingBox() const
 260         throw (css::uno::RuntimeException, std::exception) override;
 261 private:
 262     ScTabViewShell* mpViewShell;
 263     ScRangeList*    mpMarkedRanges;
 264     std::vector<ScMyAddress>* mpSortedMarkedCells;
 265     ScAccessibleDocument* mpAccDoc;
 266     rtl::Reference<ScAccessibleCell> mpAccCell;
 267     Rectangle       maVisCells;
 268     ScSplitPos      meSplitPos;
 269     ScAddress       maActiveCell;
 270     SCTAB           mnTab;
 271     bool            mbIsSpreadsheet;
 272     bool            mbHasSelection;
 273     bool            mbDelIns;
 274     bool            mbIsFocusSend;
 275
 276     bool IsDefunc(
 277         const css::uno::Reference<css::accessibility::XAccessibleStateSet>& rxParentStates);
 278     bool IsEditable(
 279         const css::uno::Reference<css::accessibility::XAccessibleStateSet>& rxParentStates);
 280     bool IsFocused();
 281     bool IsCompleteSheetSelected();
 282
 283     void SelectCell(sal_Int32 nRow, sal_Int32 nCol, bool bDeselect);
 284
 285     static ScDocument* GetDocument(ScTabViewShell* pViewShell);
 286     static Rectangle   GetVisArea(ScTabViewShell* pViewShell, ScSplitPos eSplitPos);
 287     Rectangle   GetVisCells(const Rectangle& rVisArea);
 288     typedef std::vector<ScMyAddress> VEC_MYADDR;
 289
 290     typedef std::map<ScMyAddress,css::uno::Reference< css::accessibility::XAccessible > >
 291         MAP_ADDR_XACC;
 292     MAP_ADDR_XACC m_mapSelectionSend;
 293     void RemoveSelection(ScMarkData &refScMarkData);
 294     bool IsSameMarkCell();
 295     void CommitFocusCell(const ScAddress &aNewCell);
 296 public:
 297     void FireFirstCellFocus();
 298 private:
 299     bool          m_bFormulaMode;
 300     bool          m_bFormulaLastMode;
 301     ScAddress     m_aFormulaActiveCell;
 302     MAP_ADDR_XACC m_mapFormulaSelectionSend;
 303     VEC_MYADDR    m_vecFormulaLastMyAddr;
 304     rtl::Reference<ScAccessibleCell> m_pAccFormulaCell;
 305     sal_uInt16    m_nMinX;
 306     sal_uInt16    m_nMaxX;
 307     sal_Int32     m_nMinY;
 308     sal_Int32     m_nMaxY;
 309
 310     sal_Int32 GetRowAll() const { return m_nMaxY - m_nMinY + 1 ; }
 311     sal_uInt16  GetColAll() const { return m_nMaxX - m_nMinX + 1; }
 312     void NotifyRefMode();
 313     void RemoveFormulaSelection(bool bRemoveAll = false);
 314     bool CheckChildIndex(sal_Int32) const;
 315     ScAddress GetChildIndexAddress(sal_Int32) const;
 316     sal_Int32 GetAccessibleIndexFormula( sal_Int32 nRow, sal_Int32 nColumn );
 317     bool GetFormulaCurrentFocusCell(ScAddress &addr);
 318 public:
 319     ScRange       m_aLastWithInMarkRange;
 320     OUString      m_strCurCellValue;
 321     ScRangeList   m_LastMarkedRanges;
 322     typedef std::vector<ScRange*> VEC_RANGE;
 323     VEC_RANGE     m_vecTempRange;
 324     typedef std::pair<sal_uInt16,sal_uInt16> PAIR_COL;
 325     typedef std::vector<PAIR_COL> VEC_COL;
 326     VEC_COL       m_vecTempCol;
 327     OUString      m_strOldTabName;
 328
 329     css::uno::Reference < css::accessibility::XAccessible > GetActiveCell();
 330     bool IsScAddrFormulaSel (const ScAddress &addr) const;
 331     bool IsFormulaMode();
 332     ScMyAddress CalcScAddressFromRangeList(ScRangeList *pMarkedRanges,sal_Int32 nSelectedChildIndex);
 333     static bool CalcScRangeDifferenceMax(ScRange *pSrc,ScRange *pDest,int nMax,VEC_MYADDR &vecRet,int &nSize);
 334     static bool CalcScRangeListDifferenceMax(ScRangeList *pSrc,ScRangeList *pDest,int nMax,VEC_MYADDR &vecRet);
 335 };
 336
 337 #endif
 338
 339 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */