offapi/com/sun/star/packages/zip/ZipEntry.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_ZipEntry_idl__
  28 #define __com_sun_star_packages_zip_ZipEntry_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_xml_sax_InputSource_idl__
  35 #include <com/sun/star/xml/sax/InputSource.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_io_IOException_idl__
  39 #include <com/sun/star/io/IOException.idl>
  40 #endif
  41
  42
  43 //=============================================================================
  44
  45 module com {  module sun {  module star {   module packages {  module zip {
  46
  47 //=============================================================================
  48
  49 /** used to represent a ZIP file entry
  50
  51
  52     <p>This interface is an IDL version of the Java interface
  53     <em>java.util.zip.ZipFile</em> with some minor adaptations.</p>
  54  */
  55 published struct ZipEntry
  56 {
  57     //-------------------------------------------------------------------------
  58     /** version needed to extract
  59      */
  60     short nVersion;
  61
  62     //-------------------------------------------------------------------------
  63     /** bit flags
  64      */
  65     short nFlag;
  66
  67     //-------------------------------------------------------------------------
  68     /** compression method
  69      */
  70     short nMethod;
  71
  72     //-------------------------------------------------------------------------
  73     /** modification time
  74      */
  75     long nTime;
  76
  77     //-------------------------------------------------------------------------
  78     /** crc-32 of entry data
  79      */
  80     long nCrc;
  81
  82     //-------------------------------------------------------------------------
  83     /** uncompressed size of entry data
  84      */
  85     long nCompressedSize;
  86
  87     //-------------------------------------------------------------------------
  88     /** uncompressed size of entry data
  89      */
  90     long nSize;
  91
  92     //-------------------------------------------------------------------------
  93     /** offset of LOC header
  94      */
  95     long nOffset;
  96
  97     //-------------------------------------------------------------------------
  98     /** The number of the disk this entry is saved on
  99      */
 100     short nDiskNumber;
 101
 102     //-------------------------------------------------------------------------
 103     /** the entry name
 104      */
 105     string sName;
 106
 107     //-------------------------------------------------------------------------
 108     /** optional extra field data for entry
 109      */
 110     sequence<byte> extra;
 111
 112     //-------------------------------------------------------------------------
 113     /** optional comment
 114      */
 115     string sComment;
 116 };
 117
 118 //=============================================================================
 119
 120 }; }; }; }; };
 121
 122 #endif