From c3e5af45136f515f08bf236ab7082cfabe34a912 Mon Sep 17 00:00:00 2001 From: dsiders Date: Thu, 15 Jun 2023 03:34:52 +0100 Subject: [PATCH] Docs: LCL/LazUtils/various. Removes deprecated topics and modules for changes in 74446557. --- docs/xml/lazutils/fileutil.xml | 88 --------- docs/xml/lazutils/lazloggerbase.xml | 5 - docs/xml/lazutils/lazstringutils.xml | 16 -- docs/xml/lazutils/lazutf8classes.xml | 247 -------------------------- docs/xml/lazutils/lazutf8sysutils.xml | 41 ----- docs/xml/lazutils/lazutils.xml | 2 - docs/xml/lazutils/lconvencoding.xml | 16 -- docs/xml/lcl/dialogs.xml | 14 -- docs/xml/lcl/lcltranslator.xml | 15 -- docs/xml/lcl/stdctrls.xml | 7 - 10 files changed, 451 deletions(-) delete mode 100644 docs/xml/lazutils/lazutf8classes.xml delete mode 100644 docs/xml/lazutils/lazutf8sysutils.xml diff --git a/docs/xml/lazutils/fileutil.xml b/docs/xml/lazutils/fileutil.xml index b0b3271745..a91bfedf41 100644 --- a/docs/xml/lazutils/fileutil.xml +++ b/docs/xml/lazutils/fileutil.xml @@ -594,94 +594,6 @@ The name of the directory compared to the file name. - - -Returns the file name without a file extension. - - - - -Returns the original file name if it had no extension, otherwise returns the -file name with its extension removed. - - - - -The name of the file for checking. - - - - - -Forms an absolute search path for files from values in -BaseDirectory and SearchPath. - - -

-CreateAbsoluteSearchPath - concatenates BaseDirectory -and SearchPath to form an absolute path to search for files. -

-

-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. -

-

-If BaseDirectory is empty, the function exits with a return value -equal to SearchPath. if SearchPath is empty, the -function exits with empty string ('') in the return value. -

-

-Deprecated. Use the CreateAbsoluteSearchPath function from the LazFileUtils -unit. -

-
- -Deprecated in LCL version 2.1.0. - -
- - -The absolute path formed by concatenating BaseDirectory and -SearchPath. - - - - -The search path (a relative path). - - - - -The base directory from which to form the absolute path. - - - - - -Deprecated. - - -

-Deprecated. Use the CreateAbsolutePath function from the -LazFileUtils unit. -

-
- -CreateAbsolutePath - -
- - - - - - - - - - Gets the file mask representing all files in a file filter. diff --git a/docs/xml/lazutils/lazloggerbase.xml b/docs/xml/lazutils/lazloggerbase.xml index f8a477092a..7dc1d76dd6 100644 --- a/docs/xml/lazutils/lazloggerbase.xml +++ b/docs/xml/lazutils/lazloggerbase.xml @@ -615,11 +615,6 @@ class to perform the actions needed for the logger type. - - -Deprecated. Use DoFinish instead. - - Increases the nesting level for the logger. diff --git a/docs/xml/lazutils/lazstringutils.xml b/docs/xml/lazutils/lazstringutils.xml index 80cc991b6b..e9fcbe4c9c 100644 --- a/docs/xml/lazutils/lazstringutils.xml +++ b/docs/xml/lazutils/lazstringutils.xml @@ -370,22 +370,6 @@ Converts CR or LF characters in a string to the specified delimiter character. Delimiter character used in place of CR, LF characters. - -Deprecated. - -Deprecated. Use LineBreaksToSystemLineBreaks instead. - - - - - - -Value after converting the line endings. - - -Value with line endings to convert in the routine. - - Converts all Tab characters in a string to the specified number of space diff --git a/docs/xml/lazutils/lazutf8classes.xml b/docs/xml/lazutils/lazutf8classes.xml deleted file mode 100644 index a898efa7e8..0000000000 --- a/docs/xml/lazutils/lazutf8classes.xml +++ /dev/null @@ -1,247 +0,0 @@ - - - - - - - -Implements UTF-8-enabled classes and routines. - - -

-lazutf8classes.pas implements UTF-8-enabled classes and -routines, including: TFileStreamUTF8, TMemoryStreamUTF8, and TStringListUTF8. -lazutf8classes.pas is part of the LazUtils package. -

- -lazutf8classes has an implementation dependency on the -lazfileutils.pas unit. - -
- - - - -Alias for the TFileStream type. - - - -TFileStream - - - - - -Implements a UTF-8-enabled string list. Deprecated. - - -

-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. -

-
- -TStringListUTF8 has been marked as deprecated. Use TStringList instead. - - -TStringList - -
- - - -Compares UTF-8-encoded lines in the string list. - - -

-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 True, the UTF8CompareStr is used. Otherwise, -UTF8CompareText is called. The return value contains the result from the -routine. -

-
- -
- -Value from the string comparison. - - -First string value for the comparison. - - -Second string value for the comparison. - - - - -Loads the content in the string list from the specified file. - - -

-LoadFromFile 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. -

-
- -TStrings.LoadFromFile - -
- -File name with content for the string list. - - - - -Saves the content in the string to the specified file name. - - -

-SaveToFile 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. -

-
- -TStrings.SaveToFile - -
- -File name where content in the string list is stored. - - - - -Implements a memory stream with support for UTF-8-encoded content. -Deprecated. - - -

-TMemoryStreamUTF8 is a TMemoryStream 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. -

-
- -TMemoryStreamUTF8 has been marked as deprecated. Use TMemoryStream -instead. - - -TMemoryStream - -
- - - -Loads the content in the stream from the specified file. - - -

-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. -

-
- -TMemoryStream.LoadFromFile - -
- - -File name where where content for the stream is stored. - - - - -Stores the content in the stream to the specified file. - - -

-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 -UTF-8-encoded values in the memory stream to the file. -

-
- -TCustomMemoryStream.SaveToFile - -
- - -File name where content in the stream is stored. - - - - -Loads the content for a TStringList from the specified file name. -Deprecated. - - -

-LoadStringsFromFileUTF8 is a procedure used to load the content for a string -list from the specified file name. -

-

-List is the TStrings descendant where the content from FileName is stored. -FileName can contain UTF-8-encoded characters. -

-

-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. -

-
- -LoadStringsFromFileUTF8 has been marked as deprecated. Use the -LoadFromFile method in TStrings instead. - - -
- -TStrings descendant where the content is stored. - - -File name with the content to load in the string list. - - - - -Saves the content in the TStringList to the specified file name. -Deprecated. - - -

-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. -

-
- -SaveStringsToFileUTF8 has been marked as deprecated. Use the -SaveToFile method in TStrings instead. - - -
- -String list to store in the specified file. - - -Name of the file where the content is stored. - - -
- - -
-
diff --git a/docs/xml/lazutils/lazutf8sysutils.xml b/docs/xml/lazutils/lazutf8sysutils.xml deleted file mode 100644 index 896d64b422..0000000000 --- a/docs/xml/lazutils/lazutf8sysutils.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - -Unit renamed to LazSysUtils. - -

-lazutf8sysutils.pas was renamed to lazsysutils.pas. -All routines will give a "deprecated" warning; the unit will be removed later. -

-
- - - -Deprecated; use the function from the LazSysUtils unit. - - - - -Current Date/Time value in UTC. - - - - -Deprecated; use the function from the LazSysUtils unit. - - - - -Number of ticks (milliseconds). - - -
- -
-
diff --git a/docs/xml/lazutils/lazutils.xml b/docs/xml/lazutils/lazutils.xml index 14f0b480aa..d9ac44b69c 100644 --- a/docs/xml/lazutils/lazutils.xml +++ b/docs/xml/lazutils/lazutils.xml @@ -54,7 +54,6 @@ This unit contains code in the initialization section to register the - @@ -77,7 +76,6 @@ This unit contains code in the initialization section to register the - diff --git a/docs/xml/lazutils/lconvencoding.xml b/docs/xml/lazutils/lconvencoding.xml index e038063aab..4d7158b15a 100644 --- a/docs/xml/lazutils/lconvencoding.xml +++ b/docs/xml/lazutils/lconvencoding.xml @@ -1370,22 +1370,6 @@ translation array in ArrayKOI8RToUTF8. String with the value in the KOI8R encoding. - - -Deprecated in Lazarus 2.2.0. Use KOI8RToUTF8 instead. - - -

-Deprecated in Lazarus 2.2.0. Use KOI8RToUTF8 instead. -

-
- - - -
- - - Converts a value encoded using the the Macintosh Code Page to UTF-8. diff --git a/docs/xml/lcl/dialogs.xml b/docs/xml/lcl/dialogs.xml index e53bd72be3..8e978686c8 100644 --- a/docs/xml/lcl/dialogs.xml +++ b/docs/xml/lcl/dialogs.xml @@ -1447,7 +1447,6 @@ property. - @@ -1455,19 +1454,6 @@ property. - -Resolves referential links. - -

-Deprecated since LCL version 1.9. Use or override the ResolveLinks method -instead. -

-
- - - -
- Ensures the specified file name meets the requirements for the dialog. diff --git a/docs/xml/lcl/lcltranslator.xml b/docs/xml/lcl/lcltranslator.xml index 3eae6aef6d..d16c8be26d 100644 --- a/docs/xml/lcl/lcltranslator.xml +++ b/docs/xml/lcl/lcltranslator.xml @@ -557,7 +557,6 @@ perform the update to user interface elements. - @@ -589,20 +588,6 @@ code is not available or an error occurs.
- -Deprecated. - -

-Deprecated. Use the result from the SetDefaultLang function instead. -

-
-Deprecated in LCL version 2.1.0. - -
- -Default language code currently in use. - - diff --git a/docs/xml/lcl/stdctrls.xml b/docs/xml/lcl/stdctrls.xml index bdd7af60c3..2bad7cbb2b 100644 --- a/docs/xml/lcl/stdctrls.xml +++ b/docs/xml/lcl/stdctrls.xml @@ -1638,7 +1638,6 @@ platforms, including Windows and macOS Carbon. It is best to set AutoSize to - @@ -3652,12 +3651,6 @@ cause the drop-down list to be displayed when Style is set to csDropDownList. - -Deprecated. -Deprecated. Will be removed in Lazarus 2.2. - - - Selects the text content in the edit box for the control.