AccessibleBrowseBoxBase.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 <sal/config.h>
 
#include <vcl/AccessibleBrowseBoxObjType.hxx>
#include <rtl/ustring.hxx>
#include <tools/gen.hxx>
#include <vcl/svapp.hxx>
#include <cppuhelper/compbase.hxx>
#include <cppuhelper/implbase1.hxx>
#include <cppuhelper/basemutex.hxx>
#include <com/sun/star/lang/XServiceInfo.hpp>
#include <com/sun/star/awt/XWindow.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 <com/sun/star/awt/XFocusListener.hpp>
#include <comphelper/accessibleeventnotifier.hxx>
#include <comphelper/uno3.hxx>
 
 
namespace vcl { class Window; }
 
namespace vcl {
    class IAccessibleTableProvider;
}
 
namespace accessibility {
 
typedef ::cppu::WeakComponentImplHelper<
            css::accessibility::XAccessibleContext,
            css::accessibility::XAccessibleComponent,
            css::accessibility::XAccessibleEventBroadcaster,
            css::awt::XFocusListener,
            css::lang::XServiceInfo >
        AccessibleBrowseBoxImplHelper;
 
class AccessibleBrowseBoxBase :
    public ::cppu::BaseMutex,
    public AccessibleBrowseBoxImplHelper
{
public:
    AccessibleBrowseBoxBase(
        css::uno::Reference< css::accessibility::XAccessible > xParent,
        ::vcl::IAccessibleTableProvider& rBrowseBox,
        css::uno::Reference< css::awt::XWindow >  _xFocusWindow,
        AccessibleBrowseBoxObjType eObjType );
 
    AccessibleBrowseBoxBase(
        css::uno::Reference< css::accessibility::XAccessible > xParent,
        ::vcl::IAccessibleTableProvider& rBrowseBox,
        css::uno::Reference< css::awt::XWindow >  _xFocusWindow,
        AccessibleBrowseBoxObjType eObjType,
        OUString  rName,
        OUString  rDescription );
 
protected:
    virtual ~AccessibleBrowseBoxBase() 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;
 
    // XFocusListener
    virtual void SAL_CALL disposing( const css::lang::EventObject& Source ) override;
    virtual void SAL_CALL focusGained( const css::awt::FocusEvent& e ) override;
    virtual void SAL_CALL focusLost( const css::awt::FocusEvent& e ) 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 AccessibleBrowseBoxObjType getType() const;
 
    void setAccessibleName( const OUString& rName );
    void setAccessibleDescription( const OUString& rDescription );
 
    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;
    virtual tools::Rectangle implGetBoundingBoxOnScreen() = 0;
 
    virtual sal_Int64 implCreateStateSet();
 
    // internal helper methods
 
    inline void implSetName( const OUString& rName );
 
    tools::Rectangle getBoundingBox();
    tools::Rectangle getBoundingBoxOnScreen();
 
    ::comphelper::AccessibleEventNotifier::TClientId getClientId() const { return m_aClientId; }
    void setClientId(::comphelper::AccessibleEventNotifier::TClientId _aNewClientId) { m_aClientId = _aNewClientId; }
 
public:
    ::osl::Mutex&    getMutex( ) { return m_aMutex; }
 
    void ensureIsAlive() const;
 
 
protected:
    // members
 
    css::uno::Reference< css::accessibility::XAccessible > mxParent;
    ::vcl::IAccessibleTableProvider* mpBrowseBox;
 
    css::uno::Reference< css::awt::XWindow > m_xFocusWindow;
 
private:
    OUString maName;
    OUString maDescription;
 
    AccessibleBrowseBoxObjType meObjType;
 
    ::comphelper::AccessibleEventNotifier::TClientId    m_aClientId;
};
 
 
// a version of AccessibleBrowseBoxBase which implements not only the XAccessibleContext,
// but also the XAccessible
 
typedef ::cppu::ImplHelper1 <   css::accessibility::XAccessible
                            >   BrowseBoxAccessibleElement_Base;
 
class BrowseBoxAccessibleElement
            :public AccessibleBrowseBoxBase
            ,public BrowseBoxAccessibleElement_Base
{
protected:
    BrowseBoxAccessibleElement(
        const css::uno::Reference< css::accessibility::XAccessible >& rxParent,
        ::vcl::IAccessibleTableProvider& rBrowseBox,
        const css::uno::Reference< css::awt::XWindow >& _xFocusWindow,
        AccessibleBrowseBoxObjType eObjType );
 
    BrowseBoxAccessibleElement(
        const css::uno::Reference< css::accessibility::XAccessible >& rxParent,
        ::vcl::IAccessibleTableProvider& rBrowseBox,
        const css::uno::Reference< css::awt::XWindow >& _xFocusWindow,
        AccessibleBrowseBoxObjType eObjType,
        const OUString& rName,
        const OUString& rDescription );
 
public:
    // noncopyable
    BrowseBoxAccessibleElement(const BrowseBoxAccessibleElement&) = delete;
    const BrowseBoxAccessibleElement& operator=(const BrowseBoxAccessibleElement&) = delete;
    // XInterface
    DECLARE_XINTERFACE( )
    // XTypeProvider
    DECLARE_XTYPEPROVIDER( )
 
protected:
    virtual ~BrowseBoxAccessibleElement() override;
 
protected:
    // XAccessible
 
    virtual css::uno::Reference< css::accessibility::XAccessibleContext > SAL_CALL getAccessibleContext() override;
};
 
 
// a helper class for protecting methods which need to lock the solar mutex in addition to the own mutex
 
class SolarMethodGuard : public SolarMutexGuard, public osl::MutexGuard
{
public:
    SolarMethodGuard( osl::Mutex& rMutex )
        :SolarMutexGuard( )
        ,osl::MutexGuard( rMutex )
    {
    }
};
 
// inlines
 
inline AccessibleBrowseBoxObjType AccessibleBrowseBoxBase::getType() const
{
    return meObjType;
}
 
inline void AccessibleBrowseBoxBase::implSetName(
        const OUString& rName )
{
    maName = rName;
}
 
} // namespace accessibility
 
 
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */