|
1 | 1 | ---@meta
|
2 | 2 |
|
3 |
| - |
| 3 | +--- Statuscolumn state variables. |
4 | 4 | ---@class statuscolumn.state
|
5 | 5 | ---
|
| 6 | +--- Is the module enabled? |
6 | 7 | ---@field enable boolean
|
7 |
| ----@field attached_windows { [integer]: boolean } |
| 8 | +--- |
| 9 | +---@field attached_windows table<integer, boolean> |
8 | 10 |
|
| 11 | +----------------------------------------------------------------------------- |
9 | 12 |
|
| 13 | +--- Configuration table for the statuscolumn. |
10 | 14 | ---@class statuscolumn.config
|
11 | 15 | ---
|
| 16 | +--- Filetypes to ignore. |
12 | 17 | ---@field ignore_filetypes string[]
|
| 18 | +--- Buftypes to ignore. |
13 | 19 | ---@field ignore_buftypes string[]
|
14 | 20 | ---
|
15 |
| ----@field condition? fun(buffer: integer): boolean | nil |
| 21 | +--- Additional condition for attaching to |
| 22 | +--- windows. |
| 23 | +---@field condition? fun(buffer: integer, window: integer): boolean | nil |
| 24 | +--- |
| 25 | +--- Default style. |
| 26 | +---@field default statuscolumn.style |
| 27 | +--- |
| 28 | +--- Configuration style. |
| 29 | +---@field [string] statuscolumn.style |
| 30 | + |
| 31 | +--- A configuration style. |
| 32 | +--- Must have a condition(unless `default`) |
| 33 | +--- and a list of parts. |
| 34 | +---@class statuscolumn.style |
| 35 | +--- |
| 36 | +---@field condition? fun(buffer: integer, window: integer): boolean Condition for this style. |
16 | 37 | ---
|
17 |
| ----@field default table |
18 |
| ----@field [string] table |
| 38 | +--- Parts for this style. |
| 39 | +---@field parts statuscolumn_part[] |
19 | 40 |
|
| 41 | +---@alias statuscolumn_part |
| 42 | +---| statuscolumn.parts.lnum Line number. |
| 43 | +---| statuscolumn.parts.folds Fold column. |
| 44 | +---| statuscolumn.parts.signs Sign column. |
| 45 | +---| statuscolumn.parts.empty An empty column. |
| 46 | +---| statuscolumn.parts.border A statuscolumn border. |
20 | 47 |
|
21 |
| ----@class statuscolumn.lnum |
| 48 | +----------------------------------------------------------------------------- |
| 49 | + |
| 50 | +--- Line number for statuscolumn. |
| 51 | +---@class statuscolumn.parts.lnum |
| 52 | +--- |
| 53 | +--- Condition for this component. |
| 54 | +---@field condition? fun(buffer: integer, window: integer, statuscolumn: string): boolean |
| 55 | +--- |
| 56 | +---@field kind "lnum" What kind of part is this? |
| 57 | +--- |
| 58 | +---@field click? boolean | fun(buffer: integer, window: integer, statuscolumn: string): boolean |
22 | 59 | ---
|
23 |
| ----@field kind "lnum" |
24 | 60 | ---@field mode
|
25 | 61 | ---| 1 Line number.
|
26 | 62 | ---| 2 Relative line number.
|
27 | 63 | ---| 3 Hybrid line number.
|
28 | 64 | ---
|
| 65 | +--- Text used for the wrapped lines. |
| 66 | +--- Can be a list to create a *fake* gradient effect. |
29 | 67 | ---@field wrap_markers string | string[]
|
| 68 | +--- |
| 69 | +--- Text used for the virtual lines. |
| 70 | +--- Can be a list to create a *fake* gradient effect. |
30 | 71 | ---@field virt_markers string | string[]
|
31 | 72 | ---
|
| 73 | +--- Highlight group for `wrap_markers`. |
| 74 | +--- Can be a list to create a color gradient. |
32 | 75 | ---@field wrap_hl? string | string[]
|
| 76 | +--- |
| 77 | +--- Highlight group for `virt_markers`. |
| 78 | +--- Can be a list to create a color gradient. |
33 | 79 | ---@field virt_hl? string | string[]
|
34 | 80 | ---
|
| 81 | +--- Highlight group for the line numbers. |
| 82 | +--- Can be a list to create a color gradient. |
35 | 83 | ---@field hl? string | string[]
|
36 | 84 |
|
37 | 85 |
|
38 |
| ----@class statuscolumn.empty |
| 86 | +---@class statuscolumn.parts.empty |
39 | 87 | ---
|
40 | 88 | ---@field kind "empty"
|
41 | 89 | ---@field len integer
|
42 | 90 | ---
|
43 | 91 | ---@field hl? string
|
44 | 92 |
|
45 | 93 |
|
46 |
| ----@class statuscolumn.border |
| 94 | +---@class statuscolumn.parts.border |
47 | 95 | ---
|
48 | 96 | ---@field kind "border"
|
49 | 97 | ---
|
50 | 98 | ---@field text string | string[]
|
51 | 99 | ---@field hl? string | string[]
|
52 | 100 |
|
53 | 101 |
|
54 |
| ----@class statuscolumn.folds |
| 102 | +---@class statuscolumn.parts.folds |
55 | 103 | ---
|
56 | 104 | ---@field kind "folds"
|
57 | 105 | ---
|
|
74 | 122 | ---@field fill_hl? string
|
75 | 123 |
|
76 | 124 |
|
77 |
| ----@class statuscolumn.signs |
| 125 | +---@class statuscolumn.parts.signs |
78 | 126 | ---
|
79 | 127 | ---@field kind "signs"
|
80 | 128 | ---@field hl? string
|
|
0 commit comments