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#ifndef __com_sun_star_ui_ModuleUIConfigurationManager_idl__
28#define __com_sun_star_ui_ModuleUIConfigurationManager_idl__
29
30#ifndef __com_sun_star_lang_XInitialization_idl__
31#include <com/sun/star/lang/XInitialization.idl>
32#endif
33
34#ifndef __com_sun_star_ui_XUIConfigurationManager_idl__
35#include <com/sun/star/ui/XUIConfigurationManager.idl>
36#endif
37
38#ifndef __com_sun_star_ui_XUIConfigurationPersistence_idl__
39#include <com/sun/star/ui/XUIConfigurationPersistence.idl>
40#endif
41
42#ifndef __com_sun_star_ui_XModuleUIConfigurationManager_idl__
43#include <com/sun/star/ui/XModuleUIConfigurationManager.idl>
44#endif
45
46#ifndef __com_sun_star_ui_XUIConfiguration_idl__
47#include <com/sun/star/ui/XUIConfiguration.idl>
48#endif
49
50module com { module sun { module star { module ui {
51
52/** specifies a user interface configuration manager which gives access to user interface
53    configuration data of a module.
54
55    <p>
56    A module user interface configuratio manager supports two layers of configuration settings
57    data:<br/>
58    1. Layer: A module default user interface configuration which describe all user interface
59    elements settings that are used by OpenOffice. It is not possible to insert, remove or change
60    elements settings in this layer through the interfaces.</br>
61    2. Layer: A module user interface configuration which only contains customized user interface
62    elements and user-defined ones. All changes on user interface element settings are done on
63    this layer.</br>
64    </p>
65
66    @since OOo 2.0
67*/
68
69service ModuleUIConfigurationManager
70{
71    /** provides a function to initialize a module user interface configuration manager instance.
72
73        <p>
74        A module user interface configuration manager instance needs the following arguments as
75        <type scope="com::sun::star::beans">PropertyValue</type> to be in a working state:
76        <ul>
77            <li><b>DefaultConfigStorage</b>a reference to a <type scope="com::sun::star::embed">Storage</type> that
78            contains the default module user interface configuration settings.</li>
79            <li><b>UserConfigStorage</b>a reference to a <type scope="com::sun::star::embed">Storage</type> that
80            contains the user-defined module user interface configuration settings.</li>
81            <li><b>ModuleIdentifier</b>string that provides the module identifier.</li>
82            <li><b>UserRootCommit</b>a reference to a <type scope="com::sun::star::embed">XTransactedObject</type> which
83            represents the customizable root storage. Every implementation must use this reference to commit its
84            changes also at the root storage.</li>
85        </ul>
86        A non-initialized module user interface configuration manager cannot be used, it is treated
87        as a read-only container.
88        </p>
89    */
90    interface com::sun::star::lang::XInitialization;
91
92    /** provides access to persistence functions to load/store user interface element
93        settings from/to a module storage.
94    */
95    interface com::sun::star::ui::XUIConfigurationPersistence;
96
97    /** provides functions to change, insert and remove user interface element settings
98        from a module user interface configuration manager.
99    */
100    interface com::sun::star::ui::XUIConfigurationManager;
101
102    /** provides access to the default layer of a module based ui configuration
103        manager.
104    */
105    interface com::sun::star::ui::XModuleUIConfigurationManager;
106
107    /** provides functions to add and remove listeners for changes within a module user
108        interface configuration manager.
109    */
110    interface com::sun::star::ui::XUIConfiguration;
111};
112
113//=============================================================================
114
115}; }; }; };
116
117#endif
118