147 lines
14 KiB
HTML
147 lines
14 KiB
HTML
<!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.9.1"/>
|
|
<title>discoverpixy: common/gui/screen.h Source File</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 style="padding-left: 0.5em;">
|
|
<div id="projectname">discoverpixy
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.9.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="modules.html"><span>Modules</span></a></li>
|
|
<li><a href="annotated.html"><span>Data Structures</span></a></li>
|
|
<li class="current"><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="files.html"><span>File List</span></a></li>
|
|
<li><a href="globals.html"><span>Globals</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"><a class="el" href="dir_bdd9a5d540de89e9fe90efdfc6973a4f.html">common</a></li><li class="navelem"><a class="el" href="dir_ad7e3681fbb6f77d8ce503c4a3117735.html">gui</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">screen.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="screen_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#ifndef SCREEN_H</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define SCREEN_H</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> </div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> </div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> </div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#include <stdio.h></span></div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#include <stdbool.h></span></div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"><a class="line" href="group__screen.html#gad87c84be7c1bc93ec95a1fa03f49e06d"> 18</a></span> <span class="keyword">typedef</span> void (*<a class="code" href="group__screen.html#gad87c84be7c1bc93ec95a1fa03f49e06d">SCREEN_CALLBACK</a>)(<span class="keywordtype">void</span>* <a class="code" href="screen__filetest_8c.html#a939fdd806f427cc8505ed817e28cce9d">screen</a>); </div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"><a class="line" href="struct_s_c_r_e_e_n___s.html"> 20</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="struct_s_c_r_e_e_n___s.html">SCREEN_S</a>{</div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"><a class="line" href="group__gui.html#gae6559e38ebbedb8f94a8754256dc454b"> 21</a></span>  <a class="code" href="group__screen.html#gad87c84be7c1bc93ec95a1fa03f49e06d">SCREEN_CALLBACK</a> <a class="code" href="group__gui.html#gae6559e38ebbedb8f94a8754256dc454b">on_enter</a>;</div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"><a class="line" href="group__gui.html#ga5e8f3db07ddecd10762ce1088cb2fbd8"> 22</a></span>  <a class="code" href="group__screen.html#gad87c84be7c1bc93ec95a1fa03f49e06d">SCREEN_CALLBACK</a> <a class="code" href="group__gui.html#ga5e8f3db07ddecd10762ce1088cb2fbd8">on_leave</a>;</div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"><a class="line" href="group__gui.html#gac795215b462e455f4d482f38c05e0b40"> 23</a></span>  <a class="code" href="group__screen.html#gad87c84be7c1bc93ec95a1fa03f49e06d">SCREEN_CALLBACK</a> <a class="code" href="group__gui.html#gac795215b462e455f4d482f38c05e0b40">on_update</a>;</div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="group__gui.html#ga914e64c0c6cfaf4f7b2b0c3493f0cbf2"> 26</a></span>  <span class="keyword">struct </span><a class="code" href="struct_s_c_r_e_e_n___s.html">SCREEN_S</a>* <a class="code" href="group__gui.html#ga914e64c0c6cfaf4f7b2b0c3493f0cbf2">next</a>; <span class="comment">//Used internally. do not modify</span></div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> } <a class="code" href="group__screen.html#gaf7783b8728d6d218aa9e3b29eaf9689c">SCREEN_STRUCT</a>;</div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment">//Navigate to the given string as soon as the app enters the main loop again. Method can be called from an interrupt</span></div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keywordtype">bool</span> <a class="code" href="group__screen.html#gad4473a16eaf48dab405d23f5f63af3aa">gui_screen_navigate</a>(<a class="code" href="struct_s_c_r_e_e_n___s.html">SCREEN_STRUCT</a>* <a class="code" href="screen__filetest_8c.html#a939fdd806f427cc8505ed817e28cce9d">screen</a>);</div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment">//Navigate one screen back as soon as the app enters the main loop again. Method can be called from an interrupt</span></div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="keywordtype">bool</span> <a class="code" href="group__screen.html#ga8e14bc7ee0214e2926965f9bdb54a866">gui_screen_back</a>();</div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment">//Returns the current active screen</span></div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <a class="code" href="struct_s_c_r_e_e_n___s.html">SCREEN_STRUCT</a>* <a class="code" href="group__screen.html#gae57813381133ca7d2e50f6823e41aaf9">gui_screen_get_current</a>();</div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment">//Updates/switches the screens. Call this from the app main loop, as fast as you can.</span></div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="keywordtype">void</span> <a class="code" href="group__screen.html#gab7394734ee1d57093721cbd22b901323">gui_screen_update</a>();</div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="preprocessor">#endif </span><span class="comment">/* SCREEN_H */</span><span class="preprocessor"></span></div>
|
|
<div class="ttc" id="group__screen_html_gaf7783b8728d6d218aa9e3b29eaf9689c"><div class="ttname"><a href="group__screen.html#gaf7783b8728d6d218aa9e3b29eaf9689c">SCREEN_STRUCT</a></div><div class="ttdeci">struct SCREEN_S SCREEN_STRUCT</div></div>
|
|
<div class="ttc" id="group__screen_html_gab7394734ee1d57093721cbd22b901323"><div class="ttname"><a href="group__screen.html#gab7394734ee1d57093721cbd22b901323">gui_screen_update</a></div><div class="ttdeci">void gui_screen_update()</div><div class="ttdef"><b>Definition:</b> screen.c:12</div></div>
|
|
<div class="ttc" id="group__gui_html_ga5e8f3db07ddecd10762ce1088cb2fbd8"><div class="ttname"><a href="group__gui.html#ga5e8f3db07ddecd10762ce1088cb2fbd8">SCREEN_S::on_leave</a></div><div class="ttdeci">SCREEN_CALLBACK on_leave</div><div class="ttdef"><b>Definition:</b> screen.h:22</div></div>
|
|
<div class="ttc" id="group__gui_html_ga914e64c0c6cfaf4f7b2b0c3493f0cbf2"><div class="ttname"><a href="group__gui.html#ga914e64c0c6cfaf4f7b2b0c3493f0cbf2">SCREEN_S::next</a></div><div class="ttdeci">struct SCREEN_S * next</div><div class="ttdef"><b>Definition:</b> screen.h:26</div></div>
|
|
<div class="ttc" id="group__screen_html_gae57813381133ca7d2e50f6823e41aaf9"><div class="ttname"><a href="group__screen.html#gae57813381133ca7d2e50f6823e41aaf9">gui_screen_get_current</a></div><div class="ttdeci">SCREEN_STRUCT * gui_screen_get_current()</div><div class="ttdef"><b>Definition:</b> screen.c:8</div></div>
|
|
<div class="ttc" id="group__screen_html_gad4473a16eaf48dab405d23f5f63af3aa"><div class="ttname"><a href="group__screen.html#gad4473a16eaf48dab405d23f5f63af3aa">gui_screen_navigate</a></div><div class="ttdeci">bool gui_screen_navigate(SCREEN_STRUCT *screen)</div><div class="ttdef"><b>Definition:</b> screen.c:39</div></div>
|
|
<div class="ttc" id="struct_s_c_r_e_e_n___s_html"><div class="ttname"><a href="struct_s_c_r_e_e_n___s.html">SCREEN_S</a></div><div class="ttdef"><b>Definition:</b> screen.h:20</div></div>
|
|
<div class="ttc" id="screen__filetest_8c_html_a939fdd806f427cc8505ed817e28cce9d"><div class="ttname"><a href="screen__filetest_8c.html#a939fdd806f427cc8505ed817e28cce9d">screen</a></div><div class="ttdeci">static SCREEN_STRUCT screen</div><div class="ttdef"><b>Definition:</b> screen_filetest.c:120</div></div>
|
|
<div class="ttc" id="group__screen_html_gad87c84be7c1bc93ec95a1fa03f49e06d"><div class="ttname"><a href="group__screen.html#gad87c84be7c1bc93ec95a1fa03f49e06d">SCREEN_CALLBACK</a></div><div class="ttdeci">void(* SCREEN_CALLBACK)(void *screen)</div><div class="ttdoc">Function pointer used... </div><div class="ttdef"><b>Definition:</b> screen.h:18</div></div>
|
|
<div class="ttc" id="group__gui_html_gac795215b462e455f4d482f38c05e0b40"><div class="ttname"><a href="group__gui.html#gac795215b462e455f4d482f38c05e0b40">SCREEN_S::on_update</a></div><div class="ttdeci">SCREEN_CALLBACK on_update</div><div class="ttdef"><b>Definition:</b> screen.h:23</div></div>
|
|
<div class="ttc" id="group__screen_html_ga8e14bc7ee0214e2926965f9bdb54a866"><div class="ttname"><a href="group__screen.html#ga8e14bc7ee0214e2926965f9bdb54a866">gui_screen_back</a></div><div class="ttdeci">bool gui_screen_back()</div><div class="ttdef"><b>Definition:</b> screen.c:48</div></div>
|
|
<div class="ttc" id="group__gui_html_gae6559e38ebbedb8f94a8754256dc454b"><div class="ttname"><a href="group__gui.html#gae6559e38ebbedb8f94a8754256dc454b">SCREEN_S::on_enter</a></div><div class="ttdeci">SCREEN_CALLBACK on_enter</div><div class="ttdef"><b>Definition:</b> screen.h:21</div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Tue May 12 2015 11:11:45 for discoverpixy by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.9.1
|
|
</small></address>
|
|
</body>
|
|
</html>
|