xref: /trunk/main/offapi/com/sun/star/xml/dom/XAttr.idl (revision cdf0e10c) 
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
28#ifndef __com_sun_star_xml_dom_XAttr_idl__
29#define __com_sun_star_xml_sax_XAttr_idl__
30
31#ifndef __com_sun_star_xml_dom_XNode_idl__
32#include <com/sun/star/xml/dom/XNode.idl>
33#endif
34
35module com { module sun { module star { module xml { module dom {
36
37interface XElement;
38
39interface XAttr: XNode
40{
41    /**
42    Returns the name of this attribute.
43    */
44    string getName();
45
46    /**
47    The Element node this attribute is attached to or null if this
48    attribute is not in use.
49    */
50    XElement getOwnerElement();
51
52    /**
53    If this attribute was explicitly given a value in the original
54    document, this is true; otherwise, it is false.
55    */
56    boolean getSpecified();
57
58    /**
59    On retrieval, the value of the attribute is returned as a string.
60    */
61    string getValue();
62
63    /**
64    Sets the value of the attribute from a string.
65    Throws:
66        DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
67
68    */
69    void setValue([in] string value) raises (DOMException);
70};
71};};};};};
72
73#endif
74