-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathgroup__cpp__kodi__gui__dialogs___keyboard.html
693 lines (663 loc) · 32.6 KB
/
group__cpp__kodi__gui__dialogs___keyboard.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
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
<!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=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Kodi Development: Dialog Keyboard</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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.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">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function() { init_search(); });
/* @license-end */
</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="projectlogo"><img alt="Logo" src="kodi-dev.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Kodi Development
 <span id="projectnumber">20.0</span>
</div>
<div id="projectbrief">for Binary and Script based Add-Ons</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.svg"
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.svg" alt=""/></a>
</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('group__cpp__kodi__gui__dialogs___keyboard.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- 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 class="header">
<div class="headertitle">
<div class="title">Dialog Keyboard<div class="ingroups"><a class="el" href="group__cpp.html">C++</a> » <a class="el" href="group__cpp__kodi__gui.html">Interface - kodi::gui</a> » <a class="el" href="group__cpp__kodi__gui__dialogs.html">2. Dialogs</a></div></div> </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p> <h4><code><span style="font-style: italic;">Namespace: </span><span style="font-style: bold;"><font color=31363b><big> kodi::gui::dialogs::Keyboard </big></font></span></code></h4> <b>Keyboard dialogs</b><br />
The functions listed below have to be permitted by the user for the representation of a keyboard around an input. </p>
<p>The class supports several kinds, from an easy text choice up to the passport Word production and their confirmation for add-on.</p>
<p>It has the header #include <kodi/gui/dialogs/Keyboard.h> be included to enjoy it. </p>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga167eba07f115af03700df889fa08cc54"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga167eba07f115af03700df889fa08cc54">◆ </a></span>ShowAndGetInput() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool ATTRIBUTE_HIDDEN kodi::gui::dialogs::Keyboard::ShowAndGetInput </td>
<td>(</td>
<td class="paramtype">std::string & </td>
<td class="paramname"><em>text</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>heading</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>allowEmptyResult</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>hiddenInput</em> = <code>false</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>autoCloseMs</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Show keyboard with initial value <code>text</code> and replace with result string. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in,out]</td><td class="paramname">text</td><td>Overwritten with user input if return=true. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">heading</td><td>String shown on dialog title. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">allowEmptyResult</td><td>Whether a blank password is valid or not. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">hiddenInput</td><td>[opt] The inserted input is not shown as text. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">autoCloseMs</td><td>[opt] To close the dialog after a specified time, in milliseconds, default is 0 which keeps the dialog open indefinitely. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if successful display and user input. false if unsuccessful display, no user input, or canceled editing.</dd></dl>
<hr />
<p><b>Example:</b> </p><div class="fragment"><div class="line"><span class="preprocessor">#include <kodi/gui/dialogs/Keyboard.h></span></div>
<div class="line"> </div>
<div class="line"><span class="comment">// The example shows the display of keyboard call dialog at Kodi from the add-on.</span></div>
<div class="line"><span class="comment">// Below all values are set, however, can last two (hidden input = false and autoCloseMs = 0)</span></div>
<div class="line"><span class="comment">// to be released if not needed.</span></div>
<div class="line">std::string text = <span class="stringliteral">"Please change me to them want you want"</span>; <span class="comment">// It can be leaved empty or a entry text added</span></div>
<div class="line"><span class="keywordtype">bool</span> bRet = <a class="code" href="group__cpp__kodi__gui__dialogs___keyboard.html#ga167eba07f115af03700df889fa08cc54">::kodi::gui::dialogs::Keyboard::ShowAndGetInput</a>(text,</div>
<div class="line"> <span class="stringliteral">"Demonstration text entry"</span>,</div>
<div class="line"> <span class="keyword">true</span>,</div>
<div class="line"> <span class="keyword">false</span>,</div>
<div class="line"> 0);</div>
<div class="line">fprintf(stderr, <span class="stringliteral">"Written keyboard input is : '%s' and was %s\n"</span>,</div>
<div class="line"> text.c_str(), bRet ? <span class="stringliteral">"OK"</span> : <span class="stringliteral">"Canceled"</span>);</div>
<div class="ttc" id="agroup__cpp__kodi__gui__dialogs___keyboard_html_ga167eba07f115af03700df889fa08cc54"><div class="ttname"><a href="group__cpp__kodi__gui__dialogs___keyboard.html#ga167eba07f115af03700df889fa08cc54">kodi::gui::dialogs::Keyboard::ShowAndGetInput</a></div><div class="ttdeci">bool ATTRIBUTE_HIDDEN ShowAndGetInput(std::string &text, const std::string &heading, bool allowEmptyResult, bool hiddenInput=false, unsigned int autoCloseMs=0)</div><div class="ttdoc">Show keyboard with initial value text and replace with result string.</div><div class="ttdef"><b>Definition:</b> Keyboard.h:74</div></div>
</div><!-- fragment -->
</div>
</div>
<a id="gabe75ddf0e6654ceb744069b9f5dec5c6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gabe75ddf0e6654ceb744069b9f5dec5c6">◆ </a></span>ShowAndGetInput() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool ATTRIBUTE_HIDDEN kodi::gui::dialogs::Keyboard::ShowAndGetInput </td>
<td>(</td>
<td class="paramtype">std::string & </td>
<td class="paramname"><em>text</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>allowEmptyResult</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>autoCloseMs</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The example shows the display of keyboard call dialog at Kodi from the add-on. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">text</td><td>Overwritten with user input if return=true. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">allowEmptyResult</td><td>If set to true keyboard can also exited without entered text. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">autoCloseMs</td><td>[opt] To close the dialog after a specified time, in milliseconds, default is 0 which keeps the dialog open indefinitely. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if successful display and user input. false if unsuccessful display, no user input, or canceled editing. </dd></dl>
</div>
</div>
<a id="gaf5b6268d08f41fb744dbefe28cd2f3d2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf5b6268d08f41fb744dbefe28cd2f3d2">◆ </a></span>ShowAndGetNewPassword() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool ATTRIBUTE_HIDDEN kodi::gui::dialogs::Keyboard::ShowAndGetNewPassword </td>
<td>(</td>
<td class="paramtype">std::string & </td>
<td class="paramname"><em>newPassword</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>heading</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>allowEmptyResult</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>autoCloseMs</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Shows keyboard and prompts for a password. Differs from <code><a class="el" href="group__cpp__kodi__gui__dialogs___keyboard.html#gaa2c7b74f5c3ff72f063dd1cf1d5c5f95" title="Show keyboard twice to get and confirm a user-entered password string.">ShowAndVerifyNewPassword()</a></code> in that no second verification. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in,out]</td><td class="paramname">newPassword</td><td>Overwritten with user input if return=true. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">heading</td><td>String shown on dialog title. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">allowEmptyResult</td><td>Whether a blank password is valid or not. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">autoCloseMs</td><td>[opt] To close the dialog after a specified time, in milliseconds, default is 0 which keeps the dialog open indefinitely. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if successful display and user input. false if unsuccessful display, no user input, or canceled editing. </dd></dl>
</div>
</div>
<a id="ga4ca5caade19eb3744f3a4bc599a6678b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4ca5caade19eb3744f3a4bc599a6678b">◆ </a></span>ShowAndGetNewPassword() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool ATTRIBUTE_HIDDEN kodi::gui::dialogs::Keyboard::ShowAndGetNewPassword </td>
<td>(</td>
<td class="paramtype">std::string & </td>
<td class="paramname"><em>newPassword</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>autoCloseMs</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Shows keyboard and prompts for a password. Differs from <code><a class="el" href="group__cpp__kodi__gui__dialogs___keyboard.html#gaa2c7b74f5c3ff72f063dd1cf1d5c5f95" title="Show keyboard twice to get and confirm a user-entered password string.">ShowAndVerifyNewPassword()</a></code> in that no second verification. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in,out]</td><td class="paramname">newPassword</td><td>Overwritten with user input if return=true. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">autoCloseMs</td><td>[opt] To close the dialog after a specified time, in milliseconds, default is 0 which keeps the dialog open indefinitely. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if successful display and user input. false if unsuccessful display, no user input, or canceled editing. </dd></dl>
</div>
</div>
<a id="ga0fad6063f7f930b464c81335800fbe76"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0fad6063f7f930b464c81335800fbe76">◆ </a></span>ShowAndVerifyNewPassword() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool ATTRIBUTE_HIDDEN kodi::gui::dialogs::Keyboard::ShowAndVerifyNewPassword </td>
<td>(</td>
<td class="paramtype">std::string & </td>
<td class="paramname"><em>newPassword</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>heading</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>allowEmptyResult</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>autoCloseMs</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Show keyboard twice to get and confirm a user-entered password string. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">newPassword</td><td>Overwritten with user input if return=true. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">heading</td><td>String shown on dialog title. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">allowEmptyResult</td><td></td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">autoCloseMs</td><td>[opt] To close the dialog after a specified time, in milliseconds, default is 0 which keeps the dialog open indefinitely. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if successful display and user input. false if unsuccessful display, no user input, or canceled editing.</dd></dl>
<hr />
<p><b>Example:</b> </p><div class="fragment"><div class="line"><span class="preprocessor">#include <kodi/General.h></span></div>
<div class="line"><span class="preprocessor">#include <kodi/gui/dialogs/Keyboard.h></span></div>
<div class="line"> </div>
<div class="line"><span class="comment">// The example below shows the complete use of keyboard dialog for password</span></div>
<div class="line"><span class="comment">// check. If only one check from add-on needed can be function with retries</span></div>
<div class="line"><span class="comment">// set to '0' called alone.</span></div>
<div class="line"><span class="comment">//</span></div>
<div class="line"><span class="comment">// The use of MD5 translated password is always required for the check on Kodi!</span></div>
<div class="line"> </div>
<div class="line"><span class="keywordtype">int</span> maxretries = 3;</div>
<div class="line"><span class="comment">// Password names need to be send as md5 sum to kodi.</span></div>
<div class="line">std::string password;</div>
<div class="line"><a class="code" href="group__cpp__kodi.html#ga26de39eee45315a3cda7aceb601a8bad">kodi::GetMD5</a>(<span class="stringliteral">"kodi"</span>, password);</div>
<div class="line"> </div>
<div class="line"><span class="comment">// To the loop about password checks.</span></div>
<div class="line"><span class="keywordtype">int</span> ret;</div>
<div class="line"><span class="keywordflow">for</span> (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i = 0; i < maxretries; i++)</div>
<div class="line">{</div>
<div class="line"> <span class="comment">// Ask the user about the password.</span></div>
<div class="line"> ret = <a class="code" href="group__cpp__kodi__gui__dialogs___keyboard.html#gab0a3eeadeb872871bf3618939b1328f7">::kodi::gui::dialogs::Keyboard::ShowAndVerifyPassword</a>(password, <span class="stringliteral">"Demo password call for PW 'kodi'"</span>, i, 0);</div>
<div class="line"> <span class="keywordflow">if</span> (ret == 0)</div>
<div class="line"> {</div>
<div class="line"> fprintf(stderr, <span class="stringliteral">"Password successfull confirmed after '%i' tries\n"</span>, i+1);</div>
<div class="line"> <span class="keywordflow">break</span>;</div>
<div class="line"> }</div>
<div class="line"> <span class="keywordflow">else</span> <span class="keywordflow">if</span> (ret < 0)</div>
<div class="line"> {</div>
<div class="line"> fprintf(stderr, <span class="stringliteral">"Canceled editing on try '%i'\n"</span>, i+1);</div>
<div class="line"> <span class="keywordflow">break</span>;</div>
<div class="line"> }</div>
<div class="line"> <span class="keywordflow">else</span> <span class="comment">// if (ret > 0)</span></div>
<div class="line"> {</div>
<div class="line"> fprintf(stderr, <span class="stringliteral">"Wrong password entered on try '%i'\n"</span>, i+1);</div>
<div class="line"> }</div>
<div class="line">}</div>
<div class="ttc" id="agroup__cpp__kodi__gui__dialogs___keyboard_html_gab0a3eeadeb872871bf3618939b1328f7"><div class="ttname"><a href="group__cpp__kodi__gui__dialogs___keyboard.html#gab0a3eeadeb872871bf3618939b1328f7">kodi::gui::dialogs::Keyboard::ShowAndVerifyPassword</a></div><div class="ttdeci">int ATTRIBUTE_HIDDEN ShowAndVerifyPassword(std::string &password, const std::string &heading, int retries, unsigned int autoCloseMs=0)</div><div class="ttdoc">Show keyboard and verify user input against password.</div><div class="ttdef"><b>Definition:</b> Keyboard.h:314</div></div>
<div class="ttc" id="agroup__cpp__kodi_html_ga26de39eee45315a3cda7aceb601a8bad"><div class="ttname"><a href="group__cpp__kodi.html#ga26de39eee45315a3cda7aceb601a8bad">kodi::GetMD5</a></div><div class="ttdeci">std::string ATTRIBUTE_HIDDEN GetMD5(const std::string &text)</div><div class="ttdoc">Get the MD5 digest of the given text.</div><div class="ttdef"><b>Definition:</b> General.h:409</div></div>
</div><!-- fragment -->
</div>
</div>
<a id="gaa2c7b74f5c3ff72f063dd1cf1d5c5f95"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa2c7b74f5c3ff72f063dd1cf1d5c5f95">◆ </a></span>ShowAndVerifyNewPassword() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool ATTRIBUTE_HIDDEN kodi::gui::dialogs::Keyboard::ShowAndVerifyNewPassword </td>
<td>(</td>
<td class="paramtype">std::string & </td>
<td class="paramname"><em>newPassword</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>autoCloseMs</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Show keyboard twice to get and confirm a user-entered password string. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">newPassword</td><td>Overwritten with user input if return=true. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">autoCloseMs</td><td>[opt] To close the dialog after a specified time, in milliseconds, default is 0 which keeps the dialog open indefinitely. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if successful display and user input. false if unsuccessful display, no user input, or canceled editing. </dd></dl>
</div>
</div>
<a id="gab0a3eeadeb872871bf3618939b1328f7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab0a3eeadeb872871bf3618939b1328f7">◆ </a></span>ShowAndVerifyPassword()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int ATTRIBUTE_HIDDEN kodi::gui::dialogs::Keyboard::ShowAndVerifyPassword </td>
<td>(</td>
<td class="paramtype">std::string & </td>
<td class="paramname"><em>password</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>heading</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>retries</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>autoCloseMs</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Show keyboard and verify user input against <code>password</code>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in,out]</td><td class="paramname">password</td><td>Value to compare against user input. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">heading</td><td>String shown on dialog title. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">retries</td><td>If greater than 0, shows "Incorrect password, %d retries
left" on dialog line 2, else line 2 is blank. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">autoCloseMs</td><td>[opt] To close the dialog after a specified time, in milliseconds, default is 0 which keeps the dialog open indefinitely. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if successful display and user input. 1 if unsuccessful input. -1 if no user input or canceled editing. </dd></dl>
</div>
</div>
<a id="gab65198bb34e253b8ab62858cd47f5aa1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab65198bb34e253b8ab62858cd47f5aa1">◆ </a></span>ShowAndGetFilter()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool ATTRIBUTE_HIDDEN kodi::gui::dialogs::Keyboard::ShowAndGetFilter </td>
<td>(</td>
<td class="paramtype">std::string & </td>
<td class="paramname"><em>text</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>searching</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>autoCloseMs</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Shows a filter related keyboard. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in,out]</td><td class="paramname">text</td><td>Overwritten with user input if return=true. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">searching</td><td>Use dialog for search and send our search message in safe way (only the active window needs it)<ul>
<li>header name if true is "Enter search string"</li>
<li>header name if false is "Enter value" </li>
</ul>
</td></tr>
<tr><td class="paramdir"></td><td class="paramname">autoCloseMs</td><td>[opt] To close the dialog after a specified time, in milliseconds, default is 0 which keeps the dialog open indefinitely. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if successful display and user input. false if unsuccessful display, no user input, or canceled editing. </dd></dl>
</div>
</div>
<a id="ga615a2290e7aa2a70dd6d21c5912a1386"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga615a2290e7aa2a70dd6d21c5912a1386">◆ </a></span>SendTextToActiveKeyboard()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool ATTRIBUTE_HIDDEN kodi::gui::dialogs::Keyboard::SendTextToActiveKeyboard </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>text</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>closeKeyboard</em> = <code>false</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Send a text to a visible keyboard. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">text</td><td>Overwritten with user input if return=true. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">closeKeyboard</td><td>[opt] The open dialog is if also closed on 'true'. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if successful done, false if unsuccessful or keyboard not present. </dd></dl>
</div>
</div>
<a id="gaa9861f7e42ef731a0a474aa50c95b233"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa9861f7e42ef731a0a474aa50c95b233">◆ </a></span>IsKeyboardActivated()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool ATTRIBUTE_HIDDEN kodi::gui::dialogs::Keyboard::IsKeyboardActivated </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Check for visible keyboard on GUI. </p>
<dl class="section return"><dt>Returns</dt><dd>true if keyboard present, false if not present </dd></dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">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.1 </li>
</ul>
</div>
</body>
</html>