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_ui_XUIConfigurationStorage_idl__
25#define __com_sun_star_ui_XUIConfigurationStorage_idl__
26
27#ifndef __com_sun_star_embed_XStorage_idl__
28#include <com/sun/star/embed/XStorage.idl>
29#endif
30
31//=============================================================================
32
33module com { module sun { module star { module ui {
34
35//=============================================================================
36
37/** supplies functions to change or get information about the storage
38    of a user interface configuration manager.
39
40    @since OpenOffice 2.0
41*/
42
43interface XUIConfigurationStorage : ::com::sun::star::uno::XInterface
44{
45    /** connects a storage to the user interface configuration manager
46        which is used on subsequent calls of <member>load</member> and
47        <member>store</member>.
48
49        @param Storage
50            all configuration data is loaded/stored from/into this storage.
51            If the storage is in read/write mode <member>load</member>
52            and <member>store</member> can be used otherwise only
53            <member>load</member> is possible.
54
55        <p>
56        This call needs careful usage as data loss can occur. If the
57        implementation has modified data and a new storage is set the
58        implementation is not allowed to write back the data to the old
59        storage. This must be done explicitly with <member>store</member>.
60        In general a user interface configuration manager instance is
61        created and initialize by the document model or the module user
62        interface configuration supplier. Normally there is no need to
63        set a storage for a user interface configuration manager. If a
64        copy of the configuration data to another storage should be made,
65        use <member>storeToStorage</member>.
66        </p>
67    */
68    void setStorage( [in] ::com::sun::star::embed::XStorage Storage );
69
70    /** checks if an instance has already a storage to load/store its data.
71
72        @return
73            <TRUE/> if the instance has a storage otherwise <FALSE/>.
74    */
75    boolean hasStorage();
76};
77
78//=============================================================================
79
80}; }; }; };
81
82#endif
83