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 #ifndef SVX_FMDISPATCH_HXX 25*b1cdbd2cSJim Jagielski #define SVX_FMDISPATCH_HXX 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski /** === begin UNO includes === **/ 28*b1cdbd2cSJim Jagielski #include <com/sun/star/frame/XDispatch.hpp> 29*b1cdbd2cSJim Jagielski #include <com/sun/star/lang/DisposedException.hpp> 30*b1cdbd2cSJim Jagielski #include <com/sun/star/form/runtime/XFormOperations.hpp> 31*b1cdbd2cSJim Jagielski /** === end UNO includes === **/ 32*b1cdbd2cSJim Jagielski 33*b1cdbd2cSJim Jagielski #include <cppuhelper/implbase1.hxx> 34*b1cdbd2cSJim Jagielski #include <cppuhelper/interfacecontainer.hxx> 35*b1cdbd2cSJim Jagielski 36*b1cdbd2cSJim Jagielski //........................................................................ 37*b1cdbd2cSJim Jagielski namespace svx 38*b1cdbd2cSJim Jagielski { 39*b1cdbd2cSJim Jagielski //........................................................................ 40*b1cdbd2cSJim Jagielski 41*b1cdbd2cSJim Jagielski //==================================================================== 42*b1cdbd2cSJim Jagielski //= OSingleFeatureDispatcher 43*b1cdbd2cSJim Jagielski //==================================================================== 44*b1cdbd2cSJim Jagielski typedef ::cppu::WeakImplHelper1 < ::com::sun::star::frame::XDispatch 45*b1cdbd2cSJim Jagielski > OSingleFeatureDispatcher_Base; 46*b1cdbd2cSJim Jagielski 47*b1cdbd2cSJim Jagielski class OSingleFeatureDispatcher : public OSingleFeatureDispatcher_Base 48*b1cdbd2cSJim Jagielski { 49*b1cdbd2cSJim Jagielski private: 50*b1cdbd2cSJim Jagielski ::osl::Mutex& m_rMutex; 51*b1cdbd2cSJim Jagielski ::cppu::OInterfaceContainerHelper m_aStatusListeners; 52*b1cdbd2cSJim Jagielski ::com::sun::star::uno::Reference< ::com::sun::star::form::runtime::XFormOperations > 53*b1cdbd2cSJim Jagielski m_xFormOperations; 54*b1cdbd2cSJim Jagielski const ::com::sun::star::util::URL m_aFeatureURL; 55*b1cdbd2cSJim Jagielski ::com::sun::star::uno::Any m_aLastKnownState; 56*b1cdbd2cSJim Jagielski const sal_Int16 m_nFormFeature; 57*b1cdbd2cSJim Jagielski sal_Bool m_bLastKnownEnabled; 58*b1cdbd2cSJim Jagielski sal_Bool m_bDisposed; 59*b1cdbd2cSJim Jagielski 60*b1cdbd2cSJim Jagielski public: 61*b1cdbd2cSJim Jagielski /** constructs the dispatcher 62*b1cdbd2cSJim Jagielski 63*b1cdbd2cSJim Jagielski @param _rFeatureURL 64*b1cdbd2cSJim Jagielski the URL of the feature which this instance is responsible for 65*b1cdbd2cSJim Jagielski 66*b1cdbd2cSJim Jagielski @param _nFeatureId 67*b1cdbd2cSJim Jagielski the feature which this instance is responsible for 68*b1cdbd2cSJim Jagielski 69*b1cdbd2cSJim Jagielski @param _rController 70*b1cdbd2cSJim Jagielski the controller which is responsible for providing the state of feature of this instance, 71*b1cdbd2cSJim Jagielski and for executing it. After disposing the dispatcher instance, the controller will 72*b1cdbd2cSJim Jagielski not be accessed anymore 73*b1cdbd2cSJim Jagielski 74*b1cdbd2cSJim Jagielski @see dispose 75*b1cdbd2cSJim Jagielski */ 76*b1cdbd2cSJim Jagielski OSingleFeatureDispatcher( 77*b1cdbd2cSJim Jagielski const ::com::sun::star::util::URL& _rFeatureURL, 78*b1cdbd2cSJim Jagielski const sal_Int16 _nFormFeature, 79*b1cdbd2cSJim Jagielski const ::com::sun::star::uno::Reference< ::com::sun::star::form::runtime::XFormOperations >& _rxFormOperations, 80*b1cdbd2cSJim Jagielski ::osl::Mutex& _rMutex 81*b1cdbd2cSJim Jagielski ); 82*b1cdbd2cSJim Jagielski 83*b1cdbd2cSJim Jagielski /** disposes the dispatcher instance 84*b1cdbd2cSJim Jagielski 85*b1cdbd2cSJim Jagielski All status listeners will, after receiving an <member scope="com::sun::star::lang">XEventListener::disposing</member> 86*b1cdbd2cSJim Jagielski call, be released. 87*b1cdbd2cSJim Jagielski 88*b1cdbd2cSJim Jagielski The controller provided in the in constructor will not be used anymore after returning from this call. 89*b1cdbd2cSJim Jagielski 90*b1cdbd2cSJim Jagielski No further requests to dispatch slots will be accepted. 91*b1cdbd2cSJim Jagielski 92*b1cdbd2cSJim Jagielski Multiple calls are allowed: if the object already was disposed, then subsequent calls are 93*b1cdbd2cSJim Jagielski silently ignored. 94*b1cdbd2cSJim Jagielski */ 95*b1cdbd2cSJim Jagielski void dispose(); 96*b1cdbd2cSJim Jagielski 97*b1cdbd2cSJim Jagielski /** notifies all our listeners of the current state 98*b1cdbd2cSJim Jagielski */ 99*b1cdbd2cSJim Jagielski void updateAllListeners(); 100*b1cdbd2cSJim Jagielski 101*b1cdbd2cSJim Jagielski protected: 102*b1cdbd2cSJim Jagielski // XDispatch 103*b1cdbd2cSJim Jagielski virtual void SAL_CALL dispatch( const ::com::sun::star::util::URL& _rURL, const ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue >& _rArguments ) throw (::com::sun::star::uno::RuntimeException); 104*b1cdbd2cSJim Jagielski virtual void SAL_CALL addStatusListener( const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XStatusListener >& _rxControl, const ::com::sun::star::util::URL& _rURL ) throw (::com::sun::star::uno::RuntimeException); 105*b1cdbd2cSJim Jagielski virtual void SAL_CALL removeStatusListener( const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XStatusListener >& _rxControl, const ::com::sun::star::util::URL& _rURL ) throw (::com::sun::star::uno::RuntimeException); 106*b1cdbd2cSJim Jagielski 107*b1cdbd2cSJim Jagielski protected: 108*b1cdbd2cSJim Jagielski /** notifies our current state to one or all listeners 109*b1cdbd2cSJim Jagielski 110*b1cdbd2cSJim Jagielski @param _rxListener 111*b1cdbd2cSJim Jagielski the listener to notify. May be NULL, in this case all our listeners will be 112*b1cdbd2cSJim Jagielski notified with the current state 113*b1cdbd2cSJim Jagielski 114*b1cdbd2cSJim Jagielski @param _rFreeForNotification 115*b1cdbd2cSJim Jagielski a guard which currently locks our mutex, and which is to be cleared 116*b1cdbd2cSJim Jagielski for actually doing the notification(s) 117*b1cdbd2cSJim Jagielski */ 118*b1cdbd2cSJim Jagielski void notifyStatus( 119*b1cdbd2cSJim Jagielski const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XStatusListener >& _rxListener, 120*b1cdbd2cSJim Jagielski ::osl::ClearableMutexGuard& _rFreeForNotification 121*b1cdbd2cSJim Jagielski ); 122*b1cdbd2cSJim Jagielski 123*b1cdbd2cSJim Jagielski private: 124*b1cdbd2cSJim Jagielski /** checks whether our instance is alive 125*b1cdbd2cSJim Jagielski 126*b1cdbd2cSJim Jagielski If the instance already received a <member>dispose</member> call, then a 127*b1cdbd2cSJim Jagielski <type scope="com::sun::star::lang">DisposedException</type> is thrown. 128*b1cdbd2cSJim Jagielski 129*b1cdbd2cSJim Jagielski @precond 130*b1cdbd2cSJim Jagielski our Mutex is locked - else calling the method would not make sense, since 131*b1cdbd2cSJim Jagielski it's result could be out-of-date as soon as it's returned to the caller. 132*b1cdbd2cSJim Jagielski */ 133*b1cdbd2cSJim Jagielski void checkAlive() const SAL_THROW((::com::sun::star::lang::DisposedException)); 134*b1cdbd2cSJim Jagielski 135*b1cdbd2cSJim Jagielski /** retrieves the current status of our feature, in a format which can be used 136*b1cdbd2cSJim Jagielski for UNO notifications 137*b1cdbd2cSJim Jagielski 138*b1cdbd2cSJim Jagielski @precond 139*b1cdbd2cSJim Jagielski our mutex is locked 140*b1cdbd2cSJim Jagielski */ 141*b1cdbd2cSJim Jagielski void getUnoState( ::com::sun::star::frame::FeatureStateEvent& /* [out] */ _rState ) const; 142*b1cdbd2cSJim Jagielski 143*b1cdbd2cSJim Jagielski private: 144*b1cdbd2cSJim Jagielski OSingleFeatureDispatcher(); // never implemented 145*b1cdbd2cSJim Jagielski OSingleFeatureDispatcher( const OSingleFeatureDispatcher& ); // never implemented 146*b1cdbd2cSJim Jagielski OSingleFeatureDispatcher& operator=( const OSingleFeatureDispatcher& ); // never implemented 147*b1cdbd2cSJim Jagielski }; 148*b1cdbd2cSJim Jagielski 149*b1cdbd2cSJim Jagielski //........................................................................ 150*b1cdbd2cSJim Jagielski } // namespace svx 151*b1cdbd2cSJim Jagielski //........................................................................ 152*b1cdbd2cSJim Jagielski 153*b1cdbd2cSJim Jagielski #endif 154