sd/source/ui/framework/configuration/ConfigurationControllerResourceManager.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: ConfigurationControllerResourceManager.hxx,v $
  10  *
  11  * $Revision: 1.3 $
  12  *
  13  * This file is part of OpenOffice.org.
  14  *
  15  * OpenOffice.org is free software: you can redistribute it and/or modify
  16  * it under the terms of the GNU Lesser General Public License version 3
  17  * only, as published by the Free Software Foundation.
  18  *
  19  * OpenOffice.org is distributed in the hope that it will be useful,
  20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22  * GNU Lesser General Public License version 3 for more details
  23  * (a copy is included in the LICENSE file that accompanied this code).
  24  *
  25  * You should have received a copy of the GNU Lesser General Public License
  26  * version 3 along with OpenOffice.org.  If not, see
  27  * <http://www.openoffice.org/license.html>
  28  * for a copy of the LGPLv3 License.
  29  *
  30  ************************************************************************/
  31
  32 #ifndef SD_FRAMEWORK_RESOURCE_MANAGER_HXX
  33 #define SD_FRAMEWORK_RESOURCE_MANAGER_HXX
  34
  35 #include <com/sun/star/drawing/framework/XConfiguration.hpp>
  36 #include <com/sun/star/drawing/framework/XResource.hpp>
  37 #include <com/sun/star/drawing/framework/XResourceFactory.hpp>
  38 #include <boost/noncopyable.hpp>
  39 #include <boost/shared_ptr.hpp>
  40 #include <map>
  41 #include <vector>
  42
  43 namespace css = ::com::sun::star;
  44
  45 namespace sd { namespace framework {
  46
  47 class ConfigurationControllerBroadcaster;
  48 class ResourceFactoryManager;
  49
  50 /** Manage the set of active resources.  Activate and deactivate resources.
  51 */
  52 class ConfigurationControllerResourceManager
  53     : ::boost::noncopyable
  54 {
  55 public:
  56     /** For every active resource both the resource itself as well as its
  57         creating factory are remembered, so that on deactivation, the
  58         resource can be deactivated by this factory.
  59     */
  60     class ResourceDescriptor
  61     {
  62     public:
  63         css::uno::Reference<css::drawing::framework::XResource> mxResource;
  64         css::uno::Reference<css::drawing::framework::XResourceFactory> mxResourceFactory;
  65     };
  66
  67     /** A new ResourceManager object is created with the resource factory
  68         container for creating resources and the event broadcaster for
  69         notifying ConfigurationChangeListeners of activated or deactivated
  70         resources.
  71     */
  72     ConfigurationControllerResourceManager (
  73         const ::boost::shared_ptr<ResourceFactoryManager>& rpResourceFactoryContainer,
  74         const ::boost::shared_ptr<ConfigurationControllerBroadcaster>& rpBroadcaster);
  75
  76     ~ConfigurationControllerResourceManager (void);
  77
  78     /** Activate all the resources that are specified by resource ids in
  79         rResources.  The resource ids of activated resources are added to
  80         the given configuration.  Activated resources are notified to all
  81         interested ConfigurationChangeListeners.
  82     */
  83     void ActivateResources (
  84         const ::std::vector<
  85             css::uno::Reference<css::drawing::framework::XResourceId> >& rResources,
  86         const css::uno::Reference<css::drawing::framework::XConfiguration>& rxConfiguration);
  87
  88     /** Deactivate all the resources that are specified by resource ids in
  89         rResources.  The resource ids of deactivated resources are removed
  90         from the given configuration.  Activated resources are notified to all
  91         interested ConfigurationChangeListeners.
  92     */
  93     void DeactivateResources (
  94         const ::std::vector<
  95             css::uno::Reference<css::drawing::framework::XResourceId> >& rResources,
  96         const css::uno::Reference<css::drawing::framework::XConfiguration>& rxConfiguration);
  97
  98     /** Return the descriptor for the specified resource.
  99         @return
 100             When there is no active resource for the given resource id then
 101             an empty descriptor is returned.
 102     */
 103     ResourceDescriptor GetResource (
 104         const css::uno::Reference<css::drawing::framework::XResourceId>& rxResourceId);
 105
 106 private:
 107     osl::Mutex maMutex;
 108
 109     class ResourceComparator
 110     {
 111     public:
 112         bool operator() (
 113             const css::uno::Reference<css::drawing::framework::XResourceId>& rxId1,
 114             const css::uno::Reference<css::drawing::framework::XResourceId>& rxId2) const;
 115     };
 116
 117     typedef ::std::map<
 118         css::uno::Reference<css::drawing::framework::XResourceId>,
 119         ResourceDescriptor,
 120         ResourceComparator> ResourceMap;
 121     ResourceMap maResourceMap;
 122
 123     ::boost::shared_ptr<ResourceFactoryManager> mpResourceFactoryContainer;
 124
 125     /** This broadcaster is used to notify the activation and deactivation
 126         of resources.
 127     */
 128     ::boost::shared_ptr<ConfigurationControllerBroadcaster> mpBroadcaster;
 129
 130     void ActivateResource (
 131         const css::uno::Reference<css::drawing::framework::XResourceId>& rxResourceId,
 132         const css::uno::Reference<css::drawing::framework::XConfiguration>& rxConfiguration);
 133
 134     void DeactivateResource (
 135         const css::uno::Reference<css::drawing::framework::XResourceId>& rxResourceId,
 136         const css::uno::Reference<css::drawing::framework::XConfiguration>& rxConfiguration);
 137
 138     void AddResource (
 139         const css::uno::Reference<css::drawing::framework::XResource>& rxResource,
 140         const css::uno::Reference<css::drawing::framework::XResourceFactory>& rxFactory);
 141
 142     ResourceDescriptor RemoveResource (
 143         const css::uno::Reference<css::drawing::framework::XResourceId>& rxResourceId);
 144 };
 145
 146
 147 } } // end of namespace sd::framework
 148
 149 #endif