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 #include <functional>
  28
  29 namespace com::sun::star::uno { class XInterface; }
  30 namespace com::sun::star::uno { template <class E> class Sequence; }
  31
  32 enum class SfxModelFlags
  33 {
  34     NONE                       = 0x00,
  35     EMBEDDED_OBJECT            = 0x01,
  36     EXTERNAL_LINK              = 0x02,
  37     DISABLE_EMBEDDED_SCRIPTS   = 0x04,
  38     DISABLE_DOCUMENT_RECOVERY  = 0x08,
  39 };
  40 namespace o3tl
  41 {
  42     template<> struct typed_flags<SfxModelFlags> : is_typed_flags<SfxModelFlags, 0x0f> {};
  43 }
  44
  45 namespace sfx2
  46 {
  47     /**
  48      * Intended to be called from UNO constructor functions
  49      * This evaluates certain creation arguments (passed to createInstanceWithArguments)
  50      * and passes them to the factory function of the derived class.
  51      */
  52     css::uno::Reference<css::uno::XInterface>
  53         SFX2_DLLPUBLIC createSfxModelInstance(
  54             const css::uno::Sequence<css::uno::Any> & rxArgs,
  55             std::function<css::uno::Reference<css::uno::XInterface>( SfxModelFlags )> creationFunc
  56         );
  57
  58 } // namespace sfx2
  59
  60
  61 #endif // INCLUDED_SFX2_SFXMODELFACTORY_HXX
  62
  63 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */