summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/xml/sax/InputSource.idl
blob: 8c8a04b6707b9d98089ecbef0787c06c2a750048 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
#ifndef __com_sun_star_xml_sax_InputSource_idl__
#define __com_sun_star_xml_sax_InputSource_idl__

#include <com/sun/star/io/XInputStream.idl>



module com {  module sun {  module star {  module xml {  module sax {


/** specifies the Datasource plus some additional information for the parser.

    <p>There are two places where the application will deliver this input
    source to the parser:
    </p>
    <ul>
        <li>as the argument of XParser::parseStream()</li>
        <li>as the return value of XEntityReslover::resolveEntity().
    </li>
    </ul>
 */
published struct InputSource
{
    /** contains the byte input stream of the document.
     */
    com::sun::star::io::XInputStream aInputStream;


    /** contains the encoding of the data stream. This is used by the parser
        to do Unicode conversions.

        <p>Note that in general you do not need to specify an encoding.
        Either it is UTF-8 or UTF-16 which is recognized by the parser
        or it is specified in the first line of the XML-File
        ( e.g. <em>?xml encoding="EUC-JP"?</em> ).</p>
     */
    string sEncoding;


    /** contains the public Id of the document, for example, needed in
        exception-message strings.
     */
    string sPublicId;


    /** contains the system ID of the document.
     */
    string sSystemId;
};


}; }; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */