include/ucbhelper/commandenvironment.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_UCBHELPER_COMMANDENVIRONMENT_HXX
  21 #define INCLUDED_UCBHELPER_COMMANDENVIRONMENT_HXX
  22
  23 #include <com/sun/star/ucb/XCommandEnvironment.hpp>
  24 #include <ucbhelper/ucbhelperdllapi.h>
  25 #include <cppuhelper/implbase.hxx>
  26 #include <memory>
  27
  28 namespace ucbhelper
  29 {
  30 struct CommandEnvironment_Impl;
  31
  32 // workaround for incremental linking bugs in MSVC2015
  33 class SAL_DLLPUBLIC_TEMPLATE CommandEnvironment_Base
  34     : public cppu::WeakImplHelper<css::ucb::XCommandEnvironment>
  35 {
  36 };
  37
  38 /**
  39   * This class implements the interface
  40   * css::ucb::XCommandEnvironment. Instances of this class can
  41   * be used to supply environments to commands executed by UCB contents.
  42   */
  43 class UCBHELPER_DLLPUBLIC CommandEnvironment final : public CommandEnvironment_Base
  44 {
  45     std::unique_ptr<CommandEnvironment_Impl> m_pImpl;
  46
  47 private:
  48     CommandEnvironment(const CommandEnvironment&) = delete;
  49     CommandEnvironment& operator=(const CommandEnvironment&) = delete;
  50
  51 public:
  52     /**
  53       * Constructor.
  54       *
  55       * @param rxInteractionHandler is the implementation of an Interaction
  56       *        Handler or an empty reference.
  57       * @param rxProgressHandler is the implementation of a Progress
  58       *        Handler or an empty reference.
  59       */
  60     CommandEnvironment(
  61         const css::uno::Reference<css::task::XInteractionHandler>& rxInteractionHandler,
  62         const css::uno::Reference<css::ucb::XProgressHandler>& rxProgressHandler);
  63     /**
  64       * Destructor.
  65       */
  66     virtual ~CommandEnvironment() override;
  67
  68     // XCommandEnvironment
  69     virtual css::uno::Reference<css::task::XInteractionHandler>
  70         SAL_CALL getInteractionHandler() override;
  71
  72     virtual css::uno::Reference<css::ucb::XProgressHandler> SAL_CALL getProgressHandler() override;
  73 };
  74
  75 } /* namespace ucbhelper */
  76
  77 #endif /* ! INCLUDED_UCBHELPER_COMMANDENVIRONMENT_HXX */
  78
  79 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */