ucbhelper/source/provider/simpleioerrorrequest.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 UCBHELPER_SOURCE_PROVIDER_SIMPLEIOERRORREQUEST_HXX
  21 #define UCBHELPER_SOURCE_PROVIDER_SIMPLEIOERRORREQUEST_HXX
  22
  23 #include <com/sun/star/ucb/IOErrorCode.hpp>
  24 #include <ucbhelper/interactionrequest.hxx>
  25
  26 namespace com::sun::star::ucb { class XCommandProcessor; }
  27
  28 namespace ucbhelper {
  29
  30 /**
  31   * This class implements a simple IO error interaction request. Instances
  32   * can be passed directly to XInteractionHandler::handle(...). Each
  33   * instance contains an InteractiveIOException and one interaction
  34   * continuation: "Abort".
  35   *
  36   * @see css::ucb::InteractiveIOException
  37   * @see InteractionAbort
  38   */
  39 class SimpleIOErrorRequest final : public ucbhelper::InteractionRequest
  40 {
  41 public:
  42     /**
  43       * Constructor.
  44       *
  45       * @param xContext contains the command processor that executes the
  46       *        command related to the request.
  47       *
  48       * @param eError is the error code to pass along with the request.
  49       *
  50       * qparam rArgs are additional parameters according to the specification
  51       *        of the error code. Refer to com/sun/star/ucb/IOErrorCode.idl
  52       *        for details.
  53       */
  54     SimpleIOErrorRequest( const css::ucb::IOErrorCode eError,
  55                           const css::uno::Sequence< css::uno::Any > & rArgs,
  56                           const OUString & rMessage,
  57                           const css::uno::Reference< css::ucb::XCommandProcessor > & xContext
  58                          );
  59 };
  60
  61 } // namespace ucbhelper
  62
  63 #endif /* ! UCBHELPER_SOURCE_PROVIDER_SIMPLEIOERRORREQUEST_HXX */
  64
  65 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */