office-gobmx/offapi/com/sun/star/ui/ModuleUIConfigurationManager.idl
Michael Meeks c73745117d re-base on ALv2 code. Includes:
linecap: Reintegrating finished LineCap feature
    Work contributed by Regina Henschel
    http://svn.apache.org/viewvc?view=revision&revision=1232507

    i118815 - Deprecate service due to removed implementation
    Patch contributed by Ariel Constenla-Haile
    http://svn.apache.org/viewvc?view=revision&revision=1233320

    i118814 - Allow set timeout in Mail API
    Patch contributed by Ariel Constenla-Haile
    http://svn.apache.org/viewvc?view=revision&revision=1235679

    included in the Apache baseline:
    dr80: #i117511# remove some assertions in xlsx/xlsb import filters
    Patch contributed by Daniel Rentz
2012-09-27 11:35:06 +01:00

96 lines
4.2 KiB
Text

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef __com_sun_star_ui_ModuleUIConfigurationManager_idl__
#define __com_sun_star_ui_ModuleUIConfigurationManager_idl__
#include <com/sun/star/lang/XInitialization.idl>
#include <com/sun/star/ui/XUIConfigurationManager.idl>
#include <com/sun/star/ui/XUIConfigurationPersistence.idl>
#include <com/sun/star/ui/XModuleUIConfigurationManager.idl>
#include <com/sun/star/ui/XUIConfiguration.idl>
module com { module sun { module star { module ui {
/** specifies a user interface configuration manager which gives access to user interface
configuration data of a module.
<p>
A module user interface configuration manager supports two layers of configuration settings
data:<br/>
1. Layer: A module default user interface configuration which describe all user interface
elements settings that are used by OpenOffice. It is not possible to insert, remove or change
elements settings in this layer through the interfaces.</br>
2. Layer: A module user interface configuration which only contains customized user interface
elements and user-defined ones. All changes on user interface element settings are done on
this layer.</br>
</p>
@since OOo 2.0
*/
service ModuleUIConfigurationManager
{
/** provides a function to initialize a module user interface configuration manager instance.
<p>
A module user interface configuration manager instance needs the following arguments as
<type scope="com::sun::star::beans">PropertyValue</type> to be in a working state:
<ul>
<li><b>DefaultConfigStorage</b>a reference to a <type scope="com::sun::star::embed">Storage</type> that
contains the default module user interface configuration settings.</li>
<li><b>UserConfigStorage</b>a reference to a <type scope="com::sun::star::embed">Storage</type> that
contains the user-defined module user interface configuration settings.</li>
<li><b>ModuleIdentifier</b>string that provides the module identifier.</li>
<li><b>UserRootCommit</b>a reference to a <type scope="com::sun::star::embed">XTransactedObject</type> which
represents the customizable root storage. Every implementation must use this reference to commit its
changes also at the root storage.</li>
</ul>
A non-initialized module user interface configuration manager cannot be used, it is treated
as a read-only container.
</p>
*/
interface com::sun::star::lang::XInitialization;
/** provides access to persistence functions to load/store user interface element
settings from/to a module storage.
*/
interface com::sun::star::ui::XUIConfigurationPersistence;
/** provides functions to change, insert and remove user interface element settings
from a module user interface configuration manager.
*/
interface com::sun::star::ui::XUIConfigurationManager;
/** provides access to the default layer of a module based ui configuration
manager.
*/
interface com::sun::star::ui::XModuleUIConfigurationManager;
/** provides functions to add and remove listeners for changes within a module user
interface configuration manager.
*/
interface com::sun::star::ui::XUIConfiguration;
};
}; }; }; };
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */