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_ConfigurationChangeEvent_idl__
25#define __com_sun_star_drawing_framework_ConfigurationChangeEvent_idl__
26
27#ifndef __com_sun_star_lang_EventObject_idl__
28#include <com/sun/star/lang/EventObject.idl>
29#endif
30
31module com { module sun { module star { module uno { interface XInterface; }; }; }; };
32
33module com { module sun { module star { module drawing { module framework {
34
35published interface XConfiguration;
36published interface XResourceId;
37
38/** Objects of this class are used for notifying changes of the
39    configuration.
40
41    <p>They are broadcasted by the configuration controller
42    which maintains the configuration.  The set of types of configuration
43    changes is not fixed and is not maintained or documented in one
44    place.</p>
45
46    <p>The set of used members and the exact meaning of their values is not the
47    same for all types.  Therefore, the descriptions of the members are just
48    general guidelines.   See <type>XConfigurationController</type> for a
49    list of event types used by the basic drawing framework.</p>
50*/
51published struct ConfigurationChangeEvent
52     : ::com::sun::star::lang::EventObject
53{
54    /** The type of configuration change is a free-form string.  This is the
55        only member that is always set.  The values of the other members
56        depend on the configuration change type and may or may not be set.
57    */
58    string Type;
59
60    /** The current configuration, depending on the event type, either
61        before or after the change.  May be an empty reference.
62    */
63    XConfiguration Configuration;
64
65    /** The resource id that is part of the configuration change.
66    */
67    XResourceId ResourceId;
68
69    /** The resource object that corresponds to the ResourceId.  May
70        be an empty reference.
71    */
72    com::sun::star::uno::XInterface ResourceObject;
73
74    /** Each listener is called with exactly the <member>UserData</member>
75        that was given when the listener was registered.
76    */
77    any UserData;
78};
79
80}; }; }; }; }; // ::com::sun::star::drawing::framework
81
82#endif
83