/************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite * * This file is part of OpenOffice.org. * * OpenOffice.org is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License version 3 * only, as published by the Free Software Foundation. * * OpenOffice.org is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU Lesser General Public License version 3 for more details * (a copy is included in the LICENSE file that accompanied this code). * * You should have received a copy of the GNU Lesser General Public License * version 3 along with OpenOffice.org. If not, see * * for a copy of the LGPLv3 License. * ************************************************************************/ #ifndef SD_ACCESSIBILITY_ACCESSIBLE_BASE_HXX #define SD_ACCESSIBILITY_ACCESSIBLE_BASE_HXX #include "MutexOwner.hxx" #include #include #include #include #include #include #include #include #include #include #include #include #include #include class VclWindowEvent; namespace sd { namespace toolpanel { class TreeNode; class TreeNodeStateChangeEvent; } } namespace utl { class AccessibleStateSetHelper; } namespace accessibility { class AccessibleSlideSorterObject; typedef ::cppu::WeakComponentImplHelper5< ::com::sun::star::accessibility::XAccessible, ::com::sun::star::accessibility::XAccessibleEventBroadcaster, ::com::sun::star::accessibility::XAccessibleContext, ::com::sun::star::accessibility::XAccessibleComponent, ::com::sun::star::lang::XServiceInfo > AccessibleTreeNodeBase; /** This class makes objects based on the sd::toolpanel::TreeNode accessible. */ class AccessibleTreeNode : public ::sd::MutexOwner, public AccessibleTreeNodeBase { public: /** Create a new object for the given tree node. The accessible parent is taken from the window returned by GetAccessibleParent() when called at the window of the node. @param rNode The TreeNode to make accessible. @param rsName The accessible name that will be returned by getAccessibleName(). @param rsDescription The accessible description that will be returned by getAccessibleDescription(). @param eRole The role that will be returned by getAccessibleRole(). */ AccessibleTreeNode( ::sd::toolpanel::TreeNode& rNode, const ::rtl::OUString& rsName, const ::rtl::OUString& rsDescription, sal_Int16 eRole); void FireAccessibleEvent ( short nEventId, const ::com::sun::star::uno::Any& rOldValue, const ::com::sun::star::uno::Any& rNewValue); virtual void SAL_CALL disposing (void); //===== XAccessible ======================================================= virtual ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessibleContext > SAL_CALL getAccessibleContext (void) throw (::com::sun::star::uno::RuntimeException); //===== XAccessibleEventBroadcaster ======================================= virtual void SAL_CALL addEventListener( const ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessibleEventListener >& rxListener) throw (::com::sun::star::uno::RuntimeException); virtual void SAL_CALL removeEventListener( const ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessibleEventListener >& rxListener ) throw (::com::sun::star::uno::RuntimeException); using cppu::WeakComponentImplHelperBase::addEventListener; using cppu::WeakComponentImplHelperBase::removeEventListener; //===== 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 or throw exception. 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 a reference to the parent. virtual ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessible> SAL_CALL getAccessibleParent (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); /// Return this object's role. virtual sal_Int16 SAL_CALL getAccessibleRole (void) throw (::com::sun::star::uno::RuntimeException); /// Return this object's description. virtual ::rtl::OUString SAL_CALL getAccessibleDescription (void) throw (::com::sun::star::uno::RuntimeException); /// Return the object's current name. virtual ::rtl::OUString SAL_CALL getAccessibleName (void) throw (::com::sun::star::uno::RuntimeException); /// Return NULL to indicate that an empty relation set. virtual ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessibleRelationSet> SAL_CALL getAccessibleRelationSet (void) throw (::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 the parents locale or throw exception if this object has no parent yet/anymore. */ virtual ::com::sun::star::lang::Locale SAL_CALL getLocale (void) throw (::com::sun::star::uno::RuntimeException, ::com::sun::star::accessibility::IllegalAccessibleComponentStateException); //===== XAccessibleComponent ================================================ virtual sal_Bool SAL_CALL containsPoint ( const ::com::sun::star::awt::Point& aPoint) throw (::com::sun::star::uno::RuntimeException); 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 void SAL_CALL grabFocus (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); //===== XServiceInfo ==================================================== /** Returns an identifier for the implementation of this object. */ virtual ::rtl::OUString SAL_CALL getImplementationName (void) throw (::com::sun::star::uno::RuntimeException); /** Return whether the specified service is supported by this class. */ virtual sal_Bool SAL_CALL supportsService (const ::rtl::OUString& sServiceName) throw (::com::sun::star::uno::RuntimeException); /** Returns a list of all supported services. */ virtual ::com::sun::star::uno::Sequence< ::rtl::OUString> SAL_CALL getSupportedServiceNames (void) throw (::com::sun::star::uno::RuntimeException); protected: ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessible> mxParent; ::sd::toolpanel::TreeNode& mrTreeNode; ::rtl::Reference< ::utl::AccessibleStateSetHelper> mrStateSet; const ::rtl::OUString msName; const ::rtl::OUString msDescription; const sal_Int16 meRole; virtual ~AccessibleTreeNode (void); /** Check whether or not the object has been disposed (or is in the state of beeing disposed). If that is the case then DisposedException is thrown to inform the (indirect) caller of the foul deed. */ void ThrowIfDisposed (void) throw (::com::sun::star::lang::DisposedException); /** Check whether or not the object has been disposed (or is in the state of beeing disposed). @return sal_True, if the object is disposed or in the course of being disposed. Otherwise, sal_False is returned. */ sal_Bool IsDisposed (void); /** Update the mpStateSet member to reflect the current state of the TreeNode. When one of the states has changed since the last call then an appropriate event is sent. */ virtual void UpdateStateSet (void); /** Update a single state and sent an event if its value changes. */ void UpdateState( sal_Int16 aState, bool bValue); DECL_LINK(StateChangeListener, ::sd::toolpanel::TreeNodeStateChangeEvent*); DECL_LINK(WindowEventListener, VclWindowEvent*); private: sal_uInt32 mnClientId; /// The common part of the constructor. void CommonConstructor (void); }; } // end of namespace ::accessibility #endif