AccessibleBase.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 <ObjectIdentifier.hxx>
 
#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/lang/XServiceInfo.hpp>
#include <com/sun/star/lang/XEventListener.hpp>
#include <com/sun/star/accessibility/XAccessibleEventBroadcaster.hpp>
#include <comphelper/accessibleeventnotifier.hxx>
#include <cppuhelper/basemutex.hxx>
#include <cppuhelper/compbase.hxx>
#include <rtl/ref.hxx>
#include <tools/color.hxx>
#include <unotools/weakref.hxx>
 
#include <map>
#include <vector>
#include <memory>
 
namespace com::sun::star::awt { class XWindow; }
namespace com::sun::star::chart2 { class XChartDocument; }
namespace com::sun::star::view { class XSelectionSupplier; }
 
 
class SdrView;
 
namespace accessibility
{
class IAccessibleViewForwarder;
}
 
namespace chart
{
 
class AccessibleBase;
class ChartView;
class ObjectHierarchy;
 
typedef ObjectIdentifier AccessibleUniqueId;
 
struct AccessibleElementInfo
{
    AccessibleUniqueId m_aOID;
 
    unotools::WeakReference< ::chart::ChartModel > m_xChartDocument;
    css::uno::WeakReference< css::view::XSelectionSupplier > m_xSelectionSupplier;
    unotools::WeakReference< ::chart::ChartView >   m_xView;
    css::uno::WeakReference< css::awt::XWindow >      m_xWindow;
 
    std::shared_ptr< ObjectHierarchy > m_spObjectHierarchy;
 
    AccessibleBase * m_pParent;
    SdrView* m_pSdrView;
    ::accessibility::IAccessibleViewForwarder* m_pViewForwarder;
};
 
namespace impl
{
typedef ::cppu::WeakComponentImplHelper<
        css::accessibility::XAccessible,
        css::accessibility::XAccessibleContext,
        css::accessibility::XAccessibleComponent,
        css::accessibility::XAccessibleEventBroadcaster,
        css::lang::XServiceInfo,
        css::lang::XEventListener
        > AccessibleBase_Base;
}
 
class AccessibleBase :
    public cppu::BaseMutex,
    public impl::AccessibleBase_Base
{
public:
    enum class EventType
    {
        GOT_SELECTION,
        LOST_SELECTION
    };
 
    AccessibleBase( AccessibleElementInfo aAccInfo,
                    bool bMayHaveChildren,
                    bool bAlwaysTransparent );
    virtual ~AccessibleBase() override;
 
protected:
    // for all calls to protected methods it is assumed that the mutex is locked
    // unless calls outside via UNO, e.g. event notification, are done
 
    bool             CheckDisposeState( bool bThrowException = true ) const;
 
    bool     NotifyEvent( EventType eType, const AccessibleUniqueId & rId );
 
    void             AddState( sal_Int64 aState );
 
    void             RemoveState( sal_Int64 aState );
 
    bool UpdateChildren();
 
    virtual bool ImplUpdateChildren();
 
    void         AddChild( AccessibleBase* pChild );
 
    void         RemoveChildByOId( const ObjectIdentifier& rOId );
 
    virtual css::awt::Point   GetUpperLeftOnScreen() const;
 
    void         BroadcastAccEvent( sal_Int16 nId,
                                    const css::uno::Any & rNew,
                                    const css::uno::Any & rOld ) const;
 
    void KillAllChildren();
 
    virtual css::uno::Reference< css::accessibility::XAccessible >
        ImplGetAccessibleChildById( sal_Int64 i ) const;
 
    virtual sal_Int64 ImplGetAccessibleChildCount() const;
 
    const AccessibleElementInfo& GetInfo() const { return m_aAccInfo;}
    void SetInfo( const AccessibleElementInfo & rNewInfo );
    const AccessibleUniqueId& GetId() const { return m_aAccInfo.m_aOID;}
 
    // ________ WeakComponentImplHelper (XComponent::dispose) ________
    virtual void SAL_CALL disposing() override;
 
    // ________ XAccessible ________
    virtual css::uno::Reference< css::accessibility::XAccessibleContext > SAL_CALL getAccessibleContext() override;
 
    // ________ XAccessibleContext ________
    virtual sal_Int64 SAL_CALL getAccessibleChildCount() override;
    virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL
        getAccessibleChild( sal_Int64 i ) override;
    virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL
        getAccessibleParent() override;
    virtual sal_Int64 SAL_CALL getAccessibleIndexInParent() override;
    virtual sal_Int16 SAL_CALL getAccessibleRole() override;
    // has to be implemented by derived classes
//     virtual OUString SAL_CALL getAccessibleName()
//         throw (css::uno::RuntimeException);
    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;
    // has to be implemented by derived classes
//     virtual OUString SAL_CALL getAccessibleDescription()
//         throw (css::uno::RuntimeException);
 
    // ________ XAccessibleComponent ________
    virtual sal_Bool SAL_CALL containsPoint(
        const css::awt::Point& aPoint ) override;
    virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL
        getAccessibleAtPoint( const css::awt::Point& aPoint ) override;
    // has to be defined in derived classes
    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 void SAL_CALL grabFocus() override;
    virtual sal_Int32 SAL_CALL getForeground() override;
    virtual sal_Int32 SAL_CALL getBackground() override;
 
    // ________ XServiceInfo ________
    virtual OUString SAL_CALL getImplementationName() override;
    virtual sal_Bool SAL_CALL supportsService(
        const OUString& ServiceName ) override;
    virtual css::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames() override;
 
    // ________ XEventListener ________
    virtual void SAL_CALL disposing(
        const css::lang::EventObject& Source ) override;
 
    // ________ XAccessibleEventBroadcaster ________
    virtual void SAL_CALL addAccessibleEventListener(
        const css::uno::Reference< css::accessibility::XAccessibleEventListener >& xListener ) override;
    virtual void SAL_CALL removeAccessibleEventListener(
        const css::uno::Reference< css::accessibility::XAccessibleEventListener >& xListener ) override;
 
private:
    enum eColorType
    {
        ACC_BASE_FOREGROUND,
        ACC_BASE_BACKGROUND
    };
    Color getColor( eColorType eColType );
 
private:
    typedef std::vector< css::uno::Reference< css::accessibility::XAccessible > > ChildListVectorType;
    typedef std::map< ObjectIdentifier, css::uno::Reference< css::accessibility::XAccessible > > ChildOIDMap;
 
    bool                                  m_bIsDisposed;
    const bool                            m_bMayHaveChildren;
    bool                                  m_bChildrenInitialized;
    ChildListVectorType                   m_aChildList;
 
    ChildOIDMap                           m_aChildOIDMap;
 
    ::comphelper::AccessibleEventNotifier::TClientId      m_nEventNotifierId;
 
    sal_Int64     m_nStateSet;
 
    AccessibleElementInfo  m_aAccInfo;
    const bool             m_bAlwaysTransparent;
    volatile bool          m_bStateSetInitialized;
};
 
}  // namespace chart
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */