| /************************************************************** |
| * |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| * |
| *************************************************************/ |
| |
| |
| |
| #ifndef SD_FRAMEWORK_CONFIGURATION_CONTROLLER_HXX |
| #define SD_FRAMEWORK_CONFIGURATION_CONTROLLER_HXX |
| |
| #include "MutexOwner.hxx" |
| |
| #include <com/sun/star/drawing/framework/XConfigurationController.hpp> |
| #include <com/sun/star/drawing/framework/XConfigurationChangeRequest.hpp> |
| #include <com/sun/star/drawing/framework/XConfiguration.hpp> |
| #include <com/sun/star/drawing/framework/XControllerManager.hpp> |
| #include <com/sun/star/drawing/framework/XResourceFactoryManager.hpp> |
| #include <com/sun/star/drawing/framework/XResourceId.hpp> |
| #include <com/sun/star/drawing/framework/ConfigurationChangeEvent.hpp> |
| #include <com/sun/star/lang/XInitialization.hpp> |
| #include <com/sun/star/uno/XComponentContext.hpp> |
| |
| #include <cppuhelper/compbase2.hxx> |
| #include <tools/link.hxx> |
| #include <rtl/ref.hxx> |
| |
| #include <boost/scoped_ptr.hpp> |
| #include <boost/shared_ptr.hpp> |
| #include <boost/noncopyable.hpp> |
| |
| namespace css = ::com::sun::star; |
| |
| namespace { |
| |
| typedef ::cppu::WeakComponentImplHelper2 < |
| ::css::drawing::framework::XConfigurationController, |
| ::css::lang::XInitialization |
| > ConfigurationControllerInterfaceBase; |
| |
| } // end of anonymous namespace. |
| |
| |
| namespace sd { class ViewShellBase; } |
| |
| |
| namespace sd { namespace framework { |
| |
| class ChangeRequestQueueProcessor; |
| class ConfigurationControllerBroadcaster; |
| class ConfigurationUpdater; |
| class ConfigurationUpdaterLock; |
| |
| /** The configuration controller is responsible for maintaining the current |
| configuration. |
| |
| @see css::drawing::framework::XConfigurationController |
| for an extended documentation. |
| */ |
| class ConfigurationController |
| : private sd::MutexOwner, |
| private boost::noncopyable, |
| public ConfigurationControllerInterfaceBase |
| { |
| public: |
| ConfigurationController (void) throw(); |
| virtual ~ConfigurationController (void) throw(); |
| |
| virtual void SAL_CALL disposing (void); |
| |
| void ProcessEvent (void); |
| |
| /** Normally the requested changes of the configuration are executed |
| asynchronously. However, there is at least one situation (searching |
| with the Outliner) where the surrounding code does not cope with |
| this. So, instead of calling Reschedule until the global event loop |
| executes the configuration update, this method does (almost) the |
| same without the reschedules. |
| |
| Do not use this method until there is absolutely no other way. |
| */ |
| void RequestSynchronousUpdate (void); |
| |
| // XConfigurationController |
| |
| virtual void SAL_CALL lock (void) |
| throw (css::uno::RuntimeException); |
| |
| virtual void SAL_CALL unlock (void) |
| throw (css::uno::RuntimeException); |
| |
| virtual void SAL_CALL requestResourceActivation ( |
| const css::uno::Reference<css::drawing::framework::XResourceId>& rxResourceId, |
| css::drawing::framework::ResourceActivationMode eMode) |
| throw (css::uno::RuntimeException); |
| |
| virtual void SAL_CALL requestResourceDeactivation ( |
| const css::uno::Reference<css::drawing::framework::XResourceId>& |
| rxResourceId) |
| throw (css::uno::RuntimeException); |
| |
| virtual css::uno::Reference<css::drawing::framework::XResource> |
| SAL_CALL getResource ( |
| const css::uno::Reference<css::drawing::framework::XResourceId>& rxResourceId) |
| throw (css::uno::RuntimeException); |
| |
| virtual void SAL_CALL update (void) |
| throw (css::uno::RuntimeException); |
| |
| virtual css::uno::Reference< |
| css::drawing::framework::XConfiguration> |
| SAL_CALL getRequestedConfiguration (void) |
| throw (css::uno::RuntimeException); |
| |
| virtual css::uno::Reference< |
| css::drawing::framework::XConfiguration> |
| SAL_CALL getCurrentConfiguration (void) |
| throw (css::uno::RuntimeException); |
| |
| virtual void SAL_CALL restoreConfiguration ( |
| const css::uno::Reference<css::drawing::framework::XConfiguration>& |
| rxConfiguration) |
| throw (css::uno::RuntimeException); |
| |
| |
| // XConfigurationControllerBroadcaster |
| |
| virtual void SAL_CALL addConfigurationChangeListener ( |
| const css::uno::Reference< |
| css::drawing::framework::XConfigurationChangeListener>& rxListener, |
| const ::rtl::OUString& rsEventType, |
| const css::uno::Any& rUserData) |
| throw (css::uno::RuntimeException); |
| |
| virtual void SAL_CALL removeConfigurationChangeListener ( |
| const css::uno::Reference< |
| css::drawing::framework::XConfigurationChangeListener>& rxListener) |
| throw (css::uno::RuntimeException); |
| |
| virtual void SAL_CALL notifyEvent ( |
| const css::drawing::framework::ConfigurationChangeEvent& rEvent) |
| throw (css::uno::RuntimeException); |
| |
| |
| // XConfigurationRequestQueue |
| |
| virtual sal_Bool SAL_CALL hasPendingRequests (void) |
| throw (css::uno::RuntimeException); |
| |
| virtual void SAL_CALL postChangeRequest ( |
| const css::uno::Reference< |
| css::drawing::framework::XConfigurationChangeRequest>& rxRequest) |
| throw (css::uno::RuntimeException); |
| |
| |
| // XResourceFactoryManager |
| |
| virtual void SAL_CALL addResourceFactory( |
| const ::rtl::OUString& sResourceURL, |
| const css::uno::Reference<css::drawing::framework::XResourceFactory>& rxResourceFactory) |
| throw (css::uno::RuntimeException); |
| |
| virtual void SAL_CALL removeResourceFactoryForURL( |
| const ::rtl::OUString& sResourceURL) |
| throw (css::uno::RuntimeException); |
| |
| virtual void SAL_CALL removeResourceFactoryForReference( |
| const css::uno::Reference<css::drawing::framework::XResourceFactory>& rxResourceFactory) |
| throw (css::uno::RuntimeException); |
| |
| virtual css::uno::Reference<css::drawing::framework::XResourceFactory> |
| SAL_CALL getResourceFactory ( |
| const ::rtl::OUString& sResourceURL) |
| throw (css::uno::RuntimeException); |
| |
| |
| // XInitialization |
| |
| virtual void SAL_CALL initialize( |
| const css::uno::Sequence<css::uno::Any>& rArguments) |
| throw (css::uno::Exception, css::uno::RuntimeException); |
| |
| |
| /** Use this class instead of calling lock() and unlock() directly in |
| order to be exception safe. |
| */ |
| class Lock |
| { |
| public: |
| Lock (const css::uno::Reference< |
| css::drawing::framework::XConfigurationController>& rxController); |
| ~Lock (void); |
| private: |
| css::uno::Reference< |
| css::drawing::framework::XConfigurationController> mxController; |
| }; |
| |
| private: |
| class Implementation; |
| ::boost::scoped_ptr<Implementation> mpImplementation; |
| bool mbIsDisposed; |
| |
| /** When the called object has already been disposed this method throws |
| an exception and does not return. |
| */ |
| void ThrowIfDisposed (void) const |
| throw (css::lang::DisposedException); |
| }; |
| |
| } } // end of namespace sd::framework |
| |
| #endif |