vim: runtime/doc/textprop.txt annotate

annotate runtime/doc/textprop.txt @ 24226:f49f80a0905d v8.2.2654

patch 8.2.2654: Vim9: getting a character from a string can be slow Commit: https://github.com/vim/vim/commit/ff871400461183010d3ab98f3f326e4bb75e221b Author: Bram Moolenaar <Bram@vim.org> Date: Fri Mar 26 13:34:05 2021 +0100 patch 8.2.2654: Vim9: getting a character from a string can be slow Problem: Vim9: getting a character from a string can be slow. Solution: Avoid a function call to get the character byte size. (https://github.com/vim/vim/issues/8000)

author	Bram Moolenaar <Bram@vim.org>
date	Fri, 26 Mar 2021 13:45:02 +0100
parents	5b7ea82bc18f
children	7422f2f719a3

rev	line source
22723 5b7ea82bc18f Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21250 diff changeset	1 textprop.txt For Vim version 8.2. Last change: 2020 Oct 14
15138 9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	2
9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	3
9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	4 VIM REFERENCE MANUAL by Bram Moolenaar
9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	5
9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	6
16610 1eaf34420bb3 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 16553 diff changeset	7 Displaying text with properties attached. textprop text-properties
15138 9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	8
9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	9
9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	10 1. Introduction \|text-prop-intro\|
9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	11 2. Functions \|text-prop-functions\|
15512 f0f06837a699 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 15334 diff changeset	12 3. When text changes \|text-prop-changes\|
15138 9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	13
9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	14
9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	15 {not able to use text properties when the \|+textprop\| feature was
9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	16 disabled at compile time}
9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	17
9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	18 ==============================================================================
9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	19 1. Introduction text-prop-intro
9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	20
9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	21 Text properties can be attached to text in a buffer. They will move with the
9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	22 text: If lines are deleted or inserted the properties move with the text they
9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	23 are attached to. Also when inserting/deleting text in the line before the
9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	24 text property. And when inserting/deleting text inside the text property, it
9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	25 will increase/decrease in size.
9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	26
9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	27 The main use for text properties is to highlight text. This can be seen as a
9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	28 replacement for syntax highlighting. Instead of defining patterns to match
9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	29 the text, the highlighting is set by a script, possibly using the output of an
9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	30 external parser. This only needs to be done once, not every time when
9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	31 redrawing the screen, thus can be much faster, after the initial cost of
9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	32 attaching the text properties.
9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	33
9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	34 Text properties can also be used for other purposes to identify text. For
9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	35 example, add a text property on a function name, so that a search can be
9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	36 defined to jump to the next/previous function.
9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	37
9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	38 A text property is attached at a specific line and column, and has a specified
9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	39 length. The property can span multiple lines.
9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	40
9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	41 A text property has these fields:
9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	42 "id" a number to be used as desired
9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	43 "type" the name of a property type
9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	44
9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	45
9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	46 Property Types ~
9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	47 E971
18831 6848b809a26e Runtime file updates. Bram Moolenaar <Bram@vim.org> parents: 18615 diff changeset	48 A text property normally has the name of a property type, which defines
15138 9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	49 how to highlight the text. The property type can have these entries:
9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	50 "highlight" name of the highlight group to use
18615 c4cdc715cb68 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 18594 diff changeset	51 "combine" when omitted or TRUE the text property highlighting is
c4cdc715cb68 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 18594 diff changeset	52 combined with any syntax highlighting; when FALSE the
16545 7a563ee902b6 patch 8.1.1276: cannot combine text properties with syntax highlighting Bram Moolenaar <Bram@vim.org> parents: 15512 diff changeset	53 text property highlighting replaces the syntax
7a563ee902b6 patch 8.1.1276: cannot combine text properties with syntax highlighting Bram Moolenaar <Bram@vim.org> parents: 15512 diff changeset	54 highlighting
15138 9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	55 "priority" when properties overlap, the one with the highest
9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	56 priority will be used.
9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	57 "start_incl" when TRUE inserts at the start position will be
9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	58 included in the text property
9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	59 "end_incl" when TRUE inserts at the end position will be
9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	60 included in the text property
9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	61
9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	62
9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	63 Example ~
9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	64
9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	65 Suppose line 11 in a buffer has this text (excluding the indent):
9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	66
9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	67 The number 123 is smaller than 4567.
9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	68
15334 9d3d7b0f4861 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 15281 diff changeset	69 To highlight the numbers in this text: >
15138 9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	70 call prop_type_add('number', {'highlight': 'Constant'})
15194 8b334e4cb97f Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 15138 diff changeset	71 call prop_add(11, 12, {'length': 3, 'type': 'number'})
8b334e4cb97f Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 15138 diff changeset	72 call prop_add(11, 32, {'length': 4, 'type': 'number'})
15138 9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	73
15334 9d3d7b0f4861 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 15281 diff changeset	74 Try inserting or deleting lines above the text, you will see that the text
9d3d7b0f4861 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 15281 diff changeset	75 properties stick to the text, thus the line number is adjusted as needed.
9d3d7b0f4861 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 15281 diff changeset	76
15138 9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	77 Setting "start_incl" and "end_incl" is useful when white space surrounds the
9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	78 text, e.g. for a function name. Using false is useful when the text starts
9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	79 and/or ends with a specific character, such as the quote surrounding a string.
9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	80
9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	81 func FuncName(arg) ~
9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	82 ^^^^^^^^ property with start_incl and end_incl set
9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	83
9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	84 var = "text"; ~
9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	85 ^^^^^^ property with start_incl and end_incl not set
9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	86
9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	87 Nevertheless, when text is inserted or deleted the text may need to be parsed
15194 8b334e4cb97f Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 15138 diff changeset	88 and the text properties updated. But this can be done asynchronously.
15138 9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	89
18456 6d11fc4aa683 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 18016 diff changeset	90
6d11fc4aa683 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 18016 diff changeset	91 Internal error E967
6d11fc4aa683 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 18016 diff changeset	92
6d11fc4aa683 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 18016 diff changeset	93 If you see E967, please report the bug. You can do this at Github:
6d11fc4aa683 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 18016 diff changeset	94 https://github.com/vim/vim/issues/new
6d11fc4aa683 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 18016 diff changeset	95
15138 9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	96 ==============================================================================
9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	97 2. Functions text-prop-functions
9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	98
9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	99 Manipulating text property types:
9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	100
9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	101 prop_type_add({name}, {props}) define a new property type
9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	102 prop_type_change({name}, {props}) change an existing property type
9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	103 prop_type_delete({name} [, {props}]) delete a property type
22723 5b7ea82bc18f Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21250 diff changeset	104 prop_type_get({name} [, {props}]) get property type values
15138 9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	105 prop_type_list([{props}]) get list of property types
9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	106
9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	107
9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	108 Manipulating text properties:
9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	109
9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	110 prop_add({lnum}, {col}, {props}) add a text property
15281 97b40b4c6911 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 15194 diff changeset	111 prop_clear({lnum} [, {lnum-end} [, {bufnr}]])
15138 9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	112 remove all text properties
9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	113 prop_find({props} [, {direction}]) search for a text property
20241 56265f711890 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 19646 diff changeset	114 prop_list({lnum} [, {props}]) text properties in {lnum}
15281 97b40b4c6911 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 15194 diff changeset	115 prop_remove({props} [, {lnum} [, {lnum-end}]])
15138 9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	116 remove a text property
9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	117
17456 e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	118 prop_add() E965
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	119 prop_add({lnum}, {col}, {props})
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	120 Attach a text property at position {lnum}, {col}. {col} is
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	121 counted in bytes, use one for the first column.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	122 If {lnum} is invalid an error is given. E966
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	123 If {col} is invalid an error is given. E964
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	124
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	125 {props} is a dictionary with these fields:
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	126 length length of text in bytes, can only be used
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	127 for a property that does not continue in
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	128 another line; can be zero
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	129 end_lnum line number for the end of text
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	130 end_col column just after the text; not used when
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	131 "length" is present; when {col} and "end_col"
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	132 are equal, and "end_lnum" is omitted or equal
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	133 to {lnum}, this is a zero-width text property
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	134 bufnr buffer to add the property to; when omitted
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	135 the current buffer is used
19646 847a300aa244 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 19601 diff changeset	136 id user defined ID for the property; must be a
847a300aa244 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 19601 diff changeset	137 number; when omitted zero is used
17456 e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	138 type name of the text property type
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	139 All fields except "type" are optional.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	140
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	141 It is an error when both "length" and "end_lnum" or "end_col"
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	142 are given. Either use "length" or "end_col" for a property
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	143 within one line, or use "end_lnum" and "end_col" for a
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	144 property that spans more than one line.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	145 When neither "length" nor "end_col" are given the property
19523 a7a24d06d7ce Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 19116 diff changeset	146 will be zero-width. That means it will move with the text, as
a7a24d06d7ce Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 19116 diff changeset	147 a kind of mark. One character will be highlighted, if the
a7a24d06d7ce Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 19116 diff changeset	148 type specifies highlighting.
17456 e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	149 The property can end exactly at the last character of the
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	150 text, or just after it. In the last case, if text is appended
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	151 to the line, the text property size will increase, also when
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	152 the property type does not have "end_incl" set.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	153
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	154 "type" will first be looked up in the buffer the property is
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	155 added to. When not found, the global property types are used.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	156 If not found an error is given.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	157
17980 52f23198af7f patch 8.1.1986: more functions can be used as methods Bram Moolenaar <Bram@vim.org> parents: 17909 diff changeset	158 Can also be used as a \|method\|: >
52f23198af7f patch 8.1.1986: more functions can be used as methods Bram Moolenaar <Bram@vim.org> parents: 17909 diff changeset	159 GetLnum()->prop_add(col, props)
52f23198af7f patch 8.1.1986: more functions can be used as methods Bram Moolenaar <Bram@vim.org> parents: 17909 diff changeset	160
17456 e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	161
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	162 prop_clear({lnum} [, {lnum-end} [, {props}]]) prop_clear()
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	163 Remove all text properties from line {lnum}.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	164 When {lnum-end} is given, remove all text properties from line
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	165 {lnum} to {lnum-end} (inclusive).
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	166
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	167 When {props} contains a "bufnr" item use this buffer,
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	168 otherwise use the current buffer.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	169
17980 52f23198af7f patch 8.1.1986: more functions can be used as methods Bram Moolenaar <Bram@vim.org> parents: 17909 diff changeset	170 Can also be used as a \|method\|: >
52f23198af7f patch 8.1.1986: more functions can be used as methods Bram Moolenaar <Bram@vim.org> parents: 17909 diff changeset	171 GetLnum()->prop_clear()
52f23198af7f patch 8.1.1986: more functions can be used as methods Bram Moolenaar <Bram@vim.org> parents: 17909 diff changeset	172 <
17456 e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	173 prop_find()
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	174 prop_find({props} [, {direction}])
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	175 Search for a text property as specified with {props}:
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	176 id property with this ID
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	177 type property with this type name
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	178 bufnr buffer to search in; when present a
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	179 start position with "lnum" and "col"
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	180 must be given; when omitted the
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	181 current buffer is used
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	182 lnum start in this line (when omitted start
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	183 at the cursor)
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	184 col start at this column (when omitted
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	185 and "lnum" is given: use column 1,
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	186 otherwise start at the cursor)
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	187 skipstart do not look for a match at the start
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	188 position
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	189
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	190 {direction} can be "f" for forward and "b" for backward. When
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	191 omitted forward search is performed.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	192
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	193 If a match is found then a Dict is returned with the entries
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	194 as with prop_list(), and additionally an "lnum" entry.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	195 If no match is found then an empty Dict is returned.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	196
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	197
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	198 prop_list({lnum} [, {props}]) prop_list()
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	199 Return a List with all text properties in line {lnum}.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	200
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	201 When {props} contains a "bufnr" item, use this buffer instead
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	202 of the current buffer.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	203
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	204 The properties are ordered by starting column and priority.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	205 Each property is a Dict with these entries:
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	206 col starting column
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	207 length length in bytes, one more if line break is
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	208 included
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	209 id property ID
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	210 type name of the property type, omitted if
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	211 the type was deleted
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	212 start when TRUE property starts in this line
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	213 end when TRUE property ends in this line
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	214
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	215 When "start" is zero the property started in a previous line,
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	216 the current one is a continuation.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	217 When "end" is zero the property continues in the next line.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	218 The line break after this line is included.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	219
17980 52f23198af7f patch 8.1.1986: more functions can be used as methods Bram Moolenaar <Bram@vim.org> parents: 17909 diff changeset	220 Can also be used as a \|method\|: >
52f23198af7f patch 8.1.1986: more functions can be used as methods Bram Moolenaar <Bram@vim.org> parents: 17909 diff changeset	221 GetLnum()->prop_list()
52f23198af7f patch 8.1.1986: more functions can be used as methods Bram Moolenaar <Bram@vim.org> parents: 17909 diff changeset	222 <
21250 21fb2a3ad3ca Update runtime files Bram Moolenaar <Bram@vim.org> parents: 20241 diff changeset	223 prop_remove() E968 E860
17456 e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	224 prop_remove({props} [, {lnum} [, {lnum-end}]])
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	225 Remove a matching text property from line {lnum}. When
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	226 {lnum-end} is given, remove matching text properties from line
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	227 {lnum} to {lnum-end} (inclusive).
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	228 When {lnum} is omitted remove matching text properties from
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	229 all lines.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	230
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	231 {props} is a dictionary with these fields:
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	232 id remove text properties with this ID
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	233 type remove text properties with this type name
19601 67f39cb0a49c patch 8.2.0357: cannot delete a text property matching both id and type Bram Moolenaar <Bram@vim.org> parents: 19523 diff changeset	234 both "id" and "type" must both match
17456 e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	235 bufnr use this buffer instead of the current one
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	236 all when TRUE remove all matching text properties,
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	237 not just the first one
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	238 A property matches when either "id" or "type" matches.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	239 If buffer "bufnr" does not exist you get an error message.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	240 If buffer "bufnr" is not loaded then nothing happens.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	241
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	242 Returns the number of properties that were removed.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	243
17980 52f23198af7f patch 8.1.1986: more functions can be used as methods Bram Moolenaar <Bram@vim.org> parents: 17909 diff changeset	244 Can also be used as a \|method\|: >
52f23198af7f patch 8.1.1986: more functions can be used as methods Bram Moolenaar <Bram@vim.org> parents: 17909 diff changeset	245 GetProps()->prop_remove()
52f23198af7f patch 8.1.1986: more functions can be used as methods Bram Moolenaar <Bram@vim.org> parents: 17909 diff changeset	246
17456 e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	247
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	248 prop_type_add({name}, {props}) prop_type_add() E969 E970
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	249 Add a text property type {name}. If a property type with this
17909 cc953757ed2a Runtime files update. Bram Moolenaar <Bram@vim.org> parents: 17758 diff changeset	250 name already exists an error is given. Nothing is returned.
17456 e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	251 {props} is a dictionary with these optional fields:
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	252 bufnr define the property only for this buffer; this
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	253 avoids name collisions and automatically
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	254 clears the property types when the buffer is
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	255 deleted.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	256 highlight name of highlight group to use
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	257 priority when a character has multiple text
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	258 properties the one with the highest priority
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	259 will be used; negative values can be used, the
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	260 default priority is zero
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	261 combine when TRUE combine the highlight with any
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	262 syntax highlight; when omitted or FALSE syntax
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	263 highlight will not be used
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	264 start_incl when TRUE inserts at the start position will
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	265 be included in the text property
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	266 end_incl when TRUE inserts at the end position will be
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	267 included in the text property
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	268
17980 52f23198af7f patch 8.1.1986: more functions can be used as methods Bram Moolenaar <Bram@vim.org> parents: 17909 diff changeset	269 Can also be used as a \|method\|: >
52f23198af7f patch 8.1.1986: more functions can be used as methods Bram Moolenaar <Bram@vim.org> parents: 17909 diff changeset	270 GetPropName()->prop_type_add(props)
17456 e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	271
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	272 prop_type_change({name}, {props}) prop_type_change()
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	273 Change properties of an existing text property type. If a
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	274 property with this name does not exist an error is given.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	275 The {props} argument is just like \|prop_type_add()\|.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	276
17980 52f23198af7f patch 8.1.1986: more functions can be used as methods Bram Moolenaar <Bram@vim.org> parents: 17909 diff changeset	277 Can also be used as a \|method\|: >
52f23198af7f patch 8.1.1986: more functions can be used as methods Bram Moolenaar <Bram@vim.org> parents: 17909 diff changeset	278 GetPropName()->prop_type_change(props)
17456 e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	279
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	280 prop_type_delete({name} [, {props}]) prop_type_delete()
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	281 Remove the text property type {name}. When text properties
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	282 using the type {name} are still in place, they will not have
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	283 an effect and can no longer be removed by name.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	284
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	285 {props} can contain a "bufnr" item. When it is given, delete
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	286 a property type from this buffer instead of from the global
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	287 property types.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	288
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	289 When text property type {name} is not found there is no error.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	290
17980 52f23198af7f patch 8.1.1986: more functions can be used as methods Bram Moolenaar <Bram@vim.org> parents: 17909 diff changeset	291 Can also be used as a \|method\|: >
52f23198af7f patch 8.1.1986: more functions can be used as methods Bram Moolenaar <Bram@vim.org> parents: 17909 diff changeset	292 GetPropName()->prop_type_delete()
17456 e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	293
22723 5b7ea82bc18f Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 21250 diff changeset	294 prop_type_get({name} [, {props}]) prop_type_get()
17456 e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	295 Returns the properties of property type {name}. This is a
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	296 dictionary with the same fields as was given to
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	297 prop_type_add().
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	298 When the property type {name} does not exist, an empty
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	299 dictionary is returned.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	300
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	301 {props} can contain a "bufnr" item. When it is given, use
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	302 this buffer instead of the global property types.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	303
17980 52f23198af7f patch 8.1.1986: more functions can be used as methods Bram Moolenaar <Bram@vim.org> parents: 17909 diff changeset	304 Can also be used as a \|method\|: >
52f23198af7f patch 8.1.1986: more functions can be used as methods Bram Moolenaar <Bram@vim.org> parents: 17909 diff changeset	305 GetPropName()->prop_type_get()
17456 e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	306
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	307 prop_type_list([{props}]) prop_type_list()
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	308 Returns a list with all property type names.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	309
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	310 {props} can contain a "bufnr" item. When it is given, use
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	311 this buffer instead of the global property types.
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	312
e414281d8bb4 patch 8.1.1726: the eval.txt help file is too big Bram Moolenaar <Bram@vim.org> parents: 17161 diff changeset	313
15512 f0f06837a699 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 15334 diff changeset	314 ==============================================================================
f0f06837a699 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 15334 diff changeset	315 3. When text changes text-prop-changes
f0f06837a699 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 15334 diff changeset	316
f0f06837a699 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 15334 diff changeset	317 Vim will do its best to keep the text properties on the text where it was
f0f06837a699 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 15334 diff changeset	318 attached. When inserting or deleting text the properties after the change
f0f06837a699 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 15334 diff changeset	319 will move accordingly.
f0f06837a699 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 15334 diff changeset	320
f0f06837a699 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 15334 diff changeset	321 When text is deleted and a text property no longer includes any text, it is
f0f06837a699 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 15334 diff changeset	322 deleted. However, a text property that was defined as zero-width will remain,
f0f06837a699 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 15334 diff changeset	323 unless the whole line is deleted.
18016 834b7854aa3c Update runtime files Bram Moolenaar <Bram@vim.org> parents: 17980 diff changeset	324 E275
17694 6f9cde96ee3c patch 8.1.1844: buffer no longer unloaded when adding text properties Bram Moolenaar <Bram@vim.org> parents: 17456 diff changeset	325 When a buffer is unloaded, all the text properties are gone. There is no way
6f9cde96ee3c patch 8.1.1844: buffer no longer unloaded when adding text properties Bram Moolenaar <Bram@vim.org> parents: 17456 diff changeset	326 to store the properties in a file. You can only re-create them. When a
6f9cde96ee3c patch 8.1.1844: buffer no longer unloaded when adding text properties Bram Moolenaar <Bram@vim.org> parents: 17456 diff changeset	327 buffer is hidden the text is preserved and so are the text properties. It is
6f9cde96ee3c patch 8.1.1844: buffer no longer unloaded when adding text properties Bram Moolenaar <Bram@vim.org> parents: 17456 diff changeset	328 not possible to add text properties to an unloaded buffer.
15512 f0f06837a699 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 15334 diff changeset	329
f0f06837a699 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 15334 diff changeset	330 When using replace mode, the text properties stay on the same character
f0f06837a699 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 15334 diff changeset	331 positions, even though the characters themselves change.
f0f06837a699 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 15334 diff changeset	332
16808 c002c4899529 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 16610 diff changeset	333 To update text properties after the text was changed, install a callback with
c002c4899529 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 16610 diff changeset	334 `listener_add()`. E.g, if your plugin does spell checking, you can have the
c002c4899529 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 16610 diff changeset	335 callback update spelling mistakes in the changed text. Vim will move the
c002c4899529 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 16610 diff changeset	336 properties below the changed text, so that they still highlight the same text,
c002c4899529 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 16610 diff changeset	337 thus you don't need to update these.
c002c4899529 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 16610 diff changeset	338
15512 f0f06837a699 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 15334 diff changeset	339
19523 a7a24d06d7ce Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 19116 diff changeset	340 Text property columns are not updated or copied: ~
15512 f0f06837a699 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 15334 diff changeset	341
f0f06837a699 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 15334 diff changeset	342 - When setting the line with \|setline()\| or through an interface, such as Lua,
16610 1eaf34420bb3 Update runtime files Bram Moolenaar <Bram@vim.org> parents: 16553 diff changeset	343 Tcl or Python. Vim does not know what text got inserted or deleted.
19523 a7a24d06d7ce Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 19116 diff changeset	344 - With a command like `:move`, which takes a line of text out of context.
15512 f0f06837a699 Update runtime files. Bram Moolenaar <Bram@vim.org> parents: 15334 diff changeset	345
15138 9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	346
9df130fd5e0d patch 8.1.0579: cannot attach properties to text Bram Moolenaar <Bram@vim.org> parents: diff changeset	347 vim:tw=78:ts=8:noet:ft=help:norl:

Mercurial > vim

annotate runtime/doc/textprop.txt @ 24226:f49f80a0905d v8.2.2654