summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/task/XRestartManager.idl
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/task/XRestartManager.idl')
-rw-r--r--offapi/com/sun/star/task/XRestartManager.idl80
1 files changed, 80 insertions, 0 deletions
diff --git a/offapi/com/sun/star/task/XRestartManager.idl b/offapi/com/sun/star/task/XRestartManager.idl
new file mode 100644
index 000000000..662909529
--- /dev/null
+++ b/offapi/com/sun/star/task/XRestartManager.idl
@@ -0,0 +1,80 @@
+/* -*- 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_task_XRestartManager_idl__
+#define __com_sun_star_task_XRestartManager_idl__
+
+#include <com/sun/star/uno/XInterface.idl>
+#include <com/sun/star/task/XInteractionHandler.idl>
+#include <com/sun/star/uno/Exception.idl>
+
+
+module com { module sun { module star { module task {
+
+/** allows to try to restart the office.
+
+ @since OOo 3.3
+*/
+published interface XRestartManager : com::sun::star::uno::XInterface
+{
+ /** let the office restart asynchronously
+ @param xInteractionHandler
+ the com::sun::star::task::InteractionHandler
+ service implementation, that is used in case a problem is detected
+ during requesting the restart.
+
+ @throws com::sun::star::uno::Exception
+ to notify the caller about possible failures
+ */
+ void requestRestart(
+ [in] com::sun::star::task::XInteractionHandler xInteractionHandler )
+ raises( com::sun::star::uno::Exception );
+
+ /** allows to get info whether the restart has been requested and provide
+ the initialization status.
+
+ <p>
+ The office has to call this method just before the main loop has been
+ started, with the `TRUE` as argument, so that the implementation
+ knows that the office is initialized. If the method returns `TRUE`,
+ the office should restart without starting the main loop.
+ </p>
+
+ @param bInitialized
+ specifies whether the office process is initialized already,
+ if the caller does not have this information, he should provide
+ `FALSE`.
+
+ @returns
+ `TRUE` if the office restart has been requested,
+ `FALSE` otherwise
+
+ @throws com::sun::star::uno::Exception
+ to notify the caller about possible failures
+ */
+ boolean isRestartRequested(
+ [in] boolean bInitialized )
+ raises( com::sun::star::uno::Exception );
+};
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */