1 /************************************************************** 2 * 3 * Licensed to the Apache Software Foundation (ASF) under one 4 * or more contributor license agreements. See the NOTICE file 5 * distributed with this work for additional information 6 * regarding copyright ownership. The ASF licenses this file 7 * to you under the Apache License, Version 2.0 (the 8 * "License"); you may not use this file except in compliance 9 * with the License. You may obtain a copy of the License at 10 * 11 * http://www.apache.org/licenses/LICENSE-2.0 12 * 13 * Unless required by applicable law or agreed to in writing, 14 * software distributed under the License is distributed on an 15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16 * KIND, either express or implied. See the License for the 17 * specific language governing permissions and limitations 18 * under the License. 19 * 20 *************************************************************/ 21 22 23 24 #ifndef _SFX_EVENTSUPPLIER_HXX_ 25 #define _SFX_EVENTSUPPLIER_HXX_ 26 27 #include <com/sun/star/lang/XTypeProvider.hpp> 28 #include <com/sun/star/container/XNameReplace.hpp> 29 #include <com/sun/star/container/XSet.hpp> 30 #include <com/sun/star/document/XEventListener.hpp> 31 #include <com/sun/star/document/XEventBroadcaster.hpp> 32 #include <com/sun/star/document/XDocumentEventBroadcaster.hpp> 33 #include <com/sun/star/document/XDocumentEventListener.hpp> 34 #include <com/sun/star/document/XEventsSupplier.hpp> 35 #include <com/sun/star/lang/XServiceInfo.hpp> 36 #include <com/sun/star/task/XJobExecutor.hpp> 37 #include <com/sun/star/uno/Reference.hxx> 38 #include <com/sun/star/uno/Type.hxx> 39 #include <sal/types.h> 40 #include <osl/mutex.hxx> 41 #include <cppuhelper/weak.hxx> 42 #include <cppuhelper/implbase1.hxx> 43 #include <cppuhelper/implbase2.hxx> 44 #include <cppuhelper/implbase3.hxx> 45 #include <cppuhelper/implbase4.hxx> 46 #include <cppuhelper/implbase7.hxx> 47 #include <comphelper/sequenceashashmap.hxx> 48 #include <comphelper/sequenceasvector.hxx> 49 #include <sfx2/sfxuno.hxx> 50 51 #include <vos/mutex.hxx> 52 #include <cppuhelper/interfacecontainer.hxx> 53 #include <svl/lstner.hxx> 54 #include <unotools/eventcfg.hxx> 55 56 namespace comphelper 57 { 58 class NamedValueCollection; 59 } 60 61 //-------------------------------------------------------------------------------------------------------- 62 63 #define NOSUCHELEMENTEXCEPTION ::com::sun::star::container::NoSuchElementException 64 #define XNAMEREPLACE ::com::sun::star::container::XNameReplace 65 #define DOCEVENTOBJECT ::com::sun::star::document::EventObject 66 #define XEVENTBROADCASTER ::com::sun::star::document::XEventBroadcaster 67 #define XDOCEVENTLISTENER ::com::sun::star::document::XEventListener 68 #define XEVENTSSUPPLIER ::com::sun::star::document::XEventsSupplier 69 #define XJOBEXECUTOR ::com::sun::star::task::XJobExecutor 70 #define EVENTOBJECT ::com::sun::star::lang::EventObject 71 #define ILLEGALARGUMENTEXCEPTION ::com::sun::star::lang::IllegalArgumentException 72 #define WRAPPEDTARGETEXCEPTION ::com::sun::star::lang::WrappedTargetException 73 #define ANY ::com::sun::star::uno::Any 74 #define REFERENCE ::com::sun::star::uno::Reference 75 #define WEAKREFERENCE ::com::sun::star::uno::WeakReference 76 #define RUNTIMEEXCEPTION ::com::sun::star::uno::RuntimeException 77 #define SEQUENCE ::com::sun::star::uno::Sequence 78 #define UNOTYPE ::com::sun::star::uno::Type 79 #define OUSTRING ::rtl::OUString 80 #define OINTERFACECONTAINERHELPER ::cppu::OInterfaceContainerHelper 81 82 //-------------------------------------------------------------------------------------------------------- 83 84 class SfxObjectShell; 85 class SfxBaseModel; 86 class SvxMacro; 87 88 //-------------------------------------------------------------------------------------------------------- 89 90 class SfxEvents_Impl : public ::cppu::WeakImplHelper2< ::com::sun::star::container::XNameReplace, ::com::sun::star::document::XEventListener > 91 { 92 SEQUENCE< OUSTRING > maEventNames; 93 SEQUENCE< ANY > maEventData; 94 REFERENCE< XEVENTBROADCASTER > mxBroadcaster; 95 ::osl::Mutex maMutex; 96 SfxObjectShell *mpObjShell; 97 98 sal_Bool Warn_Impl( const String& ); 99 100 public: 101 SfxEvents_Impl( SfxObjectShell* pShell, 102 REFERENCE< XEVENTBROADCASTER > xBroadcaster ); 103 ~SfxEvents_Impl(); 104 105 // --- XNameReplace --- 106 virtual void SAL_CALL replaceByName( const OUSTRING & aName, const ANY & aElement ); 107 108 // --- XNameAccess ( parent of XNameReplace ) --- 109 virtual ANY SAL_CALL getByName( const OUSTRING& aName ); 110 virtual SEQUENCE< OUSTRING > SAL_CALL getElementNames(); 111 virtual sal_Bool SAL_CALL hasByName( const OUSTRING& aName ); 112 113 // --- XElementAccess ( parent of XNameAccess ) --- 114 virtual UNOTYPE SAL_CALL getElementType(); 115 virtual sal_Bool SAL_CALL hasElements(); 116 117 // --- ::document::XEventListener --- 118 virtual void SAL_CALL notifyEvent( const DOCEVENTOBJECT& aEvent ); 119 120 // --- ::lang::XEventListener --- 121 virtual void SAL_CALL disposing( const EVENTOBJECT& Source ); 122 123 static SvxMacro* ConvertToMacro( const ANY& rElement, SfxObjectShell* pDoc, sal_Bool bNormalizeMacro ); 124 static void NormalizeMacro( const ANY& rIn, ANY& rOut, SfxObjectShell* pDoc ); 125 static void NormalizeMacro( 126 const ::comphelper::NamedValueCollection& i_eventDescriptor, 127 ::comphelper::NamedValueCollection& o_normalizedDescriptor, 128 SfxObjectShell* i_document ); 129 }; 130 131 //============================================================================= 132 struct ModelCollectionMutexBase 133 { 134 public: 135 ::osl::Mutex m_aLock; 136 }; 137 138 //============================================================================= 139 typedef ::std::vector< ::com::sun::star::uno::Reference< ::com::sun::star::frame::XModel > > TModelList; 140 141 //============================================================================= 142 class ModelCollectionEnumeration : public ModelCollectionMutexBase 143 , public ::cppu::WeakImplHelper1< ::com::sun::star::container::XEnumeration > 144 { 145 146 //------------------------------------------------------------------------- 147 // member 148 //------------------------------------------------------------------------- 149 private: 150 ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory > m_xSMGR; 151 TModelList m_lModels; 152 TModelList::iterator m_pEnumerationIt; 153 154 //------------------------------------------------------------------------- 155 // native interface 156 //------------------------------------------------------------------------- 157 public: 158 ModelCollectionEnumeration(const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& xSMGR); 159 virtual ~ModelCollectionEnumeration(); 160 void setModelList(const TModelList& rList); 161 162 //------------------------------------------------------------------------- 163 // uno interface 164 //------------------------------------------------------------------------- 165 public: 166 167 // css.container.XEnumeration 168 virtual sal_Bool SAL_CALL hasMoreElements(); 169 170 virtual ::com::sun::star::uno::Any SAL_CALL nextElement(); 171 }; 172 173 //============================================================================= 174 class SfxGlobalEvents_Impl : public ModelCollectionMutexBase 175 , public ::cppu::WeakImplHelper7< ::com::sun::star::lang::XServiceInfo 176 , ::com::sun::star::document::XEventsSupplier 177 , ::com::sun::star::document::XEventBroadcaster 178 , ::com::sun::star::document::XDocumentEventBroadcaster 179 , ::com::sun::star::document::XEventListener 180 , ::com::sun::star::document::XDocumentEventListener 181 , ::com::sun::star::container::XSet > 182 { 183 ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory > m_xSMGR; 184 ::com::sun::star::uno::Reference< ::com::sun::star::container::XNameReplace > m_xEvents; 185 ::com::sun::star::uno::WeakReference< ::com::sun::star::document::XEventListener > m_xJobExecutorListener; 186 OINTERFACECONTAINERHELPER m_aLegacyListeners; 187 OINTERFACECONTAINERHELPER m_aDocumentListeners; 188 TModelList m_lModels; 189 GlobalEventConfig* pImp; 190 191 public: 192 SfxGlobalEvents_Impl(const com::sun::star::uno::Reference < ::com::sun::star::lang::XMultiServiceFactory >& xSMGR); 193 virtual ~SfxGlobalEvents_Impl(); 194 195 SFX_DECL_XSERVICEINFO 196 197 // css.document.XEventBroadcaster 198 virtual ::com::sun::star::uno::Reference< ::com::sun::star::container::XNameReplace > SAL_CALL getEvents(); 199 200 virtual void SAL_CALL addEventListener(const ::com::sun::star::uno::Reference< ::com::sun::star::document::XEventListener >& xListener); 201 202 virtual void SAL_CALL removeEventListener( const ::com::sun::star::uno::Reference< ::com::sun::star::document::XEventListener >& xListener); 203 204 // css.document.XDocumentEventBroadcaster 205 virtual void SAL_CALL addDocumentEventListener( const ::com::sun::star::uno::Reference< ::com::sun::star::document::XDocumentEventListener >& _Listener ); 206 virtual void SAL_CALL removeDocumentEventListener( const ::com::sun::star::uno::Reference< ::com::sun::star::document::XDocumentEventListener >& _Listener ); 207 virtual void SAL_CALL notifyDocumentEvent( const ::rtl::OUString& _EventName, const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XController2 >& _ViewController, const ::com::sun::star::uno::Any& _Supplement ); 208 209 // css.document.XEventListener 210 virtual void SAL_CALL notifyEvent(const ::com::sun::star::document::EventObject& aEvent); 211 212 // css.document.XDocumentEventListener 213 virtual void SAL_CALL documentEventOccured( const ::com::sun::star::document::DocumentEvent& Event ); 214 215 // css.container.XSet 216 virtual sal_Bool SAL_CALL has(const ::com::sun::star::uno::Any& aElement); 217 218 virtual void SAL_CALL insert(const ::com::sun::star::uno::Any& aElement); 219 220 virtual void SAL_CALL remove(const ::com::sun::star::uno::Any& aElement); 221 222 // css.container.XEnumerationAccess 223 virtual ::com::sun::star::uno::Reference< ::com::sun::star::container::XEnumeration > SAL_CALL createEnumeration(); 224 225 // css.container.XElementAccess 226 virtual ::com::sun::star::uno::Type SAL_CALL getElementType(); 227 228 virtual sal_Bool SAL_CALL hasElements(); 229 230 // css.lang.XEventListener 231 virtual void SAL_CALL disposing(const ::com::sun::star::lang::EventObject& aEvent); 232 233 private: 234 235 // threadsafe 236 void implts_notifyJobExecution(const ::com::sun::star::document::EventObject& aEvent); 237 void implts_checkAndExecuteEventBindings(const ::com::sun::star::document::DocumentEvent& aEvent); 238 void implts_notifyListener(const ::com::sun::star::document::DocumentEvent& aEvent); 239 240 // not threadsafe 241 TModelList::iterator impl_searchDoc(const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XModel >& xModel); 242 }; 243 244 #endif 245