xref: /AOO41X/main/offapi/com/sun/star/ui/UIConfigurationManager.idl (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_ui_UIConfigurationManager_idl__
#define __com_sun_star_ui_UIConfigurationManager_idl__

#ifndef __com_sun_star_lang_XComponent_idl__
#include <com/sun/star/lang/XComponent.idl>
#endif

#ifndef __com_sun_star_ui_XUIConfiguration_idl__
#include <com/sun/star/ui/XUIConfiguration.idl>
#endif

#ifndef __com_sun_star_ui_XUIConfigurationManager_idl__
#include <com/sun/star/ui/XUIConfigurationManager.idl>
#endif

#ifndef __com_sun_star_ui_XUIConfigurationPersistence_idl__
#include <com/sun/star/ui/XUIConfigurationPersistence.idl>
#endif

#ifndef __com_sun_star_ui_XUIConfigurationStorage_idl__
#include <com/sun/star/ui/XUIConfigurationStorage.idl>
#endif

module com { module sun { module star { module ui {

/** specifies a user interface configuration manager which controls
    all customizeable user interface elements of an object.

    @since OOo 2.0
*/

service UIConfigurationManager
{
    /** provides access to set a storage and to check if a storage has been
        associated to the user interface configuration manager.
    */
    interface com::sun::star::ui::XUIConfigurationStorage;

    /** provides access to persistence functions to load/store user interface configuration
        data from a storage.
    */
    interface com::sun::star::ui::XUIConfigurationPersistence;

    /** provides functions to change, insert and remove user interface elements
        from a user interface configuration manager.
    */
    interface com::sun::star::ui::XUIConfigurationManager;

    /** provides functions to add and remove listeners for changes within a user
        interface configuration manager.
    */
    interface com::sun::star::ui::XUIConfiguration;

    /** allows controlling or observing the lifetime of a user interface configuration manager
        instance.

    <p>The owner of the object may dispose of this object using
    <member scope="com::sun::star::lang">XComponent::dispose()</member>.
    </p>
    */
    interface ::com::sun::star::lang::XComponent;
};

//=============================================================================

}; }; }; };

#endif