summaryrefslogtreecommitdiffstats
path: root/include/ucbhelper/simpleioerrorrequest.hxx
diff options
context:
space:
mode:
Diffstat (limited to 'include/ucbhelper/simpleioerrorrequest.hxx')
-rw-r--r--include/ucbhelper/simpleioerrorrequest.hxx69
1 files changed, 69 insertions, 0 deletions
diff --git a/include/ucbhelper/simpleioerrorrequest.hxx b/include/ucbhelper/simpleioerrorrequest.hxx
new file mode 100644
index 000000000000..d4c9c5277316
--- /dev/null
+++ b/include/ucbhelper/simpleioerrorrequest.hxx
@@ -0,0 +1,69 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+
+#ifndef _UCBHELPER_SIMPLEIOERRORREQUEST_HXX
+#define _UCBHELPER_SIMPLEIOERRORREQUEST_HXX
+
+#include <com/sun/star/ucb/IOErrorCode.hpp>
+#include <ucbhelper/interactionrequest.hxx>
+
+namespace com { namespace sun { namespace star { namespace ucb {
+ class XCommandProcessor;
+} } } }
+
+namespace ucbhelper {
+
+/**
+ * This class implements a simple IO error interaction request. Instances
+ * can be passed directly to XInteractionHandler::handle(...). Each
+ * instance contains an InteractiveIOException and one interaction
+ * continuation: "Abort".
+ *
+ * @see com::sun::star::ucb::InteractiveIOException
+ * @see InteractionAbort
+ */
+class SimpleIOErrorRequest : public ucbhelper::InteractionRequest
+{
+public:
+ /**
+ * Constructor.
+ *
+ * @param xContext contains the command processor that executes the
+ * command related to the request.
+ *
+ * @param eError is the error code to pass along with the request.
+ *
+ * qparam rArgs are additional parameters according to the specification
+ * of the error code. Refer to com/sun/star/ucb/IOErrorCode.idl
+ * for details.
+ */
+ SimpleIOErrorRequest( const com::sun::star::ucb::IOErrorCode eError,
+ const com::sun::star::uno::Sequence<
+ com::sun::star::uno::Any > & rArgs,
+ const OUString & rMessage,
+ const com::sun::star::uno::Reference<
+ com::sun::star::ucb::XCommandProcessor > & xContext
+ );
+};
+
+} // namespace ucbhelper
+
+#endif /* !_UCBHELPER_SIMPLEIOERRORREQUEST_HXX */
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */