offapi/com/sun/star/document/XStorageBasedDocument.idl

   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 #ifndef __com_sun_star_document_XStorageBasedDocument_idl__
  20 #define __com_sun_star_document_XStorageBasedDocument_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23 #include <com/sun/star/embed/XStorage.idl>
  24 #include <com/sun/star/io/IOException.idl>
  25 #include <com/sun/star/frame/DoubleInitializationException.idl>
  26 #include <com/sun/star/document/XStorageChangeListener.idl>
  27 #include <com/sun/star/lang/IllegalArgumentException.idl>
  28 #include <com/sun/star/beans/PropertyValue.idl>
  29
  30
  31  module com {  module sun {  module star {  module document {
  32
  33 /** allows to initialize document with a storage, to store document to
  34     a storage, and to set document to be based on provided storage.
  35  */
  36 interface XStorageBasedDocument: com::sun::star::uno::XInterface
  37 {
  38     /** lets the document load itself using provided storage.
  39      */
  40     void loadFromStorage(
  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::frame::DoubleInitializationException,
  45                 ::com::sun::star::io::IOException,
  46                 ::com::sun::star::uno::Exception );
  47
  48     /** lets the document store itself to the provided storage.
  49      */
  50     void storeToStorage(
  51             [in] ::com::sun::star::embed::XStorage xStorage,
  52             [in] sequence< ::com::sun::star::beans::PropertyValue > aMediaDescriptor )
  53         raises( ::com::sun::star::lang::IllegalArgumentException,
  54                 ::com::sun::star::io::IOException,
  55                 ::com::sun::star::uno::Exception );
  56
  57     /** allows to switch the document to the provided storage.
  58      */
  59     void switchToStorage( [in] ::com::sun::star::embed::XStorage xStorage )
  60         raises( ::com::sun::star::lang::IllegalArgumentException,
  61                 ::com::sun::star::io::IOException,
  62                 ::com::sun::star::uno::Exception );
  63
  64
  65     /** allows to get the storage the document is based on.
  66      */
  67     ::com::sun::star::embed::XStorage getDocumentStorage()
  68         raises( ::com::sun::star::io::IOException,
  69                 ::com::sun::star::uno::Exception );
  70
  71     /** allows to register a listener that will be notified when another
  72         storage is set to the document.
  73      */
  74     void addStorageChangeListener( [in] XStorageChangeListener xListener );
  75
  76     /** allows to deregister the listener.
  77      */
  78     void removeStorageChangeListener( [in] XStorageChangeListener xListener );
  79
  80 };
  81
  82
  83 }; }; }; };
  84
  85 #endif
  86
  87 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */