xref: /trunk/main/offapi/com/sun/star/xml/dom/XAttr.idl (revision cdf0e10c)
1*cdf0e10cSrcweir/************************************************************************
2*cdf0e10cSrcweir *
3*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4*cdf0e10cSrcweir *
5*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates.
6*cdf0e10cSrcweir *
7*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite
8*cdf0e10cSrcweir *
9*cdf0e10cSrcweir * This file is part of OpenOffice.org.
10*cdf0e10cSrcweir *
11*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify
12*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3
13*cdf0e10cSrcweir * only, as published by the Free Software Foundation.
14*cdf0e10cSrcweir *
15*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful,
16*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of
17*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details
19*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code).
20*cdf0e10cSrcweir *
21*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License
22*cdf0e10cSrcweir * version 3 along with OpenOffice.org.  If not, see
23*cdf0e10cSrcweir * <http://www.openoffice.org/license.html>
24*cdf0e10cSrcweir * for a copy of the LGPLv3 License.
25*cdf0e10cSrcweir *
26*cdf0e10cSrcweir ************************************************************************/
27*cdf0e10cSrcweir
28*cdf0e10cSrcweir#ifndef __com_sun_star_xml_dom_XAttr_idl__
29*cdf0e10cSrcweir#define __com_sun_star_xml_sax_XAttr_idl__
30*cdf0e10cSrcweir
31*cdf0e10cSrcweir#ifndef __com_sun_star_xml_dom_XNode_idl__
32*cdf0e10cSrcweir#include <com/sun/star/xml/dom/XNode.idl>
33*cdf0e10cSrcweir#endif
34*cdf0e10cSrcweir
35*cdf0e10cSrcweirmodule com { module sun { module star { module xml { module dom {
36*cdf0e10cSrcweir
37*cdf0e10cSrcweirinterface XElement;
38*cdf0e10cSrcweir
39*cdf0e10cSrcweirinterface XAttr: XNode
40*cdf0e10cSrcweir{
41*cdf0e10cSrcweir    /**
42*cdf0e10cSrcweir    Returns the name of this attribute.
43*cdf0e10cSrcweir    */
44*cdf0e10cSrcweir    string getName();
45*cdf0e10cSrcweir
46*cdf0e10cSrcweir    /**
47*cdf0e10cSrcweir    The Element node this attribute is attached to or null if this
48*cdf0e10cSrcweir    attribute is not in use.
49*cdf0e10cSrcweir    */
50*cdf0e10cSrcweir    XElement getOwnerElement();
51*cdf0e10cSrcweir
52*cdf0e10cSrcweir    /**
53*cdf0e10cSrcweir    If this attribute was explicitly given a value in the original
54*cdf0e10cSrcweir    document, this is true; otherwise, it is false.
55*cdf0e10cSrcweir    */
56*cdf0e10cSrcweir    boolean getSpecified();
57*cdf0e10cSrcweir
58*cdf0e10cSrcweir    /**
59*cdf0e10cSrcweir    On retrieval, the value of the attribute is returned as a string.
60*cdf0e10cSrcweir    */
61*cdf0e10cSrcweir    string getValue();
62*cdf0e10cSrcweir
63*cdf0e10cSrcweir    /**
64*cdf0e10cSrcweir    Sets the value of the attribute from a string.
65*cdf0e10cSrcweir    Throws:
66*cdf0e10cSrcweir        DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
67*cdf0e10cSrcweir
68*cdf0e10cSrcweir    */
69*cdf0e10cSrcweir    void setValue([in] string value) raises (DOMException);
70*cdf0e10cSrcweir};
71*cdf0e10cSrcweir};};};};};
72*cdf0e10cSrcweir
73*cdf0e10cSrcweir#endif
74