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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_xml_dom_XAttr_idl__
  21 #define __com_sun_star_xml_dom_XAttr_idl__
  22
  23 #include <com/sun/star/xml/dom/XNode.idl>
  24
  25 module com { module sun { module star { module xml { module dom {
  26
  27 interface XElement;
  28
  29 interface XAttr: XNode
  30 {
  31     /**
  32     Returns the name of this attribute.
  33     */
  34     string getName();
  35
  36     /**
  37     The Element node this attribute is attached to or null if this
  38     attribute is not in use.
  39     */
  40     XElement getOwnerElement();
  41
  42     /**
  43     If this attribute was explicitly given a value in the original
  44     document, this is true; otherwise, it is false.
  45     */
  46     boolean getSpecified();
  47
  48     /**
  49     On retrieval, the value of the attribute is returned as a string.
  50     */
  51     string getValue();
  52
  53     /**
  54     Sets the value of the attribute from a string.
  55     Throws:
  56         DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
  57
  58     */
  59     void setValue([in] string value) raises (DOMException);
  60 };
  61 };};};};};
  62
  63 #endif
  64
  65 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */