accessiblecomponenthelper.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_COMPHELPER_ACCESSIBLECOMPONENTHELPER_HXX
#define INCLUDED_COMPHELPER_ACCESSIBLECOMPONENTHELPER_HXX
 
#include <com/sun/star/accessibility/XAccessibleComponent.hpp>
#include <com/sun/star/accessibility/XAccessibleContext2.hpp>
#include <com/sun/star/accessibility/XAccessibleEventBroadcaster.hpp>
#include <com/sun/star/accessibility/XAccessibleExtendedComponent.hpp>
#include <comphelper/accessibleeventnotifier.hxx>
#include <cppuhelper/basemutex.hxx>
#include <cppuhelper/compbase.hxx>
#include <cppuhelper/implbase.hxx>
#include <comphelper/uno3.hxx>
#include <comphelper/comphelperdllapi.h>
 
 
namespace comphelper
{
 
 
    //= OCommonAccessibleComponent
 
    typedef ::cppu::WeakComponentImplHelper <   css::accessibility::XAccessibleContext2,
                                                css::accessibility::XAccessibleEventBroadcaster
                                            >   OCommonAccessibleComponent_Base;
 
    class COMPHELPER_DLLPUBLIC OCommonAccessibleComponent
                :public ::cppu::BaseMutex
                ,public OCommonAccessibleComponent_Base
    {
        friend class OContextEntryGuard;
    private:
        css::uno::WeakReference< css::accessibility::XAccessible > m_aCreator;         // the XAccessible which created our XAccessibleContext
        AccessibleEventNotifier::TClientId m_nClientId;
 
    protected:
        virtual ~OCommonAccessibleComponent( ) override;
 
        OCommonAccessibleComponent( );
 
        void    lateInit( const css::uno::Reference< css::accessibility::XAccessible >& _rxAccessible );
 
        css::uno::Reference< css::accessibility::XAccessible >
                getAccessibleCreator( ) const;
 
    public:
        // 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;
 
        // XAccessibleContext - still waiting to be overwritten
        virtual sal_Int64 SAL_CALL getAccessibleChildCount(  ) override = 0;
        virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL getAccessibleChild( sal_Int64 i ) override = 0;
        virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL getAccessibleParent(  ) override = 0;
        virtual sal_Int16 SAL_CALL getAccessibleRole(  ) override = 0;
        virtual OUString SAL_CALL getAccessibleDescription(  ) override = 0;
        virtual OUString SAL_CALL getAccessibleName(  ) override = 0;
        virtual css::uno::Reference< css::accessibility::XAccessibleRelationSet > SAL_CALL getAccessibleRelationSet(  ) override = 0;
        virtual sal_Int64 SAL_CALL getAccessibleStateSet(  ) override = 0;
 
        // XAccessibleContext2 - default implementation
        virtual OUString SAL_CALL getAccessibleId(  ) override;
 
        // XAccessibleContext - default implementations
        virtual sal_Int64 SAL_CALL getAccessibleIndexInParent(  ) override;
        virtual css::lang::Locale SAL_CALL getLocale(  ) override;
 
    protected:
        // OComponentHelper
        virtual void SAL_CALL disposing() override;
 
    protected:
        // helper
        void NotifyAccessibleEvent(
                    const sal_Int16 _nEventId,
                    const css::uno::Any& _rOldValue,
                    const css::uno::Any& _rNewValue,
                    sal_Int32 nIndexHint = -1
                );
 
        // life time control
        bool    isAlive() const;
        void        ensureAlive() const;
 
        void        ensureDisposed( );
 
        css::uno::Reference< css::accessibility::XAccessibleContext >
                    implGetParentContext();
 
        // access to the base class' broadcast helper/mutex
        ::osl::Mutex&                   GetMutex()                  { return m_aMutex; }
 
    protected:
        virtual css::awt::Rectangle implGetBounds(  ) = 0;
 
    protected:
        bool containsPoint( const css::awt::Point& aPoint );
        css::awt::Point getLocation(  );
        css::awt::Point getLocationOnScreen(  );
        css::awt::Size getSize(  );
        css::awt::Rectangle getBounds(  );
    };
 
 
    //= OAccessibleComponentHelper
 
 
    class COMPHELPER_DLLPUBLIC OAccessibleComponentHelper
            :public cppu::ImplInheritanceHelper<
                 OCommonAccessibleComponent, css::accessibility::XAccessibleComponent>
    {
    private:
        OAccessibleComponentHelper(OAccessibleComponentHelper const &) = delete;
        OAccessibleComponentHelper(OAccessibleComponentHelper &&) = delete;
        void operator =(OAccessibleComponentHelper const &) = delete;
        void operator =(OAccessibleComponentHelper &&) = delete;
 
    protected:
        OAccessibleComponentHelper();
 
    public:
        // XAccessibleComponent - default implementations
        virtual sal_Bool SAL_CALL containsPoint( const css::awt::Point& aPoint ) 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 css::awt::Rectangle SAL_CALL getBounds(  ) override;
    };
 
 
    //= OAccessibleExtendedComponentHelper
 
 
    class COMPHELPER_DLLPUBLIC OAccessibleExtendedComponentHelper
            :public cppu::ImplInheritanceHelper<
                 OCommonAccessibleComponent, css::accessibility::XAccessibleExtendedComponent>
    {
    private:
        OAccessibleExtendedComponentHelper(OAccessibleExtendedComponentHelper const &) = delete;
        OAccessibleExtendedComponentHelper(OAccessibleExtendedComponentHelper &&) = delete;
        void operator =(OAccessibleExtendedComponentHelper const &) = delete;
        void operator =(OAccessibleExtendedComponentHelper &&) = delete;
 
    protected:
        OAccessibleExtendedComponentHelper( );
 
    public:
        // XAccessibleComponent - default implementations
        virtual sal_Bool SAL_CALL containsPoint( const css::awt::Point& aPoint ) 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 css::awt::Rectangle SAL_CALL getBounds(  ) override;
    };
 
 
}   // namespace comphelper
 
 
#endif // INCLUDED_COMPHELPER_ACCESSIBLECOMPONENTHELPER_HXX
 
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */