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
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: XImplementationLoader.idl,v $
* $Revision: 1.14 $
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef __com_sun_star_loader_XImplementationLoader_idl__
#define __com_sun_star_loader_XImplementationLoader_idl__
#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif
#ifndef __com_sun_star_registry_XRegistryKey_idl__
#include <com/sun/star/registry/XRegistryKey.idl>
#endif
#ifndef __com_sun_star_registry_CannotRegisterImplementationException_idl__
#include <com/sun/star/registry/CannotRegisterImplementationException.idl>
#endif
#ifndef __com_sun_star_loader_CannotActivateFactoryException_idl__
#include <com/sun/star/loader/CannotActivateFactoryException.idl>
#endif
//=============================================================================
module com { module sun { module star { module loader {
//=============================================================================
/** handles activation (loading) of a UNO component.
@see com::sun::star::registry::XImplementationRegistration
*/
published interface XImplementationLoader: com::sun::star::uno::XInterface
{
//-------------------------------------------------------------------------
/** activates a concrete implementation within a component.
@param implementationName The name of the implementation,
which shall be instantiated. The method
<member>XImplementationLoader::writeRegistryInfo</member>
writes a list of implementation names hosted by this component.
@param implementationLoaderUrl specification bug, ignore this parameter, please
pass an empty string.
@param locationUrl Points to the location of the file containing
the component (for instance a .jar-file or a shared library).
This parameter
should be in an URL format (= protocol:protocol-dependent-part).
In case the string contains no
leading "protocol:", the implementation in general assumes,
that it is a relative file url. <p>Special loaders may define
their own protocol (for instance an executable loader may need
more than only one file url).
@param xKey A registry which may be used to read static data previously
written via <method>XImplementationLoader::writeRegistryInfo()</method>.
The use of this parameter is deprecated.
@return returns a factory interface, which allows to create an instance of
the concrete implementation. In general, the object supports a
<type scope="com::sun::star::lang">XSingleComponentFactory</type>
and the <type scope="com::sun::star::lang">XServiceInfo</type> interface. The
XServiceInfo interface informs about the capabilities of the
service implementation, not the factory itself.
*/
com::sun::star::uno::XInterface activate( [in] string implementationName,
[in] string implementationLoaderUrl,
[in] string locationUrl,
[in] com::sun::star::registry::XRegistryKey xKey )
raises( com::sun::star::loader::CannotActivateFactoryException );
//-------------------------------------------------------------------------
/** writes a list of all implementations hosted by this component into a registry key.
<p>This method is called during registering a component.
@param xKey The registry key, which shall be used to write for each
implementation the implementation name plus a list of supported
services.
@param implementationLoaderUrl specification bug, ignore this parameter, please
pass an empty string.
@param locationUrl Points to the location of the file containing
the component (for instance a .jar-file or a shared library).
This parameter
should be in an URL format (= protocol:protocol-dependent-part).
In case the string contains no
leading "protocol:", the implementation in general assumes,
that it is a relative file url. <p>Special loaders may define
their own protocol (for instance an executable loader may need
more than only one file url).
@see com::sun::star::registry::XImplementationRegistration
*/
boolean writeRegistryInfo( [in] com::sun::star::registry::XRegistryKey xKey,
[in] string implementationLoaderUrl,
[in] string locationUrl )
raises( com::sun::star::registry::CannotRegisterImplementationException );
};
//=============================================================================
}; }; }; };
#endif
|