summaryrefslogtreecommitdiffstats
path: root/runtime/doc/eval.txt
diff options
context:
space:
mode:
authorBram Moolenaar <Bram@vim.org>2010-07-18 15:45:49 +0200
committerBram Moolenaar <Bram@vim.org>2010-07-18 15:45:49 +0200
commitdc536095ac452c12e9bb4c69b473d28d51e8d4b9 (patch)
treec9cb78c565a0f42f5a82a519d9f191772831627d /runtime/doc/eval.txt
parent72597a57b526a8df333e77ef8a837b595baa18c7 (diff)
Added strdisplaywidth() function.
Diffstat (limited to 'runtime/doc/eval.txt')
-rw-r--r--runtime/doc/eval.txt20
1 files changed, 16 insertions, 4 deletions
diff --git a/runtime/doc/eval.txt b/runtime/doc/eval.txt
index f1eeb73032..25d6d01625 100644
--- a/runtime/doc/eval.txt
+++ b/runtime/doc/eval.txt
@@ -1910,6 +1910,7 @@ sqrt( {expr} Float squar root of {expr}
str2float( {expr}) Float convert String to Float
str2nr( {expr} [, {base}]) Number convert String to Number
strchars( {expr}) Number character length of the String {expr}
+strdisplaywidth( {expr} [, {col}]) Number display length of the String {expr}
strftime( {format}[, {time}]) String time in specified format
stridx( {haystack}, {needle}[, {start}])
Number index of {needle} in {haystack}
@@ -5368,7 +5369,17 @@ strchars({expr}) *strchars()*
The result is a Number, which is the number of characters
String {expr} occupies. Composing characters are counted
separately.
- Also see |strlen()| and |strwidth()|.
+ Also see |strlen()|, |strdisplaywidth()| and |strwidth()|.
+
+strdisplaywidth({expr}[, {col}]) *strdisplaywidth()*
+ The result is a Number, which is the number of display cells
+ String {expr} occupies on the screen.
+ When {col} is omitted zero is used. Otherwise it is the
+ screen column where to start. This matters for Tab
+ characters.
+ When {expr} contains characters with East Asian Width Class
+ Ambiguous, this function's return value depends on 'ambiwidth'.
+ Also see |strlen()|, |strwidth()| and |strchars()|.
strftime({format} [, {time}]) *strftime()*
The result is a String, which is a formatted date and time, as
@@ -5432,7 +5443,8 @@ strlen({expr}) The result is a Number, which is the length of the String
<
If the argument is a Number it is first converted to a String.
For other types an error is given.
- Also see |len()|, |strchars()| and |strwidth()|.
+ Also see |len()|, |strchars()|, |strdisplaywidth()| and
+ |strwidth()|.
strpart({src}, {start}[, {len}]) *strpart()*
The result is a String, which is part of {src}, starting from
@@ -5478,10 +5490,10 @@ strtrans({expr}) *strtrans()*
strwidth({expr}) *strwidth()*
The result is a Number, which is the number of display cells
String {expr} occupies. A Tab character is counted as one
- cell (on the screen it depends on the position).
+ cell, alternatively use |strdisplaywidth()|.
When {expr} contains characters with East Asian Width Class
Ambiguous, this function's return value depends on 'ambiwidth'.
- Also see |strlen()| and |strchars()|.
+ Also see |strlen()|, |strdisplaywidth()| and |strchars()|.
submatch({nr}) *submatch()*
Only for an expression in a |:substitute| command. Returns