xref: /aoo41x/main/offapi/com/sun/star/ui/XModuleUIConfigurationManagerSupplier.idl (revision cdf0e10c)

/*************************************************************************
 *
 * 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_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 OOo 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