summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/xml/sax/XAttributeList.idl
blob: abafe7a9aca953f9b5e00e3457347194871b933e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
/*************************************************************************
 *
 *  $RCSfile: XAttributeList.idl,v $
 *
 *  $Revision: 1.5 $
 *
 *  last change: $Author: mi $ $Date: 2002-10-03 13:11:18 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (the "License"); You may not use this file
 *  except in compliance with the License. You may obtain a copy of the
 *  License at http://www.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/
#ifndef __com_sun_star_xml_sax_XAttributeList_idl__
#define __com_sun_star_xml_sax_XAttributeList_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

//=============================================================================

module com {  module sun {  module star {  module xml {  module sax {

//=============================================================================

/** specifies an element's attributes.

    <p>This interface describes a name-type-value triple which describes a
    single attribute of a tag. Implementors are encouraged to implement the
    <type scope="com::sun::star::util">XCloneable</type> interface also to
    allow the user to make a copy of the instance.

    </p>
    <p>This interface is an IDL version of the Java interface
    <em>org.xml.sax.AttributeList</em>.</p>
 */
interface XAttributeList: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------

    /** @returns
                    the number of attributes in this list.
     */
    short getLength();

    //-------------------------------------------------------------------------

    /** @returns
                    the name of an attribute in this list (by position).
     */
    string getNameByIndex( [in] short i );

    //-------------------------------------------------------------------------

    /** @returns
                    the type of an attribute in the list (by position).
                    Non-validating parsers may return CDATA only.
     */
    string getTypeByIndex( [in] short i );

    //-------------------------------------------------------------------------

    /** @returns
                    the type of an attribute in the list (by name).
                    Non-validating parsers may return CDATA only.
     */
    string getTypeByName( [in] string aName );

    //-------------------------------------------------------------------------

    /** @returns
                    the value of an attribute in the list (by position).
     */
    string getValueByIndex( [in] short i );

    //-------------------------------------------------------------------------

    /** @returns
                    the value of an attribute in the list (by name).
     */
    string getValueByName( [in] string aName );
};

//=============================================================================

}; }; }; }; };

#endif