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