offapi/com/sun/star/packages/manifest/XManifestReader.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: XManifestReader.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_manifest_XManifestReader_idl__
  31 #define __com_sun_star_packages_manifest_XManifestReader_idl__
  32
  33 #ifndef __com_sun_star_beans_PropertyValue_idl__
  34 #include <com/sun/star/beans/PropertyValue.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_io_XInputStream_idl__
  38 #include <com/sun/star/io/XInputStream.idl>
  39 #endif
  40
  41 //=============================================================================
  42
  43 module com {  module sun {  module star {   module packages {  module manifest {
  44
  45 //=============================================================================
  46 /** This interface reads the manifest data from a file. The user
  47     must supply an XInputStream when calling readManifestSequence() to recieve
  48     a sequence of manifest entries. Each manifest entry is represented by
  49     a sequence of PropertyValues. */
  50 //=============================================================================
  51 published interface XManifestReader: com::sun::star::uno::XInterface
  52 {
  53     /** Supplies the XManifestReader with an XInputStream to read from, reads
  54         the data and returns it to the caller.
  55     */
  56     sequence < sequence < com::sun::star::beans::PropertyValue > > readManifestSequence( [in] com::sun::star::io::XInputStream rStream );
  57 };
  58 }; }; }; }; };
  59 #endif