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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /**
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_packages_zip_XZipFileAccess_idl__
  20 #define __com_sun_star_packages_zip_XZipFileAccess_idl__
  21
  22 #include <com/sun/star/container/NoSuchElementException.idl>
  23 #include <com/sun/star/io/XInputStream.idl>
  24 #include <com/sun/star/io/IOException.idl>
  25 #include <com/sun/star/uno/XInterface.idl>
  26
  27
  28
  29 module com {  module sun {  module star {   module packages {  module zip {
  30
  31
  32 /** allows to get reading access to non-encrypted entries inside zip file.
  33  */
  34 interface XZipFileAccess: ::com::sun::star::uno::XInterface
  35 {
  36     /** allows to get stream by specifying a pattern.
  37
  38         <p>
  39         The first stream with a name that fits to the pattern will be returned.
  40         The pattern allows to use "*" wildcard symbol. If the name contains "*"
  41         or "\" symbols itself they must guarded with backslash "\".
  42         The slashes have no special meaning here so they can be replaced
  43         by wildcards also.
  44         </p>
  45      */
  46     ::com::sun::star::io::XInputStream getStreamByPattern( [in] string aPattern )
  47         raises( ::com::sun::star::container::NoSuchElementException,
  48                 ::com::sun::star::io::IOException );
  49
  50 };
  51
  52
  53 }; }; }; }; };
  54
  55 #endif
  56
  57 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */