Added doxygen output of current emulator branch.

This commit is contained in:
Timo Lang
2015-05-12 11:12:43 +02:00
commit 57aa160278
9205 changed files with 511443 additions and 0 deletions

287
group__button.html Normal file
View File

@@ -0,0 +1,287 @@
<!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: Button</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&#160;Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data&#160;Structures</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><!-- top -->
<!-- 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 class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Button<div class="ingroups"><a class="el" href="group__gui.html">Gui</a></div></div> </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Collaboration diagram for Button:</div>
<div class="dyncontent">
<center><table><tr><td><img src="group__button.png" border="0" alt="" usemap="#group____button"/>
<map name="group____button" id="group____button">
<area shape="rect" id="node1" href="group__gui.html" title="Gui" alt="" coords="5,5,48,32"/></map>
</td></tr></table></center>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_b_u_t_t_o_n___s_t_r_u_c_t.html">BUTTON_STRUCT</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="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga0cc6f7717df9fbdc0f33efb88720a639"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__button.html#ga0cc6f7717df9fbdc0f33efb88720a639">AUTO</a>&#160;&#160;&#160;0</td></tr>
<tr class="memdesc:ga0cc6f7717df9fbdc0f33efb88720a639"><td class="mdescLeft">&#160;</td><td class="mdescRight">Use this value instead of x2, y2 in the <a class="el" href="struct_b_u_t_t_o_n___s_t_r_u_c_t.html">BUTTON_STRUCT</a> to autocalculate the button width/height. <a href="#ga0cc6f7717df9fbdc0f33efb88720a639">More...</a><br /></td></tr>
<tr class="separator:ga0cc6f7717df9fbdc0f33efb88720a639"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga2bb66de608267d70a8cc4df574cda2a2"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__button.html#ga2bb66de608267d70a8cc4df574cda2a2">BUTTON_CALLBACK</a>) (void *button)</td></tr>
<tr class="separator:ga2bb66de608267d70a8cc4df574cda2a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga64d5d2aaff2c917e5d43e7ed849607de"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__button.html#ga64d5d2aaff2c917e5d43e7ed849607de">gui_button_add</a> (<a class="el" href="struct_b_u_t_t_o_n___s_t_r_u_c_t.html">BUTTON_STRUCT</a> *button)</td></tr>
<tr class="separator:ga64d5d2aaff2c917e5d43e7ed849607de"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga39e6ec07616381a15f276cd821dad4fd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__button.html#ga39e6ec07616381a15f276cd821dad4fd">gui_button_remove</a> (<a class="el" href="struct_b_u_t_t_o_n___s_t_r_u_c_t.html">BUTTON_STRUCT</a> *button)</td></tr>
<tr class="separator:ga39e6ec07616381a15f276cd821dad4fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6da1e251bad09d29fbb3b3f405689ab1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__button.html#ga6da1e251bad09d29fbb3b3f405689ab1">gui_button_redraw</a> (<a class="el" href="struct_b_u_t_t_o_n___s_t_r_u_c_t.html">BUTTON_STRUCT</a> *button)</td></tr>
<tr class="separator:ga6da1e251bad09d29fbb3b3f405689ab1"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>The Button Gui-Element </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ga0cc6f7717df9fbdc0f33efb88720a639"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define AUTO&#160;&#160;&#160;0</td>
</tr>
</table>
</div><div class="memdoc">
<p>Use this value instead of x2, y2 in the <a class="el" href="struct_b_u_t_t_o_n___s_t_r_u_c_t.html">BUTTON_STRUCT</a> to autocalculate the button width/height. </p>
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="ga2bb66de608267d70a8cc4df574cda2a2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* BUTTON_CALLBACK) (void *button)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Prototype for Event Listeners (called when the button is pressed) </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">button</td><td>The pointer to the <a class="el" href="struct_b_u_t_t_o_n___s_t_r_u_c_t.html">BUTTON_STRUCT</a> where to corresponding Button was pressed </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga64d5d2aaff2c917e5d43e7ed849607de"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool gui_button_add </td>
<td>(</td>
<td class="paramtype"><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="paramname"><em>button</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Adds a button. Your Callback will be called from now on, if the button was pressed </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">button</td><td>A Pointer to the preinitialized <a class="el" href="struct_b_u_t_t_o_n___s_t_r_u_c_t.html">BUTTON_STRUCT</a> </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true on success </dd></dl>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="group__button_ga64d5d2aaff2c917e5d43e7ed849607de_cgraph.png" border="0" usemap="#group__button_ga64d5d2aaff2c917e5d43e7ed849607de_cgraph" alt=""/></div>
<map name="group__button_ga64d5d2aaff2c917e5d43e7ed849607de_cgraph" id="group__button_ga64d5d2aaff2c917e5d43e7ed849607de_cgraph">
<area shape="rect" id="node2" href="group__touch.html#gad32e5d122ec3f5f88bc6b2d9f4a629f8" title="touch_have_empty" alt="" coords="167,5,297,32"/><area shape="rect" id="node3" href="group__tft.html#ga7e99287b1e6b844f6867c63400959ffc" title="tft_font_width" alt="" coords="355,107,453,133"/><area shape="rect" id="node5" href="group__tft.html#gaea9f6a88da91949befe52cd4ed000c5d" title="tft_font_height" alt="" coords="353,56,455,83"/><area shape="rect" id="node7" href="button_8c.html#a7dca41e6afa418abaf2d471acac9b649" title="buttons_cb" alt="" coords="189,208,275,235"/><area shape="rect" id="node10" href="group__button.html#ga6da1e251bad09d29fbb3b3f405689ab1" title="gui_button_redraw" alt="" coords="169,157,295,184"/><area shape="rect" id="node16" href="group__touch.html#ga3adc36f55b7475b3f652c38c0e23d741" title="touch_register_area" alt="" coords="164,259,300,285"/><area shape="rect" id="node4" href="ll__tft_8h.html#a3639ec94b2239cc02b3c47a14f6637a3" title="ll_tft_font_width" alt="" coords="515,107,626,133"/><area shape="rect" id="node6" href="ll__tft_8h.html#a8dbc8b40717be527e6f1c5a2cfc72aeb" title="ll_tft_font_height" alt="" coords="513,56,629,83"/><area shape="rect" id="node8" href="group__tft.html#ga5022f91ea04919e698a79c0c309ba6f8" title="tft_draw_line" alt="" coords="357,259,451,285"/><area shape="rect" id="node9" href="ll__tft_8h.html#a2560737bf118275e6ce728f6dce1e83f" title="ll_tft_draw_line" alt="" coords="517,309,624,336"/><area shape="rect" id="node11" href="group__tft.html#ga781855ab93845ce326dfca7c099259c6" title="tft_fill_rectangle" alt="" coords="348,208,460,235"/><area shape="rect" id="node13" href="group__tft.html#gabf54943131990b366ce6875a0e1925f6" title="tft_print_line" alt="" coords="358,157,450,184"/><area shape="rect" id="node12" href="ll__tft_8h.html#a0111ae5623214d3d466b2b24598f303f" title="ll_tft_fill_rectangle" alt="" coords="508,259,633,285"/><area shape="rect" id="node14" href="ll__tft_8h.html#af4b0b73ab01e1dc300ae65dc0ac029b6" title="ll_tft_num_fonts" alt="" coords="514,157,627,184"/><area shape="rect" id="node15" href="ll__tft_8h.html#a408570a2b70769255924792ce189f2c1" title="ll_tft_draw_char" alt="" coords="515,208,627,235"/></map>
</div>
</p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="group__button_ga64d5d2aaff2c917e5d43e7ed849607de_icgraph.png" border="0" usemap="#group__button_ga64d5d2aaff2c917e5d43e7ed849607de_icgraph" alt=""/></div>
<map name="group__button_ga64d5d2aaff2c917e5d43e7ed849607de_icgraph" id="group__button_ga64d5d2aaff2c917e5d43e7ed849607de_icgraph">
<area shape="rect" id="node2" href="screen__filetest_8c.html#a3017cd14eca2b9e67a69e7ea559b5eaa" title="enter" alt="" coords="210,5,261,32"/><area shape="rect" id="node3" href="group__numupdown.html#gab4321e7fc0810ee30355bc7d0a3372db" title="gui_numupdown_add" alt="" coords="164,56,307,83"/><area shape="rect" id="node4" href="screen__guitest_8c.html#a3017cd14eca2b9e67a69e7ea559b5eaa" title="enter" alt="" coords="355,56,405,83"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="ga6da1e251bad09d29fbb3b3f405689ab1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gui_button_redraw </td>
<td>(</td>
<td class="paramtype"><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="paramname"><em>button</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Redraws the button. Call this method if you have to redraw the entire screen or if you want to draw a button on top of an image. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">button</td><td>A Pointer to the <a class="el" href="struct_b_u_t_t_o_n___s_t_r_u_c_t.html">BUTTON_STRUCT</a> </td></tr>
</table>
</dd>
</dl>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="group__button_ga6da1e251bad09d29fbb3b3f405689ab1_cgraph.png" border="0" usemap="#group__button_ga6da1e251bad09d29fbb3b3f405689ab1_cgraph" alt=""/></div>
<map name="group__button_ga6da1e251bad09d29fbb3b3f405689ab1_cgraph" id="group__button_ga6da1e251bad09d29fbb3b3f405689ab1_cgraph">
<area shape="rect" id="node2" href="group__tft.html#ga7e99287b1e6b844f6867c63400959ffc" title="tft_font_width" alt="" coords="187,157,285,184"/><area shape="rect" id="node4" href="group__tft.html#gaea9f6a88da91949befe52cd4ed000c5d" title="tft_font_height" alt="" coords="185,5,287,32"/><area shape="rect" id="node6" href="group__tft.html#ga781855ab93845ce326dfca7c099259c6" title="tft_fill_rectangle" alt="" coords="180,56,292,83"/><area shape="rect" id="node8" href="group__tft.html#ga5022f91ea04919e698a79c0c309ba6f8" title="tft_draw_line" alt="" coords="189,107,283,133"/><area shape="rect" id="node10" href="group__tft.html#gabf54943131990b366ce6875a0e1925f6" title="tft_print_line" alt="" coords="190,208,282,235"/><area shape="rect" id="node3" href="ll__tft_8h.html#a3639ec94b2239cc02b3c47a14f6637a3" title="ll_tft_font_width" alt="" coords="347,157,458,184"/><area shape="rect" id="node5" href="ll__tft_8h.html#a8dbc8b40717be527e6f1c5a2cfc72aeb" title="ll_tft_font_height" alt="" coords="345,5,461,32"/><area shape="rect" id="node7" href="ll__tft_8h.html#a0111ae5623214d3d466b2b24598f303f" title="ll_tft_fill_rectangle" alt="" coords="340,56,465,83"/><area shape="rect" id="node9" href="ll__tft_8h.html#a2560737bf118275e6ce728f6dce1e83f" title="ll_tft_draw_line" alt="" coords="349,107,456,133"/><area shape="rect" id="node11" href="ll__tft_8h.html#af4b0b73ab01e1dc300ae65dc0ac029b6" title="ll_tft_num_fonts" alt="" coords="346,208,459,235"/><area shape="rect" id="node12" href="ll__tft_8h.html#a408570a2b70769255924792ce189f2c1" title="ll_tft_draw_char" alt="" coords="347,259,459,285"/></map>
</div>
</p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="group__button_ga6da1e251bad09d29fbb3b3f405689ab1_icgraph.png" border="0" usemap="#group__button_ga6da1e251bad09d29fbb3b3f405689ab1_icgraph" alt=""/></div>
<map name="group__button_ga6da1e251bad09d29fbb3b3f405689ab1_icgraph" id="group__button_ga6da1e251bad09d29fbb3b3f405689ab1_icgraph">
<area shape="rect" id="node2" href="group__button.html#ga64d5d2aaff2c917e5d43e7ed849607de" title="gui_button_add" alt="" coords="205,31,315,57"/><area shape="rect" id="node6" href="group__numupdown.html#ga4ee98a6c6af451123af6c464a851c03a" title="gui_numupdown_redraw" alt="" coords="180,81,340,108"/><area shape="rect" id="node3" href="screen__filetest_8c.html#a3017cd14eca2b9e67a69e7ea559b5eaa" title="enter" alt="" coords="434,5,485,32"/><area shape="rect" id="node4" href="group__numupdown.html#gab4321e7fc0810ee30355bc7d0a3372db" title="gui_numupdown_add" alt="" coords="388,56,531,83"/><area shape="rect" id="node5" href="screen__guitest_8c.html#a3017cd14eca2b9e67a69e7ea559b5eaa" title="enter" alt="" coords="579,56,629,83"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="ga39e6ec07616381a15f276cd821dad4fd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gui_button_remove </td>
<td>(</td>
<td class="paramtype"><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="paramname"><em>button</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Removes the button. You will no longer receive events for this button. This function will not overdraw the region where the button was located. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">button</td><td>A Pointer to the <a class="el" href="struct_b_u_t_t_o_n___s_t_r_u_c_t.html">BUTTON_STRUCT</a> </td></tr>
</table>
</dd>
</dl>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="group__button_ga39e6ec07616381a15f276cd821dad4fd_cgraph.png" border="0" usemap="#group__button_ga39e6ec07616381a15f276cd821dad4fd_cgraph" alt=""/></div>
<map name="group__button_ga39e6ec07616381a15f276cd821dad4fd_cgraph" id="group__button_ga39e6ec07616381a15f276cd821dad4fd_cgraph">
<area shape="rect" id="node2" href="group__touch.html#gaa7d6cd569335d0ddfc9eeab479f3a0a8" title="touch_unregister_area" alt="" coords="184,5,335,32"/></map>
</div>
</p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="group__button_ga39e6ec07616381a15f276cd821dad4fd_icgraph.png" border="0" usemap="#group__button_ga39e6ec07616381a15f276cd821dad4fd_icgraph" alt=""/></div>
<map name="group__button_ga39e6ec07616381a15f276cd821dad4fd_icgraph" id="group__button_ga39e6ec07616381a15f276cd821dad4fd_icgraph">
<area shape="rect" id="node2" href="screen__filetest_8c.html#acd1409088e83cf2a8ba2cf96dd9b52f8" title="leave" alt="" coords="240,5,291,32"/><area shape="rect" id="node3" href="group__numupdown.html#ga9470a5c6f0ffbbda7c56e1b8a59f4b97" title="gui_numupdown_remove" alt="" coords="184,56,347,83"/><area shape="rect" id="node4" href="screen__guitest_8c.html#acd1409088e83cf2a8ba2cf96dd9b52f8" title="leave" alt="" coords="395,56,445,83"/></map>
</div>
</p>
</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">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.9.1
</small></address>
</body>
</html>