2f85eb7a2d
Change-Id: I0cf6f675483bddf82e7347b484a874c71963bfd7 Reviewed-on: https://gerrit.libreoffice.org/c/core/+/156984 Tested-by: Jenkins Reviewed-by: Gabor Kelemen <kelemeng@ubuntu.com>
243 lines
11 KiB
C++
243 lines
11 KiB
C++
/* -*- 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/comphelperdllapi.h>
|
|
|
|
|
|
namespace comphelper
|
|
{
|
|
|
|
|
|
//= OCommonAccessibleComponent
|
|
|
|
typedef ::cppu::WeakComponentImplHelper < css::accessibility::XAccessibleContext2,
|
|
css::accessibility::XAccessibleEventBroadcaster
|
|
> OCommonAccessibleComponent_Base;
|
|
|
|
/** base class encapsulating common functionality for the helper classes implementing
|
|
the XAccessibleComponent respectively XAccessibleExtendendComponent
|
|
*/
|
|
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( );
|
|
|
|
/** late construction
|
|
@param _rxAccessible
|
|
the Accessible object which created this context.
|
|
<p>If your derived implementation implements the XAccessible (and does not follow the proposed
|
|
separation of XAccessible from XAccessibleContext), you may pass <code>this</code> here.</p>
|
|
|
|
<p>The object is hold weak, so its life time is not affected.</p>
|
|
|
|
<p>The object is needed for performance reasons: for <method>getAccessibleIndexInParent</method>,
|
|
all children (which are XAccessible's theirself) of our parent have to be asked. If we know our
|
|
XAccessible, we can compare it with all the children, instead of asking all children for their
|
|
context and comparing this context with ourself.</p>
|
|
*/
|
|
void lateInit( const css::uno::Reference< css::accessibility::XAccessible >& _rxAccessible );
|
|
|
|
/** retrieves the creator previously set with <method>lateInit</method>
|
|
*/
|
|
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
|
|
/** default implementation for retrieving the index of this object within the parent
|
|
<p>This basic implementation here returns the index <code>i</code> of the child for which
|
|
<code><parent>.getAccessibleChild( i )</code> equals our creator.</p>
|
|
*/
|
|
virtual sal_Int64 SAL_CALL getAccessibleIndexInParent( ) override;
|
|
/** default implementation for retrieving the locale
|
|
<p>This basic implementation returns the locale of the parent context,
|
|
as retrieved via getAccessibleParent()->getAccessibleContext.</p>
|
|
*/
|
|
virtual css::lang::Locale SAL_CALL getLocale( ) override;
|
|
|
|
protected:
|
|
// OComponentHelper
|
|
virtual void SAL_CALL disposing() override;
|
|
|
|
protected:
|
|
// helper
|
|
/** notifies all AccessibleEventListeners of a certain event
|
|
|
|
@precond not to be called with our mutex locked
|
|
@param _nEventId
|
|
the id of the event. See AccessibleEventType
|
|
@param _rOldValue
|
|
the old value to be notified
|
|
@param _rNewValue
|
|
the new value to be notified
|
|
*/
|
|
void NotifyAccessibleEvent(
|
|
const sal_Int16 _nEventId,
|
|
const css::uno::Any& _rOldValue,
|
|
const css::uno::Any& _rNewValue,
|
|
sal_Int32 nIndexHint = -1
|
|
);
|
|
|
|
// life time control
|
|
/// checks whether the object is alive (returns <TRUE/> then) or disposed
|
|
bool isAlive() const;
|
|
/// checks for being alive. If the object is already disposed (i.e. not alive), an exception is thrown.
|
|
void ensureAlive() const;
|
|
|
|
/** ensures that the object is disposed.
|
|
@precond
|
|
to be called from within the destructor of your derived class only!
|
|
*/
|
|
void ensureDisposed( );
|
|
|
|
/** shortcut for retrieving the context of the parent (returned by getAccessibleParent)
|
|
*/
|
|
css::uno::Reference< css::accessibility::XAccessibleContext >
|
|
implGetParentContext();
|
|
|
|
// access to the base class' broadcast helper/mutex
|
|
::osl::Mutex& GetMutex() { return m_aMutex; }
|
|
|
|
protected:
|
|
/// implements the calculation of the bounding rectangle - still waiting to be overwritten
|
|
///
|
|
/// @throws css::uno::RuntimeException
|
|
virtual css::awt::Rectangle implGetBounds( ) = 0;
|
|
|
|
protected:
|
|
/** non-virtual versions of the methods which can be implemented using <method>implGetBounds</method>
|
|
note: getLocationOnScreen relies on a valid parent (XAccessibleContext::getParent()->getAccessibleContext()),
|
|
which itself implements XAccessibleComponent
|
|
|
|
@throws css::uno::RuntimeException
|
|
*/
|
|
bool containsPoint( const css::awt::Point& aPoint );
|
|
/// @throws css::uno::RuntimeException
|
|
css::awt::Point getLocation( );
|
|
/// @throws css::uno::RuntimeException
|
|
css::awt::Point getLocationOnScreen( );
|
|
/// @throws css::uno::RuntimeException
|
|
css::awt::Size getSize( );
|
|
/// @throws css::uno::RuntimeException
|
|
css::awt::Rectangle getBounds( );
|
|
};
|
|
|
|
|
|
//= OAccessibleComponentHelper
|
|
|
|
|
|
/** a helper class for implementing an AccessibleContext which at the same time
|
|
supports an XAccessibleComponent interface.
|
|
*/
|
|
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
|
|
|
|
|
|
/** a helper class for implementing an AccessibleContext which at the same time
|
|
supports an XAccessibleExtendedComponent interface.
|
|
*/
|
|
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: */
|