xref: /trunk/main/offapi/com/sun/star/embed/XPackageStructureCreator.idl (revision 1ecadb572e7010ff3b3382ad9bf179dbc6efadbb)
1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_embed_XPackageStructureCreator_idl__
28#define __com_sun_star_embed_XPackageStructureCreator_idl__
29
30#ifndef __com_sun_star_io_XOutputStream_idl__
31#include <com/sun/star/io/XOutputStream.idl>
32#endif
33
34#ifndef __com_sun_star_io_IOException_idl__
35#include <com/sun/star/io/IOException.idl>
36#endif
37
38//=============================================================================
39
40 module com {  module sun {  module star {  module embed {
41
42//=============================================================================
43/** allows to convert file system folder tree in to a package.
44 */
45published interface XPackageStructureCreator: com::sun::star::uno::XInterface
46{
47    //-------------------------------------------------------------------------
48    /** converts file system folder tree in to a package.
49
50        @param sFolderURL
51            the URL of folder that must be converted,
52            the URL must be in format accepted by UCB
53
54        @param xTargetStream
55            the result package will be written into this stream
56
57        @throws ::com::sun::star::io::IOException
58            in case any problem on reading/writing appears
59     */
60    void convertToPackage(
61            [in] string sFolderURL,
62            [in] ::com::sun::star::io::XOutputStream xTargetStream )
63        raises( ::com::sun::star::io::IOException );
64};
65
66//=============================================================================
67
68}; }; }; };
69
70#endif
71
72