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

@@ -92,40 +92,47 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<a href="checkbox_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>&#160;<span class="preprocessor">#ifndef CHECKBOX_H</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="preprocessor">#define CHECKBOX_H</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;</div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;</div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;</div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;</div>
<div class="line"><a name="l00016"></a><span class="lineno"><a class="line" href="group__checkbox.html#ga4e76e0aec1a3ec620e09161ed2869b14"> 16</a></span>&#160;<span class="keyword">typedef</span> void (*<a class="code" href="group__checkbox.html#ga4e76e0aec1a3ec620e09161ed2869b14">CHECKBOX_CALLBACK</a>)(<span class="keywordtype">void</span> *checkbox, <span class="keywordtype">bool</span> checked); </div>
<div class="line"><a name="l00017"></a><span class="lineno"><a class="line" href="struct_c_h_e_c_k_b_o_x___s_t_r_u_c_t.html"> 17</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span>{</div>
<div class="line"><a name="l00018"></a><span class="lineno"><a class="line" href="group__gui.html#gadf10d197299522577e67d366877bdd3f"> 18</a></span>&#160; <a class="code" href="struct_t_o_u_c_h___a_r_e_a___s_t_r_u_c_t.html">TOUCH_AREA_STRUCT</a> <a class="code" href="group__gui.html#gadf10d197299522577e67d366877bdd3f">base</a>; </div>
<div class="line"><a name="l00019"></a><span class="lineno"><a class="line" href="group__gui.html#ga78bc63a5b9272aa4a69d6ceea4e65902"> 19</a></span>&#160; uint16_t <a class="code" href="group__gui.html#ga78bc63a5b9272aa4a69d6ceea4e65902">fgcolor</a>;</div>
<div class="line"><a name="l00020"></a><span class="lineno"><a class="line" href="group__gui.html#gaf7207ba9a7bbec1e8bdcaa466ae83e64"> 20</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="group__gui.html#gaf7207ba9a7bbec1e8bdcaa466ae83e64">checked</a>;</div>
<div class="line"><a name="l00021"></a><span class="lineno"><a class="line" href="group__gui.html#ga47605ea724f7147a5e79a995afc7e26f"> 21</a></span>&#160; <a class="code" href="group__checkbox.html#ga4e76e0aec1a3ec620e09161ed2869b14">CHECKBOX_CALLBACK</a> <a class="code" href="group__gui.html#ga47605ea724f7147a5e79a995afc7e26f">callback</a>; <span class="comment">//Callback</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;} <a class="code" href="struct_c_h_e_c_k_b_o_x___s_t_r_u_c_t.html">CHECKBOX_STRUCT</a>;</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="keywordtype">bool</span> <a class="code" href="group__checkbox.html#gafc328cff61a651c7b7175515b37c2f6c">gui_checkbox_add</a>(<a class="code" href="struct_c_h_e_c_k_b_o_x___s_t_r_u_c_t.html">CHECKBOX_STRUCT</a>* checkbox);</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="keywordtype">void</span> <a class="code" href="group__checkbox.html#ga86fc603e59c7a723138b77f4a8f39e76">gui_checkbox_remove</a>(<a class="code" href="struct_c_h_e_c_k_b_o_x___s_t_r_u_c_t.html">CHECKBOX_STRUCT</a>* checkbox);</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="keywordtype">void</span> <a class="code" href="group__checkbox.html#ga669924dea6a4427dc58d40a5691f677e">gui_checkbox_update</a>(<a class="code" href="struct_c_h_e_c_k_b_o_x___s_t_r_u_c_t.html">CHECKBOX_STRUCT</a>* checkbox);</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="keywordtype">void</span> <a class="code" href="group__checkbox.html#ga3e07fb73eb79e8cf6db8f70455f09a92">gui_checkbox_redraw</a>(<a class="code" href="struct_c_h_e_c_k_b_o_x___s_t_r_u_c_t.html">CHECKBOX_STRUCT</a>* checkbox);</div>
<div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="group__checkbox.html#gac07a837d568fb96977a0658e49ca2ce8"> 29</a></span>&#160;<span class="preprocessor">#define CHECKBOX_WIN_FG_COLOR RGB(32,161,34)</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="touch_8h.html">touch.h</a>&quot;</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;</div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;</div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;</div>
<div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="group__checkbox.html#ga4e76e0aec1a3ec620e09161ed2869b14"> 29</a></span>&#160;<span class="keyword">typedef</span> void (*<a class="code" href="group__checkbox.html#ga4e76e0aec1a3ec620e09161ed2869b14">CHECKBOX_CALLBACK</a>)(<span class="keywordtype">void</span> *checkbox, <span class="keywordtype">bool</span> checked);</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* CHECKBOX_H */</span><span class="preprocessor"></span></div>
<div class="ttc" id="group__checkbox_html_gafc328cff61a651c7b7175515b37c2f6c"><div class="ttname"><a href="group__checkbox.html#gafc328cff61a651c7b7175515b37c2f6c">gui_checkbox_add</a></div><div class="ttdeci">bool gui_checkbox_add(CHECKBOX_STRUCT *checkbox)</div><div class="ttdef"><b>Definition:</b> checkbox.c:36</div></div>
<div class="ttc" id="group__checkbox_html_ga669924dea6a4427dc58d40a5691f677e"><div class="ttname"><a href="group__checkbox.html#ga669924dea6a4427dc58d40a5691f677e">gui_checkbox_update</a></div><div class="ttdeci">void gui_checkbox_update(CHECKBOX_STRUCT *checkbox)</div><div class="ttdef"><b>Definition:</b> checkbox.c:73</div></div>
<div class="ttc" id="group__gui_html_gadf10d197299522577e67d366877bdd3f"><div class="ttname"><a href="group__gui.html#gadf10d197299522577e67d366877bdd3f">CHECKBOX_STRUCT::base</a></div><div class="ttdeci">TOUCH_AREA_STRUCT base</div><div class="ttdef"><b>Definition:</b> checkbox.h:18</div></div>
<div class="ttc" id="group__checkbox_html_ga86fc603e59c7a723138b77f4a8f39e76"><div class="ttname"><a href="group__checkbox.html#ga86fc603e59c7a723138b77f4a8f39e76">gui_checkbox_remove</a></div><div class="ttdeci">void gui_checkbox_remove(CHECKBOX_STRUCT *checkbox)</div><div class="ttdef"><b>Definition:</b> checkbox.c:68</div></div>
<div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="struct_c_h_e_c_k_b_o_x___s_t_r_u_c_t.html"> 34</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span>{</div>
<div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="struct_c_h_e_c_k_b_o_x___s_t_r_u_c_t.html#adf10d197299522577e67d366877bdd3f"> 35</a></span>&#160; <a class="code" href="struct_t_o_u_c_h___a_r_e_a___s_t_r_u_c_t.html">TOUCH_AREA_STRUCT</a> <a class="code" href="struct_c_h_e_c_k_b_o_x___s_t_r_u_c_t.html#adf10d197299522577e67d366877bdd3f">base</a>; </div>
<div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="struct_c_h_e_c_k_b_o_x___s_t_r_u_c_t.html#a78bc63a5b9272aa4a69d6ceea4e65902"> 36</a></span>&#160; uint16_t <a class="code" href="struct_c_h_e_c_k_b_o_x___s_t_r_u_c_t.html#a78bc63a5b9272aa4a69d6ceea4e65902">fgcolor</a>; </div>
<div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="struct_c_h_e_c_k_b_o_x___s_t_r_u_c_t.html#af7207ba9a7bbec1e8bdcaa466ae83e64"> 37</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="struct_c_h_e_c_k_b_o_x___s_t_r_u_c_t.html#af7207ba9a7bbec1e8bdcaa466ae83e64">checked</a>; </div>
<div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="struct_c_h_e_c_k_b_o_x___s_t_r_u_c_t.html#a47605ea724f7147a5e79a995afc7e26f"> 38</a></span>&#160; <a class="code" href="group__checkbox.html#ga4e76e0aec1a3ec620e09161ed2869b14">CHECKBOX_CALLBACK</a> <a class="code" href="struct_c_h_e_c_k_b_o_x___s_t_r_u_c_t.html#a47605ea724f7147a5e79a995afc7e26f">callback</a>; </div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;} <a class="code" href="struct_c_h_e_c_k_b_o_x___s_t_r_u_c_t.html">CHECKBOX_STRUCT</a>;</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;<span class="keywordtype">bool</span> <a class="code" href="group__checkbox.html#gafc328cff61a651c7b7175515b37c2f6c">gui_checkbox_add</a>(<a class="code" href="struct_c_h_e_c_k_b_o_x___s_t_r_u_c_t.html">CHECKBOX_STRUCT</a>* checkbox);</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;<span class="keywordtype">void</span> <a class="code" href="group__checkbox.html#ga86fc603e59c7a723138b77f4a8f39e76">gui_checkbox_remove</a>(<a class="code" href="struct_c_h_e_c_k_b_o_x___s_t_r_u_c_t.html">CHECKBOX_STRUCT</a>* checkbox);</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;<span class="keywordtype">void</span> <a class="code" href="group__checkbox.html#ga669924dea6a4427dc58d40a5691f677e">gui_checkbox_update</a>(<a class="code" href="struct_c_h_e_c_k_b_o_x___s_t_r_u_c_t.html">CHECKBOX_STRUCT</a>* checkbox);</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;<span class="keywordtype">void</span> <a class="code" href="group__checkbox.html#ga3e07fb73eb79e8cf6db8f70455f09a92">gui_checkbox_redraw</a>(<a class="code" href="struct_c_h_e_c_k_b_o_x___s_t_r_u_c_t.html">CHECKBOX_STRUCT</a>* checkbox);</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;</div>
<div class="line"><a name="l00066"></a><span class="lineno"><a class="line" href="group__checkbox.html#gac07a837d568fb96977a0658e49ca2ce8"> 66</a></span>&#160;<span class="preprocessor">#define CHECKBOX_WIN_FG_COLOR RGB(32,161,34)</span></div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160;</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* CHECKBOX_H */</span><span class="preprocessor"></span></div>
<div class="ttc" id="group__checkbox_html_gafc328cff61a651c7b7175515b37c2f6c"><div class="ttname"><a href="group__checkbox.html#gafc328cff61a651c7b7175515b37c2f6c">gui_checkbox_add</a></div><div class="ttdeci">bool gui_checkbox_add(CHECKBOX_STRUCT *checkbox)</div><div class="ttdef"><b>Definition:</b> checkbox.c:51</div></div>
<div class="ttc" id="group__checkbox_html_ga669924dea6a4427dc58d40a5691f677e"><div class="ttname"><a href="group__checkbox.html#ga669924dea6a4427dc58d40a5691f677e">gui_checkbox_update</a></div><div class="ttdeci">void gui_checkbox_update(CHECKBOX_STRUCT *checkbox)</div><div class="ttdef"><b>Definition:</b> checkbox.c:102</div></div>
<div class="ttc" id="group__checkbox_html_ga86fc603e59c7a723138b77f4a8f39e76"><div class="ttname"><a href="group__checkbox.html#ga86fc603e59c7a723138b77f4a8f39e76">gui_checkbox_remove</a></div><div class="ttdeci">void gui_checkbox_remove(CHECKBOX_STRUCT *checkbox)</div><div class="ttdef"><b>Definition:</b> checkbox.c:96</div></div>
<div class="ttc" id="struct_c_h_e_c_k_b_o_x___s_t_r_u_c_t_html_af7207ba9a7bbec1e8bdcaa466ae83e64"><div class="ttname"><a href="struct_c_h_e_c_k_b_o_x___s_t_r_u_c_t.html#af7207ba9a7bbec1e8bdcaa466ae83e64">CHECKBOX_STRUCT::checked</a></div><div class="ttdeci">bool checked</div><div class="ttdoc">A boolean which indicates whether or not the checkbox is currently checked. </div><div class="ttdef"><b>Definition:</b> checkbox.h:37</div></div>
<div class="ttc" id="struct_t_o_u_c_h___a_r_e_a___s_t_r_u_c_t_html"><div class="ttname"><a href="struct_t_o_u_c_h___a_r_e_a___s_t_r_u_c_t.html">TOUCH_AREA_STRUCT</a></div><div class="ttdef"><b>Definition:</b> touch.h:50</div></div>
<div class="ttc" id="group__gui_html_gaf7207ba9a7bbec1e8bdcaa466ae83e64"><div class="ttname"><a href="group__gui.html#gaf7207ba9a7bbec1e8bdcaa466ae83e64">CHECKBOX_STRUCT::checked</a></div><div class="ttdeci">bool checked</div><div class="ttdef"><b>Definition:</b> checkbox.h:20</div></div>
<div class="ttc" id="struct_c_h_e_c_k_b_o_x___s_t_r_u_c_t_html"><div class="ttname"><a href="struct_c_h_e_c_k_b_o_x___s_t_r_u_c_t.html">CHECKBOX_STRUCT</a></div><div class="ttdef"><b>Definition:</b> checkbox.h:17</div></div>
<div class="ttc" id="group__gui_html_ga47605ea724f7147a5e79a995afc7e26f"><div class="ttname"><a href="group__gui.html#ga47605ea724f7147a5e79a995afc7e26f">CHECKBOX_STRUCT::callback</a></div><div class="ttdeci">CHECKBOX_CALLBACK callback</div><div class="ttdef"><b>Definition:</b> checkbox.h:21</div></div>
<div class="ttc" id="group__checkbox_html_ga4e76e0aec1a3ec620e09161ed2869b14"><div class="ttname"><a href="group__checkbox.html#ga4e76e0aec1a3ec620e09161ed2869b14">CHECKBOX_CALLBACK</a></div><div class="ttdeci">void(* CHECKBOX_CALLBACK)(void *checkbox, bool checked)</div><div class="ttdoc">Function pointer used... </div><div class="ttdef"><b>Definition:</b> checkbox.h:16</div></div>
<div class="ttc" id="group__checkbox_html_ga3e07fb73eb79e8cf6db8f70455f09a92"><div class="ttname"><a href="group__checkbox.html#ga3e07fb73eb79e8cf6db8f70455f09a92">gui_checkbox_redraw</a></div><div class="ttdeci">void gui_checkbox_redraw(CHECKBOX_STRUCT *checkbox)</div><div class="ttdef"><b>Definition:</b> checkbox.c:60</div></div>
<div class="ttc" id="group__gui_html_ga78bc63a5b9272aa4a69d6ceea4e65902"><div class="ttname"><a href="group__gui.html#ga78bc63a5b9272aa4a69d6ceea4e65902">CHECKBOX_STRUCT::fgcolor</a></div><div class="ttdeci">uint16_t fgcolor</div><div class="ttdef"><b>Definition:</b> checkbox.h:19</div></div>
<div class="ttc" id="struct_c_h_e_c_k_b_o_x___s_t_r_u_c_t_html"><div class="ttname"><a href="struct_c_h_e_c_k_b_o_x___s_t_r_u_c_t.html">CHECKBOX_STRUCT</a></div><div class="ttdef"><b>Definition:</b> checkbox.h:34</div></div>
<div class="ttc" id="touch_8h_html"><div class="ttname"><a href="touch_8h.html">touch.h</a></div></div>
<div class="ttc" id="struct_c_h_e_c_k_b_o_x___s_t_r_u_c_t_html_adf10d197299522577e67d366877bdd3f"><div class="ttname"><a href="struct_c_h_e_c_k_b_o_x___s_t_r_u_c_t.html#adf10d197299522577e67d366877bdd3f">CHECKBOX_STRUCT::base</a></div><div class="ttdeci">TOUCH_AREA_STRUCT base</div><div class="ttdoc">Basic geometry of the Checkbox. You only need to set the x1, y1, x2, y2 members of this struct...</div><div class="ttdef"><b>Definition:</b> checkbox.h:35</div></div>
<div class="ttc" id="group__checkbox_html_ga4e76e0aec1a3ec620e09161ed2869b14"><div class="ttname"><a href="group__checkbox.html#ga4e76e0aec1a3ec620e09161ed2869b14">CHECKBOX_CALLBACK</a></div><div class="ttdeci">void(* CHECKBOX_CALLBACK)(void *checkbox, bool checked)</div><div class="ttdef"><b>Definition:</b> checkbox.h:29</div></div>
<div class="ttc" id="struct_c_h_e_c_k_b_o_x___s_t_r_u_c_t_html_a78bc63a5b9272aa4a69d6ceea4e65902"><div class="ttname"><a href="struct_c_h_e_c_k_b_o_x___s_t_r_u_c_t.html#a78bc63a5b9272aa4a69d6ceea4e65902">CHECKBOX_STRUCT::fgcolor</a></div><div class="ttdeci">uint16_t fgcolor</div><div class="ttdoc">The 16-bit color of the tickmark. </div><div class="ttdef"><b>Definition:</b> checkbox.h:36</div></div>
<div class="ttc" id="group__checkbox_html_ga3e07fb73eb79e8cf6db8f70455f09a92"><div class="ttname"><a href="group__checkbox.html#ga3e07fb73eb79e8cf6db8f70455f09a92">gui_checkbox_redraw</a></div><div class="ttdeci">void gui_checkbox_redraw(CHECKBOX_STRUCT *checkbox)</div><div class="ttdef"><b>Definition:</b> checkbox.c:85</div></div>
<div class="ttc" id="struct_c_h_e_c_k_b_o_x___s_t_r_u_c_t_html_a47605ea724f7147a5e79a995afc7e26f"><div class="ttname"><a href="struct_c_h_e_c_k_b_o_x___s_t_r_u_c_t.html#a47605ea724f7147a5e79a995afc7e26f">CHECKBOX_STRUCT::callback</a></div><div class="ttdeci">CHECKBOX_CALLBACK callback</div><div class="ttdoc">Callback which is executed when the checkbox changes state. </div><div class="ttdef"><b>Definition:</b> checkbox.h:38</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 &#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>