XQuilla/docs/dom3-api/DOMRange_8hpp-source.html
2020-02-17 22:19:08 +01:00

149 lines
12 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>XQilla DOM3 API Documentation</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<a style="float:right;" href="http://sourceforge.net/projects/xqilla"><img src="http://sflogo.sourceforge.net/sflogo.php?group_id=152021&amp;type=2" border="0" alt="SourceForge.net Logo" /></a>
<!-- Generated by Doxygen 1.3.9.1 -->
<div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="namespacemembers.html">Namespace&nbsp;Members</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a> | <a class="qindex" href="examples.html">Examples</a></div>
<div class="nav">
<a class="el" href="dir_000000.html">xerces-c-3.0.1</a>&nbsp;/&nbsp;<a class="el" href="dir_000001.html">src</a>&nbsp;/&nbsp;<a class="el" href="dir_000002.html">xercesc</a>&nbsp;/&nbsp;<a class="el" href="dir_000003.html">dom</a></div>
<h1>DOMRange.hpp</h1><a href="DOMRange_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment">00001 <span class="comment">/*</span>
00002 <span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</span>
00003 <span class="comment"> * contributor license agreements. See the NOTICE file distributed with</span>
00004 <span class="comment"> * this work for additional information regarding copyright ownership.</span>
00005 <span class="comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</span>
00006 <span class="comment"> * (the "License"); you may not use this file except in compliance with</span>
00007 <span class="comment"> * the License. You may obtain a copy of the License at</span>
00008 <span class="comment"> * </span>
00009 <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span>
00010 <span class="comment"> * </span>
00011 <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span>
00012 <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span>
00013 <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
00014 <span class="comment"> * See the License for the specific language governing permissions and</span>
00015 <span class="comment"> * limitations under the License.</span>
00016 <span class="comment"> */</span>
00017
00018 <span class="comment">/*</span>
00019 <span class="comment"> * $Id: DOMRange.hpp 527149 2007-04-10 14:56:39Z amassari $</span>
00020 <span class="comment"> */</span>
00021
00022 <span class="preprocessor">#if !defined(XERCESC_INCLUDE_GUARD_DOMRANGE_HPP)</span>
<a name="l00023"></a><a class="code" href="DOMRange_8hpp.html#a0">00023</a> <span class="preprocessor"></span><span class="preprocessor">#define XERCESC_INCLUDE_GUARD_DOMRANGE_HPP</span>
00024 <span class="preprocessor"></span>
00025 <span class="preprocessor">#include &lt;xercesc/util/XercesDefs.hpp&gt;</span>
00026
00027 XERCES_CPP_NAMESPACE_BEGIN
00028
00029 <span class="keyword">class </span>DOMNode;
00030 <span class="keyword">class </span>DOMDocumentFragment;
00031
<a name="l00036"></a><a class="code" href="classxercesc_1_1DOMRange.html">00036</a> <span class="keyword">class </span>CDOM_EXPORT DOMRange {
00037 <span class="keyword">protected</span>:
00038 <span class="comment">// -----------------------------------------------------------------------</span>
00039 <span class="comment">// Hidden constructors</span>
00040 <span class="comment">// -----------------------------------------------------------------------</span>
<a name="l00043"></a><a class="code" href="classxercesc_1_1DOMRange.html#z399_0">00043</a> <span class="comment"></span> DOMRange() {}
<a name="l00044"></a><a class="code" href="classxercesc_1_1DOMRange.html#z399_1">00044</a> DOMRange(<span class="keyword">const</span> DOMRange &amp;) {}
00046
00047 <span class="keyword">private</span>:
00048 <span class="comment">// -----------------------------------------------------------------------</span>
00049 <span class="comment">// Unimplemented constructors and operators</span>
00050 <span class="comment">// -----------------------------------------------------------------------</span>
00053 <span class="comment"></span> DOMRange &amp; operator = (<span class="keyword">const</span> DOMRange &amp;);
00055
00056 <span class="keyword">public</span>:
00057 <span class="comment">// -----------------------------------------------------------------------</span>
00058 <span class="comment">// All constructors are hidden, just the destructor is available</span>
00059 <span class="comment">// -----------------------------------------------------------------------</span>
<a name="l00066"></a><a class="code" href="classxercesc_1_1DOMRange.html#z403_0">00066</a> <span class="comment"></span> <span class="keyword">virtual</span> ~DOMRange() {};
00068
00069 <span class="comment">// -----------------------------------------------------------------------</span>
00070 <span class="comment">// Class Types</span>
00071 <span class="comment">// -----------------------------------------------------------------------</span>
<a name="l00099"></a><a class="code" href="classxercesc_1_1DOMRange.html#z405_0">00099</a> <span class="comment"></span> <span class="keyword">enum</span> CompareHow {
00100 START_TO_START = 0,
00101 START_TO_END = 1,
00102 END_TO_END = 2,
00103 END_TO_START = 3
00104 };
00105
00107
00108 <span class="comment">// -----------------------------------------------------------------------</span>
00109 <span class="comment">// Virtual DOMRange interface</span>
00110 <span class="comment">// -----------------------------------------------------------------------</span>
00113 <span class="comment"></span> <span class="comment">// -----------------------------------------------------------------------</span>
00114 <span class="comment">// Getter methods</span>
00115 <span class="comment">// -----------------------------------------------------------------------</span>
00124 <span class="comment"></span> <span class="keyword">virtual</span> <a class="code" href="classxercesc_1_1DOMNode.html">DOMNode</a>* getStartContainer() <span class="keyword">const </span>= 0;
00125
00134 <span class="keyword">virtual</span> XMLSize_t getStartOffset() <span class="keyword">const </span>= 0;
00135
00144 <span class="keyword">virtual</span> <a class="code" href="classxercesc_1_1DOMNode.html">DOMNode</a>* getEndContainer() <span class="keyword">const </span>= 0;
00145
00154 <span class="keyword">virtual</span> XMLSize_t getEndOffset() <span class="keyword">const </span>= 0;
00155
00164 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> getCollapsed() <span class="keyword">const </span>= 0;
00165
00175 <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="code" href="classxercesc_1_1DOMNode.html">DOMNode</a>* getCommonAncestorContainer() <span class="keyword">const </span>= 0;
00176
00177 <span class="comment">// -----------------------------------------------------------------------</span>
00178 <span class="comment">// Setter methods</span>
00179 <span class="comment">// -----------------------------------------------------------------------</span>
00202 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> setStart(<span class="keyword">const</span> <a class="code" href="classxercesc_1_1DOMNode.html">DOMNode</a> *refNode, XMLSize_t offset) = 0;
00203
00226 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setEnd(<span class="keyword">const</span> <a class="code" href="classxercesc_1_1DOMNode.html">DOMNode</a> *refNode, XMLSize_t offset) = 0;
00227
00244 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setStartBefore(<span class="keyword">const</span> <a class="code" href="classxercesc_1_1DOMNode.html">DOMNode</a> *refNode) = 0;
00245
00262 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setStartAfter(<span class="keyword">const</span> <a class="code" href="classxercesc_1_1DOMNode.html">DOMNode</a> *refNode) = 0;
00263
00280 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setEndBefore(<span class="keyword">const</span> <a class="code" href="classxercesc_1_1DOMNode.html">DOMNode</a> *refNode) = 0;
00281
00298 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setEndAfter(<span class="keyword">const</span> <a class="code" href="classxercesc_1_1DOMNode.html">DOMNode</a> *refNode) = 0;
00299
00300 <span class="comment">// -----------------------------------------------------------------------</span>
00301 <span class="comment">// Misc methods</span>
00302 <span class="comment">// -----------------------------------------------------------------------</span>
00313 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> collapse(<span class="keywordtype">bool</span> toStart) = 0;
00314
00331 <span class="keyword">virtual</span> <span class="keywordtype">void</span> selectNode(<span class="keyword">const</span> <a class="code" href="classxercesc_1_1DOMNode.html">DOMNode</a> *refNode) = 0;
00332
00347 <span class="keyword">virtual</span> <span class="keywordtype">void</span> selectNodeContents(<span class="keyword">const</span> <a class="code" href="classxercesc_1_1DOMNode.html">DOMNode</a> *refNode) = 0;
00348
00366 <span class="keyword">virtual</span> <span class="keywordtype">short</span> compareBoundaryPoints(CompareHow how, <span class="keyword">const</span> DOMRange* sourceRange) <span class="keyword">const </span>= 0;
00367
00381 <span class="keyword">virtual</span> <span class="keywordtype">void</span> deleteContents() = 0;
00382
00398 <span class="keyword">virtual</span> <a class="code" href="classxercesc_1_1DOMDocumentFragment.html">DOMDocumentFragment</a>* extractContents() = 0;
00399
00412 <span class="keyword">virtual</span> <a class="code" href="classxercesc_1_1DOMDocumentFragment.html">DOMDocumentFragment</a>* cloneContents() <span class="keyword">const </span>= 0;
00413
00442 <span class="keyword">virtual</span> <span class="keywordtype">void</span> insertNode(<a class="code" href="classxercesc_1_1DOMNode.html">DOMNode</a> *newNode) = 0;
00443
00469 <span class="keyword">virtual</span> <span class="keywordtype">void</span> surroundContents(<a class="code" href="classxercesc_1_1DOMNode.html">DOMNode</a> *newParent) = 0;
00470
00481 <span class="keyword">virtual</span> DOMRange* cloneRange() <span class="keyword">const </span>= 0;
00482
00493 <span class="keyword">virtual</span> <span class="keyword">const</span> XMLCh* toString() <span class="keyword">const </span>= 0;
00494
00507 <span class="keyword">virtual</span> <span class="keywordtype">void</span> detach() = 0;
00508
00510
00511 <span class="comment">// -----------------------------------------------------------------------</span>
00512 <span class="comment">// Non-standard Extension</span>
00513 <span class="comment">// -----------------------------------------------------------------------</span>
00523 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> release() = 0;
00525 };
00526
00527
00528 XERCES_CPP_NAMESPACE_END
00529
00530 <span class="preprocessor">#endif</span>
</pre></div><hr size="1"><address style="align: right;"><small>Generated on Fri Sep 25 06:55:48 2009 for XQilla DOM Level 3 API by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.3.9.1 </small></address>
</body>
</html>