offapi/com/sun/star/document/XDocumentSubStorageSupplier.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
  22 module com {   module sun {   module star {   module document {
  23
  24 /** through this interface documents can provide access to their substorages
  25
  26     <p>
  27     A temporary interface to get access to documents substorages.
  28     </p>
  29  */
  30 interface XDocumentSubStorageSupplier: com::sun::star::uno::XInterface
  31 {
  32     /** provides the access to a substorage with specified name
  33
  34         @param StorageName
  35             the name of requested substorage
  36
  37         @param nMode
  38             a mode the storage should be opened in can take value from ::com::sun::star::embed::ElementModes
  39
  40         @returns
  41             XStorage implementation that refers to specified substorage
  42      */
  43     com::sun::star::embed::XStorage getDocumentSubStorage(
  44                                         [in] string StorageName,
  45                                         [in] long nMode );
  46
  47     /** provides the list of substorages
  48
  49         @returns
  50             sequence of substorages names
  51      */
  52     sequence< string > getDocumentSubStoragesNames()
  53         raises( ::com::sun::star::io::IOException );
  54
  55 };
  56
  57
  58 }; }; }; };
  59
  60 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */