include/vcl/accessibletable.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_VCL_ACCESSIBLETABLE_HXX
  21 #define INCLUDED_VCL_ACCESSIBLETABLE_HXX
  22
  23 #include <tools/gen.hxx>
  24 #include <com/sun/star/uno/Reference.hxx>
  25 #include <com/sun/star/accessibility/XAccessible.hpp>
  26 #include <cppuhelper/implbase.hxx>
  27
  28 namespace vcl { class Window; }
  29
  30 namespace vcl::table
  31 {
  32
  33 typedef sal_Int32   RowPos;
  34
  35 enum class AccessibleTableControlObjType
  36 {
  37     GRIDCONTROL,         /// The GridControl itself.
  38     TABLE,               /// The data table.
  39     ROWHEADERBAR,        /// The row header bar.
  40     COLUMNHEADERBAR,     /// The horizontal column header bar.
  41     TABLECELL,           /// A cell of the data table.
  42     ROWHEADERCELL,       /// A cell of the row header bar.
  43     COLUMNHEADERCELL,    /// A cell of the column header bar.
  44 };
  45
  46
  47 /** This abstract class provides methods to implement an accessible table object.
  48 */
  49 class IAccessibleTable
  50 {
  51 public:
  52     /** @return  The position of the current row. */
  53     virtual sal_Int32               GetCurrentRow() const = 0;
  54     /** @return  The position of the current column. */
  55     virtual sal_Int32               GetCurrentColumn() const = 0;
  56     virtual css::uno::Reference< css::accessibility::XAccessible > CreateAccessibleControl( sal_Int32 _nIndex )= 0;
  57     virtual OUString GetAccessibleObjectName(AccessibleTableControlObjType eObjType, sal_Int32 _nRow, sal_Int32 _nCol) const= 0;
  58     virtual void    GoToCell( sal_Int32 _nColumnPos, sal_Int32 _nRow )= 0;
  59     virtual bool    HasColHeader() = 0;
  60     virtual bool    HasRowHeader() = 0;
  61
  62     /** return the description of the specified object.
  63         @param  eObjType
  64             The type to ask for
  65         @return
  66             The description of the specified object.
  67     */
  68     virtual OUString GetAccessibleObjectDescription(AccessibleTableControlObjType eObjType) const= 0;
  69
  70     /** Fills the StateSet with all states (except DEFUNC and SHOWING, done by
  71             the accessible object), depending on the specified object type. */
  72     virtual void FillAccessibleStateSet( sal_Int64& rStateSet,
  73             AccessibleTableControlObjType eObjType ) const= 0;
  74
  75     // Window
  76     virtual AbsoluteScreenPixelRectangle GetWindowExtentsAbsolute() const = 0;
  77     virtual tools::Rectangle GetWindowExtentsRelative(const vcl::Window& rRelativeWindow) const = 0;
  78     virtual void GrabFocus()= 0;
  79     virtual css::uno::Reference< css::accessibility::XAccessible > GetAccessible()= 0;
  80     virtual vcl::Window* GetAccessibleParentWindow() const= 0;
  81     virtual vcl::Window* GetWindowInstance()= 0;
  82     virtual sal_Int32 GetAccessibleControlCount() const = 0;
  83     virtual bool ConvertPointToControlIndex( sal_Int32& _rnIndex, const Point& _rPoint )= 0;
  84     virtual sal_Int32 GetRowCount() const= 0;
  85     virtual sal_Int32 GetColumnCount() const= 0;
  86     virtual bool ConvertPointToCellAddress( sal_Int32& _rnRow, sal_Int32& _rnColPos, const Point& _rPoint )= 0;
  87     virtual tools::Rectangle calcHeaderRect( bool _bIsColumnBar ) = 0;
  88     virtual tools::Rectangle calcHeaderCellRect( bool _bColHeader, sal_Int32 _nPos ) = 0;
  89     virtual tools::Rectangle calcTableRect() = 0;
  90     virtual tools::Rectangle calcCellRect( sal_Int32 _nRowPos, sal_Int32 _nColPos ) = 0;
  91     virtual tools::Rectangle GetFieldCharacterBounds(sal_Int32 _nRow,sal_Int32 _nColumnPos,sal_Int32 nIndex)= 0;
  92     virtual sal_Int32 GetFieldIndexAtPoint(sal_Int32 _nRow,sal_Int32 _nColumnPos,const Point& _rPoint)= 0;
  93     virtual void FillAccessibleStateSetForCell( sal_Int64& _rStateSet, sal_Int32 _nRow, sal_uInt16 _nColumnPos ) const= 0;
  94     virtual OUString GetRowName(sal_Int32 _nIndex) const = 0;
  95     virtual OUString GetColumnName( sal_Int32 _nIndex ) const = 0;
  96     virtual OUString GetAccessibleCellText(sal_Int32 _nRowPos, sal_Int32 _nColPos) const = 0;
  97
  98     virtual sal_Int32 GetSelectedRowCount() const = 0;
  99     virtual sal_Int32 GetSelectedRowIndex( sal_Int32 const i_selectionIndex ) const = 0;
 100     virtual bool IsRowSelected( sal_Int32 const i_rowIndex ) const = 0;
 101     virtual void SelectRow( sal_Int32 const i_rowIndex, bool const i_select ) = 0;
 102     virtual void SelectAllRows( bool const i_select ) = 0;
 103
 104 protected:
 105     ~IAccessibleTable() {}
 106 };
 107
 108
 109 /** interface for an implementation of a table control's Accessible component
 110 */
 111 class IAccessibleTableControl : public ::cppu::WeakImplHelper< css::accessibility::XAccessible >
 112 {
 113 public:
 114
 115     /** disposes the accessible implementation, so that it becomes defunc
 116     */
 117     virtual void DisposeAccessImpl() = 0;
 118
 119     /** checks whether the accessible implementation, and its context, are still alive
 120         @return  <TRUE/>, if the object is not disposed or disposing.
 121     */
 122     virtual bool isAlive() const = 0;
 123
 124     /** commits the event at all listeners of the cell
 125          @param nEventId
 126              the event id
 127          @param rNewValue
 128              the new value
 129           @param rOldValue
 130              the old value
 131       */
 132      virtual void commitCellEvent(
 133          sal_Int16 nEventId,
 134          const css::uno::Any& rNewValue,
 135          const css::uno::Any& rOldValue
 136      ) = 0;
 137     /** commits the event at all listeners of the table
 138          @param nEventId
 139              the event id
 140          @param rNewValue
 141              the new value
 142           @param rOldValue
 143              the old value
 144       */
 145      virtual void commitTableEvent(
 146          sal_Int16 nEventId,
 147          const css::uno::Any& rNewValue,
 148          const css::uno::Any& rOldValue
 149      ) = 0;
 150
 151     ///** Commits an event to all listeners. */
 152     virtual void commitEvent(
 153         sal_Int16 nEventId,
 154         const css::uno::Any& rNewValue
 155     ) = 0;
 156
 157 protected:
 158     ~IAccessibleTableControl() {}
 159 };
 160
 161 } // namespace vcl::table
 162
 163 #endif // INCLUDED_VCL_ACCESSIBLETABLE_HXX
 164
 165 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */