Difference between revisions of "Utf8.widthindex"

From GiderosMobile
Line 2: Line 2:
 
'''Available since:''' Gideros 2016.06<br/>
 
'''Available since:''' Gideros 2016.06<br/>
 
=== Description ===
 
=== Description ===
Return the character index at given location in string s. this is a reverse operation of utf8.width(). this function return a index of location, and a offset in in UTF-8 encoding. e.g. if cursor is at the second column (middle) of the wide char, offset will be 2. the width of character at idx is returned, also.
+
<translate>Return the character index at given location in string s. this is a reverse operation of utf8.width(). this function return a index of location, and a offset in in UTF-8 encoding. e.g. if cursor is at the second column (middle) of the wide char, offset will be 2. the width of character at idx is returned, also.</translate>
 
<source lang="lua">
 
<source lang="lua">
 
(number) = utf8.widthindex(s,location,ambi_is_double,default_width)
 
(number) = utf8.widthindex(s,location,ambi_is_double,default_width)
 
</source>
 
</source>
 
=== Parameters ===
 
=== Parameters ===
'''s''': (string) <br/>
+
'''s''': (string) <translate></translate> <br/>
'''location''': (number) <br/>
+
'''location''': (number) <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) character index at given location<br/>
+
'''Returns''' (number) <translate>character index at given location</translate><br/>

Revision as of 13:34, 23 August 2018

Available since: Gideros 2016.06

Description

Return the character index at given location in string s. this is a reverse operation of utf8.width(). this function return a index of location, and a offset in in UTF-8 encoding. e.g. if cursor is at the second column (middle) of the wide char, offset will be 2. the width of character at idx is returned, also.

(number) = utf8.widthindex(s,location,ambi_is_double,default_width)

Parameters

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

Return values

Returns (number) character index at given location