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/implbase1.hxx>
  26
  27 namespace ucbhelper
  28 {
  29 struct CommandEnvironment_Impl;
  30
  31 /**
  32   * This class implements the interface
  33   * com::sun::star::ucb::XCommandEnvironement. Instances of this class can
  34   * be used to supply environments to commands executed by UCB contents.
  35   */
  36 class UCBHELPER_DLLPUBLIC CommandEnvironment :
  37             public cppu::WeakImplHelper1< css::ucb::XCommandEnvironment >
  38 {
  39     CommandEnvironment_Impl* m_pImpl;
  40
  41 private:
  42     CommandEnvironment( const CommandEnvironment& ) SAL_DELETED_FUNCTION;
  43     CommandEnvironment& operator=( const CommandEnvironment& ) SAL_DELETED_FUNCTION;
  44
  45 public:
  46     /**
  47       * Constructor.
  48       *
  49       * @param rxInteractionHandler is the implementation of an Interaction
  50       *        Handler or an empty reference.
  51       * @param rxProgressHandler is the implementation of a Progress
  52       *        Handler or an empty reference.
  53       */
  54     CommandEnvironment( const css::uno::Reference< css::task::XInteractionHandler >& rxInteractionHandler,
  55                         const css::uno::Reference< css::ucb::XProgressHandler >& rxProgressHandler );
  56     /**
  57       * Destructor.
  58       */
  59     virtual ~CommandEnvironment();
  60
  61      // XCommandEnvironemnt
  62     virtual css::uno::Reference< css::task::XInteractionHandler > SAL_CALL getInteractionHandler()
  63         throw ( css::uno::RuntimeException,
  64                 std::exception ) SAL_OVERRIDE;
  65
  66     virtual css::uno::Reference< css::ucb::XProgressHandler > SAL_CALL getProgressHandler()
  67         throw ( css::uno::RuntimeException,
  68                 std::exception ) SAL_OVERRIDE;
  69 };
  70
  71 } /* namespace ucbhelper */
  72
  73 #endif /* ! INCLUDED_UCBHELPER_COMMANDENVIRONMENT_HXX */
  74
  75 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */