-
Notifications
You must be signed in to change notification settings - Fork 35
/
Copy pathconfig.html
1458 lines (1332 loc) · 42.1 KB
/
config.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
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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!--
* This Source Code Form is subject to the terms of the Mozilla Public License,
* v. 2.0. If a copy of the MPL was not distributed with this file, You can
* obtain one at https://mozilla.org/MPL/2.0/
*
* Copyright (C) 2012-2023, Peter Johnson (gravatar.com/delphidabbler).
*
* CodeSnip File Format Documentation: Configuration Files
-->
<html xmlns="https://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<title>
CodeSnip File Format Documentation - Configuration Files
</title>
<link
rel="stylesheet"
type="text/css"
media="screen"
href="main.css"
/>
</head>
<body>
<div class="title">
<div>
DelphiDabbler CodeSnip
</div>
<div class="subtitle">
File Format Documentation
</div>
</div>
<h1>
Configuration Files
</h1>
<h2>
Introduction
</h2>
<p>
CodeSnip uses two config files – one system wide application file named <code>Common.config</code> and another user file named <code>User.config</code>. The standard version of CodeSnip maintains separate user config file for each user account that uses CodeSnip, while the portable version has just one such file.
</p>
<p>
Config files use the standard INI file format and are written and read using Windows API calls.
</p>
<p>
The following data types are supported:
</p>
<ul>
<li>
<em>String</em> – stored as a sequence of characters, optionally enclosed in double quotes.
</li>
<li>
<em>Boolean</em> – stored as the text <code class="value">False</code> and <code class="value">True</code> (although <code class="value">0</code>, <code class="value">No</code> and <code class="value">N</code> are all read as false).
</li>
<li>
<em>Integer</em> – stored as positive or negative whole numbers or zero.
</li>
<li>
<em>Float</em> – stored as positive or negative floating point numbers or zero. Floating point representations of whole numbers are stored as integers.
</li>
<li>
<em>Date-Time</em> – stored in the <code class="value">YYYY-MM-DD hh:mm:ss</code> format in all locales (i.e. the date and time separators are always <code class="value">-</code> and <code class="value">:</code> respectively.
</li>
</ul>
<h2>
Encoding
</h2>
<p>
From CodeSnip v4 config files are little endian Unicode text files with a byte order mark. This encoding is used because the international support is required and because the Windows API, which is used to read and write the files, understands this file format.
</p>
<p>
On earlier versions of CodeSnip the config files were ANSI text files using the system's default encoding. CodeSnip v4 and the standard edition's installer convert the older ANSI files to Unicode.
</p>
<h2>
File Format
</h2>
<h3>
Common Config File
</h3>
<p class="pullout">
<strong>Note:</strong> From CodeSnip v4.16 this file is used only by the installer of the standard edition. The portable edition does not use the file and does not create it.
</p>
<p>
The file stores information about the current version of the program. It is named <code>Common.config</code>. The file is stored in the standard edition's <code>%ProgramData%\DelphiDabbler\CodeSnip.4</code> directory.
</p>
<p>
There have been several versions of this file. The current one is version 7. The change to version 7 came with CodeSnip v4.16.0 and the removal of DelphiDabbler web service support.
</p>
<p>
The file has the following sections.
</p>
<h4>
[Application] section
</h4>
<p>
Provides information about the application.
</p>
<p>
Name / Value pairs:
</p>
<dl class="indent">
<dt>
<code class="key">Version</code> (String)
</dt>
<dd>
Internal version number of the installed version of CodeSnip as a dotted quad string.
</dd>
</dl>
<h4>
[IniFile] section
</h4>
<p>
Provides information about the config file itself.
</p>
<p>
Name / Value pairs:
</p>
<dl class="indent">
<dt>
<code class="key">Version</code> (Integer)
</dt>
<dd>
<div class="half-spaced">
Version number of the config file. Incremented whenever the file format changes. If this section or this value is missing then the default value is <code class="value">1</code>.
</div>
<div class="half-spaced">
The current value is <code class="value">7</code>.
</div>
</dd>
</dl>
<h3>
User Config File
</h3>
<p>
This file records configuration information that is unique users of the application. Some sections correspond to user preferences while others record details of previous operations or the layout of the GUI. The file is named <code>User.config</code>. The standard edition of CodeSnip stores the file in the logged on user's <code>%AppData%\DelphiDabbler\CodeSnip.4</code> directory, while the portable version stores it in the <code>AppDir</code> sub-directory of the folder where CodeSnip is installed.
</p>
<p>
There have been several versions of this file. The current one is version 19. The change to version 19 came with CodeSnip v4.21.0 and the addition of the [Compilers] section and the <code class="key">CanAutoInstall</code> key in the [Cmp:XXX] sections.
</p>
<p>
The file has the following sections.
</p>
<h4>
[Cmp:<em>XXX</em>] sections
</h4>
<p>
There is one of these sections for each compiler known to CodeSnip. Each section describes how CodeSnip should use the compiler, or indicates that the compiler is not available.
</p>
<p>
The actual name of a section is found by replacing <em>XXX</em> with one of the following values:
</p>
<ul>
<li>
<em>D2</em> – Delphi 2
</li>
<li>
<em>D3</em> – Delphi 3
</li>
<li>
<em>D4</em> – Delphi 4
</li>
<li>
<em>D5</em> – Delphi 5
</li>
<li>
<em>D6</em> – Delphi 6
</li>
<li>
<em>D2005w32</em> – Windows 32 personality of Delphi 2005
</li>
<li>
<em>D2006w32</em> – Windows 32 personality of Delphi 2006
</li>
<li>
<em>D2007</em> – Windows 32 personality of Delphi 2007
</li>
<li>
<em>D2009w32</em> – Windows 32 personality of Delphi 2009
</li>
<li>
<em>D2010</em> – Delphi 2010
</li>
<li>
<em>DXE</em> – Delphi XE
</li>
<li>
<em>DXE2</em> – Delphi XE2
</li>
<li>
<em>DXE3</em> – Delphi XE3
</li>
<li>
<em>DXE4</em> – Delphi XE4
</li>
<li>
<em>DXE5</em> – Delphi XE5
</li>
<li>
<em>DXE6</em> – Delphi XE6
</li>
<li>
<em>DXE7</em> – Delphi XE7
</li>
<li>
<em>DXE8</em> – Delphi XE8
</li>
<li>
<em>D10S</em> – Delphi 10 Seattle
</li>
<li>
<em>D101B</em> – Delphi 10.1 Berlin
</li>
<li>
<em>D102T</em> – Delphi 10.2 Tokyo
</li>
<li>
<em>D103R</em> – Delphi 10.3 Rio
</li>
<li>
<em>D104S</em> – Delphi 10.4 Sydney
</li>
<li>
<em>D11A</em> – Delphi 11.x Alexandria
</li>
<li>
<em>D12Y</em> – Delphi 12 Athens
</li>
<li>
<em>FPC</em> – Free Pascal
</li>
</ul>
<p>
Name / Value pairs (same for all sections unless noted otherwise):
</p>
<dl class="indent">
<dt>
<code class="key">ExePath</code> (String)
</dt>
<dd>
Path to the compiler's executable file. Empty string if the compiler not configured.
</dd>
<dt>
<code class="key">Displayable</code> (Boolean)
</dt>
<dd>
Indicates whether the compiler's compilation results for a snippet should be displayed in the UI.
</dd>
<dt>
<code class="key">Namespaces</code> (String)
</dt>
<dd>
<div class="half-spaced">
Space separated list of the namespaces containing Delphi's RTL units. A missing or empty string value ⇒ use the default RTL namespaces for the compiler.
</div>
<div class="half-spaced">
Relates to the Delphi XE2 and later compilers. If the value is present, it is ignored for earlier compilers and Free Pascal.
</div>
</dd>
<dt>
<code class="key">Prefix0</code> (String)
</dt>
<dd>
Double quoted prefix to the text output by the compiler to indicate fatal compiler errors. If not present the default is <code class="value">Fatal: </code>.
</dd>
<dt>
<code class="key">Prefix1</code> (String)
</dt>
<dd>
Double quoted prefix to the text output by the compiler to indicate standard compiler errors. If not present the default is <code class="value">Error: </code>.
</dd>
<dt>
<code class="key">Prefix2</code> (String)
</dt>
<dd>
Double quoted prefix to the text output by the compiler to indicate warnings. If not present the default is <code class="value">Warning: </code>.
</dd>
<dt>
<code class="key">Switches</code> (String)
</dt>
<dd>
Comma separated list of compiler switches. A missing or empty string value ⇒ use default switches for the compiler.
</dd>
<dt>
<code class="key">SearchDirCount</code> (Integer)
</dt>
<dd>
Count of the number of search directories configured for the compiler.
</dd>
<dt>
<code class="key">SearchDir<em>XXX</em></code> (String)
</dt>
<dd>
<div class="half-spaced">
One entry for each search directory configured for the compiler where <code class="key"<em>XXX</code> ranges from <code class="value">0</code> to <code class="key">SearchDirCount</code> - <code class="value">1</code>.
</div>
<div class="half-spaced">
Each entry contains a fully specified directory path.
</div>
</dd>
<dt>
<code class="key">CanAutoInstall</code> (Boolean)
</dt>
<dd>
<div class="half-spaced">
Determines whether the compiler can be automatically detected and registered by CodeSnip.
</div>
<div class="half-spaced">
Applies to Delphi compilers only, not to Free Pascal.
</div>
</dd>
</dl>
<h4>
[Compilers] section
</h4>
<p>
This section records configuration information that applies to all, or
multiple, compilers.
</p>
<p>
Name / Value pairs:
</p>
<dl class="indent">
<dt>
<code class="key">PermitStartupDetection</code> (Boolean)
</dt>
<dd>
<div class="half-spaced">
Determines whether CodeSnip should detect, and potentially register, any
Delphi compilers that are installed on the user's system but not
registered with the program.
</div>
<div class="half-spaced">
Does not apply to the Free Pascal compiler.
</div>
</dd>
</dl>
<h4>
[Database] section
</h4>
<p>
This section records database customisations.
</p>
<p>
Name / Value pairs:
</p>
<dl class="indent">
<dt>
<code class="key">UserDataDir</code> (String)
</dt>
<dd>
<div class="half-spaced">
Specifies the directory that contains the user database. This value is only present if the user has moved the database from its default location.
</div>
<div class="spaced">
<strong>Note:</strong> The value is ignored in the portable version of CodeSnip.
</div>
</dd>
</dl>
<h4>
[DuplicateSnippet] section
</h4>
<p>
Persists the state of controls in the Duplicate Snippet dialogue box.
</p>
<p>
Name / Value pairs:
</p>
<dl class="indent">
<dt>
<code class="key">EditSnippetOnClose</code> (Boolean)
</dt>
<dd>
Stores the state of the <em>Edit in Snippets Editor</em> check box.
</dd>
</dl>
<h4>
[Favourites] section
</h4>
<p>
Persists the state of controls in Favourites dialogue box.
</p>
<p>
Name / Value pairs:
</p>
<dl class="indent">
<dt>
<code class="key">DisplayInNewTabs</code> (Boolean)
</dt>
<dd>
Stores the state of the <em>Open favourites in new tabs</em> check box.
</dd>
<dt>
<code class="key">InactiveAlphaBlendValue</code> (Integer)
</dt>
<dd>
Stores the alpha blend value (i.e. the degree of transparency) of the Favourites dialogue box when it is not active. Values should be in the range <code class="value">128</code> to <code class="value">255</code>.
</dd>
</dl>
<h4>
[FindCompiler] section
</h4>
<p>
Provides information about the last compiler search that was run.
</p>
<p>
Name / Value pairs:
</p>
<dl class="indent">
<dt>
<code class="key">D2</code> (Boolean)
</dt>
<dd>
Indicates whether Delphi 2 was included in the search.
</dd>
<dt>
<code class="key">D3</code> (Boolean)
</dt>
<dd>
Indicates whether Delphi 3 was included in the search.
</dd>
<dt>
<code class="key">D4</code> (Boolean)
</dt>
<dd>
Indicates whether Delphi 4 was included in the search.
</dd>
<dt>
<code class="key">D5</code> (Boolean)
</dt>
<dd>
Indicates whether Delphi 5 was included in the search.
</dd>
<dt>
<code class="key">D6</code> (Boolean)
</dt>
<dd>
Indicates whether Delphi 6 was included in the search.
</dd>
<dt>
<code class="key">D7</code> (Boolean)
</dt>
<dd>
Indicates whether Delphi 7 was included in the search.
</dd>
<dt>
<code class="key">D2005w32</code> (Boolean)
</dt>
<dd>
Indicates whether the Win32 personality of Delphi 2005 was included in the search.
</dd>
<dt>
<code class="key">D2006w32</code> (Boolean)
</dt>
<dd>
Indicates whether the Win32 personality of Delphi 2006 was included in the search.
</dd>
<dt>
<code class="key">D2007</code> (Boolean)
</dt>
<dd>
Indicates whether the Win32 personality of Delphi 2007 was included in the search.
</dd>
<dt>
<code class="key">D2009w32</code> (Boolean)
</dt>
<dd>
Indicates whether the Win32 personality of Delphi 2009 was included in the search.
</dd>
<dt>
<code class="key">D2010</code> (Boolean)
</dt>
<dd>
Indicates whether Delphi 2010 was included in the search.
</dd>
<dt>
<code class="key">DXE</code> (Boolean)
</dt>
<dd>
Indicates whether Delphi XE was included in the search.
</dd>
<dt>
<code class="key">DXE2</code> (Boolean)
</dt>
<dd>
Indicates whether Delphi XE2 was included in the search.
</dd>
<dt>
<code class="key">DXE3</code> (Boolean)
</dt>
<dd>
Indicates whether Delphi XE3 was included in the search.
</dd>
<dt>
<code class="key">DXE4</code> (Boolean)
</dt>
<dd>
Indicates whether Delphi XE4 was included in the search.
</dd>
<dt>
<code class="key">DXE5</code> (Boolean)
</dt>
<dd>
Indicates whether Delphi XE5 was included in the search.
</dd>
<dt>
<code class="key">DXE6</code> (Boolean)
</dt>
<dd>
Indicates whether Delphi XE6 was included in the search.
</dd>
<dt>
<code class="key">DXE7</code> (Boolean)
</dt>
<dd>
Indicates whether Delphi XE7 was included in the search.
</dd>
<dt>
<code class="key">DXE8</code> (Boolean)
</dt>
<dd>
Indicates whether Delphi XE8 was included in the search.
</dd>
<dt>
<code class="key">D10S</code> (Boolean)
</dt>
<dd>
Indicates whether Delphi 10 Seattle was included in the search.
</dd>
<dt>
<code class="key">D101B</code> (Boolean)
</dt>
<dd>
Indicates whether Delphi 10.1 Berlin was included in the search.
</dd>
<dt>
<code class="key">D102T</code> (Boolean)
</dt>
<dd>
Indicates whether Delphi 10.2 Tokyo was included in the search.
</dd>
<dt>
<code class="key">D103R</code> (Boolean)
</dt>
<dd>
Indicates whether Delphi 10.3 Rio was included in the search.
</dd>
<dt>
<code class="key">D104S</code> (Boolean)
</dt>
<dd>
Indicates whether Delphi 10.4 Sydney was included in the search.
</dd>
<dt>
<code class="key">D11A</code> (Boolean)
</dt>
<dd>
Indicates whether Delphi 11.x Alexandria was included in the search.
</dd>
<dt>
<code class="key">D12Y</code> (Boolean)
</dt>
<dd>
Indicates whether Delphi 12 Athens was included in the search.
</dd>
<dt>
<code class="key">FPC</code> (Boolean)
</dt>
<dd>
Indicates whether Free Pascal was included in the search.
</dd>
<dt>
<code class="key">Option</code> (Integer)
</dt>
<dd>
Code that describes the kind of compilation result to be searched for: <code class="value">0</code> ⇒ snippet compiles OK; <code class="value">1</code> ⇒ snippet compiles without warnings; <code class="value">2</code> ⇒ snippet compiles with warning(s); <code class="value">3</code> ⇒ snippet fails to compile; <code class="value">4</code> ⇒ snippet not tested.
</dd>
<dt>
<dt>
<code class="key">Logic</code> (Integer)
</dt>
<dd>
Code that describes the search logic to use: <code class="value">0</code> ⇒ "and"; <code class="value">1</code> ⇒ "or".
</dd>
</dl>
<h4>
[FindText] section
</h4>
<p>
Provides information about last the last text search that was run and records a history of search terms.
</p>
<p>
Name / Value pairs:
</p>
<dl class="indent">
<dt>
<code class="key">HistoryCount</code> (Integer)
</dt>
<dd>
Count of items in the search term history.
</dd>
<dt>
<code class="key">History<em>XXX</em></code> (String)
</dt>
<dd>
<div class="half-spaced">
One entry for each search term in the history where <code class="key">XXX</code> ranges from <code class="value">0</code> to <code class="key">HistoryCount</code> - <code class="value">1</code>.
</div>
<div class="half-spaced">
Each entry contains one or more spaced separated search words.
</div>
</dd>
<dt>
<code class="key">MatchCase</code> (Boolean)
</dt>
<dd>
One of the search options. Indicates whether searches are case sensitive.
</dd>
<dt>
<code class="key">WholeWord</code> (Boolean)
</dt>
<dd>
One of the search options. Indicates whether searches match whole words only.
</dd>
<dt>
<code class="key">Logic</code> (Integer)
</dt>
<dd>
Code that describes the search logic to use: <code class="value">0</code> ⇒ "and"; <code class="value">1</code> ⇒ "or".
</dd>
</dl>
<h4>
[FindXRefs] section
</h4>
<p>
Provides information about the last snippet cross reference search that was run.
</p>
<p>
Name / Value pairs:
</p>
<dl class="indent">
<dt>
<code class="key">IncludeSnippet</code> (Boolean)
</dt>
<dd>
Indicates whether to include the snippet for which the search is being performed in the search result.
</dd>
<dt>
<code class="key">Required</code> (Boolean)
</dt>
<dd>
Indicates whether snippets that are required to compile the selected snippet are included in the search results.
</dd>
<dt>
<code class="key">RequiredRecurse</code> (Boolean)
</dt>
<dd>
Indicates whether the search for required snippets is recursive. Ignored if <code class="key">Required</code> = <code class="value">False</code>.
</dd>
<dt>
<code class="key">RequiredReverse</code> (Boolean)
</dt>
<dd>
Indicates whether snippets that depend on the searched-for snippet are included in the search results.
</dd>
<dt>
<code class="key">SeeAlso</code> (Boolean)
</dt>
<dd>
Indicates whether snippets that are cross referenced by the selected snippet are included in the search results.
</dd>
<dt>
<code class="key">SeeAlsoRecurse</code> (Boolean)
</dt>
<dd>
Indicates whether the search for cross-referenced snippets is recursive. Ignored if <code class="key">SeeAlso</code> = <code class="value">False</code>.
</dd>
<dt>
<code class="key">SeeAlsoReverse</code> (Boolean)
</dt>
<dd>
Indicates whether snippets that cross-reference the searched-for snippet are included in the search results.
</dd>
</dl>
<h4>
[IniFile] section
</h4>
<p>
Provides information about the config file and installed version of CodeSnip.
</p>
<p>
Name / Value pairs:
</p>
<dl class="indent">
<dt>
<code class="key">Version</code> (Integer)
</dt>
<dd>
<div class="half-spaced">
The version number of the config file. Incremented whenever the file format changes. If this section or this value is missing then the default value is <code class="value">1</code>.
</div>
<div class="half-spaced">
The current value is <code class="value">19</code>.
</div>
</dd>
<dt>
<code class="key">ProgramVersion</code> (String)
</dt>
<dd>
Internal version number of the currently installed version of CodeSnip as a dotted quad.
</dd>
</dl>
<h4>
[Prefs] section
</h4>
<p>
Stores information about the Preferences dialogue box itself, rather than actual preferences data. Actual preference data is stored in sections with names like [Prefs:XXX] where XXX is a preferences sub-section.
</p>
<p>
Name / Value pairs:
</p>
<dl class="indent">
<dt>
<code class="key">LastTab</code> (string)
</dt>
<dd>
Name of the tab that was open when the dialogue box was last closed. May be the empty string if the dialogue box has not yet been opened.
</dd>
</dl>
<h4>
[Prefs:CodeGen] section
</h4>
<p>
Stores source code generation preferences. Used in test compilations or when generating user defined units.
</p>
<p>
Name / Value pairs:
</p>
<dl class="indent">
<dt>
<code class="key">EmitWarnings</code> (Boolean)
</dt>
<dd>
Flag indicating whether directives are emitted to switch specified warnings on or off. <code class="value">True</code> ⇒ emit directives; <code class="value">False</code> ⇒ do not emit directives.
</dd>
<dt>
<code class="key">WarningCount</code> (Integer)
</dt>
<dd>
Number of warning directives supported.
</dd>
<dt>
<code class="key">Warning<em>XXX</em>.Symbol</code> (String)
</dt>
<dd>
<div class="half-spaced">
One entry for each supported warning directive, where <code class="key">XXX</code> ranges from <code class="value">0</code> to <code class="key">WarningCount</code> - <code class="value">1</code>.
</div>
<div class="half-spaced">
Each entry contains the symbol representing a warning as used in Delphi's $WARN directive.
</div>
</dd>
<dt>
<code class="key">Warning<em>XXX</em>.MinCompiler</code> (Float)
</dt>
<dd>
<div class="half-spaced">
One entry for each supported warning directive, where <code class="key">XXX</code> ranges from <code class="value">0</code> to <code class="key">WarningCount</code> - <code class="value">1</code>.
</div>
<div class="half-spaced">
Records the earliest version of Delphi that supports the warning. This version number is a decimal value containing the compiler version number as specified by Delphi's <var>CompilerVersion</var> constant. Must be 14.0 (Delphi 6) or higher.
</div>
</dd>
<dt>
<code class="key">Warning<em>XXX</em>.State</code> (Boolean)
</dt>
<dd>
<div class="half-spaced">
One entry for each supported warning directive, where <code class="key">XXX</code> ranges from <code class="value">0</code> to <code class="key">WarningCount</code> - <code class="value">1</code>.
</div>
<div class="half-spaced">
Indicates whether the warning should be switched on or off. <code class="value">True</code> ⇒ switch on; <code class="value">False</code> ⇒ switch off.
</div>
</dd>
</dl>
<h4>
[Prefs:Display] section
</h4>
<p>
Stores preferences for the main display.
</p>
<p>
Name / Value pairs:
</p>
<dl class="indent">
<dt>
<code class="key">OverviewStartState</code> (Integer)
</dt>
<dd>
Code that indicates the desired start state of the overview pane treeview: <code class="value">0</code> ⇒ fully expanded; <code class="value">1</code> ⇒ fully collapsed.
</dd>
<dt>
<code class="key">ShowEmptySections</code> (Boolean)
</dt>
<dd>
Flag that specifies whether empty sections should be displayed in the overview pane. <code class="value">True</code> ⇒ display empty sections; <code class="value">False</code> ⇒ hide empty sections.
</dd>
<dt>
<code class="key">ShowNewSnippetsInNewTabs</code> (Boolean)
</dt>
<dd>
Flag that specifies how newly created snippets and categories are displayed in the detail pane. <code class="value">True</code> ⇒ a new tab is created for each new item; <code class="value">False</code> ⇒ new items overwrite the current item in the selected tab.
</dd>
<dt>
<code class="key">MainDBHeadingColour</code> (Integer)
</dt>
<dd>
Colour to be used to display headings of items from the main database.
</dd>
<dt>
<code class="key">UserDBHeadingColour</code> (Integer)
</dt>
<dd>
Colour to be used to display headings of items from the user database.
</dd>
<dt>
<code class="key">SourceCodeBGColour</code> (Integer)
</dt>
<dd>
Colour to be used for the background of source code in the main display.
</dd>
<dt>
<code class="key">MainDBHeadingCustomColourCount</code> (Integer)
</dt>
<dd>
Number of recorded custom colours for main database item headings.
</dd>
<dt>
<code class="key">MainDBHeadingCustomColour<em>XXX</em></code> (String)
</dt>
<dd>
<div class="half-spaced">
One entry for each recorded custom colour for main database item headings, where <code class="key">XXX</code> ranges from <code class="value">0</code> to <code class="key">MainDBHeadingCustomColourCount</code> - <code class="value">1</code>.
</div>
<div class="half-spaced">
The value is a definition of a custom colour in the format used by the <var>TColorDialog</var> dialogue box. This format is <code class="value">ColourID=ColourNum</code> where <em>ColourID</em> is a value from <code class="value">ColorA</code> to <code class="value">ColorP</code> and <em>ColourNum</em> is the hex representation of the colour.
</div>
</dd>
<dt>
<code class="key">UserDBHeadingCustomColourCount</code> (Integer)
</dt>
<dd>
Number of recorded custom colours for user database item headings.
</dd>
<dt>
<code class="key">UserDBHeadingCustomColour<em>XXX</em></code> (String)
</dt>
<dd>
<div class="half-spaced">
One entry for each recorded custom colour for user database item headings, where <code class="key">XXX</code> ranges from <code class="value">0</code> to <code class="key">UserDBHeadingCustomColourCount</code> - <code class="value">1</code>.
</div>
<div class="half-spaced">
The value is a definition of a custom colour in the format used by the <var>TColorDialog</var> dialogue box. This format is <code class="value">ColourID=ColourNum</code> where <em>ColourID</em> is a value from <code class="value">ColorA</code> to <code class="value">ColorP</code> and <em>ColourNum</em> is the hex representation of the colour.
</div>
</dd>
<dt>
<code class="key">SourceCodeBGCustomColourCount</code> (Integer)
</dt>
<dd>
Number of recorded custom colours for the source code background in the main display.
</dd>
<dt>
<code class="key">SourceCodeBGCustomColour<em>XXX</em></code> (String)
</dt>
<dd>
<div class="half-spaced">
One entry for each recorded custom colour for the source code background in the main display, where <code class="key">XXX</code> ranges from <code class="value">0</code> to <code class="key">SourceCodeBGCustomColourCount</code> - <code class="value">1</code>.
</div>
<div class="half-spaced">
The value is a definition of a custom colour in the format used by the <var>TColorDialog</var> dialogue box. This format is <code class="value">ColourID=ColourNum</code> where <em>ColourID</em> is a value from <code class="value">ColorA</code> to <code class="value">ColorP</code> and <em>ColourNum</em> is the hex representation of the colour.
</div>
</dd>
<dt>
<code class="key">OverviewFontSize</code> (Integer)
</dt>
<dd>
Size of font to be used in overview pane tree view. If missing or empty the default value is the default font size of the operationg system.
</dd>
<dt>
<code class="key">DetailFontSize</code> (Integer)
</dt>
<dd>
Size of font to be used in detail pane for all text except for source code. If missing or empty the default value is the default content font size of the operating system.
</dd>
</dl>
<h4>
[Prefs:General] section
</h4>
<p>
Stores miscellaneous application preferences.
</p>
<p>
Name / Value pairs:
</p>
<dl class="indent">
<dt>
<code class="key">Units</code> (Integer)
</dt>
<dd>
A code that records the units of measurement used by the application: <code class="value">0</code> ⇒ inches; <code class="value">1</code> ⇒ millimeters.
</dd>
</dl>