offapi/com/sun/star/ui/XModuleUIConfigurationManagerSupplier.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27
  28 #ifndef __com_sun_star_ui_XModuleUIConfigurationManagerSupplier_idl__
  29 #define __com_sun_star_ui_XModuleUIConfigurationManagerSupplier_idl__
  30
  31 #ifndef __com_sun_star_ui_XUIConfigurationManager_idl__
  32 #include <com/sun/star/ui/XUIConfigurationManager.idl>
  33 #endif
  34
  35 #ifndef __com_sun_star_container_NoSuchElementException_idl__
  36 #include <com/sun/star/container/NoSuchElementExceptio.idl>
  37 #endif
  38
  39 module com { module sun { module star { module ui {
  40
  41 /** allows to retrieve user interface configuration managers related to
  42     OpenOffice.org modules.
  43
  44     @since OOo 2.0.0
  45 */
  46
  47 interface XModuleUIConfigurationManagerSupplier : ::com::sun::star::uno::XInterface
  48 {
  49     //----------------------------------------------------------------------
  50     /** returns the requested module based user interface configuration manager.
  51
  52         @param ModuleIdentifier
  53             a module identifier which identifies an OpenOffice.org module. The
  54             module identifier can be retrieved from the
  55             <type scope=com::sun::star::frame>ModuleManager</type> service.
  56
  57         @returns
  58             an object implementing
  59             <type scope="::com::sun::star::ui">ModuleUIConfigurationManager</type>
  60             service. If the provided module identifier is unknown a
  61             <type scope="com::sun::star::container">NoSuchElementException</type>
  62             is thrown.
  63     */
  64     XUIConfigurationManager getUIConfigurationManager( [in] string ModuleIdentifier ) raises ( com::sun::star::container::NoSuchElementException );
  65 };
  66
  67 //=============================================================================
  68
  69 }; }; }; };
  70
  71 #endif