Vim Python Extensions
Installation
Getting started
Using Buffers
Using Windows
The VPE and other logs
Scratch buffers
Handling keys, events, etc.
Timers and deferred actions
VPE plug-in mechanism
Events,
aka
auto-commands
User defined commands
Module vpe
Vim Python Extensions
Index
Index
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
K
|
L
|
M
|
N
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
|
V
|
W
|
X
|
Y
_
__call__() (vpe.Log method)
__getattr__() (vpe.Buffer method)
__getitem__() (diffs.Operation method)
(vpe.Registers method)
__getstate__() (vpe.Struct method)
__init__() (ui.FieldVar method)
__new__() (vpe.Vim static method)
__setitem__() (vpe.Registers method)
__setstate__() (vpe.Struct method)
A
a (diffs.Operation attribute)
add() (app_ui_support.Displays method)
(syntax.Cluster method)
(vpe.AutoCmdGroup static method)
add_() (config.Config method)
add_argument() (user_commands.ArgumentParser method)
add_arguments() (user_commands.CommandHandler method)
add_keyword() (syntax.Group method)
(syntax.Syntax.group_type method)
add_links() (syntax.Group method)
(syntax.Syntax.group_type method)
add_listener() (vpe.Buffer method)
add_match() (syntax.Group method)
(syntax.Syntax.group_type method)
add_panel() (panels.PanelViewBuffer method)
add_region() (syntax.Group method)
(syntax.Syntax.group_type method)
AddOp (class in diffs)
adjust_width() (windows.LayoutColumn method)
(windows.LayoutRow method)
(windows.LayoutWindow method)
AmbiguousSubcommand (class in user_commands)
app_ui_support
module
append() (vpe.Buffer method)
(vpe.Range method)
apply_sizes() (windows.LayoutElement method)
apply_syntax() (panels.Panel method)
(ui.ConfigPanel method)
apply_to() (diffs.Operation method)
apply_updates() (panels.Panel method)
AppWin (class in app_ui_support)
arg_name (syntax.NamedSyntaxItem property)
(syntax.StdCluster property)
arg_str() (syntax.MatchGroupDirective method)
(syntax.Pattern method)
args (message_bus.SimpleMessage attribute)
(vpe.Timer attribute)
ArgumentError (class in user_commands)
ArgumentParser (class in user_commands)
as_call() (vpe.Callback method)
as_invocation() (vpe.Callback method)
as_vim_function() (vpe.Callback method)
attach_vars() (in module app_ui_support)
auto_define_commands() (vpe.CommandHandler method)
auto_define_event_handlers() (vpe.BufEventHandler method)
(vpe.EventHandler method)
auto_grp_name (vpe.ScratchBuffer property)
auto_map_keys() (mapping.KeyHandler method)
(vpe.KeyHandler method)
AutoCmdGroup (class in vpe)
B
b (diffs.Operation attribute)
bang (vpe.CommandInfo attribute)
Bool (class in config)
BoolField (class in ui)
borders (app_ui_support.AppWin attribute)
buf (vpe.BufListener attribute)
(vpe.Log attribute)
buf_slice (panels.Panel property)
BufEventHandler (class in vpe)
Buffer (class in vpe)
buffer (vpe.Popup property)
Buffers (class in vpe)
buffers (vpe.TabPage property)
(vpe.Vim property)
BufListener (class in vpe)
bufnr (vpe.Buffer property)
Bus (class in message_bus)
C
call_count (vpe.Callback attribute)
call_soon() (in module vpe)
call_soon_once() (in module vpe)
Callback (class in vpe)
can_cause_changes() (in module panels)
cell_size (app_ui_support.AppWin attribute)
changed (ui.CurPrev property)
(vpe.Buffer property)
changedtick (vpe.Buffer property)
ChangeOp (class in diffs)
Channel (class in channels)
channels
module
chid (channels.VimChannel property)
Choice (class in config)
ChoiceField (class in ui)
cidx (ui.Field attribute)
clear() (vpe.Log method)
(vpe.Popup class method)
clear_props() (vpe.Buffer method)
close() (channels.Channel method)
(channels.VimChannel method)
(vpe.Popup method)
(vpe.Window method)
close_in() (channels.Channel method)
closed (channels.VimChannel property)
Cluster (class in syntax)
cluster() (syntax.Syntax method)
code (vpe.VimError attribute)
col (diffs.Operation attribute)
column_range (ui.Field property)
columns (app_ui_support.AppWin property)
command (vpe.VimError attribute)
command() (vpe.CommandHandler static method)
(vpe.Vim method)
CommandHandler (class in user_commands)
(class in vpe)
CommandInfo (class in vpe)
Commands (class in wrappers)
commands (in module vpe)
complete() (user_commands.VimCommandHandler class method)
config
module
Config (class in config)
config_panels() (ui.ConfigPanelBuffer method)
ConfigPanel (class in ui)
ConfigPanelBuffer (class in ui)
connect() (channels.Channel method)
ContainedIn (class in syntax)
Contains (class in syntax)
contains_window() (app_ui_support.Display method)
content (panels.Panel attribute)
convert_syntax_options() (in module syntax)
copy_to_store() (config.Option method)
core
module
count (diffs.Operation property)
(vpe.CommandInfo attribute)
create() (diffs.Operation class method)
create_from_vim_layout() (windows.LayoutElement class method)
create_parser() (user_commands.CommandHandler method)
(user_commands.TopLevelSubcommandHandler method)
CurPrev (class in ui)
Current (class in vpe)
current (vpe.Vim property)
D
data (panels.PanelViewBuffer property)
dead (vpe.Timer attribute)
decor_dims (app_ui_support.AppWin property)
default_value (config.Option attribute)
define_command() (in module vpe)
delete_all() (vpe.AutoCmdGroup static method)
DeleteOp (class in diffs)
deliminate() (in module syntax)
delta (diffs.Operation attribute)
describe() (windows.LayoutElement method)
(windows.LayoutWindow method)
description (config.Option attribute)
diffs
module
dims_cells (app_ui_support.AppWin attribute)
dims_corners (app_ui_support.AppWin attribute)
dims_pixels (app_ui_support.AppWin attribute)
Display (class in app_ui_support)
displays (app_ui_support.Displays attribute)
Displays (class in app_ui_support)
do_parse_known_args() (user_commands.ArgumentParser method)
dot_vim_dir() (in module vpe)
E
echo_msg() (in module vpe)
edit_field() (ui.ConfigPanelBuffer method)
edit_value() (ui.Field method)
(ui.IntField method)
effective_line_range (mapping.MappingInfo property)
End (class in syntax)
end() (syntax.Group.region_type method)
(syntax.Region method)
(syntax.Syntax.group_type.region_type method)
end_cursor (mapping.MappingInfo attribute)
end_lidx (panels.Panel property)
error (vpe.Vim property)
error() (user_commands.ArgumentParser method)
error_msg() (in module vpe)
escape_rich_like() (vpe.Buffer static method)
eval() (vpe.Vim method)
evalexpr() (channels.SyncChannel method)
EventHandler (class in vpe)
exit() (user_commands.ArgumentParser method)
expr_arg (class in core)
extract_keys() (in module syntax)
F
Field (class in ui)
fields (ui.ConfigPanel attribute)
FieldVar (class in ui)
find_active_windows() (vpe.Buffer method)
find_best_active_window() (vpe.Buffer method)
find_buffer_by_name() (in module vpe)
find_display_for_window() (app_ui_support.Displays method)
Finish (class in vpe)
fire_count (vpe.Timer attribute)
first_field_idx (ui.ConfigPanel attribute)
flush() (vpe.Log method)
fmt_group() (syntax.Syntax method)
format_call_fail_message() (vpe.Callback method)
format_contents() (panels.Panel method)
format_panel() (panels.PanelViewBuffer method)
format_str() (in module ui)
format_usage_head() (user_commands.CommandHandler method)
from_vim_change() (diffs.Operation class method)
full_width (ui.Field property)
G
get_() (config.Config method)
get_app_win_info() (in module app_ui_support)
get_call_args() (mapping.MapCallback method)
(vpe.Callback method)
get_completions() (user_commands.ArgumentParser method)
(user_commands.CommandHandler method)
(user_commands.SubcommandHandlerBase method)
get_display_buffer() (in module vpe)
get_display_info() (in module app_ui_support)
get_field_by_idx() (ui.ConfigPanel method)
(ui.ConfigPanelBuffer method)
get_known() (vpe.Buffer class method)
(vpe.TabPage class method)
get_managed_io_buffer() (in module vpe)
get_offsets() (syntax.SyntaxBase static method)
getbufnr() (channels.Channel method)
GlobalOptions (class in vpe)
goto() (vpe.Window method)
goto_active_window() (vpe.Buffer method)
Group (class in syntax)
group() (syntax.Cluster method)
(syntax.Syntax method)
Group.region_type (class in syntax)
GroupOption (class in syntax)
H
h (app_ui_support.Display attribute)
handle() (vpe.EventHandler static method)
handle_command() (user_commands.CommandHandler method)
handle_main_command() (user_commands.VimCommandHandler method)
handle_message() (in module message_bus)
handle_no_subcommand() (user_commands.SubcommandHandlerBase method)
HelpAction (class in user_commands)
hidden (vpe.Buffer property)
hide() (vpe.Log method)
(vpe.Popup method)
highlight() (in module vpe)
(syntax.Group method)
(syntax.Syntax.group_type method)
I
id (vpe.Popup property)
(vpe.Timer property)
(vpe.Window attribute)
imap() (in module mapping)
inc_field() (ui.ConfigPanelBuffer method)
include() (syntax.Cluster method)
(syntax.Syntax method)
increment() (ui.BoolField method)
(ui.ChoiceField method)
(ui.Field method)
index() (config.Choice method)
index_fields() (ui.ConfigPanel method)
info (channels.VimChannel property)
info() (channels.Channel method)
ini_path_() (config.Config method)
init_options() (vpe.ScratchBuffer method)
insert_panel() (panels.PanelViewBuffer method)
install_message_handlers() (in module message_bus)
Int (class in config)
IntField (class in ui)
invoke() (syntax.Cluster method)
(syntax.Group method)
(syntax.StdCluster method)
(syntax.Syntax.group_type method)
(vpe.Callback class method)
is_active() (vpe.Buffer method)
is_open (channels.Channel property)
items() (diffs.Operation method)
iter_all_windows() (vpe.Vim static method)
iter_windows() (windows.LayoutElement method)
J
JSChannel (class in channels)
JsonChannel (class in channels)
K
KeyHandler (class in mapping)
(class in vpe)
keys (mapping.MappingInfo attribute)
kwargs (vpe.Timer attribute)
L
lastused (vpe.Buffer property)
LayoutColumn (class in windows)
LayoutElement (class in windows)
LayoutRow (class in windows)
LayoutWindow (class in windows)
lidx (mapping.MappingInfo attribute)
(ui.Field attribute)
line1 (vpe.CommandInfo attribute)
line2 (vpe.CommandInfo attribute)
line_range (mapping.MappingInfo property)
linecount (vpe.Buffer property)
lines (vpe.Log property)
list() (vpe.Buffer method)
listen_id (vpe.BufListener attribute)
lnum (vpe.Buffer property)
load_() (config.Config method)
load_contents() (vpe.ManagedIOBuffer method)
loaded (vpe.Buffer property)
location (vpe.Buffer property)
LocationGroup (class in syntax)
Log (class in vpe)
log (in module vpe)
log() (channels.Channel method)
long_display_name (vpe.Buffer property)
M
ManagedIOBuffer (class in vpe)
map() (in module mapping)
MapCallback (class in mapping)
mapped() (mapping.KeyHandler static method)
(vpe.KeyHandler static method)
mapping
module
MappingInfo (class in mapping)
markup_text() (vpe.Buffer static method)
MatchGroup (class in syntax)
matchgroup() (syntax.Group.region_type method)
(syntax.Region method)
(syntax.Syntax.group_type.region_type method)
MatchGroupDirective (class in syntax)
maxlen (vpe.Log property)
message (vpe.VimError attribute)
message_bus
module
meta (vpe.Callback attribute)
(vpe.Timer attribute)
mode (mapping.MappingInfo attribute)
modifiable() (vpe.ScratchBuffer method)
mods (vpe.CommandInfo attribute)
module
app_ui_support
channels
config
core
diffs
mapping
message_bus
panels
syntax
ui
user_commands
vpe
windows
wrappers
move() (vpe.Popup method)
move_field() (ui.ConfigPanelBuffer method)
N
name (config.Config attribute)
(config.Option attribute)
(diffs.Operation attribute)
(message_bus.SimpleMessage attribute)
(syntax.NamedSyntaxItem property)
(vpe.Log attribute)
named_message_bus() (in module message_bus)
NamedSyntaxItem (class in syntax)
new() (vpe.TabPages static method)
NextGroup (class in syntax)
NLChannel (class in channels)
nmap() (in module mapping)
notify_content_change() (panels.PanelViewBuffer method)
notify_size_change() (panels.PanelViewBuffer method)
number (vpe.Buffer property)
O
old_slice (panels.Panel attribute)
omap() (in module mapping)
on_buf_enter() (panels.PanelViewBuffer method)
on_change() (ui.ConfigPanelBuffer method)
on_close() (channels.Channel method)
(vpe.Popup method)
on_connect() (channels.Channel method)
on_first_showing() (vpe.ManagedIOBuffer method)
(vpe.ScratchBuffer method)
on_format_contents() (panels.Panel method)
(ui.ConfigPanel method)
on_key() (vpe.Popup method)
(vpe.PopupDialog method)
(vpe.PopupMenu method)
on_message() (channels.Channel method)
on_reindex() (panels.PanelViewBuffer method)
(ui.ConfigPanelBuffer method)
on_selected_field_change() (ui.ConfigPanelBuffer method)
on_set_syntax() (panels.PanelViewBuffer method)
on_updates_applied() (panels.PanelViewBuffer method)
(ui.ConfigPanelBuffer method)
once (vpe.Callback attribute)
OneShotTimer (class in vpe)
open (channels.Channel attribute)
Operation (class in diffs)
ops (vpe.BufListener attribute)
Option (class in config)
(class in syntax)
Options (class in vpe)
options (vpe.Vim property)
options_() (config.Config method)
P
Panel (class in panels)
panels
module
panels (panels.PanelViewBuffer property)
PanelViewBuffer (class in panels)
parse_args() (user_commands.ArgumentParser method)
parse_known_args() (user_commands.ArgumentParser method)
parse_known_args_arg_count (user_commands.ArgumentParser property)
pass_bytes (vpe.Callback attribute)
Pattern (class in syntax)
pause() (vpe.Timer method)
paused (vpe.Timer property)
pedit() (in module vpe)
Popup (class in vpe)
popup_clear() (in module vpe)
PopupAtCursor (class in vpe)
PopupBeval (class in vpe)
PopupDialog (class in vpe)
PopupMenu (class in vpe)
PopupNotification (class in vpe)
popups (vpe.Buffer property)
post() (message_bus.Bus method)
post_simple_message() (message_bus.Bus method)
prefix (ui.Field attribute)
prefix_fmt_width (ui.Field property)
prefix_width (ui.Field attribute)
preview_last() (syntax.Syntax method)
print_help() (user_commands.ArgumentParser method)
process_command() (user_commands.CommandHandler method)
(user_commands.SubcommandHandlerBase method)
py_args (vpe.Callback attribute)
py_kwargs (vpe.Callback attribute)
Q
qual_name (syntax.NamedSyntaxItem property)
R
Range (class in vpe)
range (vpe.CommandInfo attribute)
range() (vpe.Buffer method)
raw_changes (vpe.BufListener attribute)
RawChannel (class in channels)
read() (channels.Channel method)
redirect() (vpe.Log method)
reg (vpe.CommandInfo attribute)
Region (class in syntax)
region() (syntax.Group method)
(syntax.Syntax.group_type method)
Registers (class in vpe)
registers (vpe.Vim property)
reindex() (panels.Panel method)
remaining (vpe.Timer property)
remove_panel() (panels.PanelViewBuffer method)
repeat (vpe.Timer property)
restore_prev() (ui.CurPrev method)
resume() (vpe.Timer method)
retrieve_store() (vpe.Buffer method)
(vpe.TabPage method)
S
save_() (config.Config method)
save_contents() (vpe.ManagedIOBuffer method)
saved_current_window (class in vpe)
saved_winview (class in vpe)
schedule() (syntax.Syntax method)
schedule_win_op() (panels.PanelViewBuffer method)
ScratchBuffer (class in vpe)
script_py_path() (in module vpe)
select_field() (ui.ConfigPanel method)
selectable_fields (ui.ConfigPanel attribute)
send() (channels.Channel method)
sendexpr() (channels.SyncChannel method)
set() (config.Bool method)
(config.Choice method)
(config.Int method)
(config.Option method)
(config.String method)
(ui.FieldVar method)
set_ext_name() (vpe.ScratchBuffer method)
set_highlight() (syntax.Group method)
(syntax.Syntax.group_type method)
set_line_prop() (vpe.Buffer method)
set_maxlen() (vpe.Log method)
set_rich_like_lines() (vpe.Buffer method)
set_view() (panels.Panel method)
set_widths_from_layout() (windows.LayoutElement method)
setoptions() (vpe.Popup method)
settext() (vpe.Popup method)
settimeout() (channels.Channel method)
short_description (vpe.Buffer property)
short_display_name (vpe.Buffer property)
show() (vpe.Log method)
(vpe.Popup method)
(vpe.ScratchBuffer method)
simple_field_args() (config.Option method)
simple_name (vpe.ScratchBuffer attribute)
SimpleCommandHandler (class in user_commands)
SimpleMessage (class in message_bus)
SimpleOption (class in syntax)
Skip (class in syntax)
skip() (syntax.Group.region_type method)
(syntax.Region method)
(syntax.Syntax.group_type.region_type method)
Start (class in syntax)
start() (syntax.Group.region_type method)
(syntax.Region method)
(syntax.Syntax.group_type.region_type method)
start_cursor (mapping.MappingInfo attribute)
start_lidx (panels.Panel attribute)
status() (channels.Channel method)
std_cluster() (syntax.Syntax method)
std_group() (syntax.Syntax method)
StdCluster (class in syntax)
stop() (vpe.Timer method)
stop_listening() (vpe.BufListener method)
store() (vpe.Buffer method)
(vpe.TabPage method)
store_repr (config.Option property)
store_value (config.Option property)
String (class in config)
Struct (class in vpe)
subcommand_help() (user_commands.CommandHandler method)
(user_commands.SubcommandHandlerBase method)
SubcommandAction (class in user_commands)
SubcommandHandlerBase (class in user_commands)
SubcommandReached (class in user_commands)
subscribe() (message_bus.Bus method)
suffix (ui.Field attribute)
suffix_fmt_width (ui.Field property)
suffix_width (ui.Field attribute)
sync_group() (syntax.Syntax method)
SyncChannel (class in channels)
SyncGroup (class in syntax)
syntax
module
Syntax (class in syntax)
Syntax.group_type (class in syntax)
Syntax.group_type.region_type (class in syntax)
Syntax.sync_group_type (class in syntax)
syntax_prefix (panels.Panel property)
(vpe.ScratchBuffer property)
SyntaxBase (class in syntax)
T
TabPage (class in vpe)
TabPages (class in vpe)
tabpages (vpe.Vim property)
temp_active_window (class in vpe)
temp_options() (vpe.Buffer method)
(vpe.Vim method)
(vpe.Window method)
text() (ui.Field method)
time (vpe.Timer property)
Timer (class in vpe)
TopLevelSubcommandHandler (class in user_commands)
type (vpe.Buffer property)
type_name (windows.LayoutElement attribute)
U
ui
module
uid (vpe.Callback attribute)
unique_match() (in module user_commands)
unredirect() (vpe.Log method)
unredirected() (vpe.Log method)
user_commands
module
V
val_extent (ui.Field property)
valid (vpe.Buffer property)
value (config.Option property)
(ui.CurPrev property)
(ui.Field property)
(ui.FieldVar property)
value_fmt_width (ui.Field property)
value_str (ui.Field property)
value_width (ui.Field property)
values() (config.Choice method)
(config.Option static method)
(ui.FieldVar method)
Variables (class in vpe)
variables (vpe.Buffer property)
varname (channels.VimChannel attribute)
vars (vpe.Buffer property)
(vpe.TabPage property)
(vpe.Vim property)
(vpe.Window property)
vch (channels.Channel attribute)
VI_DEFAULT (in module vpe)
Vim (class in vpe)
vim (in module vpe)
vim() (vpe.Vim static method)
VIM_DEFAULT (in module vpe)
vim_exprs (vpe.Callback attribute)
vim_fmt() (syntax.Option method)
(syntax.SimpleOption method)
VimChannel (class in channels)
VimCommandHandler (class in user_commands)
VimError (class in vpe)
visible_line_range (vpe.Window property)
vmode (mapping.MappingInfo attribute)
vpe
module
vvars (vpe.Vim property)
W
w (app_ui_support.Display attribute)
warning_msg() (in module vpe)
width (windows.LayoutColumn property)
(windows.LayoutRow property)
(windows.LayoutWindow property)
win_id_to_window() (vpe.Window static method)
Window (class in vpe)
windows
module
Windows (class in vpe)
windows (vpe.Buffer property)
(vpe.Vim property)
with_modifiers() (wrappers.Commands class method)
wrappers
module
write() (vpe.Log method)
X
x (app_ui_support.Display attribute)
xmap() (in module mapping)
Y
y (app_ui_support.Display attribute)