offapi/com/sun/star/xml/dom/XNamedNodeMap.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_XNamedNodeMap_idl__
  21 #define __com_sun_star_xml_dom_XNamedNodeMap_idl__
  22
  23 #include <com/sun/star/uno/XInterface.idl>
  24 #include <com/sun/star/xml/dom/DOMException.idl>
  25
  26 module com { module sun { module star { module xml { module dom {
  27
  28 interface XNode;
  29
  30 interface XNamedNodeMap : com::sun::star::uno::XInterface
  31 {
  32
  33     /**
  34     The number of nodes in this map.
  35     */
  36     long getLength();
  37
  38     /**
  39     Retrieves a node specified by local name.
  40     */
  41     XNode getNamedItem([in] string name);
  42
  43     /**
  44     Retrieves a node specified by local name and namespace URI.
  45     */
  46     XNode getNamedItemNS([in] string namespaceURI,[in]  string localName);
  47
  48     /**
  49     Returns a node specified by index.
  50     */
  51     XNode item([in] long index);
  52
  53     /**
  54     Removes a node specified by name.
  55     Throws:
  56     DOMException - NOT_FOUND_ERR: Raised if there is no node named name in this map.
  57     NO_MODIFICATION_ALLOWED_ERR: Raised if this map is readonly.
  58     */
  59     XNode removeNamedItem([in] string name) raises (DOMException);
  60
  61     /**
  62     Removes a node specified by local name and namespace URI.
  63     Throws:
  64     DOMException - NOT_FOUND_ERR: Raised if there is no node with the specified namespaceURI and localName in this map.
  65     NO_MODIFICATION_ALLOWED_ERR: Raised if this map is readonly.
  66     */
  67     XNode removeNamedItemNS([in] string namespaceURI, [in] string localName) raises (DOMException);
  68
  69     /**
  70     Adds a node using its nodeName attribute.
  71     Throws:
  72     DOMException - WRONG_DOCUMENT_ERR: Raised if arg was created from a different document than the one that created this map.
  73     NO_MODIFICATION_ALLOWED_ERR: Raised if this map is readonly.
  74     INUSE_ATTRIBUTE_ERR: Raised if arg is an Attr that is already an attribute of another Element object. The DOM user must explicitly clone Attr nodes to re-use them in other elements.
  75     HIERARCHY_REQUEST_ERR: Raised if an attempt is made to add a node doesn't belong in this NamedNodeMap. Examples would include trying to insert something other than an Attr node into an Element's map of attributes, or a non-Entity node into the DocumentType's map of Entities.
  76     */
  77     XNode setNamedItem([in] XNode arg) raises (DOMException);
  78
  79     /**
  80     Adds a node using its namespaceURI and localName.
  81     Throws:
  82     DOMException - WRONG_DOCUMENT_ERR: Raised if arg was created from a different document than the one that created this map.
  83     NO_MODIFICATION_ALLOWED_ERR: Raised if this map is readonly.
  84     INUSE_ATTRIBUTE_ERR: Raised if arg is an Attr that is already an attribute of another Element object. The DOM user must explicitly clone Attr nodes to re-use them in other elements.
  85     HIERARCHY_REQUEST_ERR: Raised if an attempt is made to add a node doesn't belong in this NamedNodeMap. Examples would include trying to insert something other than an Attr node into an Element's map of attributes, or a non-Entity node into the DocumentType's map of Entities.
  86     NOT_SUPPORTED_ERR: Always thrown if the current document does not support the "XML" feature, since namespaces were defined by XML.
  87     */
  88     XNode setNamedItemNS([in] XNode arg) raises (DOMException);
  89 };
  90 }; }; }; }; };
  91
  92 #endif
  93
  94 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */