offapi/com/sun/star/packages/zip/XZipFileAccess.idl

   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_packages_zip_XZipFileAccess_idl__
  28 #define __com_sun_star_packages_zip_XZipFileAccess_idl__
  29
  30 #ifndef __com_sun_star_uno_XInterface_idl__
  31 #include <com/sun/star/uno/XInterface.idl>
  32 #endif
  33
  34 #ifndef __com_sun_star_packages_zip_ZipEntry_idl__
  35 #include <com/sun/star/packages/zip/ZipEntry.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_container_NoSuchElementException_idl_
  39 #include <com/sun/star/container/NoSuchElementException.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_io_IOException_idl__
  43 #include <com/sun/star/io/IOException.idl>
  44 #endif
  45
  46
  47 //=============================================================================
  48
  49 module com {  module sun {  module star {   module packages {  module zip {
  50
  51 //=============================================================================
  52
  53 /** allows to get reading access to nonencrypted entries inside zip file.
  54  */
  55 interface XZipFileAccess: ::com::sun::star::uno::XInterface
  56 {
  57     //-------------------------------------------------------------------------
  58     /** allows to get stream by specifying a pattern.
  59
  60         <p>
  61         The first stream with a name that fits to the pattern will be returned.
  62         The pattern allows to use '*' wildcard symbol. If the name contains '*'
  63         or '\' symbols itself they must guarded with backslash '\'.
  64         The slashes have no special meaning here so they can be replaced
  65         by wildcards also.
  66         </p>
  67      */
  68     ::com::sun::star::io::XInputStream getStreamByPattern( [in] string aPattern )
  69         raises( ::com::sun::star::container::NoSuchElementException,
  70                 ::com::sun::star::io::IOException );
  71
  72 };
  73
  74 //=============================================================================
  75
  76 }; }; }; }; };
  77
  78 #endif
  79