Class

GtkIMContextSimple

Description [src]

class Gtk.IMContextSimple : Gtk.IMContext {
  object: GtkIMContext
}

GtkIMContextSimple is a simple input method context supporting table-based input methods. It has a built-in table of compose sequences that is derived from the X11 Compose files.

GtkIMContextSimple reads additional compose sequences from the first of the following files that is found: ~/.config/gtk-3.0/Compose, ~/.XCompose, /usr/share/X11/locale/$locale/Compose (for locales that have a nontrivial Compose file). The syntax of these files is described in the Compose(5) manual page.

Unicode characters

GtkIMContextSimple also supports numeric entry of Unicode characters by typing Ctrl-Shift-u, followed by a hexadecimal Unicode codepoint. For example, Ctrl-Shift-u 1 2 3 Enter yields U+0123 LATIN SMALL LETTER G WITH CEDILLA, i.e. ģ.

Hierarchy

hierarchy this GtkIMContextSimple ancestor_0 GtkIMContext ancestor_0--this ancestor_1 GObject ancestor_1--ancestor_0

Ancestors

Constructors

gtk_im_context_simple_new

Creates a new GtkIMContextSimple.

Instance methods

gtk_im_context_simple_add_compose_file

Adds an additional table from the X11 compose file.

gtk_im_context_simple_add_table

Adds an additional table to search to the input context. Each row of the table consists of max_seq_len key symbols followed by two #guint16 interpreted as the high and low words of a #gunicode value. Tables are searched starting from the last added.

Methods inherited from GtkIMContext (11)
gtk_im_context_delete_surrounding

Asks the widget that the input context is attached to to delete characters around the cursor position by emitting the GtkIMContext::delete_surrounding signal. Note that offset and n_chars are in characters not in bytes which differs from the usage other places in GtkIMContext.

gtk_im_context_filter_keypress

Allow an input method to internally handle key press and release events. If this function returns TRUE, then no further processing should be done for this key event.

gtk_im_context_focus_in

Notify the input method that the widget to which this input context corresponds has gained focus. The input method may, for example, change the displayed feedback to reflect this change.

gtk_im_context_focus_out

Notify the input method that the widget to which this input context corresponds has lost focus. The input method may, for example, change the displayed feedback or reset the contexts state to reflect this change.

gtk_im_context_get_preedit_string

Retrieve the current preedit string for the input context, and a list of attributes to apply to the string. This string should be displayed inserted at the insertion point.

gtk_im_context_get_surrounding

Retrieves context around the insertion point. Input methods typically want context in order to constrain input text based on existing text; this is important for languages such as Thai where only some sequences of characters are allowed.

gtk_im_context_reset

Notify the input method that a change such as a change in cursor position has been made. This will typically cause the input method to clear the preedit state.

gtk_im_context_set_client_window

Set the client window for the input context; this is the GdkWindow in which the input appears. This window is used in order to correctly position status windows, and may also be used for purposes internal to the input method.

gtk_im_context_set_cursor_location

Notify the input method that a change in cursor position has been made. The location is relative to the client window.

gtk_im_context_set_surrounding

Sets surrounding context around the insertion point and preedit string. This function is expected to be called in response to the GtkIMContext::retrieve_surrounding signal, and will likely have no effect if called at other times.

gtk_im_context_set_use_preedit

Sets whether the IM context should use the preedit string to display feedback. If use_preedit is FALSE (default is TRUE), then the IM context may use some other method to display feedback, such as displaying it in a child of the root window.

Methods inherited from GObject (42)

Properties

Properties inherited from GtkIMContext (2)
Gtk.IMContext:input-hints
No description available.
Gtk.IMContext:input-purpose
No description available.

Signals

Signals inherited from GtkIMContext (6)
Gtk.IMContext::commit

The ::commit signal is emitted when a complete input sequence has been entered by the user. This can be a single character immediately after a key press or the final result of preediting.

Gtk.IMContext::delete-surrounding

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

Gtk.IMContext::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 gtk_im_context_get_preedit_string() returns the empty string.

Gtk.IMContext::preedit-end

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

Gtk.IMContext::preedit-start

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

Gtk.IMContext::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_im_context_set_surrounding() method.

Signals inherited from GObject (1)

Class structure

struct GtkIMContextSimpleClass {
  GtkIMContextClass parent_class;
  
}
Class members
parent_class
GtkIMContextClass
  No description available.