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