aaron/discoverpixy
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Updated docu.

Browse Source
This commit is contained in:
Timo Lang
2015-06-06 18:50:22 +02:00
parent 57aa160278
commit 307c4d998b
1073 changed files with 16543 additions and 6400 deletions
Download Patch File Download Diff File Expand all files Collapse all files

349
group__gui.html
View File

@@ -76,8 +76,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="header">
<div class="summary">
<a href="#groups">Modules</a> &#124;
<a href="#var-members">Variables</a> </div>
<a href="#groups">Modules</a> </div>
<div class="headertitle">
<div class="title">Gui</div> </div>
</div><!--header-->
@@ -101,357 +100,13 @@ Modules</h2></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__screen"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__screen.html">Screen</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:gadf10d197299522577e67d366877bdd3f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_t_o_u_c_h___a_r_e_a___s_t_r_u_c_t.html">TOUCH_AREA_STRUCT</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__gui.html#gadf10d197299522577e67d366877bdd3f">base</a></td></tr>
<tr class="memdesc:gadf10d197299522577e67d366877bdd3f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Basic geometry of the button. You only need to set the x1, y1, x2, y2 members of this struct. <a href="#gadf10d197299522577e67d366877bdd3f">More...</a><br /></td></tr>
<tr class="separator:gadf10d197299522577e67d366877bdd3f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaebb27fad2492ea7aa81895d0ede61fcf"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__gui.html#gaebb27fad2492ea7aa81895d0ede61fcf">bgcolor</a></td></tr>
<tr class="memdesc:gaebb27fad2492ea7aa81895d0ede61fcf"><td class="mdescLeft">&#160;</td><td class="mdescRight">The 16-bit background color of the button. <a href="#gaebb27fad2492ea7aa81895d0ede61fcf">More...</a><br /></td></tr>
<tr class="separator:gaebb27fad2492ea7aa81895d0ede61fcf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga269d23c8a60f8acdf9279642999ee6a9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__button.html#ga2bb66de608267d70a8cc4df574cda2a2">BUTTON_CALLBACK</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__gui.html#ga269d23c8a60f8acdf9279642999ee6a9">callback</a></td></tr>
<tr class="memdesc:ga269d23c8a60f8acdf9279642999ee6a9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Callback. <a href="#ga269d23c8a60f8acdf9279642999ee6a9">More...</a><br /></td></tr>
<tr class="separator:ga269d23c8a60f8acdf9279642999ee6a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaaf5a5af411fa69950e0b4415c8089c8b"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__gui.html#gaaf5a5af411fa69950e0b4415c8089c8b">txtcolor</a></td></tr>
<tr class="memdesc:gaaf5a5af411fa69950e0b4415c8089c8b"><td class="mdescLeft">&#160;</td><td class="mdescRight">The 16-bit text color. <a href="#gaaf5a5af411fa69950e0b4415c8089c8b">More...</a><br /></td></tr>
<tr class="separator:gaaf5a5af411fa69950e0b4415c8089c8b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gadeae49dfe3584e6df726fb4167cd1cf7"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__gui.html#gadeae49dfe3584e6df726fb4167cd1cf7">font</a></td></tr>
<tr class="memdesc:gadeae49dfe3584e6df726fb4167cd1cf7"><td class="mdescLeft">&#160;</td><td class="mdescRight">The number of the font to use. <a href="#gadeae49dfe3584e6df726fb4167cd1cf7">More...</a><br /></td></tr>
<tr class="separator:gadeae49dfe3584e6df726fb4167cd1cf7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga16343090e80c4472521560f30113d96c"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__gui.html#ga16343090e80c4472521560f30113d96c">text</a></td></tr>
<tr class="memdesc:ga16343090e80c4472521560f30113d96c"><td class="mdescLeft">&#160;</td><td class="mdescRight">The label of the button. <a href="#ga16343090e80c4472521560f30113d96c">More...</a><br /></td></tr>
<tr class="separator:ga16343090e80c4472521560f30113d96c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gadf10d197299522577e67d366877bdd3f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_t_o_u_c_h___a_r_e_a___s_t_r_u_c_t.html">TOUCH_AREA_STRUCT</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__gui.html#gadf10d197299522577e67d366877bdd3f">base</a></td></tr>
<tr class="separator:gadf10d197299522577e67d366877bdd3f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga78bc63a5b9272aa4a69d6ceea4e65902"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__gui.html#ga78bc63a5b9272aa4a69d6ceea4e65902">fgcolor</a></td></tr>
<tr class="separator:ga78bc63a5b9272aa4a69d6ceea4e65902"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf7207ba9a7bbec1e8bdcaa466ae83e64"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__gui.html#gaf7207ba9a7bbec1e8bdcaa466ae83e64">checked</a></td></tr>
<tr class="separator:gaf7207ba9a7bbec1e8bdcaa466ae83e64"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga47605ea724f7147a5e79a995afc7e26f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__checkbox.html#ga4e76e0aec1a3ec620e09161ed2869b14">CHECKBOX_CALLBACK</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__gui.html#ga47605ea724f7147a5e79a995afc7e26f">callback</a></td></tr>
<tr class="separator:ga47605ea724f7147a5e79a995afc7e26f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4dde988b1b2adba65ae3efa69f65d960"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__gui.html#ga4dde988b1b2adba65ae3efa69f65d960">x</a></td></tr>
<tr class="separator:ga4dde988b1b2adba65ae3efa69f65d960"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab0580f504a7428539be299fa71565f30"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__gui.html#gab0580f504a7428539be299fa71565f30">y</a></td></tr>
<tr class="separator:gab0580f504a7428539be299fa71565f30"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga78bc63a5b9272aa4a69d6ceea4e65902"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__gui.html#ga78bc63a5b9272aa4a69d6ceea4e65902">fgcolor</a></td></tr>
<tr class="separator:ga78bc63a5b9272aa4a69d6ceea4e65902"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7375fa3485ce43bbc621f90ce895d52a"><td class="memItemLeft" align="right" valign="top">int16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__gui.html#ga7375fa3485ce43bbc621f90ce895d52a">value</a></td></tr>
<tr class="separator:ga7375fa3485ce43bbc621f90ce895d52a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga29dc67311876da954d1fb5911f161fed"><td class="memItemLeft" align="right" valign="top">int16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__gui.html#ga29dc67311876da954d1fb5911f161fed">min</a></td></tr>
<tr class="separator:ga29dc67311876da954d1fb5911f161fed"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga43a190f55cab9276eb1d6b6a4f453ccf"><td class="memItemLeft" align="right" valign="top">int16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__gui.html#ga43a190f55cab9276eb1d6b6a4f453ccf">max</a></td></tr>
<tr class="separator:ga43a190f55cab9276eb1d6b6a4f453ccf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga70d80bf3a066e14217829f05fa3600f8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__numupdown.html#ga69649e9300c3044bf33744dfb73479c0">NUMUPDOWN_CALLBACK</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__gui.html#ga70d80bf3a066e14217829f05fa3600f8">callback</a></td></tr>
<tr class="separator:ga70d80bf3a066e14217829f05fa3600f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac607274df9fa6216cd6e7f2b4bf459b8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_b_u_t_t_o_n___s_t_r_u_c_t.html">BUTTON_STRUCT</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__gui.html#gac607274df9fa6216cd6e7f2b4bf459b8">buttonUp</a></td></tr>
<tr class="separator:gac607274df9fa6216cd6e7f2b4bf459b8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga01aa78c14bf4ac60780c19a6a6d37b34"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_b_u_t_t_o_n___s_t_r_u_c_t.html">BUTTON_STRUCT</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__gui.html#ga01aa78c14bf4ac60780c19a6a6d37b34">buttonDown</a></td></tr>
<tr class="separator:ga01aa78c14bf4ac60780c19a6a6d37b34"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae6559e38ebbedb8f94a8754256dc454b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__screen.html#gad87c84be7c1bc93ec95a1fa03f49e06d">SCREEN_CALLBACK</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__gui.html#gae6559e38ebbedb8f94a8754256dc454b">on_enter</a></td></tr>
<tr class="separator:gae6559e38ebbedb8f94a8754256dc454b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5e8f3db07ddecd10762ce1088cb2fbd8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__screen.html#gad87c84be7c1bc93ec95a1fa03f49e06d">SCREEN_CALLBACK</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__gui.html#ga5e8f3db07ddecd10762ce1088cb2fbd8">on_leave</a></td></tr>
<tr class="separator:ga5e8f3db07ddecd10762ce1088cb2fbd8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac795215b462e455f4d482f38c05e0b40"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__screen.html#gad87c84be7c1bc93ec95a1fa03f49e06d">SCREEN_CALLBACK</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__gui.html#gac795215b462e455f4d482f38c05e0b40">on_update</a></td></tr>
<tr class="separator:gac795215b462e455f4d482f38c05e0b40"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga914e64c0c6cfaf4f7b2b0c3493f0cbf2"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="struct_s_c_r_e_e_n___s.html">SCREEN_S</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__gui.html#ga914e64c0c6cfaf4f7b2b0c3493f0cbf2">next</a></td></tr>
<tr class="separator:ga914e64c0c6cfaf4f7b2b0c3493f0cbf2"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>The Gui Module </p>
<h2 class="groupheader">Variable Documentation</h2>
<a class="anchor" id="gadf10d197299522577e67d366877bdd3f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="struct_t_o_u_c_h___a_r_e_a___s_t_r_u_c_t.html">TOUCH_AREA_STRUCT</a> base</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="gadf10d197299522577e67d366877bdd3f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="struct_t_o_u_c_h___a_r_e_a___s_t_r_u_c_t.html">TOUCH_AREA_STRUCT</a> base</td>
</tr>
</table>
</div><div class="memdoc">
<p>Basic geometry of the button. You only need to set the x1, y1, x2, y2 members of this struct. </p>
</div>
</div>
<a class="anchor" id="gaebb27fad2492ea7aa81895d0ede61fcf"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint16_t bgcolor</td>
</tr>
</table>
</div><div class="memdoc">
<p>The 16-bit background color of the button. </p>
</div>
</div>
<a class="anchor" id="ga01aa78c14bf4ac60780c19a6a6d37b34"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="struct_b_u_t_t_o_n___s_t_r_u_c_t.html">BUTTON_STRUCT</a> buttonDown</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="gac607274df9fa6216cd6e7f2b4bf459b8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="struct_b_u_t_t_o_n___s_t_r_u_c_t.html">BUTTON_STRUCT</a> buttonUp</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ga47605ea724f7147a5e79a995afc7e26f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__checkbox.html#ga4e76e0aec1a3ec620e09161ed2869b14">CHECKBOX_CALLBACK</a> callback</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ga70d80bf3a066e14217829f05fa3600f8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__numupdown.html#ga69649e9300c3044bf33744dfb73479c0">NUMUPDOWN_CALLBACK</a> callback</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ga269d23c8a60f8acdf9279642999ee6a9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__button.html#ga2bb66de608267d70a8cc4df574cda2a2">BUTTON_CALLBACK</a> callback</td>
</tr>
</table>
</div><div class="memdoc">
<p>Callback. </p>
</div>
</div>
<a class="anchor" id="gaf7207ba9a7bbec1e8bdcaa466ae83e64"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool checked</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ga78bc63a5b9272aa4a69d6ceea4e65902"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint16_t fgcolor</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ga78bc63a5b9272aa4a69d6ceea4e65902"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint16_t fgcolor</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="gadeae49dfe3584e6df726fb4167cd1cf7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t font</td>
</tr>
</table>
</div><div class="memdoc">
<p>The number of the font to use. </p>
</div>
</div>
<a class="anchor" id="ga43a190f55cab9276eb1d6b6a4f453ccf"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int16_t max</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ga29dc67311876da954d1fb5911f161fed"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int16_t min</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ga914e64c0c6cfaf4f7b2b0c3493f0cbf2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="struct_s_c_r_e_e_n___s.html">SCREEN_S</a>* next</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="gae6559e38ebbedb8f94a8754256dc454b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__screen.html#gad87c84be7c1bc93ec95a1fa03f49e06d">SCREEN_CALLBACK</a> on_enter</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ga5e8f3db07ddecd10762ce1088cb2fbd8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__screen.html#gad87c84be7c1bc93ec95a1fa03f49e06d">SCREEN_CALLBACK</a> on_leave</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="gac795215b462e455f4d482f38c05e0b40"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__screen.html#gad87c84be7c1bc93ec95a1fa03f49e06d">SCREEN_CALLBACK</a> on_update</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ga16343090e80c4472521560f30113d96c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* text</td>
</tr>
</table>
</div><div class="memdoc">
<p>The label of the button. </p>
</div>
</div>
<a class="anchor" id="gaaf5a5af411fa69950e0b4415c8089c8b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint16_t txtcolor</td>
</tr>
</table>
</div><div class="memdoc">
<p>The 16-bit text color. </p>
</div>
</div>
<a class="anchor" id="ga7375fa3485ce43bbc621f90ce895d52a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int16_t value</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ga4dde988b1b2adba65ae3efa69f65d960"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint16_t x</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="gab0580f504a7428539be299fa71565f30"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint16_t y</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue May 12 2015 11:11:45 for discoverpixy by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Sat Jun 6 2015 18:48:32 for discoverpixy by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.9.1
</small></address>