<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Lutok: lutok::api_error Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Lutok
 <span id="projectnumber">0.4</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main 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>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Macros</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>lutok</b></li><li class="navelem"><a class="el" href="a00002.html">api_error</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="#pri-attribs">Private Attributes</a> </div>
<div class="headertitle">
<div class="title">lutok::api_error Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Exception for errors raised by the Lua API library.
<a href="a00002.html#details">More...</a></p>
<p><code>#include <<a class="el" href="a00019_source.html">exceptions.hpp</a>></code></p>
<div class="dynheader">
Inheritance diagram for lutok::api_error:</div>
<div class="dyncontent">
<div class="center">
<img src="a00002.png" usemap="#lutok::api_error_map" alt=""/>
<map id="lutok::api_error_map" name="lutok::api_error_map">
<area href="a00005.html" title="Base exception for lua errors." alt="lutok::error" shape="rect" coords="0,0,97,24"/>
</map>
</div></div>
<p><a href="a00044.html">List of all members.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aa751d87577c1b62a6aa91b183e5f00d0"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00002.html#aa751d87577c1b62a6aa91b183e5f00d0">api_error</a> (const std::string &, const std::string &)</td></tr>
<tr class="memdesc:aa751d87577c1b62a6aa91b183e5f00d0"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a new error. <a href="#aa751d87577c1b62a6aa91b183e5f00d0"></a><br/></td></tr>
<tr class="memitem:ae7072e5ca79e159f18142b967279659b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae7072e5ca79e159f18142b967279659b"></a>
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="a00002.html#ae7072e5ca79e159f18142b967279659b">~api_error</a> (void) throw ()</td></tr>
<tr class="memdesc:ae7072e5ca79e159f18142b967279659b"><td class="mdescLeft"> </td><td class="mdescRight">Destructor for the error. <br/></td></tr>
<tr class="memitem:a5558d8cf055e38904d3e571781e50b4b"><td class="memItemLeft" align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00002.html#a5558d8cf055e38904d3e571781e50b4b">api_function</a> (void) const </td></tr>
<tr class="memdesc:a5558d8cf055e38904d3e571781e50b4b"><td class="mdescLeft"> </td><td class="mdescRight">Gets the name of the Lua API function that caused this error. <a href="#a5558d8cf055e38904d3e571781e50b4b"></a><br/></td></tr>
<tr class="inherit_header pub_methods_a00005"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_a00005')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="a00005.html">lutok::error</a></td></tr>
<tr class="memitem:a0c0a2ad18088fcafc0ca2a3b61ac5e00 inherit pub_methods_a00005"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00005.html#a0c0a2ad18088fcafc0ca2a3b61ac5e00">error</a> (const std::string &)</td></tr>
<tr class="memdesc:a0c0a2ad18088fcafc0ca2a3b61ac5e00 inherit pub_methods_a00005"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a new error with a plain-text message. <a href="#a0c0a2ad18088fcafc0ca2a3b61ac5e00"></a><br/></td></tr>
<tr class="memitem:a0e8084a7eaeb9c462e9ebfe26c3c86e8 inherit pub_methods_a00005"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0e8084a7eaeb9c462e9ebfe26c3c86e8"></a>
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="a00005.html#a0e8084a7eaeb9c462e9ebfe26c3c86e8">~error</a> (void) throw ()</td></tr>
<tr class="memdesc:a0e8084a7eaeb9c462e9ebfe26c3c86e8 inherit pub_methods_a00005"><td class="mdescLeft"> </td><td class="mdescRight">Destructor for the error. <br/></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:af34f12d221dbed4effb57ca541b609d5"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="a00002.html">api_error</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00002.html#af34f12d221dbed4effb57ca541b609d5">from_stack</a> (<a class="el" href="a00009.html">state</a> &, const std::string &)</td></tr>
<tr class="memdesc:af34f12d221dbed4effb57ca541b609d5"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a new <a class="el" href="a00002.html" title="Exception for errors raised by the Lua API library.">api_error</a> with the message on the top of the Lua stack. <a href="#af34f12d221dbed4effb57ca541b609d5"></a><br/></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a947be5cc18d28f4feed48cdb8362a9f4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a947be5cc18d28f4feed48cdb8362a9f4"></a>
std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="a00002.html#a947be5cc18d28f4feed48cdb8362a9f4">_api_function</a></td></tr>
<tr class="memdesc:a947be5cc18d28f4feed48cdb8362a9f4"><td class="mdescLeft"> </td><td class="mdescRight">Name of the Lua C API function that caused the error. <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Exception for errors raised by the Lua API library. </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="aa751d87577c1b62a6aa91b183e5f00d0"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">lutok::api_error::api_error </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>api_function_</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>message</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructs a new error. </p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">api_function_</td><td>The name of the API function that caused the error. </td></tr>
<tr><td class="paramname">message</td><td>The plain-text error message provided by Lua. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a5558d8cf055e38904d3e571781e50b4b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const std::string & lutok::api_error::api_function </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the name of the Lua API function that caused this error. </p>
<dl class="section return"><dt>Returns:</dt><dd>The name of the function. </dd></dl>
</div>
</div>
<a class="anchor" id="af34f12d221dbed4effb57ca541b609d5"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00002.html">lutok::api_error</a> lutok::api_error::from_stack </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00009.html">state</a> & </td>
<td class="paramname"><em>state_</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>api_function_</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructs a new <a class="el" href="a00002.html" title="Exception for errors raised by the Lua API library.">api_error</a> with the message on the top of the Lua stack. </p>
<dl class="section pre"><dt>Precondition:</dt><dd>There is an error message on the top of the stack. </dd></dl>
<dl class="section post"><dt>Postcondition:</dt><dd>The error message is popped from the stack.</dd></dl>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">state_</td><td>The Lua state. </td></tr>
<tr><td class="paramname">api_function_</td><td>The name of the Lua API function that caused the error.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns:</dt><dd>A new <a class="el" href="a00002.html" title="Exception for errors raised by the Lua API library.">api_error</a> with the popped message. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="a00019_source.html">exceptions.hpp</a></li>
<li>exceptions.cpp</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Dec 7 2013 19:02:36 for Lutok by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.1
</small></address>
</body>
</html>
distrib
>
Mageia
>
7
>
armv7hl
>
media
>
core-release
>
by-pkgid
>
7bace28d5ea6c160bc0c4eb9c0a59d61
>
files
>
10
