PageRenderTime 45ms CodeModel.GetById 15ms app.highlight 24ms RepoModel.GetById 1ms app.codeStats 0ms

/docs/xml/lcl/propertystorage.xml

http://github.com/graemeg/lazarus
XML | 929 lines | 822 code | 0 blank | 107 comment | 0 complexity | 52d157799ccc3f0d69bda4ebb58f63a2 MD5 | raw file
  1<?xml version="1.0" encoding="UTF-8"?>
  2<fpdoc-descriptions>
  3  <package name="lcl">
  4    <!--
  5  ====================================================================
  6    PropertyStorage
  7  ====================================================================
  8-->
  9    <module name="PropertyStorage">
 10      <short/>
 11      <descr/>
 12      <!-- unresolved type reference Visibility: default -->
 13      <element name="Classes">
 14        <short/>
 15        <descr/>
 16        <seealso/>
 17      </element>
 18      <!-- unresolved type reference Visibility: default -->
 19      <element name="SysUtils">
 20        <short/>
 21        <descr/>
 22        <seealso/>
 23      </element>
 24      <!-- unresolved type reference Visibility: default -->
 25      <element name="RTLConsts">
 26        <short/>
 27        <descr/>
 28        <seealso/>
 29      </element>
 30<!-- enumeration type Visibility: default -->
 31      <element name="TPlacementOperation">
 32        <short>Enum indicating property save or restore operation.</short>
 33        <descr/>
 34        <seealso/>
 35      </element>
 36      <element name="TPlacementOperation.poSave">
 37        <short>The property is being saved.</short>
 38      </element>
 39      <element name="TPlacementOperation.poRestore">
 40        <short>The property is being restored.</short>
 41      </element>
 42<!-- alias type Visibility: default -->
 43      <element name="TStoredType">
 44        <short>An AnsiString or Variant, holding the property values.</short>
 45        <descr/>
 46        <seealso/>
 47      <notes><note>?</note>
 48        </notes>
 49      </element>
 50<!-- procedure type Visibility: default -->
 51      <element name="TStoredValueEvent">
 52        <short>Type of an TStoredValue.OnSave and OnRestore notification handler.</short>
 53        <descr>Called before a property is saved, after a it has been restored.
 54        </descr>
 55        <seealso/>
 56      </element>
 57      <!-- argument Visibility: default -->
 58      <element name="TStoredValueEvent.Sender">
 59        <short/>
 60      <notes><note>?</note>
 61        </notes>
 62      </element>
 63      <!-- argument Visibility: default -->
 64      <element name="TStoredValueEvent.Value">
 65        <short/>
 66      <notes><note>?</note>
 67        </notes>
 68      </element>
 69<!-- object Visibility: default -->
 70      <element name="TStoredValue">
 71        <short>A key/value pair, representing an property value, with added Save/Restore features.</short>
 72        <descr/>
 73        <errors/>
 74        <seealso/>
 75      </element>
 76      <!-- variable Visibility: private -->
 77      <element name="TStoredValue.FName" link="TStoredValue.Name"/>
 78      <element name="TStoredValue.FValue" link="TStoredValue.Value"/>
 79      <element name="TStoredValue.FKeyString" link="TStoredValue.KeyString"/>
 80      <element name="TStoredValue.FOnSave" link="TStoredValue.OnSave"/>
 81      <element name="TStoredValue.FOnRestore" link="TStoredValue.OnRestore"/>
 82      <!-- function Visibility: private -->
 83      <element name="TStoredValue.IsValueStored" link="TStoredValue.Value"/>
 84      <element name="TStoredValue.IsValueStored.Result"><short/>
 85      </element>
 86      <!-- function Visibility: private -->
 87      <element name="TStoredValue.GetStoredValues" link="TStoredValue.StoredValues"/>
 88      <element name="TStoredValue.GetStoredValues.Result"><short/>
 89      </element>
 90      <!-- function Visibility: protected -->
 91      <element name="TStoredValue.GetDisplayName">
 92        <short>Overridden to return FName/Name.</short>
 93        <descr/>
 94        <errors/>
 95        <seealso/>
 96      </element>
 97      <element name="TStoredValue.GetDisplayName.Result"><short/>
 98      </element>
 99      <!-- procedure Visibility: protected -->
100      <element name="TStoredValue.SetDisplayName" link="TStoredValue.Name"/>
101      <element name="TStoredValue.SetDisplayName.AValue"><short/>
102      </element>
103      <!-- constructor Visibility: public -->
104      <element name="TStoredValue.Create"/>
105      <element name="TStoredValue.Create.ACollection"><short/>
106      </element>
107      <!-- procedure Visibility: public -->
108      <element name="TStoredValue.Assign"/>
109      <element name="TStoredValue.Assign.Source"><short/>
110      </element>
111      <!-- procedure Visibility: public -->
112      <element name="TStoredValue.Clear">
113        <short>Sets Value to the empty string.</short>
114        <descr/>
115        <errors/>
116        <seealso/>
117      </element>
118      <!-- procedure Visibility: public -->
119      <element name="TStoredValue.Save">
120        <short>Saves the value, after invocation of the OnSave handler.
121        </short>
122        <descr/>
123        <errors/>
124        <seealso>
125          <link id="TStoredValue.OnSave"/>
126          <link id="TStoredValue.StoredValues"/>
127        </seealso>
128      </element>
129      <!-- procedure Visibility: public -->
130      <element name="TStoredValue.Restore">
131        <short>Reads the value and notifies the OnRestore handler.</short>
132        <descr/>
133        <errors/>
134        <seealso>
135          <link id="TStoredValue.OnRestore"/>
136          <link id="TStoredValue.StoredValues"/>
137        </seealso>
138      </element>
139      <!-- property Visibility: public -->
140      <element name="TStoredValue.StoredValues">
141        <short>The Collection containing this object.</short>
142        <descr>The collection has a Storage property,
143          used to Save and Restore the value.
144        </descr>
145        <seealso/>
146      </element>
147      <!-- property Visibility: published -->
148      <element name="TStoredValue.Name">
149        <short>The name of the property.</short>
150        <descr/>
151        <seealso/>
152      </element>
153      <!-- property Visibility: published -->
154      <element name="TStoredValue.Value">
155        <short>The value of the property (as String or Variant).</short>
156        <descr/>
157        <seealso/>
158      </element>
159      <!-- property Visibility: published -->
160      <element name="TStoredValue.KeyString">
161        <short>Encryption key, empty for no encryption.</short>
162        <descr/>
163        <seealso/>
164      </element>
165      <!-- property Visibility: published -->
166      <element name="TStoredValue.OnSave">
167        <short>This handler is invoked before the value is stored.</short>
168        <descr/>
169        <seealso/>
170      </element>
171      <!-- property Visibility: published -->
172      <element name="TStoredValue.OnRestore">
173        <short>This handler is invoked after the value has been loaded.</short>
174        <descr/>
175        <seealso/>
176      </element>
177<!-- object Visibility: default -->
178      <element name="TStoredValues">
179        <short>A collection of property name/value pairs.</short>
180        <descr/>
181        <errors/>
182        <seealso/>
183      </element>
184      <!-- variable Visibility: private -->
185      <element name="TStoredValues.FStorage" link="TStoredValues.Storage"/>
186      <!-- function Visibility: private -->
187      <element name="TStoredValues.GetValue" link="TStoredValues.Values"/>
188      <element name="TStoredValues.GetValue.Result"><short/>
189      </element>
190      <element name="TStoredValues.GetValue.AName"><short/>
191      </element>
192      <!-- procedure Visibility: private -->
193      <element name="TStoredValues.SetValue" link="TStoredValues.Values"/>
194      <element name="TStoredValues.SetValue.AName"><short/>
195      </element>
196      <element name="TStoredValues.SetValue.AStoredValue"><short/>
197      </element>
198      <!-- function Visibility: private -->
199      <element name="TStoredValues.GetStoredValue" link="TStoredValues.StoredValue"/>
200      <element name="TStoredValues.GetStoredValue.Result"><short/>
201      </element>
202      <element name="TStoredValues.GetStoredValue.AName"><short/>
203      </element>
204      <!-- procedure Visibility: private -->
205      <element name="TStoredValues.SetStoredValue" link="TStoredValues.StoredValue"/>
206      <element name="TStoredValues.SetStoredValue.AName"><short/>
207      </element>
208      <element name="TStoredValues.SetStoredValue.Value"><short/>
209      </element>
210      <!-- function Visibility: private -->
211      <element name="TStoredValues.GetItem" link="TStoredValues.Items"/>
212      <element name="TStoredValues.GetItem.Result"><short/>
213      </element>
214      <element name="TStoredValues.GetItem.Index"><short/>
215      </element>
216      <!-- procedure Visibility: private -->
217      <element name="TStoredValues.SetItem" link="TStoredValues.Items"/>
218      <element name="TStoredValues.SetItem.Index"><short/>
219      </element>
220      <element name="TStoredValues.SetItem.AStoredValue"><short/>
221      </element>
222      <!-- constructor Visibility: public -->
223      <element name="TStoredValues.Create"/>
224      <element name="TStoredValues.Create.AOwner"><short/>
225      </element>
226      <!-- function Visibility: public -->
227      <element name="TStoredValues.IndexOf">
228        <short>Given the name of a property, returns the index of the Item object.
229        </short>
230        <descr/>
231        <errors/>
232        <seealso>
233        </seealso>
234      </element>
235      <element name="TStoredValues.IndexOf.Result"><short/>
236      </element>
237      <element name="TStoredValues.IndexOf.AName"><short/>
238      </element>
239      <!-- procedure Visibility: public -->
240      <element name="TStoredValues.SaveValues">
241        <short>Saves all Items into Storage.</short>
242        <descr/>
243        <errors/>
244        <seealso>
245          <link id="TStoredValues.Storage"/>
246        </seealso>
247      </element>
248      <!-- procedure Visibility: public -->
249      <element name="TStoredValues.RestoreValues">
250        <short>Loads all existing Items from Storage.
251        </short>
252        <descr>The named Items objects must have been created already.
253        </descr>
254        <errors/>
255        <seealso>
256          <link id="TStoredValues.Storage"/>
257        </seealso>
258      </element>
259      <!-- property Visibility: public -->
260      <element name="TStoredValues.Storage">
261        <short>The virtual storage object, used to Save and Restore the Values.
262        </short>
263        <descr/>
264        <seealso/>
265      </element>
266      <!-- property Visibility: public -->
267      <element name="TStoredValues.Items">
268        <short>The indexed list of all key/value pairs.
269        </short>
270        <descr/>
271        <seealso/>
272      </element>
273      <element name="TStoredValues.Items.Index"><short/>
274      </element>
275      <!-- property Visibility: public -->
276      <element name="TStoredValues.Values">
277        <short>The list of key/value pairs, accessible by their key names.
278        </short>
279        <descr/>
280        <seealso/>
281      </element>
282      <element name="TStoredValues.Values.Name"><short/>
283      </element>
284      <!-- property Visibility: public -->
285      <element name="TStoredValues.StoredValue">
286        <short>Retrieves the value for an given key name.</short>
287        <descr/>
288        <seealso/>
289      </element>
290      <element name="TStoredValues.StoredValue.Name"><short/>
291      </element>
292<!-- object Visibility: default -->
293      <element name="TPropertyStorageLink">
294        <short>Links a storage object to a property collection.
295        </short>
296        <descr>Not very useful by itself, Load/Save depends on installed handlers.
297        </descr>
298        <errors/>
299        <seealso/>
300      </element>
301      <!-- variable Visibility: private -->
302      <element name="TPropertyStorageLink.FStorage" link="TPropertyStorageLink.Storage"/>
303      <element name="TPropertyStorageLink.FOnSave" link="TPropertyStorageLink.OnSave"/>
304      <element name="TPropertyStorageLink.FOnLoad" link="TPropertyStorageLink.OnLoad"/>
305      <!-- function Visibility: private -->
306      <element name="TPropertyStorageLink.GetRootSection" link="TPropertyStorageLink.RootSection"/>
307      <element name="TPropertyStorageLink.GetRootSection.Result"><short/>
308      </element>
309      <!-- procedure Visibility: private -->
310      <element name="TPropertyStorageLink.SetStorage" link="TPropertyStorageLink.Storage"/>
311      <element name="TPropertyStorageLink.SetStorage.Value"><short/>
312      </element>
313      <!-- procedure Visibility: protected -->
314      <element name="TPropertyStorageLink.SaveProperties">
315        <short>Invokes the OnSave handler.
316        </short>
317        <descr/>
318        <errors/>
319        <seealso/>
320      </element>
321      <!-- procedure Visibility: protected -->
322      <element name="TPropertyStorageLink.LoadProperties">
323        <short>Invokes the OnLoad handler.
324        </short>
325        <descr/>
326        <errors/>
327        <seealso/>
328      </element>
329      <!-- destructor Visibility: public -->
330      <element name="TPropertyStorageLink.Destroy"/>
331      <!-- property Visibility: public -->
332      <element name="TPropertyStorageLink.Storage">
333        <short>Refers to the concrete Storage object.
334        </short>
335        <descr/>
336        <seealso/>
337      </element>
338      <!-- property Visibility: public -->
339      <element name="TPropertyStorageLink.RootSection">
340        <short>The path to the root of the Storage object.
341        </short>
342        <descr/>
343        <seealso/>
344      </element>
345      <!-- property Visibility: public -->
346      <element name="TPropertyStorageLink.OnSave">
347        <short>Supply your handler for saving all properties.
348        </short>
349        <descr/>
350        <seealso>
351          <link id="TPropertyStorageLink.SaveProperties"/>
352          <link id="TPropertyStorageLink.OnLoad"/>
353        </seealso>
354      <notes><note>almost unused?</note>
355        </notes>
356      </element>
357      <!-- property Visibility: public -->
358      <element name="TPropertyStorageLink.OnLoad">
359        <short>Supply your handler for loading all properties.
360        </short>
361        <descr/>
362        <seealso>
363          <link id="TPropertyStorageLink.LoadProperties"/>
364          <link id="TPropertyStorageLink.OnSave"/>
365        </seealso>
366      <notes><note>almost unused?</note>
367        </notes>
368      </element>
369<!-- object Visibility: default -->
370      <element name="TCustomPropertyStorage">
371        <short>Provides abstract means to Save/Restore properties.
372        </short>
373        <descr>
374        </descr>
375        <errors/>
376        <seealso/>
377      <notes><note>...?</note><note>describe?</note>
378        </notes>
379      </element>
380      <!-- variable Visibility: private -->
381      <element name="TCustomPropertyStorage.FOnRestoringProperties" link="TCustomPropertyStorage.OnRestoringProperties"/>
382      <element name="TCustomPropertyStorage.FOnSavingProperties" link="TCustomPropertyStorage.OnSavingProperties"/>
383      <element name="TCustomPropertyStorage.FStoredValues" link="TCustomPropertyStorage.StoredValues"/>
384      <element name="TCustomPropertyStorage.FActive" link="TCustomPropertyStorage.Active"/>
385      <!-- variable Visibility: private -->
386      <element name="TCustomPropertyStorage.FLinks">
387        <short>The list of linked property collections</short>
388        <descr/>
389        <seealso/>
390      <notes><note>?</note>
391        </notes>
392      </element>
393      <!-- variable Visibility: private -->
394      <element name="TCustomPropertyStorage.FSaved">
395        <short>True when everything has been saved</short>
396        <descr/>
397        <seealso/>
398      <notes><note>?</note>
399        </notes>
400      </element>
401      <!-- variable Visibility: private -->
402      <element name="TCustomPropertyStorage.FRestored">
403        <short>True when everything has been restored</short>
404        <descr/>
405        <seealso/>
406      <notes><note>?</note>
407        </notes>
408      </element>
409      <!-- variable Visibility: private -->
410      <element name="TCustomPropertyStorage.FOnSaveProperties" link="TCustomPropertyStorage.OnSaveProperties"/>
411      <element name="TCustomPropertyStorage.FOnRestoreProperties" link="TCustomPropertyStorage.OnRestoreProperties"/>
412      <!-- procedure Visibility: private -->
413      <element name="TCustomPropertyStorage.AddLink">
414        <short>Establish a connection to a property collection.
415        </short>
416        <descr/>
417        <errors/>
418        <seealso/>
419      </element>
420      <element name="TCustomPropertyStorage.AddLink.ALink"><short/>
421      </element>
422      <!-- procedure Visibility: private -->
423      <element name="TCustomPropertyStorage.RemoveLink">
424        <short>Drop the connection to a property collection.
425        </short>
426        <descr/>
427        <errors/>
428        <seealso/>
429      </element>
430      <element name="TCustomPropertyStorage.RemoveLink.ALink"><short/>
431      </element>
432      <!-- procedure Visibility: private -->
433      <element name="TCustomPropertyStorage.NotifyLinks">
434        <short>Notifies all connected property collections.</short>
435        <descr>
436        </descr>
437        <errors/>
438        <seealso/>
439      <notes><note>purpose?</note>
440        </notes>
441      </element>
442      <element name="TCustomPropertyStorage.NotifyLinks.Operation"><short/>
443      </element>
444      <!-- procedure Visibility: private -->
445      <element name="TCustomPropertyStorage.SetStoredValues" link="TCustomPropertyStorage.StoredValues"/>
446      <element name="TCustomPropertyStorage.SetStoredValues.Value"><short/>
447      </element>
448      <!-- function Visibility: private -->
449      <element name="TCustomPropertyStorage.GetStoredValue" link="TCustomPropertyStorage.StoredValue"/>
450      <element name="TCustomPropertyStorage.GetStoredValue.Result"><short/>
451      </element>
452      <element name="TCustomPropertyStorage.GetStoredValue.AName"><short/>
453      </element>
454      <!-- procedure Visibility: private -->
455      <element name="TCustomPropertyStorage.SetStoredValue" link="TCustomPropertyStorage.StoredValue"/>
456      <element name="TCustomPropertyStorage.SetStoredValue.AName"><short/>
457      </element>
458      <element name="TCustomPropertyStorage.SetStoredValue.Value"><short/>
459      </element>
460      <!-- function Visibility: protected -->
461      <element name="TCustomPropertyStorage.GetRoot" link="TCustomPropertyStorage.Root"/>
462      <element name="TCustomPropertyStorage.GetRoot.Result"><short/>
463      </element>
464      <!-- function Visibility: protected -->
465      <element name="TCustomPropertyStorage.RootSection">
466        <short>Constructs the path name to this section, from the Owners of the Root object.
467        </short>
468        <descr/>
469        <errors/>
470        <seealso/>
471      </element>
472      <element name="TCustomPropertyStorage.RootSection.Result"><short/>
473      </element>
474      <!-- procedure Visibility: protected -->
475      <element name="TCustomPropertyStorage.SaveProperties">
476        <short>Saves all linked property collections</short>
477        <descr/>
478        <errors/>
479        <seealso/>
480      <notes><note>?</note>
481        </notes>
482      </element>
483      <!-- procedure Visibility: protected -->
484      <element name="TCustomPropertyStorage.RestoreProperties">
485        <short>Restores all linked property collections</short>
486        <descr/>
487        <errors/>
488        <seealso/>
489      <notes><note>?</note>
490        </notes>
491      </element>
492      <!-- procedure Visibility: protected -->
493      <element name="TCustomPropertyStorage.GetPropertyList">
494        <short>Builds a list of all linked propery collections</short>
495        <descr/>
496        <errors/>
497        <seealso/>
498      <notes><note>?</note>
499        </notes>
500      </element>
501      <element name="TCustomPropertyStorage.GetPropertyList.List"><short/>
502      </element>
503      <!-- procedure Visibility: protected -->
504      <element name="TCustomPropertyStorage.FinishPropertyList">
505        <short>set Objects (i.e. the component of each property)</short>
506        <descr>Reads the Strings[] in the list,
507          retrieves and stores the associated Root or Component object in Objects[].
508        </descr>
509        <errors/>
510        <seealso/>
511      <notes><note>?</note>
512        </notes>
513      </element>
514      <element name="TCustomPropertyStorage.FinishPropertyList.List"><short/>
515      </element>
516      <!-- function Visibility: protected -->
517      <element name="TCustomPropertyStorage.DoReadInteger">
518        <short>Reads an integer value, stored as a string.
519        </short>
520        <descr/>
521        <errors/>
522        <seealso/>
523      </element>
524      <element name="TCustomPropertyStorage.DoReadInteger.Result"><short/>
525      </element>
526      <element name="TCustomPropertyStorage.DoReadInteger.Section"><short/>
527      </element>
528      <element name="TCustomPropertyStorage.DoReadInteger.Ident"><short/>
529      </element>
530      <element name="TCustomPropertyStorage.DoReadInteger.DefaultValue"><short/>
531      </element>
532      <!-- function Visibility: protected -->
533      <element name="TCustomPropertyStorage.DoReadString">
534        <short>Default OnReadString handler, must be overridden!
535        </short>
536        <descr>
537        </descr>
538        <errors/>
539        <seealso/>
540      <notes><note>How to implement an OnReadString handler?</note><note>template where?</note>
541        </notes>
542      </element>
543      <element name="TCustomPropertyStorage.DoReadString.Result">
544        <short>The previously stored string.</short>
545      </element>
546      <element name="TCustomPropertyStorage.DoReadString.Section">
547        <short/>
548      <notes><note>?</note>
549        </notes>
550      </element>
551      <element name="TCustomPropertyStorage.DoReadString.Ident">
552        <short/>
553      <notes><note>?</note>
554        </notes>
555      </element>
556      <element name="TCustomPropertyStorage.DoReadString.DefaultValue">
557        <short>The default value, when no string was stored.</short>
558      </element>
559      <!-- procedure Visibility: protected -->
560      <element name="TCustomPropertyStorage.DoWriteString">
561        <short>Default OnWriteString handler, must be overridden!
562        </short>
563        <descr>
564        </descr>
565        <errors/>
566        <seealso/>
567      <notes><note>How to implement an OnWriteString handler?</note><note>template where?</note>
568        </notes>
569      </element>
570      <element name="TCustomPropertyStorage.DoWriteString.Section">
571        <short>The name of the section.</short>
572      </element>
573      <element name="TCustomPropertyStorage.DoWriteString.Ident">
574        <short>The name (key) of the property.</short>
575      </element>
576      <element name="TCustomPropertyStorage.DoWriteString.Value">
577        <short>The value string to store.</short>
578      </element>
579      <!-- procedure Visibility: protected -->
580      <element name="TCustomPropertyStorage.DoWriteInteger">
581        <short>Writes an Integer value as a String.
582        </short>
583        <descr/>
584        <errors/>
585        <seealso/>
586      </element>
587      <element name="TCustomPropertyStorage.DoWriteInteger.Section"><short/>
588      </element>
589      <element name="TCustomPropertyStorage.DoWriteInteger.Ident"><short/>
590      </element>
591      <element name="TCustomPropertyStorage.DoWriteInteger.Value"><short/>
592      </element>
593      <!-- procedure Visibility: protected -->
594      <element name="TCustomPropertyStorage.DoEraseSections">
595        <short/>
596        <descr>Must be overridden
597        </descr>
598        <errors/>
599        <seealso/>
600      <notes><note>?</note><note>how?</note>
601        </notes>
602      </element>
603      <element name="TCustomPropertyStorage.DoEraseSections.ARootSection"><short/>
604      </element>
605      <!-- constructor Visibility: public -->
606      <element name="TCustomPropertyStorage.Create"/>
607      <element name="TCustomPropertyStorage.Create.AOwner"><short/>
608      </element>
609      <!-- destructor Visibility: public -->
610      <element name="TCustomPropertyStorage.Destroy"/>
611      <!-- procedure Visibility: public -->
612      <element name="TCustomPropertyStorage.Save">
613        <short>Saves all linked property collections</short>
614        <descr>
615          <p>
616            Uses SaveProperties and StoredValues.SaveValues to do the actual work.
617            At least one of these should be implemented.
618          </p><p>
619            All linked property collections are notified,
620            when everything has been stored, or to actually store their values.
621          </p><p>
622            The OnSavingProperties handler is invoked before the properties are stored,
623            OnSaveProperties afterwards.
624          </p>
625        </descr>
626        <errors/>
627        <seealso>
628          <link id="TCustomPropertyStorage.SaveProperties"/>
629          <link id="TCustomPropertyStorage.OnSaveProperties"/>
630          <link id="TCustomPropertyStorage.OnSavingProperties"/>
631          <link id="TCustomPropertyStorage.StoredValues"/>
632          <link id="TCustomPropertyStorage.NotifyLinks"/>
633        </seealso>
634      <notes><note>?</note><note>or?</note><note>supply links?</note><note>???</note>
635        </notes>
636      </element>
637      <!-- procedure Visibility: public -->
638      <element name="TCustomPropertyStorage.Restore">
639        <short>Restores all linked property collections</short>
640        <descr>
641          <p>
642            Uses RestoreProperties and StoredValues.RestoreValues to do the actual work.
643            At least one of these should be implemented.
644          </p><p>
645            All linked property collections are notified,
646            when everything has been restored, or to actually restore the values.
647          </p><p>
648            The OnRestoringProperties handler is invoked before the properties are restored,
649            OnRestoreProperties afterwards.
650          </p>
651        </descr>
652        <errors/>
653        <seealso>
654          <link id="TCustomPropertyStorage.RestoreProperties"/>
655          <link id="TCustomPropertyStorage.OnRestoreProperties"/>
656          <link id="TCustomPropertyStorage.OnRestoringProperties"/>
657          <link id="TCustomPropertyStorage.StoredValues"/>
658          <link id="TCustomPropertyStorage.NotifyLinks"/>
659        </seealso>
660      <notes><note>?</note><note>or?</note><note>supply links?</note><note>???</note>
661        </notes>
662      </element>
663      <!-- procedure Visibility: protected -->
664      <element name="TCustomPropertyStorage.StorageNeeded">
665        <short>Override this to provide a storage object</short>
666        <descr/>
667        <errors/>
668        <seealso/>
669      <notes><note>???</note>
670        </notes>
671      </element>
672      <element name="TCustomPropertyStorage.StorageNeeded.ReadOnly"><short/>
673      </element>
674      <!-- procedure Visibility: protected -->
675      <element name="TCustomPropertyStorage.FreeStorage">
676        <short>Override this method to release your storage.</short>
677        <descr/>
678        <errors/>
679        <seealso/>
680      <notes><note>???</note>
681        </notes>
682      </element>
683      <!-- function Visibility: public -->
684      <element name="TCustomPropertyStorage.ReadBoolean">
685        <short>Reads an Boolean value, stored as a string.
686        </short>
687        <descr>
688        </descr>
689        <errors>
690        </errors>
691        <seealso>
692        </seealso>
693      </element>
694      <element name="TCustomPropertyStorage.ReadBoolean.Result">
695        <short/>
696      </element>
697      <element name="TCustomPropertyStorage.ReadBoolean.Ident">
698        <short/>
699      </element>
700      <element name="TCustomPropertyStorage.ReadBoolean.DefaultValue">
701        <short/>
702      </element>
703      <!-- function Visibility: public -->
704      <element name="TCustomPropertyStorage.ReadString">
705        <short>Reads an String value from the RootSection.
706        </short>
707        <descr/>
708        <errors/>
709        <seealso/>
710      </element>
711      <!-- function result Visibility: default -->
712      <element name="TCustomPropertyStorage.ReadString.Result"><short/>
713      </element>
714      <element name="TCustomPropertyStorage.ReadString.Ident"><short/>
715      </element>
716      <element name="TCustomPropertyStorage.ReadString.DefaultValue"><short/>
717      </element>
718      <!-- function Visibility: public -->
719      <element name="TCustomPropertyStorage.ReadInteger">
720        <short>Reads an integer value, stored as a string, from the RootSection.
721        </short>
722        <descr/>
723        <errors/>
724        <seealso/>
725      </element>
726      <element name="TCustomPropertyStorage.ReadInteger.Result"><short/>
727      </element>
728      <element name="TCustomPropertyStorage.ReadInteger.Ident"><short/>
729      </element>
730      <element name="TCustomPropertyStorage.ReadInteger.DefaultValue"><short/>
731      </element>
732      <!-- procedure Visibility: public -->
733      <element name="TCustomPropertyStorage.ReadRect">
734        <short>Reads an TRect record, stored as a string.
735        </short>
736        <descr>
737        </descr>
738        <errors>
739        </errors>
740        <seealso>
741        </seealso>
742      </element>
743      <element name="TCustomPropertyStorage.ReadRect.Ident">
744        <short/>
745      </element>
746      <element name="TCustomPropertyStorage.ReadRect.ARect">
747        <short/>
748      </element>
749      <element name="TCustomPropertyStorage.ReadRect.Default">
750        <short/>
751      </element>
752      <!-- procedure Visibility: public -->
753      <element name="TCustomPropertyStorage.ReadStrings">
754        <short>Reads a list of strings, stored with a Count value.
755        </short>
756        <descr>
757        </descr>
758        <errors>
759        </errors>
760        <seealso>
761        </seealso>
762      </element>
763      <element name="TCustomPropertyStorage.ReadStrings.Ident">
764        <short>The name of the list property.
765        </short>
766      </element>
767      <element name="TCustomPropertyStorage.ReadStrings.List">
768        <short>The list to which the strings are added.
769        </short>
770      </element>
771      <element name="TCustomPropertyStorage.ReadStrings.DefaultList">
772        <short>A list of default values, used when nothing was stored yet.
773        </short>
774      </element>
775      <!-- procedure Visibility: public -->
776      <element name="TCustomPropertyStorage.WriteString">
777        <short>Writes an string into the RootSection.</short>
778        <descr/>
779        <errors/>
780        <seealso/>
781      </element>
782      <element name="TCustomPropertyStorage.WriteString.Ident"><short/>
783      </element>
784      <element name="TCustomPropertyStorage.WriteString.Value"><short/>
785      </element>
786      <!-- procedure Visibility: public -->
787      <element name="TCustomPropertyStorage.WriteInteger">
788        <short>Writes an integer into the RootSection.</short>
789        <descr/>
790        <errors/>
791        <seealso/>
792      </element>
793      <element name="TCustomPropertyStorage.WriteInteger.Ident"><short/>
794      </element>
795      <element name="TCustomPropertyStorage.WriteInteger.Value"><short/>
796      </element>
797      <!-- procedure Visibility: public -->
798      <element name="TCustomPropertyStorage.WriteBoolean">
799        <short>Writes an boolean value into the RootSection.</short>
800        <descr>
801        </descr>
802        <errors>
803        </errors>
804        <seealso>
805        </seealso>
806      </element>
807      <element name="TCustomPropertyStorage.WriteBoolean.Ident">
808        <short/>
809      </element>
810      <element name="TCustomPropertyStorage.WriteBoolean.Value">
811        <short/>
812      </element>
813      <!-- procedure Visibility: public -->
814      <element name="TCustomPropertyStorage.WriteRect">
815        <short>Writes an TRect record into the RootSection.</short>
816        <descr>
817        </descr>
818        <errors>
819        </errors>
820        <seealso>
821        </seealso>
822      </element>
823      <element name="TCustomPropertyStorage.WriteRect.Ident">
824        <short/>
825      </element>
826      <element name="TCustomPropertyStorage.WriteRect.Value">
827        <short/>
828      </element>
829      <!-- procedure Visibility: public -->
830      <element name="TCustomPropertyStorage.WriteStrings">
831        <short>Writes a list of strings into the RootSection.</short>
832        <descr>
833        </descr>
834        <errors>
835        </errors>
836        <seealso>
837        </seealso>
838      </element>
839      <element name="TCustomPropertyStorage.WriteStrings.Ident">
840        <short/>
841      </element>
842      <element name="TCustomPropertyStorage.WriteStrings.List">
843        <short/>
844      </element>
845      <!-- procedure Visibility: public -->
846      <element name="TCustomPropertyStorage.EraseSections">
847        <short/>
848        <descr/>
849        <errors/>
850        <seealso>
851          <link id="TCustomPropertyStorage.DoEraseSections"/>
852        </seealso>
853      <notes><note>?</note>
854        </notes>
855      </element>
856      <!-- property Visibility: public -->
857      <element name="TCustomPropertyStorage.StoredValue">
858        <short/>
859        <descr/>
860        <seealso/>
861      <notes><note>?</note>
862        </notes>
863      </element>
864      <element name="TCustomPropertyStorage.StoredValue.AName"><short/>
865      </element>
866      <!-- property Visibility: public -->
867      <element name="TCustomPropertyStorage.Root">
868        <short/>
869        <descr/>
870        <seealso/>
871      <notes><note>the Owner ?</note>
872        </notes>
873      </element>
874      <!-- property Visibility: public -->
875      <element name="TCustomPropertyStorage.Active">
876        <short/>
877        <descr/>
878        <seealso/>
879      <notes><note>?</note>
880        </notes>
881      </element>
882      <!-- property Visibility: public -->
883      <element name="TCustomPropertyStorage.StoredValues">
884        <short/>
885        <descr/>
886        <seealso/>
887      <notes><note>?</note>
888        </notes>
889      </element>
890      <!-- property Visibility: public -->
891      <element name="TCustomPropertyStorage.OnSavingProperties">
892        <short>Handler called at the begin of Save.</short>
893        <descr>
894        </descr>
895        <seealso>
896        </seealso>
897      <notes><note>purpose?</note>
898        </notes>
899      </element>
900      <!-- property Visibility: public -->
901      <element name="TCustomPropertyStorage.OnSaveProperties">
902        <short>Handler called at the end of Save.</short>
903        <descr/>
904        <seealso/>
905      <notes><note>purpose?</note>
906        </notes>
907      </element>
908      <!-- property Visibility: public -->
909      <element name="TCustomPropertyStorage.OnRestoringProperties">
910        <short>Handler called at the begin of Restore.</short>
911        <descr>
912        </descr>
913        <seealso>
914        </seealso>
915      <notes><note>purpose?</note>
916        </notes>
917      </element>
918      <!-- property Visibility: public -->
919      <element name="TCustomPropertyStorage.OnRestoreProperties">
920        <short>Handler called at the end of Restore.</short>
921        <descr/>
922        <seealso/>
923      <notes><note>purpose?</note>
924        </notes>
925      </element>
926    </module>
927    <!-- PropertyStorage -->
928  </package>
929</fpdoc-descriptions>