XQuilla/docs/simple-api/classLocationInfo.html

293 lines
12 KiB
HTML
Raw Normal View History

2020-02-17 21:13:50 +00:00
<!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>
2020-02-17 21:19:08 +00:00
<!-- Generated by Doxygen 1.3.9.1 -->
<div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="namespacemembers.html">Namespace&nbsp;Members</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a> | <a class="qindex" href="examples.html">Examples</a></div>
<h1>LocationInfo Class Reference</h1>A class that gives records a location in the query.
2020-02-17 21:13:50 +00:00
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="LocationInfo_8hpp-source.html">LocationInfo.hpp</a>&gt;</code>
<p>
2020-02-17 21:19:08 +00:00
Inheritance diagram for LocationInfo:<p><center><img src="classLocationInfo__inherit__graph.png" border="0" usemap="#LocationInfo__inherit__map" alt="Inheritance graph"></center>
2020-02-17 21:13:50 +00:00
<map name="LocationInfo__inherit__map">
2020-02-17 21:19:08 +00:00
<area href="classResultImpl.html" shape="rect" coords="129,81,215,105" alt="">
<area href="classGenerateEventsResult.html" shape="rect" coords="5,156,160,180" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classLocationInfo-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
2020-02-17 21:13:50 +00:00
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
2020-02-17 21:19:08 +00:00
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLocationInfo.html#a0">LocationInfo</a> ()</td></tr>
2020-02-17 21:13:50 +00:00
2020-02-17 21:19:08 +00:00
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor that sets the information to 0. <a href="#a0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLocationInfo.html#a1">LocationInfo</a> (const XMLCh *file, unsigned int line, unsigned int column)</td></tr>
2020-02-17 21:13:50 +00:00
2020-02-17 21:19:08 +00:00
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor that takes the initial information. <a href="#a1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const XMLCh *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLocationInfo.html#a2">getFile</a> () const </td></tr>
2020-02-17 21:13:50 +00:00
2020-02-17 21:19:08 +00:00
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The file that the query was parsed from. <a href="#a2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLocationInfo.html#a3">getLine</a> () const </td></tr>
2020-02-17 21:13:50 +00:00
2020-02-17 21:19:08 +00:00
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The line in the query. <a href="#a3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLocationInfo.html#a4">getColumn</a> () const </td></tr>
2020-02-17 21:13:50 +00:00
2020-02-17 21:19:08 +00:00
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The column in the query. <a href="#a4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLocationInfo.html#a5">setLocationInfo</a> (const XMLCh *file, unsigned int line, unsigned int column)</td></tr>
2020-02-17 21:13:50 +00:00
2020-02-17 21:19:08 +00:00
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the location to the given information. <a href="#a5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLocationInfo.html#a6">setLocationInfo</a> (const <a class="el" href="classLocationInfo.html">LocationInfo</a> *o)</td></tr>
2020-02-17 21:13:50 +00:00
2020-02-17 21:19:08 +00:00
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the location with the information in the given LocationInfo object. <a href="#a6"></a><br></td></tr>
2020-02-17 21:13:50 +00:00
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
2020-02-17 21:19:08 +00:00
A class that gives records a location in the query.
<p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="a0" doxytag="LocationInfo::LocationInfo"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
2020-02-17 21:13:50 +00:00
<tr>
2020-02-17 21:19:08 +00:00
<td class="md" nowrap valign="top">LocationInfo::LocationInfo </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap><code> [inline]</code></td>
2020-02-17 21:13:50 +00:00
</tr>
</table>
2020-02-17 21:19:08 +00:00
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
2020-02-17 21:13:50 +00:00
<p>
Constructor that sets the information to 0.
<p>
2020-02-17 21:19:08 +00:00
</td>
</tr>
</table>
<a class="anchor" name="a1" doxytag="LocationInfo::LocationInfo"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
2020-02-17 21:13:50 +00:00
<tr>
2020-02-17 21:19:08 +00:00
<td class="md" nowrap valign="top">LocationInfo::LocationInfo </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const XMLCh *&nbsp;</td>
<td class="mdname" nowrap> <em>file</em>, </td>
2020-02-17 21:13:50 +00:00
</tr>
<tr>
2020-02-17 21:19:08 +00:00
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>unsigned int&nbsp;</td>
<td class="mdname" nowrap> <em>line</em>, </td>
2020-02-17 21:13:50 +00:00
</tr>
<tr>
2020-02-17 21:19:08 +00:00
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>unsigned int&nbsp;</td>
<td class="mdname" nowrap> <em>column</em></td>
2020-02-17 21:13:50 +00:00
</tr>
<tr>
2020-02-17 21:19:08 +00:00
<td class="md"></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"><code> [inline]</code></td>
2020-02-17 21:13:50 +00:00
</tr>
</table>
2020-02-17 21:19:08 +00:00
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
2020-02-17 21:13:50 +00:00
<p>
Constructor that takes the initial information.
<p>
2020-02-17 21:19:08 +00:00
</td>
</tr>
</table>
2020-02-17 21:13:50 +00:00
<hr><h2>Member Function Documentation</h2>
2020-02-17 21:19:08 +00:00
<a class="anchor" name="a4" doxytag="LocationInfo::getColumn"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
2020-02-17 21:13:50 +00:00
<tr>
2020-02-17 21:19:08 +00:00
<td class="md" nowrap valign="top">unsigned int LocationInfo::getColumn </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap> const<code> [inline]</code></td>
2020-02-17 21:13:50 +00:00
</tr>
</table>
2020-02-17 21:19:08 +00:00
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
The column in the query.
<p>
</td>
</tr>
</table>
<a class="anchor" name="a2" doxytag="LocationInfo::getFile"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">const XMLCh* LocationInfo::getFile </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap> const<code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
2020-02-17 21:13:50 +00:00
<p>
The file that the query was parsed from.
<p>
2020-02-17 21:19:08 +00:00
This could be null. </td>
</tr>
</table>
<a class="anchor" name="a3" doxytag="LocationInfo::getLine"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
2020-02-17 21:13:50 +00:00
<tr>
2020-02-17 21:19:08 +00:00
<td class="md" nowrap valign="top">unsigned int LocationInfo::getLine </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap> const<code> [inline]</code></td>
2020-02-17 21:13:50 +00:00
</tr>
</table>
2020-02-17 21:19:08 +00:00
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
2020-02-17 21:13:50 +00:00
<p>
The line in the query.
<p>
2020-02-17 21:19:08 +00:00
</td>
</tr>
</table>
<a class="anchor" name="a6" doxytag="LocationInfo::setLocationInfo"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
2020-02-17 21:13:50 +00:00
<tr>
2020-02-17 21:19:08 +00:00
<td class="md" nowrap valign="top">void LocationInfo::setLocationInfo </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const <a class="el" href="classLocationInfo.html">LocationInfo</a> *&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>o</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap><code> [inline]</code></td>
2020-02-17 21:13:50 +00:00
</tr>
</table>
2020-02-17 21:19:08 +00:00
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
2020-02-17 21:13:50 +00:00
<p>
2020-02-17 21:19:08 +00:00
Sets the location with the information in the given LocationInfo object.
2020-02-17 21:13:50 +00:00
<p>
2020-02-17 21:19:08 +00:00
</td>
</tr>
</table>
<a class="anchor" name="a5" doxytag="LocationInfo::setLocationInfo"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
2020-02-17 21:13:50 +00:00
<tr>
2020-02-17 21:19:08 +00:00
<td class="md" nowrap valign="top">void LocationInfo::setLocationInfo </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const XMLCh *&nbsp;</td>
<td class="mdname" nowrap> <em>file</em>, </td>
2020-02-17 21:13:50 +00:00
</tr>
<tr>
2020-02-17 21:19:08 +00:00
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>unsigned int&nbsp;</td>
<td class="mdname" nowrap> <em>line</em>, </td>
2020-02-17 21:13:50 +00:00
</tr>
<tr>
2020-02-17 21:19:08 +00:00
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>unsigned int&nbsp;</td>
<td class="mdname" nowrap> <em>column</em></td>
2020-02-17 21:13:50 +00:00
</tr>
<tr>
2020-02-17 21:19:08 +00:00
<td class="md"></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"><code> [inline]</code></td>
2020-02-17 21:13:50 +00:00
</tr>
</table>
2020-02-17 21:19:08 +00:00
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
2020-02-17 21:13:50 +00:00
<p>
Sets the location to the given information.
<p>
2020-02-17 21:19:08 +00:00
</td>
</tr>
</table>
2020-02-17 21:13:50 +00:00
<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></ul>
2020-02-17 21:19:08 +00:00
<hr size="1"><address style="align: right;"><small>Generated on Fri Sep 25 06:55:41 2009 for XQilla Simple API by&nbsp;
2020-02-17 21:13:50 +00:00
<a href="http://www.doxygen.org/index.html">
2020-02-17 21:19:08 +00:00
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.3.9.1 </small></address>
2020-02-17 21:13:50 +00:00
</body>
</html>