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