Context

---

Object Hierarchy:

Description:

Content:

Properties:

• public string[] auto_start_henkan_keywords { get; set; }
  Array of strings which triggers automatic conversion.
• public CandidateList candidates { get; }
  Current candidates.
• public Dict[] dictionaries { owned get; set; }
  Dictionaries.
• public bool egg_like_newline { get; set; }
  Flag to indicate whether or not "\n" is consumed on commit.
• public InputMode input_mode { get; set; }
  Current input mode.
• public KeyEventFilter key_event_filter { owned get; }
  Filter which runs before process_key_event.
• public PeriodStyle period_style { get; set; }
  Period style used in romaji-to-kana conversion.
• public string preedit { get; }
  Current preedit string.
• public Rule typing_rule { get; set; }
  The name of typing rule.

Creation methods:

• public Context (Dict[] dictionaries)
  Create a new Context.

Methods:

• public void add_dictionary (Dict dict)
  Register dictionary.
• public void clear_output ()
  Clear the output buffer.
• public string get_output ()
  This is replaced with poll_output.
• public void get_preedit_underline (out uint offset, out uint nchars)
  Get underlined range of preedit.
• public string peek_output ()
  Peek (retrieve, but not remove) the current output string.
• public string poll_output ()
  Poll (retrieve and remove) the current output string.
• public bool process_key_event (KeyEvent key)
  Pass one key event to the context.
• public bool process_key_events (string keyseq)
  Pass key events (separated by spaces) to the context.
• public void remove_dictionary (Dict dict)
  Unregister dictionary.
• public void reset ()
  Reset the context.
• public void save_dictionaries () throws Error
  Save dictionaries on to disk.
• public void set_selection_text (string? text)
  Set the current selection text.

Signals:

• public signal bool delete_surrounding_text (int offset, uint nchars)
  Signal emitted when the context requests deletion of surrounding-text.
• public signal void request_selection_text ()
• public signal bool retrieve_surrounding_text (out string text, out uint cursor_pos)
  Signal emitted when the context requires surrounding-text.

Inherited Members: