Struct sourceview5::VimIMContext

pub struct VimIMContext { /* private fields */ }

Vim emulation.

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

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

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

VimIMContext attempts to work with additional gtk::IMContext implementations such as IBus by querying the gtk::TextView before processing the command in states which support it (notably Insert and Replace modes).

⚠️ The following code is in c ⚠️

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);

Properties

command-bar-text

Readable

command-text

Readable

IMContext

input-hints

Additional hints that allow input methods to fine-tune their behaviour.

Readable | Writeable

input-purpose

The purpose of the text field that the `GtkIMContext is connected to.

This property can be used by on-screen keyboards and other input methods to adjust their behaviour.

Readable | Writeable

Signals

edit

Requests the application open the file found at @path.

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

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

execute-command

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.

format-text

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

write

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.

IMContext

commit

The ::commit signal is emitted when a complete input sequence has been entered by the user.

If the commit comes after a preediting sequence, the ::commit signal is emitted after ::preedit-end.

This can be a single character immediately after a key press or the final result of preediting.

delete-surrounding

The ::delete-surrounding signal is emitted when the input method needs to delete all or part of the context surrounding the cursor.

preedit-changed

The ::preedit-changed signal is emitted whenever the preedit sequence currently being entered has changed.

It is also emitted at the end of a preedit sequence, in which case [IMContextExtManual::preedit_string()][crate::gtk::prelude::IMContextExtManual::preedit_string()] returns the empty string.

preedit-end

The ::preedit-end signal is emitted when a preediting sequence has been completed or canceled.

preedit-start

The ::preedit-start signal is emitted when a new preediting sequence starts.

retrieve-surrounding

The ::retrieve-surrounding signal is emitted when the input method requires the context surrounding the cursor.

The callback should set the input method surrounding context by calling the Gtk::IMContext::set_surrounding() method.

Implements

gtk::prelude::IMContextExt, [trait@glib::ObjectExt]

GLib type: GObject with reference counted clone semantics.

Implementations

impl VimIMContext

pub fn new() -> VimIMContext

pub fn builder() -> VimIMContextBuilder

Creates a new builder-pattern struct instance to construct VimIMContext objects.

This method returns an instance of VimIMContextBuilder which can be used to create VimIMContext objects.

pub fn execute_command(&self, command: &str)

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

command

the command text

pub fn command_bar_text(&self) -> GString

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

Returns

A string containing the command-bar text

pub fn command_text(&self) -> GString

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

Returns

A string containing the command text

pub fn connect_edit<F: Fn(&Self, &View, Option<&str>) + 'static>( &self, f: F, ) -> SignalHandlerId

Requests the application open the file found at @path.

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

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

view

the #GtkSourceView

path

the path if provided, otherwise None

pub fn connect_execute_command<F: Fn(&Self, &str) -> bool + 'static>( &self, f: F, ) -> SignalHandlerId

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.

command

the command to execute

Returns

true if handled; otherwise false.

pub fn connect_format_text<F: Fn(&Self, &TextIter, &TextIter) + 'static>( &self, f: F, ) -> SignalHandlerId

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

begin

the start location

end

the end location

pub fn connect_write<F: Fn(&Self, &View, Option<&str>) + 'static>( &self, f: F, ) -> SignalHandlerId

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.

view

the #GtkSourceView

path

the path if provided, otherwise None

pub fn connect_command_bar_text_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_command_text_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

Trait Implementations

impl Clone for VimIMContext

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for VimIMContext

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for VimIMContext

fn default() -> Self

Returns the “default value” for a type.

impl HasParamSpec for VimIMContext

type ParamSpec = ParamSpecObject

type SetValue = VimIMContext

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, VimIMContext>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for VimIMContext

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Hashes the memory address of this object.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for VimIMContext

fn cmp(&self, other: &Self) -> Ordering

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl ParentClassIs for VimIMContext

type Parent = IMContext

impl<OT: ObjectType> PartialEq<OT> for VimIMContext

fn eq(&self, other: &OT) -> bool

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for VimIMContext

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for VimIMContext

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for VimIMContext

impl IsA<IMContext> for VimIMContext