include/cppuhelper/component_context.hxx

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