Difference between revisions of "Utf8.width"

From GiderosMobile
m (Text replacement - "<source" to "<syntaxhighlight")
 
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
<languages />
+
'''Available since:''' Gideros 2016.06<br/>
'''<translate>Available since</translate>:''' Gideros 2016.06<br/>
+
'''Class:''' [[utf8]]<br/>
'''<translate>Class</translate>:''' [[Special:MyLanguage/utf8|utf8]]<br/>
+
 
=== <translate>Description</translate> ===
+
=== Description ===
<translate>calculate the width of UTF-8 string s. if ambi_is_double is given, the ambiguous width character's width is 2, otherwise it's 1. fullwidth/doublewidth character's width is 2, and other character's width is 1. if default_width is given, it will be the width of unprintable character, used display a non-character mark for these characters. if s is a code point, return the width of this code point.</translate>
+
Calculates the width of UTF-8 string ''s''.
 
<syntaxhighlight lang="lua">
 
<syntaxhighlight lang="lua">
 
(number) = utf8.width(s,ambi_is_double,default_width)
 
(number) = utf8.width(s,ambi_is_double,default_width)
</source>
+
</syntaxhighlight>
=== <translate>Parameters</translate> ===
+
 
'''s''': (string) <translate></translate> <br/>
+
If ''ambi_is_double'' is given, the ambiguous width character width is 2, otherwise it is 1.
'''ambi_is_double''': (boolean) <translate></translate> '''optional'''<br/>
+
 
'''default_width''': (number) <translate></translate> '''optional'''<br/>
+
fullwidth/doublewidth character width is 2, and other characters width is 1.
=== <translate>Return values</translate> ===
+
 
'''<translate>Returns</translate>''' (number) <translate>width</translate><br/>
+
If ''default_width'' is given, it will be the width of unprintable character, used to display a non-character mark for these characters.
 +
 
 +
If ''s'' is a code point, returns the width of this code point.
 +
 
 +
=== Parameters ===
 +
'''s''': (string) <br/>
 +
'''ambi_is_double''': (boolean) '''optional'''<br/>
 +
'''default_width''': (number) '''optional'''<br/>
 +
 
 +
=== Return values ===
 +
'''Returns''' (number) string width<br/>
  
 
{{Utf8}}
 
{{Utf8}}

Latest revision as of 22:24, 1 December 2023

Available since: Gideros 2016.06
Class: utf8

Description

Calculates the width of UTF-8 string s.

(number) = utf8.width(s,ambi_is_double,default_width)

If ambi_is_double is given, the ambiguous width character width is 2, otherwise it is 1.

fullwidth/doublewidth character width is 2, and other characters width is 1.

If default_width is given, it will be the width of unprintable character, used to display a non-character mark for these characters.

If s is a code point, returns the width of this code point.

Parameters

s: (string)
ambi_is_double: (boolean) optional
default_width: (number) optional

Return values

Returns (number) string width