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