Interface

GtkSource-5 ▶ GtkSource ▶ VimIMContext ▶ SignalSignatures

interface SignalSignatures {
    commit: (arg0: string) => void;
    "delete-surrounding": (arg0: number, arg1: number) => boolean | void;
    edit: (arg0: GtkSource.View, arg1: string) => void;
    "execute-command": (arg0: string) => boolean | void;
    "format-text": (arg0: Gtk.TextIter, arg1: Gtk.TextIter) => void;
    notify: (arg0: GObject.ParamSpec) => void;
    "notify::command-bar-text": (pspec: GObject.ParamSpec) => void;
    "notify::command-text": (pspec: GObject.ParamSpec) => void;
    "notify::input-hints": (pspec: GObject.ParamSpec) => void;
    "notify::input-purpose": (pspec: GObject.ParamSpec) => void;
    "preedit-changed": () => void;
    "preedit-end": () => void;
    "preedit-start": () => void;
    "retrieve-surrounding": () => boolean | void;
    write: (arg0: GtkSource.View, arg1: string) => void;
}

Hierarchy (View Summary)

Index

Properties

edit execute-command format-text notify::command-bar-text notify::command-text notify::input-hints notify::input-purpose write

Properties - Inherited from Gtk

commit delete-surrounding notify preedit-changed preedit-end preedit-start retrieve-surrounding

Properties

edit: (arg0: GtkSource.View, arg1: string) => void

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.

5.4

"execute-command": (arg0: string) => boolean | void

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.

5.4

SignalRun Lastformat-text

"format-text": (arg0: Gtk.TextIter, arg1: Gtk.TextIter) => void

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

5.4

notify::command-bar-text

"notify::command-bar-text": (pspec: GObject.ParamSpec) => void

notify::command-text

"notify::command-text": (pspec: GObject.ParamSpec) => void
"notify::input-hints": (pspec: GObject.ParamSpec) => void
"notify::input-purpose": (pspec: GObject.ParamSpec) => void
write: (arg0: GtkSource.View, arg1: string) => void

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.

5.4

Properties - Inherited from Gtk

commit: (arg0: string) => void

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": (arg0: number, arg1: number) => boolean | void

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

notify: (arg0: GObject.ParamSpec) => void

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with GObject.ParamFlags.EXPLICIT_NOTIFY, then any call to g_object_set_property() results in ::notify being emitted, even if the new value is the same as the old. If they did pass GObject.ParamFlags.EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly call g_object_notify() or g_object_notify_by_pspec(), and common practice is to do that only when the value has actually changed.

This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the g_signal_connect() call, like this:

g_signal_connect (text_view->buffer, "notify::paste-target-list",
                  G_CALLBACK (gtk_text_view_target_list_notify),
                  text_view)

It is important to note that you must use [canonical parameter names][class@GObject.ParamSpec#parameter-names] as detail strings for the notify signal.

"preedit-changed": () => void

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 Gtk.IMContext.get_preedit_string returns the empty string.

"preedit-end": () => void

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

"preedit-start": () => void

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

"retrieve-surrounding": () => boolean | void

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.