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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XDocumentSubStorageSupplier.idl,v $
  10  * $Revision: 1.5 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_document_XDocumentSubStorageSupplier_idl__
  31 #define __com_sun_star_document_XDocumentSubStorageSupplier_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_embed_XStorage_idl__
  38 #include <com/sun/star/embed/XStorage.idl>
  39 #endif
  40
  41
  42 //=============================================================================
  43
  44 module com {   module sun {   module star {   module document {
  45
  46 //=============================================================================
  47 /** through this interface documents can provide access to their substorages
  48
  49     <p>
  50     A temporary interface to get access to documents substorages.
  51     </p>
  52
  53     @see DocumentInfo
  54     @see StandaloneDocumentInfo
  55  */
  56 interface XDocumentSubStorageSupplier: com::sun::star::uno::XInterface
  57 {
  58     //-------------------------------------------------------------------------
  59     /** provides the access to a substorage with specified name
  60
  61         @param sStorageName
  62             the name of requested substorage
  63
  64         @param nMode
  65             a mode the storage should be opened in can take value from ::com::sun::star::embed::ElementModes
  66
  67         @returns
  68             XStorage implementation that refers to specified substorage
  69      */
  70     com::sun::star::embed::XStorage getDocumentSubStorage(
  71                                         [in] string aStorageName,
  72                                         [in] long nMode );
  73
  74     //-------------------------------------------------------------------------
  75     /** provides the list of substorages
  76
  77         @returns
  78             sequence of substorages names
  79      */
  80     sequence< string > getDocumentSubStoragesNames()
  81         raises( ::com::sun::star::io::IOException );
  82
  83 };
  84
  85 //=============================================================================
  86
  87 }; }; }; };
  88
  89 #endif
  90