sd/source/ui/inc/framework/ConfigurationController.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: ConfigurationController.hxx,v $
  10  * $Revision: 1.5 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef SD_FRAMEWORK_CONFIGURATION_CONTROLLER_HXX
  32 #define SD_FRAMEWORK_CONFIGURATION_CONTROLLER_HXX
  33
  34 #include "MutexOwner.hxx"
  35
  36 #include <com/sun/star/drawing/framework/XConfigurationController.hpp>
  37 #include <com/sun/star/drawing/framework/XConfigurationChangeRequest.hpp>
  38 #include <com/sun/star/drawing/framework/XConfiguration.hpp>
  39 #include <com/sun/star/drawing/framework/XControllerManager.hpp>
  40 #include <com/sun/star/drawing/framework/XResourceFactoryManager.hpp>
  41 #include <com/sun/star/drawing/framework/XResourceId.hpp>
  42 #include <com/sun/star/drawing/framework/ConfigurationChangeEvent.hpp>
  43 #include <com/sun/star/lang/XInitialization.hpp>
  44 #include <com/sun/star/uno/XComponentContext.hpp>
  45
  46 #include <cppuhelper/compbase2.hxx>
  47 #include <tools/link.hxx>
  48 #include <rtl/ref.hxx>
  49
  50 #include <boost/scoped_ptr.hpp>
  51 #include <boost/shared_ptr.hpp>
  52 #include <boost/noncopyable.hpp>
  53
  54 namespace css = ::com::sun::star;
  55
  56 namespace {
  57
  58 typedef ::cppu::WeakComponentImplHelper2 <
  59     ::css::drawing::framework::XConfigurationController,
  60     ::css::lang::XInitialization
  61     > ConfigurationControllerInterfaceBase;
  62
  63 } // end of anonymous namespace.
  64
  65
  66 namespace sd { class ViewShellBase; }
  67
  68
  69 namespace sd { namespace framework {
  70
  71 class ChangeRequestQueueProcessor;
  72 class ConfigurationControllerBroadcaster;
  73 class ConfigurationUpdater;
  74 class ConfigurationUpdaterLock;
  75
  76 /** The configuration controller is responsible for maintaining the current
  77     configuration.
  78
  79     @see css::drawing::framework::XConfigurationController
  80         for an extended documentation.
  81 */
  82 class ConfigurationController
  83     : private sd::MutexOwner,
  84       private boost::noncopyable,
  85       public ConfigurationControllerInterfaceBase
  86 {
  87 public:
  88     ConfigurationController (void) throw();
  89     virtual ~ConfigurationController (void) throw();
  90
  91     virtual void SAL_CALL disposing (void);
  92
  93     void ProcessEvent (void);
  94
  95     /** Normally the requested changes of the configuration are executed
  96         asynchronously.  However, there is at least one situation (searching
  97         with the Outliner) where the surrounding code does not cope with
  98         this.  So, instead of calling Reschedule until the global event loop
  99         executes the configuration update, this method does (almost) the
 100         same without the reschedules.
 101
 102         Do not use this method until there is absolutely no other way.
 103     */
 104     void RequestSynchronousUpdate (void);
 105
 106     // XConfigurationController
 107
 108     virtual void SAL_CALL lock (void)
 109         throw (css::uno::RuntimeException);
 110
 111     virtual void SAL_CALL unlock (void)
 112         throw (css::uno::RuntimeException);
 113
 114     virtual void SAL_CALL requestResourceActivation (
 115         const css::uno::Reference<css::drawing::framework::XResourceId>& rxResourceId,
 116         css::drawing::framework::ResourceActivationMode eMode)
 117         throw (css::uno::RuntimeException);
 118
 119     virtual void SAL_CALL requestResourceDeactivation (
 120         const css::uno::Reference<css::drawing::framework::XResourceId>&
 121             rxResourceId)
 122         throw (css::uno::RuntimeException);
 123
 124     virtual css::uno::Reference<css::drawing::framework::XResource>
 125         SAL_CALL getResource (
 126             const css::uno::Reference<css::drawing::framework::XResourceId>& rxResourceId)
 127         throw (css::uno::RuntimeException);
 128
 129     virtual void SAL_CALL update (void)
 130         throw (css::uno::RuntimeException);
 131
 132     virtual  css::uno::Reference<
 133         css::drawing::framework::XConfiguration>
 134         SAL_CALL getRequestedConfiguration (void)
 135         throw (css::uno::RuntimeException);
 136
 137     virtual  css::uno::Reference<
 138         css::drawing::framework::XConfiguration>
 139         SAL_CALL getCurrentConfiguration (void)
 140         throw (css::uno::RuntimeException);
 141
 142     virtual void SAL_CALL restoreConfiguration (
 143         const css::uno::Reference<css::drawing::framework::XConfiguration>&
 144         rxConfiguration)
 145         throw (css::uno::RuntimeException);
 146
 147
 148     // XConfigurationControllerBroadcaster
 149
 150     virtual void SAL_CALL addConfigurationChangeListener (
 151         const css::uno::Reference<
 152             css::drawing::framework::XConfigurationChangeListener>& rxListener,
 153         const ::rtl::OUString& rsEventType,
 154         const css::uno::Any& rUserData)
 155         throw (css::uno::RuntimeException);
 156
 157     virtual void SAL_CALL removeConfigurationChangeListener (
 158         const css::uno::Reference<
 159             css::drawing::framework::XConfigurationChangeListener>& rxListener)
 160         throw (css::uno::RuntimeException);
 161
 162     virtual void SAL_CALL notifyEvent (
 163         const css::drawing::framework::ConfigurationChangeEvent& rEvent)
 164         throw (css::uno::RuntimeException);
 165
 166
 167     // XConfigurationRequestQueue
 168
 169     virtual sal_Bool SAL_CALL hasPendingRequests (void)
 170         throw (css::uno::RuntimeException);
 171
 172     virtual void SAL_CALL postChangeRequest (
 173         const css::uno::Reference<
 174             css::drawing::framework::XConfigurationChangeRequest>& rxRequest)
 175         throw (css::uno::RuntimeException);
 176
 177
 178     // XResourceFactoryManager
 179
 180     virtual void SAL_CALL addResourceFactory(
 181         const ::rtl::OUString& sResourceURL,
 182         const css::uno::Reference<css::drawing::framework::XResourceFactory>& rxResourceFactory)
 183         throw (css::uno::RuntimeException);
 184
 185     virtual void SAL_CALL removeResourceFactoryForURL(
 186         const ::rtl::OUString& sResourceURL)
 187         throw (css::uno::RuntimeException);
 188
 189     virtual void SAL_CALL removeResourceFactoryForReference(
 190         const css::uno::Reference<css::drawing::framework::XResourceFactory>& rxResourceFactory)
 191         throw (css::uno::RuntimeException);
 192
 193     virtual css::uno::Reference<css::drawing::framework::XResourceFactory>
 194         SAL_CALL getResourceFactory (
 195         const ::rtl::OUString& sResourceURL)
 196         throw (css::uno::RuntimeException);
 197
 198
 199     // XInitialization
 200
 201     virtual void SAL_CALL initialize(
 202         const css::uno::Sequence<css::uno::Any>& rArguments)
 203         throw (css::uno::Exception, css::uno::RuntimeException);
 204
 205
 206     /** Use this class instead of calling lock() and unlock() directly in
 207         order to be exception safe.
 208     */
 209     class Lock
 210     {
 211     public:
 212         Lock (const css::uno::Reference<
 213             css::drawing::framework::XConfigurationController>& rxController);
 214         ~Lock (void);
 215     private:
 216         css::uno::Reference<
 217             css::drawing::framework::XConfigurationController> mxController;
 218     };
 219
 220 private:
 221     class Implementation;
 222     ::boost::scoped_ptr<Implementation> mpImplementation;
 223     bool mbIsDisposed;
 224
 225     /** When the called object has already been disposed this method throws
 226         an exception and does not return.
 227     */
 228     void ThrowIfDisposed (void) const
 229         throw (css::lang::DisposedException);
 230 };
 231
 232 } } // end of namespace sd::framework
 233
 234 #endif