-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathbyte__input_8h.html
313 lines (295 loc) · 16.7 KB
/
byte__input_8h.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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
<!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/byte_input.h File Reference</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="summary">
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">byte_input.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>GUI: <a class="el" href="struct_byte_input.html">ByteInput</a> keyboard view module API.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include <<a class="el" href="view_8h_source.html">gui/view.h</a>></code><br />
</div>
<p><a href="byte__input_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a7fb4785aaed2f3bb84afdd57f1d67886"><td class="memItemLeft" align="right" valign="top"><a id="a7fb4785aaed2f3bb84afdd57f1d67886" name="a7fb4785aaed2f3bb84afdd57f1d67886"></a>
typedef struct <a class="el" href="struct_byte_input.html">ByteInput</a> </td><td class="memItemRight" valign="bottom"><b>ByteInput</b></td></tr>
<tr class="memdesc:a7fb4785aaed2f3bb84afdd57f1d67886"><td class="mdescLeft"> </td><td class="mdescRight">Byte input anonymous structure <br />
<br /></td></tr>
<tr class="separator:a7fb4785aaed2f3bb84afdd57f1d67886"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aac6ce8d72775d51e0057eb80b7097ce6"><td class="memItemLeft" align="right" valign="top"><a id="aac6ce8d72775d51e0057eb80b7097ce6" name="aac6ce8d72775d51e0057eb80b7097ce6"></a>
typedef void(* </td><td class="memItemRight" valign="bottom"><b>ByteInputCallback</b>) (void *context)</td></tr>
<tr class="memdesc:aac6ce8d72775d51e0057eb80b7097ce6"><td class="mdescLeft"> </td><td class="mdescRight">callback that is executed on save button press <br /></td></tr>
<tr class="separator:aac6ce8d72775d51e0057eb80b7097ce6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9ae0f3431855581e281c6e1f18f80435"><td class="memItemLeft" align="right" valign="top"><a id="a9ae0f3431855581e281c6e1f18f80435" name="a9ae0f3431855581e281c6e1f18f80435"></a>
typedef void(* </td><td class="memItemRight" valign="bottom"><b>ByteChangedCallback</b>) (void *context)</td></tr>
<tr class="memdesc:a9ae0f3431855581e281c6e1f18f80435"><td class="mdescLeft"> </td><td class="mdescRight">callback that is executed when byte buffer is changed <br /></td></tr>
<tr class="separator:a9ae0f3431855581e281c6e1f18f80435"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a1c1de922f9091a277df8ee948d09226b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_byte_input.html">ByteInput</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="byte__input_8h.html#a1c1de922f9091a277df8ee948d09226b">byte_input_alloc</a> ()</td></tr>
<tr class="memdesc:a1c1de922f9091a277df8ee948d09226b"><td class="mdescLeft"> </td><td class="mdescRight">Allocate and initialize byte input. <a href="byte__input_8h.html#a1c1de922f9091a277df8ee948d09226b">More...</a><br /></td></tr>
<tr class="separator:a1c1de922f9091a277df8ee948d09226b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acf80162a45c6b333b1051acff3b9eeb4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="byte__input_8h.html#acf80162a45c6b333b1051acff3b9eeb4">byte_input_free</a> (<a class="el" href="struct_byte_input.html">ByteInput</a> *byte_input)</td></tr>
<tr class="memdesc:acf80162a45c6b333b1051acff3b9eeb4"><td class="mdescLeft"> </td><td class="mdescRight">Deinitialize and free byte input. <a href="byte__input_8h.html#acf80162a45c6b333b1051acff3b9eeb4">More...</a><br /></td></tr>
<tr class="separator:acf80162a45c6b333b1051acff3b9eeb4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a73ed21ca1341be7b96cd19cd6e381c6d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_view.html">View</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="byte__input_8h.html#a73ed21ca1341be7b96cd19cd6e381c6d">byte_input_get_view</a> (<a class="el" href="struct_byte_input.html">ByteInput</a> *byte_input)</td></tr>
<tr class="memdesc:a73ed21ca1341be7b96cd19cd6e381c6d"><td class="mdescLeft"> </td><td class="mdescRight">Get byte input view. <a href="byte__input_8h.html#a73ed21ca1341be7b96cd19cd6e381c6d">More...</a><br /></td></tr>
<tr class="separator:a73ed21ca1341be7b96cd19cd6e381c6d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0681dfcc0779cdc22d9a2a591ef3e1f7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="byte__input_8h.html#a0681dfcc0779cdc22d9a2a591ef3e1f7">byte_input_set_result_callback</a> (<a class="el" href="struct_byte_input.html">ByteInput</a> *byte_input, <a class="el" href="byte__input_8h.html#aac6ce8d72775d51e0057eb80b7097ce6">ByteInputCallback</a> input_callback, <a class="el" href="byte__input_8h.html#a9ae0f3431855581e281c6e1f18f80435">ByteChangedCallback</a> changed_callback, void *callback_context, uint8_t *bytes, uint8_t bytes_count)</td></tr>
<tr class="memdesc:a0681dfcc0779cdc22d9a2a591ef3e1f7"><td class="mdescLeft"> </td><td class="mdescRight">Set byte input result callback. <a href="byte__input_8h.html#a0681dfcc0779cdc22d9a2a591ef3e1f7">More...</a><br /></td></tr>
<tr class="separator:a0681dfcc0779cdc22d9a2a591ef3e1f7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae641d558f96a361cbe9d449b20cf7449"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="byte__input_8h.html#ae641d558f96a361cbe9d449b20cf7449">byte_input_set_header_text</a> (<a class="el" href="struct_byte_input.html">ByteInput</a> *byte_input, const char *text)</td></tr>
<tr class="memdesc:ae641d558f96a361cbe9d449b20cf7449"><td class="mdescLeft"> </td><td class="mdescRight">Set byte input header text. <a href="byte__input_8h.html#ae641d558f96a361cbe9d449b20cf7449">More...</a><br /></td></tr>
<tr class="separator:ae641d558f96a361cbe9d449b20cf7449"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p >GUI: <a class="el" href="struct_byte_input.html">ByteInput</a> keyboard view module API. </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="a1c1de922f9091a277df8ee948d09226b" name="a1c1de922f9091a277df8ee948d09226b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1c1de922f9091a277df8ee948d09226b">◆ </a></span>byte_input_alloc()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="struct_byte_input.html">ByteInput</a> * byte_input_alloc </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Allocate and initialize byte input. </p>
<p >This byte input is used to enter bytes.</p>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="struct_byte_input.html">ByteInput</a> instance pointer </dd></dl>
</div>
</div>
<a id="acf80162a45c6b333b1051acff3b9eeb4" name="acf80162a45c6b333b1051acff3b9eeb4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acf80162a45c6b333b1051acff3b9eeb4">◆ </a></span>byte_input_free()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void byte_input_free </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_byte_input.html">ByteInput</a> * </td>
<td class="paramname"><em>byte_input</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Deinitialize and free byte input. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">byte_input</td><td>Byte input instance </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a73ed21ca1341be7b96cd19cd6e381c6d" name="a73ed21ca1341be7b96cd19cd6e381c6d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a73ed21ca1341be7b96cd19cd6e381c6d">◆ </a></span>byte_input_get_view()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="struct_view.html">View</a> * byte_input_get_view </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_byte_input.html">ByteInput</a> * </td>
<td class="paramname"><em>byte_input</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get byte input view. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">byte_input</td><td>byte input instance</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="struct_view.html">View</a> instance that can be used for embedding </dd></dl>
</div>
</div>
<a id="ae641d558f96a361cbe9d449b20cf7449" name="ae641d558f96a361cbe9d449b20cf7449"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae641d558f96a361cbe9d449b20cf7449">◆ </a></span>byte_input_set_header_text()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void byte_input_set_header_text </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_byte_input.html">ByteInput</a> * </td>
<td class="paramname"><em>byte_input</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>text</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set byte input header text. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">byte_input</td><td>byte input instance </td></tr>
<tr><td class="paramname">text</td><td>text to be shown </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a0681dfcc0779cdc22d9a2a591ef3e1f7" name="a0681dfcc0779cdc22d9a2a591ef3e1f7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0681dfcc0779cdc22d9a2a591ef3e1f7">◆ </a></span>byte_input_set_result_callback()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void byte_input_set_result_callback </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_byte_input.html">ByteInput</a> * </td>
<td class="paramname"><em>byte_input</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="byte__input_8h.html#aac6ce8d72775d51e0057eb80b7097ce6">ByteInputCallback</a> </td>
<td class="paramname"><em>input_callback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="byte__input_8h.html#a9ae0f3431855581e281c6e1f18f80435">ByteChangedCallback</a> </td>
<td class="paramname"><em>changed_callback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>callback_context</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t * </td>
<td class="paramname"><em>bytes</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t </td>
<td class="paramname"><em>bytes_count</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set byte input result callback. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">byte_input</td><td>byte input instance </td></tr>
<tr><td class="paramname">input_callback</td><td>input callback fn </td></tr>
<tr><td class="paramname">changed_callback</td><td>changed callback fn </td></tr>
<tr><td class="paramname">callback_context</td><td>callback context </td></tr>
<tr><td class="paramname">bytes</td><td>buffer to use </td></tr>
<tr><td class="paramname">bytes_count</td><td>buffer length</td></tr>
</table>
</dd>
</dl>
<p>Set byte input result callback.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">byte_input</td><td>byte input instance </td></tr>
<tr><td class="paramname">input_callback</td><td>input callback fn </td></tr>
<tr><td class="paramname">changed_callback</td><td>changed callback fn </td></tr>
<tr><td class="paramname">callback_context</td><td>callback context </td></tr>
<tr><td class="paramname">bytes</td><td>buffer to use </td></tr>
<tr><td class="paramname">bytes_count</td><td>buffer length </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</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>