1*b1cdbd2cSJim Jagielski /************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski 24*b1cdbd2cSJim Jagielski 25*b1cdbd2cSJim Jagielski #ifndef DBACCESS_DOCUMENTEVENTNOTIFIER_HXX 26*b1cdbd2cSJim Jagielski #define DBACCESS_DOCUMENTEVENTNOTIFIER_HXX 27*b1cdbd2cSJim Jagielski 28*b1cdbd2cSJim Jagielski /** === begin UNO includes === **/ 29*b1cdbd2cSJim Jagielski #include <com/sun/star/document/XEventListener.hpp> 30*b1cdbd2cSJim Jagielski #include <com/sun/star/document/XDocumentEventListener.hpp> 31*b1cdbd2cSJim Jagielski /** === end UNO includes === **/ 32*b1cdbd2cSJim Jagielski 33*b1cdbd2cSJim Jagielski #include <rtl/ref.hxx> 34*b1cdbd2cSJim Jagielski 35*b1cdbd2cSJim Jagielski namespace cppu 36*b1cdbd2cSJim Jagielski { 37*b1cdbd2cSJim Jagielski class OWeakObject; 38*b1cdbd2cSJim Jagielski } 39*b1cdbd2cSJim Jagielski 40*b1cdbd2cSJim Jagielski //........................................................................ 41*b1cdbd2cSJim Jagielski namespace dbaccess 42*b1cdbd2cSJim Jagielski { 43*b1cdbd2cSJim Jagielski //........................................................................ 44*b1cdbd2cSJim Jagielski 45*b1cdbd2cSJim Jagielski class DocumentEventNotifier_Impl; 46*b1cdbd2cSJim Jagielski //==================================================================== 47*b1cdbd2cSJim Jagielski //= DocumentEventNotifier 48*b1cdbd2cSJim Jagielski //==================================================================== 49*b1cdbd2cSJim Jagielski class DocumentEventNotifier 50*b1cdbd2cSJim Jagielski { 51*b1cdbd2cSJim Jagielski public: 52*b1cdbd2cSJim Jagielski DocumentEventNotifier( ::cppu::OWeakObject& _rBroadcasterDocument, ::osl::Mutex& _rMutex ); 53*b1cdbd2cSJim Jagielski ~DocumentEventNotifier(); 54*b1cdbd2cSJim Jagielski 55*b1cdbd2cSJim Jagielski void addLegacyEventListener( const ::com::sun::star::uno::Reference< ::com::sun::star::document::XEventListener >& _Listener ); 56*b1cdbd2cSJim Jagielski void removeLegacyEventListener( const ::com::sun::star::uno::Reference< ::com::sun::star::document::XEventListener >& _Listener ); 57*b1cdbd2cSJim Jagielski void addDocumentEventListener( const ::com::sun::star::uno::Reference< ::com::sun::star::document::XDocumentEventListener >& _Listener ); 58*b1cdbd2cSJim Jagielski void removeDocumentEventListener( const ::com::sun::star::uno::Reference< ::com::sun::star::document::XDocumentEventListener >& _Listener ); 59*b1cdbd2cSJim Jagielski 60*b1cdbd2cSJim Jagielski /** disposes the instance 61*b1cdbd2cSJim Jagielski @precond 62*b1cdbd2cSJim Jagielski the mutex is not locked 63*b1cdbd2cSJim Jagielski */ 64*b1cdbd2cSJim Jagielski void disposing(); 65*b1cdbd2cSJim Jagielski 66*b1cdbd2cSJim Jagielski /** tells the instance that its document is completely initialized now. 67*b1cdbd2cSJim Jagielski 68*b1cdbd2cSJim Jagielski Before you call this method, no notification will actually happen 69*b1cdbd2cSJim Jagielski 70*b1cdbd2cSJim Jagielski @precond 71*b1cdbd2cSJim Jagielski the mutex is locked 72*b1cdbd2cSJim Jagielski */ 73*b1cdbd2cSJim Jagielski void onDocumentInitialized(); 74*b1cdbd2cSJim Jagielski 75*b1cdbd2cSJim Jagielski /** notifies a document event described by the given parameters 76*b1cdbd2cSJim Jagielski 77*b1cdbd2cSJim Jagielski @precond 78*b1cdbd2cSJim Jagielski the mutex is not locked 79*b1cdbd2cSJim Jagielski @precond 80*b1cdbd2cSJim Jagielski ->onDocumentInitialized has been called 81*b1cdbd2cSJim Jagielski */ 82*b1cdbd2cSJim Jagielski void notifyDocumentEvent( 83*b1cdbd2cSJim Jagielski const ::rtl::OUString& _EventName, 84*b1cdbd2cSJim Jagielski const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XController2 >& _rxViewController = NULL, 85*b1cdbd2cSJim Jagielski const ::com::sun::star::uno::Any& _Supplement = ::com::sun::star::uno::Any() 86*b1cdbd2cSJim Jagielski ); 87*b1cdbd2cSJim Jagielski 88*b1cdbd2cSJim Jagielski /** notifies a document event, described by the given parameters, asynchronously 89*b1cdbd2cSJim Jagielski 90*b1cdbd2cSJim Jagielski Note that no event is actually notified before you called ->onDocumentInitialized. 91*b1cdbd2cSJim Jagielski 92*b1cdbd2cSJim Jagielski @precond 93*b1cdbd2cSJim Jagielski the mutex is locked 94*b1cdbd2cSJim Jagielski */ 95*b1cdbd2cSJim Jagielski void notifyDocumentEventAsync( 96*b1cdbd2cSJim Jagielski const ::rtl::OUString& _EventName, 97*b1cdbd2cSJim Jagielski const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XController2 >& _ViewController = NULL, 98*b1cdbd2cSJim Jagielski const ::com::sun::star::uno::Any& _Supplement = ::com::sun::star::uno::Any() 99*b1cdbd2cSJim Jagielski ); 100*b1cdbd2cSJim Jagielski 101*b1cdbd2cSJim Jagielski /** notifies a document event to all registered listeners 102*b1cdbd2cSJim Jagielski 103*b1cdbd2cSJim Jagielski @precond 104*b1cdbd2cSJim Jagielski the mutex is not locked 105*b1cdbd2cSJim Jagielski @precond 106*b1cdbd2cSJim Jagielski ->onDocumentInitialized has been called 107*b1cdbd2cSJim Jagielski */ notifyDocumentEvent(const sal_Char * _pAsciiEventName,const::com::sun::star::uno::Reference<::com::sun::star::frame::XController2> & _rxViewController=NULL,const::com::sun::star::uno::Any & _rSupplement=::com::sun::star::uno::Any ())108*b1cdbd2cSJim Jagielski void notifyDocumentEvent( 109*b1cdbd2cSJim Jagielski const sal_Char* _pAsciiEventName, 110*b1cdbd2cSJim Jagielski const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XController2 >& _rxViewController = NULL, 111*b1cdbd2cSJim Jagielski const ::com::sun::star::uno::Any& _rSupplement = ::com::sun::star::uno::Any() 112*b1cdbd2cSJim Jagielski ) 113*b1cdbd2cSJim Jagielski { 114*b1cdbd2cSJim Jagielski notifyDocumentEvent( ::rtl::OUString::createFromAscii( _pAsciiEventName ), _rxViewController, _rSupplement ); 115*b1cdbd2cSJim Jagielski } 116*b1cdbd2cSJim Jagielski 117*b1cdbd2cSJim Jagielski /** notifies a document event to all registered listeners, asynchronously 118*b1cdbd2cSJim Jagielski 119*b1cdbd2cSJim Jagielski Note that no event is actually notified before you called ->onDocumentInitialized. 120*b1cdbd2cSJim Jagielski 121*b1cdbd2cSJim Jagielski @precond 122*b1cdbd2cSJim Jagielski the mutex is locked 123*b1cdbd2cSJim Jagielski */ notifyDocumentEventAsync(const sal_Char * _pAsciiEventName,const::com::sun::star::uno::Reference<::com::sun::star::frame::XController2> & _rxViewController=NULL,const::com::sun::star::uno::Any & _rSupplement=::com::sun::star::uno::Any ())124*b1cdbd2cSJim Jagielski void notifyDocumentEventAsync( 125*b1cdbd2cSJim Jagielski const sal_Char* _pAsciiEventName, 126*b1cdbd2cSJim Jagielski const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XController2 >& _rxViewController = NULL, 127*b1cdbd2cSJim Jagielski const ::com::sun::star::uno::Any& _rSupplement = ::com::sun::star::uno::Any() 128*b1cdbd2cSJim Jagielski ) 129*b1cdbd2cSJim Jagielski { 130*b1cdbd2cSJim Jagielski notifyDocumentEventAsync( ::rtl::OUString::createFromAscii( _pAsciiEventName ), _rxViewController, _rSupplement ); 131*b1cdbd2cSJim Jagielski } 132*b1cdbd2cSJim Jagielski 133*b1cdbd2cSJim Jagielski private: 134*b1cdbd2cSJim Jagielski ::rtl::Reference< DocumentEventNotifier_Impl > m_pImpl; 135*b1cdbd2cSJim Jagielski }; 136*b1cdbd2cSJim Jagielski 137*b1cdbd2cSJim Jagielski //........................................................................ 138*b1cdbd2cSJim Jagielski } // namespace dbaccess 139*b1cdbd2cSJim Jagielski //........................................................................ 140*b1cdbd2cSJim Jagielski 141*b1cdbd2cSJim Jagielski #endif // DBACCESS_DOCUMENTEVENTNOTIFIER_HXX 142