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