Updated docu.

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

View File

@@ -98,22 +98,85 @@ Collaboration diagram for SCREEN_S:</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></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>
<tr class="memitem:ae6559e38ebbedb8f94a8754256dc454b"><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="struct_s_c_r_e_e_n___s.html#ae6559e38ebbedb8f94a8754256dc454b">on_enter</a></td></tr>
<tr class="memdesc:ae6559e38ebbedb8f94a8754256dc454b"><td class="mdescLeft">&#160;</td><td class="mdescRight">The Callback which is called when the screen is entered. Add/Register all UI-Elements here. <a href="#ae6559e38ebbedb8f94a8754256dc454b">More...</a><br /></td></tr>
<tr class="separator:ae6559e38ebbedb8f94a8754256dc454b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5e8f3db07ddecd10762ce1088cb2fbd8"><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="struct_s_c_r_e_e_n___s.html#a5e8f3db07ddecd10762ce1088cb2fbd8">on_leave</a></td></tr>
<tr class="memdesc:a5e8f3db07ddecd10762ce1088cb2fbd8"><td class="mdescLeft">&#160;</td><td class="mdescRight">The Callback which is called when the screen is left. Remove/Unregister all UI-Elements here. <a href="#a5e8f3db07ddecd10762ce1088cb2fbd8">More...</a><br /></td></tr>
<tr class="separator:a5e8f3db07ddecd10762ce1088cb2fbd8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac795215b462e455f4d482f38c05e0b40"><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="struct_s_c_r_e_e_n___s.html#ac795215b462e455f4d482f38c05e0b40">on_update</a></td></tr>
<tr class="memdesc:ac795215b462e455f4d482f38c05e0b40"><td class="mdescLeft">&#160;</td><td class="mdescRight">The Callback which is called repeatedly when the screen should be updated. Update/Redraw all UI-Elements here. <a href="#ac795215b462e455f4d482f38c05e0b40">More...</a><br /></td></tr>
<tr class="separator:ac795215b462e455f4d482f38c05e0b40"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a914e64c0c6cfaf4f7b2b0c3493f0cbf2"><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="struct_s_c_r_e_e_n___s.html#a914e64c0c6cfaf4f7b2b0c3493f0cbf2">next</a></td></tr>
<tr class="memdesc:a914e64c0c6cfaf4f7b2b0c3493f0cbf2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Used internally. do not modify, do not initialize. <a href="#a914e64c0c6cfaf4f7b2b0c3493f0cbf2">More...</a><br /></td></tr>
<tr class="separator:a914e64c0c6cfaf4f7b2b0c3493f0cbf2"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Structure to configure the Screen </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a class="anchor" id="a914e64c0c6cfaf4f7b2b0c3493f0cbf2"></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">
<p>Used internally. do not modify, do not initialize. </p>
</div>
</div>
<a class="anchor" id="ae6559e38ebbedb8f94a8754256dc454b"></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">
<p>The Callback which is called when the screen is entered. Add/Register all UI-Elements here. </p>
</div>
</div>
<a class="anchor" id="a5e8f3db07ddecd10762ce1088cb2fbd8"></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">
<p>The Callback which is called when the screen is left. Remove/Unregister all UI-Elements here. </p>
</div>
</div>
<a class="anchor" id="ac795215b462e455f4d482f38c05e0b40"></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">
<p>The Callback which is called repeatedly when the screen should be updated. Update/Redraw all UI-Elements here. </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>common/gui/<a class="el" href="screen_8h_source.html">screen.h</a></li>
</ul>
</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>