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