Update ooo320-m1
[ooovba.git] / offapi / com / sun / star / packages / zip / XZipFileAccess.idl
blob875a1938abc6b6c5187b7460cafaf3be3cf73ea2
1 /*************************************************************************
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2008 by Sun Microsystems, Inc.
7 * OpenOffice.org - a multi-platform office productivity suite
9 * $RCSfile: XZipFileAccess.idl,v $
10 * $Revision: 1.4 $
12 * This file is part of OpenOffice.org.
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.
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).
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.
29 ************************************************************************/
30 #ifndef __com_sun_star_packages_zip_XZipFileAccess_idl__
31 #define __com_sun_star_packages_zip_XZipFileAccess_idl__
33 #ifndef __com_sun_star_uno_XInterface_idl__
34 #include <com/sun/star/uno/XInterface.idl>
35 #endif
37 #ifndef __com_sun_star_packages_zip_ZipEntry_idl__
38 #include <com/sun/star/packages/zip/ZipEntry.idl>
39 #endif
41 #ifndef __com_sun_star_container_NoSuchElementException_idl_
42 #include <com/sun/star/container/NoSuchElementException.idl>
43 #endif
45 #ifndef __com_sun_star_io_IOException_idl__
46 #include <com/sun/star/io/IOException.idl>
47 #endif
50 //=============================================================================
52 module com { module sun { module star { module packages { module zip {
54 //=============================================================================
56 /** allows to get reading access to nonencrypted entries inside zip file.
58 interface XZipFileAccess: ::com::sun::star::uno::XInterface
60 //-------------------------------------------------------------------------
61 /** allows to get stream by specifying a pattern.
63 <p>
64 The first stream with a name that fits to the pattern will be returned.
65 The pattern allows to use '*' wildcard symbol. If the name contains '*'
66 or '\' symbols itself they must guarded with backslash '\'.
67 The slashes have no special meaning here so they can be replaced
68 by wildcards also.
69 </p>
71 ::com::sun::star::io::XInputStream getStreamByPattern( [in] string aPattern )
72 raises( ::com::sun::star::container::NoSuchElementException,
73 ::com::sun::star::io::IOException );
75 };
77 //=============================================================================
79 }; }; }; }; };
81 #endif