include/sfx2/sfxmodelfactory.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 INCLUDED_SFX2_SFXMODELFACTORY_HXX
  21 #define INCLUDED_SFX2_SFXMODELFACTORY_HXX
  22
  23 #include <sfx2/dllapi.h>
  24
  25 #include <com/sun/star/uno/Reference.hxx>
  26 #include <o3tl/typed_flags_set.hxx>
  27
  28 namespace com::sun::star::lang { class XMultiServiceFactory; }
  29 namespace com::sun::star::lang { class XSingleServiceFactory; }
  30 namespace com::sun::star::uno { class XInterface; }
  31 namespace com::sun::star::uno { template <class E> class Sequence; }
  32
  33 enum class SfxModelFlags
  34 {
  35     NONE                       = 0x00,
  36     EMBEDDED_OBJECT            = 0x01,
  37     EXTERNAL_LINK              = 0x02,
  38     DISABLE_EMBEDDED_SCRIPTS   = 0x04,
  39     DISABLE_DOCUMENT_RECOVERY  = 0x08,
  40 };
  41 namespace o3tl
  42 {
  43     template<> struct typed_flags<SfxModelFlags> : is_typed_flags<SfxModelFlags, 0x0f> {};
  44 }
  45
  46 namespace sfx2
  47 {
  48     typedef css::uno::Reference< css::uno::XInterface > ( * SfxModelFactoryFunc ) (
  49         const css::uno::Reference< css::lang::XMultiServiceFactory >& _rxFactory,
  50         SfxModelFlags _nCreationFlags
  51     );
  52
  53
  54     //= createSfxModelFactory
  55
  56     /** creates a XSingleServiceFactory which can be used to created instances
  57         of classes derived from SfxBaseModel
  58
  59         In opposite to the default implementations from module cppuhelper, this
  60         factory evaluates certain creation arguments (passed to createInstanceWithArguments)
  61         and passes them to the factory function of the derived class.
  62     */
  63     css::uno::Reference< css::lang::XSingleServiceFactory >
  64         SFX2_DLLPUBLIC createSfxModelFactory(
  65             const css::uno::Reference< css::lang::XMultiServiceFactory >& _rxServiceFactory,
  66             const OUString& _rImplementationName,
  67             const SfxModelFactoryFunc _pComponentFactoryFunc,
  68             const css::uno::Sequence< OUString >& _rServiceNames
  69         );
  70
  71
  72 } // namespace sfx2
  73
  74
  75 #endif // INCLUDED_SFX2_SFXMODELFACTORY_HXX
  76
  77 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */