Class VimIMContext

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gtk.IMContext

org.gnome.gtksourceview.VimIMContext

All Implemented Interfaces:

Proxy

@Generated("org.javagi.JavaGI")
public class VimIMContext
extends IMContext

Vim emulation.

The GtkSourceVimIMContext is a IMContext implementation that can be used to provide Vim-like editing controls within a View.

The GtkSourceViMIMContext will process incoming KeyEvent as the user types. It should be used in conjunction with a EventControllerKey.

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 VimIMContext:command-bar-text and VimIMContext:command-text to the user as they represent the command-bar and current command preview found in Vim.

GtkSourceVimIMContext attempts to work with additional IMContext implementations such as IBus by querying the TextView 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);

key = Gtk.EventControllerKey.new()
im_context = GtkSource.VimIMContext.new()
buffer = GtkSource.Buffer()
view = GtkSource.View.new_with_buffer(buffer)

key.set_im_context(im_context)
key.set_propagation_phase(Gtk.PropagationPhase.CAPTURE)
view.add_controller(key)
im_context.set_client_widget(view)

im_context.bind_property(
    source_property="command-text",
    target=command_label,
    target_property="label",
    flags=GObject.BindingFlags.DEFAULT,
)

im_context.bind_property(
    source_property="command-bar-text",
    target=command_bar_label,
    target_property="label",
    flags=GObject.BindingFlags.DEFAULT,
)

Since:

5.4

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VimIMContext.Builder<B extends VimIMContext.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static interface	VimIMContext.EditCallback	Functional interface declaration of the EditCallback callback.
static interface	VimIMContext.ExecuteCommandCallback	Functional interface declaration of the ExecuteCommandCallback callback.
static interface	VimIMContext.FormatTextCallback	Functional interface declaration of the FormatTextCallback callback.
static class	VimIMContext.VimIMContextClass
static interface	VimIMContext.WriteCallback	Functional interface declaration of the WriteCallback callback.

Nested classes/interfaces inherited from class IMContext

IMContext.CommitCallback, IMContext.DeleteSurroundingCallback, IMContext.IMContext$Impl, IMContext.IMContextClass, IMContext.InvalidCompositionCallback, IMContext.PreeditChangedCallback, IMContext.PreeditEndCallback, IMContext.PreeditStartCallback, IMContext.RetrieveSurroundingCallback

Nested classes/interfaces inherited from class GObject

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

Constructor	Description
VimIMContext()	Create a new VimIMContext.
VimIMContext(MemorySegment address)	Create a VimIMContext instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
protected VimIMContext	asParent()	Return this instance as if it were its parent type.
static VimIMContext.Builder<? extends VimIMContext.Builder>	builder()	A VimIMContext.Builder object constructs a VimIMContext with the specified properties.
void	emitEdit(@Nullable View view, @Nullable String path)	Emits the "edit" signal.
boolean	emitExecuteCommand(String command)	Emits the "execute-command" signal.
void	emitFormatText(@Nullable TextIter begin, @Nullable TextIter end)	Emits the "format-text" signal.
void	emitWrite(@Nullable View view, @Nullable String path)	Emits the "write" signal.
void	executeCommand(String command)	Executes command as if it was typed into the command bar by the user except that this does not emit the VimIMContext::execute-command signal.
String	getCommandBarText()	Gets the current command-bar text as it is entered by the user.
String	getCommandText()	Gets the current command text as it is entered by the user.
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
static @Nullable Type	getType()	Get the GType of the VimIMContext class.
SignalConnection<VimIMContext.EditCallback>	onEdit(VimIMContext.EditCallback handler)	Requests the application open the file found at path.
SignalConnection<VimIMContext.ExecuteCommandCallback>	onExecuteCommand(VimIMContext.ExecuteCommandCallback handler)	The signal is emitted when a command should be executed.
SignalConnection<VimIMContext.FormatTextCallback>	onFormatText(VimIMContext.FormatTextCallback handler)	Requests that the application format the text between begin and end.
SignalConnection<VimIMContext.WriteCallback>	onWrite(VimIMContext.WriteCallback handler)	Requests the application save the file.

Methods inherited from class IMContext

activateOsk, activateOsk, activateOskWithEvent, commit, deleteSurrounding, emitCommit, emitDeleteSurrounding, emitInvalidComposition, emitPreeditChanged, emitPreeditEnd, emitPreeditStart, emitRetrieveSurrounding, filterKey, filterKey, filterKeypress, focusIn, focusOut, getPreeditString, getSurrounding, getSurroundingWithSelection, invalidComposition, onCommit, onDeleteSurrounding, onInvalidComposition, onPreeditChanged, onPreeditEnd, onPreeditStart, onRetrieveSurrounding, preeditChanged, preeditEnd, preeditStart, reset, retrieveSurrounding, setClientWidget, setCursorLocation, setSurrounding, setSurroundingWithSelection, setUsePreedit

Methods inherited from class GObject

addToggleRef, addWeakPointer, bindProperty, bindProperty, bindProperty, bindPropertyFull, bindPropertyFull, bindPropertyWithClosures, bindPropertyWithClosures, compatControl, connect, connect, connect, constructed, disconnect, dispatchPropertiesChanged, dispose, dupData, dupQdata, emit, emitNotify, finalize_, forceFloating, freezeNotify, get, getData, getProperty, getProperty, getProperty, getQdata, getv, interfaceFindProperty, interfaceInstallProperty, interfaceListProperties, isFloating, newInstance, newInstance, newv, notify, notify, notifyByPspec, onNotify, ref, refSink, removeToggleRef, removeWeakPointer, replaceData, replaceQdata, runDispose, set, setData, setDataFull, setProperty, setProperty, setProperty, setQdata, setQdataFull, setv, stealData, stealQdata, takeRef, thawNotify, unref, watchClosure, weakRef, weakUnref, withProperties

Methods inherited from class TypeInstance

callParent, callParent, cast, getPrivate, readGClass, writeGClass

Methods inherited from class ProxyInstance

equals, handle, hashCode

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

VimIMContext

public VimIMContext(MemorySegment address)

Create a VimIMContext instance for the provided memory address.

Parameters:

address - the memory address of the native object

VimIMContext

public VimIMContext()

Create a new VimIMContext.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the VimIMContext class.

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

protected VimIMContext asParent()

Return this instance as if it were its parent type. Comparable to the Java super keyword, but ensures the parent typeclass is also used in native code.

Overrides:

asParent in class IMContext

Returns:

the instance as if it were its parent type

executeCommand

public void executeCommand(String command)

Executes command as if it was typed into the command bar by the user except that this does not emit the VimIMContext::execute-command signal.

Parameters:

command - the command text

Since:

5.4

getCommandBarText

public String getCommandBarText()

Gets the current command-bar text as it is entered by the user.

Returns:

A string containing the command-bar text

Since:

5.4

getCommandText

public String getCommandText()

Gets the current command text as it is entered by the user.

Returns:

A string containing the command text

Since:

5.4

onEdit

public SignalConnection<VimIMContext.EditCallback> onEdit(VimIMContext.EditCallback handler)

Requests the application open the file found at path.

If path is null, then the current file should be reloaded from storage.

This may be executed in relation to the user running the :edit or :e commands.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

Since:

5.4

See Also:

• VimIMContext.EditCallback.run(View, String)

emitEdit

public void emitEdit(@Nullable View view,
 @Nullable String path)

Emits the "edit" signal. See onEdit(VimIMContext.EditCallback).

onExecuteCommand

public SignalConnection<VimIMContext.ExecuteCommandCallback> onExecuteCommand(VimIMContext.ExecuteCommandCallback handler)

The signal is emitted when a command should be executed. This might be something like :wq or :e <path>.

If the application chooses to implement this, it should return true from this signal to indicate the command has been handled.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

Since:

5.4

See Also:

• VimIMContext.ExecuteCommandCallback.run(String)

emitExecuteCommand

public boolean emitExecuteCommand(String command)

Emits the "execute-command" signal. See onExecuteCommand(VimIMContext.ExecuteCommandCallback).

onFormatText

public SignalConnection<VimIMContext.FormatTextCallback> onFormatText(VimIMContext.FormatTextCallback handler)

Requests that the application format the text between begin and end.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

Since:

5.4

See Also:

• VimIMContext.FormatTextCallback.run(TextIter, TextIter)

emitFormatText

public void emitFormatText(@Nullable TextIter begin,
 @Nullable TextIter end)

Emits the "format-text" signal. See onFormatText(VimIMContext.FormatTextCallback).

onWrite

public SignalConnection<VimIMContext.WriteCallback> onWrite(VimIMContext.WriteCallback handler)

Requests the application save the file.

If a filename was provided, it will be available to the signal handler as path. This may be executed in relation to the user running the :write or :w commands.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

Since:

5.4

See Also:

• VimIMContext.WriteCallback.run(View, String)

emitWrite

public void emitWrite(@Nullable View view,
 @Nullable String path)

Emits the "write" signal. See onWrite(VimIMContext.WriteCallback).

builder

public static VimIMContext.Builder<? extends VimIMContext.Builder> builder()

A VimIMContext.Builder object constructs a VimIMContext with the specified properties. Use the various set...() methods to set properties, and finish construction with VimIMContext.Builder.build().

Returns:

the builder object