LibreOffice LibreOffice 25.2 SDK API Reference

XStorageBasedDocument.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
21 module com { module sun { module star { module document {
22
26 interface XStorageBasedDocument: com::sun::star::uno::XInterface
27{
30 void loadFromStorage(
31 [in] ::com::sun::star::embed::XStorage xStorage,
32 [in] sequence< ::com::sun::star::beans::PropertyValue > aMediaDescriptor )
33 raises( ::com::sun::star::lang::IllegalArgumentException,
34 ::com::sun::star::frame::DoubleInitializationException,
35 ::com::sun::star::io::IOException,
36 ::com::sun::star::uno::Exception );
37
40 void storeToStorage(
41 [in] ::com::sun::star::embed::XStorage xStorage,
42 [in] sequence< ::com::sun::star::beans::PropertyValue > aMediaDescriptor )
43 raises( ::com::sun::star::lang::IllegalArgumentException,
44 ::com::sun::star::io::IOException,
45 ::com::sun::star::uno::Exception );
46
49 void switchToStorage( [in] ::com::sun::star::embed::XStorage xStorage )
50 raises( ::com::sun::star::lang::IllegalArgumentException,
51 ::com::sun::star::io::IOException,
52 ::com::sun::star::uno::Exception );
53
54
57 ::com::sun::star::embed::XStorage getDocumentStorage()
58 raises( ::com::sun::star::io::IOException,
59 ::com::sun::star::uno::Exception );
60
64 void addStorageChangeListener( [in] XStorageChangeListener xListener );
65
68 void removeStorageChangeListener( [in] XStorageChangeListener xListener );
69
70};
71
72
73}; }; }; };
74
75/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::frame::DoubleInitializationException
This exception can be thrown in case an object is initialized second time.
Definition: DoubleInitializationException.idl:29
com::sun::star::io::IOException
is thrown when an input or output error has occurred.
Definition: IOException.idl:27
com::sun::star::lang::IllegalArgumentException
This exception is thrown to indicate that a method has passed an illegal or inappropriate argument.
Definition: IllegalArgumentException.idl:27
com::sun::star::uno::Exception
the base of all UNO exceptions
Definition: Exception.idl:29
com::sun::star::document::XStorageBasedDocument
allows to initialize document with a storage, to store document to a storage, and to set document to ...
Definition: XStorageBasedDocument.idl:27
com::sun::star::document::XStorageBasedDocument::switchToStorage
void switchToStorage([in] ::com::sun::star::embed::XStorage xStorage)
allows to switch the document to the provided storage.
com::sun::star::document::XStorageBasedDocument::loadFromStorage
void loadFromStorage([in] ::com::sun::star::embed::XStorage xStorage, [in] sequence< ::com::sun::star::beans::PropertyValue > aMediaDescriptor)
lets the document load itself using provided storage.
com::sun::star::document::XStorageBasedDocument::getDocumentStorage
::com::sun::star::embed::XStorage getDocumentStorage()
allows to get the storage the document is based on.
com::sun::star::document::XStorageBasedDocument::storeToStorage
void storeToStorage([in] ::com::sun::star::embed::XStorage xStorage, [in] sequence< ::com::sun::star::beans::PropertyValue > aMediaDescriptor)
lets the document store itself to the provided storage.
com::sun::star::document::XStorageChangeListener
allows to be notified when a document is switched to a new storage.
Definition: XStorageChangeListener.idl:26
com::sun::star::embed::XStorage
This interface represents main storage functionality.
Definition: XStorage.idl:27
com::sun::star::uno::XInterface
base interface of all UNO interfaces
Definition: XInterface.idl:46
com
Definition: Ambiguous.idl:20