xref: /aoo4110/main/offapi/com/sun/star/ui/XModuleUIConfigurationManagerSupplier.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_XModuleUIConfigurationManagerSupplier_idl__
#define __com_sun_star_ui_XModuleUIConfigurationManagerSupplier_idl__

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

#ifndef __com_sun_star_container_NoSuchElementException_idl__
#include <com/sun/star/container/NoSuchElementExceptio.idl>
#endif

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

/** allows to retrieve user interface configuration managers related to
    OpenOffice.org modules.

    @since OpenOffice 2.0
*/

published interface XModuleUIConfigurationManagerSupplier : ::com::sun::star::uno::XInterface
{
    //----------------------------------------------------------------------
    /** returns the requested module based user interface configuration manager.

        @param ModuleIdentifier
            a module identifier which identifies an OpenOffice.org module. The
            module identifier can be retrieved from the
            <type scope=com::sun::star::frame>ModuleManager</type> service.

        @returns
            an object implementing
            <type scope="::com::sun::star::ui">ModuleUIConfigurationManager</type>
            service. If the provided module identifier is unknown a
            <type scope="com::sun::star::container">NoSuchElementException</type>
            is thrown.
    */
    XUIConfigurationManager getUIConfigurationManager( [in] string ModuleIdentifier ) raises ( com::sun::star::container::NoSuchElementException );
};

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

}; }; }; };

#endif