File: lcltaskdialog.xml

package info (click to toggle)
lazarus 2.2.6%2Bdfsg2-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 219,980 kB
  • sloc: pascal: 1,944,919; xml: 357,634; makefile: 270,608; cpp: 57,115; sh: 3,249; java: 609; perl: 297; sql: 222; ansic: 137
file content (1101 lines) | stat: -rw-r--r-- 33,636 bytes parent folder | download
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
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
<?xml version="1.0" encoding="UTF-8"?>
<fpdoc-descriptions>
  <package name="lcl">
    <!--
      ====================================================================
        LCLTaskDialog
      ====================================================================
    -->
    <module name="LCLTaskDialog">
      <short>Implement a TaskDialog window for LCL.</short>
      <descr>
        <p>
          <file>lcltaskdialog.pas</file> implements a task dialog . It is implemented natively on Windows Vista and Windows 7 (or later). On Windows XP, it is emulated.
        </p>
        <p>
          This unit was originally a part of the freeware Synopse mORMot framework, licensed under a MPL/GPL/LGPL tri-license; version 1.19. It has been relicensed with permission from Arnaud Bouchez, the original author, and all contributors.
        </p>
        <p>
          The original file name is SynTaskDialog.pas.
        </p>
      </descr>

      <!-- unresolved external references -->
      <element name="Windows"/>
      <element name="Classes"/>
      <element name="SysUtils"/>
      <element name="LazUTF8"/>
      <element name="LCLType"/>
      <element name="LCLStrConsts"/>
      <element name="LCLIntf"/>
      <element name="InterfaceBase"/>
      <element name="LResources"/>
      <element name="Menus"/>
      <element name="Graphics"/>
      <element name="Forms"/>
      <element name="Controls"/>
      <element name="StdCtrls"/>
      <element name="ExtCtrls"/>
      <element name="Buttons"/>

      <element name="TaskDialogIndirect">
        <short/>
        <descr>
          <p>
            Filled once in the initialization block. You can set this reference to Nil to force Delphi dialogs even on Windows Vista/Seven (e.g. make sense if TaskDialogBiggerButtons=true).
          </p>
        </descr>
        <seealso/>
      </element>
      <element name="TaskDialogIndirect.Result">
        <short/>
      </element>
      <element name="TaskDialogIndirect.AConfig">
        <short/>
      </element>
      <element name="TaskDialogIndirect.Res">
        <short/>
      </element>
      <element name="TaskDialogIndirect.ResRadio">
        <short/>
      </element>
      <element name="TaskDialogIndirect.VerifyFlag">
        <short/>
      </element>

      <!-- enumeration type Visibility: default -->
      <element name="TCommonButton">
        <short/>
        <descr>
          The standard common buttons handled by the Task Dialog.
        </descr>
        <seealso/>
      </element>

      <!-- enumeration value Visibility: default -->
      <element name="TCommonButton.cbOK">
        <short/>
      </element>

      <!-- enumeration value Visibility: default -->
      <element name="TCommonButton.cbYes">
        <short/>
      </element>

      <!-- enumeration value Visibility: default -->
      <element name="TCommonButton.cbNo">
        <short/>
      </element>

      <!-- enumeration value Visibility: default -->
      <element name="TCommonButton.cbCancel">
        <short/>
      </element>

      <!-- enumeration value Visibility: default -->
      <element name="TCommonButton.cbRetry">
        <short/>
      </element>

      <!-- enumeration value Visibility: default -->
      <element name="TCommonButton.cbClose">
        <short/>
      </element>

      <!-- set type Visibility: default -->
      <element name="TCommonButtons">
        <short/>
        <descr>
          Set of standard common buttons handled by the Task Dialog.
        </descr>
        <seealso/>
      </element>

      <!-- enumeration type Visibility: default -->
      <element name="TTaskDialogIcon">
        <short/>
        <descr>
          The available main icons for the Task Dialog.
        </descr>
        <seealso/>
      </element>

      <!-- enumeration value Visibility: default -->
      <element name="TTaskDialogIcon.tiBlank">
        <short/>
      </element>

      <!-- enumeration value Visibility: default -->
      <element name="TTaskDialogIcon.tiWarning">
        <short/>
      </element>

      <!-- enumeration value Visibility: default -->
      <element name="TTaskDialogIcon.tiQuestion">
        <short/>
      </element>

      <!-- enumeration value Visibility: default -->
      <element name="TTaskDialogIcon.tiError">
        <short/>
      </element>

      <!-- enumeration value Visibility: default -->
      <element name="TTaskDialogIcon.tiInformation">
        <short/>
      </element>

      <!-- enumeration value Visibility: default -->
      <element name="TTaskDialogIcon.tiNotUsed">
        <short/>
      </element>

      <!-- enumeration value Visibility: default -->
      <element name="TTaskDialogIcon.tiShield">
        <short/>
      </element>

      <!-- enumeration type Visibility: default -->
      <element name="TTaskDialogFooterIcon">
        <short/>
        <descr>
          The available footer icons for the Task Dialog.
        </descr>
        <seealso/>
      </element>

      <!-- enumeration value Visibility: default -->
      <element name="TTaskDialogFooterIcon.tfiBlank">
        <short/>
      </element>

      <!-- enumeration value Visibility: default -->
      <element name="TTaskDialogFooterIcon.tfiWarning">
        <short/>
      </element>

      <!-- enumeration value Visibility: default -->
      <element name="TTaskDialogFooterIcon.tfiQuestion">
        <short/>
      </element>

      <!-- enumeration value Visibility: default -->
      <element name="TTaskDialogFooterIcon.tfiError">
        <short/>
      </element>

      <!-- enumeration value Visibility: default -->
      <element name="TTaskDialogFooterIcon.tfiInformation">
        <short/>
      </element>

      <!-- enumeration value Visibility: default -->
      <element name="TTaskDialogFooterIcon.tfiShield">
        <short/>
      </element>

      <!-- enumeration type Visibility: default -->
      <element name="TTaskDialogFlag">
        <short/>
        <descr>
          <p>
            The available configuration flags for the Task Dialog. Most are standard TDF_* flags used for Vista/Seven native API (see http://msdn.microsoft.com/en-us/library/bb787473(v=vs.85).aspx for TASKDIALOG_FLAGS).
          </p>
          <p>
            tdfQuery and tdfQueryMasked are custom flags, implemented in pure Delphi code to handle input query.
          </p>
          <p>
            Our emulation code will handle only tdfUseCommandLinks, tdfUseCommandLinksNoIcon, and tdfQuery options.
          </p>
        </descr>
        <seealso/>
      </element>

      <!-- enumeration value Visibility: default -->
      <element name="TTaskDialogFlag.tdfEnableHyperLinks">
        <short/>
      </element>

      <!-- enumeration value Visibility: default -->
      <element name="TTaskDialogFlag.tdfUseHIconMain">
        <short/>
      </element>

      <!-- enumeration value Visibility: default -->
      <element name="TTaskDialogFlag.tdfUseHIconFooter">
        <short/>
      </element>

      <!-- enumeration value Visibility: default -->
      <element name="TTaskDialogFlag.tdfAllowDialogCancellation">
        <short/>
      </element>

      <!-- enumeration value Visibility: default -->
      <element name="TTaskDialogFlag.tdfUseCommandLinks">
        <short/>
      </element>

      <!-- enumeration value Visibility: default -->
      <element name="TTaskDialogFlag.tdfUseCommandLinksNoIcon">
        <short/>
      </element>

      <!-- enumeration value Visibility: default -->
      <element name="TTaskDialogFlag.tdfExpandFooterArea">
        <short/>
      </element>

      <!-- enumeration value Visibility: default -->
      <element name="TTaskDialogFlag.tdfExpandByDefault">
        <short/>
      </element>

      <!-- enumeration value Visibility: default -->
      <element name="TTaskDialogFlag.tdfVerificationFlagChecked">
        <short/>
      </element>

      <!-- enumeration value Visibility: default -->
      <element name="TTaskDialogFlag.tdfShowProgressBar">
        <short/>
      </element>

      <!-- enumeration value Visibility: default -->
      <element name="TTaskDialogFlag.tdfShowMarqueeProgressBar">
        <short/>
      </element>

      <!-- enumeration value Visibility: default -->
      <element name="TTaskDialogFlag.tdfCallbackTimer">
        <short/>
      </element>

      <!-- enumeration value Visibility: default -->
      <element name="TTaskDialogFlag.tdfPositionRelativeToWindow">
        <short/>
      </element>

      <!-- enumeration value Visibility: default -->
      <element name="TTaskDialogFlag.tdfRtlLayout">
        <short/>
      </element>

      <!-- enumeration value Visibility: default -->
      <element name="TTaskDialogFlag.tdfNoDefaultRadioButton">
        <short/>
      </element>

      <!-- enumeration value Visibility: default -->
      <element name="TTaskDialogFlag.tdfCanBeMinimized">
        <short/>
      </element>

      <!-- enumeration value Visibility: default -->
      <element name="TTaskDialogFlag.tdfQuery">
        <short/>
      </element>

      <!-- enumeration value Visibility: default -->
      <element name="TTaskDialogFlag.tdfQueryMasked">
        <short/>
      </element>

      <!-- enumeration value Visibility: default -->
      <element name="TTaskDialogFlag.tdfQueryFieldFocused">
        <short/>
      </element>

      <!-- set type Visibility: default -->
      <element name="TTaskDialogFlags">
        <short/>
        <descr>
          Set of available configuration flags for the Task Dialog.
        </descr>
        <seealso/>
      </element>

      <!-- pointer type Visibility: default -->
      <element name="PTaskDialog">
        <short/>
        <descr/>
        <seealso/>
      </element>

      <!-- procedure type Visibility: default -->
      <element name="TTaskDialogButtonClickedEvent">
        <short/>
        <descr>
          <p>
            This callback will be triggerred when a task dialog button is clicked. To prevent the task dialog from closing, the application must set ACanClose to FALSE. Otherwise, the task dialog is closed and the button ID is returned via the original TTaskDialog.Execute() result.
          </p>
        </descr>
        <seealso/>
      </element>

      <!-- argument Visibility: default -->
      <element name="TTaskDialogButtonClickedEvent.Sender">
        <short/>
      </element>

      <!-- argument Visibility: default -->
      <element name="TTaskDialogButtonClickedEvent.AButtonID">
        <short/>
      </element>

      <!-- argument Visibility: default -->
      <element name="TTaskDialogButtonClickedEvent.ACanClose">
        <short/>
      </element>

      <!-- enumeration type Visibility: default -->
      <element name="TTaskDialogElement">
        <short/>
        <descr>
          <p>
            The visual components of this Task Dialog. Maps low-level TDE_CONTENT...TDE_MAIN_INSTRUCTION constants, the query editor and checkbox. tdeEdit is for the query editor. tdeVerif is for the checkbox.
          </p>
        </descr>
        <seealso/>
      </element>

      <!-- enumeration value Visibility: default -->
      <element name="TTaskDialogElement.tdeContent">
        <short/>
      </element>

      <!-- enumeration value Visibility: default -->
      <element name="TTaskDialogElement.tdeExpandedInfo">
        <short/>
      </element>

      <!-- enumeration value Visibility: default -->
      <element name="TTaskDialogElement.tdeFooter">
        <short/>
      </element>

      <!-- enumeration value Visibility: default -->
      <element name="TTaskDialogElement.tdeMainInstruction">
        <short/>
      </element>

      <!-- enumeration value Visibility: default -->
      <element name="TTaskDialogElement.tdeEdit">
        <short/>
      </element>

      <!-- enumeration value Visibility: default -->
      <element name="TTaskDialogElement.tdeVerif">
        <short/>
      </element>

      <!-- class Visibility: default -->
      <element name="TEmulatedTaskDialog">
        <short/>
        <descr>
          The actual form class used for emulation.
        </descr>
        <seealso/>
      </element>

      <!-- procedure Visibility: protected -->
      <element name="TEmulatedTaskDialog.HandleEmulatedButtonClicked">
        <short/>
        <descr/>
        <seealso/>
      </element>

      <!-- argument Visibility: default -->
      <element name="TEmulatedTaskDialog.HandleEmulatedButtonClicked.Sender">
        <short/>
      </element>

      <!-- procedure Visibility: public -->
      <element name="TEmulatedTaskDialog.KeyDown">
        <short/>
        <descr/>
        <seealso/>
      </element>

      <!-- argument Visibility: default -->
      <element name="TEmulatedTaskDialog.KeyDown.Key">
        <short/>
      </element>

      <!-- argument Visibility: default -->
      <element name="TEmulatedTaskDialog.KeyDown.Shift">
        <short/>
      </element>

      <!-- constructor Visibility: public -->
      <element name="TEmulatedTaskDialog.CreateNew">
        <short/>
        <descr/>
        <seealso/>
      </element>

      <!-- argument Visibility: default -->
      <element name="TEmulatedTaskDialog.CreateNew.AOwner">
        <short/>
      </element>

      <!-- argument Visibility: default -->
      <element name="TEmulatedTaskDialog.CreateNew.Num">
        <short/>
      </element>

      <!-- variable Visibility: public -->
      <element name="TEmulatedTaskDialog.Owner">
        <short/>
        <descr>
          The Task Dialog structure which created the form.
        </descr>
        <seealso/>
      </element>

      <!-- variable Visibility: public -->
      <element name="TEmulatedTaskDialog.Element">
        <short/>
        <descr>
          The labels corresponding to the Task Dialog main elements.
        </descr>
        <seealso/>
      </element>

      <!-- variable Visibility: public -->
      <element name="TEmulatedTaskDialog.Combo">
        <short/>
        <descr>
          The Task Dialog selection list.
        </descr>
        <seealso/>
      </element>

      <!-- variable Visibility: public -->
      <element name="TEmulatedTaskDialog.Edit">
        <short/>
        <descr>
          The Task Dialog optional query editor.
        </descr>
        <seealso/>
      </element>

      <!-- variable Visibility: public -->
      <element name="TEmulatedTaskDialog.Verif">
        <short/>
        <descr>
          The Task Dialog optional checkbox.
        </descr>
        <seealso/>
      </element>

      <!-- record type Visibility: default -->
      <element name="TTaskDialogImplementation">
        <short/>
        <descr>
          <p>
            Structure for low-level access to the task dialog implementation. Points either to the HWND handle of the new TaskDialog API or to the emulation dialog.
          </p>
        </descr>
        <seealso/>
      </element>

      <!-- variable Visibility: default -->
      <element name="TTaskDialogImplementation.OnButtonClicked">
        <short/>
        <descr/>
        <seealso/>
      </element>

      <!-- variable Visibility: default -->
      <element name="TTaskDialogImplementation.Emulated">
        <short/>
        <descr/>
        <seealso/>
      </element>

      <!-- variable Visibility: default -->
      <element name="TTaskDialogImplementation.Wnd">
        <short/>
        <descr/>
        <seealso/>
      </element>

      <!-- variable Visibility: default -->
      <element name="TTaskDialogImplementation.Form">
        <short/>
        <descr/>
        <seealso/>
      </element>

      <!-- record type Visibility: default -->
      <element name="TTaskDialog">
        <short/>
        <descr>
          <p>
            Implements a TaskDialog. Uses the new TaskDialog API under Vista/Seven, and emulate it with pure Pascal code and standard themed components under XP or 2K. Creating a TTaskDialog object/record on the stack will initialize all of its string parameters to ''. Set the appropriate string parameters, then call Execute() with all additional parameters.
          </p>
          <p>
            RadioRes/SelectionRes/VerifyChecked will be used to reflect the state after dialog execution.
          </p>
          <p>
            Typical usage:
          </p>
<code>
var Task: TTaskDialog;
begin
  Task.Inst := 'Saving application settings';
  Task.Content := 'This is the content';
  Task.Radios := 'Store settings in registry' +#10+ ' Store settings in XML file';
  Task.Verify := 'Do no ask for this setting next time';
  Task.VerifyChecked := true;
  Task.Footer := 'XML file is perhaps a better choice';
  Task.Execute([],0,[],tiQuestion,tfiInformation,200);
  ShowMessage(IntToStr(Task.RadioRes)); // 200=Registry, 201=XML
  if Task.VerifyChecked then
  ShowMessage(Task.Verify);
end;
</code>
        </descr>
        <seealso/>
      </element>

      <!-- variable Visibility: default -->
      <element name="TTaskDialog.Title">
        <short/>
        <descr>
          The main title of the dialog window. If left void, the title of the application main form is used.
        </descr>
        <seealso/>
      </element>

      <element name="TTaskDialog.Inst">
        <short/>
        <descr>
          <p>
            The main instruction (first line displayed at the top of dialog). If not assigned (contains ''), the text is taken from resource strings for the message type defined in <file>LCLStrConsts</file>.
          </p>
        </descr>
        <seealso>
          <link id="#lcl.lclstrconsts.rsMtWarning"/>
          <link id="#lcl.lclstrconsts.rsMtError"/>
          <link id="#lcl.lclstrconsts.rsMtInformation"/>
          <link id="#lcl.lclstrconsts.rsMtConfirmation"/>
          <link id="#lcl.lclstrconsts.rsMtAuthentication"/>
          <link id="#lcl.lclstrconsts.rsMtCustom"/>
        </seealso>
      </element>

      <!-- variable Visibility: default -->
      <element name="TTaskDialog.Content">
        <short/>
        <descr>
          <p>
            The text displayed as the primary content for the dialog. The value is used in the Execute method to add a label displayed in the dialog.
          </p>
          <remark>
            In previous LCL versions, '\n' characters sequences were converted to LineEnding characters. This action is no longer performed as of revision 64975.
          </remark>
        </descr>
        <seealso/>
      </element>

      <!-- variable Visibility: default -->
      <element name="TTaskDialog.Buttons">
        <short/>
        <descr>
          <p>
            A #13#10 or #10 separated list of custom buttons. They will be identified with an ID number starting at 100. By default, the buttons will be created at the dialog bottom, just like the common buttons. If tdfUseCommandLinks flag is set, the custom buttons will be created as big button in the middle of the dialog window; in this case, any '\n' will be converted as note text (shown with smaller text under native Vista/Seven TaskDialog, or as popup hint within Delphi emulation).
          </p>
        </descr>
        <seealso/>
      </element>

      <!-- variable Visibility: default -->
      <element name="TTaskDialog.Radios">
        <short/>
        <descr>
          <p>
            A <b>#13#10</b> or <b>#10</b> delimited list of custom radio buttons. They will be identified with an ID number starting at 200. aRadioDef parameter can be set to define the default selected value. '\n' will be converted as note text (shown with smaller text under native Vista/Seven TaskDialog, or as popup hint within Delphi emulation).
          </p>
        </descr>
        <seealso/>
      </element>

      <!-- variable Visibility: default -->
      <element name="TTaskDialog.Info">
        <short/>
        <descr>
          <p>
            The expanded information content text. The Delphi emulation will always show the Info content (there is no collapse/expand button).
          </p>
        </descr>
        <seealso/>
      </element>

      <!-- variable Visibility: default -->
      <element name="TTaskDialog.InfoExpanded">
        <short/>
        <descr>
          <p>
            The button caption to be displayed when the information is expanded. Not used under XP: the Delphi emulation will always show the Info content.
          </p>
        </descr>
        <seealso/>
      </element>

      <!-- variable Visibility: default -->
      <element name="TTaskDialog.InfoCollapse">
        <short/>
        <descr>
          <p>
            The button caption to be displayed when the information is collapsed. Not used under XP. The Delphi emulation will always show the Info content.
          </p>
        </descr>
        <seealso/>
      </element>

      <!-- variable Visibility: default -->
      <element name="TTaskDialog.Footer">
        <short/>
        <descr>
          <p>
            The footer content text.
          </p>
        </descr>
        <seealso/>
      </element>

      <!-- variable Visibility: default -->
      <element name="TTaskDialog.Verify">
        <short/>
        <descr>
          <p>
            The text of the bottom most optional checkbox.
          </p>
        </descr>
        <seealso/>
      </element>

      <!-- variable Visibility: default -->
      <element name="TTaskDialog.Selection">
        <short/>
        <descr>
          <p>
            A #13#10 or #10 separated list of items to be selected. If set, a Combo Box will be displayed to select. If tdfQuery is in the flags, the combo box will be in addition mode and the user will be able to edit the Query text or fill the field with one item of the selection. This selection is not handled via the Vista/Seven TaskDialog, but with our Delphi emulation code (via a TComboBox).
          </p>
        </descr>
        <seealso/>
      </element>

      <!-- variable Visibility: default -->
      <element name="TTaskDialog.Query">
        <short/>
        <descr>
          <p>
            Text to be edited. If tdfQuery is in the flags, will contain the default query text.
          </p>
        </descr>
        <seealso/>
      </element>

      <!-- variable Visibility: default -->
      <element name="TTaskDialog.RadioRes">
        <short/>
        <descr>
          <p>
            The selected radio item; the first is numbered 0.
          </p>
        </descr>
        <seealso/>
      </element>

      <!-- variable Visibility: default -->
      <element name="TTaskDialog.SelectionRes">
        <short/>
        <descr>
          <p>
            After execution, contains the selected item from the Selection list.
          </p>
        </descr>
        <seealso/>
      </element>

      <!-- variable Visibility: default -->
      <element name="TTaskDialog.VerifyChecked">
        <short/>
        <descr>
          <p>
            Reflect the bottom-most optional checkbox state. If Verify is not '', should be set before execution. After execution, will contain the final checkbox state.
          </p>
        </descr>
        <seealso/>
      </element>

      <!-- variable Visibility: default -->
      <element name="TTaskDialog.Dialog">
        <short/>
        <descr>
          <p>
            Low-level access to the task dialog implementation.
          </p>
        </descr>
        <seealso/>
      </element>

      <!-- function Visibility: default -->
      <element name="TTaskDialog.Execute">
        <short/>
        <descr>
          <p>
            Launches the TaskDialog form.
          </p>
          <p>
            Some common buttons can be set via aCommonButtons. In emulation mode, aFlags will handle only tdfUseCommandLinks, tdfUseCommandLinksNoIcon, and tdfQuery options.
          </p>
          <p>
            Will return 0 on error, or the Button ID (e.g. mrOk for the OK button or 100 for the first custom button defined in Buttons string).
          </p>
          <p>
            If Buttons was defined, aButtonDef can set the selected Button ID. If Radios was defined, aRadioDef can set the selected Radio ID.
          </p>
          <p>
            aDialogIcon and aFooterIcon are used to specify the displayed icons.
          </p>
          <p>
            aWidth can be used to force a custom form width (in pixels).
          </p>
          <p>
            aParent can be set to any HWND - by default, Application.DialogHandle.
          </p>
          <p>
            If aNonNative is TRUE, the Delphi emulation code will always be used. aEmulateClassicStyle can be set to enforce conformity with the non themed user interface - see @http://synopse.info/forum/viewtopic.php?pid=2867#p2867.
          </p>
          <p>
            aOnButtonClicked can be set to a callback executed when a button is clicked.
          </p>
        </descr>
        <seealso/>
      </element>

      <!-- function result Visibility: default -->
      <element name="TTaskDialog.Execute.Result">
        <short/>
      </element>

      <!-- argument Visibility: default -->
      <element name="TTaskDialog.Execute.aCommonButtons">
        <short/>
      </element>

      <!-- argument Visibility: default -->
      <element name="TTaskDialog.Execute.aButtonDef">
        <short/>
      </element>

      <!-- argument Visibility: default -->
      <element name="TTaskDialog.Execute.aFlags">
        <short/>
      </element>

      <!-- argument Visibility: default -->
      <element name="TTaskDialog.Execute.aDialogIcon">
        <short/>
      </element>

      <!-- argument Visibility: default -->
      <element name="TTaskDialog.Execute.aFooterIcon">
        <short/>
      </element>

      <!-- argument Visibility: default -->
      <element name="TTaskDialog.Execute.aRadioDef">
        <short/>
      </element>

      <!-- argument Visibility: default -->
      <element name="TTaskDialog.Execute.aWidth">
        <short/>
      </element>

      <!-- argument Visibility: default -->
      <element name="TTaskDialog.Execute.aParent">
        <short/>
      </element>

      <!-- argument Visibility: default -->
      <element name="TTaskDialog.Execute.aNonNative">
        <short/>
      </element>

      <!-- argument Visibility: default -->
      <element name="TTaskDialog.Execute.aEmulateClassicStyle">
        <short/>
      </element>

      <!-- argument Visibility: default -->
      <element name="TTaskDialog.Execute.aOnButtonClicked">
        <short/>
      </element>

      <!-- procedure Visibility: default -->
      <element name="TTaskDialog.SetElementText">
        <short/>
        <descr>
          <p>
            Allow a OnButtonClicked callback to change the Task Dialog main elements. Note that tdeVerif could be modified only in emulation mode, since the API does not give any run-time access to the checkbox caption. Other elements will work in both emulated and native modes.
          </p>
        </descr>
        <seealso/>
      </element>

      <!-- argument Visibility: default -->
      <element name="TTaskDialog.SetElementText.element">
        <short/>
      </element>

      <!-- argument Visibility: default -->
      <element name="TTaskDialog.SetElementText.Text">
        <short/>
      </element>

      <!-- record type Visibility: default -->
      <element name="TTaskDialogEx">
        <short/>
        <descr>
          <p>
            A wrapper around the TTaskDialog.Execute method. Used to provide a "flat" access to task dialog parameters.
          </p>
        </descr>
        <seealso/>
      </element>

      <!-- variable Visibility: default -->
      <element name="TTaskDialogEx.Base">
        <short/>
        <descr>
          <p>
            The associated main TTaskDialog instance.
          </p>
        </descr>
        <seealso/>
      </element>

      <!-- variable Visibility: default -->
      <element name="TTaskDialogEx.CommonButtons">
        <short/>
        <descr>
          <p>
            Some common buttons to be displayed.
          </p>
        </descr>
        <seealso/>
      </element>

      <!-- variable Visibility: default -->
      <element name="TTaskDialogEx.ButtonDef">
        <short/>
        <descr>
          The default button ID.
        </descr>
        <seealso/>
      </element>

      <!-- variable Visibility: default -->
      <element name="TTaskDialogEx.Flags">
        <short/>
        <descr>
          <p>
            The associated configuration flags for this Task Dialog. In emulation mode, aFlags will handle only tdfUseCommandLinks, tdfUseCommandLinksNoIcon, and tdfQuery options.
          </p>
        </descr>
        <seealso/>
      </element>

      <!-- variable Visibility: default -->
      <element name="TTaskDialogEx.DialogIcon">
        <short/>
        <descr>
          Used to specify the dialog icon.
        </descr>
        <seealso/>
      </element>

      <!-- variable Visibility: default -->
      <element name="TTaskDialogEx.FooterIcon">
        <short/>
        <descr>
          Used to specify the footer icon.
        </descr>
        <seealso/>
      </element>

      <!-- variable Visibility: default -->
      <element name="TTaskDialogEx.RadioDef">
        <short/>
        <descr>
          The default radio button ID.
        </descr>
        <seealso/>
      </element>

      <!-- variable Visibility: default -->
      <element name="TTaskDialogEx.Width">
        <short/>
        <descr>
          Can be used to force a custom form width (in pixels).
        </descr>
        <seealso/>
      </element>

      <!-- variable Visibility: default -->
      <element name="TTaskDialogEx.NonNative">
        <short/>
        <descr>
          If TRUE, the Delphi emulation code will always be used.
        </descr>
        <seealso/>
      </element>

      <!-- variable Visibility: default -->
      <element name="TTaskDialogEx.EmulateClassicStyle">
        <short/>
        <descr>
          Can be used to enforce conformity with the non-themed user interface.
        </descr>
        <seealso/>
      </element>

      <!-- variable Visibility: default -->
      <element name="TTaskDialogEx.OnButtonClicked">
        <short/>
        <descr>
          This event handler will be fired on a button dialog click.
        </descr>
        <seealso/>
      </element>

      <!-- procedure Visibility: default -->
      <element name="TTaskDialogEx.Init">
        <short/>
        <descr>
          <p>
            Will initialize the dialog parameters. Can be used to display some information with less parameters. For example:
          </p>
<code>
var TaskEx: TTaskDialogEx;
// ...
TaskEx.Init;
TaskEx.Base.Title := 'Task Dialog Test';
TaskEx.Base.Inst := 'Callback Test';
TaskEx.Execute;
</code>
        </descr>
        <seealso/>
      </element>

      <!-- function Visibility: default -->
      <element name="TTaskDialogEx.Execute">
        <short/>
        <descr>
          <p>
            Main (and unique) method used to show the dialog. It is a wrapper around the TTaskDialog.Execute method.
          </p>
        </descr>
        <seealso/>
      </element>

      <!-- function result Visibility: default -->
      <element name="TTaskDialogEx.Execute.Result">
        <short/>
      </element>

      <!-- argument Visibility: default -->
      <element name="TTaskDialogEx.Execute.aParent">
        <short/>
      </element>

      <!-- function Visibility: default -->
      <element name="UnAmp">
        <short/>
        <descr>
          <p>
            Return the text without '&amp;' (Ampersand) characters.
          </p>
        </descr>
        <seealso/>
      </element>

      <!-- function result Visibility: default -->
      <element name="UnAmp.Result">
        <short/>
      </element>

      <!-- argument Visibility: default -->
      <element name="UnAmp.s">
        <short/>
      </element>

      <!-- variable Visibility: default -->
      <element name="DefaultTaskDialog">
        <short/>
        <descr>
          <p>
            A default Task Dialog wrapper instance. Can be used to display some information with fewer parameters, just like the TTaskDialogEx.Init method. For example:
          </p>
          <code>
var TaskEx: TTaskDialogEx;
// ...
TaskEx := DefaultTaskDialog;
TaskEx.Base.Title := 'Task Dialog Test';
TaskEx.Base.Inst := 'Callback Test';
TaskEx.Execute;
          </code>
        </descr>
        <seealso/>
      </element>

      <!-- function type Visibility: default -->
      <element name="TTaskDialogTranslate">
        <short/>
        <descr>
          Function used to translate captions.
        </descr>
        <seealso/>
      </element>

      <!-- function result Visibility: default -->
      <element name="TTaskDialogTranslate.Result">
        <short/>
      </element>

      <!-- argument Visibility: default -->
      <element name="TTaskDialogTranslate.aString">
        <short/>
      </element>

      <!-- variable Visibility: default -->
      <element name="TaskDialog_Translate">
        <short/>
        <descr/>
        <seealso/>
      </element>

      <!-- function Visibility: default -->
      <element name="DefaultFont">
        <short/>
        <descr>
          <p>
            Will map a default font, according to the available fonts. If Calibri is installed, it will be used by default. Falls back to Tahoma otherwise.
          </p>
        </descr>
        <seealso/>
      </element>
      <element name="DefaultFont.Result">
        <short/>
      </element>

    </module>
    <!-- LCLTaskDialog -->
  </package>
</fpdoc-descriptions>