summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/xml/sax/XAttributeList.idl
blob: 51924375edcbf584a6bbba12c0a5b36fa6579d41 (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
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 .
 */
#ifndef __com_sun_star_xml_sax_XAttributeList_idl__
#define __com_sun_star_xml_sax_XAttributeList_idl__

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


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
    com::sun::star::util::XCloneable interface also to
    allow the user to make a copy of the instance.

    </p>
    <p>This interface is a poor IDL version of the Java interface
    <em>org.xml.sax.AttributeList</em>.  For example in getValueByName, it does
    not allow to distinguish a missing value (for which the Java interface
    returns null) from an empty string value.</p>
 */
published 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

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */