Class: Gtk::IMContext
- Inherits:
-
Object
- Object
- Gtk::IMContext
- Defined in:
- (unknown)
Instance Method Summary collapse
-
#client_window=(window) ⇒ nil
Set the client window for the input context; this is the Gdk::Window in which the input appears.
-
#cursor_location=(area) ⇒ nil
Notify the input method that a change in cursor position has been made.
-
#delete_surrounding(offset, n_chars) ⇒ TrueClass
Asks the widget that the input context is attached to to delete characters around the cursor position by emitting the GtkIMContext::delete_surrounding signal.
-
#filter_keypress(event) ⇒ TrueClass
Allow an input method to internally handle key press and release events.
-
#focus_in ⇒ nil
Notify the input method that the widget to which this input context corresponds has gained focus.
-
#focus_out ⇒ nil
Notify the input method that the widget to which this input context corresponds has lost focus.
-
#get_preedit_string(str, attrs, cursor_pos) ⇒ nil
Retrieve the current preedit string for the input context, and a list of attributes to apply to the string.
-
#get_surrounding(text, cursor_index) ⇒ TrueClass
Retrieves context around the insertion point.
-
#input_hints ⇒ Gtk::InputHints
Input-hints.
- #input_hints=(input_hints) ⇒ Gtk::InputHints
-
#input_purpose ⇒ Gtk::InputPurpose
Input-purpose.
- #input_purpose=(input_purpose) ⇒ Gtk::InputPurpose
-
#reset ⇒ nil
Notify the input method that a change such as a change in cursor position has been made.
-
#set_surrounding(text, len, cursor_index) ⇒ nil
Sets surrounding context around the insertion point and preedit string.
-
#use_preedit=(use_preedit) ⇒ nil
Sets whether the IM context should use the preedit string to display feedback.
Instance Method Details
#client_window=(window) ⇒ nil
Set the client window for the input context; this is the Gdk::Window 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.
#cursor_location=(area) ⇒ nil
Notify the input method that a change in cursor position has been made. The location is relative to the client window.
#delete_surrounding(offset, n_chars) ⇒ TrueClass
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 Gtk::IMContext.
In order to use this function, you should first call gtk_im_context_get_surrounding() to get the current context, and call this function immediately afterwards to make sure that you know what you are deleting. You should also account for the fact that even if the signal was handled, the input context might not have deleted all the characters that were requested to be deleted.
This function is used by an input method that wants to make subsitutions in the existing text in response to new input. It is not useful for applications.
#filter_keypress(event) ⇒ TrueClass
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.
#focus_in ⇒ nil
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.
#focus_out ⇒ nil
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.
#get_preedit_string(str, attrs, cursor_pos) ⇒ nil
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.
#get_surrounding(text, cursor_index) ⇒ TrueClass
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.
This function is implemented by emitting the GtkIMContext::retrieve_surrounding signal on the input method; in response to this signal, a widget should provide as much context as is available, up to an entire paragraph, by calling gtk_im_context_set_surrounding(). Note that there is no obligation for a widget to respond to the ::retrieve_surrounding signal, so input methods must be prepared to function without context.
#input_hints ⇒ Gtk::InputHints
Returns input-hints.
#input_hints=(input_hints) ⇒ Gtk::InputHints
#input_purpose ⇒ Gtk::InputPurpose
Returns input-purpose.
#input_purpose=(input_purpose) ⇒ Gtk::InputPurpose
#reset ⇒ nil
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.
#set_surrounding(text, len, cursor_index) ⇒ nil
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.
#use_preedit=(use_preedit) ⇒ nil
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.