<!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"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>Snake: Interface.GUI 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/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</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 id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Snake
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<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="pages.html"><span>Related 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>
<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="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)">
</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>Interface</b></li><li class="navelem"><a class="el" href="classInterface_1_1GUI.html">GUI</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classInterface_1_1GUI-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Interface.GUI Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A Class that will contain useful functions in order for the creation of main interface.
<a href="classInterface_1_1GUI.html#details">More...</a></p>
<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:aea50c45b0173d626777b9aee47a23591"><td class="memItemLeft" align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="classInterface_1_1GUI.html#aea50c45b0173d626777b9aee47a23591">runfile</a> (runfilename)</td></tr>
<tr class="memdesc:aea50c45b0173d626777b9aee47a23591"><td class="mdescLeft"> </td><td class="mdescRight">A function for running other files. <a href="#aea50c45b0173d626777b9aee47a23591">More...</a><br /></td></tr>
<tr class="separator:aea50c45b0173d626777b9aee47a23591"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6e96c109143b0d74c039338673435280"><td class="memItemLeft" align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="classInterface_1_1GUI.html#a6e96c109143b0d74c039338673435280">button</a> (Surface, color, Rect, width)</td></tr>
<tr class="memdesc:a6e96c109143b0d74c039338673435280"><td class="mdescLeft"> </td><td class="mdescRight">A method to create a button. <a href="#a6e96c109143b0d74c039338673435280">More...</a><br /></td></tr>
<tr class="separator:a6e96c109143b0d74c039338673435280"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1017c12e07fbe580fa27aa4c0c634b93"><td class="memItemLeft" align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="classInterface_1_1GUI.html#a1017c12e07fbe580fa27aa4c0c634b93">text</a> (text, fontStyle, fontSize, color, coord, surface)</td></tr>
<tr class="memdesc:a1017c12e07fbe580fa27aa4c0c634b93"><td class="mdescLeft"> </td><td class="mdescRight">A method to display text. <a href="#a1017c12e07fbe580fa27aa4c0c634b93">More...</a><br /></td></tr>
<tr class="separator:a1017c12e07fbe580fa27aa4c0c634b93"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A Class that will contain useful functions in order for the creation of main interface. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a6e96c109143b0d74c039338673435280"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">def Interface.GUI.button </td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>Surface</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><em>color</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><em>Rect</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><em>width</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>A method to create a button. </p>
<p>This method will make a box on the interface </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">surface</td><td>The background (surface) the box should be made on </td></tr>
<tr><td class="paramname">color</td><td>The color of the button to be made </td></tr>
<tr><td class="paramname">Rect</td><td>The coordinate of the button with the length and width </td></tr>
<tr><td class="paramname">width</td><td>The width of the sides of button </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aea50c45b0173d626777b9aee47a23591"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">def Interface.GUI.runfile </td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>runfilename</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>A function for running other files. </p>
<p>Executes another python file when this is selected, Given that the file is in same folder. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">runfilename</td><td>The name of the file to be executed </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a1017c12e07fbe580fa27aa4c0c634b93"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">def Interface.GUI.text </td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>text</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><em>fontStyle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><em>fontSize</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><em>color</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><em>coord</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><em>surface</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>A method to display text. </p>
<p>This function will print the text on the interface </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">text</td><td>The text to be printed </td></tr>
<tr><td class="paramname">fontStyle</td><td>The font Style of the text to be displayed </td></tr>
<tr><td class="paramname">fontSize</td><td>The size of the text written </td></tr>
<tr><td class="paramname">color</td><td>The color of the text </td></tr>
<tr><td class="paramname">coord</td><td>The coordinate at which the text should start displaying </td></tr>
<tr><td class="paramname">surface</td><td>The background (surface) the text should be printed on </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>Interface.py</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>