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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
|
/* -*- 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 COMPHELPER_COMPONENTCONTEXT_HXX
#define COMPHELPER_COMPONENTCONTEXT_HXX
#include <comphelper/comphelperdllapi.h>
#include <com/sun/star/uno/XComponentContext.hpp>
#include <com/sun/star/lang/XMultiServiceFactory.hpp>
//........................................................................
namespace comphelper
{
//........................................................................
//====================================================================
//= ComponentContext
//====================================================================
/** a helper class for working with a component context
*/
class COMPHELPER_DLLPUBLIC ComponentContext
{
private:
::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext > m_xContext;
::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiComponentFactory > m_xORB;
public:
/** constructs an instance
@param _rxContext
the component context to manage
@throws ::com::sun::star::lang::NullPointerException
if the given context, or its component factory, are <NULL/>
*/
ComponentContext( const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext >& _rxContext );
/** constructs an instance
@param _rxLegacyFactory
the legacy service factor to obtain the <type scope="com::sun::star::uno">XComponentContext</type> from
@throws ::com::sun::star::uno::RuntimeException
if the given factory or does not have a DefaultContext property to obtain
a component context
@throws ::com::sun::star::lang::NullPointerException
if the given factory is <NULL/>, or provides a component context being <NULL/>, or provides
a component context whose component factory is <NULL/>
*/
ComponentContext( const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& _rxLegacyFactory );
/** returns the ->XComponentContext interface
*/
inline ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext >
getUNOContext() const { return m_xContext; }
/** determines whether the context is not <NULL/>
*/
inline sal_Bool is() const
{
return m_xContext.is();
}
/** creates a component using our component factory/context
@throws ::com::sun::star::uno::Exception
@return
<TRUE/> if and only if the component could be successfully created
*/
template < typename INTERFACE >
bool createComponent( const ::rtl::OUString& _rServiceName, ::com::sun::star::uno::Reference< INTERFACE >& _out_rxComponent ) const
{
_out_rxComponent.clear();
_out_rxComponent = _out_rxComponent.query(
m_xORB->createInstanceWithContext( _rServiceName, m_xContext )
);
return _out_rxComponent.is();
}
/** creates a component using our component factory/context
@throws ::com::sun::star::uno::Exception
@return
<TRUE/> if and only if the component could be successfully created
*/
template < typename INTERFACE >
bool createComponent( const sal_Char* _pAsciiServiceName, ::com::sun::star::uno::Reference< INTERFACE >& _out_rxComponent ) const
{
return createComponent( ::rtl::OUString::createFromAscii( _pAsciiServiceName ), _out_rxComponent );
}
/** creates a component using our component factory/context, passing creation arguments
@throws ::com::sun::star::uno::Exception
@return
<TRUE/> if and only if the component could be successfully created
*/
template < typename INTERFACE >
bool createComponentWithArguments( const ::rtl::OUString& _rServiceName, const ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Any >& _rArguments, ::com::sun::star::uno::Reference< INTERFACE >& _out_rxComponent ) const
{
_out_rxComponent.clear();
_out_rxComponent = _out_rxComponent.query(
m_xORB->createInstanceWithArgumentsAndContext( _rServiceName, _rArguments, m_xContext )
);
return _out_rxComponent.is();
}
/** creates a component using our component factory/context, passing creation arguments
@throws ::com::sun::star::uno::Exception
@return
<TRUE/> if and only if the component could be successfully created
*/
template < typename INTERFACE >
bool createComponentWithArguments( const sal_Char* _pAsciiServiceName, const ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Any >& _rArguments, ::com::sun::star::uno::Reference< INTERFACE >& _out_rxComponent ) const
{
return createComponentWithArguments( ::rtl::OUString::createFromAscii( _pAsciiServiceName ), _rArguments, _out_rxComponent );
}
/** creates a component using our component factory/context
@throws ::com::sun::star::lang::ServiceNotRegisteredException
if the given service is not registered
@throws Exception
if an exception occurred during creating the component
@return
the newly created component. Is never <NULL/>.
*/
::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > createComponent( const ::rtl::OUString& _rServiceName ) const;
/** creates a component using our component factory/context
@throws ::com::sun::star::lang::ServiceNotRegisteredException
if the given service is not registered
@throws Exception
if an exception occurred during creating the component
@return
the newly created component. Is never <NULL/>.
*/
::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > createComponent( const sal_Char* _pAsciiServiceName ) const
{
return createComponent( ::rtl::OUString::createFromAscii( _pAsciiServiceName ) );
}
/** creates a component using our component factory/context, passing creation arguments
@throws ::com::sun::star::lang::ServiceNotRegisteredException
if the given service is not registered
@throws Exception
if an exception occurred during creating the component
@return
the newly created component. Is never <NULL/>.
*/
::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > createComponentWithArguments(
const ::rtl::OUString& _rServiceName,
const ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Any >& _rArguments
) const;
/** creates a component using our component factory/context, passing creation arguments
@throws ::com::sun::star::lang::ServiceNotRegisteredException
if the given service is not registered
@throws Exception
if an exception occurred during creating the component
@return
the newly created component. Is never <NULL/>.
*/
::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > createComponentWithArguments(
const sal_Char* _pAsciiServiceName,
const ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Any >& _rArguments
) const
{
return createComponentWithArguments( ::rtl::OUString::createFromAscii( _pAsciiServiceName ), _rArguments );
}
/** retrieves a singleton instance from the context
Singletons are collected below the <code>/singletons</code> key in a component context,
so accessing them means retrieving the value under <code>/singletons/<instance_name></code>.
*/
::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > getSingleton( const ::rtl::OUString& _rInstanceName ) const;
/** retrieves a singleton instance from the context
Singletons are collected below the <code>/singletons</code> key in a component context,
so accessing them means retrieving the value under <code>/singletons/<instance_name></code>.
*/
::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > getSingleton( const sal_Char* _pAsciiInstanceName ) const
{
return getSingleton( ::rtl::OUString::createFromAscii( _pAsciiInstanceName ) );
}
/** returns the ->XMultiServiceFactory interface of ->m_xORB, for passing to
older code which does not yet support ->XMultiComponentFactory
@throws ::com::sun::star::uno::RuntimeException
if our our component factory does not support this interface
*/
::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >
getLegacyServiceFactory() const;
/** retrieves a value from our component context
@param _rName
the name of the value to retrieve
@return
the context value with the given name
@seealso XComponentContext::getValueByName
@seealso getContextValueByAsciiName
*/
::com::sun::star::uno::Any
getContextValueByName( const ::rtl::OUString& _rName ) const;
/** retrieves a value from our component context, specified by 8-bit ASCII string
@param _rName
the name of the value to retrieve, as ASCII character string
@return
the context value with the given name
@seealso XComponentContext::getValueByName
@seealso getContextValueByName
*/
inline ::com::sun::star::uno::Any
getContextValueByAsciiName( const sal_Char* _pAsciiName ) const
{
return getContextValueByName( ::rtl::OUString::createFromAscii( _pAsciiName ) );
}
};
//........................................................................
} // namespace comphelper
//........................................................................
#endif // COMPHELPER_COMPONENTCONTEXT_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
