1
0
Fork 0
libreoffice/accessibility/inc/extended/AccessibleGridControlHeader.hxx
Daniel Baumann 8e63e14cf6
Adding upstream version 4:25.2.3.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
2025-06-22 16:20:04 +02:00

155 lines
6.1 KiB
C++

/* -*- 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 <extended/AccessibleGridControlTableBase.hxx>
namespace accessibility {
/** This class represents the accessible object of a header bar of a Grid Control
(row or column header bar). This object supports the
XAccessibleSelection interface. Selecting a child of this object selects
complete rows or columns of the data table. */
class AccessibleGridControlHeader final : public AccessibleGridControlTableBase
{
public:
/** @param rxParent accessible parent control
@param rTable accessible table
@param eObjType One of the two allowed types AccessibleTableControlObjType::ROWHEADERBAR or
AccessibleTableControlObjType::COLUMNHEADERBAR. */
AccessibleGridControlHeader(
const css::uno::Reference<
css::accessibility::XAccessible >& rxParent,
::vcl::table::IAccessibleTable& rTable,
::vcl::table::AccessibleTableControlObjType eObjType );
private:
virtual ~AccessibleGridControlHeader() override = default;
public:
// XAccessibleContext
/** @return
The XAccessible interface of the specified child.
*/
virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL
getAccessibleChild( sal_Int64 nChildIndex ) override;
/** @return The index of this object among the parent's children. */
virtual sal_Int64 SAL_CALL getAccessibleIndexInParent() override;
// XAccessibleComponent
/** @return The accessible child rendered under the given point. */
virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL
getAccessibleAtPoint( const css::awt::Point& rPoint ) override;
/** Grabs the focus to (the current cell of) the data table. */
virtual void SAL_CALL grabFocus() override;
// XAccessibleTable
/** @return The description text of the specified row. */
virtual OUString SAL_CALL
getAccessibleRowDescription( sal_Int32 nRow ) override;
/** @return The description text of the specified column. */
virtual OUString SAL_CALL
getAccessibleColumnDescription( sal_Int32 nColumn ) override;
/** @return The XAccessibleTable interface of the row header bar. */
virtual css::uno::Reference< css::accessibility::XAccessibleTable > SAL_CALL
getAccessibleRowHeaders() override;
/** @return The XAccessibleTable interface of the column header bar. */
virtual css::uno::Reference< css::accessibility::XAccessibleTable > SAL_CALL
getAccessibleColumnHeaders() override;
/** @return An index list of completely selected rows. */
virtual css::uno::Sequence< sal_Int32 > SAL_CALL
getSelectedAccessibleRows() override;
/** @return An index list of completely selected columns. */
virtual css::uno::Sequence< sal_Int32 > SAL_CALL
getSelectedAccessibleColumns() override;
/** @return TRUE, if the specified row is completely selected. */
virtual sal_Bool SAL_CALL isAccessibleRowSelected( sal_Int32 nRow ) override;
/** @return TRUE, if the specified column is completely selected. */
virtual sal_Bool SAL_CALL isAccessibleColumnSelected( sal_Int32 nColumn ) override;
/** @return The XAccessible interface of the cell object at the specified
cell position. */
virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL
getAccessibleCellAt( sal_Int32 nRow, sal_Int32 nColumn ) override;
/** @return TRUE, if the specified cell is selected. */
virtual sal_Bool SAL_CALL isAccessibleSelected( sal_Int32 nRow, sal_Int32 nColumn ) override;
// XServiceInfo
/** @return The name of this class. */
virtual OUString SAL_CALL getImplementationName() override;
/** @return a unique implementation ID. */
virtual css::uno::Sequence< sal_Int8 > SAL_CALL getImplementationId() override;
private:
/** Returns the specified row or column. Uses one of the parameters,
depending on object type.
@attention This method requires locked mutex's and a living object.
@return The XAccessible interface of the specified column/row. */
css::uno::Reference< css::accessibility::XAccessible >
implGetChild( sal_Int32 nRow, sal_uInt32 nColumnPos );
/** @attention This method requires locked mutex's and a living object.
@return The bounding box (VCL rect.) relative to the parent window. */
virtual tools::Rectangle implGetBoundingBox() override;
/** @attention This method requires locked mutex's and a living object.
@return The bounding box (VCL rect.) in screen coordinates. */
virtual AbsoluteScreenPixelRectangle implGetBoundingBoxOnScreen() override;
// internal helper methods
/** @return TRUE, if the objects is a header bar for rows. */
inline bool isRowBar() const;
/** @return TRUE, if the objects is a header bar for columns. */
inline bool isColumnBar() const;
};
// inlines
inline bool AccessibleGridControlHeader::isRowBar() const
{
return getType() == ::vcl::table::AccessibleTableControlObjType::ROWHEADERBAR;
}
inline bool AccessibleGridControlHeader::isColumnBar() const
{
return getType() == ::vcl::table::AccessibleTableControlObjType::COLUMNHEADERBAR;
}
} // namespace accessibility
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */