163 lines
17 KiB
HTML
163 lines
17 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&type=2" border="0" alt="SourceForge.net Logo" /></a>
|
|
<!-- Generated by Doxygen 1.6.1 -->
|
|
<div class="navigation" id="top">
|
|
<div class="tabs">
|
|
<ul>
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
|
|
<li><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li class="current"><a href="files.html"><span>Files</span></a></li>
|
|
<li><a href="examples.html"><span>Examples</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="tabs">
|
|
<ul>
|
|
<li><a href="files.html"><span>File List</span></a></li>
|
|
<li><a href="globals.html"><span>File Members</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<h1>DOMRange.hpp</h1><a href="DOMRange_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
|
|
<a name="l00002"></a>00002 <span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</span>
|
|
<a name="l00003"></a>00003 <span class="comment"> * contributor license agreements. See the NOTICE file distributed with</span>
|
|
<a name="l00004"></a>00004 <span class="comment"> * this work for additional information regarding copyright ownership.</span>
|
|
<a name="l00005"></a>00005 <span class="comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</span>
|
|
<a name="l00006"></a>00006 <span class="comment"> * (the "License"); you may not use this file except in compliance with</span>
|
|
<a name="l00007"></a>00007 <span class="comment"> * the License. You may obtain a copy of the License at</span>
|
|
<a name="l00008"></a>00008 <span class="comment"> * </span>
|
|
<a name="l00009"></a>00009 <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span>
|
|
<a name="l00010"></a>00010 <span class="comment"> * </span>
|
|
<a name="l00011"></a>00011 <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span>
|
|
<a name="l00012"></a>00012 <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span>
|
|
<a name="l00013"></a>00013 <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
|
|
<a name="l00014"></a>00014 <span class="comment"> * See the License for the specific language governing permissions and</span>
|
|
<a name="l00015"></a>00015 <span class="comment"> * limitations under the License.</span>
|
|
<a name="l00016"></a>00016 <span class="comment"> */</span>
|
|
<a name="l00017"></a>00017
|
|
<a name="l00018"></a>00018 <span class="comment">/*</span>
|
|
<a name="l00019"></a>00019 <span class="comment"> * $Id: DOMRange.hpp 527149 2007-04-10 14:56:39Z amassari $</span>
|
|
<a name="l00020"></a>00020 <span class="comment"> */</span>
|
|
<a name="l00021"></a>00021
|
|
<a name="l00022"></a>00022 <span class="preprocessor">#if !defined(XERCESC_INCLUDE_GUARD_DOMRANGE_HPP)</span>
|
|
<a name="l00023"></a><a class="code" href="DOMRange_8hpp.html#a735b5230d67f7022d16793e3d64c9e1c">00023</a> <span class="preprocessor"></span><span class="preprocessor">#define XERCESC_INCLUDE_GUARD_DOMRANGE_HPP</span>
|
|
<a name="l00024"></a>00024 <span class="preprocessor"></span>
|
|
<a name="l00025"></a>00025 <span class="preprocessor">#include <xercesc/util/XercesDefs.hpp></span>
|
|
<a name="l00026"></a>00026
|
|
<a name="l00027"></a>00027 XERCES_CPP_NAMESPACE_BEGIN
|
|
<a name="l00028"></a>00028
|
|
<a name="l00029"></a>00029 <span class="keyword">class </span>DOMNode;
|
|
<a name="l00030"></a>00030 <span class="keyword">class </span>DOMDocumentFragment;
|
|
<a name="l00031"></a>00031
|
|
<a name="l00036"></a><a class="code" href="classxercesc_1_1DOMRange.html">00036</a> <span class="keyword">class </span>CDOM_EXPORT <a class="code" href="classxercesc_1_1DOMRange.html">DOMRange</a> {
|
|
<a name="l00037"></a>00037 <span class="keyword">protected</span>:
|
|
<a name="l00038"></a>00038 <span class="comment">// -----------------------------------------------------------------------</span>
|
|
<a name="l00039"></a>00039 <span class="comment">// Hidden constructors</span>
|
|
<a name="l00040"></a>00040 <span class="comment">// -----------------------------------------------------------------------</span>
|
|
<a name="l00043"></a><a class="code" href="classxercesc_1_1DOMRange.html#a55cc14fcbe9b32c109689bc33f7ca425">00043</a> <span class="comment"></span> <a class="code" href="classxercesc_1_1DOMRange.html#a55cc14fcbe9b32c109689bc33f7ca425">DOMRange</a>() {}
|
|
<a name="l00044"></a><a class="code" href="classxercesc_1_1DOMRange.html#a53db0c08257f4bbeb3b9597f656dd31d">00044</a> <a class="code" href="classxercesc_1_1DOMRange.html#a53db0c08257f4bbeb3b9597f656dd31d">DOMRange</a>(<span class="keyword">const</span> <a class="code" href="classxercesc_1_1DOMRange.html">DOMRange</a> &) {}
|
|
<a name="l00046"></a>00046
|
|
<a name="l00047"></a>00047 <span class="keyword">private</span>:
|
|
<a name="l00048"></a>00048 <span class="comment">// -----------------------------------------------------------------------</span>
|
|
<a name="l00049"></a>00049 <span class="comment">// Unimplemented constructors and operators</span>
|
|
<a name="l00050"></a>00050 <span class="comment">// -----------------------------------------------------------------------</span>
|
|
<a name="l00053"></a>00053 <span class="comment"></span> <a class="code" href="classxercesc_1_1DOMRange.html">DOMRange</a> & operator = (<span class="keyword">const</span> <a class="code" href="classxercesc_1_1DOMRange.html">DOMRange</a> &);
|
|
<a name="l00055"></a>00055
|
|
<a name="l00056"></a>00056 <span class="keyword">public</span>:
|
|
<a name="l00057"></a>00057 <span class="comment">// -----------------------------------------------------------------------</span>
|
|
<a name="l00058"></a>00058 <span class="comment">// All constructors are hidden, just the destructor is available</span>
|
|
<a name="l00059"></a>00059 <span class="comment">// -----------------------------------------------------------------------</span>
|
|
<a name="l00066"></a><a class="code" href="classxercesc_1_1DOMRange.html#a6911af3e9b1a093ea192be117aa57119">00066</a> <span class="comment"></span> <span class="keyword">virtual</span> <a class="code" href="classxercesc_1_1DOMRange.html#a6911af3e9b1a093ea192be117aa57119" title="Destructor.">~DOMRange</a>() {};
|
|
<a name="l00068"></a>00068
|
|
<a name="l00069"></a>00069 <span class="comment">// -----------------------------------------------------------------------</span>
|
|
<a name="l00070"></a>00070 <span class="comment">// Class Types</span>
|
|
<a name="l00071"></a>00071 <span class="comment">// -----------------------------------------------------------------------</span>
|
|
<a name="l00099"></a><a class="code" href="classxercesc_1_1DOMRange.html#aa09aef968bc14cd4a17a64e9909c24a8">00099</a> <span class="comment"></span> <span class="keyword">enum</span> <a class="code" href="classxercesc_1_1DOMRange.html#aa09aef968bc14cd4a17a64e9909c24a8" title="Constants CompareHow.">CompareHow</a> {
|
|
<a name="l00100"></a><a class="code" href="classxercesc_1_1DOMRange.html#aa09aef968bc14cd4a17a64e9909c24a8a9649fea7f983f05b75a95f22e16667f9">00100</a> START_TO_START = 0,
|
|
<a name="l00101"></a><a class="code" href="classxercesc_1_1DOMRange.html#aa09aef968bc14cd4a17a64e9909c24a8ac6b5ab309618a64b8a5b06de2ef91530">00101</a> START_TO_END = 1,
|
|
<a name="l00102"></a><a class="code" href="classxercesc_1_1DOMRange.html#aa09aef968bc14cd4a17a64e9909c24a8a60fca29ffc73ba8037e7e15a839a4019">00102</a> END_TO_END = 2,
|
|
<a name="l00103"></a><a class="code" href="classxercesc_1_1DOMRange.html#aa09aef968bc14cd4a17a64e9909c24a8a791b1951bc5f462ace1e30acc5a4c261">00103</a> END_TO_START = 3
|
|
<a name="l00104"></a>00104 };
|
|
<a name="l00105"></a>00105
|
|
<a name="l00107"></a>00107
|
|
<a name="l00108"></a>00108 <span class="comment">// -----------------------------------------------------------------------</span>
|
|
<a name="l00109"></a>00109 <span class="comment">// Virtual DOMRange interface</span>
|
|
<a name="l00110"></a>00110 <span class="comment">// -----------------------------------------------------------------------</span>
|
|
<a name="l00113"></a>00113 <span class="comment"></span> <span class="comment">// -----------------------------------------------------------------------</span>
|
|
<a name="l00114"></a>00114 <span class="comment">// Getter methods</span>
|
|
<a name="l00115"></a>00115 <span class="comment">// -----------------------------------------------------------------------</span>
|
|
<a name="l00124"></a>00124 <span class="comment"></span> <span class="keyword">virtual</span> <a class="code" href="classxercesc_1_1DOMNode.html" title="The DOMNode interface is the primary datatype for the entire Document Object Model...">DOMNode</a>* getStartContainer() <span class="keyword">const</span> = 0;
|
|
<a name="l00125"></a>00125
|
|
<a name="l00134"></a>00134 <span class="keyword">virtual</span> XMLSize_t getStartOffset() <span class="keyword">const</span> = 0;
|
|
<a name="l00135"></a>00135
|
|
<a name="l00144"></a>00144 <span class="keyword">virtual</span> <a class="code" href="classxercesc_1_1DOMNode.html" title="The DOMNode interface is the primary datatype for the entire Document Object Model...">DOMNode</a>* getEndContainer() <span class="keyword">const</span> = 0;
|
|
<a name="l00145"></a>00145
|
|
<a name="l00154"></a>00154 <span class="keyword">virtual</span> XMLSize_t getEndOffset() <span class="keyword">const</span> = 0;
|
|
<a name="l00155"></a>00155
|
|
<a name="l00164"></a>00164 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> getCollapsed() <span class="keyword">const</span> = 0;
|
|
<a name="l00165"></a>00165
|
|
<a name="l00175"></a>00175 <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="code" href="classxercesc_1_1DOMNode.html" title="The DOMNode interface is the primary datatype for the entire Document Object Model...">DOMNode</a>* getCommonAncestorContainer() <span class="keyword">const</span> = 0;
|
|
<a name="l00176"></a>00176
|
|
<a name="l00177"></a>00177 <span class="comment">// -----------------------------------------------------------------------</span>
|
|
<a name="l00178"></a>00178 <span class="comment">// Setter methods</span>
|
|
<a name="l00179"></a>00179 <span class="comment">// -----------------------------------------------------------------------</span>
|
|
<a name="l00202"></a>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" title="The DOMNode interface is the primary datatype for the entire Document Object Model...">DOMNode</a> *refNode, XMLSize_t offset) = 0;
|
|
<a name="l00203"></a>00203
|
|
<a name="l00226"></a>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" title="The DOMNode interface is the primary datatype for the entire Document Object Model...">DOMNode</a> *refNode, XMLSize_t offset) = 0;
|
|
<a name="l00227"></a>00227
|
|
<a name="l00244"></a>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" title="The DOMNode interface is the primary datatype for the entire Document Object Model...">DOMNode</a> *refNode) = 0;
|
|
<a name="l00245"></a>00245
|
|
<a name="l00262"></a>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" title="The DOMNode interface is the primary datatype for the entire Document Object Model...">DOMNode</a> *refNode) = 0;
|
|
<a name="l00263"></a>00263
|
|
<a name="l00280"></a>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" title="The DOMNode interface is the primary datatype for the entire Document Object Model...">DOMNode</a> *refNode) = 0;
|
|
<a name="l00281"></a>00281
|
|
<a name="l00298"></a>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" title="The DOMNode interface is the primary datatype for the entire Document Object Model...">DOMNode</a> *refNode) = 0;
|
|
<a name="l00299"></a>00299
|
|
<a name="l00300"></a>00300 <span class="comment">// -----------------------------------------------------------------------</span>
|
|
<a name="l00301"></a>00301 <span class="comment">// Misc methods</span>
|
|
<a name="l00302"></a>00302 <span class="comment">// -----------------------------------------------------------------------</span>
|
|
<a name="l00313"></a>00313 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> collapse(<span class="keywordtype">bool</span> toStart) = 0;
|
|
<a name="l00314"></a>00314
|
|
<a name="l00331"></a>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" title="The DOMNode interface is the primary datatype for the entire Document Object Model...">DOMNode</a> *refNode) = 0;
|
|
<a name="l00332"></a>00332
|
|
<a name="l00347"></a>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" title="The DOMNode interface is the primary datatype for the entire Document Object Model...">DOMNode</a> *refNode) = 0;
|
|
<a name="l00348"></a>00348
|
|
<a name="l00366"></a>00366 <span class="keyword">virtual</span> <span class="keywordtype">short</span> compareBoundaryPoints(CompareHow how, <span class="keyword">const</span> <a class="code" href="classxercesc_1_1DOMRange.html">DOMRange</a>* sourceRange) <span class="keyword">const</span> = 0;
|
|
<a name="l00367"></a>00367
|
|
<a name="l00381"></a>00381 <span class="keyword">virtual</span> <span class="keywordtype">void</span> deleteContents() = 0;
|
|
<a name="l00382"></a>00382
|
|
<a name="l00398"></a>00398 <span class="keyword">virtual</span> <a class="code" href="classxercesc_1_1DOMDocumentFragment.html" title="DOMDocumentFragment is a &quot;lightweight&quot; or &quot;minimal&quot; DOMDocument...">DOMDocumentFragment</a>* extractContents() = 0;
|
|
<a name="l00399"></a>00399
|
|
<a name="l00412"></a>00412 <span class="keyword">virtual</span> <a class="code" href="classxercesc_1_1DOMDocumentFragment.html" title="DOMDocumentFragment is a &quot;lightweight&quot; or &quot;minimal&quot; DOMDocument...">DOMDocumentFragment</a>* cloneContents() <span class="keyword">const</span> = 0;
|
|
<a name="l00413"></a>00413
|
|
<a name="l00442"></a>00442 <span class="keyword">virtual</span> <span class="keywordtype">void</span> insertNode(<a class="code" href="classxercesc_1_1DOMNode.html" title="The DOMNode interface is the primary datatype for the entire Document Object Model...">DOMNode</a> *newNode) = 0;
|
|
<a name="l00443"></a>00443
|
|
<a name="l00469"></a>00469 <span class="keyword">virtual</span> <span class="keywordtype">void</span> surroundContents(<a class="code" href="classxercesc_1_1DOMNode.html" title="The DOMNode interface is the primary datatype for the entire Document Object Model...">DOMNode</a> *newParent) = 0;
|
|
<a name="l00470"></a>00470
|
|
<a name="l00481"></a>00481 <span class="keyword">virtual</span> <a class="code" href="classxercesc_1_1DOMRange.html">DOMRange</a>* cloneRange() <span class="keyword">const</span> = 0;
|
|
<a name="l00482"></a>00482
|
|
<a name="l00493"></a>00493 <span class="keyword">virtual</span> <span class="keyword">const</span> XMLCh* toString() <span class="keyword">const</span> = 0;
|
|
<a name="l00494"></a>00494
|
|
<a name="l00507"></a>00507 <span class="keyword">virtual</span> <span class="keywordtype">void</span> detach() = 0;
|
|
<a name="l00508"></a>00508
|
|
<a name="l00510"></a>00510
|
|
<a name="l00511"></a>00511 <span class="comment">// -----------------------------------------------------------------------</span>
|
|
<a name="l00512"></a>00512 <span class="comment">// Non-standard Extension</span>
|
|
<a name="l00513"></a>00513 <span class="comment">// -----------------------------------------------------------------------</span>
|
|
<a name="l00523"></a>00523 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> release() = 0;
|
|
<a name="l00525"></a>00525 };
|
|
<a name="l00526"></a>00526
|
|
<a name="l00527"></a>00527
|
|
<a name="l00528"></a>00528 XERCES_CPP_NAMESPACE_END
|
|
<a name="l00529"></a>00529
|
|
<a name="l00530"></a>00530 <span class="preprocessor">#endif</span>
|
|
</pre></div></div>
|
|
<hr size="1"/><address style="text-align: right;"><small>Generated on Fri Nov 13 15:00:06 2009 for XQilla DOM Level 3 API by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
|
|
</body>
|
|
</html>
|