Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.11


SelectionEvent.hpp
Go to the documentation of this file.
1 /*
2  * Licensed to the Apache Software Foundation (ASF) under one
3  * or more contributor license agreements. See the NOTICE file
4  * distributed with this work for additional information
5  * regarding copyright ownership. The ASF licenses this file
6  * to you under the Apache License, Version 2.0 (the "License");
7  * you may not use this file except in compliance with the License.
8  * You may obtain a copy of the License at
9  *
10  * http://www.apache.org/licenses/LICENSE-2.0
11  *
12  * Unless required by applicable law or agreed to in writing, software
13  * distributed under the License is distributed on an "AS IS" BASIS,
14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15  * See the License for the specific language governing permissions and
16  * limitations under the License.
17  */
18 #if !defined(XALAN_SelectionEvent_HEADER_GUARD)
19 #define XALAN_SelectionEvent_HEADER_GUARD
20 
21 
22 
23 // Base include file. Must be first.
25 
26 
27 
29 
30 
31 
32 #include <xalanc/XPath/XObject.hpp>
33 
34 
35 
36 XALAN_CPP_NAMESPACE_BEGIN
37 
38 
39 
40 class XalanNode;
43 class XPath;
44 
45 
46 
48 {
49 public:
50 
51  /**
52  * Create an event originating at the given node of the style tree.
53  *
54  * @param executionContext The current execution context
55  * @param sourceNode The source node selected.
56  * @param styleNode The node in the style tree reference for the event
57  * @param attributeName The attribute name where the XPath expression was supplied
58  * @param xpath The XPath instance executed
59  * @param selection The result of evaluating the XPath
60  *
61  */
63  StylesheetExecutionContext& executionContext,
64  const XalanNode* sourceNode,
65  const ElemTemplateElement& styleNode,
66  const XalanDOMString& attributeName,
67  const XPath& xpath,
68  const XObjectPtr selection);
69 
70  /**
71  * Create an event originating at the given node of the style tree.
72  *
73  * @param executionContext The current execution context
74  * @param sourceNode The source node selected.
75  * @param styleNode The node in the style tree reference for the event
76  * @param attributeName The attribute name where the XPath expression was supplied
77  * @param xpathExpression The XPath expression executed
78  * @param selection The result of evaluating the XPath
79  *
80  */
82  StylesheetExecutionContext& executionContext,
83  const XalanNode* sourceNode,
84  const ElemTemplateElement& styleNode,
85  const XalanDOMString& attributeName,
86  const XalanDOMString& xpathExpression,
87  const XObjectPtr selection);
88 
89  /**
90  * Create an event originating at the given node of the style tree.
91  *
92  * @param executionContext The current execution context
93  * @param sourceNode The source node selected.
94  * @param styleNode The node in the style tree reference for the event
95  * @param attributeName The attribute name where the XPath expression was supplied
96  * @param xpath The XPath instance executed
97  * @param selection The result of evaluating the XPath
98  *
99  */
101  StylesheetExecutionContext& executionContext,
102  const XalanNode* sourceNode,
103  const ElemTemplateElement& styleNode,
104  const XalanDOMString& attributeName,
105  const XPath& xpath,
106  bool selection);
107 
108  /**
109  * Create an event originating at the given node of the style tree.
110  *
111  * @param executionContext The current execution context
112  * @param sourceNode The source node selected.
113  * @param styleNode The node in the style tree reference for the event
114  * @param attributeName The attribute name where the XPath expression was supplied
115  * @param xpath The XPath instance executed
116  * @param selection The result of evaluating the XPath
117  *
118  */
120  StylesheetExecutionContext& executionContext,
121  const XalanNode* sourceNode,
122  const ElemTemplateElement& styleNode,
123  const XalanDOMString& attributeName,
124  const XPath& xpath,
125  const NodeRefListBase& selection);
126 
127  virtual
128  ~SelectionEvent();
129 
130  enum eSelectionType { eNone, eBoolean, eNodeSet, eUnknown };
131 
132  /**
133  * The executionContext instance.
134  */
136 
137  /**
138  * The current context node.
139  */
141 
142  /**
143  * The node in the style tree where the event occurs.
144  */
146 
147  /**
148  * The attribute name from which the selection is made.
149  */
151 
152  /**
153  * The XPath expression evaluated.
154  */
156 
157  /**
158  * The result of the selection. If it's null, m_sourceNode
159  * was selected, or some specific type was selected. See
160  * the above enums.
161  */
163 
164  /**
165  * The type of the selection.
166  */
168 
169  bool m_boolean;
170 
172 
173 private:
174 
175  // Unimplemented...
177  operator=(const SelectionEvent& other);
178 };
179 
180 
181 
182 XALAN_CPP_NAMESPACE_END
183 
184 
185 
186 #endif //XALAN_SelectionEvent_HEADER_GUARD
const XObjectPtr m_selection
The result of the selection.
const StylesheetExecutionContext & m_executionContext
The executionContext instance.
const XalanDOMString & m_attributeName
The attribute name from which the selection is made.
Class to hold XObjectPtr return types.
Definition: XObject.hpp:883
Definition: XPath.hpp:64
Local implementation of NodeRefList.
const NodeRefListBase *const m_nodeList
const eSelectionType m_type
The type of the selection.
const ElemTemplateElement & m_styleNode
The node in the style tree where the event occurs.
#define XALAN_XSLT_EXPORT
const XalanNode * m_sourceNode
The current context node.
const XalanDOMString & m_xpathExpression
The XPath expression evaluated.

Interpreting class diagrams

Doxygen and GraphViz are used to generate this API documentation from the Xalan-C header files.

Xalan-C++ XSLT Processor Version 1.11
Copyright © 1999-2012 The Apache Software Foundation.
All Rights Reserved.

Apache Logo