accessibletable.hxx

Go to the documentation of this file.

/* -*- 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 INCLUDED_VCL_ACCESSIBLETABLE_HXX
#define INCLUDED_VCL_ACCESSIBLETABLE_HXX
 
#include <tools/gen.hxx>
 
#include <com/sun/star/uno/Reference.hxx>
 
namespace com::sun::star::accessibility { class XAccessible; }
namespace vcl { class Window; }
 
namespace vcl::table
{
 
typedef sal_Int32   RowPos;
 
enum AccessibleTableControlObjType
{
    TCTYPE_GRIDCONTROL,           
    TCTYPE_TABLE,               
    TCTYPE_ROWHEADERBAR,        
    TCTYPE_COLUMNHEADERBAR,     
    TCTYPE_TABLECELL,           
    TCTYPE_ROWHEADERCELL,       
    TCTYPE_COLUMNHEADERCELL,    
};
 
 
class IAccessibleTable
{
public:
    virtual sal_Int32               GetCurrentRow() const = 0;
    virtual sal_Int32               GetCurrentColumn() const = 0;
    virtual css::uno::Reference< css::accessibility::XAccessible > CreateAccessibleControl( sal_Int32 _nIndex )= 0;
    virtual OUString GetAccessibleObjectName(AccessibleTableControlObjType eObjType, sal_Int32 _nRow, sal_Int32 _nCol) const= 0;
    virtual void    GoToCell( sal_Int32 _nColumnPos, sal_Int32 _nRow )= 0;
    virtual bool    HasColHeader() = 0;
    virtual bool    HasRowHeader() = 0;
 
    virtual OUString GetAccessibleObjectDescription(AccessibleTableControlObjType eObjType) const= 0;
 
    virtual void FillAccessibleStateSet( sal_Int64& rStateSet,
            AccessibleTableControlObjType eObjType ) const= 0;
 
    // Window
    virtual tools::Rectangle GetWindowExtentsAbsolute() const = 0;
    virtual tools::Rectangle GetWindowExtentsRelative(const vcl::Window& rRelativeWindow) const = 0;
    virtual void GrabFocus()= 0;
    virtual css::uno::Reference< css::accessibility::XAccessible > GetAccessible()= 0;
    virtual vcl::Window* GetAccessibleParentWindow() const= 0;
    virtual vcl::Window* GetWindowInstance()= 0;
    virtual sal_Int32 GetAccessibleControlCount() const = 0;
    virtual bool ConvertPointToControlIndex( sal_Int32& _rnIndex, const Point& _rPoint )= 0;
    virtual sal_Int32 GetRowCount() const= 0;
    virtual sal_Int32 GetColumnCount() const= 0;
    virtual bool ConvertPointToCellAddress( sal_Int32& _rnRow, sal_Int32& _rnColPos, const Point& _rPoint )= 0;
    virtual tools::Rectangle calcHeaderRect( bool _bIsColumnBar ) = 0;
    virtual tools::Rectangle calcHeaderCellRect( bool _bColHeader, sal_Int32 _nPos ) = 0;
    virtual tools::Rectangle calcTableRect() = 0;
    virtual tools::Rectangle calcCellRect( sal_Int32 _nRowPos, sal_Int32 _nColPos ) = 0;
    virtual tools::Rectangle GetFieldCharacterBounds(sal_Int32 _nRow,sal_Int32 _nColumnPos,sal_Int32 nIndex)= 0;
    virtual sal_Int32 GetFieldIndexAtPoint(sal_Int32 _nRow,sal_Int32 _nColumnPos,const Point& _rPoint)= 0;
    virtual void FillAccessibleStateSetForCell( sal_Int64& _rStateSet, sal_Int32 _nRow, sal_uInt16 _nColumnPos ) const= 0;
    virtual OUString GetRowName(sal_Int32 _nIndex) const = 0;
    virtual OUString GetColumnName( sal_Int32 _nIndex ) const = 0;
    virtual OUString GetAccessibleCellText(sal_Int32 _nRowPos, sal_Int32 _nColPos) const = 0;
 
    virtual sal_Int32 GetSelectedRowCount() const = 0;
    virtual sal_Int32 GetSelectedRowIndex( sal_Int32 const i_selectionIndex ) const = 0;
    virtual bool IsRowSelected( sal_Int32 const i_rowIndex ) const = 0;
    virtual void SelectRow( sal_Int32 const i_rowIndex, bool const i_select ) = 0;
    virtual void SelectAllRows( bool const i_select ) = 0;
 
protected:
    ~IAccessibleTable() {}
};
 
 
class IAccessibleTableControl
{
public:
    virtual css::uno::Reference< css::accessibility::XAccessible >
        getMyself() = 0;
 
    virtual void DisposeAccessImpl() = 0;
 
    virtual bool isAlive() const = 0;
 
     virtual void commitCellEvent(
         sal_Int16 nEventId,
         const css::uno::Any& rNewValue,
         const css::uno::Any& rOldValue
     ) = 0;
     virtual void commitTableEvent(
         sal_Int16 nEventId,
         const css::uno::Any& rNewValue,
         const css::uno::Any& rOldValue
     ) = 0;
 
    virtual void commitEvent(
        sal_Int16 nEventId,
        const css::uno::Any& rNewValue
    ) = 0;
 
protected:
    ~IAccessibleTableControl() {}
};
 
} // namespace vcl::table
 
#endif // INCLUDED_VCL_ACCESSIBLETABLE_HXX
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */