Return the current working branch.
Parameters: |
|
---|
Highlight groups used: branch_clean, branch_dirty, branch.
Divider highlight group used: branch:divider.
Show buffer number
Parameters: | show_current (bool) – If False do not show current window number. |
---|
Display CSV column number and column name
Requires filetype to be set to csv.
Parameters: |
|
---|
Highlight groups used: csv:column_number or csv, csv:column_name or csv.
Return file directory (head component of the file path).
Parameters: |
|
---|
Return file encoding/character set.
Returns: | file encoding/character set or None if unknown or missing file encoding |
---|
Divider highlight group used: background:divider.
Return file format (i.e. line ending type).
Returns: | file format or None if unknown or missing file format |
---|
Divider highlight group used: background:divider.
Return file name (tail component of the file path).
Parameters: |
|
---|
Highlight groups used: file_name_no_file or file_name, file_name.
Return the protocol part of the file.
Protocol is the part of the full filename just before the colon which starts with a latin letter and contains only latin letters, digits, plus, period or hyphen (refer to RFC3986 for the description of URI scheme). If there is no such a thing None is returned, effectively removing segment.
Note
Segment will not check whether there is // just after the colon or if there is at least one slash after the scheme. Reason: it is not always present. E.g. when opening file inside a zip archive file name will look like zipfile:/path/to/archive.zip::file.txt. file_scheme segment will catch zipfile part here.
Return file size in &encoding.
Parameters: |
|
---|---|
Returns: | file size or None if the file isn’t saved or if the size is too big to fit in a number |
Return file type.
Returns: | file type or None if unknown file type |
---|
Divider highlight group used: background:divider.
Return the VCS status for this buffer.
Highlight groups used: file_vcs_status.
Return the cursor position in the file as a percentage.
Parameters: | gradient (bool) – highlight the percentage with a color gradient (by default a green to red gradient) |
---|
Highlight groups used: line_percent_gradient (gradient), line_percent.
Return the current vim mode.
Parameters: | override (dict) – dict for overriding default mode strings, e.g. { 'n': 'NORM' } |
---|
Return a comma-separated list of modified buffers.
Parameters: |
|
---|
Return a file modified indicator.
Parameters: | text (string) – text to display if the current buffer is modified |
---|
Return a paste mode indicator.
Parameters: | text (string) – text to display if paste mode is enabled |
---|
Return the position of the current view in the file as a percentage.
Parameters: |
|
---|
Highlight groups used: position_gradient (gradient), position.
Return a read-only indicator.
Parameters: | text (string) – text to display if the current buffer is read-only |
---|
Mark start of the clickable region for tabpage
Parameters: | end (bool) – In place of starting region for the current tab end it. |
---|
No highlight groups are used (literal segment).
Return a file modified indicator for tabpages.
Parameters: | text (string) – text to display if any buffer in the current tab is modified |
---|
Highlight groups used: tab_modified_indicator or modified_indicator.
Show tabpage number
Parameters: | show_current (bool) – If False do not show current tabpage number. This is default because tabnr is by default only present in tabline. |
---|
Return the line number for trailing whitespaces
It is advised not to use this segment in insert mode: in Insert mode it will iterate over all lines in buffer each time you happen to type a character which may cause lags. It will also show you whitespace warning each time you happen to type space.
Highlight groups used: trailing_whitespace or warning.
Return current visual column with concealed characters ingored
Parameters: | gradient (bool) – Determines whether it should show textwidth-based gradient (gradient level is virtcol * 100 / textwidth). |
---|
Highlight groups used: virtcol_current_gradient (gradient), virtcol_current or col_current.
Return the current visual selection range.
Parameters: |
|
---|
All texts are format strings which are passed the following parameters:
Parameter | Description |
---|---|
sline | Line number of the first line of the selection |
eline | Line number of the last line of the selection |
scol | Column number of the first character of the selection |
ecol | Column number of the last character of the selection |
svcol | Virtual column number of the first character of the selection |
secol | Virtual column number of the last character of the selection |
rows | Number of lines in the selection |
cols | Number of columns in the selection |
vcols | Number of virtual columns in the selection |
Return the window title.
This currently looks at the quickfix_title window variable, which is used by Syntastic and Vim itself.
It is used in the quickfix theme.
Show window number
Parameters: | show_current (bool) – If False do not show current window number. |
---|
Show whether syntastic has found any errors or warnings
Parameters: |
|
---|
Highlight groups used: syntastic:warning or warning, syntastic:error or error.
Display Command-T finder name
Requires $command_t.active_finder and methods (code above may monkey-patch $command_t to add them). All Command-T finders have CommandT:: module prefix, but it is stripped out (actually, any CommandT:: substring will be stripped out).
Highlight groups used: commandt:finder.
Display path used by Command-T
Requires $command_t.active_finder and .path methods (code above may monkey-patch $command_t to add them).
$command_t.active_finder is required in order to omit displaying path for finders MRUBufferFinder, BufferFinder, TagFinder and JumpFinder (pretty much any finder, except FileFinder).
Highlight groups used: commandt:path.
Return tag that is near the cursor.
Parameters: | flags (str) – Specifies additional properties of the displayed tag. Supported values:
More info in the official documentation (search for “tagbar#currenttag”). |
---|
Shows the indicator if tpope/vim-capslock plugin is enabled
Note
In the current state plugin automatically disables itself when leaving insert mode. So trying to use this segment not in insert or replace modes is useless.
Parameters: | text (str) – String to show when software capslock presented by this plugin is active. |
---|