offapi/com/sun/star/xml/dom/XCharacterData.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_XCharacterData_idl__
  21 #define __com_sun_star_xml_dom_XCharacterData_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 XCharacterData: XNode
  28 {
  29     /**
  30     Append the string to the end of the character data of the node.
  31     Throws:
  32         DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
  33     */
  34     void appendData([in] string arg) raises (DOMException);
  35
  36     /**
  37     Remove a range of 16-bit units from the node.
  38     Throws:
  39         DOMException - INDEX_SIZE_ERR: Raised if the specified offset is negative or greater
  40             than the number of 16-bit units in data, or if the specified count is negative.
  41         NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
  42     */
  43     void deleteData([in] long offset, [in] long count) raises (DOMException);
  44
  45     /**
  46     Return the character data of the node that implements this interface.
  47     Throws:
  48         DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
  49         DOMException - DOMSTRING_SIZE_ERR: Raised when it would return more characters
  50             than fit in a DOMString variable on the implementation platform.
  51
  52
  53     */
  54     string getData() raises (DOMException);
  55
  56     /**
  57     The number of 16-bit units that are available through data and the
  58     substringData method below.
  59     */
  60     long getLength();
  61
  62     /**
  63     Insert a string at the specified 16-bit unit offset.
  64     Throws:
  65     DOMException - INDEX_SIZE_ERR: Raised if the specified offset is negative or greater than
  66                                    the number of 16-bit units in data.
  67                    NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
  68     */
  69     void insertData([in] long offset, [in] string arg) raises (DOMException);
  70
  71     /**
  72     Replace the characters starting at the specified 16-bit unit offset
  73     with the specified string.
  74     Throws;
  75     DOMException - INDEX_SIZE_ERR: Raised if the specified offset is negative or greater than
  76                       the number of 16-bit units in data, or if the specified count is negative.
  77                    NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
  78     */
  79     void replaceData([in] long offset, [in] long count, [in] string arg) raises (DOMException);
  80
  81     /**
  82     Set the character data of the node that implements this interface.
  83     Throws:
  84         DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
  85         DOMException - DOMSTRING_SIZE_ERR: Raised when it would return more characters than
  86             fit in a DOMString variable on the implementation platform.
  87     */
  88     void setData([in] string data) raises (DOMException);
  89
  90     /**
  91     Extracts a range of data from the node.
  92     Throws:
  93         DOMException - INDEX_SIZE_ERR: Raised if the specified offset is negative or greater
  94             than the number of 16-bit units in data, or if the specified count is negative.
  95         DOMSTRING_SIZE_ERR: Raised if the specified range of text does not fit into a DOMString.
  96     */
  97     string subStringData([in] long offset, [in] long count) raises (DOMException);
  98
  99 };
 100 };};};};};
 101
 102 #endif
 103
 104 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */