summaryrefslogtreecommitdiff
path: root/udkapi/com/sun/star/lang/ServiceManager.idl
blob: f17588c9b5b1787e78502bdff7a4d94a3d7bbe89 (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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
/* -*- 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_lang_ServiceManager_idl__
#define __com_sun_star_lang_ServiceManager_idl__

#include <com/sun/star/lang/MultiServiceFactory.idl>

#include <com/sun/star/lang/XComponent.idl>

#include <com/sun/star/container/XSet.idl>

#include <com/sun/star/container/XContentEnumerationAccess.idl>

#include <com/sun/star/lang/XMultiServiceFactory.idl>
#include <com/sun/star/lang/XMultiComponentFactory.idl>

#include <com/sun/star/lang/XServiceInfo.idl>

#include <com/sun/star/beans/XPropertySet.idl>

//=============================================================================

module com {  module sun {  module star {  module lang {

//=============================================================================

/** Provides a collection of implementations for services.  This is a singleton
    you commonly find in your component context under key
    <code>/singletons/com.sun.star.lang.theServiceManager</code>.

    <p>
    The factories are accessed with a service name. It is possible to
    access the factories with their implementation names, but you should
    avoid this.
    </p>

    <p>Service factories added via <type scope="com::sun::star::container">XSet</type>
    should support the following interfaces: </p>

    <dl>
    <dt><type>XServiceInfo</type></dt>
    <dd>supported interfaces/ implementation name</dd>

    <dt><type>XSingleComponentFactory</type>(optional)</dt>
    <dd>is used to create instances of the implementation.</dd>

    <dt><type>XComponent</type> (optional)</dt>
    <dd>The service manager calls the method
    <member scope="com::sun::star::lang">XComponent::dispose</member>
    on the factory when going down (i.e. it is commonly disposed by the component context).</dd>
    </dl>

    <p>Since LibreOffice 3.6, in addition to instances of
    <type>XServiceInfo</type> et al, the
    <type scope="com::sun::star::container">XSet</type> of at least the default
    C++ service manager implementation now also supports sequences of
    <type scope="com::sun::star::beans">NamedValue</type> in <code>insert</code>
    and <code>remove</code>.  The sequence elements must each have a
    <code>Name</code> of <code>uri</code> and a string <code>Value</code> that
    is the URI of a service rdb.  It is legal for there to be no such
    <code>uri</code> elements.  For <code>insert</code>, there can additionally
    be an optional element with a <code>Name</code> of
    <code>component-context</code> and a value that is a non-null reference of
    type <type scope="com::sun::star::uno">XComponentContext</type> that shall
    be used instead of this service manager's default component context when
    loading the corresponding implementations.

    @see com::sun::star::uno::XComponentContext
*/
published service ServiceManager
{
    /** This is a derived MultiServiceFactory service.
    */
    service com::sun::star::lang::MultiServiceFactory;

    /** Disposing of service manager.
        <p>
        The component context disposes its service manager singleton when going down
        (i.e. when the component context is disposed).
        </p>
    */
    interface com::sun::star::lang::XComponent;

    /** Management of service factories.
    */
    interface com::sun::star::container::XSet;

    /** Enumeration of all service factories.
        <p>
        It is possible to enumerate all implementations that support the
        service specified with the argument of the
        <member scope="com::sun::star::container">XContentEnumerationAccess::createContentEnumeration</member> method.
        The enumerator commonly returns <type>XSingleComponentFactory</type>
        interfaces.
        </p>
    */
    interface com::sun::star::container::XContentEnumerationAccess;

    /** Property access.
    */
    [optional] interface com::sun::star::beans::XPropertySet;
    /** specifies the default component context to be used, if instanciating services
        via <type>XMultiServiceFactory</type>
    */
    [optional, property] com::sun::star::uno::XComponentContext DefaultContext;
};

//=============================================================================

}; }; }; };

/*=============================================================================

=============================================================================*/
#endif

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