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
  20
  21  module com {  module sun {  module star {  module document {
  22
  23 /** allows to initialize document with a storage, to store document to
  24     a storage, and to set document to be based on provided storage.
  25  */
  26 interface XStorageBasedDocument: com::sun::star::uno::XInterface
  27 {
  28     /** lets the document load itself using provided storage.
  29      */
  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
  38     /** lets the document store itself to the provided storage.
  39      */
  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
  47     /** allows to switch the document to the provided storage.
  48      */
  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
  55     /** allows to get the storage the document is based on.
  56      */
  57     ::com::sun::star::embed::XStorage getDocumentStorage()
  58         raises( ::com::sun::star::io::IOException,
  59                 ::com::sun::star::uno::Exception );
  60
  61     /** allows to register a listener that will be notified when another
  62         storage is set to the document.
  63      */
  64     void addStorageChangeListener( [in] XStorageChangeListener xListener );
  65
  66     /** allows to deregister the listener.
  67      */
  68     void removeStorageChangeListener( [in] XStorageChangeListener xListener );
  69
  70 };
  71
  72
  73 }; }; }; };
  74
  75 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */