/* -*- 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 . */ #ifndef ACCESSIBILITY_EXT_ACCESSIBLEBROWSEBOXHEADERBAR_HXX #define ACCESSIBILITY_EXT_ACCESSIBLEBROWSEBOXHEADERBAR_HXX #include "accessibility/extended/AccessibleBrowseBoxTableBase.hxx" #include #include // ============================================================================ namespace accessibility { // ============================================================================ typedef ::cppu::ImplHelper1< ::com::sun::star::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 : public AccessibleBrowseBoxTableBase, public AccessibleBrowseBoxHeaderBarImplHelper { public: /** @param eObjType One of the two allowed types BBTYPE_ROWHEADERBAR or BBTYPE_COLUMNHEADERBAR. */ AccessibleBrowseBoxHeaderBar( const ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessible >& rxParent, ::svt::IAccessibleTableProvider& rBrowseBox, ::svt::AccessibleBrowseBoxObjType eObjType ); protected: virtual ~AccessibleBrowseBoxHeaderBar(); public: // XAccessibleContext ----------------------------------------------------- /** @return The XAccessible interface of the specified child. */ virtual ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessible > SAL_CALL getAccessibleChild( sal_Int32 nChildIndex ) throw ( ::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException ); /** @return The index of this object among the parent's children. */ virtual sal_Int32 SAL_CALL getAccessibleIndexInParent() throw ( ::com::sun::star::uno::RuntimeException ); // XAccessibleComponent --------------------------------------------------- /** @return The accessible child rendered under the given point. */ virtual ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessible > SAL_CALL getAccessibleAtPoint( const ::com::sun::star::awt::Point& rPoint ) throw ( ::com::sun::star::uno::RuntimeException ); /** Grabs the focus to (the current cell of) the data table. */ virtual void SAL_CALL grabFocus() throw ( ::com::sun::star::uno::RuntimeException ); /** @return The key bindings associated with this object. */ virtual ::com::sun::star::uno::Any SAL_CALL getAccessibleKeyBinding() throw ( ::com::sun::star::uno::RuntimeException ); // XAccessibleTable ------------------------------------------------------- /** @return The description text of the specified row. */ virtual ::rtl::OUString SAL_CALL getAccessibleRowDescription( sal_Int32 nRow ) throw ( ::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException ); /** @return The description text of the specified column. */ virtual ::rtl::OUString SAL_CALL getAccessibleColumnDescription( sal_Int32 nColumn ) throw ( ::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException ); /** @return The XAccessibleTable interface of the row header bar. */ virtual ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessibleTable > SAL_CALL getAccessibleRowHeaders() throw ( ::com::sun::star::uno::RuntimeException ); /** @return The XAccessibleTable interface of the column header bar. */ virtual ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessibleTable > SAL_CALL getAccessibleColumnHeaders() throw ( ::com::sun::star::uno::RuntimeException ); /** @return An index list of completely selected rows. */ virtual ::com::sun::star::uno::Sequence< sal_Int32 > SAL_CALL getSelectedAccessibleRows() throw ( ::com::sun::star::uno::RuntimeException ); /** @return An index list of completely selected columns. */ virtual ::com::sun::star::uno::Sequence< sal_Int32 > SAL_CALL getSelectedAccessibleColumns() throw ( ::com::sun::star::uno::RuntimeException ); /** @return , if the specified row is completely selected. */ virtual sal_Bool SAL_CALL isAccessibleRowSelected( sal_Int32 nRow ) throw ( ::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException ); /** @return , if the specified column is completely selected. */ virtual sal_Bool SAL_CALL isAccessibleColumnSelected( sal_Int32 nColumn ) throw ( ::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException ); /** @return The XAccessible interface of the cell object at the specified cell position. */ virtual ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessible > SAL_CALL getAccessibleCellAt( sal_Int32 nRow, sal_Int32 nColumn ) throw ( ::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException ); /** @return , if the specified cell is selected. */ virtual sal_Bool SAL_CALL isAccessibleSelected( sal_Int32 nRow, sal_Int32 nColumn ) throw ( ::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException ); // XAccessibleSelection --------------------------------------------------- /** Selects the specified child (row or column of the table). */ virtual void SAL_CALL selectAccessibleChild( sal_Int32 nChildIndex ) throw ( ::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException ); /** @return , if the specified child (row/column) is selected. */ virtual sal_Bool SAL_CALL isAccessibleChildSelected( sal_Int32 nChildIndex ) throw ( ::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException ); /** Clears the complete selection. */ virtual void SAL_CALL clearAccessibleSelection() throw ( ::com::sun::star::uno::RuntimeException ); /** Selects all children or first, if multiselection is not supported. */ virtual void SAL_CALL selectAllAccessibleChildren() throw ( ::com::sun::star::uno::RuntimeException ); /** @return The number of selected rows/columns. */ virtual sal_Int32 SAL_CALL getSelectedAccessibleChildCount() throw ( ::com::sun::star::uno::RuntimeException ); /** @return The specified selected row/column. */ virtual ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessible > SAL_CALL getSelectedAccessibleChild( sal_Int32 nSelectedChildIndex ) throw ( ::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException ); /** Removes the specified row/column from the selection. */ virtual void SAL_CALL deselectAccessibleChild( sal_Int32 nSelectedChildIndex ) throw ( ::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException ); // XInterface ------------------------------------------------------------- /** Queries for a new interface. */ ::com::sun::star::uno::Any SAL_CALL queryInterface( const ::com::sun::star::uno::Type& rType ) throw ( ::com::sun::star::uno::RuntimeException ); /** Aquires the object (calls acquire() on base class). */ virtual void SAL_CALL acquire() throw (); /** Releases the object (calls release() on base class). */ virtual void SAL_CALL release() throw (); // XServiceInfo ----------------------------------------------------------- /** @return The name of this class. */ virtual ::rtl::OUString SAL_CALL getImplementationName() throw ( ::com::sun::star::uno::RuntimeException ); /** @return An unique implementation ID. */ virtual ::com::sun::star::uno::Sequence< sal_Int8 > SAL_CALL getImplementationId() throw ( ::com::sun::star::uno::RuntimeException ); protected: // 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 Rectangle implGetBoundingBox(); /** @attention This method requires locked mutex's and a living object. @return The bounding box (VCL rect.) in screen coordinates. */ virtual Rectangle implGetBoundingBoxOnScreen(); /** @attention This method requires locked mutex's and a living object. @return The count of used rows. */ virtual sal_Int32 implGetRowCount() const; /** @attention This method requires locked mutex's and a living object. @return The count of used columns. */ virtual sal_Int32 implGetColumnCount() const; // internal helper methods ------------------------------------------------ /** @return , if the objects is a header bar for rows. */ inline sal_Bool isRowBar() const; /** @return , if the objects is a header bar for columns. */ inline sal_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. */ ::com::sun::star::uno::Reference< ::com::sun::star::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 IndexOutOfBoundsException If the specified index is invalid. */ sal_Int32 implGetChildIndexFromSelectedIndex( sal_Int32 nSelectedChildIndex ) throw ( ::com::sun::star::lang::IndexOutOfBoundsException ); /** @attention This method requires locked mutex's and a living object. @throws IndexOutOfBoundsException If the specified row/column index (depending on type) is invalid. */ void ensureIsValidHeaderIndex( sal_Int32 nIndex ) throw ( ::com::sun::star::lang::IndexOutOfBoundsException ); }; // inlines -------------------------------------------------------------------- inline sal_Bool AccessibleBrowseBoxHeaderBar::isRowBar() const { return getType() == ::svt::BBTYPE_ROWHEADERBAR; } inline sal_Bool AccessibleBrowseBoxHeaderBar::isColumnBar() const { return getType() == ::svt::BBTYPE_COLUMNHEADERBAR; } // ============================================================================ } // namespace accessibility // ============================================================================ #endif /* vim:set shiftwidth=4 softtabstop=4 expandtab: */