[Overview][Types][Classes][Procedures and functions][Variables][Index] Reference for unit 'LazUTF8' (#lazutils)

UTF8WrapText

Creates a word wrapped version of the specified string.

Declaration

Source position: lazutf8.pas line 150

function UTF8WrapText(

  S: string;

  BreakStr: string;

  BreakChars: TSysCharSet;

  MaxCol: Integer

):string; overload;

function UTF8WrapText(

  S: string;

  MaxCol: Integer

):string; overload;

Arguments

S

  

String with values word-wrapped in the routine.

BreakStr

  

End-of-line sequence used in the routine.

BreakChars

  

Set of characters where a line break cab be inserted.

MaxCol

  

Maximum line width in number of UTF-8 characters.

Function result

Word-wrapped version of the specified text.

Arguments

S

  

String with values word-wrapped in the routine.

MaxCol

  

Maximum line width in number of UTF-8 characters.

Description

UTF8WrapText is an overloaded String function used to wrap lines of text in S at the number of characters (codepoints) specified in MaxCol.

The overloaded variant allow additional parameters to be provided with the EOL character sequence and a set of characters where a line break can be inserted. Default characters are used in BreakChars for the variant without a BreakChars argument. They include: ' ' (Space), '-' (Dash), and #9 (Tab). BreakStr contains the end-of-line sequence used to represent a line break inserted into the return value.

No actions are performed in the function when S is an empty string (''), MaxCol is set to 0 (zero), or BreakChars is an empty set.


Version 3.2 Generated 2024-02-25 Home