1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_drawing_framework_XConfigurationChangeRequest_idl__
25#define __com_sun_star_drawing_framework_XConfigurationChangeRequest_idl__
26
27#ifndef __com_sun_star_uno_XInterface_idl__
28#include <com/sun/star/uno/XInterface.idl>
29#endif
30#ifndef __com_sun_star_drawing_framework_ConfigurationChangeEvent_idl__
31#include <com/sun/star/drawing/framework/ConfigurationChangeEvent.idl>
32#endif
33
34module com { module sun { module star { module drawing { module framework {
35
36published interface XConfiguration;
37
38/** A single explicit request for a configuration change.
39
40    <p>The requested change is committed to a configuration only when the
41    <member>execute()</member> method is called.  Configuration change
42    requests are executed asynchronously.  This is done to avoid reentrance
43    problems with objects that are registered as
44    <type>XConfigurationChangeListener</type> and at the same time make
45    configuration change requests.  When the requests were executed
46    synchronously then the listeners would be notified of the changes while
47    their request call has not yet returned.</p>
48
49    <p>This interface is typically used internally by the
50    <type>XConfigurationController</type></p> @see XConfigurationController
51*/
52published interface XConfigurationChangeRequest
53{
54    /** Commit the configuration change request represented by the called
55        object to the given configuration.
56        @param xConfiguration
57            This is the configuration to commit the requested change to.
58    */
59    void execute ([in] XConfiguration xConfiguration);
60};
61
62}; }; }; }; }; // ::com::sun::star::drawing::framework
63
64#endif
65