blob: b613da1dbfe63490b98df5ab950c3994d22688e3 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Xalan-C++ API : Main Page</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<!-- The head section is copied from Doxygen 1.7.1 generated default output -->
<body>
<h2 align="center">Xalan-C++ API Documentation</h2>
<h3 align="center"><a href="../index.html">The Xalan C++ XSLT Processor Version 1.11</a></h3>
<hr/>
<!-- Generated by Doxygen 1.7.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="pages.html"><span>Related&nbsp;Pages</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>
</ul>
</div>
<div class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&nbsp;List</span></a></li>
<li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
</ul>
</div>
<div class="header">
<div class="headertitle">
<h1>XalanSourceTreeAttr.hpp</h1> </div>
</div>
<div class="contents">
<a href="XalanSourceTreeAttr_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</span>
<a name="l00003"></a>00003 <span class="comment"> * or more contributor license agreements. See the NOTICE file</span>
<a name="l00004"></a>00004 <span class="comment"> * distributed with this work for additional information</span>
<a name="l00005"></a>00005 <span class="comment"> * regarding copyright ownership. The ASF licenses this file</span>
<a name="l00006"></a>00006 <span class="comment"> * to you under the Apache License, Version 2.0 (the &quot;License&quot;);</span>
<a name="l00007"></a>00007 <span class="comment"> * you may not use this file except in compliance with the License.</span>
<a name="l00008"></a>00008 <span class="comment"> * You may obtain a copy of the License at</span>
<a name="l00009"></a>00009 <span class="comment"> *</span>
<a name="l00010"></a>00010 <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span>
<a name="l00011"></a>00011 <span class="comment"> *</span>
<a name="l00012"></a>00012 <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span>
<a name="l00013"></a>00013 <span class="comment"> * distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span>
<a name="l00014"></a>00014 <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
<a name="l00015"></a>00015 <span class="comment"> * See the License for the specific language governing permissions and</span>
<a name="l00016"></a>00016 <span class="comment"> * limitations under the License.</span>
<a name="l00017"></a>00017 <span class="comment"> */</span>
<a name="l00018"></a>00018 <span class="preprocessor">#if !defined(XALANSOURCETREEATTR_HEADER_GUARD_1357924680)</span>
<a name="l00019"></a>00019 <span class="preprocessor"></span><span class="preprocessor">#define XALANSOURCETREEATTR_HEADER_GUARD_1357924680</span>
<a name="l00020"></a>00020 <span class="preprocessor"></span>
<a name="l00021"></a>00021
<a name="l00022"></a>00022
<a name="l00023"></a>00023 <span class="preprocessor">#include &lt;<a class="code" href="XalanSourceTreeDefinitions_8hpp.html">xalanc/XalanSourceTree/XalanSourceTreeDefinitions.hpp</a>&gt;</span>
<a name="l00024"></a>00024
<a name="l00025"></a>00025
<a name="l00026"></a>00026
<a name="l00027"></a>00027 <span class="preprocessor">#include &lt;<a class="code" href="XalanAttr_8hpp.html">xalanc/XalanDOM/XalanAttr.hpp</a>&gt;</span>
<a name="l00028"></a>00028
<a name="l00029"></a>00029
<a name="l00030"></a>00030
<a name="l00031"></a>00031 <span class="preprocessor">#include &lt;<a class="code" href="XalanDOMString_8hpp.html">xalanc/XalanDOM/XalanDOMString.hpp</a>&gt;</span>
<a name="l00032"></a>00032
<a name="l00033"></a>00033
<a name="l00034"></a>00034
<a name="l00035"></a>00035 XALAN_CPP_NAMESPACE_BEGIN
<a name="l00036"></a>00036
<a name="l00037"></a>00037
<a name="l00038"></a>00038
<a name="l00039"></a>00039 <span class="keyword">class </span><a class="code" href="classXalanSourceTreeDocument.html">XalanSourceTreeDocument</a>;
<a name="l00040"></a>00040 <span class="keyword">class </span><a class="code" href="classXalanSourceTreeElement.html">XalanSourceTreeElement</a>;
<a name="l00041"></a>00041
<a name="l00042"></a>00042
<a name="l00043"></a>00043
<a name="l00044"></a>00044 <span class="comment">/*</span>
<a name="l00045"></a>00045 <span class="comment"> * &lt;meta name=&quot;usage&quot; content=&quot;experimental&quot;/&gt;</span>
<a name="l00046"></a>00046 <span class="comment"> *</span>
<a name="l00047"></a>00047 <span class="comment"> * Base class for the Xalan source tree Attr interface.</span>
<a name="l00048"></a>00048 <span class="comment"> *</span>
<a name="l00049"></a>00049 <span class="comment"> * This class is experimental and subject to change!!</span>
<a name="l00050"></a>00050 <span class="comment"> */</span>
<a name="l00051"></a>00051
<a name="l00052"></a><a class="code" href="classXalanSourceTreeAttr.html">00052</a> <span class="keyword">class </span><a class="code" href="XalanSourceTreeDefinitions_8hpp.html#ab668c8aeadc52576c1aab5a1888f349c">XALAN_XALANSOURCETREE_EXPORT</a> <a class="code" href="classXalanSourceTreeAttr.html">XalanSourceTreeAttr</a> : <span class="keyword">public</span> <a class="code" href="classXalanAttr.html">XalanAttr</a>
<a name="l00053"></a>00053 {
<a name="l00054"></a>00054 <span class="keyword">public</span>:
<a name="l00055"></a>00055 <span class="comment"></span>
<a name="l00056"></a>00056 <span class="comment"> /**</span>
<a name="l00057"></a>00057 <span class="comment"> * Constructor.</span>
<a name="l00058"></a>00058 <span class="comment"> *</span>
<a name="l00059"></a>00059 <span class="comment"> * @param theName The name of the attribute</span>
<a name="l00060"></a>00060 <span class="comment"> * @param theValue The value of the attribute</span>
<a name="l00061"></a>00061 <span class="comment"> * @param theOwnerDocument The document that owns the instance</span>
<a name="l00062"></a>00062 <span class="comment"> * @param theOwnerElement The element that owns the instance</span>
<a name="l00063"></a>00063 <span class="comment"> * @param theIndex The document-order index of the node.</span>
<a name="l00064"></a>00064 <span class="comment"> */</span>
<a name="l00065"></a>00065 <a class="code" href="classXalanSourceTreeAttr.html">XalanSourceTreeAttr</a>(
<a name="l00066"></a>00066 <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; theName,
<a name="l00067"></a>00067 <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; theValue,
<a name="l00068"></a>00068 <a class="code" href="classXalanSourceTreeElement.html">XalanSourceTreeElement</a>* theOwnerElement = 0,
<a name="l00069"></a>00069 <a class="code" href="classXalanNode.html#a737e6c797973546c10650cd72cc5f8ab">IndexType</a> theIndex = 0);
<a name="l00070"></a>00070
<a name="l00071"></a>00071 <span class="keyword">virtual</span>
<a name="l00072"></a>00072 ~<a class="code" href="classXalanSourceTreeAttr.html">XalanSourceTreeAttr</a>();
<a name="l00073"></a>00073
<a name="l00074"></a>00074
<a name="l00075"></a>00075 <span class="comment">// These interfaces are inherited from XalanNode...</span>
<a name="l00076"></a>00076 <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp;
<a name="l00077"></a>00077 <a class="code" href="classXalanAttr.html#a9ef9a0271e76ceddb575f28f6f57b4c9" title="Gets the name of this node, depending on its type.">getNodeName</a>() <span class="keyword">const</span>;
<a name="l00078"></a>00078
<a name="l00079"></a>00079 <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp;
<a name="l00080"></a>00080 <a class="code" href="classXalanAttr.html#a4f8e11b6bf969ea3f261a5456540240d" title="Gets the value of this node, depending on its type.">getNodeValue</a>() <span class="keyword">const</span>;
<a name="l00081"></a>00081
<a name="l00082"></a>00082 <span class="keyword">virtual</span> <a class="code" href="classXalanNode.html#a93d60cd336327226e55c45a320cced24">NodeType</a>
<a name="l00083"></a>00083 <a class="code" href="classXalanAttr.html#a9026ef42adcba6f80dd7fccdf62ea3d5" title="An enum value representing the type of the underlying object.">getNodeType</a>() <span class="keyword">const</span>;
<a name="l00084"></a>00084
<a name="l00085"></a>00085 <span class="keyword">virtual</span> <a class="code" href="classXalanNode.html">XalanNode</a>*
<a name="l00086"></a>00086 <a class="code" href="classXalanAttr.html#a3b8c23e6ce134b4176c921611041b3ad" title="Gets the parent of this node.">getParentNode</a>() <span class="keyword">const</span>;
<a name="l00087"></a>00087
<a name="l00088"></a>00088 <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="code" href="classXalanNodeList.html">XalanNodeList</a>*
<a name="l00089"></a>00089 <a class="code" href="classXalanAttr.html#a54cf5616ea6b217c4b3b3fdfd1556d5c" title="Gets a XalanNodeList that contains all children of this node.">getChildNodes</a>() <span class="keyword">const</span>;
<a name="l00090"></a>00090
<a name="l00091"></a>00091 <span class="keyword">virtual</span> <a class="code" href="classXalanNode.html">XalanNode</a>*
<a name="l00092"></a>00092 <a class="code" href="classXalanAttr.html#add6a2d506a31ba389642a4a23790e77f" title="Gets the first child of this node.">getFirstChild</a>() <span class="keyword">const</span>;
<a name="l00093"></a>00093
<a name="l00094"></a>00094 <span class="keyword">virtual</span> <a class="code" href="classXalanNode.html">XalanNode</a>*
<a name="l00095"></a>00095 <a class="code" href="classXalanAttr.html#a879d12b52d6a15ccec56116c42d7feb8" title="Gets the last child of this node.">getLastChild</a>() <span class="keyword">const</span>;
<a name="l00096"></a>00096
<a name="l00097"></a>00097 <span class="keyword">virtual</span> <a class="code" href="classXalanNode.html">XalanNode</a>*
<a name="l00098"></a>00098 <a class="code" href="classXalanAttr.html#a8b4d4124d2711132e6408fa263173e5c" title="Gets the node immediately preceding this node.">getPreviousSibling</a>() <span class="keyword">const</span>;
<a name="l00099"></a>00099
<a name="l00100"></a>00100 <span class="keyword">virtual</span> <a class="code" href="classXalanNode.html">XalanNode</a>*
<a name="l00101"></a>00101 <a class="code" href="classXalanAttr.html#a0a74cdad1d304577d68f31c23c06f12c" title="Gets the node immediately following this node.">getNextSibling</a>() <span class="keyword">const</span>;
<a name="l00102"></a>00102
<a name="l00103"></a>00103 <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="code" href="classXalanNamedNodeMap.html">XalanNamedNodeMap</a>*
<a name="l00104"></a>00104 <a class="code" href="classXalanAttr.html#a7750ba37bb437d4d30833e41d92a21bb" title="Gets a XalanNamedNodeMap containing the attributes of this node (if it is an XalanElement) or a null ...">getAttributes</a>() <span class="keyword">const</span>;
<a name="l00105"></a>00105
<a name="l00106"></a>00106 <span class="keyword">virtual</span> <a class="code" href="classXalanDocument.html">XalanDocument</a>*
<a name="l00107"></a>00107 <a class="code" href="classXalanAttr.html#acb0a89263c9a51b013ca1a4a8aac5754" title="Gets the XalanDocument object associated with this node.">getOwnerDocument</a>() <span class="keyword">const</span>;
<a name="l00108"></a>00108
<a name="l00109"></a>00109 <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp;
<a name="l00110"></a>00110 <a class="code" href="classXalanAttr.html#aded5065e84d25c337d98fb9c08f5d86c" title="Get the namespace URI of this node.">getNamespaceURI</a>() <span class="keyword">const</span>;
<a name="l00111"></a>00111
<a name="l00112"></a>00112 <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp;
<a name="l00113"></a>00113 <a class="code" href="classXalanAttr.html#ac457d32841dd470ec68c5a53e1bdb392" title="Get the namespace prefix of this node.">getPrefix</a>() <span class="keyword">const</span>;
<a name="l00114"></a>00114
<a name="l00115"></a>00115 <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp;
<a name="l00116"></a>00116 <a class="code" href="classXalanAttr.html#a4c9470c847ec9850fb18995558bf209b" title="Returns the local part of the qualified name of this node.">getLocalName</a>() <span class="keyword">const</span>;
<a name="l00117"></a>00117
<a name="l00118"></a>00118 <span class="keyword">virtual</span> <span class="keywordtype">bool</span>
<a name="l00119"></a>00119 <a class="code" href="classXalanAttr.html#a29d64d7b4931db030b1a0a229aef8218" title="Determine if the document is node-order indexed.">isIndexed</a>() <span class="keyword">const</span>;
<a name="l00120"></a>00120
<a name="l00121"></a>00121 <span class="keyword">virtual</span> <a class="code" href="classXalanNode.html#a737e6c797973546c10650cd72cc5f8ab">IndexType</a>
<a name="l00122"></a>00122 <a class="code" href="classXalanAttr.html#ac4eb197ed43dc452ae5d3229a41eced4" title="Get the node&amp;#39;s index.">getIndex</a>() <span class="keyword">const</span>;
<a name="l00123"></a>00123
<a name="l00124"></a>00124 <span class="comment">// These interfaces are inherited from XalanAttr...</span>
<a name="l00125"></a>00125 <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp;
<a name="l00126"></a>00126 <a class="code" href="classXalanAttr.html#abb0407e81ba9082f7189a974e30ec20b" title="Returns the name of this attribute.">getName</a>() <span class="keyword">const</span>;
<a name="l00127"></a>00127
<a name="l00128"></a>00128 <span class="keyword">virtual</span> <span class="keywordtype">bool</span>
<a name="l00129"></a>00129 getSpecified() <span class="keyword">const</span>;
<a name="l00130"></a>00130
<a name="l00131"></a>00131 <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp;
<a name="l00132"></a>00132 <a class="code" href="classXalanAttr.html#ac26aa81790cbf7cff4a72e0cf316359a" title="Returns the value of the attribute.">getValue</a>() <span class="keyword">const</span>;
<a name="l00133"></a>00133
<a name="l00134"></a>00134 <span class="keyword">virtual</span> <a class="code" href="classXalanElement.html">XalanElement</a>*
<a name="l00135"></a>00135 <a class="code" href="classXalanAttr.html#a3572f5f0166f651b970f5249edcc0388" title="The XalanElement node this attribute is attached to.">getOwnerElement</a>() <span class="keyword">const</span>;
<a name="l00136"></a>00136
<a name="l00137"></a>00137 <span class="comment">// public interfaces not inherited from XalanAttr...</span>
<a name="l00138"></a>00138
<a name="l00139"></a>00139 <span class="keywordtype">void</span>
<a name="l00140"></a><a class="code" href="classXalanSourceTreeAttr.html#a04a0c410fdbb377073e1b3df3a43a5f2">00140</a> setOwnerElement(<a class="code" href="classXalanSourceTreeElement.html">XalanSourceTreeElement</a>* theElement)
<a name="l00141"></a>00141 {
<a name="l00142"></a>00142 m_ownerElement = theElement;
<a name="l00143"></a>00143 }
<a name="l00144"></a>00144
<a name="l00145"></a>00145 <span class="keywordtype">void</span>
<a name="l00146"></a><a class="code" href="classXalanSourceTreeAttr.html#adcaa93fd101d3a4f132440874b9cfec7">00146</a> setIndex(<a class="code" href="classXalanNode.html#a737e6c797973546c10650cd72cc5f8ab">IndexType</a> theIndex)
<a name="l00147"></a>00147 {
<a name="l00148"></a>00148 m_index = theIndex;
<a name="l00149"></a>00149 }
<a name="l00150"></a>00150
<a name="l00151"></a>00151 <span class="keyword">private</span>:
<a name="l00152"></a>00152
<a name="l00153"></a>00153 <span class="comment">// Not defined...</span>
<a name="l00154"></a>00154 <a class="code" href="classXalanSourceTreeAttr.html">XalanSourceTreeAttr</a>(<span class="keyword">const</span> <a class="code" href="classXalanSourceTreeAttr.html">XalanSourceTreeAttr</a>&amp; theSource);
<a name="l00155"></a>00155
<a name="l00156"></a>00156 <a class="code" href="classXalanSourceTreeAttr.html">XalanSourceTreeAttr</a>&amp;
<a name="l00157"></a>00157 <a class="code" href="classXalanAttr.html#a6ee1f8ed2b60ec823858d24020cc3e54">operator=</a>(<span class="keyword">const</span> <a class="code" href="classXalanSourceTreeAttr.html">XalanSourceTreeAttr</a>&amp; theSource);
<a name="l00158"></a>00158
<a name="l00159"></a>00159 <span class="keywordtype">bool</span>
<a name="l00160"></a>00160 <a class="code" href="classXalanAttr.html#a13848f29a5aed48b89840c6c0aff6c15">operator==</a>(<span class="keyword">const</span> <a class="code" href="classXalanSourceTreeAttr.html">XalanSourceTreeAttr</a>&amp; theRHS) <span class="keyword">const</span>;
<a name="l00161"></a>00161
<a name="l00162"></a>00162
<a name="l00163"></a>00163 <span class="comment">// Data members...</span>
<a name="l00164"></a>00164 <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; m_name;
<a name="l00165"></a>00165
<a name="l00166"></a>00166 <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; m_value;
<a name="l00167"></a>00167
<a name="l00168"></a>00168 <a class="code" href="classXalanSourceTreeElement.html">XalanSourceTreeElement</a>* m_ownerElement;
<a name="l00169"></a>00169
<a name="l00170"></a>00170 IndexType m_index;
<a name="l00171"></a>00171 };
<a name="l00172"></a>00172
<a name="l00173"></a>00173
<a name="l00174"></a>00174
<a name="l00175"></a>00175 XALAN_CPP_NAMESPACE_END
<a name="l00176"></a>00176
<a name="l00177"></a>00177
<a name="l00178"></a>00178
<a name="l00179"></a>00179 <span class="preprocessor">#endif // !defined(XALANSOURCETREEATTR_HEADER_GUARD_1357924680)</span>
</pre></div></div>
</div>
<p align="center"><a href="graph_legend.html">Interpreting class diagrams</a></p>
<p><font color="#000000" face="arial,helvetica,sanserif" size="-1">
<i><a href="http://www.doxygen.org/">Doxygen</a> and
<a href="http://www.graphviz.org/">GraphViz</a> are
used to generate this API documentation from the Xalan-C header files.</i></font></p>
<table border="0" cellpadding="0" cellspacing="0" width="80%">
<tr>
<td width="80%" valign="top">
<p align="center"><b>Xalan-C++ XSLT Processor Version 1.11</b><br/>
Copyright &copy; 1999-2012 The Apache Software Foundation.<br/>
All Rights Reserved.</p>
</td>
</tr>
<tr>
<td width="100%">
<p align="center"><img src="asf_logo_wide.gif" width="268" height="25" align="bottom" border="0" alt="Apache Logo">
</td>
</tr>
</table>
</body>
</html>