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
|
<?xml version="1.0" encoding="UTF-8"?>
<fpdoc-descriptions>
<package name="lcl">
<!--
====================================================================
JSONPropStorage
====================================================================
-->
<module name="JSONPropStorage">
<short>Contains a component that stores Form Session Properties in JSON format.</short>
<descr>
<p>In this unit you can find an implementation of a name/value pair storage container in JSON format.</p>
<p>This container will get the Form's Session Properties that you setup in <link id="#LCL.Forms.TForm">TForm.SessionProperties</link> and read/write them on the file you specify on <link id="#LCL.JsonPropStorage.TJSONPropStorage.JSONFileName">TJSONPropStorage.JSONFileName</link>.</p>
</descr>
<!-- unresolved type reference Visibility: default -->
<element name="Classes">
<short />
<descr />
<seealso />
</element> <!-- unit Classes -->
<!-- unresolved type reference Visibility: default -->
<element name="SysUtils">
<short />
<descr />
<seealso />
</element> <!-- unit SysUtils -->
<!-- unresolved type reference Visibility: default -->
<element name="Forms">
<short />
<descr />
<seealso />
</element> <!-- unit Forms -->
<!-- unresolved type reference Visibility: default -->
<element name="JSONConf">
<short>This unit contains the implementation of a path/value pair generic container in JSON format. See package: <url href="http://wiki.freepascal.org/fcl-json">fcl-json</url>.</short>
<descr />
<seealso />
</element> <!-- unit JSONConf -->
<!-- unresolved type reference Visibility: default -->
<element name="LazUTF8">
<short />
<descr />
<seealso />
</element> <!-- unit LazUTF8 -->
<!-- object Visibility: default -->
<element name="TCustomJSONPropStorage">
<short>Implements the base class for the JSON Form's Session Properties Storage.</short>
<descr />
<errors />
<seealso />
</element> <!-- object TCustomJSONPropStorage -->
<!-- variable Visibility: private -->
<element name="TCustomJSONPropStorage.FCount">
<short />
<descr />
<errors />
<seealso />
</element> <!-- variable TCustomJSONPropStorage.FCount -->
<!-- variable Visibility: private -->
<element name="TCustomJSONPropStorage.FJSONFileName">
<short />
<descr />
<errors />
<seealso />
</element> <!-- variable TCustomJSONPropStorage.FJSONFileName -->
<!-- variable Visibility: private -->
<element name="TCustomJSONPropStorage.FRootObjectPath">
<short />
<descr />
<errors />
<seealso />
</element> <!-- variable TCustomJSONPropStorage.FRootObjectPath -->
<!-- variable Visibility: private -->
<element name="TCustomJSONPropStorage.FJSONConf">
<short />
<descr />
<errors />
<seealso />
</element> <!-- variable TCustomJSONPropStorage.FJSONConf -->
<!-- variable Visibility: private -->
<element name="TCustomJSONPropStorage.FFormatted">
<short />
<descr />
<errors />
<seealso />
</element> <!-- variable TCustomJSONPropStorage.FFormatted -->
<!-- function Visibility: protected -->
<element name="TCustomJSONPropStorage.GetJSONFileName">
<short>Getter for the property <link id="#LCL.JsonPropStorage.TCustomJSONPropStorage.JSONFileName">TCustomJSONPropStorage.JSONFileName</link>.</short>
<descr />
<errors />
<seealso />
</element> <!-- function TCustomJSONPropStorage.GetJSONFileName -->
<!-- function result Visibility: default -->
<element name="TCustomJSONPropStorage.GetJSONFileName.Result">
<short>The current value of the property <link id="#LCL.JsonPropStorage.TCustomJSONPropStorage.JSONFileName">TCustomJSONPropStorage.JSONFileName</link>.</short>
</element> <!-- function result TCustomJSONPropStorage.GetJSONFileName.Result -->
<!-- function Visibility: protected -->
<element name="TCustomJSONPropStorage.RootSection">
<short>Returns the name of the RootSection.</short>
<descr />
<errors />
<seealso />
</element> <!-- function TCustomJSONPropStorage.RootSection -->
<!-- function result Visibility: default -->
<element name="TCustomJSONPropStorage.RootSection.Result">
<short>The current value of RootSection.</short>
</element> <!-- function result TCustomJSONPropStorage.RootSection.Result -->
<!-- function Visibility: protected -->
<element name="TCustomJSONPropStorage.GetFormatted">
<short>Getter for the property <link id="#LCL.JsonPropStorage.TCustomJSONPropStorage.Formatted">TCustomJSONPropStorage.Formatted</link>.</short>
<descr />
<errors />
<seealso />
</element> <!-- function TCustomJSONPropStorage.GetFormatted -->
<!-- function result Visibility: default -->
<element name="TCustomJSONPropStorage.GetFormatted.Result">
<short>The current value of <link id="#LCL.JsonPropStorage.TCustomJSONPropStorage.Formatted">TCustomJSONPropStorage.Formatted</link>.</short>
</element> <!-- function result TCustomJSONPropStorage.GetFormatted.Result -->
<!-- procedure Visibility: protected -->
<element name="TCustomJSONPropStorage.SetFormatted">
<short>Setter for the property <link id="#LCL.JsonPropStorage.TCustomJSONPropStorage.Formatted">TCustomJSONPropStorage.Formatted</link>.</short>
<descr />
<errors />
<seealso />
</element> <!-- procedure TCustomJSONPropStorage.SetFormatted -->
<!-- argument Visibility: default -->
<element name="TCustomJSONPropStorage.SetFormatted.Value">
<short>A <var>Boolean</var> value to set the property <link id="#LCL.JsonPropStorage.TCustomJSONPropStorage.Formatted">TCustomJSONPropStorage.Formatted</link></short>
</element> <!-- argument TCustomJSONPropStorage.SetFormatted.Value -->
<!-- function Visibility: protected -->
<element name="TCustomJSONPropStorage.FixPath">
<short>Turns '.' notation into '/' notation for the xpath-ish <url href="http://wiki.freepascal.org/fcl-json">JSONConf</url> underlayer.</short>
<descr />
<errors />
<seealso />
</element> <!-- function TCustomJSONPropStorage.FixPath -->
<!-- argument Visibility: default -->
<element name="TCustomJSONPropStorage.FixPath.aPath">
<short>The path to be fixed.</short>
</element> <!-- argument TCustomJSONPropStorage.FixPath.aPath -->
<!-- function result Visibility: default -->
<element name="TCustomJSONPropStorage.FixPath.Result">
<short>The fixed path is returned with '.' replaced by '/'.</short>
</element> <!-- function result TCustomJSONPropStorage.FixPath.Result -->
<!-- property Visibility: protected -->
<element name="TCustomJSONPropStorage.JSONConf">
<short>Instance of the object that implements a generic path/value pair storage.</short>
<descr />
<errors />
<seealso />
</element> <!-- property TCustomJSONPropStorage.JSONConf -->
<!-- procedure Visibility: public -->
<element name="TCustomJSONPropStorage.StorageNeeded">
<short>Aks the underlying storage object for an entry</short>
<descr />
<errors />
<seealso />
</element> <!-- procedure TCustomJSONPropStorage.StorageNeeded -->
<!-- argument Visibility: default -->
<element name="TCustomJSONPropStorage.StorageNeeded.ReadOnly">
<short>If the item is read-only.</short>
</element> <!-- argument TCustomJSONPropStorage.StorageNeeded.ReadOnly -->
<!-- procedure Visibility: public -->
<element name="TCustomJSONPropStorage.FreeStorage">
<short>Frees an entry from the underlying storage object.</short>
<descr />
<errors />
<seealso />
</element> <!-- procedure TCustomJSONPropStorage.FreeStorage -->
<!-- function Visibility: public -->
<element name="TCustomJSONPropStorage.DoReadString">
<short>Implements the actual reading of a value from the underlying storage container.</short>
<descr />
<errors />
<seealso />
</element> <!-- fucntion TCustomJSONPropStorage.DoReadString -->
<!-- argument Visibility: default -->
<element name="TCustomJSONPropStorage.DoReadString.Section">
<short>The section to be read.</short>
</element> <!-- argument TCustomJSONPropStorage.DoReadString.Section -->
<!-- argument Visibility: default -->
<element name="TCustomJSONPropStorage.DoReadString.Ident">
<short>The ident to be read.</short>
</element> <!-- argument TCustomJSONPropStorage.StorageNeeded.Ident -->
<!-- argument Visibility: default -->
<element name="TCustomJSONPropStorage.DoReadString.Default">
<short>If has no value then return this as default.</short>
</element> <!-- argument TCustomJSONPropStorage.DoReadString.Default -->
<!-- function result Visibility: default -->
<element name="TCustomJSONPropStorage.DoReadString.Result">
<short>The value of the section/ident requested.</short>
</element> <!-- function result TCustomJSONPropStorage.DoReadString.Result -->
<!-- procedure Visibility: public -->
<element name="TCustomJSONPropStorage.DoWriteString">
<short>Implements the actual writing of a value from the underlying storage container.</short>
<descr />
<errors />
<seealso />
</element> <!-- procedure TCustomJSONPropStorage.DoWriteString -->
<!-- argument Visibility: default -->
<element name="TCustomJSONPropStorage.DoWriteString.Section">
<short>The section to be written.</short>
</element> <!-- argument TCustomJSONPropStorage.DoWriteString.Section -->
<!-- argument Visibility: default -->
<element name="TCustomJSONPropStorage.DoWriteString.Ident">
<short>The ident to be written.</short>
</element> <!-- argument TCustomJSONPropStorage.DoWriteString.Ident -->
<!-- argument Visibility: default -->
<element name="TCustomJSONPropStorage.DoWriteString.Value">
<short>The value to be written.</short>
</element> <!-- argument TCustomJSONPropStorage.DoWriteString.Value -->
<!-- procedure Visibility: public -->
<element name="TCustomJSONPropStorage.DoEraseSections">
<short>Erases a section from the underlying storage container.</short>
<descr />
<errors />
<seealso />
</element> <!-- procedure TCustomJSONPropStorage.DoEraseSections -->
<!-- argument Visibility: default -->
<element name="TCustomJSONPropStorage.DoEraseSections.ARootObjectPath">
<short>The path to the section that will be erased.</short>
</element> <!-- argument TCustomJSONPropStorage.DoEraseSections.ARootObjectPath -->
<!-- property Visibility: public -->
<element name="TCustomJSONPropStorage.JSONFileName">
<short>Name of the file where the property data is saved in JSON format.</short>
<descr />
<errors />
<seealso />
</element> <!-- property TCustomJSONPropStorage.JSONFileName -->
<!-- property Visibility: public -->
<element name="TCustomJSONPropStorage.RootObjectPath">
<short>Name of the root object path on your JSON file.</short>
<descr />
<errors />
<seealso />
</element> <!-- property TCustomJSONPropStorage.RootObjectPath -->
<!-- property Visibility: public -->
<element name="TCustomJSONPropStorage.Formatted">
<short>This determines if the JSON is to be formatted or not.</short>
<descr />
<errors />
<seealso />
</element> <!-- property TCustomJSONPropStorage.Formatted -->
<!-- object Visibility: default -->
<element name="TJSONPropStorage">
<short>Implements the final class for the JSON Form Session Properties storage.</short>
<descr />
<errors />
<seealso>
<link id="#LCL.Forms.TForm">TForm.SessionProperties</link>
<link id="#LCL.INIPropStorage.TINIPropStorage">TINIPropStorage</link>
<link id="#LCL.XMLPropStorage.TXMLPropStorage">TXMLPropStorage</link>
</seealso>
</element> <!-- object TJSONPropStorage -->
<!-- property Visibility: published -->
<element name="TJSONPropStorage.StoredValues" link="#LCL.PropertyStorage.TCustomPropertyStorage.StoredValues">
<short />
<descr />
<errors />
<seealso />
</element> <!-- property TJSONPropStorage.StoredValues -->
<!-- property Visibility: published -->
<element name="TJSONPropStorage.JSONFileName" link="#LCL.JsonPropStorage.TCustomJSONPropStorage.JSONFileName">
<short />
<descr />
<errors />
<seealso />
</element> <!-- property TJSONPropStorage.JSONFileName -->
<!-- property Visibility: published -->
<element name="TJSONPropStorage.Formatted" link="#LCL.JsonPropStorage.TCustomJSONPropStorage.Formatted">
<short />
<descr />
<errors />
<seealso />
</element> <!-- property TJSONPropStorage.StoredValues -->
<!-- property Visibility: published -->
<element name="TJSONPropStorage.Active" link="#LCL.PropertyStorage.TCustomPropertyStorage.Active">
<short />
<descr />
<errors />
<seealso />
</element> <!-- property TJSONPropStorage.Active -->
<!-- property Visibility: published -->
<element name="TJSONPropStorage.OnSavingProperties" link="#LCL.PropertyStorage.TCustomPropertyStorage.OnSavingProperties">
<short />
<descr />
<errors />
<seealso />
</element> <!-- property TJSONPropStorage.OnSavingProperties -->
<!-- property Visibility: published -->
<element name="TJSONPropStorage.OnSaveProperties" link="#LCL.PropertyStorage.TCustomPropertyStorage.OnSaveProperties">
<short />
<descr />
<errors />
<seealso />
</element> <!-- property TJSONPropStorage.OnSaveProperties -->
<!-- property Visibility: published -->
<element name="TJSONPropStorage.OnRestoringProperties" link="#LCL.PropertyStorage.TCustomPropertyStorage.OnRestoringProperties">
<short />
<descr />
<errors />
<seealso />
</element> <!-- property TJSONPropStorage.OnRestoringProperties -->
<!-- property Visibility: published -->
<element name="TJSONPropStorage.OnRestoreProperties" link="#LCL.PropertyStorage.TCustomPropertyStorage.OnRestoreProperties">
<short />
<descr />
<errors />
<seealso />
</element> <!-- property TJSONPropStorage.OnRestoreProperties -->
<!-- procedure Visibility: default -->
<element name="Register">
<short>Registers <link id="#LCL.JsonPropStorage.TJSONPropStorage">TJSONPropStorage</link> on the 'Misc' tab of the component pallete.</short>
<descr />
<errors />
<seealso />
</element> <!-- procedure Register -->
</module> <!-- module JSONPropStorage -->
</package> <!-- package lcl -->
</fpdoc-descriptions>
|
