LibreOffice LibreOffice 26.2 SDK API Reference

XDocumentRecovery.idl
Go to the documentation of this file.
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
21module com { module sun { module star { module document {
22
23
27 interface XDocumentRecovery
28{
47 boolean wasModifiedSinceLastSave();
48
62 void storeToRecoveryFile(
63 [in] string TargetLocation,
64 [in] sequence< ::com::sun::star::beans::PropertyValue > MediaDescriptor
65 )
66 raises ( ::com::sun::star::io::IOException,
67 ::com::sun::star::lang::WrappedTargetException
68 );
69
96 void recoverFromFile(
97 [in] string SourceLocation,
98 [in] string SalvagedFile,
99 [in] sequence< ::com::sun::star::beans::PropertyValue > MediaDescriptor
100 )
101 raises ( ::com::sun::star::io::IOException,
102 ::com::sun::star::lang::WrappedTargetException
103 );
104};
105
106
107}; }; }; };
108
109
110/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::io::IOException
is thrown when an input or output error has occurred.
Definition: IOException.idl:27
com::sun::star::lang::WrappedTargetException
This is a checked exception that wraps an exception thrown by the original target.
Definition: WrappedTargetException.idl:34
com::sun::star::document::XDocumentRecovery
is the interface to be implemented by documents who wish to participate in the document emergency-sav...
Definition: XDocumentRecovery.idl:28
com::sun::star::document::XDocumentRecovery::recoverFromFile
void recoverFromFile([in] string SourceLocation, [in] string SalvagedFile, [in] sequence< ::com::sun::star::beans::PropertyValue > MediaDescriptor)
recovers the document after a previous emergency or session save.
com::sun::star::document::XDocumentRecovery::wasModifiedSinceLastSave
boolean wasModifiedSinceLastSave()
determines whether the document has been modified since the last call to storeToRecoveryFile().
com::sun::star::document::XDocumentRecovery::storeToRecoveryFile
void storeToRecoveryFile([in] string TargetLocation, [in] sequence< ::com::sun::star::beans::PropertyValue > MediaDescriptor)
does an emergency save of the document
com
Definition: Ambiguous.idl:20
com::sun::star::document::MediaDescriptor
describes properties of a document, regarding the relationship between the loaded document and the re...
Definition: MediaDescriptor.idl:45