Quelle  XParser.idl

/* -*- 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 .
 */



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


/** specifies a SAX parser.

    <p>This interface is an IDL version of the Java interface
    <em>org.xml.sax.Parser</em> with some minor adaptations.</p>
 */
published interface XParser: com::sun::star::uno::XInterface
{
    /** parses an XML document from a stream.

        <p>Set the desired handlers before calling this method.</p>
     */
    void parseStream( [in] com::sun::star::xml::sax::InputSource aInputSource )
            raises( com::sun::star::xml::sax::SAXException,
                    com::sun::star::io::IOException );

    /** allows an application to register a document event handler.
     */
    void setDocumentHandler( [in] com::sun::star::xml::sax::XDocumentHandler xHandler );

    /** allows an application to register an error event handler.

        <p>Note that the error handler can throw an exception when an error or
        warning occurs.  Note that an exception is thrown by the parser when
        an unrecoverable (fatal) error occurs.</p>
     */
    void setErrorHandler( [in] com::sun::star::xml::sax::XErrorHandler xHandler );

    /** allows an application to register a DTD-Handler.
     */
    void setDTDHandler( [in] com::sun::star::xml::sax::XDTDHandler xHandler );

    /** allows an application to register a DTD-Handler.
     */
    void setEntityResolver( [in] com::sun::star::xml::sax::XEntityResolver xResolver );

    /** sets a locale specified for localization of warnings and error messages.

        <p>Set the language of the error messages. Useful when the parsing
        errors will be presented to the user.</p>
     */
    void setLocale( [in] com::sun::star::lang::Locale locale );
};


}; }; }; }; };

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