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