Engine

---

Object Hierarchy:

Description:

Content:

Properties:

• public bool active_surrounding_text { get; construct; }
  When this property is set to true, "RequireSurroundingText" D-Bus signal will be called by ibus-daemon on every focus-in/out event, with no need for the engine to call get_surrounding_text.
• public string engine_name { owned get; construct; }
  Name of this IBusEngine.
• public bool has_focus_id { get; construct; }
  Use focus_in_id ()/focus_out_id() class method insteads of focus_in/focus_out() class methods when this property is set to true.

Creation methods:

• public Engine (string engine_name, string object_path, DBusConnection connection)
  Create a new Engine.
• public Engine.with_type (Type engine_type, string engine_name, string object_path, DBusConnection connection)
  Create a new Engine.

Methods:

• public void commit_text (Text text)
  Commit output of input method to IBus client.
• public void delete_surrounding_text (int offset, uint nchars)
  Delete surrounding text.
• public void forward_key_event (uint keyval, uint keycode, uint state)
  Forward the key event.
• public void get_content_type (out uint purpose, out uint hints)
  Get content-type (primary purpose and hints) of the current input context.
• public unowned string get_name ()
  Return the name of Engine.
• public void get_surrounding_text (out unowned Text text, out uint cursor_pos, out uint anchor_pos)
  Get surrounding text.
• public void hide_auxiliary_text ()
  Hide the auxiliary bar.
• public void hide_lookup_table ()
  Hide the lookup table.
• public void hide_preedit_text ()
  Hide the pre-edit buffer.
• public void register_properties (PropList prop_list)
  Register and show properties in language bar.
• public void send_message (Message message)
  Send a message to the Engine for the focus-less notification popup.
• public void show_auxiliary_text ()
  Show the auxiliary bar.
• public void show_lookup_table ()
  Show the lookup table.
• public void show_preedit_text ()
  Show the pre-edit buffer.
• public void update_auxiliary_text (Text text, bool visible)
  Update the auxiliary bar.
• public void update_lookup_table (LookupTable lookup_table, bool visible)
  Update the lookup table.
• public void update_lookup_table_fast (LookupTable lookup_table, bool visible)
  Fast update for big lookup table.
• public void update_preedit_text (Text text, uint cursor_pos, bool visible)
  Update the pre-edit buffer.
• public void update_preedit_text_with_mode (Text text, uint cursor_pos, bool visible, PreeditFocusMode mode)
  Update the pre-edit buffer with commit mode.
• public void update_property (Property prop)
  Update the state displayed in language bar.

Signals:

• public virtual signal void cancel_hand_writing (uint n_strokes)
  Emitted when a hand writing operation is cancelled.
• public virtual signal void candidate_clicked (uint index, uint button, uint state)
  Emitted when candidate on lookup table is clicked.
• public virtual signal void cursor_down ()
  Emitted when the down cursor button is pressed.
• public virtual signal void cursor_up ()
  Emitted when the up cursor button is pressed.
• public virtual signal void disable ()
  Emitted when the IME is disabled.
• public virtual signal void enable ()
  Emitted when the IME is enabled.
• public virtual signal void focus_in ()
  Emitted when the client application get the focus.
• public virtual signal void focus_in_id (string object_path, string client)
  Emitted when the client application get the focus.
• public virtual signal void focus_out ()
  Emitted when the client application lost the focus.
• public virtual signal void focus_out_id (string object_path)
  Emitted when the client application lost the focus.
• public virtual signal void page_down ()
  Emitted when the page-down button is pressed.
• public virtual signal void page_up ()
  Emitted when the page-up button is pressed.
• public virtual signal void process_hand_writing_event (void* coordinates, uint coordinates_len)
  Emitted when a hand writing operation is cancelled.
• public virtual signal bool process_key_event (uint keyval, uint keycode, uint state)
  Emitted when a key event is received.
• public virtual signal void property_activate (string prop_name, uint prop_state)
  Emitted when a property is activated or change changed.
• public virtual signal void property_hide (string prop_name)
  Emitted when a property is hidden.
• public virtual signal void property_show (string prop_name)
  Emitted when a property is shown.
• public virtual signal void reset ()
  Emitted when the IME is reset.
• public virtual signal void set_capabilities (uint caps)
  Emitted when the client application capabilities is set.
• public virtual signal void set_content_type (uint purpose, uint hints)
  Emitted when the client application content-type (primary purpose and hints) is set.
• public virtual signal void set_cursor_location (int x, int y, int w, int h)
  Emitted when the location of IME is set.
• public virtual signal void set_surrounding_text (Object text, uint cursor_index, uint anchor_pos)
  Emitted when a surrounding text is set.

Fields:

• public uint client_capabilities
• public Rectangle cursor_area
• public bool enabled
• public bool has_focus

Inherited Members: