blob: 756061a1e0d2cd140a83b86132bdda3429352455 [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>SelectionEvent.hpp</h1> </div>
</div>
<div class="contents">
<a href="SelectionEvent_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(XALAN_SelectionEvent_HEADER_GUARD)</span>
<a name="l00019"></a>00019 <span class="preprocessor"></span><span class="preprocessor">#define XALAN_SelectionEvent_HEADER_GUARD</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="comment">// Base include file. Must be first.</span>
<a name="l00024"></a>00024 <span class="preprocessor">#include &lt;<a class="code" href="XSLTDefinitions_8hpp.html">xalanc/XSLT/XSLTDefinitions.hpp</a>&gt;</span>
<a name="l00025"></a>00025
<a name="l00026"></a>00026
<a name="l00027"></a>00027
<a name="l00028"></a>00028 <span class="preprocessor">#include &lt;<a class="code" href="XalanDOMString_8hpp.html">xalanc/XalanDOM/XalanDOMString.hpp</a>&gt;</span>
<a name="l00029"></a>00029
<a name="l00030"></a>00030
<a name="l00031"></a>00031
<a name="l00032"></a>00032 <span class="preprocessor">#include &lt;<a class="code" href="XObject_8hpp.html">xalanc/XPath/XObject.hpp</a>&gt;</span>
<a name="l00033"></a>00033
<a name="l00034"></a>00034
<a name="l00035"></a>00035
<a name="l00036"></a>00036 XALAN_CPP_NAMESPACE_BEGIN
<a name="l00037"></a>00037
<a name="l00038"></a>00038
<a name="l00039"></a>00039
<a name="l00040"></a>00040 <span class="keyword">class </span><a class="code" href="classXalanNode.html">XalanNode</a>;
<a name="l00041"></a>00041 <span class="keyword">class </span><a class="code" href="classElemTemplateElement.html">ElemTemplateElement</a>;
<a name="l00042"></a>00042 <span class="keyword">class </span><a class="code" href="classStylesheetExecutionContext.html">StylesheetExecutionContext</a>;
<a name="l00043"></a>00043 <span class="keyword">class </span><a class="code" href="classXPath.html">XPath</a>;
<a name="l00044"></a>00044
<a name="l00045"></a>00045
<a name="l00046"></a>00046
<a name="l00047"></a><a class="code" href="classSelectionEvent.html">00047</a> <span class="keyword">class </span><a class="code" href="XSLTDefinitions_8hpp.html#afe13e115e49db23eff1daccf7343935f">XALAN_XSLT_EXPORT</a> <a class="code" href="classSelectionEvent.html">SelectionEvent</a>
<a name="l00048"></a>00048 {
<a name="l00049"></a>00049 <span class="keyword">public</span>:
<a name="l00050"></a>00050 <span class="comment"></span>
<a name="l00051"></a>00051 <span class="comment"> /**</span>
<a name="l00052"></a>00052 <span class="comment"> * Create an event originating at the given node of the style tree.</span>
<a name="l00053"></a>00053 <span class="comment"> *</span>
<a name="l00054"></a>00054 <span class="comment"> * @param executionContext The current execution context</span>
<a name="l00055"></a>00055 <span class="comment"> * @param sourceNode The source node selected.</span>
<a name="l00056"></a>00056 <span class="comment"> * @param styleNode The node in the style tree reference for the event</span>
<a name="l00057"></a>00057 <span class="comment"> * @param attributeName The attribute name where the XPath expression was supplied</span>
<a name="l00058"></a>00058 <span class="comment"> * @param xpath The XPath instance executed</span>
<a name="l00059"></a>00059 <span class="comment"> * @param selection The result of evaluating the XPath</span>
<a name="l00060"></a>00060 <span class="comment"> *</span>
<a name="l00061"></a>00061 <span class="comment"> */</span>
<a name="l00062"></a>00062 <a class="code" href="classSelectionEvent.html">SelectionEvent</a>(
<a name="l00063"></a>00063 <a class="code" href="classStylesheetExecutionContext.html">StylesheetExecutionContext</a>&amp; executionContext,
<a name="l00064"></a>00064 <span class="keyword">const</span> <a class="code" href="classXalanNode.html">XalanNode</a>* sourceNode,
<a name="l00065"></a>00065 <span class="keyword">const</span> <a class="code" href="classElemTemplateElement.html">ElemTemplateElement</a>&amp; styleNode,
<a name="l00066"></a>00066 <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; attributeName,
<a name="l00067"></a>00067 <span class="keyword">const</span> <a class="code" href="classXPath.html">XPath</a>&amp; xpath,
<a name="l00068"></a>00068 <span class="keyword">const</span> <a class="code" href="classXObjectPtr.html" title="Class to hold XObjectPtr return types.">XObjectPtr</a> selection);
<a name="l00069"></a>00069 <span class="comment"></span>
<a name="l00070"></a>00070 <span class="comment"> /**</span>
<a name="l00071"></a>00071 <span class="comment"> * Create an event originating at the given node of the style tree.</span>
<a name="l00072"></a>00072 <span class="comment"> *</span>
<a name="l00073"></a>00073 <span class="comment"> * @param executionContext The current execution context</span>
<a name="l00074"></a>00074 <span class="comment"> * @param sourceNode The source node selected.</span>
<a name="l00075"></a>00075 <span class="comment"> * @param styleNode The node in the style tree reference for the event</span>
<a name="l00076"></a>00076 <span class="comment"> * @param attributeName The attribute name where the XPath expression was supplied</span>
<a name="l00077"></a>00077 <span class="comment"> * @param xpathExpression The XPath expression executed</span>
<a name="l00078"></a>00078 <span class="comment"> * @param selection The result of evaluating the XPath</span>
<a name="l00079"></a>00079 <span class="comment"> *</span>
<a name="l00080"></a>00080 <span class="comment"> */</span>
<a name="l00081"></a>00081 <a class="code" href="classSelectionEvent.html">SelectionEvent</a>(
<a name="l00082"></a>00082 <a class="code" href="classStylesheetExecutionContext.html">StylesheetExecutionContext</a>&amp; executionContext,
<a name="l00083"></a>00083 <span class="keyword">const</span> <a class="code" href="classXalanNode.html">XalanNode</a>* sourceNode,
<a name="l00084"></a>00084 <span class="keyword">const</span> <a class="code" href="classElemTemplateElement.html">ElemTemplateElement</a>&amp; styleNode,
<a name="l00085"></a>00085 <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; attributeName,
<a name="l00086"></a>00086 <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; xpathExpression,
<a name="l00087"></a>00087 <span class="keyword">const</span> <a class="code" href="classXObjectPtr.html" title="Class to hold XObjectPtr return types.">XObjectPtr</a> selection);
<a name="l00088"></a>00088 <span class="comment"></span>
<a name="l00089"></a>00089 <span class="comment"> /**</span>
<a name="l00090"></a>00090 <span class="comment"> * Create an event originating at the given node of the style tree.</span>
<a name="l00091"></a>00091 <span class="comment"> *</span>
<a name="l00092"></a>00092 <span class="comment"> * @param executionContext The current execution context</span>
<a name="l00093"></a>00093 <span class="comment"> * @param sourceNode The source node selected.</span>
<a name="l00094"></a>00094 <span class="comment"> * @param styleNode The node in the style tree reference for the event</span>
<a name="l00095"></a>00095 <span class="comment"> * @param attributeName The attribute name where the XPath expression was supplied</span>
<a name="l00096"></a>00096 <span class="comment"> * @param xpath The XPath instance executed</span>
<a name="l00097"></a>00097 <span class="comment"> * @param selection The result of evaluating the XPath</span>
<a name="l00098"></a>00098 <span class="comment"> *</span>
<a name="l00099"></a>00099 <span class="comment"> */</span>
<a name="l00100"></a>00100 <a class="code" href="classSelectionEvent.html">SelectionEvent</a>(
<a name="l00101"></a>00101 <a class="code" href="classStylesheetExecutionContext.html">StylesheetExecutionContext</a>&amp; executionContext,
<a name="l00102"></a>00102 <span class="keyword">const</span> <a class="code" href="classXalanNode.html">XalanNode</a>* sourceNode,
<a name="l00103"></a>00103 <span class="keyword">const</span> <a class="code" href="classElemTemplateElement.html">ElemTemplateElement</a>&amp; styleNode,
<a name="l00104"></a>00104 <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; attributeName,
<a name="l00105"></a>00105 <span class="keyword">const</span> <a class="code" href="classXPath.html">XPath</a>&amp; xpath,
<a name="l00106"></a>00106 <span class="keywordtype">bool</span> selection);
<a name="l00107"></a>00107 <span class="comment"></span>
<a name="l00108"></a>00108 <span class="comment"> /**</span>
<a name="l00109"></a>00109 <span class="comment"> * Create an event originating at the given node of the style tree.</span>
<a name="l00110"></a>00110 <span class="comment"> *</span>
<a name="l00111"></a>00111 <span class="comment"> * @param executionContext The current execution context</span>
<a name="l00112"></a>00112 <span class="comment"> * @param sourceNode The source node selected.</span>
<a name="l00113"></a>00113 <span class="comment"> * @param styleNode The node in the style tree reference for the event</span>
<a name="l00114"></a>00114 <span class="comment"> * @param attributeName The attribute name where the XPath expression was supplied</span>
<a name="l00115"></a>00115 <span class="comment"> * @param xpath The XPath instance executed</span>
<a name="l00116"></a>00116 <span class="comment"> * @param selection The result of evaluating the XPath</span>
<a name="l00117"></a>00117 <span class="comment"> *</span>
<a name="l00118"></a>00118 <span class="comment"> */</span>
<a name="l00119"></a>00119 <a class="code" href="classSelectionEvent.html">SelectionEvent</a>(
<a name="l00120"></a>00120 <a class="code" href="classStylesheetExecutionContext.html">StylesheetExecutionContext</a>&amp; executionContext,
<a name="l00121"></a>00121 <span class="keyword">const</span> <a class="code" href="classXalanNode.html">XalanNode</a>* sourceNode,
<a name="l00122"></a>00122 <span class="keyword">const</span> <a class="code" href="classElemTemplateElement.html">ElemTemplateElement</a>&amp; styleNode,
<a name="l00123"></a>00123 <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; attributeName,
<a name="l00124"></a>00124 <span class="keyword">const</span> <a class="code" href="classXPath.html">XPath</a>&amp; xpath,
<a name="l00125"></a>00125 <span class="keyword">const</span> <a class="code" href="classNodeRefListBase.html" title="Local implementation of NodeRefList.">NodeRefListBase</a>&amp; selection);
<a name="l00126"></a>00126
<a name="l00127"></a>00127 <span class="keyword">virtual</span>
<a name="l00128"></a>00128 ~<a class="code" href="classSelectionEvent.html">SelectionEvent</a>();
<a name="l00129"></a>00129
<a name="l00130"></a><a class="code" href="classSelectionEvent.html#ac59e57ccbee58a553333ff42fb73a22ba56f8a9e40e64b170f100e27f062804a7">00130</a> <span class="keyword">enum</span> <a class="code" href="classSelectionEvent.html#ac59e57ccbee58a553333ff42fb73a22b">eSelectionType</a> { eNone, eBoolean, eNodeSet, eUnknown };
<a name="l00131"></a>00131 <span class="comment"></span>
<a name="l00132"></a>00132 <span class="comment"> /**</span>
<a name="l00133"></a>00133 <span class="comment"> * The executionContext instance.</span>
<a name="l00134"></a>00134 <span class="comment"> */</span>
<a name="l00135"></a><a class="code" href="classSelectionEvent.html#a08c3c5bc3ddcc81c4e2d89a9e0f7862c">00135</a> <span class="keyword">const</span> <a class="code" href="classStylesheetExecutionContext.html">StylesheetExecutionContext</a>&amp; m_executionContext;
<a name="l00136"></a>00136 <span class="comment"></span>
<a name="l00137"></a>00137 <span class="comment"> /**</span>
<a name="l00138"></a>00138 <span class="comment"> * The current context node.</span>
<a name="l00139"></a>00139 <span class="comment"> */</span>
<a name="l00140"></a><a class="code" href="classSelectionEvent.html#a2c8ec9266214ad277d27e4cbbeaa253c">00140</a> <span class="keyword">const</span> <a class="code" href="classXalanNode.html">XalanNode</a>* m_sourceNode;
<a name="l00141"></a>00141 <span class="comment"></span>
<a name="l00142"></a>00142 <span class="comment"> /**</span>
<a name="l00143"></a>00143 <span class="comment"> * The node in the style tree where the event occurs.</span>
<a name="l00144"></a>00144 <span class="comment"> */</span>
<a name="l00145"></a><a class="code" href="classSelectionEvent.html#ab0fbb2e1d0d8f363b5a1986d215c6d6e">00145</a> <span class="keyword">const</span> <a class="code" href="classElemTemplateElement.html">ElemTemplateElement</a>&amp; m_styleNode;
<a name="l00146"></a>00146 <span class="comment"></span>
<a name="l00147"></a>00147 <span class="comment"> /**</span>
<a name="l00148"></a>00148 <span class="comment"> * The attribute name from which the selection is made.</span>
<a name="l00149"></a>00149 <span class="comment"> */</span>
<a name="l00150"></a><a class="code" href="classSelectionEvent.html#a34c8284cb883b486843d191475bc6ce7">00150</a> <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; m_attributeName;
<a name="l00151"></a>00151 <span class="comment"></span>
<a name="l00152"></a>00152 <span class="comment"> /**</span>
<a name="l00153"></a>00153 <span class="comment"> * The XPath expression evaluated.</span>
<a name="l00154"></a>00154 <span class="comment"> */</span>
<a name="l00155"></a><a class="code" href="classSelectionEvent.html#a42e632a90e0be88ee0b452dc6459be3a">00155</a> <span class="keyword">const</span> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp; m_xpathExpression;
<a name="l00156"></a>00156 <span class="comment"></span>
<a name="l00157"></a>00157 <span class="comment"> /**</span>
<a name="l00158"></a>00158 <span class="comment"> * The result of the selection. If it&#39;s null, m_sourceNode</span>
<a name="l00159"></a>00159 <span class="comment"> * was selected, or some specific type was selected. See</span>
<a name="l00160"></a>00160 <span class="comment"> * the above enums.</span>
<a name="l00161"></a>00161 <span class="comment"> */</span>
<a name="l00162"></a><a class="code" href="classSelectionEvent.html#af60718580b2b75f346bb038b06b6abc3">00162</a> <span class="keyword">const</span> <a class="code" href="classXObjectPtr.html" title="Class to hold XObjectPtr return types.">XObjectPtr</a> m_selection;
<a name="l00163"></a>00163 <span class="comment"></span>
<a name="l00164"></a>00164 <span class="comment"> /**</span>
<a name="l00165"></a>00165 <span class="comment"> * The type of the selection.</span>
<a name="l00166"></a>00166 <span class="comment"> */</span>
<a name="l00167"></a><a class="code" href="classSelectionEvent.html#a16668506544074929a4ae06f2a633dee">00167</a> <span class="keyword">const</span> <a class="code" href="classSelectionEvent.html#ac59e57ccbee58a553333ff42fb73a22b">eSelectionType</a> m_type;
<a name="l00168"></a>00168
<a name="l00169"></a><a class="code" href="classSelectionEvent.html#a93d182ab0224bfa0f23fbbf139959c45">00169</a> <span class="keywordtype">bool</span> m_boolean;
<a name="l00170"></a>00170
<a name="l00171"></a><a class="code" href="classSelectionEvent.html#adda0e60013722ceb2bee751c7bf22526">00171</a> <span class="keyword">const</span> <a class="code" href="classNodeRefListBase.html" title="Local implementation of NodeRefList.">NodeRefListBase</a>* <span class="keyword">const</span> m_nodeList;
<a name="l00172"></a>00172
<a name="l00173"></a>00173 <span class="keyword">private</span>:
<a name="l00174"></a>00174
<a name="l00175"></a>00175 <span class="comment">// Unimplemented...</span>
<a name="l00176"></a>00176 <a class="code" href="classSelectionEvent.html">SelectionEvent</a>&amp;
<a name="l00177"></a>00177 operator=(<span class="keyword">const</span> <a class="code" href="classSelectionEvent.html">SelectionEvent</a>&amp; other);
<a name="l00178"></a>00178 };
<a name="l00179"></a>00179
<a name="l00180"></a>00180
<a name="l00181"></a>00181
<a name="l00182"></a>00182 XALAN_CPP_NAMESPACE_END
<a name="l00183"></a>00183
<a name="l00184"></a>00184
<a name="l00185"></a>00185
<a name="l00186"></a>00186 <span class="preprocessor">#endif //XALAN_SelectionEvent_HEADER_GUARD</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>