offapi/com/sun/star/xml/sax/XAttributeList.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XAttributeList.idl,v $
  10  * $Revision: 1.8 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_xml_sax_XAttributeList_idl__
  31 #define __com_sun_star_xml_sax_XAttributeList_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 //=============================================================================
  38
  39 module com {  module sun {  module star {  module xml {  module sax {
  40
  41 //=============================================================================
  42
  43 /** specifies an element's attributes.
  44
  45     <p>This interface describes a name-type-value triple which describes a
  46     single attribute of a tag. Implementors are encouraged to implement the
  47     <type scope="com::sun::star::util">XCloneable</type> interface also to
  48     allow the user to make a copy of the instance.
  49
  50     </p>
  51     <p>This interface is an IDL version of the Java interface
  52     <em>org.xml.sax.AttributeList</em>.</p>
  53  */
  54 published interface XAttributeList: com::sun::star::uno::XInterface
  55 {
  56     //-------------------------------------------------------------------------
  57
  58     /** @returns
  59                     the number of attributes in this list.
  60      */
  61     short getLength();
  62
  63     //-------------------------------------------------------------------------
  64
  65     /** @returns
  66                     the name of an attribute in this list (by position).
  67      */
  68     string getNameByIndex( [in] short i );
  69
  70     //-------------------------------------------------------------------------
  71
  72     /** @returns
  73                     the type of an attribute in the list (by position).
  74                     Non-validating parsers may return CDATA only.
  75      */
  76     string getTypeByIndex( [in] short i );
  77
  78     //-------------------------------------------------------------------------
  79
  80     /** @returns
  81                     the type of an attribute in the list (by name).
  82                     Non-validating parsers may return CDATA only.
  83      */
  84     string getTypeByName( [in] string aName );
  85
  86     //-------------------------------------------------------------------------
  87
  88     /** @returns
  89                     the value of an attribute in the list (by position).
  90      */
  91     string getValueByIndex( [in] short i );
  92
  93     //-------------------------------------------------------------------------
  94
  95     /** @returns
  96                     the value of an attribute in the list (by name).
  97      */
  98     string getValueByName( [in] string aName );
  99 };
 100
 101 //=============================================================================
 102
 103 }; }; }; }; };
 104
 105 #endif