Difference between revisions of "Utf8.widthindex"
From GiderosMobile
| (6 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
'''Available since:''' Gideros 2016.06<br/> | '''Available since:''' Gideros 2016.06<br/> | ||
| + | '''Class:''' [[utf8]]<br/> | ||
| + | |||
=== Description === | === Description === | ||
| − | + | Returns the character index at given ''location'' in string ''s''. This is a reverse operation of utf8.width(). | |
| − | < | + | <syntaxhighlight lang="lua"> |
(number) = utf8.widthindex(s,location,ambi_is_double,default_width) | (number) = utf8.widthindex(s,location,ambi_is_double,default_width) | ||
| − | </ | + | </syntaxhighlight> |
| + | |||
| + | This function returns an index of location, and an 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 index is also returned. | ||
| + | |||
=== Parameters === | === Parameters === | ||
| − | '''s''': (string) | + | '''s''': (string) <br/> |
| − | '''location''': (number) | + | '''location''': (number) <br/> |
| − | '''ambi_is_double''': (boolean) | + | '''ambi_is_double''': (boolean) '''optional'''<br/> |
| − | '''default_width''': (number) | + | '''default_width''': (number) '''optional'''<br/> |
| + | |||
=== Return values === | === Return values === | ||
'''Returns''' (number) character index at given location<br/> | '''Returns''' (number) character index at given location<br/> | ||
| + | |||
| + | {{Utf8}} | ||
Latest revision as of 22:27, 1 December 2023
Available since: Gideros 2016.06
Class: utf8
Description
Returns the character index at given location in string s. This is a reverse operation of utf8.width().
(number) = utf8.widthindex(s,location,ambi_is_double,default_width)
This function returns an index of location, and an 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 index is also returned.
Parameters
s: (string)
location: (number)
ambi_is_double: (boolean) optional
default_width: (number) optional
Return values
Returns (number) character index at given location
