offapi/com/sun/star/xml/sax/InputSource.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_xml_sax_InputSource_idl__
  20 #define __com_sun_star_xml_sax_InputSource_idl__
  21
  22 #include <com/sun/star/io/XInputStream.idl>
  23
  24
  25
  26 module com {  module sun {  module star {  module xml {  module sax {
  27
  28
  29 /** specifies the Datasource plus some additional information for the parser.
  30
  31     <p>There are two places where the application will deliver this input
  32     source to the parser:
  33     </p>
  34     <ul>
  35         <li>as the argument of XParser::parseStream()</li>
  36         <li>as the return value of XEntityReslover::resolveEntity().
  37     </li>
  38     </ul>
  39  */
  40 published struct InputSource
  41 {
  42     /** contains the byte input stream of the document.
  43      */
  44     com::sun::star::io::XInputStream aInputStream;
  45
  46
  47     /** contains the encoding of the data stream. This is used by the parser
  48         to do Unicode conversions.
  49
  50         <p>Note that in general you do not need to specify an encoding.
  51         Either it is UTF-8 or UTF-16 which is recognized by the parser
  52         or it is specified in the first line of the XML-File
  53         ( e.g. <em>?xml encoding="EUC-JP"?</em> ).</p>
  54      */
  55     string sEncoding;
  56
  57
  58     /** contains the public Id of the document, for example, needed in
  59         exception-message strings.
  60      */
  61     string sPublicId;
  62
  63
  64     /** contains the system ID of the document.
  65      */
  66     string sSystemId;
  67 };
  68
  69
  70 }; }; }; }; };
  71
  72 #endif
  73
  74 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */