summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/xml/dom/XAttr.idl
blob: ee50368dd5f401e15fba5a96cbd4139a26f7bbbd (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
/************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2008 by Sun Microsystems, Inc.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * $RCSfile: XAttr.idl,v $
 * $Revision: 1.4 $
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org 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 version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#ifndef __com_sun_star_xml_dom_XAttr_idl__
#define __com_sun_star_xml_sax_XAttr_idl__

#ifndef __com_sun_star_xml_dom_XNode_idl__
#include <com/sun/star/xml/dom/XNode.idl>
#endif

module com { module sun { module star { module xml { module dom {

interface XElement;

interface XAttr: XNode
{
    /**
    Returns the name of this attribute.
    */
    string getName();

    /**
    The Element node this attribute is attached to or null if this
    attribute is not in use.
    */
    XElement getOwnerElement();

    /**
    If this attribute was explicitly given a value in the original
    document, this is true; otherwise, it is false.
    */
    boolean getSpecified();

    /**
    On retrieval, the value of the attribute is returned as a string.
    */
    string getValue();

    /**
    Sets the value of the attribute from a string.
    Throws:
        DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.

    */
    void setValue([in] string value) raises (DOMException);
};
};};};};};

#endif