paweld/lazarus
1
0
Fork 0
mirror of https://gitlab.com/freepascal.org/lazarus/lazarus.git synced 2025-08-16 19:29:34 +02:00
Code Issues Packages Projects Releases Wiki Activity

Docs: LCL/LazUtils/various. Removes deprecated topics and modules for changes in 74446557.

Browse Source
This commit is contained in:
dsiders 2023-06-15 03:34:52 +01:00
parent b949b1d54f
commit c3e5af4513
10 changed files with 0 additions and 451 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

88
docs/xml/lazutils/fileutil.xml
View File

@ -594,94 +594,6 @@ The name of the directory compared to the file name.
</short>
</element>
<element name="ExtractFileNameWithoutExt">
<short>
Returns the file name without a file extension.
</short>
</element>
<element name="ExtractFileNameWithoutExt.Result">
<short>
Returns the original file name if it had no extension, otherwise returns the
file name with its extension removed.
</short>
</element>
<element name="ExtractFileNameWithoutExt.AFilename">
<short>
The name of the file for checking.
</short>
</element>
<element name="CreateAbsoluteSearchPath">
<short>
Forms an absolute search path for files from values in
<var>BaseDirectory</var> and <var>SearchPath</var>.
</short>
<descr>
<p>
<var>CreateAbsoluteSearchPath</var> - concatenates <var>BaseDirectory</var>
and <var>SearchPath</var> to form an absolute path to search for files.
</p>
<p>
The routine adds the appropriate path delimiters to the BaseDirectory string,
and adds the search path. Each directory in the search path is examined to
ensure that each is also an absolute directory path. The return value
contains the fully-formed absolute search path.
</p>
<p>
If <var>BaseDirectory</var> is empty, the function exits with a return value
equal to <var>SearchPath</var>. if <var>SearchPath</var> is empty, the
function exits with empty string <b>('')</b> in the return value.
</p>
<p>
Deprecated. Use the CreateAbsoluteSearchPath function from the LazFileUtils
unit.
</p>
</descr>
<version>
Deprecated in LCL version 2.1.0.
</version>
</element>
<element name="CreateAbsoluteSearchPath.Result">
<short>
The absolute path formed by concatenating <var>BaseDirectory</var> and
<var>SearchPath</var>.
</short>
</element>
<element name="CreateAbsoluteSearchPath.SearchPath">
<short>
The search path (a relative path).
</short>
</element>
<element name="CreateAbsoluteSearchPath.BaseDirectory">
<short>
The base directory from which to form the absolute path.
</short>
</element>
<element name="CreateAbsolutePath">
<short>
Deprecated.
</short>
<descr>
<p>
Deprecated. Use the CreateAbsolutePath function from the
<file>LazFileUtils</file> unit.
</p>
</descr>
<seealso>
<link id="#lazutils.lazfileutils.CreateAbsolutePath">CreateAbsolutePath</link>
</seealso>
</element>
<element name="CreateAbsolutePath.Filename">
<short/>
</element>
<element name="CreateAbsolutePath.BaseDirectory">
<short/>
</element>
<element name="CreateAbsolutePath.Result">
<short/>
</element>
<element name="GetAllFilesMask">
<short>
Gets the file mask representing all files in a file filter.

5
docs/xml/lazutils/lazloggerbase.xml
View File

@ -615,11 +615,6 @@ class to perform the actions needed for the logger type.
</seealso>
</element>
<!-- procedure Visibility: protected -->
<element name="TLazLogger.DoFinsh">
<short>Deprecated. Use DoFinish instead.</short>
</element>
<!-- procedure Visibility: protected -->
<element name="TLazLogger.IncreaseIndent">
<short>Increases the nesting level for the logger.</short>

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

@ -370,22 +370,6 @@ Converts CR or LF characters in a string to the specified delimiter character.
<short>Delimiter character used in place of CR, LF characters.</short>
</element>
<element name="ConvertLineEndings">
<short>Deprecated.</short>
<descr>
<remark>Deprecated. Use LineBreaksToSystemLineBreaks instead.</remark>
</descr>
<seealso>
<link id="LineBreaksToSystemLineBreaks"/>
</seealso>
</element>
<element name="ConvertLineEndings.Result">
<short>Value after converting the line endings.</short>
</element>
<element name="ConvertLineEndings.s">
<short>Value with line endings to convert in the routine.</short>
</element>
<element name="TabsToSpaces">
<short>
Converts all Tab characters in a string to the specified number of space

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

@ -1,247 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<fpdoc-descriptions>
<package name="lazutils">
<!-- lazutf8classes -->
<module name="lazutf8classes">
<short>
Implements UTF-8-enabled classes and routines.
</short>
<descr>
<p>
<file>lazutf8classes.pas</file> implements UTF-8-enabled classes and
routines, including: TFileStreamUTF8, TMemoryStreamUTF8, and TStringListUTF8.
<file>lazutf8classes.pas</file> is part of the <file>LazUtils</file> package.
</p>
<remark>
lazutf8classes has an implementation dependency on the
<file>lazfileutils.pas</file> unit.
</remark>
</descr>
<!-- class Visibility: default -->
<element name="TFileStreamUTF8">
<short>
Alias for the TFileStream type.
</short>
<descr/>
<seealso>
<link id="#rtl.classes.TFileStream">TFileStream</link>
</seealso>
</element>
<element name="TStringListUTF8">
<short>
Implements a UTF-8-enabled string list. <b>Deprecated</b>.
</short>
<descr>
<p>
TStringListUTF8 is a TStringList descendant that implements a string list
that can store data which uses UTF-8 encoding. TStringListUTF8 provides an
overridden method used to sort items in the list using UTF-8 string
comparisons.
</p>
</descr>
<remark>
TStringListUTF8 has been marked as <b>deprecated</b>. Use TStringList instead.
</remark>
<seealso>
<link id="#rtl.classes.TStringList">TStringList</link>
</seealso>
</element>
<element name="TStringListUTF8.DoCompareText">
<short>
Compares UTF-8-encoded lines in the string list.
</short>
<descr>
<p>
DoCompareText is PtrInt function used to compare the specified values using
UTF-8 string comparison routines. DoCompareText uses the value in
CaseSensitive to determine the routine used for the comparison. When
CaseSensitive contains <b>True</b>, the UTF8CompareStr is used. Otherwise,
UTF8CompareText is called. The return value contains the result from the
routine.
</p>
</descr>
<seealso></seealso>
</element>
<element name="TStringListUTF8.DoCompareText.Result">
<short>Value from the string comparison.</short>
</element>
<element name="TStringListUTF8.DoCompareText.s1">
<short>First string value for the comparison.</short>
</element>
<element name="TStringListUTF8.DoCompareText.s2">
<short>Second string value for the comparison.</short>
</element>
<element name="TStringListUTF8.LoadFromFile">
<short>
Loads the content in the string list from the specified file.
</short>
<descr>
<p>
<var>LoadFromFile</var> is a procedure used to load the content for the
string list from the specified file name. 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>
<link id="#rtl.classes.TStrings.LoadFromFile">TStrings.LoadFromFile</link>
</seealso>
</element>
<element name="TStringListUTF8.LoadFromFile.FileName">
<short>File name with content for the string list.</short>
</element>
<element name="TStringListUTF8.SaveToFile">
<short>
Saves the content in the string to the specified file name.
</short>
<descr>
<p>
<var>SaveToFile</var> is a procedure used to save the content in the string
list to the specified file name. 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>
<link id="#rtl.classes.TStrings.SaveToFile">TStrings.SaveToFile</link>
</seealso>
</element>
<element name="TStringListUTF8.SaveToFile.FileName">
<short>File name where content in the string list is stored.</short>
</element>
<element name="TMemoryStreamUTF8">
<short>
Implements a memory stream with support for UTF-8-encoded content.
<b>Deprecated</b>.
</short>
<descr>
<p>
<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 content from files with UTF-8-encoded
content.
</p>
</descr>
<remark>
TMemoryStreamUTF8 has been marked as <b>deprecated</b>. Use TMemoryStream
instead.
</remark>
<seealso>
<link id="#rtl.classes.TMemoryStream">TMemoryStream</link>
</seealso>
</element>
<element name="TMemoryStreamUTF8.LoadFromFile">
<short>
Loads the content in the stream from the specified file.
</short>
<descr>
<p>
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>
<link id="#rtl.classes.TMemoryStream.LoadFromFile">TMemoryStream.LoadFromFile</link>
</seealso>
</element>
<element name="TMemoryStreamUTF8.LoadFromFile.FileName">
<short>File name where where content for the stream is stored.</short>
</element>
<element name="TMemoryStreamUTF8.SaveToFile">
<short>
Stores the content in the stream to the specified file.
</short>
<descr>
<p>
<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
UTF-8-encoded values in the memory stream to the file.
</p>
</descr>
<seealso>
<link id="#rtl.classes.TCustomMemoryStream.SaveToFile">TCustomMemoryStream.SaveToFile</link>
</seealso>
</element>
<element name="TMemoryStreamUTF8.SaveToFile.FileName">
<short>File name where content in the stream is stored.</short>
</element>
<element name="LoadStringsFromFileUTF8">
<short>
Loads the content for a TStringList from the specified file name.
<b>Deprecated</b>.
</short>
<descr>
<p>
LoadStringsFromFileUTF8 is a procedure used to load the content for a string
list from the specified file name.
</p>
<p>
List is the TStrings descendant where the content from FileName is stored.
FileName can contain UTF-8-encoded characters.
</p>
<p>
LoadStringsFromFileUTF8 creates an internal TStringListUTF8 instance (when
needed) that is used to load the UTF-8-encoded content in FileName. It calls
the Assign method in List to store the values.
</p>
</descr>
<remark>
LoadStringsFromFileUTF8 has been marked as <b>deprecated</b>. Use the
LoadFromFile method in TStrings instead.
</remark>
<seealso></seealso>
</element>
<element name="LoadStringsFromFileUTF8.List">
<short>TStrings descendant where the content is stored.</short>
</element>
<element name="LoadStringsFromFileUTF8.FileName">
<short>File name with the content to load in the string list.</short>
</element>
<element name="SaveStringsToFileUTF8">
<short>
Saves the content in the TStringList to the specified file name.
<b>Deprecated</b>.
</short>
<descr>
<p>
SaveStringsToFileUTF8 is a procedure used to save the content in the List to
the specified file name. List is a TStrings descendant with the content to
store in the specified file name. SaveStringsToFileUTF8 uses a
TStringListUTF8 (when needed) to store the UTF-8-encoded content in the
string list to the specified FileName.
</p>
</descr>
<remark>
SaveStringsToFileUTF8 has been marked as <b>deprecated</b>. Use the
SaveToFile method in TStrings instead.
</remark>
<seealsao></seealsao>
</element>
<element name="SaveStringsToFileUTF8.List">
<short>String list to store in the specified file.</short>
</element>
<element name="SaveStringsToFileUTF8.FileName">
<short>Name of the file where the content is stored.</short>
</element>
</module>
<!-- lazutf8classes -->
</package>
</fpdoc-descriptions>

41
docs/xml/lazutils/lazutf8sysutils.xml
View File

@ -1,41 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<fpdoc-descriptions>
<package name="lazutils">
<!--
====================================================================
lazutf8sysutils
====================================================================
-->
<module name="lazutf8sysutils">
<short>Unit renamed to LazSysUtils.</short>
<descr>
<p>
<file>lazutf8sysutils.pas</file> was renamed to <file>lazsysutils.pas</file>.
All routines will give a "deprecated" warning; the unit will be removed later.
</p>
</descr>
<!-- function Visibility: default -->
<element name="NowUTC">
<short>Deprecated; use the function from the LazSysUtils unit.</short>
</element>
<!-- function result Visibility: default -->
<element name="NowUTC.Result">
<short>Current Date/Time value in UTC.</short>
</element>
<!-- function Visibility: default -->
<element name="GetTickCount64">
<short>Deprecated; use the function from the LazSysUtils unit.</short>
</element>
<!-- function result Visibility: default -->
<element name="GetTickCount64.Result">
<short>Number of ticks (milliseconds).</short>
</element>
</module>
<!-- lazutf8sysutils -->
</package>
</fpdoc-descriptions>

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

@ -54,7 +54,6 @@ This unit contains code in the initialization section to register the
<element name="LazUnicode"/>
<element name="LazUTF16"/>
<element name="LazUTF8"/>
<element name="LazUTF8Classes"/>
<element name="LazSysUtils"/>
<element name="LazUtilities"/>
<element name="LazUtilsStrConsts"/>
@ -77,7 +76,6 @@ This unit contains code in the initialization section to register the
<element name="GraphType"/>
<element name="LazTracer"/>
<element name="LazStringUtils"/>
<element name="LazUTF8SysUtils"/>
<element name="ObjectLists"/>
<element name="CodepagesAsian"/>
<element name="CodepagesCommon"/>

16
docs/xml/lazutils/lconvencoding.xml
View File

@ -1370,22 +1370,6 @@ translation array in ArrayKOI8RToUTF8.
<short>String with the value in the KOI8R encoding.</short>
</element>
<element name="KOI8ToUTF8">
<short>
Deprecated in Lazarus 2.2.0. Use KOI8RToUTF8 instead.
</short>
<descr>
<p>
Deprecated in Lazarus 2.2.0. Use KOI8RToUTF8 instead.
</p>
</descr>
<seealso>
<link id="KOI8RToUTF8"/>
</seealso>
</element>
<element name="KOI8ToUTF8.Result"/>
<element name="KOI8ToUTF8.s"/>
<element name="MacintoshToUTF8">
<short>
Converts a value encoded using the the Macintosh Code Page to UTF-8.

14
docs/xml/lcl/dialogs.xml
View File

@ -1447,7 +1447,6 @@ property.
</descr>
<seealso>
<link id="TOpenDialog.DoExecute"/>
<link id="TOpenDialog.DereferenceLinks"/>
<link id="TOpenDialog.Options"/>
<link id="TFileDialog.Filename"/>
<link id="TFileDialog.Files"/>
@ -1455,19 +1454,6 @@ property.
</seealso>
</element>
<element name="TOpenDialog.DereferenceLinks">
<short>Resolves referential links.</short>
<descr>
<p>
Deprecated since LCL version 1.9. Use or override the ResolveLinks method
instead.
</p>
</descr>
<seealso>
<link id="TOpenDialog.ResolveLinks"/>
</seealso>
</element>
<element name="TOpenDialog.CheckFile">
<short>
Ensures the specified file name meets the requirements for the dialog.

15
docs/xml/lcl/lcltranslator.xml
View File

@ -557,7 +557,6 @@ perform the update to user interface elements.
<link id="TPOTranslator"/>
<link id="TDefaultTranslator"/>
<link id="TUpdateTranslator"/>
<link id="GetDefaultLang"/>
</seealso>
</element>
<element name="SetDefaultLang.Lang">
@ -589,20 +588,6 @@ code is not available or an error occurs.
</short>
</element>
<element name="GetDefaultLang">
<short>Deprecated.</short>
<descr>
<p>
Deprecated. Use the result from the SetDefaultLang function instead.
</p>
</descr>
<version>Deprecated in LCL version 2.1.0.</version>
<seealso><link id="SetDefaultLang"/></seealso>
</element>
<element name="GetDefaultLang.Result">
<short>Default language code currently in use.</short>
</element>
</module>
<!-- LCLTranslator -->
</package>

7
docs/xml/lcl/stdctrls.xml
View File

@ -1638,7 +1638,6 @@ platforms, including Windows and macOS Carbon. It is best to set AutoSize to
<element name="TCustomComboBox.FCharCase"/>
<element name="TCustomComboBox.FDropDownCount"/>
<element name="TCustomComboBox.FDroppedDown"/>
<element name="TCustomComboBox.FDroppingDown"/>
<element name="TCustomComboBox.FEditingDone"/>
<element name="TCustomComboBox.FEmulatedTextHintStatus"/>
<element name="TCustomComboBox.FItemHeight"/>
@ -3652,12 +3651,6 @@ cause the drop-down list to be displayed when Style is set to csDropDownList.
</seealso>
</element>
<element name="TCustomComboBox.DroppingDown">
<short>Deprecated.</short>
<descr>Deprecated. Will be removed in Lazarus 2.2.</descr>
<seealso/>
</element>
<element name="TCustomComboBox.SelectAll">
<short>Selects the text content in the edit box for the control.</short>
<descr>