Files
discoverpixy/checkbox_8h_source.html
2015-06-08 11:04:50 +02:00

157 lines
16 KiB
HTML

<!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: common/gui/checkbox.h Source File</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 class="current"><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 id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&#160;List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<!-- 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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_bdd9a5d540de89e9fe90efdfc6973a4f.html">common</a></li><li class="navelem"><a class="el" href="dir_ad7e3681fbb6f77d8ce503c4a3117735.html">gui</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">checkbox.h</div> </div>
</div><!--header-->
<div class="contents">
<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="comment">/**************************************************************************************************************************************</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">* Project: discoverpixy</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">* Website: https://github.com/t-moe/discoverpixy</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">* Authors: Aaron Schmocker, Timo Lang</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment">* Institution: BFH Bern University of Applied Sciences</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment">* File: common/gui/checkbox.h</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment">*</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment">* Version History:</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment">* Date Autor Email SHA Changes</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment">* 2015-04-27 timolang@gmail.com b300ac5 Added Checkbox support</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment">* 2015-05-11 timolang@gmail.com 08d9fe0 More work on doxygen module structure</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment">* 2015-05-15 timolang@gmail.com 9a16865 Added doxgen comments to filesyste, checkbox, numupdown and screen module. And some minor changes to the other modules.</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment">* 2015-05-17 timolang@gmail.com 2d46336 Improved comments in implementation of button, checkbox, numupdown, tft, touch and screen modules/submodules.</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment">*</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment">**************************************************************************************************************************************/</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;</div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#ifndef CHECKBOX_H</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#define CHECKBOX_H</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;</div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</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="l00021"></a><span class="lineno"> 21</span>&#160;</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;</div>
<div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="group__checkbox.html#ga4e76e0aec1a3ec620e09161ed2869b14"> 45</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="l00046"></a><span class="lineno"> 46</span>&#160;</div>
<div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="struct_c_h_e_c_k_b_o_x___s_t_r_u_c_t.html"> 50</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span>{</div>
<div class="line"><a name="l00051"></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"> 51</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="l00052"></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"> 52</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="l00053"></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"> 53</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="l00054"></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"> 54</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="l00055"></a><span class="lineno"> 55</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="l00056"></a><span class="lineno"> 56</span>&#160;</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</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="l00063"></a><span class="lineno"> 63</span>&#160;</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</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="l00069"></a><span class="lineno"> 69</span>&#160;</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</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="l00075"></a><span class="lineno"> 75</span>&#160;</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</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="l00081"></a><span class="lineno"> 81</span>&#160;</div>
<div class="line"><a name="l00082"></a><span class="lineno"><a class="line" href="group__checkbox.html#gac07a837d568fb96977a0658e49ca2ce8"> 82</a></span>&#160;<span class="preprocessor">#define CHECKBOX_WIN_FG_COLOR RGB(32,161,34)</span></div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160;</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</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> <a href="checkbox_8c_source.html#l00070">checkbox.c:70</a></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> <a href="checkbox_8c_source.html#l00125">checkbox.c:125</a></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> <a href="checkbox_8c_source.html#l00119">checkbox.c:119</a></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> <a href="checkbox_8h_source.html#l00053">checkbox.h:53</a></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> <a href="touch_8h_source.html#l00072">touch.h:72</a></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> <a href="checkbox_8h_source.html#l00050">checkbox.h:50</a></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> <a href="checkbox_8h_source.html#l00051">checkbox.h:51</a></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> <a href="checkbox_8h_source.html#l00045">checkbox.h:45</a></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> <a href="checkbox_8h_source.html#l00052">checkbox.h:52</a></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> <a href="checkbox_8c_source.html#l00108">checkbox.c:108</a></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> <a href="checkbox_8h_source.html#l00054">checkbox.h:54</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Jun 8 2015 11:01:18 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>