InputContext

---

Object Hierarchy:

Description:

Content:

Static methods:

• public static unowned InputContext get_input_context (string path, DBusConnection connection)
  Gets an existing IBusInputContext.
• public static async void get_input_context_async (string path, DBusConnection connection, Cancellable? cancellable)
  Gets an existing InputContext asynchronously.
• public static unowned InputContext get_input_context_async_finish (AsyncResult res) throws Error
  Finishes an operation started with get_input_context_async.
• public static async void new_async (string path, DBusConnection connection, Cancellable? cancellable)
  Creates a new InputContext asynchronously.

Creation methods:

• public InputContext (string path, DBusConnection connection, Cancellable? cancellable = null) throws Error
  Creates a new InputContext.
• public InputContext.async_finish (AsyncResult res) throws Error
  Finishes an operation started with new_async.

Methods:

• public void cancel_hand_writing (uint n_strokes)
  Clear handwriting stroke(s) in the current input method engine.
• public void focus_in ()
  Invoked when the client application get focus.
• public void focus_out ()
  Invoked when the client application get focus.
• public unowned EngineDesc get_engine ()
  Gets an IME engine description for the context.
• public async void get_engine_async (int timeout_msec, Cancellable? cancellable)
  An asynchronous IPC will be performed.
• public unowned EngineDesc get_engine_async_finish (AsyncResult res) throws Error
  Finishes an operation started with get_engine_async.
• public bool needs_surrounding_text ()
  Check whether the current engine requires surrounding-text.
• public void post_process_key_event ()
  Call this API after process_key_event returns to retrieve commit-text and forwar-key-event signals during calling process_key_event.
• public void process_hand_writing_event (double coordinates, uint coordinates_len)
  Pass a handwriting stroke to an input method engine.
• public bool process_key_event (uint32 keyval, uint32 keycode, uint32 state)
  Pass the key event to input method engine and wait for the reply from ibus (i.
• public async void process_key_event_async (uint32 keyval, uint32 keycode, uint32 state, int timeout_msec, Cancellable? cancellable)
  Pass the key event to input method engine.
• public bool process_key_event_async_finish (AsyncResult res) throws Error
  Finishes an operation started with process_key_event_async.
• public void property_activate (string prop_name, uint32 state)
  Activate the property asynchronously.
• public void reset ()
  Invoked when the IME is reset.
• public void set_capabilities (uint32 capabilities)
  Set the capabilities flags of client application asynchronously.
• public void set_client_commit_preedit (bool client_commit)
  Set whether InputContext commits pre-edit texts or not.
• public void set_content_type (uint purpose, uint hints)
  Set content-type (primary purpose and hints) of the context.
• public void set_cursor_location (int32 x, int32 y, int32 w, int32 h)
  Set the cursor location of IBus input context asynchronously.
• public void set_cursor_location_relative (int32 x, int32 y, int32 w, int32 h)
  Set the relative cursor location of IBus input context asynchronously.
• public void set_engine (string name)
  Invoked when the IME engine is changed.
• public void set_post_process_key_event (bool enable)
• public void set_preedit_format (PreeditFormat format)
  The pre-edit attributes follows the format and the default is RGBA and the types of all Attribute are should be one of UNDERLINE, FOREGROUND, BACKGROUND.
• public void set_selected_color (RGBA fg_color, RGBA bg_color)
• public void set_surrounding_text (Text text, uint32 cursor_pos, uint32 anchor_pos)

Signals:

• public signal void commit_text (Text text)
  Emitted when the text is going to be committed.
• public signal void cursor_down_lookup_table ()
  Emitted to select next candidate of lookup table.
• public signal void cursor_up_lookup_table ()
  Emitted to select previous candidate of lookup table.
• public signal void delete_surrounding_text (int offset, uint n_chars)
  Emitted to delete surrounding text event from IME to client of IME.
• public signal void disabled ()
  Emitted when an IME is disabled.
• public signal void enabled ()
  Emitted when an IME is enabled.
• public signal void forward_key_event (uint keyval, uint keycode, uint modifiers)
  Emitted to forward key event from IME to client of IME.
• public signal void hide_auxiliary_text ()
  Emitted to hide auxiliary text.
• public signal void hide_lookup_table ()
  Emitted to hide lookup table.
• public signal void hide_preedit_text ()
  Emitted to hide preedit text.
• public signal void page_down_lookup_table ()
  Emitted to view the next page of lookup table.
• public signal void page_up_lookup_table ()
  Emitted to view the previous page of lookup table.
• public signal void register_properties (PropList props)
  Emitted to register the properties in props.
• public signal void require_surrounding_text ()
  Emitted to receive the RequireSurroundingText signal from the daemon.
• public signal void show_auxiliary_text ()
  Emitted to show auxiliary text.
• public signal void show_lookup_table ()
  Emitted to show lookup table.
• public signal void show_preedit_text ()
  Emitted to show preedit text.
• public signal void update_auxiliary_text (Text text, bool visible)
  Emitted to hide auxilary text.
• public signal void update_lookup_table (LookupTable table, bool visible)
  Emitted to update lookup table.
• public signal void update_preedit_text (Text text, uint cursor_pos, bool visible)
  Emitted to update preedit text.
• public signal void update_preedit_text_with_mode (Text text, uint cursor_pos, bool visible, uint mode)
  Emitted to update preedit text with the mode.
• public signal void update_property (Property prop)
  Emitted to update the property prop.

Inherited Members: