offapi/com/sun/star/embed/XPackageStructureCreator.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: XPackageStructureCreator.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_embed_XPackageStructureCreator_idl__
  31 #define __com_sun_star_embed_XPackageStructureCreator_idl__
  32
  33 #ifndef __com_sun_star_io_XOutputStream_idl__
  34 #include <com/sun/star/io/XOutputStream.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_io_IOException_idl__
  38 #include <com/sun/star/io/IOException.idl>
  39 #endif
  40
  41 //=============================================================================
  42
  43  module com {  module sun {  module star {  module embed {
  44
  45 //=============================================================================
  46 /** allows to convert file system folder tree in to a package.
  47  */
  48 interface XPackageStructureCreator: com::sun::star::uno::XInterface
  49 {
  50     //-------------------------------------------------------------------------
  51     /** converts file system folder tree in to a package.
  52
  53         @param sFolderURL
  54             the URL of folder that must be converted,
  55             the URL must be in format accepted by UCB
  56
  57         @param xTargetStream
  58             the result package will be written into this stream
  59
  60         @throws ::com::sun::star::io::IOException
  61             in case any problem on reading/writing appears
  62      */
  63     void convertToPackage(
  64             [in] string sFolderURL,
  65             [in] ::com::sun::star::io::XOutputStream xTargetStream )
  66         raises( ::com::sun::star::io::IOException );
  67 };
  68
  69 //=============================================================================
  70
  71 }; }; }; };
  72
  73 #endif
  74