offapi/com/sun/star/xml/sax/InputSource.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: InputSource.idl,v $
  10  * $Revision: 1.7 $
  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_xml_sax_InputSource_idl__
  31 #define __com_sun_star_xml_sax_InputSource_idl__
  32
  33 #ifndef __com_sun_star_io_XInputStream_idl__
  34 #include <com/sun/star/io/XInputStream.idl>
  35 #endif
  36
  37
  38 //=============================================================================
  39
  40 module com {  module sun {  module star {  module xml {  module sax {
  41
  42 //=============================================================================
  43
  44 /** specifies the Datasource plus some additional information for the parser.
  45
  46     <p>There are two places where the application will deliver this input
  47     source to the parser:
  48     </p>
  49     <ul>
  50         <li>as the argument of <method>XParser::parseStream</method></li>
  51         <li>as the return value of <method>XEntityReslover::resolveEntity</method>.
  52     </li>
  53     </ul>
  54  */
  55 published struct InputSource
  56 {
  57     /** contains the byte input stream of the document.
  58      */
  59     com::sun::star::io::XInputStream aInputStream;
  60
  61     //-------------------------------------------------------------------------
  62
  63     /** contains the encoding of the data stream. This is used by the parser
  64         to do unicode conversions.
  65
  66         <p>Note that in general you do not need to specify an encoding.
  67         Either it is UTF-8 or UTF-16 which is recognized by the parser
  68         or it is specified in the first line of the XML-File
  69         ( e.g. <em>?xml encoding="EUC-JP"?</em> ).</p>
  70      */
  71     string sEncoding;
  72
  73     //-------------------------------------------------------------------------
  74
  75     /** constains the public Id of the document, for example, needed in
  76         exception-message strings.
  77      */
  78     string sPublicId;
  79
  80     //-------------------------------------------------------------------------
  81
  82     /** contains the sytemID of the document.
  83      */
  84     string sSystemId;
  85 };
  86
  87 //=============================================================================
  88
  89 }; }; }; }; };
  90
  91 #endif