1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27
28#ifndef __com_sun_star_drawing_framework_XConfigurationChangeRequest_idl__
29#define __com_sun_star_drawing_framework_XConfigurationChangeRequest_idl__
30
31#ifndef __com_sun_star_uno_XInterface_idl__
32#include <com/sun/star/uno/XInterface.idl>
33#endif
34#ifndef __com_sun_star_drawing_framework_ConfigurationChangeEvent_idl__
35#include <com/sun/star/drawing/framework/ConfigurationChangeEvent.idl>
36#endif
37
38module com { module sun { module star { module drawing { module framework {
39
40published interface XConfiguration;
41
42/** A single explicit request for a configuration change.
43
44    <p>The requested change is committed to a configuration only when the
45    <member>execute()</member> method is called.  Configuration change
46    requests are executed asynchronously.  This is done to avoid reentrance
47    problems with objects that are registered as
48    <type>XConfigurationChangeListener</type> and at the same time make
49    configuration change requests.  When the requests were executed
50    synchronously then the listeners would be notified of the changes while
51    their request call has not yet returned.</p>
52
53    <p>This interface is typically used internally by the
54    <type>XConfigurationController</type></p> @see XConfigurationController
55*/
56published interface XConfigurationChangeRequest
57{
58    /** Commit the configuration change request represented by the called
59        object to the given configuration.
60        @param xConfiguration
61            This is the configuration to commit the requested change to.
62    */
63    void execute ([in] XConfiguration xConfiguration);
64};
65
66}; }; }; }; }; // ::com::sun::star::drawing::framework
67
68#endif
69