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