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

@@ -100,7 +100,6 @@ Data Structures</h2></td></tr>
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga69649e9300c3044bf33744dfb73479c0"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__numupdown.html#ga69649e9300c3044bf33744dfb73479c0">NUMUPDOWN_CALLBACK</a>) (void *numupdown, int16_t value)</td></tr>
<tr class="memdesc:ga69649e9300c3044bf33744dfb73479c0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Function pointer used... <a href="#ga69649e9300c3044bf33744dfb73479c0">More...</a><br /></td></tr>
<tr class="separator:ga69649e9300c3044bf33744dfb73479c0"><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>
@@ -126,8 +125,14 @@ Functions</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<p>Function pointer used... </p>
<p>Prototype for Event Listeners (called when the NummericUpDown value has changed) </p><dl class="section note"><dt>Note</dt><dd>You should NOT execute long running things in this callback nor should you update the gui. But you can call <a class="el" href="group__screen.html#gad4473a16eaf48dab405d23f5f63af3aa">gui_screen_navigate()</a> for instance. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">numupdown</td><td>The pointer to the <a class="el" href="struct_n_u_m_u_p_d_o_w_n___s_t_r_u_c_t.html">NUMUPDOWN_STRUCT</a> where to corresponding NummericUpDown has changed it's value </td></tr>
<tr><td class="paramname">value</td><td>The new value of the NummericUpDown </td></tr>
</table>
</dd>
</dl>
</div>
</div>
@@ -145,13 +150,20 @@ Functions</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<p>Adds a NummericUpDown. Your Callback will be called from now on, if the numupdown's value changes </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">numupdown</td><td>A Pointer to the preinitialized <a class="el" href="struct_n_u_m_u_p_d_o_w_n___s_t_r_u_c_t.html">NUMUPDOWN_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__numupdown_gab4321e7fc0810ee30355bc7d0a3372db_cgraph.png" border="0" usemap="#group__numupdown_gab4321e7fc0810ee30355bc7d0a3372db_cgraph" alt=""/></div>
<map name="group__numupdown_gab4321e7fc0810ee30355bc7d0a3372db_cgraph" id="group__numupdown_gab4321e7fc0810ee30355bc7d0a3372db_cgraph">
<area shape="rect" id="node2" href="group__touch.html#gad32e5d122ec3f5f88bc6b2d9f4a629f8" title="touch_have_empty" alt="" coords="375,287,506,314"/><area shape="rect" id="node3" href="numupdown_8c.html#a9f47a5adddb4640cdd37b578484abfa8" title="calc_text_width" alt="" coords="577,34,689,60"/><area shape="rect" id="node4" href="group__tft.html#ga7e99287b1e6b844f6867c63400959ffc" title="tft_font_width" alt="" coords="583,287,682,314"/><area shape="rect" id="node6" href="group__tft.html#gaea9f6a88da91949befe52cd4ed000c5d" title="tft_font_height" alt="" coords="581,464,684,491"/><area shape="rect" id="node8" href="numupdown_8c.html#a0422809516212448deaf10314d0c01d5" title="button_down_cb" alt="" coords="196,84,312,111"/><area shape="rect" id="node10" href="group__tft.html#ga781855ab93845ce326dfca7c099259c6" title="tft_fill_rectangle" alt="" coords="577,135,689,162"/><area shape="rect" id="node12" href="group__tft.html#ga765c521ee1b01ab0c34449936500291b" title="tft_print_formatted" alt="" coords="569,186,696,212"/><area shape="rect" id="node16" href="group__button.html#ga64d5d2aaff2c917e5d43e7ed849607de" title="gui_button_add" alt="" coords="199,388,309,415"/><area shape="rect" id="node22" href="numupdown_8c.html#a47b81268e10355aa5abbb05788e99dfc" title="button_up_cb" alt="" coords="204,135,304,162"/><area shape="rect" id="node5" href="ll__tft_8h.html#a3639ec94b2239cc02b3c47a14f6637a3" title="ll_tft_font_width" alt="" coords="919,287,1029,314"/><area shape="rect" id="node7" href="ll__tft_8h.html#a8dbc8b40717be527e6f1c5a2cfc72aeb" title="ll_tft_font_height" alt="" coords="749,464,865,491"/><area shape="rect" id="node9" href="group__numupdown.html#ga99d528cc9828d6dcf46e04673e5e51d9" title="gui_numupdown_update" alt="" coords="360,135,521,162"/><area shape="rect" id="node11" href="ll__tft_8h.html#a0111ae5623214d3d466b2b24598f303f" title="ll_tft_fill_rectangle" alt="" coords="744,135,869,162"/><area shape="rect" id="node13" href="group__tft.html#gabf54943131990b366ce6875a0e1925f6" title="tft_print_line" alt="" coords="761,338,853,364"/><area shape="rect" id="node14" href="ll__tft_8h.html#af4b0b73ab01e1dc300ae65dc0ac029b6" title="ll_tft_num_fonts" alt="" coords="917,388,1031,415"/><area shape="rect" id="node15" href="ll__tft_8h.html#a408570a2b70769255924792ce189f2c1" title="ll_tft_draw_char" alt="" coords="918,338,1030,364"/><area shape="rect" id="node17" href="button_8c.html#a7dca41e6afa418abaf2d471acac9b649" title="buttons_cb" alt="" coords="397,591,484,618"/><area shape="rect" id="node20" href="group__button.html#ga6da1e251bad09d29fbb3b3f405689ab1" title="gui_button_redraw" alt="" coords="377,439,504,466"/><area shape="rect" id="node21" href="group__touch.html#ga3adc36f55b7475b3f652c38c0e23d741" title="touch_register_area" alt="" coords="373,388,509,415"/><area shape="rect" id="node18" href="group__tft.html#ga5022f91ea04919e698a79c0c309ba6f8" title="tft_draw_line" alt="" coords="585,566,680,592"/><area shape="rect" id="node19" href="ll__tft_8h.html#a2560737bf118275e6ce728f6dce1e83f" title="ll_tft_draw_line" alt="" coords="753,566,860,592"/></map>
<area shape="rect" id="node2" href="group__touch.html#gad32e5d122ec3f5f88bc6b2d9f4a629f8" title="touch_have_empty" alt="" coords="375,287,506,314"/><area shape="rect" id="node3" href="numupdown_8c.html#a9f47a5adddb4640cdd37b578484abfa8" title="calc_text_width" alt="" coords="579,34,691,60"/><area shape="rect" id="node4" href="group__tft.html#ga7e99287b1e6b844f6867c63400959ffc" title="tft_font_width" alt="" coords="586,287,685,314"/><area shape="rect" id="node6" href="group__tft.html#gaea9f6a88da91949befe52cd4ed000c5d" title="tft_font_height" alt="" coords="584,464,687,491"/><area shape="rect" id="node8" href="numupdown_8c.html#a0422809516212448deaf10314d0c01d5" title="button_down_cb" alt="" coords="196,84,312,111"/><area shape="rect" id="node10" href="group__tft.html#ga781855ab93845ce326dfca7c099259c6" title="tft_fill_rectangle" alt="" coords="579,135,691,162"/><area shape="rect" id="node12" href="group__tft.html#ga765c521ee1b01ab0c34449936500291b" title="tft_print_formatted" alt="" coords="572,186,699,212"/><area shape="rect" id="node16" href="group__button.html#ga64d5d2aaff2c917e5d43e7ed849607de" title="gui_button_add" alt="" coords="199,388,309,415"/><area shape="rect" id="node23" href="numupdown_8c.html#a47b81268e10355aa5abbb05788e99dfc" title="button_up_cb" alt="" coords="204,135,304,162"/><area shape="rect" id="node5" href="group__ll__tft.html#ga3639ec94b2239cc02b3c47a14f6637a3" title="ll_tft_font_width" alt="" coords="924,287,1035,314"/><area shape="rect" id="node7" href="group__ll__tft.html#ga8dbc8b40717be527e6f1c5a2cfc72aeb" title="ll_tft_font_height" alt="" coords="754,464,870,491"/><area shape="rect" id="node9" href="group__numupdown.html#ga99d528cc9828d6dcf46e04673e5e51d9" title="gui_numupdown_update" alt="" coords="360,135,521,162"/><area shape="rect" id="node11" href="group__ll__tft.html#ga0111ae5623214d3d466b2b24598f303f" title="ll_tft_fill_rectangle" alt="" coords="749,135,875,162"/><area shape="rect" id="node13" href="group__tft.html#gabf54943131990b366ce6875a0e1925f6" title="tft_print_line" alt="" coords="766,338,858,364"/><area shape="rect" id="node14" href="group__ll__tft.html#gaf4b0b73ab01e1dc300ae65dc0ac029b6" title="ll_tft_num_fonts" alt="" coords="923,388,1036,415"/><area shape="rect" id="node15" href="group__ll__tft.html#ga408570a2b70769255924792ce189f2c1" title="ll_tft_draw_char" alt="" coords="923,338,1035,364"/><area shape="rect" id="node17" href="button_8c.html#a7dca41e6afa418abaf2d471acac9b649" title="buttons_cb" alt="" coords="397,591,484,618"/><area shape="rect" id="node21" href="group__button.html#ga6da1e251bad09d29fbb3b3f405689ab1" title="gui_button_redraw" alt="" coords="377,439,504,466"/><area shape="rect" id="node22" href="group__touch.html#ga3adc36f55b7475b3f652c38c0e23d741" title="touch_register_area" alt="" coords="373,388,509,415"/><area shape="rect" id="node18" href="button_8c.html#a05bb88dac6f60063eae2bb67dda1f4e8" title="calculate_shadows" alt="" coords="569,584,701,611"/><area shape="rect" id="node19" href="group__tft.html#ga5022f91ea04919e698a79c0c309ba6f8" title="tft_draw_line" alt="" coords="588,522,683,548"/><area shape="rect" id="node20" href="group__ll__tft.html#ga2560737bf118275e6ce728f6dce1e83f" title="ll_tft_draw_line" alt="" coords="759,522,865,548"/></map>
</div>
</p>
@@ -179,13 +191,19 @@ Here is the caller graph for this function:</div>
</tr>
</table>
</div><div class="memdoc">
<p>Redraws the NummericUpDown. Call this method if you have to redraw the entire screen or if you want to draw a numupdown on top of an image. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">numupdown</td><td>A Pointer to the <a class="el" href="struct_n_u_m_u_p_d_o_w_n___s_t_r_u_c_t.html">NUMUPDOWN_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__numupdown_ga4ee98a6c6af451123af6c464a851c03a_cgraph.png" border="0" usemap="#group__numupdown_ga4ee98a6c6af451123af6c464a851c03a_cgraph" alt=""/></div>
<map name="group__numupdown_ga4ee98a6c6af451123af6c464a851c03a_cgraph" id="group__numupdown_ga4ee98a6c6af451123af6c464a851c03a_cgraph">
<area shape="rect" id="node2" href="group__button.html#ga6da1e251bad09d29fbb3b3f405689ab1" title="gui_button_redraw" alt="" coords="231,120,357,147"/><area shape="rect" id="node14" href="group__numupdown.html#ga99d528cc9828d6dcf46e04673e5e51d9" title="gui_numupdown_update" alt="" coords="213,196,375,223"/><area shape="rect" id="node3" href="group__tft.html#ga7e99287b1e6b844f6867c63400959ffc" title="tft_font_width" alt="" coords="437,157,535,184"/><area shape="rect" id="node5" href="group__tft.html#gaea9f6a88da91949befe52cd4ed000c5d" title="tft_font_height" alt="" coords="435,107,537,133"/><area shape="rect" id="node7" href="group__tft.html#ga781855ab93845ce326dfca7c099259c6" title="tft_fill_rectangle" alt="" coords="430,259,542,285"/><area shape="rect" id="node9" href="group__tft.html#ga5022f91ea04919e698a79c0c309ba6f8" title="tft_draw_line" alt="" coords="439,5,533,32"/><area shape="rect" id="node11" href="group__tft.html#gabf54943131990b366ce6875a0e1925f6" title="tft_print_line" alt="" coords="614,56,706,83"/><area shape="rect" id="node4" href="ll__tft_8h.html#a3639ec94b2239cc02b3c47a14f6637a3" title="ll_tft_font_width" alt="" coords="772,132,883,159"/><area shape="rect" id="node6" href="ll__tft_8h.html#a8dbc8b40717be527e6f1c5a2cfc72aeb" title="ll_tft_font_height" alt="" coords="602,107,718,133"/><area shape="rect" id="node8" href="ll__tft_8h.html#a0111ae5623214d3d466b2b24598f303f" title="ll_tft_fill_rectangle" alt="" coords="597,259,723,285"/><area shape="rect" id="node10" href="ll__tft_8h.html#a2560737bf118275e6ce728f6dce1e83f" title="ll_tft_draw_line" alt="" coords="607,5,713,32"/><area shape="rect" id="node12" href="ll__tft_8h.html#af4b0b73ab01e1dc300ae65dc0ac029b6" title="ll_tft_num_fonts" alt="" coords="771,31,884,57"/><area shape="rect" id="node13" href="ll__tft_8h.html#a408570a2b70769255924792ce189f2c1" title="ll_tft_draw_char" alt="" coords="771,81,883,108"/><area shape="rect" id="node15" href="numupdown_8c.html#a9f47a5adddb4640cdd37b578484abfa8" title="calc_text_width" alt="" coords="430,309,542,336"/><area shape="rect" id="node16" href="group__tft.html#ga765c521ee1b01ab0c34449936500291b" title="tft_print_formatted" alt="" coords="423,208,549,235"/></map>
<area shape="rect" id="node2" href="group__button.html#ga6da1e251bad09d29fbb3b3f405689ab1" title="gui_button_redraw" alt="" coords="231,208,357,235"/><area shape="rect" id="node15" href="group__numupdown.html#ga99d528cc9828d6dcf46e04673e5e51d9" title="gui_numupdown_update" alt="" coords="213,132,375,159"/><area shape="rect" id="node3" href="group__tft.html#ga7e99287b1e6b844f6867c63400959ffc" title="tft_font_width" alt="" coords="439,157,538,184"/><area shape="rect" id="node5" href="group__tft.html#gaea9f6a88da91949befe52cd4ed000c5d" title="tft_font_height" alt="" coords="437,208,540,235"/><area shape="rect" id="node7" href="button_8c.html#a05bb88dac6f60063eae2bb67dda1f4e8" title="calculate_shadows" alt="" coords="423,309,555,336"/><area shape="rect" id="node8" href="group__tft.html#ga781855ab93845ce326dfca7c099259c6" title="tft_fill_rectangle" alt="" coords="433,107,545,133"/><area shape="rect" id="node10" href="group__tft.html#ga5022f91ea04919e698a79c0c309ba6f8" title="tft_draw_line" alt="" coords="441,360,536,387"/><area shape="rect" id="node12" href="group__tft.html#gabf54943131990b366ce6875a0e1925f6" title="tft_print_line" alt="" coords="619,259,711,285"/><area shape="rect" id="node4" href="group__ll__tft.html#ga3639ec94b2239cc02b3c47a14f6637a3" title="ll_tft_font_width" alt="" coords="777,171,888,197"/><area shape="rect" id="node6" href="group__ll__tft.html#ga8dbc8b40717be527e6f1c5a2cfc72aeb" title="ll_tft_font_height" alt="" coords="607,208,723,235"/><area shape="rect" id="node9" href="group__ll__tft.html#ga0111ae5623214d3d466b2b24598f303f" title="ll_tft_fill_rectangle" alt="" coords="603,107,728,133"/><area shape="rect" id="node11" href="group__ll__tft.html#ga2560737bf118275e6ce728f6dce1e83f" title="ll_tft_draw_line" alt="" coords="612,360,719,387"/><area shape="rect" id="node13" href="group__ll__tft.html#gaf4b0b73ab01e1dc300ae65dc0ac029b6" title="ll_tft_num_fonts" alt="" coords="776,233,889,260"/><area shape="rect" id="node14" href="group__ll__tft.html#ga408570a2b70769255924792ce189f2c1" title="ll_tft_draw_char" alt="" coords="777,284,889,311"/><area shape="rect" id="node16" href="numupdown_8c.html#a9f47a5adddb4640cdd37b578484abfa8" title="calc_text_width" alt="" coords="433,5,545,32"/><area shape="rect" id="node17" href="group__tft.html#ga765c521ee1b01ab0c34449936500291b" title="tft_print_formatted" alt="" coords="425,56,552,83"/></map>
</div>
</p>
@@ -204,6 +222,12 @@ Here is the call graph for this function:</div>
</tr>
</table>
</div><div class="memdoc">
<p>Removes the NummericUpDown. You will no longer receive events for this numupdown. This function will not overdraw the region where the numupdown was located. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">numupdown</td><td>A Pointer to the <a class="el" href="struct_n_u_m_u_p_d_o_w_n___s_t_r_u_c_t.html">NUMUPDOWN_STRUCT</a> </td></tr>
</table>
</dd>
</dl>
<p><div class="dynheader">
Here is the call graph for this function:</div>
@@ -238,13 +262,19 @@ Here is the caller graph for this function:</div>
</tr>
</table>
</div><div class="memdoc">
<p>Updates the NummericUpDown. Call this function when you change the value/min/max of the numupdown through code. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">numupdown</td><td>A Pointer to the <a class="el" href="struct_n_u_m_u_p_d_o_w_n___s_t_r_u_c_t.html">NUMUPDOWN_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__numupdown_ga99d528cc9828d6dcf46e04673e5e51d9_cgraph.png" border="0" usemap="#group__numupdown_ga99d528cc9828d6dcf46e04673e5e51d9_cgraph" alt=""/></div>
<map name="group__numupdown_ga99d528cc9828d6dcf46e04673e5e51d9_cgraph" id="group__numupdown_ga99d528cc9828d6dcf46e04673e5e51d9_cgraph">
<area shape="rect" id="node2" href="numupdown_8c.html#a9f47a5adddb4640cdd37b578484abfa8" title="calc_text_width" alt="" coords="222,5,334,32"/><area shape="rect" id="node3" href="group__tft.html#ga7e99287b1e6b844f6867c63400959ffc" title="tft_font_width" alt="" coords="403,56,501,83"/><area shape="rect" id="node5" href="group__tft.html#ga781855ab93845ce326dfca7c099259c6" title="tft_fill_rectangle" alt="" coords="222,107,334,133"/><area shape="rect" id="node7" href="group__tft.html#ga765c521ee1b01ab0c34449936500291b" title="tft_print_formatted" alt="" coords="215,157,341,184"/><area shape="rect" id="node11" href="group__tft.html#gaea9f6a88da91949befe52cd4ed000c5d" title="tft_font_height" alt="" coords="227,208,329,235"/><area shape="rect" id="node4" href="ll__tft_8h.html#a3639ec94b2239cc02b3c47a14f6637a3" title="ll_tft_font_width" alt="" coords="564,69,675,96"/><area shape="rect" id="node6" href="ll__tft_8h.html#a0111ae5623214d3d466b2b24598f303f" title="ll_tft_fill_rectangle" alt="" coords="389,107,515,133"/><area shape="rect" id="node8" href="group__tft.html#gabf54943131990b366ce6875a0e1925f6" title="tft_print_line" alt="" coords="406,157,498,184"/><area shape="rect" id="node9" href="ll__tft_8h.html#af4b0b73ab01e1dc300ae65dc0ac029b6" title="ll_tft_num_fonts" alt="" coords="563,132,676,159"/><area shape="rect" id="node10" href="ll__tft_8h.html#a408570a2b70769255924792ce189f2c1" title="ll_tft_draw_char" alt="" coords="563,183,675,209"/><area shape="rect" id="node12" href="ll__tft_8h.html#a8dbc8b40717be527e6f1c5a2cfc72aeb" title="ll_tft_font_height" alt="" coords="394,208,510,235"/></map>
<area shape="rect" id="node2" href="numupdown_8c.html#a9f47a5adddb4640cdd37b578484abfa8" title="calc_text_width" alt="" coords="222,5,334,32"/><area shape="rect" id="node3" href="group__tft.html#ga7e99287b1e6b844f6867c63400959ffc" title="tft_font_width" alt="" coords="403,56,501,83"/><area shape="rect" id="node5" href="group__tft.html#ga781855ab93845ce326dfca7c099259c6" title="tft_fill_rectangle" alt="" coords="222,107,334,133"/><area shape="rect" id="node7" href="group__tft.html#ga765c521ee1b01ab0c34449936500291b" title="tft_print_formatted" alt="" coords="215,157,341,184"/><area shape="rect" id="node11" href="group__tft.html#gaea9f6a88da91949befe52cd4ed000c5d" title="tft_font_height" alt="" coords="227,208,329,235"/><area shape="rect" id="node4" href="group__ll__tft.html#ga3639ec94b2239cc02b3c47a14f6637a3" title="ll_tft_font_width" alt="" coords="564,69,675,96"/><area shape="rect" id="node6" href="group__ll__tft.html#ga0111ae5623214d3d466b2b24598f303f" title="ll_tft_fill_rectangle" alt="" coords="389,107,515,133"/><area shape="rect" id="node8" href="group__tft.html#gabf54943131990b366ce6875a0e1925f6" title="tft_print_line" alt="" coords="406,157,498,184"/><area shape="rect" id="node9" href="group__ll__tft.html#gaf4b0b73ab01e1dc300ae65dc0ac029b6" title="ll_tft_num_fonts" alt="" coords="563,132,676,159"/><area shape="rect" id="node10" href="group__ll__tft.html#ga408570a2b70769255924792ce189f2c1" title="ll_tft_draw_char" alt="" coords="563,183,675,209"/><area shape="rect" id="node12" href="group__ll__tft.html#ga8dbc8b40717be527e6f1c5a2cfc72aeb" title="ll_tft_font_height" alt="" coords="394,208,510,235"/></map>
</div>
</p>
@@ -262,7 +292,7 @@ Here is the caller graph for this function:</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>