accessibility/inc/extended/AccessibleBrowseBoxTable.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
  21 #ifndef INCLUDED_ACCESSIBILITY_INC_EXTENDED_ACCESSIBLEBROWSEBOXTABLE_HXX
  22 #define INCLUDED_ACCESSIBILITY_INC_EXTENDED_ACCESSIBLEBROWSEBOXTABLE_HXX
  23
  24 #include <extended/AccessibleBrowseBoxTableBase.hxx>
  25
  26
  27 namespace accessibility {
  28
  29 /** This class represents the accessible object of the data table of a
  30     BrowseBox control. */
  31 class AccessibleBrowseBoxTable : public AccessibleBrowseBoxTableBase
  32 {
  33     friend class AccessibleBrowseBox;   // to create header bars
  34
  35 public:
  36     AccessibleBrowseBoxTable(
  37         const css::uno::Reference< css::accessibility::XAccessible >& rxParent,
  38         ::svt::IAccessibleTableProvider& rBrowseBox );
  39
  40 protected:
  41     virtual ~AccessibleBrowseBoxTable() override;
  42
  43 public:
  44     // XAccessibleContext
  45
  46     /** @return  The XAccessible interface of the specified child. */
  47     virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL
  48     getAccessibleChild( sal_Int32 nChildIndex ) override;
  49
  50     /** @return  The index of this object among the parent's children. */
  51     virtual sal_Int32 SAL_CALL getAccessibleIndexInParent() override;
  52
  53     // XAccessibleComponent
  54
  55     /** @return  The accessible child rendered under the given point. */
  56     virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL
  57     getAccessibleAtPoint( const css::awt::Point& rPoint ) override;
  58
  59     /** Grabs the focus to (the current cell of) the data table. */
  60     virtual void SAL_CALL grabFocus() override;
  61
  62     // XAccessibleTable
  63
  64     /** @return  The description text of the specified row. */
  65     virtual OUString SAL_CALL getAccessibleRowDescription( sal_Int32 nRow ) override;
  66
  67     /** @return  The description text of the specified column. */
  68     virtual OUString SAL_CALL getAccessibleColumnDescription( sal_Int32 nColumn ) override;
  69
  70     /** @return  The XAccessibleTable interface of the row header bar. */
  71     virtual css::uno::Reference< css::accessibility::XAccessibleTable > SAL_CALL
  72     getAccessibleRowHeaders() override;
  73
  74     /** @return  The XAccessibleTable interface of the column header bar. */
  75     virtual css::uno::Reference< css::accessibility::XAccessibleTable > SAL_CALL
  76     getAccessibleColumnHeaders() override;
  77
  78     /** @return  An index list of completely selected rows. */
  79     virtual css::uno::Sequence< sal_Int32 > SAL_CALL
  80     getSelectedAccessibleRows() override;
  81
  82     /** @return  An index list of completely selected columns. */
  83     virtual css::uno::Sequence< sal_Int32 > SAL_CALL
  84     getSelectedAccessibleColumns() override;
  85
  86     /** @return  TRUE, if the specified row is completely selected. */
  87     virtual sal_Bool SAL_CALL isAccessibleRowSelected( sal_Int32 nRow ) override;
  88
  89     /** @return  TRUE, if the specified column is completely selected. */
  90     virtual sal_Bool SAL_CALL isAccessibleColumnSelected( sal_Int32 nColumn ) override;
  91
  92     /** @return The XAccessible interface of the cell object at the specified
  93                 cell position. */
  94     virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL
  95     getAccessibleCellAt( sal_Int32 nRow, sal_Int32 nColumn ) override;
  96
  97     /** @return  TRUE, if the specified cell is selected. */
  98     virtual sal_Bool SAL_CALL isAccessibleSelected( sal_Int32 nRow, sal_Int32 nColumn ) override;
  99
 100     // XServiceInfo
 101
 102     /** @return  The name of this class. */
 103     virtual OUString SAL_CALL getImplementationName() override;
 104
 105 protected:
 106     // internal virtual methods
 107
 108     /** @attention  This method requires locked mutex's and a living object.
 109         @return  The bounding box (VCL rect.) relative to the parent window. */
 110     virtual tools::Rectangle implGetBoundingBox() override;
 111     /** @attention  This method requires locked mutex's and a living object.
 112         @return  The bounding box (VCL rect.) in screen coordinates. */
 113     virtual tools::Rectangle implGetBoundingBoxOnScreen() override;
 114
 115     // internal helper methods
 116
 117     /** @attention  This method requires a locked mutex.
 118         @return  The XAccessibleTable interface of the specified header bar.
 119         @throws css::uno::RuntimeException
 120     */
 121     css::uno::Reference< css::accessibility::XAccessibleTable >
 122     implGetHeaderBar( sal_Int32 nChildIndex );
 123 };
 124
 125
 126 } // namespace accessibility
 127
 128
 129 #endif
 130
 131 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */