offapi/com/sun/star/xml/sax/XAttributeList.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 /** specifies an element's attributes.
  25
  26     <p>This interface describes a name-type-value triple which describes a
  27     single attribute of a tag. Implementors are encouraged to implement the
  28     com::sun::star::util::XCloneable interface also to
  29     allow the user to make a copy of the instance.
  30
  31     </p>
  32     <p>This interface is a poor IDL version of the Java interface
  33     <em>org.xml.sax.AttributeList</em>.  For example in getValueByName, it does
  34     not allow to distinguish a missing value (for which the Java interface
  35     returns null) from an empty string value.</p>
  36  */
  37 published interface XAttributeList: com::sun::star::uno::XInterface
  38 {
  39
  40     /** @returns
  41                     the number of attributes in this list.
  42      */
  43     short getLength();
  44
  45
  46     /** @returns
  47                     the name of an attribute in this list (by position).
  48      */
  49     string getNameByIndex( [in] short i );
  50
  51
  52     /** @returns
  53                     the type of an attribute in the list (by position).
  54                     Non-validating parsers may return CDATA only.
  55      */
  56     string getTypeByIndex( [in] short i );
  57
  58
  59     /** @returns
  60                     the type of an attribute in the list (by name).
  61                     Non-validating parsers may return CDATA only.
  62      */
  63     string getTypeByName( [in] string aName );
  64
  65
  66     /** @returns
  67                     the value of an attribute in the list (by position).
  68      */
  69     string getValueByIndex( [in] short i );
  70
  71
  72     /** @returns
  73                     the value of an attribute in the list (by name).
  74      */
  75     string getValueByName( [in] string aName );
  76 };
  77
  78
  79 }; }; }; }; };
  80
  81 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */