summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/ucb/XProgressHandler.idl
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 09:06:44 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 09:06:44 +0000
commited5640d8b587fbcfed7dd7967f3de04b37a76f26 (patch)
tree7a5f7c6c9d02226d7471cb3cc8fbbf631b415303 /offapi/com/sun/star/ucb/XProgressHandler.idl
parentInitial commit. (diff)
downloadlibreoffice-upstream/4%7.4.7.tar.xz
libreoffice-upstream/4%7.4.7.zip
Adding upstream version 4:7.4.7.upstream/4%7.4.7upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to '')
-rw-r--r--offapi/com/sun/star/ucb/XProgressHandler.idl69
1 files changed, 69 insertions, 0 deletions
diff --git a/offapi/com/sun/star/ucb/XProgressHandler.idl b/offapi/com/sun/star/ucb/XProgressHandler.idl
new file mode 100644
index 000000000..bfa4d5644
--- /dev/null
+++ b/offapi/com/sun/star/ucb/XProgressHandler.idl
@@ -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 __com_sun_star_ucb_XProgressHandler_idl__
+#define __com_sun_star_ucb_XProgressHandler_idl__
+
+#include <com/sun/star/uno/XInterface.idl>
+
+
+
+module com { module sun { module star { module ucb {
+
+/** Handle a tasks notification that it has made some progress.
+*/
+published interface XProgressHandler: com::sun::star::uno::XInterface
+{
+ /** The task notifies the handler that it has started some new activity
+ (possibly a sub-activity of another activity already making progress;
+ therefore, these notifications behave in a stack-like manner).
+
+ @param Status An object representing the new activity. There has to
+ be an agreement between caller and callee of methods
+ XProgressHandler::push() and
+ XProgressHandler::update() as to which Status
+ arguments are meaningful. For example, a `string` argument
+ to XProgressHandler::push() should be used to transport
+ some status text that describes the progress being made (possibly
+ followed by one or more XProgressHandler::update()s with
+ `string` arguments, if the appropriate status text changes
+ as progress is being made).
+ */
+ void push([in] any Status);
+
+ /** The task notifies the handler that its current activity is making
+ progress.
+
+ @param Status An object representing the progress made. See the
+ documentation of XProgressHandler::push() for more
+ information.
+ */
+ void update([in] any Status);
+
+ /** The task notifies the handler that it has finished its current
+ activity.
+ */
+ void pop();
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */