AccessibleGridControlBase.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 .
 */
 
 
#pragma once
 
#include <vcl/accessibletable.hxx>
#include <rtl/ustring.hxx>
#include <rtl/ref.hxx>
#include <tools/gen.hxx>
#include <cppuhelper/compbase.hxx>
#include <cppuhelper/implbase1.hxx>
#include <cppuhelper/basemutex.hxx>
#include <com/sun/star/lang/XServiceInfo.hpp>
#include <com/sun/star/accessibility/XAccessible.hpp>
#include <com/sun/star/accessibility/XAccessibleContext.hpp>
#include <com/sun/star/accessibility/XAccessibleComponent.hpp>
#include <com/sun/star/accessibility/XAccessibleEventBroadcaster.hpp>
#include <comphelper/accessibleeventnotifier.hxx>
#include <comphelper/uno3.hxx>
 
 
namespace vcl { class Window; }
 
 
namespace accessibility {
 
typedef ::cppu::WeakComponentImplHelper<
            css::accessibility::XAccessibleContext,
            css::accessibility::XAccessibleComponent,
            css::accessibility::XAccessibleEventBroadcaster,
            css::lang::XServiceInfo >
        AccessibleGridControlImplHelper;
 
class AccessibleGridControlBase :
    public ::cppu::BaseMutex,
    public AccessibleGridControlImplHelper
{
public:
    AccessibleGridControlBase(
        css::uno::Reference< css::accessibility::XAccessible > xParent,
        ::vcl::table::IAccessibleTable& rTable,
        ::vcl::table::AccessibleTableControlObjType  eObjType );
 
protected:
    virtual ~AccessibleGridControlBase() override;
 
    virtual void SAL_CALL disposing() override;
 
public:
    // XAccessibleContext
 
    virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL
    getAccessibleParent() override;
 
    virtual sal_Int64 SAL_CALL getAccessibleIndexInParent() override;
 
    virtual OUString SAL_CALL getAccessibleDescription() override;
 
    virtual OUString SAL_CALL getAccessibleName() override;
 
    virtual css::uno::Reference< css::accessibility::XAccessibleRelationSet > SAL_CALL
        getAccessibleRelationSet() override;
 
    virtual sal_Int64 SAL_CALL getAccessibleStateSet() override;
 
    virtual css::lang::Locale SAL_CALL getLocale() override;
 
    virtual sal_Int16 SAL_CALL getAccessibleRole() override;
 
    /*  Derived classes have to implement:
        -   getAccessibleChildCount,
        -   getAccessibleChild,
        -   getAccessibleRole.
        Derived classes may overwrite getAccessibleIndexInParent to increase
        performance. */
 
    // XAccessibleComponent
 
    virtual sal_Bool SAL_CALL containsPoint( const css::awt::Point& rPoint ) override;
 
    virtual css::awt::Rectangle SAL_CALL getBounds() override;
 
    virtual css::awt::Point SAL_CALL getLocation() override;
 
    virtual css::awt::Point SAL_CALL getLocationOnScreen() override;
 
    virtual css::awt::Size SAL_CALL getSize() override;
 
    virtual sal_Int32 SAL_CALL getForeground(  ) override;
    virtual sal_Int32 SAL_CALL getBackground(  ) override;
 
 
    /*  Derived classes have to implement:
        -   getAccessibleAt,
        -   grabFocus. */
 
    virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL
    getAccessibleAtPoint( const css::awt::Point& rPoint ) override;
 
    // XAccessibleEventBroadcaster
 
    virtual void SAL_CALL addAccessibleEventListener(
            const css::uno::Reference< css::accessibility::XAccessibleEventListener>& rxListener ) override;
 
    virtual void SAL_CALL removeAccessibleEventListener(
            const css::uno::Reference< css::accessibility::XAccessibleEventListener>& rxListener ) override;
 
    // XTypeProvider
 
    virtual css::uno::Sequence< sal_Int8 > SAL_CALL getImplementationId() override;
 
    // XServiceInfo
 
    virtual sal_Bool SAL_CALL supportsService( const OUString& rServiceName ) override;
 
    virtual css::uno::Sequence< OUString > SAL_CALL
    getSupportedServiceNames() override;
 
    /*  Derived classes have to implement:
        -   getImplementationName. */
 
    // helper methods
 
    inline ::vcl::table::AccessibleTableControlObjType getType() const;
 
    virtual void commitEvent(sal_Int16 nEventId, const css::uno::Any& rNewValue,
                             const css::uno::Any& rOldValue);
    bool isAlive() const;
 
protected:
    // internal virtual methods
 
    bool implIsShowing();
 
    virtual tools::Rectangle implGetBoundingBox() = 0;
    //    @attention  This method requires locked mutex's and a living object.
    //    @return  The bounding box (VCL rect.) in screen coordinates. */
    virtual tools::Rectangle implGetBoundingBoxOnScreen() = 0;
 
    virtual sal_Int64 implCreateStateSet();
 
    // internal helper methods
 
    void ensureIsAlive() const;
 
    tools::Rectangle getBoundingBox();
    //    coordinates.
    //    @return  The bounding box (VCL rect.) in screen coordinates. */
    tools::Rectangle getBoundingBoxOnScreen();
 
    ::comphelper::AccessibleEventNotifier::TClientId getClientId() const { return m_aClientId; }
    void setClientId(::comphelper::AccessibleEventNotifier::TClientId _aNewClientId) { m_aClientId = _aNewClientId; }
 
protected:
    // members
 
    css::uno::Reference< css::accessibility::XAccessible > m_xParent;
    ::vcl::table::IAccessibleTable& m_aTable;
    ::vcl::table::AccessibleTableControlObjType m_eObjType;
 
private:
    ::comphelper::AccessibleEventNotifier::TClientId    m_aClientId;
};
 
 
// a version of AccessibleGridControlBase which implements not only the XAccessibleContext,
// but also the XAccessible
 
typedef ::cppu::ImplHelper1 <   css::accessibility::XAccessible
                            >   GridControlAccessibleElement_Base;
 
class GridControlAccessibleElement
            :public AccessibleGridControlBase
            ,public GridControlAccessibleElement_Base
{
protected:
    GridControlAccessibleElement(
        const css::uno::Reference< css::accessibility::XAccessible >& rxParent,
        ::vcl::table::IAccessibleTable& rTable,
        ::vcl::table::AccessibleTableControlObjType  eObjType );
 
public:
    // XInterface
    DECLARE_XINTERFACE( )
    // XTypeProvider
    DECLARE_XTYPEPROVIDER( )
 
protected:
    virtual ~GridControlAccessibleElement() override;
 
protected:
    // XAccessible
 
    virtual css::uno::Reference< css::accessibility::XAccessibleContext > SAL_CALL
    getAccessibleContext() override;
 
private:
    GridControlAccessibleElement( const GridControlAccessibleElement& ) = delete;
    GridControlAccessibleElement& operator=( const GridControlAccessibleElement& ) = delete;
};
 
// inlines
 
inline ::vcl::table::AccessibleTableControlObjType AccessibleGridControlBase::getType() const
{
    return m_eObjType;
}
 
 
} // namespace accessibility
 
 
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */