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