svx/source/accessibility/AccessibleImageBullet.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: AccessibleImageBullet.hxx,v $
  10  * $Revision: 1.12 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef _SVX_ACCESSIBLE_IMAGE_BULLET_HXX
  32 #define _SVX_ACCESSIBLE_IMAGE_BULLET_HXX
  33
  34 #include <tools/gen.hxx>
  35 #include <cppuhelper/weakref.hxx>
  36 #include <cppuhelper/implbase5.hxx>
  37
  38 #ifndef _CPPUHELPER_INTERFACECONTAINER_H_
  39 #include <cppuhelper/interfacecontainer.hxx>
  40 #endif
  41 #include <com/sun/star/uno/Reference.hxx>
  42 #include <com/sun/star/lang/XServiceInfo.hpp>
  43 #include <com/sun/star/accessibility/XAccessible.hpp>
  44 #include <com/sun/star/accessibility/XAccessibleContext.hpp>
  45 #include <com/sun/star/accessibility/XAccessibleComponent.hpp>
  46 #include <com/sun/star/accessibility/XAccessibleEventBroadcaster.hpp>
  47 #include "AccessibleParaManager.hxx"
  48 #include <svx/unoedsrc.hxx>
  49
  50 namespace accessibility
  51 {
  52     typedef ::cppu::WeakImplHelper5< ::com::sun::star::accessibility::XAccessible,
  53                                      ::com::sun::star::accessibility::XAccessibleContext,
  54                                      ::com::sun::star::accessibility::XAccessibleComponent,
  55                                      ::com::sun::star::accessibility::XAccessibleEventBroadcaster,
  56                                      ::com::sun::star::lang::XServiceInfo >  AccessibleImageBulletInterfaceBase;
  57
  58     /** This class implements the image bullets for the EditEngine/Outliner UAA
  59      */
  60     class AccessibleImageBullet : public AccessibleImageBulletInterfaceBase
  61     {
  62
  63     public:
  64         /// Create accessible object for given parent
  65         AccessibleImageBullet ( const ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessible >& rParent );
  66
  67         virtual ~AccessibleImageBullet  ();
  68
  69         // XInterface
  70         virtual ::com::sun::star::uno::Any SAL_CALL queryInterface (const ::com::sun::star::uno::Type & rType) throw (::com::sun::star::uno::RuntimeException);
  71
  72         // XAccessible
  73         virtual ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessibleContext > SAL_CALL getAccessibleContext(  ) throw (::com::sun::star::uno::RuntimeException);
  74
  75         // XAccessibleContext
  76         virtual sal_Int32 SAL_CALL getAccessibleChildCount() throw (::com::sun::star::uno::RuntimeException);
  77         virtual ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessible > SAL_CALL getAccessibleChild( sal_Int32 i ) throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException);
  78         virtual ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessible > SAL_CALL getAccessibleParent() throw (::com::sun::star::uno::RuntimeException);
  79         virtual sal_Int32 SAL_CALL getAccessibleIndexInParent() throw (::com::sun::star::uno::RuntimeException);
  80         virtual sal_Int16 SAL_CALL getAccessibleRole() throw (::com::sun::star::uno::RuntimeException);
  81         /// Maximal length of text returned by getAccessibleDescription()
  82         enum { MaxDescriptionLen = 40 };
  83         virtual ::rtl::OUString SAL_CALL getAccessibleDescription() throw (::com::sun::star::uno::RuntimeException);
  84         virtual ::rtl::OUString SAL_CALL getAccessibleName() throw (::com::sun::star::uno::RuntimeException);
  85         virtual ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessibleRelationSet > SAL_CALL getAccessibleRelationSet() throw (::com::sun::star::uno::RuntimeException);
  86         virtual ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessibleStateSet > SAL_CALL getAccessibleStateSet() throw (::com::sun::star::uno::RuntimeException);
  87         virtual ::com::sun::star::lang::Locale SAL_CALL getLocale() throw (::com::sun::star::accessibility::IllegalAccessibleComponentStateException, ::com::sun::star::uno::RuntimeException);
  88
  89         // XAccessibleEventBroadcaster
  90         virtual void SAL_CALL addEventListener( const ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessibleEventListener >& xListener ) throw (::com::sun::star::uno::RuntimeException);
  91         virtual void SAL_CALL removeEventListener( const ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessibleEventListener >& xListener ) throw (::com::sun::star::uno::RuntimeException);
  92
  93         // XAccessibleComponent
  94         virtual sal_Bool SAL_CALL containsPoint( const ::com::sun::star::awt::Point& aPoint ) throw (::com::sun::star::uno::RuntimeException);
  95         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);
  96         virtual ::com::sun::star::awt::Rectangle SAL_CALL getBounds(  ) throw (::com::sun::star::uno::RuntimeException);
  97         virtual ::com::sun::star::awt::Point SAL_CALL getLocation(  ) throw (::com::sun::star::uno::RuntimeException);
  98         virtual ::com::sun::star::awt::Point SAL_CALL getLocationOnScreen(  ) throw (::com::sun::star::uno::RuntimeException);
  99         virtual ::com::sun::star::awt::Size SAL_CALL getSize(  ) throw (::com::sun::star::uno::RuntimeException);
 100         virtual void SAL_CALL grabFocus(  ) throw (::com::sun::star::uno::RuntimeException);
 101         virtual sal_Int32 SAL_CALL getForeground(  ) throw (::com::sun::star::uno::RuntimeException);
 102         virtual sal_Int32 SAL_CALL getBackground(  ) throw (::com::sun::star::uno::RuntimeException);
 103
 104         // XServiceInfo
 105         virtual ::rtl::OUString SAL_CALL getImplementationName (void) throw (::com::sun::star::uno::RuntimeException);
 106         virtual sal_Bool SAL_CALL supportsService (const ::rtl::OUString& sServiceName) throw (::com::sun::star::uno::RuntimeException);
 107         virtual ::com::sun::star::uno::Sequence< ::rtl::OUString> SAL_CALL getSupportedServiceNames (void) throw (::com::sun::star::uno::RuntimeException);
 108
 109         // XServiceName
 110         virtual ::rtl::OUString SAL_CALL getServiceName (void) throw (::com::sun::star::uno::RuntimeException);
 111
 112         /** Set the current index in the accessibility parent
 113
 114             @attention This method does not lock the SolarMutex,
 115             leaving that to the calling code. This is because only
 116             there potential deadlock situations can be resolved. Thus,
 117             make sure SolarMutex is locked when calling this.
 118          */
 119         void SetIndexInParent( sal_Int32 nIndex );
 120
 121         /** Get the current index in the accessibility parent
 122
 123             @attention This method does not lock the SolarMutex,
 124             leaving that to the calling code. This is because only
 125             there potential deadlock situations can be resolved. Thus,
 126             make sure SolarMutex is locked when calling this.
 127          */
 128         sal_Int32 GetIndexInParent() const;
 129
 130         /** Set the edit engine offset
 131
 132             @attention This method does not lock the SolarMutex,
 133             leaving that to the calling code. This is because only
 134             there potential deadlock situations can be resolved. Thus,
 135             make sure SolarMutex is locked when calling this.
 136          */
 137         void SetEEOffset( const Point& rOffset );
 138
 139         /** Set the EditEngine offset
 140
 141             @attention This method does not lock the SolarMutex,
 142             leaving that to the calling code. This is because only
 143             there potential deadlock situations can be resolved. Thus,
 144             make sure SolarMutex is locked when calling this.
 145          */
 146         void SetEditSource( SvxEditSource* pEditSource );
 147
 148         /** Dispose this object
 149
 150             Notifies and deregisters the listeners, drops all references.
 151          */
 152         void Dispose();
 153
 154         /** Set the current paragraph number
 155
 156             @attention This method does not lock the SolarMutex,
 157             leaving that to the calling code. This is because only
 158             there potential deadlock situations can be resolved. Thus,
 159             make sure SolarMutex is locked when calling this.
 160          */
 161         void SetParagraphIndex( sal_Int32 nIndex );
 162
 163         /** Query the current paragraph number (0 - nParas-1)
 164
 165             @attention This method does not lock the SolarMutex,
 166             leaving that to the calling code. This is because only
 167             there potential deadlock situations can be resolved. Thus,
 168             make sure SolarMutex is locked when calling this.
 169          */
 170         sal_Int32 GetParagraphIndex() const SAL_THROW((::com::sun::star::uno::RuntimeException));
 171
 172         /// Calls all Listener objects to tell them the change. Don't hold locks when calling this!
 173         virtual void FireEvent(const sal_Int16 nEventId, const ::com::sun::star::uno::Any& rNewValue = ::com::sun::star::uno::Any(), const ::com::sun::star::uno::Any& rOldValue = ::com::sun::star::uno::Any() ) const;
 174
 175     private:
 176
 177         // declared, but not defined
 178         AccessibleImageBullet( const AccessibleImageBullet& );
 179         AccessibleImageBullet& operator= ( const AccessibleImageBullet& );
 180
 181         // syntactic sugar for FireEvent
 182         void GotPropertyEvent( const ::com::sun::star::uno::Any& rNewValue, const sal_Int16 nEventId ) const;
 183         void LostPropertyEvent( const ::com::sun::star::uno::Any& rOldValue, const sal_Int16 nEventId ) const;
 184
 185         // maintain state set and send STATE_CHANGE events
 186         void SetState( const sal_Int16 nStateId );
 187         void UnSetState( const sal_Int16 nStateId );
 188
 189         SvxEditSource& GetEditSource() const SAL_THROW((::com::sun::star::uno::RuntimeException));
 190
 191         int getNotifierClientId() const;
 192
 193         /** Query the SvxTextForwarder for EditEngine access.
 194
 195             @attention This method does not lock the SolarMutex,
 196             leaving that to the calling code. This is because only
 197             there potential deadlock situations can be resolved. Thus,
 198             make sure SolarMutex is locked when calling this.
 199          */
 200         SvxTextForwarder&       GetTextForwarder() const SAL_THROW((::com::sun::star::uno::RuntimeException));
 201
 202         /** Query the SvxViewForwarder for EditEngine access.
 203
 204             @attention This method does not lock the SolarMutex,
 205             leaving that to the calling code. This is because only
 206             there potential deadlock situations can be resolved. Thus,
 207             make sure SolarMutex is locked when calling this.
 208          */
 209         SvxViewForwarder&       GetViewForwarder() const SAL_THROW((::com::sun::star::uno::RuntimeException));
 210
 211         const Point& GetEEOffset() const;
 212
 213         // the paragraph index in the edit engine (guarded by solar mutex)
 214         sal_Int32       mnParagraphIndex;
 215
 216         // our current index in the parent (guarded by solar mutex)
 217         sal_Int32       mnIndexInParent;
 218
 219         // the current edit source (guarded by solar mutex)
 220         SvxEditSource* mpEditSource;
 221
 222         // the offset of the underlying EditEngine from the shape/cell (guarded by solar mutex)
 223         Point maEEOffset;
 224
 225         // the current state set (updated from SetState/UnSetState and guarded by solar mutex)
 226         ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessibleStateSet > mxStateSet;
 227
 228         mutable osl::Mutex      maMutex;
 229
 230         /// The shape we're the accessible for (unguarded)
 231         ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessible > mxParent;
 232
 233         /// Our listeners (guarded by maMutex)
 234         int mnNotifierClientId;
 235     };
 236
 237 } // end of namespace accessibility
 238
 239 #endif
 240