Class
GtkSourceVimIMContext
Description [src]
final class GtkSource.VimIMContext : Gtk.IMContext {
/* No available fields */
}
Vim emulation.
The GtkSourceVimIMContext
is a GtkIMContext
implementation that can
be used to provide Vim-like editing controls within a GtkSourceView
.
The GtkSourceViMIMContext
will process incoming GdkKeyEvent
as the
user types. It should be used in conjunction with a GtkEventControllerKey
.
Various features supported by GtkSourceVimIMContext
include:
- Normal, Insert, Replace, Visual, and Visual Line modes
- Support for an integrated command bar and current command preview
- Search and replace
- Motions and Text Objects
- History replay
- Jumplists within the current file
- Registers including the system and primary clipboards
- Creation and motion to marks
- Some commonly used Vim commands
It is recommended that applications display the contents of
GtkSourceVimIMContext:command-bar-text
and
GtkSourceVimIMContext:command-text
to the user as they represent the
command-bar and current command preview found in Vim.
GtkSourceVimIMContext
attempts to work with additional GtkIMContext
implementations such as IBus by querying the GtkTextView
before processing
the command in states which support it (notably Insert and Replace modes).
GtkEventController *key;
GtkIMContext *im_context;
GtkWidget *view;
view = gtk_source_view_new ();
im_context = gtk_source_vim_im_context_new ();
key = gtk_event_controller_key_new ();
gtk_event_controller_key_set_im_context (GTK_EVENT_CONTROLLER_KEY (key), im_context);
gtk_event_controller_set_propagation_phase (key, GTK_PHASE_CAPTURE);
gtk_widget_add_controller (view, key);
gtk_im_context_set_client_widget (im_context, view);
g_object_bind_property (im_context, "command-bar-text", command_bar_label, "label", 0);
g_object_bind_property (im_context, "command-text", command_label, "label", 0);
Available since: | 5.4 |
Constructors
gtk_source_vim_im_context_new
Instance methods
gtk_source_vim_im_context_execute_command
Executes command
as if it was typed into the command bar by the
user except that this does not emit the
GtkSourceVimIMContext::execute-command
signal.
Available since: 5.4
gtk_source_vim_im_context_get_command_bar_text
Gets the current command-bar text as it is entered by the user.
Available since: 5.4
gtk_source_vim_im_context_get_command_text
Gets the current command text as it is entered by the user.
Available since: 5.4
Properties
GtkSource.VimIMContext:command-bar-text
GtkSource.VimIMContext:command-text
Signals
GtkSource.VimIMContext::edit
Requests the application open the file found at path
.
Available since: 5.4
GtkSource.VimIMContext::execute-command
The signal is emitted when a command should be
executed. This might be something like :wq
or :e <path>
.
Available since: 5.4
GtkSource.VimIMContext::format-text
Requests that the application format the text between
begin
and end
.
Available since: 5.4