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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 module com { module sun { module star { module ui {
  21
  22 /** specifies a user interface configuration manager which gives access to user interface
  23     configuration data of a module.
  24
  25     <p>
  26     A module user interface configuration manager supports two layers of configuration settings
  27     data:<br>
  28     1. Layer: A module default user interface configuration which describe all user interface
  29     elements settings that are used by OpenOffice. It is not possible to insert, remove or change
  30     elements settings in this layer through the interfaces.<br>
  31     2. Layer: A module user interface configuration which only contains customized user interface
  32     elements and user-defined ones. All changes on user interface element settings are done on
  33     this layer.
  34     </p>
  35
  36     @since OOo 2.0
  37 */
  38
  39 service ModuleUIConfigurationManager : XModuleUIConfigurationManager2
  40 {
  41     /** provides a function to initialize a module user interface configuration manager instance.
  42
  43         <p>
  44         A module user interface configuration manager instance needs the following arguments as
  45         com::sun::star::beans::PropertyValue to be in a working state:
  46         <ul>
  47             <li><b>DefaultConfigStorage</b>a reference to a com::sun::star::embed::Storage that
  48             contains the default module user interface configuration settings.</li>
  49             <li><b>UserConfigStorage</b>a reference to a com::sun::star::embed::Storage that
  50             contains the user-defined module user interface configuration settings.</li>
  51             <li><b>ModuleIdentifier</b>string that provides the module identifier.</li>
  52             <li><b>UserRootCommit</b>a reference to a com::sun::star::embed::XTransactedObject which
  53             represents the customizable root storage. Every implementation must use this reference to commit its
  54             changes also at the root storage.</li>
  55         </ul>
  56         A non-initialized module user interface configuration manager cannot be used, it is treated
  57         as a read-only container.
  58         </p>
  59     */
  60     createDefault([in] string ModuleShortName, [in] string ModuleIdentifier)
  61         raises ( com::sun::star::configuration::CorruptedUIConfigurationException,
  62                com::sun::star::beans::UnknownPropertyException,
  63                com::sun::star::lang::WrappedTargetException );
  64
  65
  66 };
  67
  68
  69 }; }; }; };
  70
  71 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */