Difference between revisions of "Utf8.width"

From GiderosMobile
Line 2: Line 2:
 
'''Available since:''' Gideros 2016.06<br/>
 
'''Available since:''' Gideros 2016.06<br/>
 
=== Description ===
 
=== Description ===
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>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>
 
<source lang="lua">
 
<source lang="lua">
 
(number) = utf8.width(s,ambi_is_double,default_width)
 
(number) = utf8.width(s,ambi_is_double,default_width)
 
</source>
 
</source>
 
=== Parameters ===
 
=== Parameters ===
'''s''': (string) <br/>
+
'''s''': (string) <translate></translate> <br/>
'''ambi_is_double''': (boolean) '''optional'''<br/>
+
'''ambi_is_double''': (boolean) <translate></translate> '''optional'''<br/>
'''default_width''': (number) '''optional'''<br/>
+
'''default_width''': (number) <translate></translate> '''optional'''<br/>
 
=== Return values ===
 
=== Return values ===
'''Returns''' (number) width<br/>
+
'''Returns''' (number) <translate>width</translate><br/>

Revision as of 13:34, 23 August 2018

Available since: Gideros 2016.06

Description

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.

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

Parameters

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

Return values

Returns (number) width