-
-
Notifications
You must be signed in to change notification settings - Fork 5
/
Highlight.txt
70 lines (53 loc) · 1.86 KB
/
Highlight.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
*Vital/Vim/Highlight.txt* Highlight get/set library
Author : Alisue <[email protected]>
DEPRECATED
==============================================================================
CONTENTS *Vital.Vim.Highlight-contents*
INTRODUCTIONS |Vital.Vim.Highlight-introductions|
FUNCTIONS |Vital.Vim.Highlight-functions|
==============================================================================
INTRODUCTIONS *Vital.Vim.Highlight-introductions*
This module provides several utility functions for |highlight|.
==============================================================================
FUNCTIONS *Vital.Vim.Highlight-functions*
*Vital.Vim.Highlight.get()*
get([{name}])
Return a highlight instance or a list of highlight instances.
When {name} is specified, it returns a highlight instance of the
given {name}. Otherwise it returns a list of highlight instance of
all highlights defined.
The highlight instance has
"name" The name of the highlight
"attrs" Highlight arguments
For example
>
let highlight = s:Highlight.get('Title')
echo highlight.name
" 'Title'
echo highlight.attrs.ctermfg
" '0'
echo highlight.attrs.guifg
" '#000000'
<
*Vital.Vim.Highlight.set()*
set({highlight}[, {options}])
Create or overwrite highlight by {highlight} instance.
The {options} may contains
"force" Overwrite existing highlight forcedly
"default" Use "default" keyword to define highlight
For example
>
call Highlight.set({'name': 'Title', 'attrs': {
\ 'cterm': 'reverse',
\ 'ctermfg': '1',
\ 'guifg': '#123123',
\}})
call Highlight.set({'name': 'TitleLink', 'attrs': {
\ 'link': 'Title',
\}})
call Highlight.set({'name': 'TitleClear', 'attrs': {
\ 'cleared': 1,
\}})
<
==============================================================================
vim:tw=78:fo=tcq2mM:ts=8:ft=help:norl