udkapi/com/sun/star/uno/XComponentContext.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_uno_XComponentContext_idl__
  28 #define __com_sun_star_uno_XComponentContext_idl__
  29
  30 #ifndef __com_sun_star_uno_Exception_idl__
  31 #include <com/sun/star/uno/Exception.idl>
  32 #endif
  33
  34
  35 module com {  module sun {  module star {  module lang {
  36  published interface XMultiComponentFactory;
  37 }; }; }; };
  38
  39 module com {  module sun {  module star {  module uno {
  40
  41 /** Component context to be passed to a component via
  42     <type scope="com::sun::star::lang">XSingleComponentFactory</type>.
  43     Arbitrary values (e.g. deployment values) can be retrieved from the context.
  44 */
  45 published interface XComponentContext : XInterface
  46 {
  47     /** Gets a value from the context.
  48
  49         @param Name
  50                name of value
  51         @return
  52                 value
  53     */
  54     any getValueByName( [in] string Name );
  55
  56     /** Gets the service manager instance to be used from key
  57         <code>/singletons/com.sun.star.lang.theServiceManager</code> (maybe null ref).
  58         This method has been added for convenience, because the
  59         service manager is used very often.
  60
  61         @return
  62                 service manager, if any
  63     */
  64     com::sun::star::lang::XMultiComponentFactory getServiceManager();
  65 };
  66
  67 }; }; }; };
  68
  69 #endif