summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/embed/XPackageStructureCreator.idl
blob: c76d4c787cc75ee3a3430d8876b366c34bb3e9a8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_embed_XPackageStructureCreator_idl__
#define __com_sun_star_embed_XPackageStructureCreator_idl__

#ifndef __com_sun_star_io_XOutputStream_idl__
#include <com/sun/star/io/XOutputStream.idl>
#endif

#ifndef __com_sun_star_io_IOException_idl__
#include <com/sun/star/io/IOException.idl>
#endif

//=============================================================================

 module com {  module sun {  module star {  module embed {

//=============================================================================
/** allows to convert file system folder tree in to a package.
 */
published interface XPackageStructureCreator: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------
    /** converts file system folder tree in to a package.

        @param sFolderURL
            the URL of folder that must be converted,
            the URL must be in format accepted by UCB

        @param xTargetStream
            the result package will be written into this stream

        @throws ::com::sun::star::io::IOException
            in case any problem on reading/writing appears
     */
    void convertToPackage(
            [in] string sFolderURL,
            [in] ::com::sun::star::io::XOutputStream xTargetStream )
        raises( ::com::sun::star::io::IOException );
};

//=============================================================================

}; }; }; };

#endif