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

239 lines
12 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.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;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 class="tabs">
<ul>
<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="contents">
<h1>LocationInfo Class Reference</h1><!-- doxytag: class="LocationInfo" -->
<p>A class that gives records a location in the query.
<a href="#_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="dynsection">
<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" href="classResultImpl.html" title="A lazily evaluated query result." alt="" coords="128,83,211,112"/><area shape="rect" href="classGenerateEventsResult.html" title="GenerateEventsResult" alt="" coords="5,160,157,189"/><area shape="rect" title="Top level lazy result iterator." alt="" coords="181,160,336,189"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classLocationInfo-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLocationInfo.html#a5c76b8f6805ea9c2115d342b5032a89b">LocationInfo</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor that sets the information to 0. <a href="#a5c76b8f6805ea9c2115d342b5032a89b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</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><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor that takes the initial information. <a href="#a6707d1df52d987f0d27b5f729e1345ea"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const XMLCh *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLocationInfo.html#a91188c6e8540e3ca6a8982295a33abb9">getFile</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The file that the query was parsed from. <a href="#a91188c6e8540e3ca6a8982295a33abb9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLocationInfo.html#ae54c9c58cf764fd31faf19377ce056bb">getLine</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The line in the query. <a href="#ae54c9c58cf764fd31faf19377ce056bb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLocationInfo.html#a3da5fe46f09faedc38f910171812befa">getColumn</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The column in the query. <a href="#a3da5fe46f09faedc38f910171812befa"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</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><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the location to the given information. <a href="#a7d0654fb1459d1ae3e328e7a5ea3b40f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</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><td class="mdescLeft">&nbsp;</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"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>A class that gives records a location in the query. </p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a5c76b8f6805ea9c2115d342b5032a89b"></a><!-- doxytag: member="LocationInfo::LocationInfo" ref="a5c76b8f6805ea9c2115d342b5032a89b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LocationInfo::LocationInfo </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor that sets the information to 0. </p>
</div>
</div>
<a class="anchor" id="a6707d1df52d987f0d27b5f729e1345ea"></a><!-- doxytag: member="LocationInfo::LocationInfo" ref="a6707d1df52d987f0d27b5f729e1345ea" args="(const XMLCh *file, unsigned int line, unsigned int column)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LocationInfo::LocationInfo </td>
<td>(</td>
<td class="paramtype">const XMLCh *&nbsp;</td>
<td class="paramname"> <em>file</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int&nbsp;</td>
<td class="paramname"> <em>line</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int&nbsp;</td>
<td class="paramname"> <em>column</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor that takes the initial information. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a3da5fe46f09faedc38f910171812befa"></a><!-- doxytag: member="LocationInfo::getColumn" ref="a3da5fe46f09faedc38f910171812befa" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int LocationInfo::getColumn </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The column in the query. </p>
</div>
</div>
<a class="anchor" id="a91188c6e8540e3ca6a8982295a33abb9"></a><!-- doxytag: member="LocationInfo::getFile" ref="a91188c6e8540e3ca6a8982295a33abb9" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const XMLCh* LocationInfo::getFile </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [inline]</code></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><!-- doxytag: member="LocationInfo::getLine" ref="ae54c9c58cf764fd31faf19377ce056bb" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int LocationInfo::getLine </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The line in the query. </p>
</div>
</div>
<a class="anchor" id="a7c1455041c480e753b5c49addc827494"></a><!-- doxytag: member="LocationInfo::setLocationInfo" ref="a7c1455041c480e753b5c49addc827494" args="(const LocationInfo *o)" -->
<div class="memitem">
<div class="memproto">
<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> *&nbsp;</td>
<td class="paramname"> <em>o</em></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [inline]</code></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>
<a class="anchor" id="a7d0654fb1459d1ae3e328e7a5ea3b40f"></a><!-- doxytag: member="LocationInfo::setLocationInfo" ref="a7d0654fb1459d1ae3e328e7a5ea3b40f" args="(const XMLCh *file, unsigned int line, unsigned int column)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void LocationInfo::setLocationInfo </td>
<td>(</td>
<td class="paramtype">const XMLCh *&nbsp;</td>
<td class="paramname"> <em>file</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int&nbsp;</td>
<td class="paramname"> <em>line</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int&nbsp;</td>
<td class="paramname"> <em>column</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the location to the given information. </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>
<hr size="1"/><address style="text-align: right;"><small>Generated on Mon Mar 1 21:16:14 2010 for XQilla Simple API by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>