/* -*- 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 _SVX_ACCESSIBILITY_ACCESSIBLE_SHAPE_HXX #define _SVX_ACCESSIBILITY_ACCESSIBLE_SHAPE_HXX #include #include #include #include #include #include #include #include #include #include #include #include "svx/svxdllapi.h" #include "ChildrenManager.hxx" class SdrObject; namespace accessibility { class AccessibleShapeInfo; class AccessibleShapeTreeInfo; class IAccessibleParent; /** This base class provides a base implementation for all shapes. For more detailed documentation about the methods refer to the descriptions of the implemented interfaces. These are, among others, XAccessible, XAccessibleContext, XAccessibleComponent and XAccessibleExtendedComponent.

The children of a shape can stem from two sources which, in case of SVX and SD shapes, are mutually exclusive. This implementation, however, handles both simultaniously to cope with future extensions or shapes from other projects.

  • If this shape is a group shape, i.e. a SvxShapeGroup or a Svx3DSceneObject, it can have nested shapes.
  • If this shape is a descendant from SvxShapeText then the text paragraphs are its children.

Accessible shapes do not listen for disposing() calls of the UNO shapes they make accessible. This is the task of their owner, usually a container, who can then call dispose() at the accessible object.

*/ class SVX_DLLPUBLIC AccessibleShape : public AccessibleContextBase, public AccessibleComponentBase, public IAccessibleViewForwarderListener, public ::com::sun::star::document::XEventListener, public ::com::sun::star::lang::XUnoTunnel { public: //===== internal ======================================================== /** Create a new accessible object that makes the given shape accessible. @param rShapeInfo This object contains all information specific to the new accessible shape. That are e.g. the shape to be made accessible and the accessible object that will become the parent of the new object. @param rShapeTreeInfo Bundel of information passed to this shape and all of its desendants. @attention Always call the init method after creating a new accessible shape. This is one way to overcome the potential problem of registering the new object with e.g. event broadcasters. That would delete the new object if a broadcaster would not keep a strong reference to the new object. */ AccessibleShape ( const AccessibleShapeInfo& rShapeInfo, const AccessibleShapeTreeInfo& rShapeTreeInfo); /** The destructor releases its children manager and text engine if still existent. These are responsible to send appropriate events. */ virtual ~AccessibleShape (void); /** Initialize a new shape. See the documentation of the constructor for the reason of this method's existence. */ virtual void Init (void); /** Compare two accessible shapes using object identity @param rShape This is the second operand. @return Returns true if both shapes are the same object. */ virtual bool operator== (const AccessibleShape& rShape); /** Set the specified state. If the state is FOCUSED then, additionally to the inherited functionality, the focus listeners registered with the XAccessibleComponent interface are called (if that state really changes). @param aState The state to turn on. @return The returned flag indicates whether the specified state has been changed (), i.e. it has formerly not been set. */ virtual sal_Bool SetState (sal_Int16 aState); /** Reset the specified state. If the state is FOCUSED then, additionally to the inherited functionality, the focus listeners registered with the XAccessibleComponent interface are called (if that state really changes). @param aState The state to turn off. @return The returned flag indicates whether the specified state has been changed (), i.e. it has formerly been set. */ virtual sal_Bool ResetState (sal_Int16 aState); /** Return the state of the specified state. Take the FOCUSED state from the accessible edit engine. @param aState The state for which to return its value. @return A value of indicates that the state is set. A value indicates an unset state or the inability to access the entity that manages the state set. */ sal_Bool GetState (sal_Int16 aState); //===== XAccessibleContext ============================================== /// Return the number of currently visible children. virtual sal_Int32 SAL_CALL getAccessibleChildCount (void) throw (::com::sun::star::uno::RuntimeException); /** Return the specified child. @param nIndex Index of the requested child. @return Reference of the requested child which is the accessible object of a visible shape. @raises IndexOutOfBoundsException Throws an exception if the index is not valid. */ virtual ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessible> SAL_CALL getAccessibleChild (sal_Int32 nIndex) throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException); /// Return the set of current states. virtual ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessibleStateSet> SAL_CALL getAccessibleStateSet (void) throw (::com::sun::star::uno::RuntimeException); /// Return this objects index among the parents children. virtual sal_Int32 SAL_CALL getAccessibleIndexInParent (void) throw (::com::sun::star::uno::RuntimeException); //===== XAccessibleComponent ============================================ virtual ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessible > SAL_CALL getAccessibleAtPoint (const ::com::sun::star::awt::Point& aPoint) throw (::com::sun::star::uno::RuntimeException); virtual ::com::sun::star::awt::Rectangle SAL_CALL getBounds (void) throw (::com::sun::star::uno::RuntimeException); virtual ::com::sun::star::awt::Point SAL_CALL getLocation (void) throw (::com::sun::star::uno::RuntimeException); virtual ::com::sun::star::awt::Point SAL_CALL getLocationOnScreen (void) throw (::com::sun::star::uno::RuntimeException); virtual ::com::sun::star::awt::Size SAL_CALL getSize (void) throw (::com::sun::star::uno::RuntimeException); virtual sal_Int32 SAL_CALL getForeground (void) throw (::com::sun::star::uno::RuntimeException); virtual sal_Int32 SAL_CALL getBackground (void) throw (::com::sun::star::uno::RuntimeException); //===== XAccessibleEventBroadcaster ===================================== /** This call is forwarded to a) the base class and b) to the accessible edit engine if it is present. @param rxListener This listener is informed about accessibility events. */ virtual void SAL_CALL addAccessibleEventListener ( const ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessibleEventListener >& rxListener) throw (::com::sun::star::uno::RuntimeException); /** This call is forwarded to a) the base class and b) to the accessible edit engine if it is present. @param rxListener This listener will not be informed about accessibility events anymore. */ virtual void SAL_CALL removeAccessibleEventListener ( const ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessibleEventListener >& rxListener) throw (::com::sun::star::uno::RuntimeException); //===== XInterface ====================================================== virtual com::sun::star::uno::Any SAL_CALL queryInterface (const com::sun::star::uno::Type & rType) throw (::com::sun::star::uno::RuntimeException); virtual void SAL_CALL acquire (void) throw (); virtual void SAL_CALL release (void) throw (); //===== XServiceInfo ==================================================== /** Returns an identifier for the implementation of this object. */ virtual OUString SAL_CALL getImplementationName (void) throw (::com::sun::star::uno::RuntimeException); virtual ::com::sun::star::uno::Sequence< OUString> SAL_CALL getSupportedServiceNames (void) throw (::com::sun::star::uno::RuntimeException); //===== XTypeProvider =================================================== virtual ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Type> SAL_CALL getTypes (void) throw (::com::sun::star::uno::RuntimeException); //===== IAccessibleViewForwarderListener ================================ virtual void ViewForwarderChanged (ChangeType aChangeType, const IAccessibleViewForwarder* pViewForwarder); //===== lang::XEventListener ============================================ /** Listen for disposing events of the model. The accessible shape remains functional when this happens. */ virtual void SAL_CALL disposing (const ::com::sun::star::lang::EventObject& Source) throw (::com::sun::star::uno::RuntimeException); //===== document::XEventListener ======================================== virtual void SAL_CALL notifyEvent (const ::com::sun::star::document::EventObject& rEventObject) throw (::com::sun::star::uno::RuntimeException); //===== XUnoTunnel ======================================================== static const ::com::sun::star::uno::Sequence< sal_Int8 >& getUnoTunnelImplementationId() throw(); static AccessibleShape* getImplementation( const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >& _rxIFace ) throw(); sal_Int64 SAL_CALL getSomething( const ::com::sun::star::uno::Sequence< sal_Int8 >& _rIdentifier ) throw(::com::sun::star::uno::RuntimeException); //===== Misc ======================================================== ::com::sun::star::uno::Reference< ::com::sun::star::drawing::XShape > GetXShape(); /** set the index _nIndex at the accessible shape @param _nIndex The new index in parent. */ inline void setIndexInParent(sal_Int32 _nIndex) { m_nIndexInParent = _nIndex; } protected: /// Children manager. May be empty if there are no children. ChildrenManager* mpChildrenManager; /// Reference to the actual shape. ::com::sun::star::uno::Reference< ::com::sun::star::drawing::XShape> mxShape; /** Bundle of information passed to all shapes in a document tree. */ AccessibleShapeTreeInfo maShapeTreeInfo; /** Index that is appended to the object's name to disambiguate between different names with the otherwise same name. */ long mnIndex; /** the index in parent. */ sal_Int32 m_nIndexInParent; /** The accessible text engine. May be NULL if it can not be created. */ AccessibleTextHelper* mpText; /** This object can be used to modify the child list of our parent. */ IAccessibleParent* mpParent; /** This object can be removed when we have an extra interface to ask if the shape is selected */ SdrObject* m_pShape; /** This method is called from the component helper base class while disposing. */ virtual void SAL_CALL disposing (void); /** Create a base name string that contains the accessible name. */ virtual OUString CreateAccessibleBaseName (void) throw (::com::sun::star::uno::RuntimeException); /** Create a unique name string that contains the accessible name. The name consists of the base name and the index. */ virtual OUString CreateAccessibleName (void) throw (::com::sun::star::uno::RuntimeException); /// Create a description string that contains the accessible description. virtual OUString CreateAccessibleDescription (void) throw (::com::sun::star::uno::RuntimeException); /** Update the OPAQUE and SELECTED state. */ virtual void UpdateStates (void); private: /** Don't use the default constructor. Use the public constructor that takes the original shape and the parent as arguments instead. */ SVX_DLLPRIVATE explicit AccessibleShape (void); /// Don't use the copy constructor. Is there any use for it? SVX_DLLPRIVATE explicit AccessibleShape (const AccessibleShape&); /// Don't use the assignment operator. Do we need this? SVX_DLLPRIVATE AccessibleShape& operator= (const AccessibleShape&); /** Call this method when the title, name, or description of the mxShape member (may) have been changed. This method adapts the name and description members of the AccessibleContextBase base class. */ void UpdateNameAndDescription (void); }; } // end of namespace accessibility #endif /* vim:set shiftwidth=4 softtabstop=4 expandtab: */