include/comphelper/processfactory.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 #ifndef _COMPHELPER_PROCESSFACTORY_HXX_
  21 #define _COMPHELPER_PROCESSFACTORY_HXX_
  22
  23 #include <com/sun/star/uno/XComponentContext.hpp>
  24 #include <com/sun/star/uno/Sequence.hxx>
  25 #include "comphelper/comphelperdllapi.h"
  26
  27 namespace com { namespace sun { namespace star { namespace lang {
  28     class XMultiServiceFactory;
  29 } } } }
  30
  31 namespace comphelper
  32 {
  33
  34 /**
  35  * This function set the process service factory.
  36  *
  37  * @author Juergen Schmidt
  38  */
  39 COMPHELPER_DLLPUBLIC void setProcessServiceFactory(const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& xSMgr);
  40
  41 /**
  42  * This function gets the process service factory.
  43  *
  44  * If no service factory is set the function throws a RuntimeException.
  45  *
  46  * @author Juergen Schmidt
  47  */
  48 COMPHELPER_DLLPUBLIC ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory > getProcessServiceFactory();
  49
  50 /** Obtains a component context from a service factory.
  51
  52     Throws a RuntimeException if no component context can be obtained.
  53
  54     @param factory may be null
  55     @return may be null
  56  */
  57 COMPHELPER_DLLPUBLIC
  58 com::sun::star::uno::Reference< com::sun::star::uno::XComponentContext >
  59 getComponentContext(
  60     com::sun::star::uno::Reference< com::sun::star::lang::XMultiServiceFactory >
  61         const & factory);
  62
  63 /**
  64  * This function gets the process service factory's default component context.
  65  *
  66  * Throws a RuntimeException if no component context can be obtained.
  67  */
  68 COMPHELPER_DLLPUBLIC
  69 ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext >
  70 getProcessComponentContext();
  71
  72 }
  73
  74
  75 extern "C" {
  76 /// @internal ATTENTION returns ACQUIRED pointer! release it explicitly!
  77 COMPHELPER_DLLPUBLIC
  78 ::com::sun::star::uno::XComponentContext *
  79 comphelper_getProcessComponentContext();
  80 } // extern "C"
  81
  82 #endif // _COMPHELPER_PROCESSFACTORY_HXX_
  83
  84 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */