xref: /trunk/main/offapi/com/sun/star/xml/dom/XAttr.idl (revision d1766043)
1*d1766043SAndrew Rist/**************************************************************
2cdf0e10cSrcweir *
3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
4*d1766043SAndrew Rist * or more contributor license agreements.  See the NOTICE file
5*d1766043SAndrew Rist * distributed with this work for additional information
6*d1766043SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the
8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance
9*d1766043SAndrew Rist * with the License.  You may obtain a copy of the License at
10*d1766043SAndrew Rist *
11*d1766043SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
12*d1766043SAndrew Rist *
13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing,
14*d1766043SAndrew Rist * software distributed under the License is distributed on an
15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*d1766043SAndrew Rist * KIND, either express or implied.  See the License for the
17*d1766043SAndrew Rist * specific language governing permissions and limitations
18*d1766043SAndrew Rist * under the License.
19*d1766043SAndrew Rist *
20*d1766043SAndrew Rist *************************************************************/
21*d1766043SAndrew Rist
22*d1766043SAndrew Rist
23cdf0e10cSrcweir
24cdf0e10cSrcweir#ifndef __com_sun_star_xml_dom_XAttr_idl__
25cdf0e10cSrcweir#define __com_sun_star_xml_sax_XAttr_idl__
26cdf0e10cSrcweir
27cdf0e10cSrcweir#ifndef __com_sun_star_xml_dom_XNode_idl__
28cdf0e10cSrcweir#include <com/sun/star/xml/dom/XNode.idl>
29cdf0e10cSrcweir#endif
30cdf0e10cSrcweir
31cdf0e10cSrcweirmodule com { module sun { module star { module xml { module dom {
32cdf0e10cSrcweir
33cdf0e10cSrcweirinterface XElement;
34cdf0e10cSrcweir
35cdf0e10cSrcweirinterface XAttr: XNode
36cdf0e10cSrcweir{
37cdf0e10cSrcweir    /**
38cdf0e10cSrcweir    Returns the name of this attribute.
39cdf0e10cSrcweir    */
40cdf0e10cSrcweir    string getName();
41cdf0e10cSrcweir
42cdf0e10cSrcweir    /**
43cdf0e10cSrcweir    The Element node this attribute is attached to or null if this
44cdf0e10cSrcweir    attribute is not in use.
45cdf0e10cSrcweir    */
46cdf0e10cSrcweir    XElement getOwnerElement();
47cdf0e10cSrcweir
48cdf0e10cSrcweir    /**
49cdf0e10cSrcweir    If this attribute was explicitly given a value in the original
50cdf0e10cSrcweir    document, this is true; otherwise, it is false.
51cdf0e10cSrcweir    */
52cdf0e10cSrcweir    boolean getSpecified();
53cdf0e10cSrcweir
54cdf0e10cSrcweir    /**
55cdf0e10cSrcweir    On retrieval, the value of the attribute is returned as a string.
56cdf0e10cSrcweir    */
57cdf0e10cSrcweir    string getValue();
58cdf0e10cSrcweir
59cdf0e10cSrcweir    /**
60cdf0e10cSrcweir    Sets the value of the attribute from a string.
61cdf0e10cSrcweir    Throws:
62cdf0e10cSrcweir        DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
63cdf0e10cSrcweir
64cdf0e10cSrcweir    */
65cdf0e10cSrcweir    void setValue([in] string value) raises (DOMException);
66cdf0e10cSrcweir};
67cdf0e10cSrcweir};};};};};
68cdf0e10cSrcweir
69cdf0e10cSrcweir#endif
70