xref: /AOO41X/main/offapi/com/sun/star/xml/sax/XAttributeList.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_xml_sax_XAttributeList_idl__
24#define __com_sun_star_xml_sax_XAttributeList_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30//=============================================================================
31
32module com {  module sun {  module star {  module xml {  module sax {
33
34//=============================================================================
35
36/** specifies an element's attributes.
37
38    <p>This interface describes a name-type-value triple which describes a
39    single attribute of a tag. Implementors are encouraged to implement the
40    <type scope="com::sun::star::util">XCloneable</type> interface also to
41    allow the user to make a copy of the instance.
42
43    </p>
44    <p>This interface is an IDL version of the Java interface
45    <em>org.xml.sax.AttributeList</em>.</p>
46 */
47published interface XAttributeList: com::sun::star::uno::XInterface
48{
49    //-------------------------------------------------------------------------
50
51    /** @returns
52                    the number of attributes in this list.
53     */
54    short getLength();
55
56    //-------------------------------------------------------------------------
57
58    /** @returns
59                    the name of an attribute in this list (by position).
60     */
61    string getNameByIndex( [in] short i );
62
63    //-------------------------------------------------------------------------
64
65    /** @returns
66                    the type of an attribute in the list (by position).
67                    Non-validating parsers may return CDATA only.
68     */
69    string getTypeByIndex( [in] short i );
70
71    //-------------------------------------------------------------------------
72
73    /** @returns
74                    the type of an attribute in the list (by name).
75                    Non-validating parsers may return CDATA only.
76     */
77    string getTypeByName( [in] string aName );
78
79    //-------------------------------------------------------------------------
80
81    /** @returns
82                    the value of an attribute in the list (by position).
83     */
84    string getValueByIndex( [in] short i );
85
86    //-------------------------------------------------------------------------
87
88    /** @returns
89                    the value of an attribute in the list (by name).
90     */
91    string getValueByName( [in] string aName );
92};
93
94//=============================================================================
95
96}; }; }; }; };
97
98#endif
99