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
  20
  21
  22 module com {  module sun {  module star {  module xml {  module sax {
  23
  24
  25 /** specifies the Datasource plus some additional information for the parser.
  26
  27     <p>There are two places where the application will deliver this input
  28     source to the parser:
  29     </p>
  30     <ul>
  31         <li>as the argument of XParser::parseStream()</li>
  32         <li>as the return value of XEntityResolver::resolveEntity().
  33     </li>
  34     </ul>
  35  */
  36 published struct InputSource
  37 {
  38     /** contains the byte input stream of the document.
  39      */
  40     com::sun::star::io::XInputStream aInputStream;
  41
  42
  43     /** contains the encoding of the data stream. This is used by the parser
  44         to do Unicode conversions.
  45
  46         <p>Note that in general you do not need to specify an encoding.
  47         Either it is UTF-8 or UTF-16 which is recognized by the parser
  48         or it is specified in the first line of the XML-File
  49         ( e.g. <em>?xml encoding="EUC-JP"?</em> ).</p>
  50      */
  51     string sEncoding;
  52
  53
  54     /** contains the public Id of the document, for example, needed in
  55         exception-message strings.
  56      */
  57     string sPublicId;
  58
  59
  60     /** contains the system ID of the document.
  61      */
  62     string sSystemId;
  63 };
  64
  65
  66 }; }; }; }; };
  67
  68 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */