blob: 82a71b3fdad2ec556157509f11a66b63cdcde938 [file] [log] [blame]
/**************************************************************
*
* 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
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*
*************************************************************/
#ifndef ACCESSIBILITY_EXT_ACCESSIBLEBROWSEBOXTABLE_HXX
#define ACCESSIBILITY_EXT_ACCESSIBLEBROWSEBOXTABLE_HXX
#include "accessibility/extended/AccessibleBrowseBoxTableBase.hxx"
// ============================================================================
namespace accessibility {
// ============================================================================
/** This class represents the accessible object of the data table of a
BrowseBox control. */
class AccessibleBrowseBoxTable : public AccessibleBrowseBoxTableBase
{
friend class AccessibleBrowseBox; // to create header bars
public:
AccessibleBrowseBoxTable(
const ::com::sun::star::uno::Reference<
::com::sun::star::accessibility::XAccessible >& rxParent,
::svt::IAccessibleTableProvider& rBrowseBox );
protected:
virtual ~AccessibleBrowseBoxTable();
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 <TRUE/>, 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 <TRUE/>, 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 <TRUE/>, 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 );
// XServiceInfo -----------------------------------------------------------
/** @return The name of this class. */
virtual ::rtl::OUString SAL_CALL getImplementationName()
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();
// internal helper methods ------------------------------------------------
/** @attention This method requires a locked mutex.
@return The XAccessibleTable interface of the specified header bar. */
::com::sun::star::uno::Reference<
::com::sun::star::accessibility::XAccessibleTable >
implGetHeaderBar( sal_Int32 nChildIndex )
throw ( ::com::sun::star::uno::RuntimeException );
};
// ============================================================================
} // namespace accessibility
// ============================================================================
#endif