XQuilla/docs/simple-api/classLocationInfo.html
2020-02-17 22:24:47 +01:00

298 lines
13 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 Simple 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&amp;type=2" border="0" alt="SourceForge.net Logo" /></a>
<!-- Generated by Doxygen 1.8.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</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>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classLocationInfo-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">LocationInfo Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A class that gives records a location in the query.
<a href="classLocationInfo.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="LocationInfo_8hpp_source.html">LocationInfo.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for LocationInfo:</div>
<div class="dyncontent">
<div class="center"><img src="classLocationInfo__inherit__graph.png" border="0" usemap="#LocationInfo_inherit__map" alt="Inheritance graph"/></div>
<map name="LocationInfo_inherit__map" id="LocationInfo_inherit__map">
<area shape="rect" id="node2" href="classResultImpl.html" title="A lazily evaluated query result. " alt="" coords="9,80,95,107"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a5c76b8f6805ea9c2115d342b5032a89b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLocationInfo.html#a5c76b8f6805ea9c2115d342b5032a89b">LocationInfo</a> ()</td></tr>
<tr class="memdesc:a5c76b8f6805ea9c2115d342b5032a89b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor that sets the information to 0. <a href="#a5c76b8f6805ea9c2115d342b5032a89b">More...</a><br/></td></tr>
<tr class="separator:a5c76b8f6805ea9c2115d342b5032a89b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6707d1df52d987f0d27b5f729e1345ea"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLocationInfo.html#a6707d1df52d987f0d27b5f729e1345ea">LocationInfo</a> (const XMLCh *file, unsigned int line, unsigned int column)</td></tr>
<tr class="memdesc:a6707d1df52d987f0d27b5f729e1345ea"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor that takes the initial information. <a href="#a6707d1df52d987f0d27b5f729e1345ea">More...</a><br/></td></tr>
<tr class="separator:a6707d1df52d987f0d27b5f729e1345ea"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a91188c6e8540e3ca6a8982295a33abb9"><td class="memItemLeft" align="right" valign="top">const XMLCh *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLocationInfo.html#a91188c6e8540e3ca6a8982295a33abb9">getFile</a> () const </td></tr>
<tr class="memdesc:a91188c6e8540e3ca6a8982295a33abb9"><td class="mdescLeft">&#160;</td><td class="mdescRight">The file that the query was parsed from. <a href="#a91188c6e8540e3ca6a8982295a33abb9">More...</a><br/></td></tr>
<tr class="separator:a91188c6e8540e3ca6a8982295a33abb9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae54c9c58cf764fd31faf19377ce056bb"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLocationInfo.html#ae54c9c58cf764fd31faf19377ce056bb">getLine</a> () const </td></tr>
<tr class="memdesc:ae54c9c58cf764fd31faf19377ce056bb"><td class="mdescLeft">&#160;</td><td class="mdescRight">The line in the query. <a href="#ae54c9c58cf764fd31faf19377ce056bb">More...</a><br/></td></tr>
<tr class="separator:ae54c9c58cf764fd31faf19377ce056bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3da5fe46f09faedc38f910171812befa"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLocationInfo.html#a3da5fe46f09faedc38f910171812befa">getColumn</a> () const </td></tr>
<tr class="memdesc:a3da5fe46f09faedc38f910171812befa"><td class="mdescLeft">&#160;</td><td class="mdescRight">The column in the query. <a href="#a3da5fe46f09faedc38f910171812befa">More...</a><br/></td></tr>
<tr class="separator:a3da5fe46f09faedc38f910171812befa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7d0654fb1459d1ae3e328e7a5ea3b40f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLocationInfo.html#a7d0654fb1459d1ae3e328e7a5ea3b40f">setLocationInfo</a> (const XMLCh *file, unsigned int line, unsigned int column)</td></tr>
<tr class="memdesc:a7d0654fb1459d1ae3e328e7a5ea3b40f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the location to the given information. <a href="#a7d0654fb1459d1ae3e328e7a5ea3b40f">More...</a><br/></td></tr>
<tr class="separator:a7d0654fb1459d1ae3e328e7a5ea3b40f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7c1455041c480e753b5c49addc827494"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLocationInfo.html#a7c1455041c480e753b5c49addc827494">setLocationInfo</a> (const <a class="el" href="classLocationInfo.html">LocationInfo</a> *o)</td></tr>
<tr class="memdesc:a7c1455041c480e753b5c49addc827494"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the location with the information in the given <a class="el" href="classLocationInfo.html" title="A class that gives records a location in the query. ">LocationInfo</a> object. <a href="#a7c1455041c480e753b5c49addc827494">More...</a><br/></td></tr>
<tr class="separator:a7c1455041c480e753b5c49addc827494"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A class that gives records a location in the query. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a5c76b8f6805ea9c2115d342b5032a89b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">LocationInfo::LocationInfo </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor that sets the information to 0. </p>
</div>
</div>
<a class="anchor" id="a6707d1df52d987f0d27b5f729e1345ea"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">LocationInfo::LocationInfo </td>
<td>(</td>
<td class="paramtype">const XMLCh *&#160;</td>
<td class="paramname"><em>file</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int&#160;</td>
<td class="paramname"><em>line</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int&#160;</td>
<td class="paramname"><em>column</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor that takes the initial information. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a3da5fe46f09faedc38f910171812befa"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">unsigned int LocationInfo::getColumn </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The column in the query. </p>
</div>
</div>
<a class="anchor" id="a91188c6e8540e3ca6a8982295a33abb9"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const XMLCh* LocationInfo::getFile </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The file that the query was parsed from. </p>
<p>This could be null. </p>
</div>
</div>
<a class="anchor" id="ae54c9c58cf764fd31faf19377ce056bb"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">unsigned int LocationInfo::getLine </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The line in the query. </p>
</div>
</div>
<a class="anchor" id="a7d0654fb1459d1ae3e328e7a5ea3b40f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void LocationInfo::setLocationInfo </td>
<td>(</td>
<td class="paramtype">const XMLCh *&#160;</td>
<td class="paramname"><em>file</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int&#160;</td>
<td class="paramname"><em>line</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int&#160;</td>
<td class="paramname"><em>column</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the location to the given information. </p>
</div>
</div>
<a class="anchor" id="a7c1455041c480e753b5c49addc827494"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void LocationInfo::setLocationInfo </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classLocationInfo.html">LocationInfo</a> *&#160;</td>
<td class="paramname"><em>o</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the location with the information in the given <a class="el" href="classLocationInfo.html" title="A class that gives records a location in the query. ">LocationInfo</a> object. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="LocationInfo_8hpp_source.html">LocationInfo.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>