/* -*- 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 .
*/
namespace com::sun::star::uno { class XComponentContext; }
namespace accessibility
{
//= OAccessibleWrapper
class OAccessibleContextWrapper; class OWrappedAccessibleChildrenManager;
using OAccessibleWrapper_Base = cppu::ImplHelper1<css::accessibility::XAccessible>;
/** a class which aggregates a proxy for an XAccessible, and wrapping the context returned by this XAccessible.
*/ class OAccessibleWrapper final : public OAccessibleWrapper_Base, public OComponentProxyAggregation
/** Helper for wrapping an XAccessibleContext by aggregating a proxy for it.
<p>This class does not have own ref counting. In addition, it does not implement the XAccessibleContext interface, but provides all the methods from this interface which must be implemented using the inner context (such as getAccessibleChild*).</p>
<p>Children of the aggregated XAccessibleContext are wrapped, too.</p>
<p>AccessibleEvents fired by the inner context are multiplexed, especially, any references to children in such events are translated. This means that even in such events, no un-wrapped object will ever leave this class - if the aggregated context notifies a child event, the child passed to the event is wrapped</p>
@seealso OAccessibleContextWrapper
*/ class OAccessibleContextWrapperHelper : private OComponentProxyAggregationHelper, public OAccessibleContextWrapperHelper_Base
{ protected: /// the context we're wrapping (properly typed, in opposite to OComponentProxyAggregationHelper::m_xInner)
css::uno::Reference< css::accessibility::XAccessibleContext >
m_xInnerContext; /// the XAccessible which created this context
css::uno::Reference< css::accessibility::XAccessible >
m_xOwningAccessible; /// the XAccessible which is to be returned in getAccessibleParent
css::uno::Reference< css::accessibility::XAccessible >
m_xParentAccessible;
rtl::Reference<OWrappedAccessibleChildrenManager> m_xChildMapper; // for mapping children from our inner context to our callers
protected: /** ctor
@param _rxContext a service factory
@param _rxInnerAccessibleContext the object to wrap
@param _rxOwningAccessible The XAccessible which created this object. This is necessary because children of our wrapped context need to be wrapped, too, and if they're asked for a parent, they of course should return the proper parent<br/> The object will be held with a hard reference
@param _rxParentAccessible The XAccessible to return in the getAccessibleParent call
*/
OAccessibleContextWrapperHelper( const css::uno::Reference< css::uno::XComponentContext >& _rxContext,
::cppu::OBroadcastHelper& _rBHelper, const css::uno::Reference< css::accessibility::XAccessibleContext >& _rxInnerAccessibleContext, const css::uno::Reference< css::accessibility::XAccessible >& _rxOwningAccessible, const css::uno::Reference< css::accessibility::XAccessible >& _rxParentAccessible
);
/// to be called from within your ctor - does the aggregation of a proxy for m_xInnerContext void aggregateProxy(
oslInterlockedCount& _rRefCount,
::cppu::OWeakObject& _rDelegator
);
// own overridables /** notify an accessible event which has been translated (if necessary)
<p>Usually, you derive your class from both OAccessibleContextWrapperHelper and XAccessibleEventBroadcaster, and simply call all your XAccessibleEventListener with the given event.</p>
<p>The mutex of the BroadcastHelper passed to the instance's ctor is <em>not</em> locked when calling into this method</p>
class OAccessibleContextWrapper final : public cppu::BaseMutex, public OAccessibleContextWrapper_CBase, public OAccessibleContextWrapperHelper
{ private:
::comphelper::AccessibleEventNotifier::TClientId m_nNotifierClient; // for notifying AccessibleEvents
public: /** ctor
@param _rxContext a service factory
@param _rxInnerAccessibleContext the object to wrap
@param _rxOwningAccessible The XAccessible which created this object. This is necessary because children of our wrapped context need to be wrapped, too, and if they're asked for a parent, they of course should return the proper parent<br/> The object will be held with a hard reference
@param _rxParentAccessible The XAccessible to return in the getAccessibleParent call
*/
OAccessibleContextWrapper( const css::uno::Reference< css::uno::XComponentContext >& _rxContext, const css::uno::Reference< css::accessibility::XAccessibleContext >& _rxInnerAccessibleContext, const css::uno::Reference< css::accessibility::XAccessible >& _rxOwningAccessible, const css::uno::Reference< css::accessibility::XAccessible >& _rxParentAccessible
);
typedef ::std::map < css::uno::Reference< css::accessibility::XAccessible >
, rtl::Reference<OAccessibleWrapper >
> AccessibleMap; // TODO: think about if we should hold these objects weak
typedef ::cppu::WeakImplHelper< css::lang::XEventListener
> OWrappedAccessibleChildrenManager_Base; /** manages wrapping XAccessible's to XAccessible's
*/ class OWrappedAccessibleChildrenManager final : public OWrappedAccessibleChildrenManager_Base
{
css::uno::Reference< css::uno::XComponentContext >
m_xContext;
css::uno::WeakReference< css::accessibility::XAccessible >
m_aOwningAccessible; // the XAccessible which belongs to the XAccessibleContext which we work for
AccessibleMap m_aChildrenMap; // for caching children bool m_bTransientChildren; // are we prohibited to cache our children?
/** specifies if the children are to be considered transient (i.e.: not cached) <p>to be called only once per lifetime</p>
*/ void setTransientChildren( bool _bSet );
/** sets the XAccessible which belongs to the XAccessibleContext which we work for <p>to be called only once per lifetime</p>
*/ void setOwningAccessible( const css::uno::Reference< css::accessibility::XAccessible >& _rxAcc );
/// retrieves a wrapper for the given accessible
css::uno::Reference< css::accessibility::XAccessible >
getAccessibleWrapperFor( const css::uno::Reference< css::accessibility::XAccessible >& _rxKey
);
/// erases the given key from the map (if it is present there) void removeFromCache( const css::uno::Reference< css::accessibility::XAccessible >& _rxKey );
/// invalidates (i.e. empties) the map void invalidateAll( );
/** disposes (i.e. clears) the manager
<p>Note that the XAccessibleContext's of the mapped XAccessible objects are disposed, too.</p>
*/ void dispose();
/** handles a notification as got from the parent of the children we're managing <p>This applies only to the notifications which have a direct impact on our map.</p>
*/ void handleChildNotification( const css::accessibility::AccessibleEventObject& _rEvent );
/** translates events as got from the parent of the children we're managing <p>This applies only to the notifications which deal with child objects which we manage.</p>
*/ void translateAccessibleEvent( const css::accessibility::AccessibleEventObject& _rEvent,
css::accessibility::AccessibleEventObject& _rTranslatedEvent
);
Die Informationen auf dieser Webseite wurden
nach bestem Wissen sorgfältig zusammengestellt. Es wird jedoch weder Vollständigkeit, noch Richtigkeit,
noch Qualität der bereit gestellten Informationen zugesichert.
Bemerkung:
Die farbliche Syntaxdarstellung und die Messung sind noch experimentell.
