udkapi/com/sun/star/uno/XComponentContext.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_uno_XComponentContext_idl__
  20 #define __com_sun_star_uno_XComponentContext_idl__
  21
  22 #include <com/sun/star/uno/Exception.idl>
  23
  24
  25 module com {  module sun {  module star {  module lang {
  26  published interface XMultiComponentFactory;
  27 }; }; }; };
  28
  29 module com {  module sun {  module star {  module uno {
  30
  31 /** Component context to be passed to a component via
  32     com::sun::star::lang::XSingleComponentFactory.
  33     Arbitrary values (e.g. deployment values) can be retrieved from the context.
  34 */
  35 published interface XComponentContext : XInterface
  36 {
  37     /** Gets a value from the context.
  38
  39         @param Name
  40                name of value
  41         @return
  42                 value
  43     */
  44     any getValueByName( [in] string Name );
  45
  46     /** Gets the service manager instance to be used from key
  47         <code>/singletons/com.sun.star.lang.theServiceManager</code>.
  48         This method has been added for convenience, because the
  49         service manager is used very often.
  50
  51         @return
  52                 service manager; throws DeploymentException in case service
  53                 manager is null
  54     */
  55     com::sun::star::lang::XMultiComponentFactory getServiceManager();
  56 };
  57
  58 }; }; }; };
  59
  60 #endif
  61
  62 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */