office-gobmx/sd/source/ui/framework/configuration/GenericConfigurationChangeRequest.hxx

123 lines
4.5 KiB
C++

/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef SD_FRAMEWORK_GENERIC_CONFIGURATTION_CHANGE_REQUEST_HXX
#define SD_FRAMEWORK_GENERIC_CONFIGURATTION_CHANGE_REQUEST_HXX
#include "MutexOwner.hxx"
#include <com/sun/star/drawing/framework/XConfigurationChangeRequest.hpp>
#include <com/sun/star/container/XNamed.hpp>
#include <com/sun/star/drawing/framework/XConfiguration.hpp>
#include <com/sun/star/drawing/framework/XResourceId.hpp>
#include <com/sun/star/lang/IllegalArgumentException.hpp>
#include <com/sun/star/beans/PropertyValues.hpp>
#include <cppuhelper/compbase2.hxx>
namespace css = ::com::sun::star;
namespace {
typedef ::cppu::WeakComponentImplHelper2 <
::com::sun::star::drawing::framework::XConfigurationChangeRequest,
::com::sun::star::container::XNamed
> GenericConfigurationChangeRequestInterfaceBase;
} // end of anonymous namespace.
namespace sd { namespace framework {
/** This implementation of the XConfigurationChangeRequest interface
represents a single explicit request for a configuration change. On its
execution it may result in other, implicit, configuration changes. For
example this is the case when the deactivation of a unique resource is
requested: the resources linked to it have to be deactivated as well.
*/
class GenericConfigurationChangeRequest
: private MutexOwner,
public GenericConfigurationChangeRequestInterfaceBase
{
public:
/** This enum specified whether the activation or deactivation of a
resource is requested.
*/
enum Mode { Activation, Deactivation };
/** Create a new object that represents the request for activation or
deactivation of the specified resource.
@param rxsResourceId
Id of the resource that is to be activated or deactivated.
@param eMode
The mode specifies whether to activate or to deactivate the
resource.
*/
GenericConfigurationChangeRequest (
const ::com::sun::star::uno::Reference<com::sun::star::drawing::framework::XResourceId>&
rxResourceId,
const Mode eMode)
throw (::com::sun::star::lang::IllegalArgumentException);
virtual ~GenericConfigurationChangeRequest (void) throw();
// XConfigurationChangeOperation
/** The requested configuration change is executed on the given
configuration. Additionally to the explicitly requested change
other changes have to be made as well. See class description for an
example.
@param rxConfiguration
The configuration to which the requested change is made.
*/
virtual void SAL_CALL execute (
const ::com::sun::star::uno::Reference<
com::sun::star::drawing::framework::XConfiguration>& rxConfiguration)
throw (::com::sun::star::uno::RuntimeException);
// XNamed
/** Return a human readable string representation. This is used for
debugging purposes.
*/
virtual ::rtl::OUString SAL_CALL getName (void)
throw (::com::sun::star::uno::RuntimeException);
/** This call is ignored because the XNamed interface is (mis)used to
give access to a human readable name for debugging purposes.
*/
virtual void SAL_CALL setName (const ::rtl::OUString& rName)
throw (::com::sun::star::uno::RuntimeException);
private:
const css::uno::Reference<css::drawing::framework::XResourceId> mxResourceId;
const Mode meMode;
};
} } // end of namespace sd::framework
#endif