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 SD_FRAMEWORK_CONFIGURATION_CONTROLLER_HXX 25*b1cdbd2cSJim Jagielski #define SD_FRAMEWORK_CONFIGURATION_CONTROLLER_HXX 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski #include "MutexOwner.hxx" 28*b1cdbd2cSJim Jagielski 29*b1cdbd2cSJim Jagielski #include <com/sun/star/drawing/framework/XConfigurationController.hpp> 30*b1cdbd2cSJim Jagielski #include <com/sun/star/drawing/framework/XConfigurationChangeRequest.hpp> 31*b1cdbd2cSJim Jagielski #include <com/sun/star/drawing/framework/XConfiguration.hpp> 32*b1cdbd2cSJim Jagielski #include <com/sun/star/drawing/framework/XControllerManager.hpp> 33*b1cdbd2cSJim Jagielski #include <com/sun/star/drawing/framework/XResourceFactoryManager.hpp> 34*b1cdbd2cSJim Jagielski #include <com/sun/star/drawing/framework/XResourceId.hpp> 35*b1cdbd2cSJim Jagielski #include <com/sun/star/drawing/framework/ConfigurationChangeEvent.hpp> 36*b1cdbd2cSJim Jagielski #include <com/sun/star/lang/XInitialization.hpp> 37*b1cdbd2cSJim Jagielski #include <com/sun/star/uno/XComponentContext.hpp> 38*b1cdbd2cSJim Jagielski 39*b1cdbd2cSJim Jagielski #include <cppuhelper/compbase2.hxx> 40*b1cdbd2cSJim Jagielski #include <tools/link.hxx> 41*b1cdbd2cSJim Jagielski #include <rtl/ref.hxx> 42*b1cdbd2cSJim Jagielski 43*b1cdbd2cSJim Jagielski #include <boost/scoped_ptr.hpp> 44*b1cdbd2cSJim Jagielski #include <boost/shared_ptr.hpp> 45*b1cdbd2cSJim Jagielski #include <boost/noncopyable.hpp> 46*b1cdbd2cSJim Jagielski 47*b1cdbd2cSJim Jagielski namespace css = ::com::sun::star; 48*b1cdbd2cSJim Jagielski 49*b1cdbd2cSJim Jagielski namespace { 50*b1cdbd2cSJim Jagielski 51*b1cdbd2cSJim Jagielski typedef ::cppu::WeakComponentImplHelper2 < 52*b1cdbd2cSJim Jagielski ::css::drawing::framework::XConfigurationController, 53*b1cdbd2cSJim Jagielski ::css::lang::XInitialization 54*b1cdbd2cSJim Jagielski > ConfigurationControllerInterfaceBase; 55*b1cdbd2cSJim Jagielski 56*b1cdbd2cSJim Jagielski } // end of anonymous namespace. 57*b1cdbd2cSJim Jagielski 58*b1cdbd2cSJim Jagielski 59*b1cdbd2cSJim Jagielski namespace sd { class ViewShellBase; } 60*b1cdbd2cSJim Jagielski 61*b1cdbd2cSJim Jagielski 62*b1cdbd2cSJim Jagielski namespace sd { namespace framework { 63*b1cdbd2cSJim Jagielski 64*b1cdbd2cSJim Jagielski class ChangeRequestQueueProcessor; 65*b1cdbd2cSJim Jagielski class ConfigurationControllerBroadcaster; 66*b1cdbd2cSJim Jagielski class ConfigurationUpdater; 67*b1cdbd2cSJim Jagielski class ConfigurationUpdaterLock; 68*b1cdbd2cSJim Jagielski 69*b1cdbd2cSJim Jagielski /** The configuration controller is responsible for maintaining the current 70*b1cdbd2cSJim Jagielski configuration. 71*b1cdbd2cSJim Jagielski 72*b1cdbd2cSJim Jagielski @see css::drawing::framework::XConfigurationController 73*b1cdbd2cSJim Jagielski for an extended documentation. 74*b1cdbd2cSJim Jagielski */ 75*b1cdbd2cSJim Jagielski class ConfigurationController 76*b1cdbd2cSJim Jagielski : private sd::MutexOwner, 77*b1cdbd2cSJim Jagielski private boost::noncopyable, 78*b1cdbd2cSJim Jagielski public ConfigurationControllerInterfaceBase 79*b1cdbd2cSJim Jagielski { 80*b1cdbd2cSJim Jagielski public: 81*b1cdbd2cSJim Jagielski ConfigurationController (void) throw(); 82*b1cdbd2cSJim Jagielski virtual ~ConfigurationController (void) throw(); 83*b1cdbd2cSJim Jagielski 84*b1cdbd2cSJim Jagielski virtual void SAL_CALL disposing (void); 85*b1cdbd2cSJim Jagielski 86*b1cdbd2cSJim Jagielski void ProcessEvent (void); 87*b1cdbd2cSJim Jagielski 88*b1cdbd2cSJim Jagielski /** Normally the requested changes of the configuration are executed 89*b1cdbd2cSJim Jagielski asynchronously. However, there is at least one situation (searching 90*b1cdbd2cSJim Jagielski with the Outliner) where the surrounding code does not cope with 91*b1cdbd2cSJim Jagielski this. So, instead of calling Reschedule until the global event loop 92*b1cdbd2cSJim Jagielski executes the configuration update, this method does (almost) the 93*b1cdbd2cSJim Jagielski same without the reschedules. 94*b1cdbd2cSJim Jagielski 95*b1cdbd2cSJim Jagielski Do not use this method until there is absolutely no other way. 96*b1cdbd2cSJim Jagielski */ 97*b1cdbd2cSJim Jagielski void RequestSynchronousUpdate (void); 98*b1cdbd2cSJim Jagielski 99*b1cdbd2cSJim Jagielski // XConfigurationController 100*b1cdbd2cSJim Jagielski 101*b1cdbd2cSJim Jagielski virtual void SAL_CALL lock (void) 102*b1cdbd2cSJim Jagielski throw (css::uno::RuntimeException); 103*b1cdbd2cSJim Jagielski 104*b1cdbd2cSJim Jagielski virtual void SAL_CALL unlock (void) 105*b1cdbd2cSJim Jagielski throw (css::uno::RuntimeException); 106*b1cdbd2cSJim Jagielski 107*b1cdbd2cSJim Jagielski virtual void SAL_CALL requestResourceActivation ( 108*b1cdbd2cSJim Jagielski const css::uno::Reference<css::drawing::framework::XResourceId>& rxResourceId, 109*b1cdbd2cSJim Jagielski css::drawing::framework::ResourceActivationMode eMode) 110*b1cdbd2cSJim Jagielski throw (css::uno::RuntimeException); 111*b1cdbd2cSJim Jagielski 112*b1cdbd2cSJim Jagielski virtual void SAL_CALL requestResourceDeactivation ( 113*b1cdbd2cSJim Jagielski const css::uno::Reference<css::drawing::framework::XResourceId>& 114*b1cdbd2cSJim Jagielski rxResourceId) 115*b1cdbd2cSJim Jagielski throw (css::uno::RuntimeException); 116*b1cdbd2cSJim Jagielski 117*b1cdbd2cSJim Jagielski virtual css::uno::Reference<css::drawing::framework::XResource> 118*b1cdbd2cSJim Jagielski SAL_CALL getResource ( 119*b1cdbd2cSJim Jagielski const css::uno::Reference<css::drawing::framework::XResourceId>& rxResourceId) 120*b1cdbd2cSJim Jagielski throw (css::uno::RuntimeException); 121*b1cdbd2cSJim Jagielski 122*b1cdbd2cSJim Jagielski virtual void SAL_CALL update (void) 123*b1cdbd2cSJim Jagielski throw (css::uno::RuntimeException); 124*b1cdbd2cSJim Jagielski 125*b1cdbd2cSJim Jagielski virtual css::uno::Reference< 126*b1cdbd2cSJim Jagielski css::drawing::framework::XConfiguration> 127*b1cdbd2cSJim Jagielski SAL_CALL getRequestedConfiguration (void) 128*b1cdbd2cSJim Jagielski throw (css::uno::RuntimeException); 129*b1cdbd2cSJim Jagielski 130*b1cdbd2cSJim Jagielski virtual css::uno::Reference< 131*b1cdbd2cSJim Jagielski css::drawing::framework::XConfiguration> 132*b1cdbd2cSJim Jagielski SAL_CALL getCurrentConfiguration (void) 133*b1cdbd2cSJim Jagielski throw (css::uno::RuntimeException); 134*b1cdbd2cSJim Jagielski 135*b1cdbd2cSJim Jagielski virtual void SAL_CALL restoreConfiguration ( 136*b1cdbd2cSJim Jagielski const css::uno::Reference<css::drawing::framework::XConfiguration>& 137*b1cdbd2cSJim Jagielski rxConfiguration) 138*b1cdbd2cSJim Jagielski throw (css::uno::RuntimeException); 139*b1cdbd2cSJim Jagielski 140*b1cdbd2cSJim Jagielski 141*b1cdbd2cSJim Jagielski // XConfigurationControllerBroadcaster 142*b1cdbd2cSJim Jagielski 143*b1cdbd2cSJim Jagielski virtual void SAL_CALL addConfigurationChangeListener ( 144*b1cdbd2cSJim Jagielski const css::uno::Reference< 145*b1cdbd2cSJim Jagielski css::drawing::framework::XConfigurationChangeListener>& rxListener, 146*b1cdbd2cSJim Jagielski const ::rtl::OUString& rsEventType, 147*b1cdbd2cSJim Jagielski const css::uno::Any& rUserData) 148*b1cdbd2cSJim Jagielski throw (css::uno::RuntimeException); 149*b1cdbd2cSJim Jagielski 150*b1cdbd2cSJim Jagielski virtual void SAL_CALL removeConfigurationChangeListener ( 151*b1cdbd2cSJim Jagielski const css::uno::Reference< 152*b1cdbd2cSJim Jagielski css::drawing::framework::XConfigurationChangeListener>& rxListener) 153*b1cdbd2cSJim Jagielski throw (css::uno::RuntimeException); 154*b1cdbd2cSJim Jagielski 155*b1cdbd2cSJim Jagielski virtual void SAL_CALL notifyEvent ( 156*b1cdbd2cSJim Jagielski const css::drawing::framework::ConfigurationChangeEvent& rEvent) 157*b1cdbd2cSJim Jagielski throw (css::uno::RuntimeException); 158*b1cdbd2cSJim Jagielski 159*b1cdbd2cSJim Jagielski 160*b1cdbd2cSJim Jagielski // XConfigurationRequestQueue 161*b1cdbd2cSJim Jagielski 162*b1cdbd2cSJim Jagielski virtual sal_Bool SAL_CALL hasPendingRequests (void) 163*b1cdbd2cSJim Jagielski throw (css::uno::RuntimeException); 164*b1cdbd2cSJim Jagielski 165*b1cdbd2cSJim Jagielski virtual void SAL_CALL postChangeRequest ( 166*b1cdbd2cSJim Jagielski const css::uno::Reference< 167*b1cdbd2cSJim Jagielski css::drawing::framework::XConfigurationChangeRequest>& rxRequest) 168*b1cdbd2cSJim Jagielski throw (css::uno::RuntimeException); 169*b1cdbd2cSJim Jagielski 170*b1cdbd2cSJim Jagielski 171*b1cdbd2cSJim Jagielski // XResourceFactoryManager 172*b1cdbd2cSJim Jagielski 173*b1cdbd2cSJim Jagielski virtual void SAL_CALL addResourceFactory( 174*b1cdbd2cSJim Jagielski const ::rtl::OUString& sResourceURL, 175*b1cdbd2cSJim Jagielski const css::uno::Reference<css::drawing::framework::XResourceFactory>& rxResourceFactory) 176*b1cdbd2cSJim Jagielski throw (css::uno::RuntimeException); 177*b1cdbd2cSJim Jagielski 178*b1cdbd2cSJim Jagielski virtual void SAL_CALL removeResourceFactoryForURL( 179*b1cdbd2cSJim Jagielski const ::rtl::OUString& sResourceURL) 180*b1cdbd2cSJim Jagielski throw (css::uno::RuntimeException); 181*b1cdbd2cSJim Jagielski 182*b1cdbd2cSJim Jagielski virtual void SAL_CALL removeResourceFactoryForReference( 183*b1cdbd2cSJim Jagielski const css::uno::Reference<css::drawing::framework::XResourceFactory>& rxResourceFactory) 184*b1cdbd2cSJim Jagielski throw (css::uno::RuntimeException); 185*b1cdbd2cSJim Jagielski 186*b1cdbd2cSJim Jagielski virtual css::uno::Reference<css::drawing::framework::XResourceFactory> 187*b1cdbd2cSJim Jagielski SAL_CALL getResourceFactory ( 188*b1cdbd2cSJim Jagielski const ::rtl::OUString& sResourceURL) 189*b1cdbd2cSJim Jagielski throw (css::uno::RuntimeException); 190*b1cdbd2cSJim Jagielski 191*b1cdbd2cSJim Jagielski 192*b1cdbd2cSJim Jagielski // XInitialization 193*b1cdbd2cSJim Jagielski 194*b1cdbd2cSJim Jagielski virtual void SAL_CALL initialize( 195*b1cdbd2cSJim Jagielski const css::uno::Sequence<css::uno::Any>& rArguments) 196*b1cdbd2cSJim Jagielski throw (css::uno::Exception, css::uno::RuntimeException); 197*b1cdbd2cSJim Jagielski 198*b1cdbd2cSJim Jagielski 199*b1cdbd2cSJim Jagielski /** Use this class instead of calling lock() and unlock() directly in 200*b1cdbd2cSJim Jagielski order to be exception safe. 201*b1cdbd2cSJim Jagielski */ 202*b1cdbd2cSJim Jagielski class Lock 203*b1cdbd2cSJim Jagielski { 204*b1cdbd2cSJim Jagielski public: 205*b1cdbd2cSJim Jagielski Lock (const css::uno::Reference< 206*b1cdbd2cSJim Jagielski css::drawing::framework::XConfigurationController>& rxController); 207*b1cdbd2cSJim Jagielski ~Lock (void); 208*b1cdbd2cSJim Jagielski private: 209*b1cdbd2cSJim Jagielski css::uno::Reference< 210*b1cdbd2cSJim Jagielski css::drawing::framework::XConfigurationController> mxController; 211*b1cdbd2cSJim Jagielski }; 212*b1cdbd2cSJim Jagielski 213*b1cdbd2cSJim Jagielski private: 214*b1cdbd2cSJim Jagielski class Implementation; 215*b1cdbd2cSJim Jagielski ::boost::scoped_ptr<Implementation> mpImplementation; 216*b1cdbd2cSJim Jagielski bool mbIsDisposed; 217*b1cdbd2cSJim Jagielski 218*b1cdbd2cSJim Jagielski /** When the called object has already been disposed this method throws 219*b1cdbd2cSJim Jagielski an exception and does not return. 220*b1cdbd2cSJim Jagielski */ 221*b1cdbd2cSJim Jagielski void ThrowIfDisposed (void) const 222*b1cdbd2cSJim Jagielski throw (css::lang::DisposedException); 223*b1cdbd2cSJim Jagielski }; 224*b1cdbd2cSJim Jagielski 225*b1cdbd2cSJim Jagielski } } // end of namespace sd::framework 226*b1cdbd2cSJim Jagielski 227*b1cdbd2cSJim Jagielski #endif 228