Line data    Source code

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