-
Notifications
You must be signed in to change notification settings - Fork 0
/
button__menu_8h_source.html
136 lines (134 loc) · 15.9 KB
/
button__menu_8h_source.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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=11"/>
<meta name="generator" content="Doxygen 1.9.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>FlipperZero Firmware: applications/services/gui/modules/button_menu.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>
<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 id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">FlipperZero Firmware
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.2 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></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_a6e4fee11f07c3b70486e88fe92cbbdc.html">applications</a></li><li class="navelem"><a class="el" href="dir_1581ab0e1b6f5f52cf9e9cea60a8e5e8.html">services</a></li><li class="navelem"><a class="el" href="dir_7aa9847637b0c465bfb6fdb3cbf0b24a.html">gui</a></li><li class="navelem"><a class="el" href="dir_d1431f705967dc3195bd6b9148f35d78.html">modules</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">button_menu.h</div></div>
</div><!--header-->
<div class="contents">
<a href="button__menu_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span> </div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span> </div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include <stdint.h></span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include <<a class="code" href="view_8h.html">gui/view.h</a>></span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> </div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> </div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"><a class="line" href="button__menu_8h.html#a5dabb30aafd88e154044624b625bcf7a"> 16</a></span><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="struct_button_menu.html">ButtonMenu</a> <a class="code hl_struct" href="struct_button_menu.html">ButtonMenu</a>;</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> </div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"><a class="line" href="button__menu_8h.html#aa1345067143ce1712f7cbbaeb7658d6f"> 19</a></span><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="struct_button_menu_item.html">ButtonMenuItem</a> <a class="code hl_struct" href="struct_button_menu_item.html">ButtonMenuItem</a>;</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> </div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"><a class="line" href="button__menu_8h.html#a1043247f8de6ed5a0f9f212b2bb45bb0"> 22</a></span><span class="keyword">typedef</span> void (*<a class="code hl_typedef" href="button__menu_8h.html#a1043247f8de6ed5a0f9f212b2bb45bb0">ButtonMenuItemCallback</a>)(<span class="keywordtype">void</span>* context, int32_t index, <a class="code hl_enumeration" href="input_8h.html#a5fc772c800c3d40d2b95564e8a839bab">InputType</a> type);</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> </div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"><a class="line" href="button__menu_8h.html#acda8e10ea4bfef16a93f47b6e6dca665"> 25</a></span><span class="keyword">typedef</span> <span class="keyword">enum</span> {</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> ButtonMenuItemTypeCommon,</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> ButtonMenuItemTypeControl,</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span>} <a class="code hl_enumeration" href="button__menu_8h.html#acda8e10ea4bfef16a93f47b6e6dca665">ButtonMenuItemType</a>;</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> </div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span><a class="code hl_struct" href="struct_view.html">View</a>* <a class="code hl_function" href="button__menu_8h.html#abb61bf047649f3d1c152d3201fe7c4d2">button_menu_get_view</a>(<a class="code hl_struct" href="struct_button_menu.html">ButtonMenu</a>* button_menu);</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> </div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span><span class="keywordtype">void</span> <a class="code hl_function" href="button__menu_8h.html#aa3f10e888d162311a1d99079ab29647d">button_menu_reset</a>(<a class="code hl_struct" href="struct_button_menu.html">ButtonMenu</a>* button_menu);</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> </div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span><a class="code hl_struct" href="struct_button_menu_item.html">ButtonMenuItem</a>* <a class="code hl_function" href="button__menu_8h.html#a0eb3e3f054f00f64399dcff3afddaa1a">button_menu_add_item</a>(</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> <a class="code hl_struct" href="struct_button_menu.html">ButtonMenu</a>* button_menu,</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* label,</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> int32_t index,</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> <a class="code hl_typedef" href="button__menu_8h.html#a1043247f8de6ed5a0f9f212b2bb45bb0">ButtonMenuItemCallback</a> callback,</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> <a class="code hl_enumeration" href="button__menu_8h.html#acda8e10ea4bfef16a93f47b6e6dca665">ButtonMenuItemType</a> type,</div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> <span class="keywordtype">void</span>* callback_context);</div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> </div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span><a class="code hl_struct" href="struct_button_menu.html">ButtonMenu</a>* <a class="code hl_function" href="button__menu_8h.html#a8b910c700d95329dbbb799edbdd55b42">button_menu_alloc</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> </div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span><span class="keywordtype">void</span> <a class="code hl_function" href="button__menu_8h.html#a5176ba9dce5b88e70528c299e3620d98">button_menu_free</a>(<a class="code hl_struct" href="struct_button_menu.html">ButtonMenu</a>* button_menu);</div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> </div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span><span class="keywordtype">void</span> <a class="code hl_function" href="button__menu_8h.html#aefbf1d29762dd9581ce37e4a61b6537d">button_menu_set_header</a>(<a class="code hl_struct" href="struct_button_menu.html">ButtonMenu</a>* button_menu, <span class="keyword">const</span> <span class="keywordtype">char</span>* header);</div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> </div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span><span class="keywordtype">void</span> <a class="code hl_function" href="button__menu_8h.html#a7076c1c94e9074a56566583349b09fce">button_menu_set_selected_item</a>(<a class="code hl_struct" href="struct_button_menu.html">ButtonMenu</a>* button_menu, uint32_t index);</div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span> </div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span><span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span>}</div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span><span class="preprocessor">#endif</span></div>
<div class="ttc" id="abutton__menu_8h_html_a0eb3e3f054f00f64399dcff3afddaa1a"><div class="ttname"><a href="button__menu_8h.html#a0eb3e3f054f00f64399dcff3afddaa1a">button_menu_add_item</a></div><div class="ttdeci">ButtonMenuItem * button_menu_add_item(ButtonMenu *button_menu, const char *label, int32_t index, ButtonMenuItemCallback callback, ButtonMenuItemType type, void *callback_context)</div><div class="ttdoc">Add item to button menu instance.</div><div class="ttdef"><b>Definition:</b> button_menu.c:275</div></div>
<div class="ttc" id="abutton__menu_8h_html_a1043247f8de6ed5a0f9f212b2bb45bb0"><div class="ttname"><a href="button__menu_8h.html#a1043247f8de6ed5a0f9f212b2bb45bb0">ButtonMenuItemCallback</a></div><div class="ttdeci">void(* ButtonMenuItemCallback)(void *context, int32_t index, InputType type)</div><div class="ttdoc">Callback for any button menu actions.</div><div class="ttdef"><b>Definition:</b> button_menu.h:22</div></div>
<div class="ttc" id="abutton__menu_8h_html_a5176ba9dce5b88e70528c299e3620d98"><div class="ttname"><a href="button__menu_8h.html#a5176ba9dce5b88e70528c299e3620d98">button_menu_free</a></div><div class="ttdeci">void button_menu_free(ButtonMenu *button_menu)</div><div class="ttdoc">Free ButtonMenu element.</div><div class="ttdef"><b>Definition:</b> button_menu.c:325</div></div>
<div class="ttc" id="abutton__menu_8h_html_a7076c1c94e9074a56566583349b09fce"><div class="ttname"><a href="button__menu_8h.html#a7076c1c94e9074a56566583349b09fce">button_menu_set_selected_item</a></div><div class="ttdeci">void button_menu_set_selected_item(ButtonMenu *button_menu, uint32_t index)</div><div class="ttdoc">Set selected item.</div><div class="ttdef"><b>Definition:</b> button_menu.c:337</div></div>
<div class="ttc" id="abutton__menu_8h_html_a8b910c700d95329dbbb799edbdd55b42"><div class="ttname"><a href="button__menu_8h.html#a8b910c700d95329dbbb799edbdd55b42">button_menu_alloc</a></div><div class="ttdeci">ButtonMenu * button_menu_alloc(void)</div><div class="ttdoc">Allocate and initialize new instance of ButtonMenu model.</div><div class="ttdef"><b>Definition:</b> button_menu.c:302</div></div>
<div class="ttc" id="abutton__menu_8h_html_aa3f10e888d162311a1d99079ab29647d"><div class="ttname"><a href="button__menu_8h.html#aa3f10e888d162311a1d99079ab29647d">button_menu_reset</a></div><div class="ttdeci">void button_menu_reset(ButtonMenu *button_menu)</div><div class="ttdoc">Clean button menu.</div><div class="ttdef"><b>Definition:</b> button_menu.c:254</div></div>
<div class="ttc" id="abutton__menu_8h_html_abb61bf047649f3d1c152d3201fe7c4d2"><div class="ttname"><a href="button__menu_8h.html#abb61bf047649f3d1c152d3201fe7c4d2">button_menu_get_view</a></div><div class="ttdeci">View * button_menu_get_view(ButtonMenu *button_menu)</div><div class="ttdoc">Get button menu view.</div><div class="ttdef"><b>Definition:</b> button_menu.c:249</div></div>
<div class="ttc" id="abutton__menu_8h_html_acda8e10ea4bfef16a93f47b6e6dca665"><div class="ttname"><a href="button__menu_8h.html#acda8e10ea4bfef16a93f47b6e6dca665">ButtonMenuItemType</a></div><div class="ttdeci">ButtonMenuItemType</div><div class="ttdoc">Type of button.</div><div class="ttdef"><b>Definition:</b> button_menu.h:25</div></div>
<div class="ttc" id="abutton__menu_8h_html_aefbf1d29762dd9581ce37e4a61b6537d"><div class="ttname"><a href="button__menu_8h.html#aefbf1d29762dd9581ce37e4a61b6537d">button_menu_set_header</a></div><div class="ttdeci">void button_menu_set_header(ButtonMenu *button_menu, const char *header)</div><div class="ttdoc">Set ButtonMenu header on top of canvas.</div><div class="ttdef"><b>Definition:</b> button_menu.c:268</div></div>
<div class="ttc" id="ainput_8h_html_a5fc772c800c3d40d2b95564e8a839bab"><div class="ttname"><a href="input_8h.html#a5fc772c800c3d40d2b95564e8a839bab">InputType</a></div><div class="ttdeci">InputType</div><div class="ttdoc">Input Types Some of them are physical events and some logical.</div><div class="ttdef"><b>Definition:</b> input.h:19</div></div>
<div class="ttc" id="astruct_button_menu_html"><div class="ttname"><a href="struct_button_menu.html">ButtonMenu</a></div><div class="ttdef"><b>Definition:</b> button_menu.c:26</div></div>
<div class="ttc" id="astruct_button_menu_item_html"><div class="ttname"><a href="struct_button_menu_item.html">ButtonMenuItem</a></div><div class="ttdef"><b>Definition:</b> button_menu.c:16</div></div>
<div class="ttc" id="astruct_view_html"><div class="ttname"><a href="struct_view.html">View</a></div><div class="ttdef"><b>Definition:</b> view_i.h:16</div></div>
<div class="ttc" id="aview_8h_html"><div class="ttname"><a href="view_8h.html">view.h</a></div><div class="ttdoc">GUI: View API.</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.2
</small></address>
</body>
</html>