offapi/com/sun/star/xml/sax/XFastContextHandler.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 /** receives notification of sax document events from a
  26     XFastParser.
  27
  28     @see XFastDocumentHandler
  29  */
  30 interface XFastContextHandler: com::sun::star::uno::XInterface
  31 {
  32
  33     /** receives notification of the beginning of an element .
  34
  35         @param Element
  36             contains the integer token from the XFastTokenHandler
  37             registered at the XFastParser.<br>
  38
  39             If the element has a namespace that was registered with the
  40             XFastParser, <code>Element</code> contains the integer
  41             token of the elements local name from the XFastTokenHandler
  42             and the integer token of the namespace combined with an arithmetic
  43             <b>or</b> operation.
  44
  45         @param Attribs
  46             Contains a XFastAttributeList to access the attributes
  47             from the element.
  48
  49     */
  50     void startFastElement( [in] long Element, [in] XFastAttributeList Attribs )
  51             raises( com::sun::star::xml::sax::SAXException );
  52
  53
  54     /** receives notification of the beginning of an unknown element .
  55
  56         @param Namespace
  57             contains the namespace url (not the prefix!) of this element.
  58         @param Name
  59             contains the elements local name.
  60         @param Attribs
  61             Contains a XFastAttributeList to access the attributes
  62             from the element.
  63      */
  64     void startUnknownElement( [in] string Namespace, [in] string Name, [in] XFastAttributeList Attribs )
  65             raises( com::sun::star::xml::sax::SAXException );
  66
  67
  68     /** receives notification of the end of a known element.
  69         @see startFastElement
  70      */
  71     void endFastElement( [in] long Element )
  72             raises( com::sun::star::xml::sax::SAXException );
  73
  74
  75     /** receives notification of the end of a known element.
  76         @see startUnknownElement
  77      */
  78     void endUnknownElement( [in] string Namespace, [in] string Name )
  79             raises( com::sun::star::xml::sax::SAXException );
  80
  81
  82     /** receives notification of the beginning of a known child element.
  83
  84         @param Element
  85             contains the integer token from the XFastTokenHandler
  86             registered at the XFastParser.
  87
  88             <br>If the element has a namespace that was registered with the
  89             XFastParser, <code>Element</code> contains the
  90             integer token of the elements local name from the
  91             XFastTokenHandler and the integer token of the
  92             namespace combined with an arithmetic <b>or</b> operation.
  93
  94         @param Attribs
  95             Contains a XFastAttributeList to access the attributes
  96             from the element.
  97      */
  98     XFastContextHandler createFastChildContext( [in] long Element, [in] XFastAttributeList Attribs )
  99             raises( com::sun::star::xml::sax::SAXException );
 100
 101
 102     /** receives notification of the beginning of an unknown child element .
 103
 104         @param Namespace
 105             contains the namespace url (not the prefix!) of this element.
 106         @param Name
 107             contains the elements local name.
 108         @param Attribs
 109             Contains a XFastAttributeList to access the attributes
 110             the element.
 111      */
 112     XFastContextHandler createUnknownChildContext( [in] string Namespace, [in] string Name, [in] XFastAttributeList Attribs )
 113             raises( com::sun::star::xml::sax::SAXException );
 114
 115
 116     /** receives notification of character data.
 117      */
 118     void characters( [in] string aChars )
 119             raises( com::sun::star::xml::sax::SAXException );
 120   };
 121
 122
 123 }; }; }; }; };
 124
 125 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */