offapi/com/sun/star/ui/ModuleUIConfigurationManager.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: ModuleUIConfigurationManager.idl,v $
  10  * $Revision: 1.5 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_ui_ModuleUIConfigurationManager_idl__
  31 #define __com_sun_star_ui_ModuleUIConfigurationManager_idl__
  32
  33 #ifndef __com_sun_star_lang_XInitialization_idl__
  34 #include <com/sun/star/lang/XInitialization.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_ui_XUIConfigurationManager_idl__
  38 #include <com/sun/star/ui/XUIConfigurationManager.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_ui_XUIConfigurationPersistence_idl__
  42 #include <com/sun/star/ui/XUIConfigurationPersistence.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_ui_XModuleUIConfigurationManager_idl__
  46 #include <com/sun/star/ui/XModuleUIConfigurationManager.idl>
  47 #endif
  48
  49 #ifndef __com_sun_star_ui_XUIConfiguration_idl__
  50 #include <com/sun/star/ui/XUIConfiguration.idl>
  51 #endif
  52
  53 module com { module sun { module star { module ui {
  54
  55 /** specifies a user interface configuration manager which gives access to user interface
  56     configuration data of a module.
  57
  58     <p>
  59     A module user interface configuratio manager supports two layers of configuration settings
  60     data:<br/>
  61     1. Layer: A module default user interface configuration which describe all user interface
  62     elements settings that are used by OpenOffice. It is not possible to insert, remove or change
  63     elements settings in this layer through the interfaces.</br>
  64     2. Layer: A module user interface configuration which only contains customized user interface
  65     elements and user-defined ones. All changes on user interface element settings are done on
  66     this layer.</br>
  67     </p>
  68
  69     @since OOo 2.0.0
  70 */
  71
  72 service ModuleUIConfigurationManager
  73 {
  74     /** provides a function to initialize a module user interface configuration manager instance.
  75
  76         <p>
  77         A module user interface configuration manager instance needs the following arguments as
  78         <type scope="com::sun::star::beans">PropertyValue</type> to be in a working state:
  79         <ul>
  80             <li><b>DefaultConfigStorage</b>a reference to a <type scope="com::sun::star::embed">Storage</type> that
  81             contains the default module user interface configuration settings.</li>
  82             <li><b>UserConfigStorage</b>a reference to a <type scope="com::sun::star::embed">Storage</type> that
  83             contains the user-defined module user interface configuration settings.</li>
  84             <li><b>ModuleIdentifier</b>string that provides the module identifier.</li>
  85             <li><b>UserRootCommit</b>a reference to a <type scope="com::sun::star::embed">XTransactedObject</type> which
  86             represents the customizable root storage. Every implementation must use this reference to commit its
  87             changes also at the root storage.</li>
  88         </ul>
  89         A non-initialized module user interface configuration manager cannot be used, it is treated
  90         as a read-only container.
  91         </p>
  92     */
  93     interface com::sun::star::lang::XInitialization;
  94
  95     /** provides access to persistence functions to load/store user interface element
  96         settings from/to a module storage.
  97     */
  98     interface com::sun::star::ui::XUIConfigurationPersistence;
  99
 100     /** provides functions to change, insert and remove user interface element settings
 101         from a module user interface configuration manager.
 102     */
 103     interface com::sun::star::ui::XUIConfigurationManager;
 104
 105     /** provides access to the default layer of a module based ui configuration
 106         manager.
 107     */
 108     interface com::sun::star::ui::XModuleUIConfigurationManager;
 109
 110     /** provides functions to add and remove listeners for changes within a module user
 111         interface configuration manager.
 112     */
 113     interface com::sun::star::ui::XUIConfiguration;
 114 };
 115
 116 //=============================================================================
 117
 118 }; }; }; };
 119
 120 #endif