blob: 676be43c0ca4b44c5a60febe6928711815111896 [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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<h1>ProblemListener Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="ProblemListener" --><!-- doxytag: inherits="ProblemListenerBase" -->
<p>This is the abstract class that the XSL processor uses when it has a problem of some kind, that requires a message, an error or a warning.
<a href="#_details">More...</a></p>
<p><code>#include &lt;<a class="el" href="ProblemListener_8hpp_source.html">ProblemListener.hpp</a>&gt;</code></p>
<p>Inherits <a class="el" href="classProblemListenerBase.html">ProblemListenerBase</a>.</p>
<p>Inherited by <a class="el" href="classProblemListenerDefault.html">ProblemListenerDefault</a>, and <a class="el" href="classXalanTransformerProblemListener.html">XalanTransformerProblemListener</a>.</p>
<div class="dynheader">
Collaboration diagram for ProblemListener:</div>
<div class="dyncontent">
<div class="center"><img src="classProblemListener__coll__graph.png" border="0" usemap="#ProblemListener_coll__map" alt="Collaboration graph"/></div>
<map name="ProblemListener_coll__map" id="ProblemListener_coll__map">
<area shape="rect" id="node2" href="classProblemListenerBase.html" title="This is the abstract class that is used when reporting a problem some kind, that requires a message..." alt="" coords="5,5,163,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classProblemListener-members.html">List of all members.</a></p>
<h2><a name="pub-types"></a>
Public Types</h2>
<ul>
<li>typedef <a class="el" href="classProblemListenerBase.html#ae363b5e4919bbe4e41f6b2c1b322ee7c">eSource</a> <a class="el" href="classProblemListener.html#a0b33a3762e89fbcfd751b5e7071ec14e">eProblemSource</a>
</ul>
<h2><a name="pub-methods"></a>
Public Member Functions</h2>
<ul>
<li><a class="el" href="classProblemListener.html#ab1fb673242fb090a9f8a457849cfecc0">ProblemListener</a> ()
<li>virtual <a class="el" href="classProblemListener.html#aa52d3c1ee291989052a050f74ad7ef08">~ProblemListener</a> ()
<li>virtual void <a class="el" href="classProblemListener.html#a204be0de52fc0c0e05bf3652c8ea7324">setPrintWriter</a> (<a class="el" href="classPrintWriter.html">PrintWriter</a> *pw)=0
<li>virtual void <a class="el" href="classProblemListener.html#a8629b542f8eb8b0ec791b8de63a1082b">problem</a> (<a class="el" href="classProblemListenerBase.html#ae363b5e4919bbe4e41f6b2c1b322ee7c">eSource</a> source, <a class="el" href="classProblemListenerBase.html#a1fec6cce6cc3429e200355330a41152a">eClassification</a> classification, const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;msg, const Locator *locator, const <a class="el" href="classXalanNode.html">XalanNode</a> *sourceNode)=0
<dl class="el"><dd class="mdescRight"><a class="el" href="classFunction.html">Function</a> that is called when a problem event occurs. <a href="#a8629b542f8eb8b0ec791b8de63a1082b"></a><br/></dl><li>virtual void <a class="el" href="classProblemListener.html#a4cd63f709a24a740a5faee8d150607a2">problem</a> (<a class="el" href="classProblemListenerBase.html#ae363b5e4919bbe4e41f6b2c1b322ee7c">eSource</a> source, <a class="el" href="classProblemListenerBase.html#a1fec6cce6cc3429e200355330a41152a">eClassification</a> classification, const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;msg, const <a class="el" href="classXalanNode.html">XalanNode</a> *sourceNode)=0
<dl class="el"><dd class="mdescRight"><a class="el" href="classFunction.html">Function</a> that is called when a problem event occurs. <a href="#a4cd63f709a24a740a5faee8d150607a2"></a><br/></dl><li>virtual void <a class="el" href="classProblemListener.html#aa82ddbdfd3d6843aac31796812fbb634">problem</a> (<a class="el" href="classProblemListenerBase.html#ae363b5e4919bbe4e41f6b2c1b322ee7c">eSource</a> source, <a class="el" href="classProblemListenerBase.html#a1fec6cce6cc3429e200355330a41152a">eClassification</a> classification, const <a class="el" href="classXalanNode.html">XalanNode</a> *sourceNode, const <a class="el" href="classElemTemplateElement.html">ElemTemplateElement</a> *styleNode, const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;msg, const XalanDOMChar *uri, XalanFileLoc lineNo, XalanFileLoc charOffset)=0
<dl class="el"><dd class="mdescRight"><a class="el" href="classFunction.html">Function</a> that is called when a problem event occurs. <a href="#aa82ddbdfd3d6843aac31796812fbb634"></a><br/></dl></ul>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>This is the abstract class that the XSL processor uses when it has a problem of some kind, that requires a message, an error or a warning. </p>
<p>Users should ask the <a class="el" href="classXSLTProcessor.html" title="This is an interface for an XSLT Processor engine.">XSLTProcessor</a> class to setProblemListener if they wish an object instance to be called when a problem event occurs. </p>
<p>Definition at line <a class="el" href="ProblemListener_8hpp_source.html#l00048">48</a> of file <a class="el" href="ProblemListener_8hpp_source.html">ProblemListener.hpp</a>.</p>
<hr/><h2>Member Typedef Documentation</h2>
<a class="anchor" id="a0b33a3762e89fbcfd751b5e7071ec14e"></a><!-- doxytag: member="ProblemListener::eProblemSource" ref="a0b33a3762e89fbcfd751b5e7071ec14e" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="classProblemListenerBase.html#ae363b5e4919bbe4e41f6b2c1b322ee7c">eSource</a> <a class="el" href="classProblemListenerBase.html#ae363b5e4919bbe4e41f6b2c1b322ee7c">ProblemListener::eProblemSource</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented from <a class="el" href="classProblemListenerBase.html#a9c9513a41170d6e3c7429a14943b7350">ProblemListenerBase</a>.</p>
<p>Definition at line <a class="el" href="ProblemListener_8hpp_source.html#l00053">53</a> of file <a class="el" href="ProblemListener_8hpp_source.html">ProblemListener.hpp</a>.</p>
</div>
</div>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="ab1fb673242fb090a9f8a457849cfecc0"></a><!-- doxytag: member="ProblemListener::ProblemListener" ref="ab1fb673242fb090a9f8a457849cfecc0" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ProblemListener::ProblemListener </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="aa52d3c1ee291989052a050f74ad7ef08"></a><!-- doxytag: member="ProblemListener::~ProblemListener" ref="aa52d3c1ee291989052a050f74ad7ef08" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual ProblemListener::~ProblemListener </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a8629b542f8eb8b0ec791b8de63a1082b"></a><!-- doxytag: member="ProblemListener::problem" ref="a8629b542f8eb8b0ec791b8de63a1082b" args="(eSource source, eClassification classification, const XalanDOMString &amp;msg, const Locator *locator, const XalanNode *sourceNode)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void ProblemListener::problem </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classProblemListenerBase.html#ae363b5e4919bbe4e41f6b2c1b322ee7c">eSource</a>&nbsp;</td>
<td class="paramname"> <em>source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classProblemListenerBase.html#a1fec6cce6cc3429e200355330a41152a">eClassification</a>&nbsp;</td>
<td class="paramname"> <em>classification</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;&nbsp;</td>
<td class="paramname"> <em>msg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const Locator *&nbsp;</td>
<td class="paramname"> <em>locator</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classXalanNode.html">XalanNode</a> *&nbsp;</td>
<td class="paramname"> <em>sourceNode</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classFunction.html">Function</a> that is called when a problem event occurs. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>source</em>&nbsp;</td><td>Either eXMLParser, eXSLProcessor, or eXPATH. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>classification</em>&nbsp;</td><td>Either eMessage, eWarning, or eError. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>locator</em>&nbsp;</td><td>The current Locator instance for the stylesheet. Maybe be a null pointer. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>sourceNode</em>&nbsp;</td><td>The current source node, if any. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>msg</em>&nbsp;</td><td>The error message. </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classProblemListenerBase.html#a50a8c4dee286543750b247df7ca99ca0">ProblemListenerBase</a>.</p>
<p>Implemented in <a class="el" href="classProblemListenerDefault.html#af6b426eaaa3ecc025c9501fff9bf8eea">ProblemListenerDefault</a>, and <a class="el" href="classXalanTransformerProblemListener.html#a40f9cfd45343956e1a0aca6b118d837d">XalanTransformerProblemListener</a>.</p>
</div>
</div>
<a class="anchor" id="aa82ddbdfd3d6843aac31796812fbb634"></a><!-- doxytag: member="ProblemListener::problem" ref="aa82ddbdfd3d6843aac31796812fbb634" args="(eSource source, eClassification classification, const XalanNode *sourceNode, const ElemTemplateElement *styleNode, const XalanDOMString &amp;msg, const XalanDOMChar *uri, XalanFileLoc lineNo, XalanFileLoc charOffset)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void ProblemListener::problem </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classProblemListenerBase.html#ae363b5e4919bbe4e41f6b2c1b322ee7c">eSource</a>&nbsp;</td>
<td class="paramname"> <em>source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classProblemListenerBase.html#a1fec6cce6cc3429e200355330a41152a">eClassification</a>&nbsp;</td>
<td class="paramname"> <em>classification</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classXalanNode.html">XalanNode</a> *&nbsp;</td>
<td class="paramname"> <em>sourceNode</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classElemTemplateElement.html">ElemTemplateElement</a> *&nbsp;</td>
<td class="paramname"> <em>styleNode</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;&nbsp;</td>
<td class="paramname"> <em>msg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const XalanDOMChar *&nbsp;</td>
<td class="paramname"> <em>uri</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">XalanFileLoc&nbsp;</td>
<td class="paramname"> <em>lineNo</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">XalanFileLoc&nbsp;</td>
<td class="paramname"> <em>charOffset</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classFunction.html">Function</a> that is called when a problem event occurs. </p>
<p>This function is deprecated. Use the overload with the Locator parameter instead. </p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000002">Deprecated:</a></b></dt><dd></dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>source</em>&nbsp;</td><td>either eXMLPARSER, eXSLPROCESSOR, or eXPATH </td></tr>
<tr><td valign="top"></td><td valign="top"><em>classification</em>&nbsp;</td><td>either eMESSAGE, eERROR or eWARNING </td></tr>
<tr><td valign="top"></td><td valign="top"><em>sourceNode</em>&nbsp;</td><td>source tree node where the problem occurred (may be 0) </td></tr>
<tr><td valign="top"></td><td valign="top"><em>styleNode</em>&nbsp;</td><td>style tree node where the problem occurred (may be 0) </td></tr>
<tr><td valign="top"></td><td valign="top"><em>msg</em>&nbsp;</td><td>string message explaining the problem. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>uri</em>&nbsp;</td><td>the URI of the document where the problem occurred. May be 0. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>lineNo</em>&nbsp;</td><td>line number where the problem occurred. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>charOffset</em>&nbsp;</td><td>character offset where the problem. </td></tr>
</table>
</dd>
</dl>
<p>Implemented in <a class="el" href="classProblemListenerDefault.html#a506e54fd8489a144f5e4cb1abc705cd9">ProblemListenerDefault</a>, and <a class="el" href="classXalanTransformerProblemListener.html#a8bbdabe32f8c7cd64f34302c638de3c4">XalanTransformerProblemListener</a>.</p>
</div>
</div>
<a class="anchor" id="a4cd63f709a24a740a5faee8d150607a2"></a><!-- doxytag: member="ProblemListener::problem" ref="a4cd63f709a24a740a5faee8d150607a2" args="(eSource source, eClassification classification, const XalanDOMString &amp;msg, const XalanNode *sourceNode)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void ProblemListener::problem </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classProblemListenerBase.html#ae363b5e4919bbe4e41f6b2c1b322ee7c">eSource</a>&nbsp;</td>
<td class="paramname"> <em>source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classProblemListenerBase.html#a1fec6cce6cc3429e200355330a41152a">eClassification</a>&nbsp;</td>
<td class="paramname"> <em>classification</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;&nbsp;</td>
<td class="paramname"> <em>msg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classXalanNode.html">XalanNode</a> *&nbsp;</td>
<td class="paramname"> <em>sourceNode</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classFunction.html">Function</a> that is called when a problem event occurs. </p>
<p>This version assumes location information is already formatted into the message.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>source</em>&nbsp;</td><td>either eXMLPARSER, eXSLPROCESSOR, or eXPATH </td></tr>
<tr><td valign="top"></td><td valign="top"><em>classification</em>&nbsp;</td><td>either eMESSAGE, eERROR or eWARNING </td></tr>
<tr><td valign="top"></td><td valign="top"><em>msg</em>&nbsp;</td><td>string message explaining the problem. </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classProblemListenerBase.html#ab0b6125dce1f0c27a3d91fdca012f3b4">ProblemListenerBase</a>.</p>
<p>Implemented in <a class="el" href="classProblemListenerDefault.html#aa08e26d43d4a1bb5270511cfc80e1e2f">ProblemListenerDefault</a>, and <a class="el" href="classXalanTransformerProblemListener.html#aa05eeec3e483444f1b57fa7b14f65890">XalanTransformerProblemListener</a>.</p>
</div>
</div>
<a class="anchor" id="a204be0de52fc0c0e05bf3652c8ea7324"></a><!-- doxytag: member="ProblemListener::setPrintWriter" ref="a204be0de52fc0c0e05bf3652c8ea7324" args="(PrintWriter *pw)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void ProblemListener::setPrintWriter </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classPrintWriter.html">PrintWriter</a> *&nbsp;</td>
<td class="paramname"> <em>pw</em></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Implemented in <a class="el" href="classProblemListenerDefault.html#af9f81b7f10a47787a2133d36a0057845">ProblemListenerDefault</a>, and <a class="el" href="classXalanTransformerProblemListener.html#a29726f501b05c38a7e9b9212dd664561">XalanTransformerProblemListener</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="ProblemListener_8hpp_source.html">ProblemListener.hpp</a></li>
</ul>
</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>