Files
libreoffice/sw/source/core/access/acctable.hxx
2011-01-31 12:06:07 +01:00

333 lines
13 KiB
C++

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef _ACCTABLE_HXX
#define _ACCTABLE_HXX
#include <com/sun/star/accessibility/XAccessibleTable.hpp>
#include <com/sun/star/accessibility/XAccessibleSelection.hpp>
#include <acccontext.hxx>
class SwTabFrm;
class SwAccessibleTableData_Impl;
class SwTableBox;
class SwSelBoxes;
namespace sw { namespace access {
class SwAccessibleChild;
} }
class SwAccessibleTable :
public SwAccessibleContext,
public ::com::sun::star::accessibility::XAccessibleTable,
public ::com::sun::star::accessibility::XAccessibleSelection,
public SwClient
{
SwAccessibleTableData_Impl *mpTableData; // the table's data, prot by Sol-Mutex
::rtl::OUString sDesc;
const SwSelBoxes *GetSelBoxes() const;
void FireTableChangeEvent( const SwAccessibleTableData_Impl& rTableData );
/** get the SwTableBox* for the given child */
const SwTableBox* GetTableBox( sal_Int32 ) const;
sal_Bool IsChildSelected( sal_Int32 nChildIndex ) const;
sal_Int32 GetIndexOfSelectedChild( sal_Int32 nSelectedChildIndex ) const;
protected:
// Set states for getAccessibleStateSet.
// This drived class additinaly sets MULTISELECTABLE(+)
virtual void GetStates( ::utl::AccessibleStateSetHelper& rStateSet );
virtual ~SwAccessibleTable();
// #i77106#
inline void SetDesc( ::rtl::OUString sNewDesc )
{
sDesc = sNewDesc;
}
virtual SwAccessibleTableData_Impl* CreateNewTableData(); // #i77106#
// force update of table data
void UpdateTableData();
// remove the current table data
void ClearTableData();
// get table data, update if necessary
inline SwAccessibleTableData_Impl& GetTableData();
// Is table data evailable?
sal_Bool HasTableData() const { return (mpTableData != 0); }
public:
SwAccessibleTable( SwAccessibleMap* pInitMap, const SwTabFrm* pTableFrm );
virtual void Modify( SfxPoolItem *pOld, SfxPoolItem *pNew);
//===== XInterface ======================================================
// (XInterface methods need to be implemented to disambigouate
// between those inherited through SwAcessibleContext and
// XAccessibleTable).
virtual ::com::sun::star::uno::Any SAL_CALL queryInterface(
const ::com::sun::star::uno::Type& aType )
throw (::com::sun::star::uno::RuntimeException);
virtual void SAL_CALL acquire( ) throw ()
{ SwAccessibleContext::acquire(); };
virtual void SAL_CALL release( ) throw ()
{ SwAccessibleContext::release(); };
//====== XTypeProvider ====================================================
virtual ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Type > SAL_CALL getTypes( ) throw(::com::sun::star::uno::RuntimeException);
virtual ::com::sun::star::uno::Sequence< sal_Int8 > SAL_CALL getImplementationId( ) throw(::com::sun::star::uno::RuntimeException);
//===== XAccessibleContext ==============================================
/// Return this object's description.
virtual ::rtl::OUString SAL_CALL
getAccessibleDescription (void)
throw (com::sun::star::uno::RuntimeException);
//===== XAccessibleTable ================================================
virtual sal_Int32 SAL_CALL getAccessibleRowCount()
throw (::com::sun::star::uno::RuntimeException);
virtual sal_Int32 SAL_CALL getAccessibleColumnCount( )
throw (::com::sun::star::uno::RuntimeException);
virtual ::rtl::OUString SAL_CALL getAccessibleRowDescription(
sal_Int32 nRow )
throw (::com::sun::star::lang::IndexOutOfBoundsException,
::com::sun::star::uno::RuntimeException);
virtual ::rtl::OUString SAL_CALL getAccessibleColumnDescription(
sal_Int32 nColumn )
throw (::com::sun::star::lang::IndexOutOfBoundsException,
::com::sun::star::uno::RuntimeException);
virtual sal_Int32 SAL_CALL getAccessibleRowExtentAt(
sal_Int32 nRow, sal_Int32 nColumn )
throw (::com::sun::star::lang::IndexOutOfBoundsException,
::com::sun::star::uno::RuntimeException);
virtual sal_Int32 SAL_CALL getAccessibleColumnExtentAt(
sal_Int32 nRow, sal_Int32 nColumn )
throw (::com::sun::star::lang::IndexOutOfBoundsException,
::com::sun::star::uno::RuntimeException);
virtual ::com::sun::star::uno::Reference<
::com::sun::star::accessibility::XAccessibleTable >
SAL_CALL getAccessibleRowHeaders( )
throw (::com::sun::star::uno::RuntimeException);
virtual ::com::sun::star::uno::Reference<
::com::sun::star::accessibility::XAccessibleTable >
SAL_CALL getAccessibleColumnHeaders( )
throw (::com::sun::star::uno::RuntimeException);
virtual ::com::sun::star::uno::Sequence< sal_Int32 > SAL_CALL
getSelectedAccessibleRows( )
throw (::com::sun::star::uno::RuntimeException);
virtual ::com::sun::star::uno::Sequence< sal_Int32 > SAL_CALL
getSelectedAccessibleColumns( )
throw (::com::sun::star::uno::RuntimeException);
virtual sal_Bool SAL_CALL isAccessibleRowSelected( sal_Int32 nRow )
throw (::com::sun::star::lang::IndexOutOfBoundsException,
::com::sun::star::uno::RuntimeException);
virtual sal_Bool SAL_CALL isAccessibleColumnSelected( sal_Int32 nColumn )
throw (::com::sun::star::lang::IndexOutOfBoundsException,
::com::sun::star::uno::RuntimeException);
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);
virtual ::com::sun::star::uno::Reference<
::com::sun::star::accessibility::XAccessible > SAL_CALL
getAccessibleCaption( )
throw (::com::sun::star::uno::RuntimeException);
virtual ::com::sun::star::uno::Reference<
::com::sun::star::accessibility::XAccessible > SAL_CALL
getAccessibleSummary( )
throw (::com::sun::star::uno::RuntimeException);
virtual sal_Bool SAL_CALL isAccessibleSelected(
sal_Int32 nRow, sal_Int32 nColumn )
throw (::com::sun::star::lang::IndexOutOfBoundsException,
::com::sun::star::uno::RuntimeException);
virtual sal_Int32 SAL_CALL getAccessibleIndex(
sal_Int32 nRow, sal_Int32 nColumn )
throw (::com::sun::star::lang::IndexOutOfBoundsException,
::com::sun::star::uno::RuntimeException);
virtual sal_Int32 SAL_CALL getAccessibleRow( sal_Int32 nChildIndex )
throw (::com::sun::star::lang::IndexOutOfBoundsException,
::com::sun::star::uno::RuntimeException);
virtual sal_Int32 SAL_CALL getAccessibleColumn( sal_Int32 nChildIndex )
throw (::com::sun::star::lang::IndexOutOfBoundsException,
::com::sun::star::uno::RuntimeException);
//===== XServiceInfo ====================================================
/** Returns an identifier for the implementation of this object.
*/
virtual ::rtl::OUString SAL_CALL
getImplementationName (void)
throw (::com::sun::star::uno::RuntimeException);
/** Return whether the specified service is supported by this class.
*/
virtual sal_Bool SAL_CALL
supportsService (const ::rtl::OUString& sServiceName)
throw (::com::sun::star::uno::RuntimeException);
/** Returns a list of all supported services. In this case that is just
the AccessibleContext service.
*/
virtual ::com::sun::star::uno::Sequence< ::rtl::OUString> SAL_CALL
getSupportedServiceNames (void)
throw (::com::sun::star::uno::RuntimeException);
//===== C++ interface ======================================================
// The object has been moved by the layout
virtual void InvalidatePosOrSize( const SwRect& rOldBox );
// The object is not visible an longer and should be destroyed
virtual void Dispose( sal_Bool bRecursive = sal_False );
virtual void DisposeChild( const sw::access::SwAccessibleChild& rFrmOrObj,
sal_Bool bRecursive );
virtual void InvalidateChildPosOrSize( const sw::access::SwAccessibleChild& rFrmOrObj,
const SwRect& rFrm );
//===== XAccessibleSelection ============================================
virtual void SAL_CALL selectAccessibleChild(
sal_Int32 nChildIndex )
throw ( ::com::sun::star::lang::IndexOutOfBoundsException,
::com::sun::star::uno::RuntimeException );
virtual sal_Bool SAL_CALL isAccessibleChildSelected(
sal_Int32 nChildIndex )
throw ( ::com::sun::star::lang::IndexOutOfBoundsException,
::com::sun::star::uno::RuntimeException );
virtual void SAL_CALL clearAccessibleSelection( )
throw ( ::com::sun::star::uno::RuntimeException );
virtual void SAL_CALL selectAllAccessibleChildren( )
throw ( ::com::sun::star::uno::RuntimeException );
virtual sal_Int32 SAL_CALL getSelectedAccessibleChildCount( )
throw ( ::com::sun::star::uno::RuntimeException );
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);
// index has to be treated as global child index.
virtual void SAL_CALL deselectAccessibleChild(
sal_Int32 nChildIndex )
throw ( ::com::sun::star::lang::IndexOutOfBoundsException,
::com::sun::star::uno::RuntimeException );
};
inline SwAccessibleTableData_Impl& SwAccessibleTable::GetTableData()
{
if( !mpTableData )
UpdateTableData();
return *mpTableData;
}
// #i77106# - subclass to represent table column headers
class SwAccessibleTableColHeaders : public SwAccessibleTable
{
protected:
virtual ~SwAccessibleTableColHeaders()
{}
virtual SwAccessibleTableData_Impl* CreateNewTableData();
public:
SwAccessibleTableColHeaders( SwAccessibleMap *pMap, const SwTabFrm *pTabFrm );
virtual void Modify( SfxPoolItem *pOld, SfxPoolItem *pNew);
//===== XInterface ======================================================
virtual ::com::sun::star::uno::Any SAL_CALL queryInterface(
const ::com::sun::star::uno::Type& aType )
throw (::com::sun::star::uno::RuntimeException);
virtual void SAL_CALL acquire( ) throw ()
{ SwAccessibleContext::acquire(); };
virtual void SAL_CALL release( ) throw ()
{ SwAccessibleContext::release(); };
//===== XAccessibleContext ==============================================
/// Return the number of currently visible children.
virtual sal_Int32 SAL_CALL getAccessibleChildCount (void)
throw (::com::sun::star::uno::RuntimeException);
/// Return the specified child or NULL if index is invalid.
virtual ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessible> SAL_CALL
getAccessibleChild (sal_Int32 nIndex)
throw (::com::sun::star::uno::RuntimeException,
::com::sun::star::lang::IndexOutOfBoundsException);
//===== XAccessibleTable ================================================
virtual ::com::sun::star::uno::Reference<
::com::sun::star::accessibility::XAccessibleTable >
SAL_CALL getAccessibleRowHeaders( )
throw (::com::sun::star::uno::RuntimeException);
virtual ::com::sun::star::uno::Reference<
::com::sun::star::accessibility::XAccessibleTable >
SAL_CALL getAccessibleColumnHeaders( )
throw (::com::sun::star::uno::RuntimeException);
//===== XServiceInfo ====================================================
/** Returns an identifier for the implementation of this object.
*/
virtual ::rtl::OUString SAL_CALL
getImplementationName (void)
throw (::com::sun::star::uno::RuntimeException);
};
// <--
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */