xref: /aoo4110/main/offapi/com/sun/star/ui/UIConfigurationManager.idl (revision b1cdbd2c)

/**************************************************************
 *
 * 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
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the 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 OpenOffice 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