ChildrenManagerImpl.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_SVX_SOURCE_ACCESSIBILITY_CHILDRENMANAGERIMPL_HXX
#define INCLUDED_SVX_SOURCE_ACCESSIBILITY_CHILDRENMANAGERIMPL_HXX
 
#include <svx/IAccessibleViewForwarderListener.hxx>
#include <svx/IAccessibleParent.hxx>
#include <svx/AccessibleShapeTreeInfo.hxx>
#include <editeng/AccessibleContextBase.hxx>
#include <comphelper/compbase.hxx>
#include <tools/gen.hxx>
#include <vector>
#include <com/sun/star/drawing/XShape.hpp>
#include <com/sun/star/drawing/XShapes.hpp>
#include <com/sun/star/document/XEventListener.hpp>
#include <com/sun/star/view/XSelectionChangeListener.hpp>
#include <com/sun/star/accessibility/XAccessible.hpp>
 
namespace accessibility {
 
class AccessibleShape;
 
class ChildDescriptor; // See below for declaration.
typedef ::std::vector<ChildDescriptor> ChildDescriptorListType;
 
// Re-using MutexOwner class defined in AccessibleContextBase.hxx
 
class ChildrenManagerImpl final
    :   public comphelper::WeakComponentImplHelper<
            css::document::XEventListener,
            css::view::XSelectionChangeListener>,
        public IAccessibleViewForwarderListener,
        public IAccessibleParent
{
public:
    ChildrenManagerImpl (css::uno::Reference<css::accessibility::XAccessible> xParent,
        css::uno::Reference<css::drawing::XShapes> xShapeList,
        const AccessibleShapeTreeInfo& rShapeTreeInfo,
        AccessibleContextBase& rContext);
 
    virtual ~ChildrenManagerImpl() override;
 
    void Init();
 
    sal_Int64 GetChildCount() const noexcept;
 
    const css::uno::Reference<css::drawing::XShape>& GetChildShape(sal_Int64 nIndex);
    css::uno::Reference<css::accessibility::XAccessible>
        GetChild (sal_Int64 nIndex);
 
    css::uno::Reference<css::accessibility::XAccessible>
        GetChild (ChildDescriptor& aChildDescriptor,sal_Int32 _nIndex);
 
    void Update (bool bCreateNewObjectsOnDemand);
 
    void SetShapeList (const css::uno::Reference<css::drawing::XShapes>& xShapeList);
 
    void AddAccessibleShape (rtl::Reference<AccessibleShape> const & shape);
 
    void ClearAccessibleShapeList();
 
    void SetInfo (const AccessibleShapeTreeInfo& rShapeTreeInfo);
 
    void UpdateSelection();
 
    bool HasFocus() const;
 
    void RemoveFocus();
 
    // lang::XEventListener
    virtual void SAL_CALL
        disposing (const css::lang::EventObject& rEventObject) override;
 
    // document::XEventListener
    virtual void SAL_CALL
        notifyEvent (const css::document::EventObject& rEventObject) override;
 
    // view::XSelectionChangeListener
    virtual void  SAL_CALL
        selectionChanged (const css::lang::EventObject& rEvent) override;
 
    // IAccessibleViewForwarderListener
    virtual void ViewForwarderChanged() override;
 
    // IAccessibleParent
    virtual bool ReplaceChild (
        AccessibleShape* pCurrentChild,
        const css::uno::Reference< css::drawing::XShape >& _rxShape,
        const tools::Long _nIndex,
        const AccessibleShapeTreeInfo& _rShapeTreeInfo
    ) override;
 
    // Add the impl method for IAccessibleParent interface
    virtual AccessibleControlShape* GetAccControlShapeFromModel
        (css::beans::XPropertySet* pSet) override;
    virtual css::uno::Reference<css::accessibility::XAccessible>
        GetAccessibleCaption (const css::uno::Reference<css::drawing::XShape>& xShape) override;
 
private:
    ChildDescriptorListType maVisibleChildren;
 
    css::uno::Reference<css::drawing::XShapes> mxShapeList;
 
    typedef std::vector< rtl::Reference< AccessibleShape> > AccessibleShapeList;
    AccessibleShapeList maAccessibleShapes;
 
    tools::Rectangle maVisibleArea;
 
    css::uno::Reference<css::accessibility::XAccessible> mxParent;
 
    AccessibleShapeTreeInfo maShapeTreeInfo;
 
    AccessibleContextBase& mrContext;
 
    virtual void disposing(std::unique_lock<std::mutex>&) override;
 
    void impl_dispose();
 
    ChildrenManagerImpl (const ChildrenManagerImpl&) = delete;
    ChildrenManagerImpl& operator= (const ChildrenManagerImpl&) = delete;
 
    AccessibleShape* mpFocusedShape;
 
    void CreateListOfVisibleShapes (ChildDescriptorListType& raChildList);
 
    void RemoveNonVisibleChildren (
        const std::vector<ChildDescriptor*>& rNonVisibleChildren);
 
    std::vector<ChildDescriptor*> MergeAccessibilityInformation (ChildDescriptorListType& raChildList);
 
    static void SendVisibleAreaEvents (ChildDescriptorListType& raChildList);
 
    void CreateAccessibilityObjects (ChildDescriptorListType& raChildList);
 
    void AddShape (const css::uno::Reference<css::drawing::XShape>& xShape);
 
    void RemoveShape (const css::uno::Reference<css::drawing::XShape>& xShape);
 
    void RegisterAsDisposeListener (const css::uno::Reference<css::drawing::XShape>& xShape);
 
    void UnregisterAsDisposeListener (const css::uno::Reference<css::drawing::XShape>& xShape);
};
 
 
class ChildDescriptor
{
public:
    css::uno::Reference<css::drawing::XShape> mxShape;
 
    rtl::Reference<AccessibleShape> mxAccessibleShape;
 
    AccessibleShape* GetAccessibleShape() const { return mxAccessibleShape.get(); }
 
    void setIndexAtAccessibleShape(sal_Int32 _nIndex);
 
    bool mbCreateEventPending;
 
    explicit ChildDescriptor (const css::uno::Reference<css::drawing::XShape>& xShape);
 
    explicit ChildDescriptor (const rtl::Reference<AccessibleShape>& rxAccessibleShape);
 
    void disposeAccessibleObject (AccessibleContextBase& rParent);
 
    bool operator == (const ChildDescriptor& aDescriptor) const
    {
        return (
                this == &aDescriptor ||
                (
                 (mxShape.get() == aDescriptor.mxShape.get() ) &&
                 (mxShape.is() || mxAccessibleShape.get() == aDescriptor.mxAccessibleShape.get())
                )
               );
    }
 
};
 
 
} // end of namespace accessibility
 
#endif
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */