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
  20 module com {  module sun {  module star {   module packages {  module zip {
  21
  22
  23 /** allows to get reading access to non-encrypted entries inside zip file.
  24  */
  25 interface XZipFileAccess: ::com::sun::star::uno::XInterface
  26 {
  27     /** allows to get stream by specifying a pattern.
  28
  29         <p>
  30         The first stream with a name that fits to the pattern will be returned.
  31         The pattern allows to use "*" wildcard symbol. If the name contains "*"
  32         or "\" symbols itself they must guarded with backslash "\".
  33         The slashes have no special meaning here so they can be replaced
  34         by wildcards also.
  35         </p>
  36      */
  37     ::com::sun::star::io::XInputStream getStreamByPattern( [in] string aPattern )
  38         raises( ::com::sun::star::container::NoSuchElementException,
  39                 ::com::sun::star::io::IOException,
  40                 ::com::sun::star::packages::WrongPasswordException,
  41                 ::com::sun::star::packages::zip::ZipException );
  42
  43 };
  44
  45
  46 }; }; }; }; };
  47
  48 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */