sd/source/ui/framework/configuration/GenericConfigurationChangeRequest.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: GenericConfigurationChangeRequest.hxx,v $
  10  * $Revision: 1.4 $
  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_GENERIC_CONFIGURATTION_CHANGE_REQUEST_HXX
  32 #define SD_FRAMEWORK_GENERIC_CONFIGURATTION_CHANGE_REQUEST_HXX
  33
  34 #include "MutexOwner.hxx"
  35 #include <com/sun/star/drawing/framework/XConfigurationChangeRequest.hpp>
  36 #include <com/sun/star/container/XNamed.hpp>
  37 #include <com/sun/star/drawing/framework/XConfiguration.hpp>
  38 #include <com/sun/star/drawing/framework/XResourceId.hpp>
  39 #include <com/sun/star/lang/IllegalArgumentException.hpp>
  40 #include <com/sun/star/beans/PropertyValues.hpp>
  41 #include <cppuhelper/compbase2.hxx>
  42
  43 namespace css = ::com::sun::star;
  44
  45 namespace {
  46
  47 typedef ::cppu::WeakComponentImplHelper2 <
  48       ::com::sun::star::drawing::framework::XConfigurationChangeRequest,
  49       ::com::sun::star::container::XNamed
  50     > GenericConfigurationChangeRequestInterfaceBase;
  51
  52 } // end of anonymous namespace.
  53
  54
  55 namespace sd { namespace framework {
  56
  57 /** This implementation of the XConfigurationChangeRequest interface
  58     represents a single explicit request for a configuration change.  On its
  59     execution it may result in other, implicit, configuration changes.  For
  60     example this is the case when the deactivation of a unique resource is
  61     requested: the resources linked to it have to be deactivated as well.
  62 */
  63 class GenericConfigurationChangeRequest
  64     : private MutexOwner,
  65       public GenericConfigurationChangeRequestInterfaceBase
  66 {
  67 public:
  68     /** This enum specified whether the activation or deactivation of a
  69         resource is requested.
  70     */
  71     enum Mode { Activation, Deactivation };
  72
  73     /** Create a new object that represents the request for activation or
  74         deactivation of the specified resource.
  75         @param rxsResourceId
  76             Id of the resource that is to be activated or deactivated.
  77         @param eMode
  78             The mode specifies whether to activate or to deactivate the
  79             resource.
  80     */
  81     GenericConfigurationChangeRequest (
  82         const ::com::sun::star::uno::Reference<com::sun::star::drawing::framework::XResourceId>&
  83             rxResourceId,
  84         const Mode eMode)
  85         throw (::com::sun::star::lang::IllegalArgumentException);
  86
  87     virtual ~GenericConfigurationChangeRequest (void) throw();
  88
  89
  90     // XConfigurationChangeOperation
  91
  92     /** The requested configuration change is executed on the given
  93         configuration.  Additionally to the explicitly requested change
  94         other changes have to be made as well.  See class description for an
  95         example.
  96         @param rxConfiguration
  97             The configuration to which the requested change is made.
  98     */
  99     virtual void SAL_CALL execute (
 100         const ::com::sun::star::uno::Reference<
 101             com::sun::star::drawing::framework::XConfiguration>& rxConfiguration)
 102         throw (::com::sun::star::uno::RuntimeException);
 103
 104
 105     // XNamed
 106
 107     /** Return a human readable string representation.  This is used for
 108         debugging purposes.
 109     */
 110     virtual ::rtl::OUString SAL_CALL getName (void)
 111         throw (::com::sun::star::uno::RuntimeException);
 112
 113     /** This call is ignored because the XNamed interface is (mis)used to
 114         give access to a human readable name for debugging purposes.
 115     */
 116     virtual void SAL_CALL setName (const ::rtl::OUString& rName)
 117         throw (::com::sun::star::uno::RuntimeException);
 118
 119 private:
 120     const css::uno::Reference<css::drawing::framework::XResourceId> mxResourceId;
 121     const Mode meMode;
 122 };
 123
 124 } } // end of namespace sd::framework
 125
 126 #endif