-
Notifications
You must be signed in to change notification settings - Fork 5
/
Dialog.h
990 lines (944 loc) · 36.8 KB
/
Dialog.h
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
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
/*
* Copyright (C) 2005-2018 Team Kodi
* This file is part of Kodi - https://kodi.tv
*
* SPDX-License-Identifier: GPL-2.0-or-later
* See LICENSES/README.md for more information.
*/
#pragma once
#include "AddonClass.h"
#include "AddonString.h"
#include "Alternative.h"
#include "ListItem.h"
#include "dialogs/GUIDialogExtendedProgressBar.h"
#include "dialogs/GUIDialogProgress.h"
#include <string>
#include <vector>
namespace XBMCAddon
{
namespace xbmcgui
{
constexpr int INPUT_ALPHANUM{0};
constexpr int INPUT_NUMERIC{1};
constexpr int INPUT_DATE{2};
constexpr int INPUT_TIME{3};
constexpr int INPUT_IPADDRESS{4};
constexpr int INPUT_PASSWORD{5};
constexpr int PASSWORD_VERIFY{1};
constexpr int ALPHANUM_HIDE_INPUT{2};
///
/// \defgroup python_Dialog Dialog
/// \ingroup python_xbmcgui
/// @{
/// @brief **Kodi's dialog class**
///
/// The graphical control element dialog box (also called dialogue box or
/// just dialog) is a small window that communicates information to the user
/// and prompts them for a response.
///
class Dialog : public AddonClass
{
public:
inline Dialog() = default;
~Dialog() override;
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_Dialog
/// \python_func{ xbmcgui.Dialog().yesno(heading, line1[, line2, line3, nolabel, yeslabel, autoclose]) }
///------------------------------------------------------------------------
///
/// **Yes / no dialog**
///
/// The Yes / No dialog can be used to inform the user about questions and
/// get the answer.
///
/// @param heading string or unicode - dialog heading.
/// @param line1 string or unicode - line #1 multi-line text.
/// @param line2 [opt] string or unicode - line #2 text.
/// @param line3 [opt] string or unicode - line #3 text.
/// @param nolabel [opt] label to put on the no button.
/// @param yeslabel [opt] label to put on the yes button.
/// @param autoclose [opt] integer - milliseconds to autoclose dialog. (default=do not autoclose)
/// @return Returns True if 'Yes' was pressed, else False.
///
/// @note It is preferred to only use line1 as it is actually a multi-line text. In this case line2 and line3 must be omitted.
///
///
///------------------------------------------------------------------------
/// @python_v13 Added new option **autoclose**.
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ..
/// dialog = xbmcgui.Dialog()
/// ret = dialog.yesno('Kodi', 'Do you want to exit this script?')
/// ..
/// ~~~~~~~~~~~~~
///
yesno(...);
#else
bool yesno(const String& heading, const String& line1,
const String& line2 = emptyString,
const String& line3 = emptyString,
const String& nolabel = emptyString,
const String& yeslabel = emptyString,
int autoclose = 0);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_Dialog
/// \python_func{ xbmcgui.Dialog().info(listitem) }
///------------------------------------------------------------------------
///
/// **Info dialog**
///
/// Show the corresponding info dialog for a given listitem
///
/// @param listitem xbmcgui.ListItem - ListItem to show info for.
/// @return Returns whether the dialog opened successfully.
///
///
///------------------------------------------------------------------------
/// @python_v17 New function added.
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ..
/// dialog = xbmcgui.Dialog()
/// ret = dialog.info(listitem)
/// ..
/// ~~~~~~~~~~~~~
///
info(...);
#else
bool info(const ListItem* item);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_Dialog
/// \python_func{ xbmcgui.Dialog().select(heading, list[, autoclose, preselect, useDetails]) }
///------------------------------------------------------------------------
///
/// **Select dialog**
///
/// Show of a dialog to select of an entry as a key
///
/// @param heading string or unicode - dialog heading.
/// @param list list of strings / xbmcgui.ListItems - list of items shown in dialog.
/// @param autoclose [opt] integer - milliseconds to autoclose dialog. (default=do not autoclose)
/// @param preselect [opt] integer - index of preselected item. (default=no preselected item)
/// @param useDetails [opt] bool - use detailed list instead of a compact list. (default=false)
/// @return Returns the position of the highlighted item as an integer.
///
///
///------------------------------------------------------------------------
/// @python_v17 **preselect** option added.
/// @python_v17 Added new option **useDetails**.
/// @python_v17 Allow listitems for parameter **list**
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ..
/// dialog = xbmcgui.Dialog()
/// ret = dialog.select('Choose a playlist', ['Playlist #1', 'Playlist #2, 'Playlist #3'])
/// ..
/// ~~~~~~~~~~~~~
///
select(...);
#else
int select(const String& heading, const std::vector<Alternative<String, const ListItem* > > & list, int autoclose=0, int preselect=-1, bool useDetails=false);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_Dialog
/// \python_func{ xbmcgui.Dialog().contextmenu(list) }
///------------------------------------------------------------------------
///
/// Show a context menu.
///
/// @param list string list - list of items.
/// @return the position of the highlighted item as an integer
/// (-1 if cancelled).
///
///
///--------------------------------------------------------------------------
/// @python_v17 New function added
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ..
/// dialog = xbmcgui.Dialog()
/// ret = dialog.contextmenu(['Option #1', 'Option #2', 'Option #3'])
/// ..
/// ~~~~~~~~~~~~~
///
contextmenu(...);
#else
int contextmenu(const std::vector<String>& list);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_Dialog
/// \python_func{ xbmcgui.Dialog().multiselect(heading, options[, autoclose, preselect, useDetails]) }
///------------------------------------------------------------------------
///
/// Show a multi-select dialog.
///
/// @param heading string or unicode - dialog heading.
/// @param options list of strings / xbmcgui.ListItems - options to choose from.
/// @param autoclose [opt] integer - milliseconds to autoclose dialog.
/// (default=do not autoclose)
/// @param preselect [opt] list of int - indexes of items to preselect
/// in list (default: do not preselect any item)
/// @param useDetails [opt] bool - use detailed list instead of a compact list. (default=false)
/// @return Returns the selected items as a list of indices,
/// or None if cancelled.
///
///
///------------------------------------------------------------------------
/// @python_v16 New function added.
/// @python_v17 Added new option **preselect**.
/// @python_v17 Added new option **useDetails**.
/// @python_v17 Allow listitems for parameter **options**
///
/// **Example:**
/// @code{.py}
/// ..
/// dialog = xbmcgui.Dialog()
/// ret = dialog.multiselect("Choose something", ["Foo", "Bar", "Baz"], preselect=[1,2])
/// ..
/// @endcode
///
multiselect(...);
#else
std::unique_ptr<std::vector<int> > multiselect(const String& heading, const std::vector<Alternative<String, const ListItem* > > & options, int autoclose=0, const std::vector<int>& preselect = std::vector<int>(), bool useDetails=false);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_Dialog
/// \python_func{ xbmcgui.Dialog().ok(heading, line1[, line2, line3]) }
///------------------------------------------------------------------------
///
/// **OK dialog**
///
/// The functions permit the call of a dialog of information, a
/// confirmation of the user by press from OK required.
///
/// @param heading string or unicode - dialog heading.
/// @param line1 string or unicode - line #1 multi-line text.
/// @param line2 [opt] string or unicode - line #2 text.
/// @param line3 [opt] string or unicode - line #3 text.
/// @return Returns True if 'Ok' was pressed, else False.
///
/// @note It is preferred to only use line1 as it is actually a multi-line text. In this case line2 and line3 must be omitted.
///
///
///------------------------------------------------------------------------
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ..
/// dialog = xbmcgui.Dialog()
/// ok = dialog.ok('Kodi', 'There was an error.')
/// ..
/// ~~~~~~~~~~~~~
///
ok(...);
#else
bool ok(const String& heading, const String& line1,
const String& line2 = emptyString,
const String& line3 = emptyString);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_Dialog
/// \python_func{ xbmcgui.Dialog().textviewer(heading, text, usemono) }
///------------------------------------------------------------------------
///
/// **TextViewer dialog**
///
/// The text viewer dialog can be used to display descriptions, help texts
/// or other larger texts.
///
/// @param heading string or unicode - dialog heading.
/// @param text string or unicode - text.
/// @param usemono [opt] bool - use monospace font
///
///
///------------------------------------------------------------------------
/// @python_v16 New function added.
/// @python_v18 New optional param added **usemono**.
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ..
/// dialog = xbmcgui.Dialog()
/// dialog.textviewer('Plot', 'Some movie plot.')
/// ..
/// ~~~~~~~~~~~~~
///
textviewer(...);
#else
void textviewer(const String& heading, const String& text, bool usemono = false);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_Dialog
/// \python_func{ xbmcgui.Dialog().browse(type, heading, shares[, mask, useThumbs, treatAsFolder, defaultt, enableMultiple]) }
///------------------------------------------------------------------------
///
/// **Browser dialog**
///
/// The function offer the possibility to select a file by the user of
/// the add-on.
///
/// It allows all the options that are possible in Kodi itself and offers
/// all support file types.
///
/// @param type integer - the type of browse dialog.
/// | Param | Name |
/// |:-----:|:--------------------------------|
/// | 0 | ShowAndGetDirectory |
/// | 1 | ShowAndGetFile |
/// | 2 | ShowAndGetImage |
/// | 3 | ShowAndGetWriteableDirectory |
/// @param heading string or unicode - dialog heading.
/// @param shares string or unicode - from [sources.xml](http://kodi.wiki/view/Sources.xml)
/// | Param | Name |
/// |:--------------:|:---------------------------------------------|
/// | "programs" | list program addons
/// | "video" | list video sources
/// | "music" | list music sources
/// | "pictures" | list picture sources
/// | "files" | list file sources (added through filemanager)
/// | "games" | list game sources
/// | "local" | list local drives
/// | "" | list local drives and network shares
/// @param mask [opt] string or unicode - '|' separated file mask. (i.e. '.jpg|.png')
/// @param useThumbs [opt] boolean - if True autoswitch to Thumb view if files exist.
/// @param treatAsFolder [opt] boolean - if True playlists and archives act as folders.
/// @param defaultt [opt] string - default path or file.
/// @param enableMultiple [opt] boolean - if True multiple file selection is enabled.
///
/// @return If enableMultiple is False (default): returns filename and/or path as a string
/// to the location of the highlighted item, if user pressed 'Ok' or a masked item
/// was selected. Returns the default value if dialog was canceled.
/// If enableMultiple is True: returns tuple of marked filenames as a string
/// if user pressed 'Ok' or a masked item was selected. Returns empty tuple if dialog was canceled.\n\n
/// If type is 0 or 3 the enableMultiple parameter is ignore
///
///
///------------------------------------------------------------------------
/// @python_v18 New option added to browse network and/or local drives.
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ..
/// dialog = xbmcgui.Dialog()
/// fn = dialog.browse(3, 'Kodi', 'files', '', False, False, False, 'special://masterprofile/script_data/Kodi Lyrics')
/// ..
/// ~~~~~~~~~~~~~
///
browse(...);
#else
Alternative<String, std::vector<String> > browse(int type, const String& heading, const String& shares,
const String& mask = emptyString, bool useThumbs = false,
bool treatAsFolder = false, const String& defaultt = emptyString,
bool enableMultiple = false);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_Dialog
/// \python_func{ xbmcgui.Dialog().browseSingle(type, heading, shares[, mask, useThumbs, treatAsFolder, defaultt]) }
///------------------------------------------------------------------------
///
/// **Browse single dialog**
///
/// The function offer the possibility to select a file by the user of
/// the add-on.
///
/// It allows all the options that are possible in Kodi itself and offers
/// all support file types.
///
/// @param type integer - the type of browse dialog.
/// | Param | Name |
/// |:-----:|:--------------------------------|
/// | 0 | ShowAndGetDirectory
/// | 1 | ShowAndGetFile
/// | 2 | ShowAndGetImage
/// | 3 | ShowAndGetWriteableDirectory
/// @param heading string or unicode - dialog heading.
/// @param shares string or unicode - from [sources.xml](http://kodi.wiki/view/Sources.xml)
/// | Param | Name |
/// |:--------------:|:---------------------------------------------|
/// | "programs" | list program addons
/// | "video" | list video sources
/// | "music" | list music sources
/// | "pictures" | list picture sources
/// | "files" | list file sources (added through filemanager)
/// | "games" | list game sources
/// | "local" | list local drives
/// | "" | list local drives and network shares
/// @param mask [opt] string or unicode - '|' separated file mask. (i.e. '.jpg|.png')
/// @param useThumbs [opt] boolean - if True autoswitch to Thumb view if files exist (default=false).
/// @param treatAsFolder [opt] boolean - if True playlists and archives act as folders (default=false).
/// @param defaultt [opt] string - default path or file.
///
/// @return Returns filename and/or path as a string to the location of the highlighted item,
/// if user pressed 'Ok' or a masked item was selected.
/// Returns the default value if dialog was canceled.
///
///
///------------------------------------------------------------------------
/// @python_v18 New option added to browse network and/or local drives.
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ..
/// dialog = xbmcgui.Dialog()
/// fn = dialog.browseSingle(3, 'Kodi', 'files', '', False, False, 'special://masterprofile/script_data/Kodi Lyrics')
/// ..
/// ~~~~~~~~~~~~~
///
browseSingle(...);
#else
String browseSingle(int type, const String& heading, const String& shares,
const String& mask = emptyString, bool useThumbs = false,
bool treatAsFolder = false,
const String& defaultt = emptyString );
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_Dialog
/// \python_func{ xbmcgui.Dialog().browseMultiple(type, heading, shares[, mask, useThumbs, treatAsFolder, defaultt]) }
///------------------------------------------------------------------------
///
/// **Browser dialog**
///
/// The function offer the possibility to select multiple files by the
/// user of the add-on.
///
/// It allows all the options that are possible in Kodi itself and offers
/// all support file types.
///
/// @param type integer - the type of browse dialog.
/// | Param | Name |
/// |:-----:|:--------------------------------|
/// | 1 | ShowAndGetFile
/// | 2 | ShowAndGetImage
/// @param heading string or unicode - dialog heading.
/// @param shares string or unicode - from [sources.xml](http://kodi.wiki/view/Sources.xml)
/// | Param | Name |
/// |:--------------:|:---------------------------------------------|
/// | "programs" | list program addons
/// | "video" | list video sources
/// | "music" | list music sources
/// | "pictures" | list picture sources
/// | "files" | list file sources (added through filemanager)
/// | "games" | list game sources
/// | "local" | list local drives
/// | "" | list local drives and network shares
/// @param mask [opt] string or unicode - '|' separated file mask. (i.e. '.jpg|.png')
/// @param useThumbs [opt] boolean - if True autoswitch to Thumb view if files exist (default=false).
/// @param treatAsFolder [opt] boolean - if True playlists and archives act as folders (default=false).
/// @param defaultt [opt] string - default path or file.
/// @return Returns tuple of marked filenames as a string,"
/// if user pressed 'Ok' or a masked item was selected. Returns empty tuple if dialog was canceled.
///
///
///------------------------------------------------------------------------
/// @python_v18 New option added to browse network and/or local drives.
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ..
/// dialog = xbmcgui.Dialog()
/// fn = dialog.browseMultiple(2, 'Kodi', 'files', '', False, False, 'special://masterprofile/script_data/Kodi Lyrics')
/// ..
/// ~~~~~~~~~~~~~
///
browseMultiple(...);
#else
std::vector<String> browseMultiple(int type, const String& heading, const String& shares,
const String& mask = emptyString, bool useThumbs = false,
bool treatAsFolder = false,
const String& defaultt = emptyString );
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_Dialog
/// \python_func{ xbmcgui.Dialog().numeric(type, heading[, defaultt, bHiddenInput]) }
///------------------------------------------------------------------------
///
/// **Numeric dialog**
///
/// The function have to be permitted by the user for the representation
/// of a numeric keyboard around an input.
///
/// @param type integer - the type of numeric dialog.
/// | Param | Name | Format |
/// |:-----:|:-------------------------|:-----------------------------|
/// | 0 | ShowAndGetNumber | (default format: #)
/// | 1 | ShowAndGetDate | (default format: DD/MM/YYYY)
/// | 2 | ShowAndGetTime | (default format: HH:MM)
/// | 3 | ShowAndGetIPAddress | (default format: #.#.#.#)
/// | 4 | ShowAndVerifyNewPassword | (default format: *)
/// @param heading string or unicode - dialog heading (will be ignored for type 4).
/// @param defaultt [opt] string - default value.
/// @param bHiddenInput [opt] bool - mask input (available for type 0).
/// @return Returns the entered data as a string.
/// Returns the default value if dialog was canceled.
///
///
///------------------------------------------------------------------------
/// @python_v19 New option added ShowAndVerifyNewPassword.
/// @python_v19 Added new option **bHiddenInput**.
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ..
/// dialog = xbmcgui.Dialog()
/// d = dialog.numeric(1, 'Enter date of birth')
/// ..
/// ~~~~~~~~~~~~~
///
numeric(...);
#else
String numeric(int type, const String& heading, const String& defaultt = emptyString, bool bHiddenInput = false);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_Dialog
/// \python_func{ xbmcgui.Dialog().notification(heading, message[, icon, time, sound]) }
///------------------------------------------------------------------------
///
/// Show a Notification alert.
///
/// @param heading string - dialog heading.
/// @param message string - dialog message.
/// @param icon [opt] string - icon to use. (default xbmcgui.NOTIFICATION_INFO)
/// @param time [opt] integer - time in milliseconds (default 5000)
/// @param sound [opt] bool - play notification sound (default True)
///
/// Builtin Icons:
/// - xbmcgui.NOTIFICATION_INFO
/// - xbmcgui.NOTIFICATION_WARNING
/// - xbmcgui.NOTIFICATION_ERROR
///
///
///------------------------------------------------------------------------
/// @python_v13 New function added.
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ..
/// dialog = xbmcgui.Dialog()
/// dialog.notification('Movie Trailers', 'Finding Nemo download finished.', xbmcgui.NOTIFICATION_INFO, 5000)
/// ..
/// ~~~~~~~~~~~~~
///
notification(...);
#else
void notification(const String& heading, const String& message, const String& icon = emptyString, int time = 0, bool sound = true);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_Dialog
/// \python_func{ xbmcgui.Dialog().input(heading[, defaultt, type, option, autoclose]) }
///------------------------------------------------------------------------
///
/// Show an Input dialog.
///
/// @param heading string - dialog heading.
/// @param defaultt [opt] string - default value. (default=empty string)
/// @param type [opt] integer - the type of keyboard dialog. (default=xbmcgui.INPUT_ALPHANUM)
/// | Parameter | Format |
/// |---------------------------------:|:--------------------------------|
/// | <tt>xbmcgui.INPUT_ALPHANUM</tt> | (standard keyboard)
/// | <tt>xbmcgui.INPUT_NUMERIC</tt> | (format: #)
/// | <tt>xbmcgui.INPUT_DATE</tt> | (format: DD/MM/YYYY)
/// | <tt>xbmcgui.INPUT_TIME</tt> | (format: HH:MM)
/// | <tt>xbmcgui.INPUT_IPADDRESS</tt> | (format: #.#.#.#)
/// | <tt>xbmcgui.INPUT_PASSWORD</tt> | (return md5 hash of input, input is masked)
/// @param option [opt] integer - option for the dialog. (see Options below)
/// - Password dialog:
/// - <tt>xbmcgui.PASSWORD_VERIFY</tt> (verifies an existing (default) md5 hashed password)
/// - Alphanum dialog:
/// - <tt>xbmcgui.ALPHANUM_HIDE_INPUT</tt> (masks input)
/// @param autoclose [opt] integer - milliseconds to autoclose dialog. (default=do not autoclose)
///
/// @return Returns the entered data as a string.
/// Returns an empty string if dialog was canceled.
///
///
///------------------------------------------------------------------------
/// @python_v13 New function added.
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ..
/// dialog = xbmcgui.Dialog()
/// d = dialog.input('Enter secret code', type=xbmcgui.INPUT_ALPHANUM, option=xbmcgui.ALPHANUM_HIDE_INPUT)
/// ..
/// ~~~~~~~~~~~~~
///
input(...);
#else
String input(const String& heading,
const String& defaultt = emptyString,
int type = INPUT_ALPHANUM,
int option = 0,
int autoclose = 0);
#endif
};
//@}
///
/// \defgroup python_DialogProgress DialogProgress
/// \ingroup python_xbmcgui
/// @{
/// @brief <b>Kodi's progress dialog class (Duh!)</b>
///
///
class DialogProgress : public AddonClass
{
CGUIDialogProgress* dlg = nullptr;
bool open = false;
protected:
void deallocating() override;
public:
DialogProgress() = default;
~DialogProgress() override;
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_DialogProgress
/// \python_func{ xbmcgui.DialogProgress().create(heading[, line1, line2, line3]) }
///------------------------------------------------------------------------
///
/// Create and show a progress dialog.
///
/// @param heading string or unicode - dialog heading.
/// @param line1 [opt] string or unicode - line #1 multi-line text.
/// @param line2 [opt] string or unicode - line #2 text.
/// @param line3 [opt] string or unicode - line #3 text.
///
/// @note It is preferred to only use line1 as it is actually a multi-line text. In this case line2 and line3 must be omitted.
/// @note Use update() to update lines and progressbar.
///
///
///------------------------------------------------------------------------
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ..
/// pDialog = xbmcgui.DialogProgress()
/// pDialog.create('Kodi', 'Initializing script...')
/// ..
/// ~~~~~~~~~~~~~
///
create(...);
#else
void create(const String& heading, const String& line1 = emptyString,
const String& line2 = emptyString,
const String& line3 = emptyString);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_DialogProgress
/// \python_func{ xbmcgui.DialogProgress().update(percent[, line1, line2, line3]) }
///------------------------------------------------------------------------
///
/// Updates the progress dialog.
///
/// @param percent integer - percent complete. (0:100)
/// @param line1 [opt] string or unicode - line #1 multi-line text.
/// @param line2 [opt] string or unicode - line #2 text.
/// @param line3 [opt] string or unicode - line #3 text.
///
/// @note It is preferred to only use line1 as it is actually a multi-line text. In this case line2 and line3 must be omitted.
///
///
///------------------------------------------------------------------------
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ..
/// pDialog.update(25, 'Importing modules...')
/// ..
/// ~~~~~~~~~~~~~
///
update(...);
#else
void update(int percent, const String& line1 = emptyString,
const String& line2 = emptyString,
const String& line3 = emptyString);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_DialogProgress
/// \python_func{ xbmcgui.DialogProgress().close() }
///------------------------------------------------------------------------
///
/// Close the progress dialog.
///
///
///------------------------------------------------------------------------
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ..
/// pDialog.close()
/// ..
/// ~~~~~~~~~~~~~
///
close(...);
#else
void close();
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_DialogProgress
/// \python_func{ xbmcgui.DialogProgress().iscanceled() }
///------------------------------------------------------------------------
///
/// Checks progress is canceled.
///
/// @return True if the user pressed cancel.
///
///
///------------------------------------------------------------------------
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ..
/// if (pDialog.iscanceled()): return
/// ..
/// ~~~~~~~~~~~~~
///
iscanceled(...);
#else
bool iscanceled();
#endif
};
//@}
///
/// \defgroup python_DialogBusy DialogBusy
/// \ingroup python_xbmcgui
/// @{
/// @brief <b>Kodi's busy dialog class</b>
///
///-----------------------------------------------------------------------
/// @python_v18 removed, usage results in nop!
///
class DialogBusy : public AddonClass
{
protected:
void deallocating() override;
public:
DialogBusy() = default;
~DialogBusy() override;
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_DialogBusy
/// \python_func{ xbmcgui.DialogBusy().create() }
///------------------------------------------------------------------------
///
/// Create and show a busy dialog.
///
/// @note Use update() to update the progressbar.
///
///
///------------------------------------------------------------------------
/// @python_v18 removed, usage results in nop!
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ..
/// dialog = xbmcgui.DialogBusy()
/// dialog.create()
/// ..
/// ~~~~~~~~~~~~~
///
create(...);
#else
void create();
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_DialogBusy
/// \python_func{ xbmcgui.DialogBusy().update(percent) }
///------------------------------------------------------------------------
///
/// Updates the busy dialog.
///
/// @param percent integer - percent complete. (-1:100)
///
/// @note If percent == -1 (default), the progressbar will be hidden.
///
///
///------------------------------------------------------------------------
/// @python_v18 removed, usage results in nop!
///
update(...);
#else
void update(int percent) const;
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_DialogBusy
/// \python_func{ xbmcgui.DialogBusy().close() }
///------------------------------------------------------------------------
///
/// Close the progress dialog.
///
///
///------------------------------------------------------------------------
/// @python_v18 removed, usage results in nop!
///
close(...);
#else
void close();
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_DialogBusy
/// \python_func{ xbmcgui.DialogBusy().iscanceled() }
///------------------------------------------------------------------------
///
/// Checks if busy dialog is canceled.
///
/// @return True if the user pressed cancel.
///
///
///------------------------------------------------------------------------
/// @python_v18 removed, usage results in nop!
///
iscanceled(...);
#else
bool iscanceled() const;
#endif
};
//@}
///
/// \defgroup python_DialogProgressBG DialogProgressBG
/// \ingroup python_xbmcgui
/// @{
/// @brief <b>Kodi's background progress dialog class</b>
///
///
class DialogProgressBG : public AddonClass
{
CGUIDialogExtendedProgressBar* dlg = nullptr;
CGUIDialogProgressBarHandle* handle = nullptr;
bool open = false;
protected:
void deallocating() override;
public:
DialogProgressBG() = default;
~DialogProgressBG() override;
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_DialogProgressBG
/// \python_func{ xbmcgui.DialogProgressBG().create(heading[, message]) }
///------------------------------------------------------------------------
///
/// Create and show a background progress dialog.
///
/// @param heading string or unicode - dialog heading.
/// @param message [opt] string or unicode - message text.
///
/// @note 'heading' is used for the dialog's id. Use a unique heading.
/// Use update() to update heading, message and progressbar.
///
///
///------------------------------------------------------------------------
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ..
/// pDialog = xbmcgui.DialogProgressBG()
/// pDialog.create('Movie Trailers', 'Downloading Monsters Inc... .')
/// ..
/// ~~~~~~~~~~~~~
///
create(...);
#else
void create(const String& heading, const String& message = emptyString);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_DialogProgressBG
/// \python_func{ xbmcgui.DialogProgressBG().update([percent, heading, message]) }
///------------------------------------------------------------------------
///
/// Updates the background progress dialog.
///
/// @param percent [opt] integer - percent complete. (0:100)
/// @param heading [opt] string or unicode - dialog heading.
/// @param message [opt] string or unicode - message text.
///
/// @note To clear heading or message, you must pass a blank character.
///
///
///------------------------------------------------------------------------
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ..
/// pDialog.update(25, message='Downloading Finding Nemo ...')
/// ..
/// ~~~~~~~~~~~~~
///
update(...);
#else
void update(int percent = 0, const String& heading = emptyString, const String& message = emptyString);
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_DialogProgressBG
/// \python_func{ xbmcgui.DialogProgressBG().close() }
///------------------------------------------------------------------------
///
/// Close the background progress dialog
///
///
///------------------------------------------------------------------------
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ..
/// pDialog.close()
/// ..
/// ~~~~~~~~~~~~~
///
close(...);
#else
void close();
#endif
#ifdef DOXYGEN_SHOULD_USE_THIS
///
/// \ingroup python_DialogProgressBG
/// \python_func{ xbmcgui.DialogProgressBG().isFinished() }
///------------------------------------------------------------------------
///
/// Checks progress is finished
///
/// @return True if the background dialog is active.
///
///
///------------------------------------------------------------------------
///
/// **Example:**
/// ~~~~~~~~~~~~~{.py}
/// ..
/// if (pDialog.isFinished()): return
/// ..
/// ~~~~~~~~~~~~~
///
isFinished(...);
#else
bool isFinished();
#endif
};
//@}
} // namespace xbmcgui
} // namespace XBMCAddon