summaryrefslogtreecommitdiff
path: root/udkapi/com/sun/star/uno/XComponentContext.idl
blob: 7d293eaaf4450c6b8a2f604a7deb74396efc87df (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/**
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
#ifndef __com_sun_star_uno_XComponentContext_idl__
#define __com_sun_star_uno_XComponentContext_idl__

#include <com/sun/star/uno/Exception.idl>


module com {  module sun {  module star {  module lang {
 published interface XMultiComponentFactory;
}; }; }; };

module com {  module sun {  module star {  module uno {

/** Component context to be passed to a component via
    <type scope="com::sun::star::lang">XSingleComponentFactory</type>.
    Arbitrary values (e.g. deployment values) can be retrieved from the context.
*/
published interface XComponentContext : XInterface
{
    /** Gets a value from the context.

        @param Name
               name of value
        @return
                value
    */
    any getValueByName( [in] string Name );

    /** Gets the service manager instance to be used from key
        <code>/singletons/com.sun.star.lang.theServiceManager</code>.
        This method has been added for convenience, because the
        service manager is used very often.

        @return
                service manager; throws DeploymentException in case service
                manager is null
    */
    com::sun::star::lang::XMultiComponentFactory getServiceManager();
};

}; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */