paweld/lazarus
1
0
Fork 0
mirror of https://gitlab.com/freepascal.org/lazarus/lazarus.git synced 2025-11-23 21:39:31 +01:00
Code Issues Packages Projects Releases Wiki Activity

Docs: LazUtils/extendedstrings. Updates topic content and See Also links. Removes unused tags in private members.

Browse Source
This commit is contained in:
dsiders 2022-10-23 20:29:47 +01:00
parent 1e7d87dd64
commit 4741e7df12
1 changed files with 88 additions and 121 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

209
docs/xml/lazutils/extendedstrings.xml
View File

@ -48,16 +48,13 @@ type.
<link id="TExtStringsOptions"/> <link id="TExtStringsOptions"/>
</seealso> </seealso>
</element> </element>
<!-- enumeration value Visibility: default -->
<element name="TExtStringsOption.esoClearRecordsOnCreate"> <element name="TExtStringsOption.esoClearRecordsOnCreate">
<short>Memory allocated to a new record is cleared (filled with #0).</short> <short>Memory allocated to a new record is cleared (filled with #0).</short>
</element> </element>
<!-- enumeration value Visibility: default -->
<element name="TExtStringsOption.esoFreeObjectsOnDelete"> <element name="TExtStringsOption.esoFreeObjectsOnDelete">
<short>Objects call their free method before they are deleted.</short> <short>Objects call their free method before they are deleted.</short>
</element> </element>
<!-- set type Visibility: default -->
<element name="TExtStringsOptions"> <element name="TExtStringsOptions">
<short> <short>
Stores TExtStringsOption values. Stores TExtStringsOption values.
@ -69,10 +66,11 @@ Stores TExtStringsOption values.
the <var>TExtendedStringList.Options</var> property. the <var>TExtendedStringList.Options</var> property.
</p> </p>
</descr> </descr>
<seealso></seealso> <seealso>
<link id="TExtendedStringList.Options"/>
</seealso>
</element> </element>
<!-- object Visibility: default -->
<element name="TExtendedStringList"> <element name="TExtendedStringList">
<short> <short>
Implements a string list that allows Records in its Objects property. Implements a string list that allows Records in its Objects property.
@ -83,7 +81,7 @@ Implements a string list that allows Records in its Objects property.
provides support for using records in the class. The <var>Records</var> provides support for using records in the class. The <var>Records</var>
property allows access to records stored in the class. TExtendedStringList property allows access to records stored in the class. TExtendedStringList
provides overridden methods to maintain values in the <var>Objects</var> provides overridden methods to maintain values in the <var>Objects</var>
property. New properties and methods are included to control actions needed property. New properties and methods are included to perform actions needed
when adding or freeing Records stored in the Objects property. when adding or freeing Records stored in the Objects property.
</p> </p>
</descr> </descr>
@ -92,77 +90,30 @@ when adding or freeing Records stored in the Objects property.
</seealso> </seealso>
</element> </element>
<!-- variable Visibility: private --> <!-- private members -->
<element name="TExtendedStringList.FOptions"> <element name="TExtendedStringList.FOptions"/>
<short/> <element name="TExtendedStringList.FRecordSize"/>
</element>
<!-- variable Visibility: private -->
<element name="TExtendedStringList.FRecordSize">
<short/>
</element>
<!-- function Visibility: private --> <element name="TExtendedStringList.GetRecords"/>
<element name="TExtendedStringList.GetRecords"> <element name="TExtendedStringList.GetRecords.Result"/>
<short/> <element name="TExtendedStringList.GetRecords.Index"/>
</element>
<!-- function result Visibility: default -->
<element name="TExtendedStringList.GetRecords.Result">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TExtendedStringList.GetRecords.Index">
<short/>
</element>
<!-- procedure Visibility: private --> <element name="TExtendedStringList.SetOptions"/>
<element name="TExtendedStringList.SetOptions"> <element name="TExtendedStringList.SetOptions.AValue"/>
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TExtendedStringList.SetOptions.AValue">
<short/>
</element>
<!-- procedure Visibility: private --> <element name="TExtendedStringList.SetRecords"/>
<element name="TExtendedStringList.SetRecords"> <element name="TExtendedStringList.SetRecords.Index"/>
<short/> <element name="TExtendedStringList.SetRecords.AValue"/>
</element>
<!-- argument Visibility: default -->
<element name="TExtendedStringList.SetRecords.Index">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TExtendedStringList.SetRecords.AValue">
<short/>
</element>
<!-- procedure Visibility: private --> <element name="TExtendedStringList.SetRecordSize"/>
<element name="TExtendedStringList.SetRecordSize"> <element name="TExtendedStringList.SetRecordSize.AValue"/>
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TExtendedStringList.SetRecordSize.AValue">
<short/>
</element>
<!-- procedure Visibility: private --> <element name="TExtendedStringList.DoResizeRecord"/>
<element name="TExtendedStringList.DoResizeRecord"> <element name="TExtendedStringList.DoResizeRecord.Index"/>
<short/> <element name="TExtendedStringList.DoResizeRecord.OldSize"/>
</element> <element name="TExtendedStringList.DoResizeRecord.NewSize"/>
<!-- argument Visibility: default -->
<element name="TExtendedStringList.DoResizeRecord.Index">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TExtendedStringList.DoResizeRecord.OldSize">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TExtendedStringList.DoResizeRecord.NewSize">
<short/>
</element>
<!-- procedure Visibility: protected --> <!-- protected -->
<element name="TExtendedStringList.ResizeRecord"> <element name="TExtendedStringList.ResizeRecord">
<short> <short>
Changes the memory allocation size for the specified record. Changes the memory allocation size for the specified record.
@ -180,24 +131,19 @@ is changed.
<link id="TExtendedStringList.RecordSize"/> <link id="TExtendedStringList.RecordSize"/>
</seealso> </seealso>
</element> </element>
<!-- argument Visibility: default -->
<element name="TExtendedStringList.ResizeRecord.ARecord"> <element name="TExtendedStringList.ResizeRecord.ARecord">
<short>Pointer to the record.</short> <short>Pointer to the record.</short>
</element> </element>
<!-- argument Visibility: default -->
<element name="TExtendedStringList.ResizeRecord.Index"> <element name="TExtendedStringList.ResizeRecord.Index">
<short>Ordinal position for the specified record.</short> <short>Ordinal position for the specified record.</short>
</element> </element>
<!-- argument Visibility: default -->
<element name="TExtendedStringList.ResizeRecord.OldSize"> <element name="TExtendedStringList.ResizeRecord.OldSize">
<short>Previous memory allocation size.</short> <short>Previous memory allocation size.</short>
</element> </element>
<!-- argument Visibility: default -->
<element name="TExtendedStringList.ResizeRecord.NewSize"> <element name="TExtendedStringList.ResizeRecord.NewSize">
<short>New memory allocation size.</short> <short>New memory allocation size.</short>
</element> </element>
<!-- function Visibility: protected -->
<element name="TExtendedStringList.GetObject"> <element name="TExtendedStringList.GetObject">
<short> <short>
Re-implements the read access specifier for the Objects property. Re-implements the read access specifier for the Objects property.
@ -215,21 +161,20 @@ GetObject and PutObject are called directly (as opposed to using the Objects
property) in methods which maintain values in Records. property) in methods which maintain values in Records.
</p> </p>
</descr> </descr>
<seealso></seealso> <seealso>
<link id="#rtl.classes.TStringList">TStringList</link>
</seealso>
</element> </element>
<!-- function result Visibility: default -->
<element name="TExtendedStringList.GetObject.Result"> <element name="TExtendedStringList.GetObject.Result">
<short>TObject stored at the specified position.</short> <short>TObject stored at the specified position.</short>
</element> </element>
<!-- argument Visibility: default -->
<element name="TExtendedStringList.GetObject.Index"> <element name="TExtendedStringList.GetObject.Index">
<short>Ordinal position for the requested value.</short> <short>Ordinal position for the requested value.</short>
</element> </element>
<!-- procedure Visibility: protected -->
<element name="TExtendedStringList.PutObject"> <element name="TExtendedStringList.PutObject">
<short> <short>
Reimplements the write access specifier for Objects. Reimplements the write access specifier for the Objects property.
</short> </short>
<descr> <descr>
<p> <p>
@ -245,61 +190,62 @@ GetObject and PutObject are called directly (as opposed to using the Objects
property) in methods which maintain values in Records. property) in methods which maintain values in Records.
</p> </p>
</descr> </descr>
<seealso></seealso> <seealso>
<link id="#rtl.classes.TStringList">TStringList</link>
</seealso>
</element> </element>
<!-- argument Visibility: default -->
<element name="TExtendedStringList.PutObject.Index"> <element name="TExtendedStringList.PutObject.Index">
<short>Ordinal position for value.</short> <short>Ordinal position for value.</short>
</element> </element>
<!-- argument Visibility: default -->
<element name="TExtendedStringList.PutObject.AnObject"> <element name="TExtendedStringList.PutObject.AnObject">
<short>Object to store at the specified position.</short> <short>Object to store at the specified position.</short>
</element> </element>
<!-- constructor Visibility: public --> <!-- public -->
<element name="TExtendedStringList.Create"> <element name="TExtendedStringList.Create">
<short> <short>
Constructor for the class instance. Constructor for the class instance.
</short> </short>
<descr> <descr>
<p> <p>
<var>Create</var> is the constructor for the class instance. Create calls the <var>Create</var> is the overloaded constructor for the class instance.
inherited constructor, and sets the default values in the following Create calls the inherited constructor, and sets the default values
properties: in the following properties:
</p> </p>
<dl> <dl>
<dt>Options</dt> <dt>Options</dt>
<dd>Set to <var>[ esoClearRecordsOnCreate ]</var></dd> <dd>Set to <var>[ esoClearRecordsOnCreate ]</var>.</dd>
<dt>RecordSize</dt> <dt>RecordSize</dt>
<dd>Set to the value in the <var>InitialRecordSize</var> argument</dd> <dd>Set to the value in the <var>InitialRecordSize</var> argument.</dd>
</dl> </dl>
<p> <p>
Use RecordSize to change the memory allocation size for Records in the class. Use RecordSize to change the memory allocation size for Records in the class.
</p> </p>
</descr> </descr>
<seealso></seealso> <seealso>
<link id="#rtl.classes.TStringList">TStringList</link>
</seealso>
</element> </element>
<!-- argument Visibility: default -->
<element name="TExtendedStringList.Create.InitialRecordSize"> <element name="TExtendedStringList.Create.InitialRecordSize">
<short>Memory size allocated for records.</short> <short>Memory size allocated for records.</short>
</element> </element>
<!-- destructor Visibility: public -->
<element name="TExtendedStringList.Destroy"> <element name="TExtendedStringList.Destroy">
<short> <short>
Destructor for the class instance. Destructor for the class instance.
</short> </short>
<descr> <descr>
<p> <p>
<var>Destroy</var> is the destructor for the class instance. Destroy calls <var>Destroy</var> is the overridden destructor for the class instance.
FreeAllRecords to release memory allocated for entries in the Records Destroy calls FreeAllRecords to release memory allocated for entries in the
property. Destroy calls the inherited destructor. Records property. Destroy calls the inherited destructor.
</p> </p>
</descr> </descr>
<seealso></seealso> <seealso>
<link id="#rtl.classes.TStringList.Destroy">TStringList.Destroy</link>
</seealso>
</element> </element>
<!-- procedure Visibility: public -->
<element name="TExtendedStringList.Clear"> <element name="TExtendedStringList.Clear">
<short> <short>
Removes items stored in the string list. Removes items stored in the string list.
@ -311,10 +257,11 @@ the string list. Clear calls FreeAllRecords to release memory allocated for
items in the Records property. Clear calls the inherited Clear method. items in the Records property. Clear calls the inherited Clear method.
</p> </p>
</descr> </descr>
<seealso></seealso> <seealso>
<link id="#rtl.classes.TStringList.Clear">TStringList.Clear</link>
</seealso>
</element> </element>
<!-- procedure Visibility: public -->
<element name="TExtendedStringList.Delete"> <element name="TExtendedStringList.Delete">
<short> <short>
Deletes the item at the specified position. Deletes the item at the specified position.
@ -327,14 +274,14 @@ in Records is freed by calling FreeRecord using the position in Index. Delete
calls the inherited Delete method. calls the inherited Delete method.
</p> </p>
</descr> </descr>
<seealso></seealso> <seealso>
<link id="#rtl.classes.TStringList.Delete">TStringList.Delete</link>
</seealso>
</element> </element>
<!-- argument Visibility: default -->
<element name="TExtendedStringList.Delete.Index"> <element name="TExtendedStringList.Delete.Index">
<short>Ordinal position for the item.</short> <short>Ordinal position for the item.</short>
</element> </element>
<!-- procedure Visibility: public -->
<element name="TExtendedStringList.CreateRecord"> <element name="TExtendedStringList.CreateRecord">
<short> <short>
Allocates memory for a new record instance. Allocates memory for a new record instance.
@ -353,14 +300,16 @@ CreateRecord is called when reading a value in the Records property, and when
writing a value to the Objects property. writing a value to the Objects property.
</p> </p>
</descr> </descr>
<seealso></seealso> <seealso>
<link id="TExtendedStringList.RecordSize"/>
<link id="TExtendedStringList.Options"/>
<link id="#rtl.classes.TStrings.Objects">TStrings.Objects</link>
</seealso>
</element> </element>
<!-- argument Visibility: default -->
<element name="TExtendedStringList.CreateRecord.Index"> <element name="TExtendedStringList.CreateRecord.Index">
<short>Ordinal position for the record.</short> <short>Ordinal position for the record.</short>
</element> </element>
<!-- procedure Visibility: public -->
<element name="TExtendedStringList.FreeRecord"> <element name="TExtendedStringList.FreeRecord">
<short> <short>
Frees memory allocated for the record at the specified position. Frees memory allocated for the record at the specified position.
@ -380,14 +329,16 @@ FreeRecord is called when writing a new value in the Records property, and in
methods like FreeAllRecords and Delete. methods like FreeAllRecords and Delete.
</p> </p>
</descr> </descr>
<seealso></seealso> <seealso>
<link id="TExtendedStringList.RecordSize"/>
<link id="TExtendedStringList.Options"/>
<link id="#rtl.classes.TStrings.Objects">TStrings.Objects</link>
</seealso>
</element> </element>
<!-- argument Visibility: default -->
<element name="TExtendedStringList.FreeRecord.Index"> <element name="TExtendedStringList.FreeRecord.Index">
<short>Ordinal position for the record.</short> <short>Ordinal position for the record.</short>
</element> </element>
<!-- procedure Visibility: public -->
<element name="TExtendedStringList.FreeAllRecords"> <element name="TExtendedStringList.FreeAllRecords">
<short> <short>
Frees memory allocated for all Records in the class. Frees memory allocated for all Records in the class.
@ -404,11 +355,12 @@ FreeAllRecords is called in the Clear method, and in the destructor for the
class. class.
</p> </p>
</descr> </descr>
<errors></errors> <seealso>
<seealso></seealso> <link id="TExtendedStringList.Records"/>
<link id="TExtendedStringList.Clear"/>
</seealso>
</element> </element>
<!-- function Visibility: public -->
<element name="TExtendedStringList.RecordAllocated"> <element name="TExtendedStringList.RecordAllocated">
<short> <short>
Determines if memory has been allocated for the specified record. Determines if memory has been allocated for the specified record.
@ -424,18 +376,17 @@ other than <var>Nil</var>.
RecordAllocated is called when reading a value for the Records property. RecordAllocated is called when reading a value for the Records property.
</p> </p>
</descr> </descr>
<seealso></seealso> <seealso>
<link id="TExtendedStringList.Records"/>
</seealso>
</element> </element>
<!-- function result Visibility: default -->
<element name="TExtendedStringList.RecordAllocated.Result"> <element name="TExtendedStringList.RecordAllocated.Result">
<short><b>True</b> if memory has been allocated for the record.</short> <short><b>True</b> if memory has been allocated for the record.</short>
</element> </element>
<!-- argument Visibility: default -->
<element name="TExtendedStringList.RecordAllocated.Index"> <element name="TExtendedStringList.RecordAllocated.Index">
<short>Ordinal position for the record.</short> <short>Ordinal position for the record.</short>
</element> </element>
<!-- property Visibility: public -->
<element name="TExtendedStringList.Records"> <element name="TExtendedStringList.Records">
<short> <short>
Provides indexed access to records in the string list. Provides indexed access to records in the string list.
@ -457,14 +408,19 @@ calling FreeRecord. The inherited PutObject method is called to store the
value in AValue as a TObject reference in the Objects property. value in AValue as a TObject reference in the Objects property.
</p> </p>
</descr> </descr>
<seealso></seealso> <seealso>
<link id="TExtendedStringList.RecordSize"/>
<link id="TExtendedStringList.Options"/>
<link id="TExtendedStringList.FreeRecord"/>
<link id="TExtendedStringList.FreeAllRecords"/>
<link id="TExtendedStringList.Clear"/>
<link id="#rtl.classes.TStrings.Objects">TStrings.Objects</link>
</seealso>
</element> </element>
<!-- argument Visibility: default -->
<element name="TExtendedStringList.Records.Index"> <element name="TExtendedStringList.Records.Index">
<short>Ordinal position for the record.</short> <short>Ordinal position for the record.</short>
</element> </element>
<!-- property Visibility: public -->
<element name="TExtendedStringList.RecordSize"> <element name="TExtendedStringList.RecordSize">
<short> <short>
Memory allocation size for Records in the class. Memory allocation size for Records in the class.
@ -477,11 +433,18 @@ is set to the argument passed in the constructor. Setting a new value for the
property causes the allocated memory size for any existing Records to be property causes the allocated memory size for any existing Records to be
changed to the new value. changed to the new value.
</p> </p>
<p>
RecordSize is used in the CreateRecord method and indicates the initial size
for the block of memory allocated for the record instance using GetMem.
</p>
</descr> </descr>
<seealso></seealso> <seealso>
<link id="TExtendedStringList.Records"/>
<link id="TExtendedStringList.CreateRecord"/>
<link id="TExtendedStringList.Options"/>
</seealso>
</element> </element>
<!-- property Visibility: public -->
<element name="TExtendedStringList.Options"> <element name="TExtendedStringList.Options">
<short> <short>
Contains record options enabled in the class. Contains record options enabled in the class.
@ -508,10 +471,14 @@ as set in the constructor for the class.
</p> </p>
</descr> </descr>
<seealso> <seealso>
<link id="TExtendedStringList.CreateRecord"/>
<link id="TExtendedStringList.FreeRecord"/>
<link id="TExtendedStringList.Create"/>
<link id="TExtStringsOptions"/> <link id="TExtStringsOptions"/>
<link id="TExtStringsOption"/> <link id="TExtStringsOption"/>
</seealso> </seealso>
</element> </element>
</module> </module>
<!-- ExtendedStrings --> <!-- ExtendedStrings -->