1/************************************************************** 2 * 3 * Licensed to the Apache Software Foundation (ASF) under one 4 * or more contributor license agreements. See the NOTICE file 5 * distributed with this work for additional information 6 * regarding copyright ownership. The ASF licenses this file 7 * to you under the Apache License, Version 2.0 (the 8 * "License"); you may not use this file except in compliance 9 * with the License. You may obtain a copy of the License at 10 * 11 * http://www.apache.org/licenses/LICENSE-2.0 12 * 13 * Unless required by applicable law or agreed to in writing, 14 * software distributed under the License is distributed on an 15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16 * KIND, either express or implied. See the License for the 17 * specific language governing permissions and limitations 18 * under the License. 19 * 20 *************************************************************/ 21 22 23#ifndef __com_sun_star_xml_sax_InputSource_idl__ 24#define __com_sun_star_xml_sax_InputSource_idl__ 25 26#ifndef __com_sun_star_io_XInputStream_idl__ 27#include <com/sun/star/io/XInputStream.idl> 28#endif 29 30 31//============================================================================= 32 33module com { module sun { module star { module xml { module sax { 34 35//============================================================================= 36 37/** specifies the Datasource plus some additional information for the parser. 38 39 <p>There are two places where the application will deliver this input 40 source to the parser: 41 </p> 42 <ul> 43 <li>as the argument of <method>XParser::parseStream</method></li> 44 <li>as the return value of <method>XEntityReslover::resolveEntity</method>. 45 </li> 46 </ul> 47 */ 48published struct InputSource 49{ 50 /** contains the byte input stream of the document. 51 */ 52 com::sun::star::io::XInputStream aInputStream; 53 54 //------------------------------------------------------------------------- 55 56 /** contains the encoding of the data stream. This is used by the parser 57 to do unicode conversions. 58 59 <p>Note that in general you do not need to specify an encoding. 60 Either it is UTF-8 or UTF-16 which is recognized by the parser 61 or it is specified in the first line of the XML-File 62 ( e.g. <em>?xml encoding="EUC-JP"?</em> ).</p> 63 */ 64 string sEncoding; 65 66 //------------------------------------------------------------------------- 67 68 /** constains the public Id of the document, for example, needed in 69 exception-message strings. 70 */ 71 string sPublicId; 72 73 //------------------------------------------------------------------------- 74 75 /** contains the sytemID of the document. 76 */ 77 string sSystemId; 78}; 79 80//============================================================================= 81 82}; }; }; }; }; 83 84#endif 85