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

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