offapi/com/sun/star/xml/dom/XAttr.idl

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