summaryrefslogtreecommitdiffstats
path: root/accessibility/inc/extended/AccessibleBrowseBoxHeaderBar.hxx
diff options
context:
space:
mode:
Diffstat (limited to 'accessibility/inc/extended/AccessibleBrowseBoxHeaderBar.hxx')
-rw-r--r--accessibility/inc/extended/AccessibleBrowseBoxHeaderBar.hxx219
1 files changed, 219 insertions, 0 deletions
diff --git a/accessibility/inc/extended/AccessibleBrowseBoxHeaderBar.hxx b/accessibility/inc/extended/AccessibleBrowseBoxHeaderBar.hxx
new file mode 100644
index 000000000..64d41cb6d
--- /dev/null
+++ b/accessibility/inc/extended/AccessibleBrowseBoxHeaderBar.hxx
@@ -0,0 +1,219 @@
+/* -*- 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/AccessibleBrowseBoxTableBase.hxx>
+#include <cppuhelper/implbase1.hxx>
+#include <com/sun/star/accessibility/XAccessibleSelection.hpp>
+
+
+namespace accessibility {
+
+
+typedef ::cppu::ImplHelper1< css::accessibility::XAccessibleSelection >
+ AccessibleBrowseBoxHeaderBarImplHelper;
+
+/** This class represents the accessible object of a header bar of a BrowseBox
+ 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 AccessibleBrowseBoxHeaderBar final :
+ public AccessibleBrowseBoxTableBase,
+ public AccessibleBrowseBoxHeaderBarImplHelper
+{
+public:
+ /** @param rxParent Parent that holds the browsebox headerbar control
+ @param rBrowseBox The BrowseBox control.
+ @param eObjType One of the two allowed types AccessibleBrowseBoxObjType::RowHeaderBar or
+ AccessibleBrowseBoxObjType::ColumnHeaderBar. */
+ AccessibleBrowseBoxHeaderBar(
+ const css::uno::Reference< css::accessibility::XAccessible >& rxParent,
+ ::vcl::IAccessibleTableProvider& rBrowseBox,
+ AccessibleBrowseBoxObjType eObjType );
+
+private:
+ virtual ~AccessibleBrowseBoxHeaderBar() override;
+
+public:
+ // XAccessibleContext
+
+ /** @return
+ The XAccessible interface of the specified child.
+ */
+ virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL
+ getAccessibleChild( sal_Int32 nChildIndex ) override;
+
+ /** @return The index of this object among the parent's children. */
+ virtual sal_Int32 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;
+
+ // XAccessibleSelection
+
+ /** Selects the specified child (row or column of the table). */
+ virtual void SAL_CALL selectAccessibleChild( sal_Int32 nChildIndex ) override;
+
+ /** @return TRUE, if the specified child (row/column) is selected. */
+ virtual sal_Bool SAL_CALL isAccessibleChildSelected( sal_Int32 nChildIndex ) override;
+
+ /** Clears the complete selection. */
+ virtual void SAL_CALL clearAccessibleSelection() override;
+
+ /** Selects all children or first, if multiselection is not supported. */
+ virtual void SAL_CALL selectAllAccessibleChildren() override;
+
+ /** @return The number of selected rows/columns. */
+ virtual sal_Int32 SAL_CALL getSelectedAccessibleChildCount() override;
+
+ /** @return The specified selected row/column. */
+ virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL
+ getSelectedAccessibleChild( sal_Int32 nSelectedChildIndex ) override;
+
+ /** Removes the specified row/column from the selection. */
+ virtual void SAL_CALL deselectAccessibleChild( sal_Int32 nSelectedChildIndex ) override;
+
+ // XInterface
+
+ /** Queries for a new interface. */
+ css::uno::Any SAL_CALL queryInterface( const css::uno::Type& rType ) override;
+
+ /** Acquires the object (calls acquire() on base class). */
+ virtual void SAL_CALL acquire() noexcept override;
+
+ /** Releases the object (calls release() on base class). */
+ virtual void SAL_CALL release() noexcept 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:
+ // internal virtual methods
+
+ /** @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 tools::Rectangle implGetBoundingBoxOnScreen() override;
+
+ /** @attention This method requires locked mutex's and a living object.
+ @return The count of used rows. */
+ virtual sal_Int32 implGetRowCount() const override;
+ /** @attention This method requires locked mutex's and a living object.
+ @return The count of used columns. */
+ virtual sal_Int32 implGetColumnCount() const 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;
+
+ /** 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_uInt16 nColumnPos );
+
+ /** @attention This method requires locked mutex's and a living object.
+ @return The absolute child index from the index of selected children.
+ @throws <type>IndexOutOfBoundsException</type>
+ If the specified index is invalid. */
+ sal_Int32 implGetChildIndexFromSelectedIndex( sal_Int32 nSelectedChildIndex );
+
+ /** @attention This method requires locked mutex's and a living object.
+ @throws <type>IndexOutOfBoundsException</type>
+ If the specified row/column index (depending on type) is invalid. */
+ void ensureIsValidHeaderIndex( sal_Int32 nIndex );
+};
+
+// inlines
+
+inline bool AccessibleBrowseBoxHeaderBar::isRowBar() const
+{
+ return getType() == AccessibleBrowseBoxObjType::RowHeaderBar;
+}
+
+inline bool AccessibleBrowseBoxHeaderBar::isColumnBar() const
+{
+ return getType() == AccessibleBrowseBoxObjType::ColumnHeaderBar;
+}
+
+
+} // namespace accessibility
+
+
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */