offapi/com/sun/star/frame/ModuleManager.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_frame_ModuleManager_idl__
  29 #define __com_sun_star_frame_ModuleManager_idl__
  30
  31 #ifndef __com_sun_star_frame_XModuleManager_idl__
  32 #include <com/sun/star/frame/XModuleManager.idl>
  33 #endif
  34
  35 #ifndef __com_sun_star_container_XNameAccess_idl__
  36 #include <com/sun/star/container/XNameAccess.idl>
  37 #endif
  38
  39 //===============================================
  40
  41 module com { module sun { module star { module frame {
  42
  43 //===============================================
  44 /** can be used to identify office modules.
  45
  46     <p>
  47     Further it provides read access to the configuration
  48     of office modules.
  49     </p>
  50
  51     @since OOo 2.0.0
  52  */
  53
  54 service ModuleManager
  55 {
  56     //-------------------------------------------
  57     /** provides functions to identify office modules.
  58      */
  59     interface XModuleManager;
  60
  61     //-------------------------------------------
  62     /** provides read access to the configuration of office modules.
  63
  64         <p>
  65         Every module is referenced by an unique service name
  66         (which is used inside configuration as set node name too)
  67         and is further represented by a sequence of elements of type
  68         <type scope="com::sun::star::beans">PropertyValue</type>.
  69         A list of properties can be getted from the configuration template
  70         org.openoffice.Setup/Factory.
  71         </p>
  72      */
  73     interface ::com::sun::star::container::XNameAccess;
  74 };
  75
  76 }; }; }; };
  77
  78 #endif