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