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

Docs: LazUtils/lazutf16. Updates topics for changes in dd161fc0.

Browse Source
This commit is contained in:
dsiders 2023-07-05 17:40:00 +01:00
parent e676a483db
commit 619460681d
1 changed files with 37 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
docs/xml/lazutils/lazutf16.xml
View File

@ -45,14 +45,20 @@ a UTF-16 table, but it might be extended to include various UTF-16 routines.
Gets the length of the UTF-16 character in the specified PWideChar value.
</short>
<descr>
<p>
Uses the endian-ness for the platform. Returns 0, 1, or 2.
</p>
</descr>
</element>
<element name="UTF16CharacterLength.Result">
<short>Length of the UTF-16 character in the value, or 0 when Nil.</short>
<short>
Length of the UTF-16 character in the value, or 0 when <b>Nil</b>.
</short>
</element>
<element name="UTF16CharacterLength.p">
<short>PWideChar value examined in the routine.</short>
<short>
PWideChar value examined in the routine.
</short>
</element>
<element name="UTF16Length">
@ -110,6 +116,7 @@ specified value.
<short>Number of characters (code points) copied in the the routine.</short>
</element>
<!-- TODO: Needs description. -->
<element name="UTF16CharStart">
<short>
Gets a pointer to the character (UTF-16 codepoint) at the specified position
@ -211,23 +218,28 @@ when p contains an invalid UTF-16 code point.
<element name="UnicodeToUTF16">
<short>
Converts a Unicode character value to its UTF-16 equivalent as a WideString
value.
Converts a Unicode character (code point) to its UTF-16 equivalent as a UnicodeString type.
</short>
<descr>
<p>
Cardinal values below $10000 result in a single WideChar code value for the
code point. Other cardinal values result in 2 WideChar values in the result to
represent the UTF-16 code point.
Cardinal values below $10000 result in a single WideChar value for the code
point. Cardinal values in the range $D800 - $DFFF are reserved code points
and contain 2 WideChar values in the result to represent the UTF-16 code
point. WIdeChar values are cast to the UnicodeString type used in the return
value.
</p>
</descr>
<seealso/>
</element>
<element name="UnicodeToUTF16.Result">
<short>WideString value with UTF-16 code point the Unicode character.</short>
<short>
UnicodeString value for the specified UTF-16 code point.
</short>
</element>
<element name="UnicodeToUTF16.u">
<short>Unicode character value converted in the routine.</short>
<short>
Cardinal value with the UTF-16 code point converted in the routine.
</short>
</element>
<element name="IsUTF16CharValid">
@ -277,23 +289,24 @@ Next UTF-16 code examined in the method.
<element name="IsUTF16StringValid">
<short>
Determines if the specified WideString contains valid UTF-16 code points.
Determines if the specified Unicode string contains valid UTF-16 code points.
</short>
<descr>
<p>
Examines the content in AWideStr for valid UTF-16 characters. Calls
IsUTF16CharValid for consecutive code point pairs.
Examines the content in AStr for valid UTF-16 characters. Calls IsUTF16CharValid for consecutive code point pairs.
</p>
</descr>
<seealso/>
</element>
<element name="IsUTF16StringValid.Result">
<short>
True if the specified WideString contains valid UTF-16 code points.
<b>True</b> if the specified Unicode string contains valid UTF-16 code points.
</short>
</element>
<element name="IsUTF16StringValid.AWideStr">
<short>WideString examined in the routine.</short>
<short>
Unicode string examined in the routine.
</short>
</element>
<element name="Utf16StringReplace">
@ -383,6 +396,11 @@ Characters in the following Unicode blocks are handled:
<dd>ASCII variants in the Halfwidth and Fullwidth Forms block</dd>
</dl>
</descr>
<version>
Modified in LazUtils version 4.0 to dynamically initialize the character
mapping tables once when either UnicodeLowercase or UTF8LowerCaseViaTables is
called.
</version>
<seealso/>
</element>
<element name="UnicodeLowercase.Result">
@ -403,6 +421,11 @@ Converts a UTF-8-encoded string to lowercase UTF-8 values using internal
case tables.
</short>
<descr/>
<version>
Modified in LazUtils version 4.0 to dynamically initialize the character
mapping tables once when either UnicodeLowercase or UTF8LowerCaseViaTables is
called.
</version>
<seealso/>
</element>
<element name="UTF8LowerCaseViaTables.Result">