offapi/com/sun/star/xml/sax/XFastAttributeList.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_XFastAttributeList_idl__
  20 #define __com_sun_star_xml_sax_XFastAttributeList_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23 #include <com/sun/star/xml/Attribute.idl>
  24 #include <com/sun/star/xml/FastAttribute.idl>
  25 #include <com/sun/star/xml/sax/SAXException.idl>
  26
  27
  28 module com {  module sun {  module star {  module xml {  module sax {
  29
  30
  31 /** a container for the attributes of an XML element.
  32
  33     <br>Attributes are separated into known attributes and unknown attributes.
  34     <p>Known attributes have a local name that is known to the XFastTokenHandler
  35     registered at the XFastParser which created the sax event containing
  36     this attributes. If an attribute also has a namespace, that must be registered
  37     at the XFastParser, else this attribute is also unknown even if
  38     the local name is known.
  39  */
  40 interface XFastAttributeList: com::sun::star::uno::XInterface
  41 {
  42     /** checks if an attribute is available.<br>
  43
  44         @param Token
  45             contains the integer token from the XFastTokenHandler
  46             registered at the XFastParser.<br>
  47
  48             If the attribute name has a namespace that was registered with the
  49             XFastParser, Token contains the integer token of the
  50             attributes local name from the XFastTokenHandler and
  51             the integer token of the namespace combined with an arithmetic
  52             <b>or</b> operation.
  53
  54         @returns
  55             `TRUE`, if the attribute is available
  56     */
  57     boolean hasAttribute( [in] long Token );
  58
  59     /** retrieves the token of an attribute value.<br>
  60
  61         @param Token
  62             contains the integer token from the XFastTokenHandler
  63             registered at the XFastParser.<br>
  64
  65             If the attribute name has a namespace that was registered with the
  66             XFastParser, Token contains the integer token of the
  67             attributes local name from the XFastTokenHandler and
  68             the integer token of the namespace combined with an arithmetic
  69             <b>or</b> operation.
  70
  71         @returns
  72             The integer token of the value from the attribute or FastToken::Invalid
  73
  74         @throws SAXEXception
  75             if the attribute is not available
  76
  77     */
  78     long getValueToken( [in] long Token )
  79         raises( SAXException );
  80
  81     /**retrieves the token of an attribute value.<br>
  82
  83         @param Token
  84             contains the integer token from the XFastTokenHandler
  85             registered at the XFastParser.<br>
  86
  87             If the attribute name has a namespace that was registered with the
  88             XFastParser, Token contains the integer token of the
  89             attributes local name from the XFastTokenHandler and
  90             the integer token of the namespace combined with an arithmetic
  91             <b>or</b> operation.
  92
  93         @param Default
  94             This value will be returned if the attribute is not available
  95
  96         @returns
  97             If the attribute is available it returns the integer token of the value
  98             from the attribute or FastToken::Invalid.
  99             If not the value of <code>Default</code> is returned.
 100
 101     */
 102     long getOptionalValueToken( [in] long Token, [in] long Default );
 103
 104     /** retrieves the value of an attribute.<br>
 105
 106         @param Token
 107             contains the integer token from the XFastTokenHandler
 108             registered at the XFastParser.<br>
 109
 110             If the attribute name has a namespace that was registered with the
 111             XFastParser, Token contains the integer token of the
 112             attributes local name from the XFastTokenHandler and
 113             the integer token of the namespace combined with an arithmetic
 114             <b>or</b> operation.
 115
 116         @returns
 117             The string value from the attribute.
 118
 119         @throws SAXEXception
 120             if the attribute is not available
 121
 122     */
 123     string getValue( [in] long Token )
 124         raises( SAXException );
 125
 126     /** retrieves the value of an attribute.<br>
 127
 128         @param Token
 129             contains the integer token from the XFastTokenHandler
 130             registered at the XFastParser.<br>
 131
 132             If the attribute name has a namespace that was registered with the
 133             XFastParser, Token contains the integer token of the
 134             attributes local name from the XFastTokenHandler and
 135             the integer token of the namespace combined with an arithmetic
 136             <b>or</b> operation.
 137
 138         @returns
 139             The string value from the attribute or an empty string if the
 140             attribute is not available.
 141     */
 142     string getOptionalValue( [in] long Token );
 143
 144     /** returns a sequence of attributes which names and or namespaces URLS
 145         can not be translated to tokens.
 146     */
 147     sequence< ::com::sun::star::xml::Attribute > getUnknownAttributes();
 148
 149     /** returns a sequence of attributes which names and or namespaces URLS
 150         are translated to tokens.
 151     */
 152     sequence< ::com::sun::star::xml::FastAttribute > getFastAttributes();
 153 };
 154
 155
 156 }; }; }; }; };
 157
 158 #endif
 159
 160 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */