paweld/lazarus
1
0
Fork 0
mirror of https://gitlab.com/freepascal.org/lazarus/lazarus.git synced 2025-08-10 14:36:09 +02:00
Code Issues Packages Projects Releases Wiki Activity

Docs: LazUtils. Converts element links to see also links for topics with content.

Browse Source
This commit is contained in:
dsiders 2021-08-05 03:37:34 +01:00
parent 6f2dbaa8cd
commit 543b3ba2af
12 changed files with 225 additions and 116 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/xml/lazutils/avglvltree.xml
View File

@ -939,14 +939,16 @@
<seealso></seealso>
</element>
<element name="TStringToStringTree" link="#lazutils.avglvltree.TCustomStringMap">
<element name="TStringToStringTree">
<short>An associative array of StringToString Items, or a tree of trees.</short>
<descr>
<p>
<var>TStringToStringTree</var> implements an associative array of StringToString Items, or a tree of trees. This class uses strings to identify strings within the array, unlike the <var>TPointerToPointerTree</var>, which uses pointers to identify pointers.
</p>
</descr>
<seealso/>
<seealso>
<link id="TCustomStringMap"/>
</seealso>
</element>
<element name="TStringToStringTree.GetValues">

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

@ -64,7 +64,7 @@
</element>
<!-- object Visibility: default -->
<element name="TExtendedStringList" link="#rtl.Classes.TStringList">
<element name="TExtendedStringList">
<short>
Implements a string list that allows Records in its Objects property.
</short>
@ -73,7 +73,9 @@
<var>TExtendedStringList</var> is a <var>TStringList</var> descendant that provides support for using records in the class. The <var>Records</var> property allows access to records stored in the class. TExtendedStringList provides overridden methods to maintain values in the <var>Objects</var> property. New properties and methods are included to control actions needed when adding or freeing Records stored in the Objects property.
</p>
</descr>
<seealso></seealso>
<seealso>
<link id="#rtl.classes.TStringList">TStringList</link>
</seealso>
</element>
<!-- variable Visibility: private -->

20
docs/xml/lazutils/integerlist.xml
View File

@ -16,7 +16,7 @@
</p>
</descr>
<element name="TByteList" link="#RTL.fgl.TFPGList">
<element name="TByteList">
<short>Implements a specialization of TFPGList for Byte data types.</short>
<descr>
<p>
@ -28,7 +28,7 @@
</seealso>
</element>
<element name="TByteList.Sort" link="#rtl.fgl.TFPGList.Sort">
<element name="TByteList.Sort">
<short>Sorts the Byte values stored in the list.</short>
<descr>
<p>
@ -40,7 +40,7 @@
</seealso>
</element>
<element name="TWordList" link="#rtl.fgl.TFPGList">
<element name="TWordList">
<short>Implements a specialization of TFPGList for Word data types.</short>
<descr>
<p>
@ -52,7 +52,7 @@
</seealso>
</element>
<element name="TWordList.Sort" link="#rtl.fgl.TFPGList.Sort">
<element name="TWordList.Sort">
<short>Sorts the Word values stored in the list.</short>
<descr>
<p>
@ -64,7 +64,7 @@
</seealso>
</element>
<element name="TCardinalList" link="#rtl.fgl.TFPGList">
<element name="TCardinalList">
<short>Implements a specialization of TFPGList for Cardinal data types.</short>
<descr>
<p>
@ -78,7 +78,7 @@
</seealso>
</element>
<element name="TCardinalList.Sort" link="#rtl.fgl.TFPGList.Sort">
<element name="TCardinalList.Sort">
<short>Sorts the Word values stored in the list.</short>
<descr>
<p>
@ -90,7 +90,7 @@
</seealso>
</element>
<element name="TIntegerList" link="#rtl.fgl.TFPGList">
<element name="TIntegerList">
<short>Implements a specialization of TFPGList for Integer data types.</short>
<descr>
<p>
@ -104,7 +104,7 @@
</seealso>
</element>
<element name="TIntegerList.Sort" link="#rtl.fgl.TFPGList.Sort">
<element name="TIntegerList.Sort">
<short>Sorts the Integer values stored in the list.</short>
<descr>
<p>
@ -116,7 +116,7 @@
</seealso>
</element>
<element name="TInt64List" link="#rtl.fgl.TFPGList">
<element name="TInt64List">
<short>Implements a specialization of TFPGList for Int64 data types.</short>
<descr>
<p>
@ -129,7 +129,7 @@
</seealso>
</element>
<element name="TInt64List.Sort" link="#rtl.fgl.TFPGList.Sort">
<element name="TInt64List.Sort">
<short>Sorts the Int64 values stored in the list.</short>
<descr>
<p>

10
docs/xml/lazutils/laz2_xpath.xml
View File

@ -2164,8 +2164,11 @@
<element name="TXPathEnvironment.FVariables"/>
<!-- function Visibility: private -->
<element name="TXPathEnvironment.GetFunctionCount" link="#lazutils.laz2_xpath.TXPathEnvironment.FunctionCount">
<element name="TXPathEnvironment.GetFunctionCount">
<short>Gets the value for the FunctionCount property.</short>
<seealso>
<link id="#lazutils.laz2_xpath.TXPathEnvironment.FunctionCount">TXPathEnvironment.FunctionCount</link>
</seealso>
</element>
<!-- function result Visibility: default -->
@ -2174,8 +2177,11 @@
</element>
<!-- function Visibility: private -->
<element name="TXPathEnvironment.GetVariableCount" link="#lazutils.laz2_xpath.TXPathEnvironment.VariableCount">
<element name="TXPathEnvironment.GetVariableCount">
<short>Gets the value for the VariableCount property.</short>
<seealso>
<link id="#lazutils.laz2_xpath.TXPathEnvironment.VariableCount">TXPathEnvironment.VariableCount</link>
</seealso>
</element>
<!-- function result Visibility: default -->

20
docs/xml/lazutils/lazcollections.xml
View File

@ -142,8 +142,11 @@
<element name="TLazMonitor.FDefaultSpinCount" link="#lazutils.lazcollections.TLazMonitor.DefaultSpinCount"/>
<!-- class function Visibility: private -->
<element name="TLazMonitor.GetDefaultSpinCount" link="#lazutils.lazcollections.TLazMonitor.DefaultSpinCount">
<element name="TLazMonitor.GetDefaultSpinCount">
<short>Gets the value for the DefaultSpinCount class property.</short>
<seealso>
<link id="TLazMonitor.DefaultSpinCount"/>
</seealso>
</element>
<!-- function result Visibility: private -->
<element name="TLazMonitor.GetDefaultSpinCount.Result">
@ -151,8 +154,11 @@
</element>
<!-- class procedure Visibility: private -->
<element name="TLazMonitor.SetDefaultSpinCount" link="#lazutils.lazcollections.TLazMonitor.DefaultSpinCount">
<element name="TLazMonitor.SetDefaultSpinCount">
<short>Sets the value for the DefaultSpinCount property.</short>
<seealso>
<link id="TLazMonitor.DefaultSpinCount"/>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TLazMonitor.SetDefaultSpinCount.AValue">
@ -160,8 +166,11 @@
</element>
<!-- function Visibility: private -->
<element name="TLazMonitor.GetSpinCount" link="#lazutils.lazcollections.TLazMonitor.SpinCount">
<element name="TLazMonitor.GetSpinCount">
<short>Gets the value for the SpinCount property.</short>
<seealso>
<link id="TLazMonitor.SpinCount"/>
</seealso>
</element>
<!-- function result Visibility: private -->
<element name="TLazMonitor.GetSpinCount.Result">
@ -169,8 +178,11 @@
</element>
<!-- procedure Visibility: private -->
<element name="TLazMonitor.SetSpinCount" link="#lazutils.lazcollections.TLazMonitor.SpinCount">
<element name="TLazMonitor.SetSpinCount">
<short>Sets the value for the SpinCount property.</short>
<seealso>
<link id="TLazMonitor.SpinCount"/>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TLazMonitor.SetSpinCount.AValue">

20
docs/xml/lazutils/lazmethodlist.xml
View File

@ -83,8 +83,11 @@
<element name="TMethodList.FCount"/>
<!-- function Visibility: private -->
<element name="TMethodList.GetItems" link="#lazutils.lazmethodlist.TMethodList.Items">
<element name="TMethodList.GetItems">
<short>Gets the value for the Items property.</short>
<seealso>
<link id="TMethodList.Items"/>
</seealso>
</element>
<element name="TMethodList.GetItems.Result">
<short>Value for the Items property.</short>
@ -94,16 +97,22 @@
</element>
<!-- procedure Visibility: private -->
<element name="TMethodList.SetAllowDuplicates" link="#lazutils.lazmethodlist.TMethodList.AllowDuplicates">
<element name="TMethodList.SetAllowDuplicates">
<short>Sets the value in the AllowDuplicates property.</short>
<seealso>
<link id="TMethodList.AllowDuplicates"/>
</seealso>
</element>
<element name="TMethodList.SetAllowDuplicates.AValue">
<short>New value for the AllowDuplicates property.</short>
</element>
<!-- procedure Visibility: private -->
<element name="TMethodList.SetItems" link="#lazutils.lazmethodlist.TMethodList.Items">
<element name="TMethodList.SetItems">
<short>Sets the value for the Items property.</short>
<seealso>
<link id="TMethodList.Items"/>
</seealso>
</element>
<element name="TMethodList.SetItems.Index">
<short>Ordinal position for the item.</short>
@ -112,8 +121,11 @@
<short>New value for the item at the specified position.</short>
</element>
<element name="TMethodList.InternalInsert" link="#lazutils.lazmethodlist.TMethodList.Insert">
<element name="TMethodList.InternalInsert">
<short>Performs actions needed to insert a method at the specified position.</short>
<seealso>
<link id="TMethodList.Insert"/>
</seealso>
</element>
<element name="TMethodList.InternalInsert.Index">
<short>Ordinal position for the item.</short>

2
docs/xml/lazutils/lazstringutils.xml
View File

@ -1057,7 +1057,7 @@
<short>Maximum number of characters examined in the routine.</short>
</element>
<element name="LazIsValidIdent" link="#rtl.sysutils.IsValidIdent">
<element name="LazIsValidIdent">
<short>This is a copy of IsValidIdent from FPC 3.1.</short>
<descr>
<remark>

6
docs/xml/lazutils/lazsysutils.xml
View File

@ -27,12 +27,14 @@
<short>Date/Time value in UTC.</short>
</element>
<element name="GetTickCount64" link="#rtl.SysUtils.GetTickCount64">
<element name="GetTickCount64">
<short>
Gets the number of Milliseconds elapsed since the computer was started.
</short>
<descr></descr>
<seealso></seealso>
<seealso>
<link id="#rtl.SysUtils.GetTickCount64"/>
</seealso>
</element>
<element name="GetTickCount64.Result">

68
docs/xml/lazutils/lazutf8classes.xml
View File

@ -17,7 +17,7 @@
</descr>
<!-- class Visibility: default -->
<element name="TFileStreamUTF8" link="#rtl.Classes.TFileStream">
<element name="TFileStreamUTF8">
<short>
Implements a file stream with support for UTF-8-encoded file names.
</short>
@ -26,14 +26,16 @@
TFileStreamUTF8 is a TFileStream descendant which implements a file stream with support for UTF-8-encoded content file names. TFileStreamUTF8 provides constructors which create or open the file for the stream using UTF-8 encoding.
</p>
</descr>
<seealso></seealso>
<seealso>
<link id="#rtl.classes.TFileStream">TFileStream</link>
</seealso>
</element>
<!-- variable Visibility: private -->
<element name="TFileStreamUTF8.FFileName"/>
<!-- constructor Visibility: public -->
<element name="TFileStreamUTF8.Create" link="#rtl.Classes.TFileStream.Create">
<element name="TFileStreamUTF8.Create">
<short>
Constructor for the class instance.
</short>
@ -97,7 +99,9 @@
</dd>
</dl>
</errors>
<seealso></seealso>
<seealso>
<link id="#rtl.classes.TFileStream.Create">TFileStream.Create</link>
</seealso>
</element>
<!-- argument Visibility: default -->
@ -116,19 +120,22 @@
</element>
<!-- property Visibility: public -->
<element name="TFileStreamUTF8.FileName" link="#rtl.Classes.TFileStream.FileName">
<element name="TFileStreamUTF8.FileName">
<short>
Name of the file where stream content is read or written.
</short>
<descr>
FileName is a read-only String property that contains the name of the file where stream content is read or
written. FileName can contain UTF-8-encoded characters.
<p>
<var>FileName</var> is a read-only <var>String</var> property that contains the name of the file where stream content is read or written. FileName can contain UTF-8-encoded characters.
</p>
</descr>
<seealso></seealso>
<seealso>
<link id="#rtl.classes.TFileStream.FileName">TFileStream.FileName</link>
</seealso>
</element>
<!-- class Visibility: default -->
<element name="TStringListUTF8" link="#rtl.Classes.TStringList">
<element name="TStringListUTF8">
<short>
Implements a UTF-8-enabled string list.
</short>
@ -140,7 +147,9 @@ written. FileName can contain UTF-8-encoded characters.
<remark>
TStringListUTF8 has been marked as deprecated. Use TStringList instead.
</remark>
<seealso></seealso>
<seealso>
<link id="#rtl.classes.TStringList">TStringList</link>
</seealso>
</element>
<!-- function Visibility: protected -->
@ -172,16 +181,18 @@ written. FileName can contain UTF-8-encoded characters.
</element>
<!-- procedure Visibility: public -->
<element name="TStringListUTF8.LoadFromFile" link="#rtl.Classes.TStringList.LoadFromFile">
<element name="TStringListUTF8.LoadFromFile">
<short>
Loads the content in the string list from the specified file.
</short>
<descr>
<p>
LoadFromFile is a procedure used to load the content in the string list from the specified file name. FileName can contain UTF-8-encoded characters. LoadFromFile uses a TFileStreamUTF8 instance to open and read the contents of FileName, and calls LoadFromStream to store the values in the string list.
<var>LoadFromFile</var> is a procedure used to load the content in the string list from the specified file name. FileName can contain UTF-8-encoded characters. LoadFromFile uses a TFileStreamUTF8 instance to open and read the contents of FileName, and calls LoadFromStream to store the values in the string list.
</p>
</descr>
<seealso></seealso>
<seealso>
<link id="#rtl.classes.TStrings.LoadFromFile">TStrings.LoadFromFile</link>
</seealso>
</element>
<!-- argument Visibility: default -->
@ -190,17 +201,18 @@ written. FileName can contain UTF-8-encoded characters.
</element>
<!-- procedure Visibility: public -->
<element name="TStringListUTF8.SaveToFile" link="#rtl.Classes.TStringList.SaveToFile">
<element name="TStringListUTF8.SaveToFile">
<short>
Saves the content in the string to the specified file name.
</short>
<descr>
<p>
SaveToFile is a procedure used to save the content in the string list to the specified file name. FileName can
contain UTF-8-encoded characters. SaveToFile uses a TFileStreamUTF8 instance to create the file specified in FileName, and calls the SaveToStream method to store values from the string list.
<var>SaveToFile</var> is a procedure used to save the content in the string list to the specified file name. FileName can contain UTF-8-encoded characters. SaveToFile uses a TFileStreamUTF8 instance to create the file specified in FileName, and calls the SaveToStream method to store values from the string list.
</p>
</descr>
<seealso></seealso>
<seealso>
<link id="#rtl.classes.TStrings.SaveToFile">TStrings.SaveToFile</link>
</seealso>
</element>
<!-- argument Visibility: default -->
@ -209,23 +221,25 @@ contain UTF-8-encoded characters. SaveToFile uses a TFileStreamUTF8 instance to
</element>
<!-- class Visibility: default -->
<element name="TMemoryStreamUTF8" link="#rtl.Classes.TMemoryStream">
<element name="TMemoryStreamUTF8">
<short>
Implements a memory stream which supports file names with UTF-8 encoding.
</short>
<descr>
<p>
TMemoryStreamUTF8 is a TMemoryStream descendant that stores its data in memory. TMemoryStreamUTF8 extends the ancestor to include methods used to load and save its memory content using files names that may contain UTF-8-encoded characters.
<var>TMemoryStreamUTF8</var> is a <var>TMemoryStream</var> descendant that stores its data in memory. TMemoryStreamUTF8 extends the ancestor to include methods used to load and save its memory content using files names that may contain UTF-8-encoded characters.
</p>
</descr>
<remark>
TMemoryStreamUTF8 has been marked as deprecated. Use TMemoryStream instead.
</remark>
<seealso></seealso>
<seealso>
<link id="#rtl.classes.TMemoryStream">TMemoryStream</link>
</seealso>
</element>
<!-- procedure Visibility: public -->
<element name="TMemoryStreamUTF8.LoadFromFile" link="#rtl.Classes.TMemoryStream.LoadFromFile">
<element name="TMemoryStreamUTF8.LoadFromFile">
<short>
Loads the content in the stream from the specified file.
</short>
@ -234,7 +248,9 @@ contain UTF-8-encoded characters. SaveToFile uses a TFileStreamUTF8 instance to
LoadFromFile is a procedure used to load the content for the stream from the specified file name. LoadFromFile uses a TFileStreamUTF8 instance to open the file specified in FileName, and calls LoadFromStream to store the contents in the memory stream.
</p>
</descr>
<seealso></seealso>
<seealso>
<link id="#rtl.classes.TMemoryStream.LoadFromFile">TMemoryStream.LoadFromFile</link>
</seealso>
</element>
<!-- argument Visibility: default -->
@ -243,16 +259,18 @@ contain UTF-8-encoded characters. SaveToFile uses a TFileStreamUTF8 instance to
</element>
<!-- procedure Visibility: public -->
<element name="TMemoryStreamUTF8.SaveToFile" link="#rtl.Classes.TMemoryStream.SaveToFile">
<element name="TMemoryStreamUTF8.SaveToFile">
<short>
Stores the content in the stream to the specified file.
</short>
<descr>
<p>
SaveToFile is a procedure used to store the content in the memory stream to the specified file name. SaveToFile uses a TFileStreamUTF8 instance to create the file in FileName, and calls SaveToStream to write the content in the memory stream.
<var>SaveToFile</var> is a procedure used to store the content in the memory stream to the specified file name. SaveToFile uses a TFileStreamUTF8 instance to create the file in FileName, and calls SaveToStream to write the content in the memory stream.
</p>
</descr>
<seealso></seealso>
<seealso>
<link id="#rtl.classes.TCustomMemoryStream.SaveToFile">TCustomMemoryStream.SaveToFile</link>
</seealso>
</element>
<!-- argument Visibility: default -->

66
docs/xml/lazutils/lookupstringlist.xml
View File

@ -20,7 +20,7 @@
</descr>
<!-- class Visibility: default -->
<element name="TLookupStringList" link="#rtl.Classes.TStringList">
<element name="TLookupStringList">
<short>
Implements an unsorted StringList with a fast lookup feature.
</short>
@ -38,14 +38,16 @@
Authors: Juha Manninen / Antônio Galvão
</p>
</descr>
<seealso></seealso>
<seealso>
<link id="#rtl.classes.TStringList">TStringList</link>
</seealso>
</element>
<!-- variable Visibility: private -->
<element name="TLookupStringList.FMap"/>
<!-- procedure Visibility: protected -->
<element name="TLookupStringList.InsertItem" link="#rtl.Classes.TStringList.InsertItem">
<element name="TLookupStringList.InsertItem">
<short>
Adds a new value to the items and the string map with duplicate enforcement.
</short>
@ -76,7 +78,9 @@
Raises an <var>Exception</var> when adding a duplicated value and Duplicates contains <var>dupError</var>. Raised with the message 'TLookupStringList.InsertItem: Duplicates are not allowed.'
</p>
</errors>
<seealso></seealso>
<seealso>
<link id="#rtl.classes.TStringList">TStringList</link>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TLookupStringList.InsertItem.Index">
@ -88,7 +92,7 @@
</element>
<!-- constructor Visibility: public -->
<element name="TLookupStringList.Create" link="#rtl.Classes.TStringList.Create">
<element name="TLookupStringList.Create">
<short>
Constructor for the class instance.
</short>
@ -97,11 +101,13 @@
<var>Create</var> is the constructor for the class instance, and calls the inherited constructor. Create allocates the internal <var>TStringMap</var> instance used in the class.
</p>
</descr>
<seealso></seealso>
<seealso>
<link id="#rtl.classes.TStrings.Create">TStrings.Create</link>
</seealso>
</element>
<!-- destructor Visibility: public -->
<element name="TLookupStringList.Destroy" link="#rtl.Classes.TStringList.Destroy">
<element name="TLookupStringList.Destroy">
<short>
Destructor for the class instance.
</short>
@ -110,11 +116,13 @@
<var>Destroy</var> is the destructor for the class instance. Destroy frees the internal <var>TStringMap</var> instance allocated in the constructor, and calls the inherited Destroy method.
</p>
</descr>
<seealso></seealso>
<seealso>
<link id="#rtl.classes.TStringList.Destroy">TStringList.Destroy</link>
</seealso>
</element>
<!-- procedure Visibility: public -->
<element name="TLookupStringList.Assign" link="#rtl.Classes.TStrings.Assign">
<element name="TLookupStringList.Assign">
<short>
Implements object persistence in the class.
</short>
@ -123,7 +131,9 @@
<var>Assign</var> is an overridden method which implements the object persistence mechanism in the class. Assign ensures that property values in <var>Source</var> are stored in the current class instance. Assign calls the inherited method. When Source is a <var>TLookupStringList</var> class instance, the values in its internal string map are also stored in the current class instance.
</p>
</descr>
<seealso></seealso>
<seealso>
<link id="#rtl.classes.TStrings.Assign">TStrings.Assign</link>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TLookupStringList.Assign.Source">
@ -131,7 +141,7 @@
</element>
<!-- procedure Visibility: public -->
<element name="TLookupStringList.Clear" link="#rtl.Classes.TStringList.Clear">
<element name="TLookupStringList.Clear">
<short>
Clears the content stored in the class instance.
</short>
@ -140,11 +150,13 @@
<var>Clear</var> is an overridden method used to clear the content stored in <var>Strings</var>, <var>Objects</var>, and the internal string map. Clear calls the inherited method, and calls the <var>TStringMap.Clear</var> method in the internal string map.
</p>
</descr>
<seealso></seealso>
<seealso>
<link id="#rtl.classes.TStringList.Clear">TStringList.Clear</link>
</seealso>
</element>
<!-- procedure Visibility: public -->
<element name="TLookupStringList.Delete" link="#rtl.Classes.TStringList.Delete">
<element name="TLookupStringList.Delete">
<short>
Deletes the value at the specified position.
</short>
@ -153,7 +165,9 @@
<var>Delete</var> is an overridden method which ensures that the internal string map is maintained when deleting the value stored at the specified position. The corresponding value in <var>Strings</var> is used to check for duplicates using <var>IndexOf</var>. When a duplicate exists, and <var>Duplicates</var> are not allowed, the value is also removed from the internal string map. Delete calls the inherited method to delete the values in Strings and Objects at the position in <var>Index</var>.
</p>
</descr>
<seealso></seealso>
<seealso>
<link id="#rtl.classes.TStringList.Delete">TStringList.Delete</link>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TLookupStringList.Delete.Index">
@ -161,7 +175,7 @@
</element>
<!-- function Visibility: public -->
<element name="TLookupStringList.Add" link="#rtl.Classes.TStringList.Add">
<element name="TLookupStringList.Add">
<short>
Adds the specified value to the Strings in the list.
</short>
@ -173,7 +187,9 @@
The return value is <b>-1</b> if the value in <var>S</var> already exists in the string map, and no actions are performed in the method. Otherwise, the inherited Add method is called to store the value in S. The return value is the position in Strings where the new value was stored.
</p>
</descr>
<seealso></seealso>
<seealso>
<link id="#rtl.classes.TStringList.Add">TStringList.Add</link>
</seealso>
</element>
<!-- function result Visibility: default -->
<element name="TLookupStringList.Add.Result">
@ -187,7 +203,7 @@
</element>
<!-- function Visibility: public -->
<element name="TLookupStringList.AddObject" link="#rtl.Classes.TStrings.AddObject">
<element name="TLookupStringList.AddObject">
<short>
Adds the specified values to the Strings and Objects in the list.
</short>
@ -199,7 +215,9 @@
The return value contains the ordinal position in Strings where the value was stored, or <b>-1</b> when duplicate values are not allowed. If the return value is not <b>-1</b>, the Objects property is updated to include the value in <var>AObject</var> at the specified position.
</p>
</descr>
<seealso></seealso>
<seealso>
<link id="#rtl.classes.TStrings.AddObject">TStrings.AddObject</link>
</seealso>
</element>
<!-- function result Visibility: default -->
<element name="TLookupStringList.AddObject.Result">
@ -241,7 +259,7 @@
</element>
<!-- function Visibility: public -->
<element name="TLookupStringList.Find" link="#rtl.Classes.TStringList.Find">
<element name="TLookupStringList.Find">
<short>
Locates the specified value in the Strings property.
</short>
@ -253,7 +271,9 @@
Please note: Find does <b>NOT</b> call the inherited method.
</p>
</descr>
<seealso></seealso>
<seealso>
<link id="#rtl.classes.TStringList.Find">TStringList.Find</link>
</seealso>
</element>
<!-- function result Visibility: default -->
<element name="TLookupStringList.Find.Result">
@ -269,7 +289,7 @@
</element>
<!-- function Visibility: public -->
<element name="TLookupStringList.IndexOf" link="#rtl.Classes.TStringList.IndexOf">
<element name="TLookupStringList.IndexOf">
<short>
Gets the position in Strings where the specified value is stored.
</short>
@ -281,7 +301,9 @@
The return value contains the ordinal position for the specified value, or <b>-1</b> when S does not exist in the string map.
</p>
</descr>
<seealso></seealso>
<seealso>
<link id="#rtl.classes.TStringList.IndexOf">TStringList.IndexOf</link>
</seealso>
</element>
<!-- function result Visibility: default -->
<element name="TLookupStringList.IndexOf.Result">

55
docs/xml/lazutils/maps.xml
View File

@ -624,7 +624,7 @@
<descr/>
</element>
<element name="TBaseMapIterator" link="#rtl.Classes.TObject">
<element name="TBaseMapIterator">
<short>Specifies the interface used for map item iterators.</short>
<descr/>
</element>
@ -842,7 +842,7 @@
</descr>
</element>
<element name="TMap.Add" link="#lazutils.maps.TBaseMap.InternalAdd">
<element name="TMap.Add">
<short>
Adds a map item with the specified ID and Data values.
</short>
@ -872,7 +872,7 @@
<short>Map item to locate in the AVL Tree.</short>
</element>
<element name="TMap.GetData" link="#lazutils.maps.TBaseMap.InternalGetData">
<element name="TMap.GetData">
<short>
Gets the Data for the map item with the specified ID.
</short>
@ -888,7 +888,7 @@
<short/>
</element>
<element name="TMap.GetDataPtr" link="#lazutils.maps.TBaseMap.InternalGetDataPtr">
<element name="TMap.GetDataPtr">
<short>Gets a Pointer to the data for the specified map item.</short>
<descr/>
</element>
@ -899,7 +899,7 @@
<short/>
</element>
<element name="TMap.SetData" link="#lazutils.maps.TBaseMap.InternalSetData">
<element name="TMap.SetData">
<short>Stores the data for the specified map item.</short>
<descr/>
</element>
@ -913,50 +913,68 @@
<short/>
</element>
<element name="TMapIterator" link="#lazutils.maps.TBaseMapIterator">
<element name="TMapIterator">
<short>Implements an iterator for items in a map.</short>
<descr>
<p>
<var>TMapIterator</var> is a <var>TBaseMapIterator</var> descendant that implements an iterator for items in a map. TMapIterator provides methods to initialize the iterator for a map. It also provides methods to read the IDs for map items, and to read and write the Data in map items. TMapIterator also provides an implementation of the Locate method.
</p>
</descr>
<seealso>
<link id="TBaseMapIterator"/>
</seealso>
</element>
<element name="TMapIterator.Create" link="#lazutils.maps.TBaseMapIterator.InternalCreate">
<element name="TMapIterator.Create">
<short>Constructor for the class instance.</short>
<seealso>
<link id="TBaseMapIterator.InternalCreate"/>
</seealso>
<descr/>
</element>
<element name="TMapIterator.Create.AMap">
<short>Map with IDs and Data for the iterator.</short>
</element>
<element name="TMapIterator.DataPtr" link="#lazutils.maps.TBaseMap.InternalGetDataPtr">
<element name="TMapIterator.DataPtr">
<short>Gets the Pointer to the Data in a map item.</short>
<descr/>
<seealso>
<link id="TBaseMap.InternalGetDataPtr"/>
</seealso>
</element>
<element name="TMapIterator.DataPtr.Result" link="#lazutils.maps.TBaseMap.InternalGetDataPtr.Result">
<short/>
</element>
<element name="TMapIterator.GetData" link="#lazutils.maps.TBaseMap.InternalGetData">
<element name="TMapIterator.GetData">
<short>Gets the Data for a map item.</short>
<seealso>
<link id="TBaseMap.InternalGetData"/>
</seealso>
<descr/>
</element>
<element name="TMapIterator.GetData.AData" link="#lazutils.maps.TBaseMap.InternalGetData,AData">
<short>Data for the map item.</short>
</element>
<element name="TMapIterator.GetID" link="#lazutils.maps.TBaseMap.InternalGetID">
<element name="TMapIterator.GetID">
<short>Gets the ID for a map item.</short>
<descr/>
<seealso>
<link id="TBaseMap.InternalGetID"/>
</seealso>
</element>
<element name="TMapIterator.GetID.AID" link="#lazutils.maps.TBaseMap.InternalGetID.AID">
<short/>
</element>
<element name="TMapIterator.Locate" link="#lazutils.maps.TBaseMapIterator.InternalLocate">
<element name="TMapIterator.Locate">
<short>Locates a map item with the specified ID.</short>
<descr/>
<seealso>
<link id="TBaseMapIterator.InternalLocate"/>
</seealso>
</element>
<element name="TMapIterator.Locate.Result" link="#lazutils.maps.TBaseMapIterator.InternalLocate.Result">
<short/>
@ -965,9 +983,12 @@
<short/>
</element>
<element name="TMapIterator.SetData" link="#lazutils.maps.TBaseMap.InternalSetData">
<element name="TMapIterator.SetData">
<short>Sets the Data for a map item.</short>
<descr/>
<seealso>
<link id="TBaseMap.InternalSetData"/>
</seealso>
</element>
<element name="TMapIterator.SetData.AData" link="#lazutils.maps.TBaseMap.InternalSetData.AData">
<short/>
@ -995,7 +1016,7 @@
<seealso/>
</element>
<element name="TTypedMap" link="#lazutils.maps.TMap">
<element name="TTypedMap">
<short>
Implements a map with support for reference counted Type Information in the Data.
</short>
@ -1004,6 +1025,9 @@
TTypedMap is a TBaseMap map descendant that implements a map with support for reference counted Type Information in the Data for map items.
</p>
</descr>
<seealso>
<link id="TBaseMap"/>
</seealso>
</element>
<element name="TTypedMap.FTypeInfo"/>
@ -1107,13 +1131,16 @@
<short/>
</element>
<element name="TTypedMapIterator" link="#lazutils.maps.TMapIterator">
<element name="TTypedMapIterator">
<short>Implements an iterator for items in a map.</short>
<descr>
<p>
<var>TTypedMapIterator</var> is a <var>TMapIterator</var> descendant that implements an iterator for map items with reference counted Type Information in their Data. TTypedMapIterator provides methods to initialize the iterator for a map. It also provides methods to read the IDs for map items, and to read and write the Data in map items. TTypedMapIterator also provides an implementation of the Locate method.
</p>
</descr>
<seealso>
<link id="TMapIterator"/>
</seealso>
</element>
<element name="TTypedMapIterator.Create">

62
docs/xml/lazutils/textstrings.xml
View File

@ -249,11 +249,10 @@
</seealso>
</element>
<element name="TTextStrings.Get" link="#rtl.classes.TStrings.Get">
<element name="TTextStrings.Get">
<short>Gets the value for the indexed Strings property.</short>
<descr/>
<seealso>
<link id="#rtl.classes.TStrings.Get">TStrings.Get</link>
<link id="#rtl.classes.TStrings.Strings">TStrings.Strings</link>
</seealso>
</element>
@ -285,12 +284,11 @@
</seealso>
</element>
<element name="TTextStrings.GetObject" link="#rtl.classes.TStrings.GetObject">
<element name="TTextStrings.GetObject">
<short>Gets the value for the indexed Objects property.</short>
<descr/>
<seealso>
<link id="#rtl.classes.TStrings.Objects">TStrings.Objects</link>
<link id="#rtl.classes.TStrings.GetObject">TStrings.GetObject</link>
</seealso>
</element>
<element name="TTextStrings.GetObject.Result">
@ -300,12 +298,11 @@
<short>Ordinal position in Objects with the property value.</short>
</element>
<element name="TTextStrings.Put" link="#rtl.classes.TStrings.Put">
<element name="TTextStrings.Put">
<short>Sets the value for the indexed Strings property.</short>
<descr/>
<seealso>
<link id="#rtl.classes.TStrings.Strings">TStrings.Strings</link>
<link id="#rtl.classes.TStrings.Put">TStrings.Put</link>
</seealso>
</element>
<element name="TTextStrings.Put.Index">
@ -315,7 +312,7 @@
<short>New value in the indexed property.</short>
</element>
<element name="TTextStrings.PutObject" link="#rtl.classes.TStrings.PutObject">
<element name="TTextStrings.PutObject">
<short>Sets a value in the indexed Objects property.</short>
<descr/>
<seealso/>
@ -391,7 +388,7 @@
<seealso/>
</element>
<element name="TTextStrings.Destroy" link="#rtl.classes.TStrings.Destroy">
<element name="TTextStrings.Destroy">
<short>Destructor for the class instance.</short>
<descr>
<p>
@ -407,7 +404,7 @@
</seealso>
</element>
<element name="TTextStrings.Clear" link="#rtl.classes.TStrings.Clear">
<element name="TTextStrings.Clear">
<short>Clears the text and internal line ranges for the component.</short>
<descr>
<p>
@ -430,7 +427,7 @@
</seealso>
</element>
<element name="TTextStrings.SetText" link="#rtl.classes.TStrings.SetText">
<element name="TTextStrings.SetText">
<short>Sets the value for the Text property from a PChar type.</short>
<descr>
<p>
@ -443,13 +440,15 @@
SetText re-implements the method from the ancestor, and does <b>not</b> call the inherited method.
</p>
</descr>
<seealso/>
<seealso>
<link id="#rtl.classes.TStrings.SetText">TStrings.SetText</link>
</seealso>
</element>
<element name="TTextStrings.SetText.TheText">
<short>New value for the property.</short>
</element>
<element name="TTextStrings.Insert" link="#rtl.classes.TStrings.Insert">
<element name="TTextStrings.Insert">
<short>Inserts the line of text in S at the specified position.</short>
<descr>
<p>
@ -477,7 +476,9 @@
<errors>
Raises an EListError exception if Index contains an invalild position in the list of string values.
</errors>
<seealso/>
<seealso>
<link id="#rtl.classes.TStrings.Insert">TStrings.Insert</link>
</seealso>
</element>
<element name="TTextStrings.Insert.Index">
<short>Ordinal position where the line of text is inserted.</short>
@ -486,7 +487,7 @@
<short>Value for the line of text inserted in the method.</short>
</element>
<element name="TTextStrings.Delete" link="#rtl.classes.TStrings.Delete">
<element name="TTextStrings.Delete">
<short>Deletes the line of text at the specified position.</short>
<descr>
<p>
@ -507,15 +508,16 @@
<link id="TTextStrings.Text"/>
<link id="TTextLineRange"/>
<link id="EStringListError"/>
<link id="#rtl.systems.classes.TStrings.Count">TStrings.Count</link>
<link id="#rtl.systems.classes.TStrings.Strings">TStrings.Strings</link>
<link id="#rtl.classes.TStrings.Count">TStrings.Count</link>
<link id="#rtl.classes.TStrings.Delete">TStrings.Delete</link>
<link id="#rtl.classes.TStrings.Strings">TStrings.Strings</link>
</seealso>
</element>
<element name="TTextStrings.Delete.Index">
<short>Ordinal position for the value removed from the Strings property.</short>
</element>
<element name="TTextStrings.Exchange" link="#rtl.classes.TStrings.Exchange">
<element name="TTextStrings.Exchange">
<short>Swaps the line values at the specified positions.</short>
<descr>
<p>
@ -540,7 +542,9 @@
Exchange re-implements the method defined in the ancestor, and does <b>not</b> call the inherited method.
</p>
</descr>
<seealso/>
<seealso>
<link id="#rtl.classes.TStrings.Exchange">TStrings.Exchange</link>
</seealso>
</element>
<element name="TTextStrings.Exchange.Index1">
<short>First position for the value exchange.</short>
@ -549,10 +553,12 @@
<short>Second position for the value exchange.</short>
</element>
<element name="TTextStrings.Move" link="#rtl.classes.TStrings.Move">
<element name="TTextStrings.Move">
<short>Moves a String value from the current position to the new position.</short>
<descr/>
<seealso/>
<seealso>
<link id="#rtl.classes.TStrings.Move">TStrings.Move</link>
</seealso>
</element>
<element name="TTextStrings.Move.CurIndex">
<short>Current ordinal position for the string.</short>
@ -593,7 +599,7 @@
</seealso>
</element>
<element name="TTextStrings.EndUpdate" link="#rtl.classes.TStrings.EndUpdate">
<element name="TTextStrings.EndUpdate">
<short>Finishes an update process for the component.</short>
<descr>
<p>
@ -617,10 +623,11 @@
</errors>
<seealso>
<link id="TTextStrings.BeginUpdate"/>
<link id="#rtl.classes.TStrings.EndUpdate">TStrings.EndUpdate</link>
</seealso>
</element>
<element name="TTextStrings.GetText" link="#rtl.classes.TStrings.GetText">
<element name="TTextStrings.GetText">
<short>Gets the value for the Text property as a PChar type.</short>
<descr/>
<seealso>
@ -632,11 +639,11 @@
<short>Value for the property as a PChar type.</short>
</element>
<element name="TTextStrings.IndexOf" link="#rtl.classes.TStrings.IndexOf">
<element name="TTextStrings.IndexOf">
<short>Gets the ordinal position for the specified String value.</short>
<descr/>
<link id="#rtl.classes.TStrings.IndexOf">TStrings.IndexOf</link>
<seealso>
<link id="#rtl.classes.TStrings.IndexOf">TStrings.IndexOf</link>
</seealso>
</element>
<element name="TTextStrings.IndexOf.Result">
@ -646,7 +653,7 @@
<short>Value to locate in the method.</short>
</element>
<element name="TTextStrings.Add" link="#rtl.classes.TStrings.Add">
<element name="TTextStrings.Add">
<short>Appends the specified text to the values in Strings.</short>
<descr>
<p>
@ -695,7 +702,7 @@
<short>TObject instance (or Nil) added to the component.</short>
</element>
<element name="TTextStrings.AddStrings" link="#rtl.classes.TStrings.AddStrings">
<element name="TTextStrings.AddStrings">
<short/>
<descr>
<p>
@ -742,7 +749,7 @@
<short>File name where the content is stored.</short>
</element>
<element name="TTextStrings.Text" link="#rtl.classes.TStrings.Text">
<element name="TTextStrings.Text">
<short>Contains the textual representation for the values in Strings.</short>
<descr>
<p>
@ -750,7 +757,6 @@
</p>
</descr>
<seealso>
<link id="TTextStrings.SetTextStr"/>
<link id="#rtl.classes.TStrings.Text">TStrings.Text</link>
</seealso>
</element>