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 INCLUDED_CPPUHELPER_COMPONENT_CONTEXT_HXX
20 #define INCLUDED_CPPUHELPER_COMPONENT_CONTEXT_HXX
21 
22 #include "com/sun/star/uno/Any.hxx"
23 #include "com/sun/star/uno/Reference.hxx"
24 #include "cppuhelper/cppuhelperdllapi.h"
25 #include "rtl/ustring.hxx"
26 #include "sal/types.h"
27 
28 namespace com { namespace sun { namespace star { namespace uno { class XComponentContext; } } } }
29 
30 namespace cppu
31 {
32 
33 /** Context entries init struct calling createComponentContext().
34 */
35 struct SAL_WARN_UNUSED ContextEntry_Init
36 {
37     /** late init denotes an object that will be raised when first get() is calling for it
38 
39         The context implementation expects either a css::lang::XSingleComponentFactory
40         object as value (to instantiate the object) or a string as value for raising
41         a service via the used service manager.
42     */
43     bool bLateInitService;
44     /** name of context value
45     */
46     ::rtl::OUString name;
47     /** context value
48     */
49     css::uno::Any value;
50 
51     /** Default ctor.
52     */
ContextEntry_Initcppu::ContextEntry_Init53     ContextEntry_Init()
54         : bLateInitService( false )
55         {}
56     /** Ctor.
57 
58         @param name_
59                name of entry
60         @param value_
61                value of entry
62         @param bLateInitService_
63                whether this entry is a late-init named object entry
64                (value is object factory or service string)
65     */
ContextEntry_Initcppu::ContextEntry_Init66     ContextEntry_Init(
67         ::rtl::OUString const & name_,
68         css::uno::Any const & value_,
69         bool bLateInitService_ = false )
70             : bLateInitService( bLateInitService_ ),
71               name( name_ ),
72               value( value_ )
73         {}
74 };
75 
76 /** Creates a component context with the given entries.
77 
78     @param pEntries array of entries
79     @param nEntries number of entries
80     @param xDelegate delegation to further context, if value was not found
81     @return new context object
82 */
83 CPPUHELPER_DLLPUBLIC css::uno::Reference< css::uno::XComponentContext >
84 SAL_CALL createComponentContext(
85     ContextEntry_Init const * pEntries, sal_Int32 nEntries,
86     css::uno::Reference< css::uno::XComponentContext > const & xDelegate =
87     css::uno::Reference< css::uno::XComponentContext >() );
88 
89 }
90 
91 #endif
92 
93 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
94