mirror of
https://gitlab.com/freepascal.org/lazarus/lazarus.git
synced 2025-11-01 22:19:39 +01:00
Docs: Documentation for [INI|XML|JSON]PropStorage units. Issue #31407, patch from Gustavo Carreno.
git-svn-id: trunk@54186 -
This commit is contained in:
juha
parent
4a89297c1e
commit
82a7e6d0c7
@ -1,378 +1,326 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<fpdoc-descriptions>
|
||||
<package name="lcl">
|
||||
<package name="lcl">
|
||||
|
||||
<!--
|
||||
====================================================================
|
||||
IniPropStorage
|
||||
====================================================================
|
||||
-->
|
||||
<!--
|
||||
====================================================================
|
||||
IniPropStorage
|
||||
====================================================================
|
||||
-->
|
||||
|
||||
<module name="IniPropStorage">
|
||||
<short/>
|
||||
<descr>
|
||||
</descr>
|
||||
<module name="IniPropStorage">
|
||||
<short>Contains a component that stores Form Session Properties in INI format.</short>
|
||||
<descr>
|
||||
<p>In this unit you can find an implementation of a name/value pair storage container in INI 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.IniPropStorage.TINIPropStorage.INIFileName">TINIPropStorage.INIFileName</link>.</p>
|
||||
</descr>
|
||||
|
||||
<!-- unresolved type reference Visibility: default -->
|
||||
<element name="Classes">
|
||||
<short/>
|
||||
<descr>
|
||||
</descr>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- unresolved type reference Visibility: default -->
|
||||
<element name="Classes">
|
||||
<short />
|
||||
<descr />
|
||||
<seealso />
|
||||
</element> <!-- Classes -->
|
||||
|
||||
<!-- unresolved type reference Visibility: default -->
|
||||
<element name="SysUtils">
|
||||
<short/>
|
||||
<descr>
|
||||
</descr>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- unresolved type reference Visibility: default -->
|
||||
<element name="SysUtils">
|
||||
<short />
|
||||
<descr />
|
||||
<seealso />
|
||||
</element> <!-- SysUtils -->
|
||||
|
||||
<!-- unresolved type reference Visibility: default -->
|
||||
<element name="Forms">
|
||||
<short/>
|
||||
<descr>
|
||||
</descr>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- unresolved type reference Visibility: default -->
|
||||
<element name="IniFiles">
|
||||
<short />
|
||||
<descr />
|
||||
<seealso />
|
||||
</element> <!-- IniFiles -->
|
||||
|
||||
<!-- unresolved type reference Visibility: default -->
|
||||
<element name="IniFiles">
|
||||
<short/>
|
||||
<descr>
|
||||
</descr>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- unresolved type reference Visibility: default -->
|
||||
<element name="LazUTF8">
|
||||
<short />
|
||||
<descr />
|
||||
<seealso />
|
||||
</element> <!-- LazUTF8 -->
|
||||
|
||||
<!-- unresolved type reference Visibility: default -->
|
||||
<element name="PropertyStorage">
|
||||
<short/>
|
||||
<descr>
|
||||
</descr>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- unresolved type reference Visibility: default -->
|
||||
<element name="Forms">
|
||||
<short />
|
||||
<descr />
|
||||
<seealso />
|
||||
</element> <!-- Forms -->
|
||||
|
||||
<!-- "class of" type Visibility: default -->
|
||||
<element name="TIniFileClass">
|
||||
<short/>
|
||||
<descr>
|
||||
</descr>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- "class of" type Visibility: default -->
|
||||
<element name="TIniFileClass">
|
||||
<short>Class of <link id="#fcl.IniFiles.TCustomIniFile">TCustomIniFile</link></short>
|
||||
<descr />
|
||||
<seealso />
|
||||
</element> <!-- "class of" TIniFileClass -->
|
||||
|
||||
<!-- object Visibility: default -->
|
||||
<element name="TCustomIniPropStorage">
|
||||
<short/>
|
||||
<descr>
|
||||
</descr>
|
||||
<errors>
|
||||
</errors>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- object Visibility: default -->
|
||||
<element name="TCustomIniPropStorage">
|
||||
<short>Implements the base class for the INI Form's Session Properties.</short>
|
||||
<descr />
|
||||
<errors />
|
||||
<seealso />
|
||||
</element> <!-- object TCustomIniPropStorage -->
|
||||
|
||||
<!-- variable Visibility: private -->
|
||||
<element name="TCustomIniPropStorage.FCount">
|
||||
<short/>
|
||||
<descr>
|
||||
</descr>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- variable Visibility: private -->
|
||||
<element name="TCustomIniPropStorage.FCount">
|
||||
<short />
|
||||
<descr />
|
||||
<seealso />
|
||||
</element> <!-- variable TCustomIniPropStorage.FCount -->
|
||||
|
||||
<!-- variable Visibility: private -->
|
||||
<element name="TCustomIniPropStorage.FReadOnly">
|
||||
<short/>
|
||||
<descr>
|
||||
</descr>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- variable Visibility: private -->
|
||||
<element name="TCustomIniPropStorage.FReadOnly">
|
||||
<short />
|
||||
<descr />
|
||||
<seealso />
|
||||
</element> <!-- variable TCustomIniPropStorage.FReadOnly -->
|
||||
|
||||
<!-- variable Visibility: private -->
|
||||
<element name="TCustomIniPropStorage.FIniFile">
|
||||
<short/>
|
||||
<descr>
|
||||
</descr>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- variable Visibility: private -->
|
||||
<element name="TCustomIniPropStorage.FIniFile">
|
||||
<short />
|
||||
<descr />
|
||||
<seealso />
|
||||
</element> <!-- variable TCustomIniPropStorage.FIniFile -->
|
||||
|
||||
<!-- variable Visibility: private -->
|
||||
<element name="TCustomIniPropStorage.FIniFileName">
|
||||
<short/>
|
||||
<descr>
|
||||
</descr>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- variable Visibility: private -->
|
||||
<element name="TCustomIniPropStorage.FIniFileName">
|
||||
<short />
|
||||
<descr />
|
||||
<seealso />
|
||||
</element> <!-- variable TCustomIniPropStorage.FIniFileName -->
|
||||
|
||||
<!-- variable Visibility: private -->
|
||||
<element name="TCustomIniPropStorage.FIniSection">
|
||||
<short/>
|
||||
<descr>
|
||||
</descr>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- variable Visibility: private -->
|
||||
<element name="TCustomIniPropStorage.FIniSection">
|
||||
<short />
|
||||
<descr />
|
||||
<seealso />
|
||||
</element> <!-- variable TCustomIniPropStorage.FIniSection -->
|
||||
|
||||
<!-- function Visibility: protected -->
|
||||
<element name="TCustomIniPropStorage.IniFileClass">
|
||||
<short/>
|
||||
<descr>
|
||||
</descr>
|
||||
<errors>
|
||||
</errors>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- function Visibility: protected -->
|
||||
<element name="TCustomIniPropStorage.IniFileClass">
|
||||
<short>Returns the class <link id="#fcl.IniFiles.TIniFile">TIniFile</link></short>
|
||||
<descr />
|
||||
<errors />
|
||||
<seealso />
|
||||
</element> <!-- function TCustomIniPropStorage.IniFileClass -->
|
||||
|
||||
<!-- function result Visibility: default -->
|
||||
<element name="TCustomIniPropStorage.IniFileClass.Result">
|
||||
<short/>
|
||||
</element>
|
||||
<!-- function result Visibility: default -->
|
||||
<element name="TCustomIniPropStorage.IniFileClass.Result">
|
||||
<short>The class <link id="#fcl.IniFiles.TIniFile">TIniFile</link></short>
|
||||
</element> <!-- function result TCustomIniPropStorage.IniFileClass.Result -->
|
||||
|
||||
<!-- procedure Visibility: protected -->
|
||||
<element name="TCustomIniPropStorage.StorageNeeded">
|
||||
<short/>
|
||||
<descr>
|
||||
</descr>
|
||||
<errors>
|
||||
</errors>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- function Visibility: protected -->
|
||||
<element name="TCustomIniPropStorage.GetIniFileName">
|
||||
<short>Getter for the property <link id="#LCL.IniPropStorage.TCustomIniPropStorage.IniFileName">TCustomIniPropStorage.IniFileName</link>.</short>
|
||||
<descr />
|
||||
<errors />
|
||||
<seealso />
|
||||
</element> <!-- function TCustomIniPropStorage.GetIniFileName -->
|
||||
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="TCustomIniPropStorage.StorageNeeded.ReadOnly">
|
||||
<short/>
|
||||
</element>
|
||||
<!-- function result Visibility: default -->
|
||||
<element name="TCustomIniPropStorage.GetIniFileName.Result">
|
||||
<short>The current value of the property <link id="#LCL.IniPropStorage.TCustomIniPropStorage.IniFileName">TCustomIniPropStorage.IniFileName</link>.</short>
|
||||
</element> <!-- function result TCustomIniPropStorage.GetIniFileName.Result -->
|
||||
|
||||
<!-- procedure Visibility: protected -->
|
||||
<element name="TCustomIniPropStorage.FreeStorage">
|
||||
<short/>
|
||||
<descr>
|
||||
</descr>
|
||||
<errors>
|
||||
</errors>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- function Visibility: protected -->
|
||||
<element name="TCustomIniPropStorage.RootSection">
|
||||
<short>Returns the name of the RootSection.</short>
|
||||
<descr />
|
||||
<errors />
|
||||
<seealso />
|
||||
</element> <!-- function TCustomIniPropStorage.RootSection -->
|
||||
|
||||
<!-- function Visibility: protected -->
|
||||
<element name="TCustomIniPropStorage.GetIniFileName">
|
||||
<short/>
|
||||
<descr>
|
||||
</descr>
|
||||
<errors>
|
||||
</errors>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- function result Visibility: default -->
|
||||
<element name="TCustomIniPropStorage.RootSection.Result">
|
||||
<short>The current value of RootSection.</short>
|
||||
</element> <!-- function result TCustomIniPropStorage.RootSection.Result -->
|
||||
|
||||
<!-- function result Visibility: default -->
|
||||
<element name="TCustomIniPropStorage.GetIniFileName.Result">
|
||||
<short/>
|
||||
</element>
|
||||
<!-- property Visibility: protected -->
|
||||
<element name="TCustomIniPropStorage.IniFile">
|
||||
<short>Property to access the <link id="#fcl.IniFiles.TCustomIniFile">TCustomIniFile</link> instance.</short>
|
||||
<descr />
|
||||
<seealso />
|
||||
</element> <!-- property TCustomIniPropStorage.IniFile -->
|
||||
|
||||
<!-- function Visibility: protected -->
|
||||
<element name="TCustomIniPropStorage.RootSection">
|
||||
<short/>
|
||||
<descr>
|
||||
</descr>
|
||||
<errors>
|
||||
</errors>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- procedure Visibility: public -->
|
||||
<element name="TCustomIniPropStorage.StorageNeeded">
|
||||
<short>Aks the underlying storage object for an entry</short>
|
||||
<descr />
|
||||
<errors />
|
||||
<seealso />
|
||||
</element> <!-- procedure TCustomIniPropStorage.StorageNeeded -->
|
||||
|
||||
<!-- function result Visibility: default -->
|
||||
<element name="TCustomIniPropStorage.RootSection.Result">
|
||||
<short/>
|
||||
</element>
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="TCustomIniPropStorage.StorageNeeded.ReadOnly">
|
||||
<short>If the item is read-only.</short>
|
||||
</element> <!-- argument TCustomIniPropStorage.StorageNeeded.ReadOnly -->
|
||||
|
||||
<!-- property Visibility: protected -->
|
||||
<element name="TCustomIniPropStorage.IniFile">
|
||||
<short/>
|
||||
<descr>
|
||||
</descr>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- procedure Visibility: public -->
|
||||
<element name="TCustomIniPropStorage.FreeStorage">
|
||||
<short>Frees an entry from the underlying storage object.</short>
|
||||
<descr />
|
||||
<errors />
|
||||
<seealso />
|
||||
</element> <!-- procedure TCustomIniPropStorage.FreeStorage -->
|
||||
|
||||
<!-- function Visibility: public -->
|
||||
<element name="TCustomIniPropStorage.DoReadString">
|
||||
<short/>
|
||||
<descr>
|
||||
</descr>
|
||||
<errors>
|
||||
</errors>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- function Visibility: public -->
|
||||
<element name="TCustomIniPropStorage.DoReadString">
|
||||
<short>Implements the actual reading of a value from the underlying storage container.</short>
|
||||
<descr />
|
||||
<errors />
|
||||
<seealso />
|
||||
</element> <!-- function TCustomIniPropStorage.DoReadString -->
|
||||
|
||||
<!-- function result Visibility: default -->
|
||||
<element name="TCustomIniPropStorage.DoReadString.Result">
|
||||
<short/>
|
||||
</element>
|
||||
<!-- function result Visibility: default -->
|
||||
<element name="TCustomIniPropStorage.DoReadString.Result">
|
||||
<short>The value of the section/ident requested.</short>
|
||||
</element> <!-- function result TCustomIniPropStorage.DoReadString.Result -->
|
||||
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="TCustomIniPropStorage.DoReadString.Section">
|
||||
<short/>
|
||||
</element>
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="TCustomIniPropStorage.DoReadString.Section">
|
||||
<short>The section to be read.</short>
|
||||
</element> <!-- argument TCustomIniPropStorage.DoReadString.Section -->
|
||||
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="TCustomIniPropStorage.DoReadString.Ident">
|
||||
<short/>
|
||||
</element>
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="TCustomIniPropStorage.DoReadString.Ident">
|
||||
<short>The ident to be read.</short>
|
||||
</element> <!-- argument TCustomIniPropStorage.DoReadString.Ident -->
|
||||
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="TCustomIniPropStorage.DoReadString.Default">
|
||||
<short/>
|
||||
</element>
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="TCustomIniPropStorage.DoReadString.Default">
|
||||
<short>If has no value then return this as default.</short>
|
||||
</element> <!-- argument TCustomIniPropStorage.DoReadString.Default -->
|
||||
|
||||
<!-- procedure Visibility: public -->
|
||||
<element name="TCustomIniPropStorage.DoWriteString">
|
||||
<short/>
|
||||
<descr>
|
||||
</descr>
|
||||
<errors>
|
||||
</errors>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- procedure Visibility: public -->
|
||||
<element name="TCustomIniPropStorage.DoWriteString">
|
||||
<short>Implements the actual writing of a value from the underlying storage container.</short>
|
||||
<descr />
|
||||
<errors />
|
||||
<seealso />
|
||||
</element> <!-- procedure TCustomIniPropStorage.DoWriteString -->
|
||||
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="TCustomIniPropStorage.DoWriteString.Section">
|
||||
<short/>
|
||||
</element>
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="TCustomIniPropStorage.DoWriteString.Section">
|
||||
<short>The section to be written.</short>
|
||||
</element> <!-- argument TCustomIniPropStorage.DoWriteString.Section -->
|
||||
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="TCustomIniPropStorage.DoWriteString.Ident">
|
||||
<short/>
|
||||
</element>
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="TCustomIniPropStorage.DoWriteString.Ident">
|
||||
<short>The ident to be written.</short>
|
||||
</element> <!-- argument TCustomIniPropStorage.DoWriteString.Ident -->
|
||||
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="TCustomIniPropStorage.DoWriteString.Value">
|
||||
<short/>
|
||||
</element>
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="TCustomIniPropStorage.DoWriteString.Value">
|
||||
<short>The value to be written.</short>
|
||||
</element> <!-- argument TCustomIniPropStorage.DoWriteString.Value -->
|
||||
|
||||
<!-- procedure Visibility: public -->
|
||||
<element name="TCustomIniPropStorage.DoEraseSections">
|
||||
<short/>
|
||||
<descr>
|
||||
</descr>
|
||||
<errors>
|
||||
</errors>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- procedure Visibility: public -->
|
||||
<element name="TCustomIniPropStorage.DoEraseSections">
|
||||
<short>Erases a section from the underlying storage container.</short>
|
||||
<descr />
|
||||
<errors />
|
||||
<seealso />
|
||||
</element> <!-- procedure TCustomIniPropStorage.DoEraseSections -->
|
||||
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="TCustomIniPropStorage.DoEraseSections.ARootSection">
|
||||
<short/>
|
||||
</element>
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="TCustomIniPropStorage.DoEraseSections.ARootSection">
|
||||
<short>The path to the section that will be erased.</short>
|
||||
</element> <!-- argument TCustomIniPropStorage.DoEraseSections.ARootSection -->
|
||||
|
||||
<!-- property Visibility: public -->
|
||||
<element name="TCustomIniPropStorage.IniFileName">
|
||||
<short/>
|
||||
<descr>
|
||||
</descr>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- property Visibility: public -->
|
||||
<element name="TCustomIniPropStorage.IniFileName">
|
||||
<short>Name of the file where the property data is saved in INI format.</short>
|
||||
<descr />
|
||||
<seealso />
|
||||
</element> <!-- property TCustomIniPropStorage.IniFileName -->
|
||||
|
||||
<!-- property Visibility: public -->
|
||||
<element name="TCustomIniPropStorage.IniSection">
|
||||
<short/>
|
||||
<descr>
|
||||
</descr>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- property Visibility: public -->
|
||||
<element name="TCustomIniPropStorage.IniSection">
|
||||
<short>The section on the INI file where values are to be kept.</short>
|
||||
<descr />
|
||||
<seealso />
|
||||
</element> <!-- property TCustomIniPropStorage.IniSection -->
|
||||
|
||||
<!-- object Visibility: default -->
|
||||
<element name="TIniPropStorage">
|
||||
<short/>
|
||||
<descr>
|
||||
</descr>
|
||||
<errors>
|
||||
</errors>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- object Visibility: default -->
|
||||
<element name="TIniPropStorage">
|
||||
<short>Implements the final class for the INI Form Session Properties storage.</short>
|
||||
<descr />
|
||||
<errors />
|
||||
<seealso>
|
||||
<link id="#LCL.Forms.TForm">TForm.SessionProperties</link>
|
||||
<link id="#LCL.JSONPropStorage.TJSONPropStorage">TJSONPropStorage</link>
|
||||
<link id="#LCL.XMLPropStorage.TXMLPropStorage">TXMLPropStorage</link>
|
||||
</seealso>
|
||||
</element> <!-- object TIniPropStorage -->
|
||||
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TIniPropStorage.StoredValues">
|
||||
<short/>
|
||||
<descr>
|
||||
</descr>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TIniPropStorage.StoredValues" link="#LCL.PropertyStorage.TCustomPropertyStorage.StoredValues">
|
||||
<short />
|
||||
<descr />
|
||||
<seealso />
|
||||
</element> <!-- property TIniPropStorage.StoredValues -->
|
||||
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TIniPropStorage.IniFileName">
|
||||
<short>Name of the file where the property data is saved in INI-format.</short>
|
||||
<descr>
|
||||
</descr>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TIniPropStorage.IniFileName" link="#LCL.IniPropStorage.TCustomIniPropStorage.IniFileName">
|
||||
<short />
|
||||
<descr />
|
||||
<seealso />
|
||||
</element> <!-- property TIniPropStorage.IniFileName -->
|
||||
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TIniPropStorage.IniSection">
|
||||
<short/>
|
||||
<descr>
|
||||
</descr>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TIniPropStorage.IniSection" link="#LCL.IniPropStorage.TCustomIniPropStorage.IniSection">
|
||||
<short />
|
||||
<descr />
|
||||
<seealso />
|
||||
</element> <!-- property TIniPropStorage.IniSection -->
|
||||
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TIniPropStorage.Active">
|
||||
<short/>
|
||||
<descr>
|
||||
</descr>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TIniPropStorage.Active" link="#LCL.PropertyStorage.TCustomPropertyStorage.Active">
|
||||
<short />
|
||||
<descr />
|
||||
<seealso />
|
||||
</element> <!-- property TIniPropStorage.Active -->
|
||||
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TIniPropStorage.OnSaveProperties">
|
||||
<short/>
|
||||
<descr>
|
||||
</descr>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TIniPropStorage.OnSavingProperties" link="#LCL.PropertyStorage.TCustomPropertyStorage.OnSavingProperties">
|
||||
<short />
|
||||
<descr />
|
||||
<seealso />
|
||||
</element> <!-- property TIniPropStorage.OnSavingProperties -->
|
||||
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TIniPropStorage.OnRestoreProperties">
|
||||
<short/>
|
||||
<descr>
|
||||
</descr>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TIniPropStorage.OnSaveProperties" link="#LCL.PropertyStorage.TCustomPropertyStorage.OnSaveProperties">
|
||||
<short />
|
||||
<descr />
|
||||
<seealso />
|
||||
</element> <!-- property TIniPropStorage.OnSaveProperties -->
|
||||
|
||||
<!-- procedure Visibility: default -->
|
||||
<element name="Register">
|
||||
<short/>
|
||||
<descr>
|
||||
</descr>
|
||||
<errors>
|
||||
</errors>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
</module> <!-- IniPropStorage -->
|
||||
</package>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TIniPropStorage.OnRestoringProperties" link="#LCL.PropertyStorage.TCustomPropertyStorage.OnRestoringProperties">
|
||||
<short />
|
||||
<descr />
|
||||
<seealso />
|
||||
</element> <!-- property TIniPropStorage.OnRestoringProperties -->
|
||||
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TIniPropStorage.OnRestoreProperties" link="#LCL.PropertyStorage.TCustomPropertyStorage.OnRestoreProperties">
|
||||
<short />
|
||||
<descr />
|
||||
<seealso />
|
||||
</element> <!-- property TIniPropStorage.OnRestoreProperties -->
|
||||
|
||||
<!-- procedure Visibility: default -->
|
||||
<element name="Register">
|
||||
<short>Registers <link id="#LCL.IniPropStorage.TIniPropStorage">TIniPropStorage</link> on the 'Misc' tab of the component pallete.</short>
|
||||
<descr />
|
||||
<errors />
|
||||
<seealso />
|
||||
</element> <!-- procedure Register -->
|
||||
|
||||
</module> <!-- module IniPropStorage -->
|
||||
</package> <!-- package lcl -->
|
||||
</fpdoc-descriptions>
|
||||
|
||||
@ -1,12 +1,374 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<fpdoc-descriptions>
|
||||
<package name="LCLBase">
|
||||
<module name="JSONPropStorage">
|
||||
<element name="TJSONPropStorage"/>
|
||||
<element name="TJSONPropStorage.JSONFileName">
|
||||
<short>Name of the file where the property data is saved in JSON format.</short>
|
||||
</element>
|
||||
</module>
|
||||
</package>
|
||||
</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>This determines if the object is active or not.</short>
|
||||
<descr />
|
||||
<errors />
|
||||
<seealso />
|
||||
</element> <!-- property TJSONPropStorage.Active -->
|
||||
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TJSONPropStorage.OnSavingProperties" link="#LCL.PropertyStorage.TCustomPropertyStorage.OnSavingProperties">
|
||||
<short>Called before saving the properties.</short>
|
||||
<descr />
|
||||
<errors />
|
||||
<seealso />
|
||||
</element> <!-- property TJSONPropStorage.OnSavingProperties -->
|
||||
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TJSONPropStorage.OnSaveProperties" link="#LCL.PropertyStorage.TCustomPropertyStorage.OnSaveProperties">
|
||||
<short>Called after saving the properties.</short>
|
||||
<descr />
|
||||
<errors />
|
||||
<seealso />
|
||||
</element> <!-- property TJSONPropStorage.OnSaveProperties -->
|
||||
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TJSONPropStorage.OnRestoringProperties" link="#LCL.PropertyStorage.TCustomPropertyStorage.OnRestoringProperties">
|
||||
<short>Called before restoring the properties.</short>
|
||||
<descr />
|
||||
<errors />
|
||||
<seealso />
|
||||
</element> <!-- property TJSONPropStorage.OnRestoringProperties -->
|
||||
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TJSONPropStorage.OnRestoreProperties" link="#LCL.PropertyStorage.TCustomPropertyStorage.OnRestoreProperties">
|
||||
<short>Called after restoring the properties.</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>
|
||||
|
||||
@ -1,418 +1,433 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<fpdoc-descriptions>
|
||||
<package name="lcl">
|
||||
<package name="lcl">
|
||||
|
||||
<!--
|
||||
====================================================================
|
||||
XMLPropStorage
|
||||
====================================================================
|
||||
-->
|
||||
<!--
|
||||
====================================================================
|
||||
XMLPropStorage
|
||||
====================================================================
|
||||
-->
|
||||
|
||||
<module name="XMLPropStorage">
|
||||
<short/>
|
||||
<descr>
|
||||
</descr>
|
||||
<module name="XMLPropStorage">
|
||||
<short>Contains a component that stores Form Session Properties in XML format.</short>
|
||||
<descr>
|
||||
<p>In this unit you can find an implementation of a name/value pair storage container in XML 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.XmlPropStorage.TXMLPropStorage.FileName">TXMLPropStorage.FileName</link>.</p>
|
||||
</descr>
|
||||
|
||||
<!-- unresolved type reference Visibility: default -->
|
||||
<element name="Classes">
|
||||
<short/>
|
||||
<descr>
|
||||
</descr>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- unresolved type reference Visibility: default -->
|
||||
<element name="Classes">
|
||||
<short />
|
||||
<descr />
|
||||
<seealso />
|
||||
</element> <!-- Classes -->
|
||||
|
||||
<!-- unresolved type reference Visibility: default -->
|
||||
<element name="SysUtils">
|
||||
<short/>
|
||||
<descr>
|
||||
</descr>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- unresolved type reference Visibility: default -->
|
||||
<element name="SysUtils">
|
||||
<short />
|
||||
<descr />
|
||||
<seealso />
|
||||
</element> <!-- SysUtils -->
|
||||
|
||||
<!-- unresolved type reference Visibility: default -->
|
||||
<element name="LCLProc">
|
||||
<short/>
|
||||
<descr>
|
||||
</descr>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- unresolved type reference Visibility: default -->
|
||||
<element name="XMLConf">
|
||||
<short>This unit contains the implementation of a path/value pair generic container in XML format.</short>
|
||||
<descr />
|
||||
<seealso />
|
||||
</element> <!-- XMLConf -->
|
||||
|
||||
<!-- unresolved type reference Visibility: default -->
|
||||
<element name="Forms">
|
||||
<short/>
|
||||
<descr>
|
||||
</descr>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- unresolved type reference Visibility: default -->
|
||||
<element name="DOM">
|
||||
<short />
|
||||
<descr />
|
||||
<seealso />
|
||||
</element> <!-- DOM -->
|
||||
|
||||
<!-- unresolved type reference Visibility: default -->
|
||||
<element name="PropertyStorage">
|
||||
<short/>
|
||||
<descr>
|
||||
</descr>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- unresolved type reference Visibility: default -->
|
||||
<element name="XMLRead">
|
||||
<short />
|
||||
<descr />
|
||||
<seealso />
|
||||
</element> <!-- XMLRead -->
|
||||
|
||||
<!-- unresolved type reference Visibility: default -->
|
||||
<element name="XMLCfg">
|
||||
<short/>
|
||||
<descr>
|
||||
</descr>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- unresolved type reference Visibility: default -->
|
||||
<element name="XMLWrite">
|
||||
<short />
|
||||
<descr />
|
||||
<seealso />
|
||||
</element> <!-- XMLWrite -->
|
||||
|
||||
<!-- unresolved type reference Visibility: default -->
|
||||
<element name="DOM">
|
||||
<short/>
|
||||
<descr>
|
||||
</descr>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- unresolved type reference Visibility: default -->
|
||||
<element name="LCLProc">
|
||||
<short />
|
||||
<descr />
|
||||
<seealso />
|
||||
</element> <!-- LCLProc -->
|
||||
|
||||
<!-- object Visibility: default -->
|
||||
<element name="TPropStorageXMLConfig">
|
||||
<short/>
|
||||
<descr>
|
||||
</descr>
|
||||
<errors>
|
||||
</errors>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- unresolved type reference Visibility: default -->
|
||||
<element name="Forms">
|
||||
<short />
|
||||
<descr />
|
||||
<seealso />
|
||||
</element> <!-- Forms -->
|
||||
|
||||
<!-- procedure Visibility: public -->
|
||||
<element name="TPropStorageXMLConfig.DeleteSubNodes">
|
||||
<short/>
|
||||
<descr>
|
||||
</descr>
|
||||
<errors>
|
||||
</errors>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- unresolved type reference Visibility: default -->
|
||||
<element name="LazConfigStorage">
|
||||
<short />
|
||||
<descr />
|
||||
<seealso />
|
||||
</element> <!-- LazConfigStorage -->
|
||||
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="TPropStorageXMLConfig.DeleteSubNodes.ARootNode">
|
||||
<short/>
|
||||
</element>
|
||||
<!-- unresolved type reference Visibility: default -->
|
||||
<element name="LazUTF8">
|
||||
<short />
|
||||
<descr />
|
||||
<seealso />
|
||||
</element> <!-- LazUTF8 -->
|
||||
|
||||
<!-- object Visibility: default -->
|
||||
<element name="TCustomXMLPropStorage">
|
||||
<short/>
|
||||
<descr>
|
||||
</descr>
|
||||
<errors>
|
||||
</errors>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- unresolved type reference Visibility: default -->
|
||||
<element name="LazUTF8Classes">
|
||||
<short />
|
||||
<descr />
|
||||
<seealso />
|
||||
</element> <!-- LazUTF8Classes -->
|
||||
|
||||
<!-- variable Visibility: private -->
|
||||
<element name="TCustomXMLPropStorage.FCount">
|
||||
<short/>
|
||||
<descr>
|
||||
</descr>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- object Visibility: default -->
|
||||
<element name="TPropStorageXMLConfig">
|
||||
<short>Wrapper class around <url href="http://wiki.freepascal.org/xmlconf">XMLConf</url>.<url href="http://wiki.freepascal.org/TXMLConfig">TXMLConfig</url>.</short>
|
||||
<descr />
|
||||
<errors />
|
||||
<seealso />
|
||||
</element> <!-- object TPropStorageXMLConfig -->
|
||||
|
||||
<!-- variable Visibility: private -->
|
||||
<element name="TCustomXMLPropStorage.FFileName">
|
||||
<short/>
|
||||
<descr>
|
||||
</descr>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- procedure Visibility: public -->
|
||||
<element name="TPropStorageXMLConfig.DeleteSubNodes">
|
||||
<short>Deletes sub nodes on a path.</short>
|
||||
<descr />
|
||||
<errors />
|
||||
<seealso />
|
||||
</element> <!-- procedure TPropStorageXMLConfig.DeleteSubNodes -->
|
||||
|
||||
<!-- variable Visibility: private -->
|
||||
<element name="TCustomXMLPropStorage.FXML">
|
||||
<short/>
|
||||
<descr>
|
||||
</descr>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="TPropStorageXMLConfig.DeleteSubNodes.ARootNode">
|
||||
<short>The path of the node to have it's sub nodes deleted.</short>
|
||||
</element> <!-- argument TPropStorageXMLConfig.DeleteSubNodes.ARootNode -->
|
||||
|
||||
<!-- variable Visibility: private -->
|
||||
<element name="TCustomXMLPropStorage.FRootNode">
|
||||
<short/>
|
||||
<descr>
|
||||
</descr>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- procedure Visibility: public -->
|
||||
<element name="TPropStorageXMLConfig.LoadFromStream">
|
||||
<short>Loads XML content from a stream.</short>
|
||||
<descr />
|
||||
<errors />
|
||||
<seealso />
|
||||
</element> <!-- procedure TPropStorageXMLConfig.LoadFromStream -->
|
||||
|
||||
<!-- variable Visibility: private -->
|
||||
<element name="TCustomXMLPropStorage.FRootNodePath">
|
||||
<short/>
|
||||
<descr>
|
||||
</descr>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="TPropStorageXMLConfig.LoadFromStream.s">
|
||||
<short>The stream to load the XML content from.</short>
|
||||
</element> <!-- argument TPropStorageXMLConfig.LoadFromStream.s -->
|
||||
|
||||
<!-- procedure Visibility: protected -->
|
||||
<element name="TCustomXMLPropStorage.StorageNeeded">
|
||||
<short/>
|
||||
<descr>
|
||||
</descr>
|
||||
<errors>
|
||||
</errors>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- procedure Visibility: public -->
|
||||
<element name="TPropStorageXMLConfig.SaveToStream">
|
||||
<short>Saves XML content to a stream.</short>
|
||||
<descr />
|
||||
<errors />
|
||||
<seealso />
|
||||
</element> <!-- procedure TPropStorageXMLConfig.SaveToStream -->
|
||||
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="TCustomXMLPropStorage.StorageNeeded.ReadOnly">
|
||||
<short/>
|
||||
</element>
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="TPropStorageXMLConfig.SaveToStream.s">
|
||||
<short>The stream to save the XML content to.</short>
|
||||
</element> <!-- argument TPropStorageXMLConfig.SaveToStream.s -->
|
||||
|
||||
<!-- procedure Visibility: protected -->
|
||||
<element name="TCustomXMLPropStorage.FreeStorage">
|
||||
<short/>
|
||||
<descr>
|
||||
</descr>
|
||||
<errors>
|
||||
</errors>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- property Visibility: public -->
|
||||
<element name="TPropStorageXMLConfig.XMLDoc">
|
||||
<short>Contains the XML document.</short>
|
||||
<descr />
|
||||
<errors />
|
||||
<seealso />
|
||||
</element> <!-- property TPropStorageXMLConfig.XMLDoc -->
|
||||
|
||||
<!-- function Visibility: protected -->
|
||||
<element name="TCustomXMLPropStorage.GetXMLFileName">
|
||||
<short/>
|
||||
<descr>
|
||||
</descr>
|
||||
<errors>
|
||||
</errors>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- object Visibility: default -->
|
||||
<element name="TCustomXMLPropStorage">
|
||||
<short>Implements the base class for the XML Form's Session Properties Storage.</short>
|
||||
<descr />
|
||||
<errors />
|
||||
<seealso />
|
||||
</element> <!-- object TCustomXMLPropStorage -->
|
||||
|
||||
<!-- function result Visibility: default -->
|
||||
<element name="TCustomXMLPropStorage.GetXMLFileName.Result">
|
||||
<short/>
|
||||
</element>
|
||||
<!-- variable Visibility: private -->
|
||||
<element name="TCustomXMLPropStorage.FCount">
|
||||
<short />
|
||||
<descr />
|
||||
<seealso />
|
||||
</element> <!-- variable TCustomXMLPropStorage.FCount -->
|
||||
|
||||
<!-- function Visibility: protected -->
|
||||
<element name="TCustomXMLPropStorage.RootSection">
|
||||
<short/>
|
||||
<descr>
|
||||
</descr>
|
||||
<errors>
|
||||
</errors>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- variable Visibility: private -->
|
||||
<element name="TCustomXMLPropStorage.FFileName">
|
||||
<short />
|
||||
<descr />
|
||||
<seealso />
|
||||
</element> <!-- variable TCustomXMLPropStorage.FFileName -->
|
||||
|
||||
<!-- function result Visibility: default -->
|
||||
<element name="TCustomXMLPropStorage.RootSection.Result">
|
||||
<short/>
|
||||
</element>
|
||||
<!-- variable Visibility: private -->
|
||||
<element name="TCustomXMLPropStorage.FXML">
|
||||
<short />
|
||||
<descr />
|
||||
<seealso />
|
||||
</element> <!-- variable TCustomXMLPropStorage.FXML -->
|
||||
|
||||
<!-- function Visibility: protected -->
|
||||
<element name="TCustomXMLPropStorage.FixPath">
|
||||
<short/>
|
||||
<descr>
|
||||
</descr>
|
||||
<errors>
|
||||
</errors>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- variable Visibility: private -->
|
||||
<element name="TCustomXMLPropStorage.FRootNode">
|
||||
<short />
|
||||
<descr />
|
||||
<seealso />
|
||||
</element> <!-- variable TCustomXMLPropStorage.FRootNode -->
|
||||
|
||||
<!-- function result Visibility: default -->
|
||||
<element name="TCustomXMLPropStorage.FixPath.Result">
|
||||
<short/>
|
||||
</element>
|
||||
<!-- variable Visibility: private -->
|
||||
<element name="TCustomXMLPropStorage.FRootNodePath">
|
||||
<short />
|
||||
<descr />
|
||||
<seealso />
|
||||
</element> <!-- variable TCustomXMLPropStorage.FRootNodePath -->
|
||||
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="TCustomXMLPropStorage.FixPath.APath">
|
||||
<short/>
|
||||
</element>
|
||||
<!-- function Visibility: protected -->
|
||||
<element name="TCustomXMLPropStorage.GetXMLFileName">
|
||||
<short>Getter for the property <link id="#LCL.XmlPropStorage.TCustomXMLPropStorage.FileName">TCustomXMLPropStorage.FileName</link>.</short>
|
||||
<descr />
|
||||
<errors />
|
||||
<seealso />
|
||||
</element> <!-- function TCustomXMLPropStorage.GetXMLFileName -->
|
||||
|
||||
<!-- property Visibility: protected -->
|
||||
<element name="TCustomXMLPropStorage.XMLConfig">
|
||||
<short/>
|
||||
<descr>
|
||||
</descr>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- function result Visibility: default -->
|
||||
<element name="TCustomXMLPropStorage.GetXMLFileName.Result">
|
||||
<short>The current value of the property <link id="#LCL.XmlPropStorage.TCustomXMLPropStorage.FileName">TCustomXMLPropStorage.FileName</link>.</short>
|
||||
</element> <!-- function result TCustomXMLPropStorage.GetXMLFileName.Result -->
|
||||
|
||||
<!-- function Visibility: public -->
|
||||
<element name="TCustomXMLPropStorage.DoReadString">
|
||||
<short/>
|
||||
<descr>
|
||||
</descr>
|
||||
<errors>
|
||||
</errors>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- function Visibility: protected -->
|
||||
<element name="TCustomXMLPropStorage.RootSection">
|
||||
<short>Returns the name of the RootSection.</short>
|
||||
<descr />
|
||||
<errors />
|
||||
<seealso />
|
||||
</element> <!-- function TCustomXMLPropStorage.RootSection -->
|
||||
|
||||
<!-- function result Visibility: default -->
|
||||
<element name="TCustomXMLPropStorage.DoReadString.Result">
|
||||
<short/>
|
||||
</element>
|
||||
<!-- function result Visibility: default -->
|
||||
<element name="TCustomXMLPropStorage.RootSection.Result">
|
||||
<short>The current value of RootSection.</short>
|
||||
</element> <!-- function result TCustomXMLPropStorage.RootSection.Result -->
|
||||
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="TCustomXMLPropStorage.DoReadString.Section">
|
||||
<short/>
|
||||
</element>
|
||||
<!-- function Visibility: protected -->
|
||||
<element name="TCustomXMLPropStorage.FixPath">
|
||||
<short>Turns '.' notation into '/' notation for the xpath-ish <url href="http://wiki.freepascal.org/xmlconf">XMLConf</url> underlayer.</short>
|
||||
<descr />
|
||||
<errors />
|
||||
<seealso />
|
||||
</element> <!-- function TCustomXMLPropStorage.FixPath -->
|
||||
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="TCustomXMLPropStorage.DoReadString.Ident">
|
||||
<short/>
|
||||
</element>
|
||||
<!-- function result Visibility: default -->
|
||||
<element name="TCustomXMLPropStorage.FixPath.Result">
|
||||
<short>The fixed path is returned with '.' replaced by '/'.</short>
|
||||
</element> <!-- function result TCustomXMLPropStorage.FixPath.Result -->
|
||||
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="TCustomXMLPropStorage.DoReadString.TheDefault">
|
||||
<short/>
|
||||
</element>
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="TCustomXMLPropStorage.FixPath.APath">
|
||||
<short>The path to be fixed.</short>
|
||||
</element> <!-- argument TCustomXMLPropStorage.FixPath.APath -->
|
||||
|
||||
<!-- procedure Visibility: public -->
|
||||
<element name="TCustomXMLPropStorage.DoWriteString">
|
||||
<short/>
|
||||
<descr>
|
||||
</descr>
|
||||
<errors>
|
||||
</errors>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- property Visibility: protected -->
|
||||
<element name="TCustomXMLPropStorage.XMLConfig">
|
||||
<short>Property to access the <link id="#LCL.XmlPropStorage.TPropStorageXMLConfig">TPropStorageXMLConfig</link>.</short>
|
||||
<descr />
|
||||
<seealso />
|
||||
</element> <!-- property TCustomXMLPropStorage.XMLConfig -->
|
||||
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="TCustomXMLPropStorage.DoWriteString.Section">
|
||||
<short/>
|
||||
</element>
|
||||
<!-- procedure Visibility: public -->
|
||||
<element name="TCustomXMLPropStorage.StorageNeeded">
|
||||
<short>Aks the underlying storage object for an entry</short>
|
||||
<descr />
|
||||
<errors />
|
||||
<seealso />
|
||||
</element> <!-- procedure TCustomXMLPropStorage.StorageNeeded -->
|
||||
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="TCustomXMLPropStorage.DoWriteString.Ident">
|
||||
<short/>
|
||||
</element>
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="TCustomXMLPropStorage.StorageNeeded.ReadOnly">
|
||||
<short>If the item is read-only.</short>
|
||||
</element> <!-- argument TCustomXMLPropStorage.StorageNeeded.ReadOnly -->
|
||||
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="TCustomXMLPropStorage.DoWriteString.Value">
|
||||
<short/>
|
||||
</element>
|
||||
<!-- procedure Visibility: public -->
|
||||
<element name="TCustomXMLPropStorage.FreeStorage">
|
||||
<short>Frees an entry from the underlying storage object.</short>
|
||||
<descr />
|
||||
<errors />
|
||||
<seealso />
|
||||
</element> <!-- procedure TCustomXMLPropStorage.FreeStorage -->
|
||||
|
||||
<!-- procedure Visibility: public -->
|
||||
<element name="TCustomXMLPropStorage.DoEraseSections">
|
||||
<short/>
|
||||
<descr>
|
||||
</descr>
|
||||
<errors>
|
||||
</errors>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- function Visibility: public -->
|
||||
<element name="TCustomXMLPropStorage.DoReadString">
|
||||
<short>Implements the actual reading of a value from the underlying storage container.</short>
|
||||
<descr />
|
||||
<errors />
|
||||
<seealso />
|
||||
</element> <!-- function TCustomXMLPropStorage.DoReadString -->
|
||||
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="TCustomXMLPropStorage.DoEraseSections.ARootSection">
|
||||
<short/>
|
||||
</element>
|
||||
<!-- function result Visibility: default -->
|
||||
<element name="TCustomXMLPropStorage.DoReadString.Result">
|
||||
<short>The value of the section/ident requested.</short>
|
||||
</element> <!-- function result TCustomXMLPropStorage.DoReadString.Result -->
|
||||
|
||||
<!-- property Visibility: public -->
|
||||
<element name="TCustomXMLPropStorage.FileName">
|
||||
<short/>
|
||||
<descr>
|
||||
</descr>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="TCustomXMLPropStorage.DoReadString.Section">
|
||||
<short>The section to be read.</short>
|
||||
</element> <!-- argument TCustomXMLPropStorage.DoReadString.Section -->
|
||||
|
||||
<!-- property Visibility: public -->
|
||||
<element name="TCustomXMLPropStorage.RootNodePath">
|
||||
<short/>
|
||||
<descr>
|
||||
</descr>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="TCustomXMLPropStorage.DoReadString.Ident">
|
||||
<short>The ident to be read.</short>
|
||||
</element> <!-- argument TCustomXMLPropStorage.DoReadString.Ident -->
|
||||
|
||||
<!-- object Visibility: default -->
|
||||
<element name="TXMLPropStorage">
|
||||
<short/>
|
||||
<descr>
|
||||
</descr>
|
||||
<errors>
|
||||
</errors>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="TCustomXMLPropStorage.DoReadString.TheDefault">
|
||||
<short>If has no value then return this as default.</short>
|
||||
</element> <!-- argument TCustomXMLPropStorage.DoReadString.TheDefault -->
|
||||
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TXMLPropStorage.StoredValues">
|
||||
<short/>
|
||||
<descr>
|
||||
</descr>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- procedure Visibility: public -->
|
||||
<element name="TCustomXMLPropStorage.DoWriteString">
|
||||
<short>Implements the actual writing of a value from the underlying storage container.</short>
|
||||
<descr />
|
||||
<errors />
|
||||
<seealso />
|
||||
</element> <!-- procedure TCustomXMLPropStorage.DoWriteString -->
|
||||
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TXMLPropStorage.FileName">
|
||||
<short>Name of the file where the property data is saved in XML format.</short>
|
||||
<descr>
|
||||
</descr>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="TCustomXMLPropStorage.DoWriteString.Section">
|
||||
<short>The section to be written.</short>
|
||||
</element> <!-- argument TCustomXMLPropStorage.DoWriteString.Section -->
|
||||
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TXMLPropStorage.RootNodePath">
|
||||
<short/>
|
||||
<descr>
|
||||
</descr>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="TCustomXMLPropStorage.DoWriteString.Ident">
|
||||
<short>The ident to be written.</short>
|
||||
</element> <!-- argument TCustomXMLPropStorage.DoWriteString.Ident -->
|
||||
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TXMLPropStorage.Active">
|
||||
<short/>
|
||||
<descr>
|
||||
</descr>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="TCustomXMLPropStorage.DoWriteString.Value">
|
||||
<short>The value to be written.</short>
|
||||
</element> <!-- argument TCustomXMLPropStorage.DoWriteString.Value -->
|
||||
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TXMLPropStorage.OnSaveProperties">
|
||||
<short/>
|
||||
<descr>
|
||||
</descr>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- procedure Visibility: public -->
|
||||
<element name="TCustomXMLPropStorage.DoEraseSections">
|
||||
<short>Erases a section from the underlying storage container.</short>
|
||||
<descr />
|
||||
<errors />
|
||||
<seealso />
|
||||
</element> <!-- procedure TCustomXMLPropStorage.DoEraseSections -->
|
||||
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TXMLPropStorage.OnRestoreProperties">
|
||||
<short/>
|
||||
<descr>
|
||||
</descr>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="TCustomXMLPropStorage.DoEraseSections.ARootSection">
|
||||
<short>The path to the section that will be erased.</short>
|
||||
</element> <!-- argument TCustomXMLPropStorage.DoEraseSections.ARootSection -->
|
||||
|
||||
<!-- procedure Visibility: default -->
|
||||
<element name="Register">
|
||||
<short/>
|
||||
<descr>
|
||||
</descr>
|
||||
<errors>
|
||||
</errors>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
</module> <!-- XMLPropStorage -->
|
||||
</package>
|
||||
<!-- property Visibility: public -->
|
||||
<element name="TCustomXMLPropStorage.FileName">
|
||||
<short>Name of the file where the property data is saved in XML format.</short>
|
||||
<descr />
|
||||
<seealso />
|
||||
</element> <!-- propert TCustomXMLPropStorage.FileName -->
|
||||
|
||||
<!-- property Visibility: public -->
|
||||
<element name="TCustomXMLPropStorage.RootNodePath">
|
||||
<short>Name of the root object path on your XML file.</short>
|
||||
<descr />
|
||||
<seealso />
|
||||
</element> <!-- property TCustomXMLPropStorage.RootNodePath -->
|
||||
|
||||
<!-- object Visibility: default -->
|
||||
<element name="TXMLPropStorage">
|
||||
<short>Implements the final class for the XML 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.JSONPropStorage.TJSONPropStorage">TJSONPropStorage</link>
|
||||
</seealso>
|
||||
</element> <!-- object TXMLPropStorage -->
|
||||
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TXMLPropStorage.StoredValues" link="#LCL.PropertyStorage.TCustomPropertyStorage.StoredValues">
|
||||
<short />
|
||||
<descr />
|
||||
<seealso />
|
||||
</element> <!-- property TXMLPropStorage.StoredValues -->
|
||||
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TXMLPropStorage.FileName" link="#LCL.XmlPropStorage.TCustomXmlPropStorage.FileName">
|
||||
<short />
|
||||
<descr />
|
||||
<seealso />
|
||||
</element> <!-- property TXMLPropStorage.FileName -->
|
||||
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TXMLPropStorage.RootNodePath" link="#LCL.XmlPropStorage.TCustomXmlPropStorage.RootNodePath">
|
||||
<short />
|
||||
<descr />
|
||||
<seealso />
|
||||
</element> <!-- property TXMLPropStorage.RootNodePath -->
|
||||
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TXMLPropStorage.Active" link="#LCL.PropertyStorage.TCustomPropertyStorage.Active">
|
||||
<short />
|
||||
<descr />
|
||||
<seealso />
|
||||
</element> <!-- property TXMLPropStorage.Active -->
|
||||
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TXMLPropStorage.OnSavingProperties" link="#LCL.PropertyStorage.TCustomPropertyStorage.OnSavingProperties">
|
||||
<short />
|
||||
<descr />
|
||||
<errors />
|
||||
<seealso />
|
||||
</element> <!-- property TXMLPropStorage.OnSavingProperties -->
|
||||
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TXMLPropStorage.OnSaveProperties" link="#LCL.PropertyStorage.TCustomPropertyStorage.OnSaveProperties">
|
||||
<short />
|
||||
<descr />
|
||||
<errors />
|
||||
<seealso />
|
||||
</element> <!-- property TXMLPropStorage.OnSaveProperties -->
|
||||
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TXMLPropStorage.OnRestoringProperties" link="#LCL.PropertyStorage.TCustomPropertyStorage.OnRestoringProperties">
|
||||
<short />
|
||||
<descr />
|
||||
<errors />
|
||||
<seealso />
|
||||
</element> <!-- property TXMLPropStorage.OnRestoringProperties -->
|
||||
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TXMLPropStorage.OnRestoreProperties" link="#LCL.PropertyStorage.TCustomPropertyStorage.OnRestoreProperties">
|
||||
<short />
|
||||
<descr />
|
||||
<errors />
|
||||
<seealso />
|
||||
</element> <!-- property TXMLPropStorage.OnRestoreProperties -->
|
||||
|
||||
<!-- object Visibility: default -->
|
||||
<element name="TXMLConfigStorage">
|
||||
<short>This class is present on the source but seems not be used.</short>
|
||||
<descr />
|
||||
<errors />
|
||||
<seealso />
|
||||
</element> <!-- object TXMLConfigStorage -->
|
||||
|
||||
<!-- procedure Visibility: default -->
|
||||
<element name="Register">
|
||||
<short>Registers <link id="#LCL.XmlPropStorage.TXMLPropStorage">TXMLPropStorage</link> on the 'Misc' tab of the component pallete.</short>
|
||||
<descr />
|
||||
<errors />
|
||||
<seealso />
|
||||
</element> <!-- procedure Register -->
|
||||
|
||||
</module> <!-- moduleXMLPropStorage -->
|
||||
</package> <!-- package lcl -->
|
||||
</fpdoc-descriptions>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user