offapi/com/sun/star/configuration/bootstrap/BootstrapContext.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: BootstrapContext.idl,v $
  10  * $Revision: 1.6 $
  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 #ifndef __com_sun_star_configuration_bootstrap_BootstrapContext_idl__
  31 #define __com_sun_star_configuration_bootstrap_BootstrapContext_idl__
  32
  33 #ifndef __com_sun_star_uno_XComponentContext_idl__
  34 #include <com/sun/star/uno/XComponentContext.idl>
  35 #endif
  36
  37 //=============================================================================
  38
  39 module com { module sun { module star { module configuration { module bootstrap {
  40
  41 //=============================================================================
  42
  43 /**
  44     provides access to a component context that is enhanced with
  45     bootstrap parameters for configuration services from the
  46     associated metaconfiguration mechanism.
  47
  48     <p> The contained settings are used to initialize the
  49         <type scope="com::sun::star::configuration">DefaultProvider</type> and
  50         <type scope="com::sun::star::configuration::backend">DefaultBackend</type> of the
  51         component context.
  52     </p>
  53     <p> The implementation is usally available as singleton in the context
  54         that it wraps..
  55     </p>
  56
  57     @since OOo 1.1.2
  58 */
  59 published service BootstrapContext
  60 {
  61     //-------------------------------------------------------------------------
  62
  63     /**
  64       provides access to metaconfiguration data.
  65
  66       <p>Some values are retrieved from external metaconfiguration,
  67         if they are not overridden in the wrapped context.
  68       </p>
  69       */
  70     interface com::sun::star::uno::XComponentContext ;
  71
  72     //-------------------------------------------------------------------------
  73 } ;
  74
  75 //=============================================================================
  76
  77 } ; } ; } ; } ; } ;
  78
  79 #endif