| ibusinputcontext.h | | ibusinputcontext.h | |
| | | | |
| skipping to change at line 110 | | skipping to change at line 110 | |
| IBusInputContext | | IBusInputContext | |
| *ibus_input_context_new (const gchar *path, | | *ibus_input_context_new (const gchar *path, | |
| GDBusConnection *connection
, | | GDBusConnection *connection
, | |
| GCancellable *cancellabl
e, | | GCancellable *cancellabl
e, | |
| GError **error); | | GError **error); | |
| | | | |
| /** | | /** | |
| * ibus_input_context_get_input_context: | | * ibus_input_context_get_input_context: | |
| * @path: The path to the object that emitting the signal. | | * @path: The path to the object that emitting the signal. | |
| * @connection: An GDBusConnection. | | * @connection: An GDBusConnection. | |
|
| * @returns: An existing IBusInputContext. | | * @returns: (transfer none): An existing IBusInputContext. | |
| * | | * | |
| * Gets an existing IBusInputContext. | | * Gets an existing IBusInputContext. | |
| */ | | */ | |
| IBusInputContext | | IBusInputContext | |
| *ibus_input_context_get_input_context | | *ibus_input_context_get_input_context | |
| (const gchar *path, | | (const gchar *path, | |
| GDBusConnection *connection
); | | GDBusConnection *connection
); | |
| | | | |
| /** | | /** | |
| * ibus_input_context_process_key_event: | | * ibus_input_context_process_key_event: | |
| * @context: An IBusInputContext. | | * @context: An IBusInputContext. | |
| * @keyval: Key symbol of a key event. | | * @keyval: Key symbol of a key event. | |
| * @keycode: Keycode of a key event. | | * @keycode: Keycode of a key event. | |
| * @state: Key modifier flags. | | * @state: Key modifier flags. | |
|
| * @returns: TRUE for successfully process the key; FALSE otherwise. | | * @timeout_msec: The timeout in milliseconds or -1 to use the default time | |
| | | out. | |
| | | * @cancellable: A GCancellable or NULL. | |
| | | * @callback: A GAsyncReadyCallback to call when the request is satisfied o | |
| | | r NULL | |
| | | * if you don't care about the result of the method invocation. | |
| | | * @user_data: The data to pass to callback. | |
| * | | * | |
| * Pass the key event to input method engine. | | * Pass the key event to input method engine. | |
| * | | * | |
| * Key symbols are characters/symbols produced by key press, for example, | | * Key symbols are characters/symbols produced by key press, for example, | |
| * pressing "s" generates key symbol "s"; pressing shift-"s" generates key
symbol "S". | | * pressing "s" generates key symbol "s"; pressing shift-"s" generates key
symbol "S". | |
| * Same key on keyboard may produce different key symbols on different keyb
oard layout. | | * Same key on keyboard may produce different key symbols on different keyb
oard layout. | |
| * e.g., "s" key on QWERTY keyboard produces "o" in DVORAK layout. | | * e.g., "s" key on QWERTY keyboard produces "o" in DVORAK layout. | |
| * | | * | |
| * Unlike key symbol, keycode is only determined by the location of the key
, and | | * Unlike key symbol, keycode is only determined by the location of the key
, and | |
| * irrelevant of the keyboard layout. | | * irrelevant of the keyboard layout. | |
| * | | * | |
| * Briefly speaking, input methods that expect certain keyboard layout shou
ld use | | * Briefly speaking, input methods that expect certain keyboard layout shou
ld use | |
| * keycode; otherwise keyval is sufficient. | | * keycode; otherwise keyval is sufficient. | |
| * For example, Chewing, Cangjie, Wubi expect an en-US QWERTY keyboard, the
se should | | * For example, Chewing, Cangjie, Wubi expect an en-US QWERTY keyboard, the
se should | |
| * use keycode; while pinyin can rely on keyval only, as it is less sensiti
ve to | | * use keycode; while pinyin can rely on keyval only, as it is less sensiti
ve to | |
| * the keyboard layout change, DVORAK users can still use DVORAK layout to
input pinyin. | | * the keyboard layout change, DVORAK users can still use DVORAK layout to
input pinyin. | |
| * | | * | |
| * Use ibus_keymap_lookup_keysym() to convert keycode to keysym in given ke
yboard layout. | | * Use ibus_keymap_lookup_keysym() to convert keycode to keysym in given ke
yboard layout. | |
| * | | * | |
|
| * @see_also: #IBusEngine::process-key-event | | * see_also: #IBusEngine::process-key-event | |
| | | */ | |
| | | void ibus_input_context_process_key_event | |
| | | (IBusInputContext *context, | |
| | | guint32 keyval, | |
| | | guint32 keycode, | |
| | | guint32 state, | |
| | | gint timeout_ms | |
| | | ec, | |
| | | GCancellable *cancellabl | |
| | | e, | |
| | | GAsyncReadyCallback callback, | |
| | | gpointer user_data) | |
| | | ; | |
| | | | |
| | | /** | |
| | | * ibus_input_context_process_key_event: | |
| | | * @context: An IBusInputContext. | |
| | | * @res: A GAsyncResult obtained from the GAsyncReadyCallback passed to | |
| | | * ibus_input_context_process_key_event(). | |
| | | * @processed: A point to a bool value. If the the key event is processed, | |
| | | it will | |
| | | * assigned to TRUE, FALSE otherwise. | |
| | | * @error: Return location for error or NULL. | |
| | | * @returns: TRUE for success; FALSE otherwise. | |
| | | * | |
| | | * Finishes an operation started with ibus_input_context_process_key_event( | |
| | | ). | |
| | | */ | |
| | | gboolean ibus_input_context_process_key_event_finish | |
| | | (IBusInputContext *context, | |
| | | GAsyncResult *res, | |
| | | gboolean *processed, | |
| | | GError **error); | |
| | | | |
| | | /** | |
| | | * ibus_input_context_process_key_event_sync: | |
| | | * @context: An IBusInputContext. | |
| | | * @keyval: Key symbol of a key event. | |
| | | * @keycode: Keycode of a key event. | |
| | | * @state: Key modifier flags. | |
| | | * @returns: TRUE for successfully process the key; FALSE otherwise. | |
| | | * | |
| | | * Pass the key event to input method engine and wait for the reply from ib | |
| | | us. | |
| | | * | |
| | | * @see_also: ibus_input_context_process_key_event() | |
| */ | | */ | |
|
| gboolean ibus_input_context_process_key_event | | gboolean ibus_input_context_process_key_event_sync | |
| (IBusInputContext *context, | | (IBusInputContext *context, | |
| guint32 keyval, | | guint32 keyval, | |
| guint32 keycode, | | guint32 keycode, | |
| guint32 state); | | guint32 state); | |
| | | | |
| /** | | /** | |
| * ibus_input_context_set_cursor_location: | | * ibus_input_context_set_cursor_location: | |
| * @context: An IBusInputContext. | | * @context: An IBusInputContext. | |
| * @x: X coordinate of the cursor. | | * @x: X coordinate of the cursor. | |
| * @y: Y coordinate of the cursor. | | * @y: Y coordinate of the cursor. | |
| * @w: Width of the cursor. | | * @w: Width of the cursor. | |
| * @h: Height of the cursor. | | * @h: Height of the cursor. | |
| * | | * | |
| * Set the cursor location of IBus input context. | | * Set the cursor location of IBus input context. | |
| * | | * | |
|
| * @see_also: #IBusEngine::set-cursor-location | | * see_also: #IBusEngine::set-cursor-location | |
| */ | | */ | |
| void ibus_input_context_set_cursor_location | | void ibus_input_context_set_cursor_location | |
| (IBusInputContext *context, | | (IBusInputContext *context, | |
| gint32 x, | | gint32 x, | |
| gint32 y, | | gint32 y, | |
| gint32 w, | | gint32 w, | |
| gint32 h); | | gint32 h); | |
| /** | | /** | |
| * ibus_input_context_set_capabilities: | | * ibus_input_context_set_capabilities: | |
| * @context: An IBusInputContext. | | * @context: An IBusInputContext. | |
| * @capabilities: Capabilities flags of IBusEngine, see #IBusCapabilite | | * @capabilities: Capabilities flags of IBusEngine, see #IBusCapabilite | |
| * | | * | |
| * Set the capabilities flags of client application. | | * Set the capabilities flags of client application. | |
| * When IBUS_CAP_FOCUS is not set, IBUS_CAP_PREEDIT_TEXT, IBUS_CAP_AUXILIAR
Y_TEXT, IBUS_CAP_LOOKUP_TABLE, and IBUS_CAP_PROPERTY have to be all set. | | * When IBUS_CAP_FOCUS is not set, IBUS_CAP_PREEDIT_TEXT, IBUS_CAP_AUXILIAR
Y_TEXT, IBUS_CAP_LOOKUP_TABLE, and IBUS_CAP_PROPERTY have to be all set. | |
| * The panel component does nothing for an application that doesn't support
focus. | | * The panel component does nothing for an application that doesn't support
focus. | |
| * | | * | |
|
| * @see_also: #IBusEngine::set-capabilities | | * see_also: #IBusEngine::set-capabilities | |
| */ | | */ | |
| void ibus_input_context_set_capabilities | | void ibus_input_context_set_capabilities | |
| (IBusInputContext *context, | | (IBusInputContext *context, | |
| guint32 capabiliti
es); | | guint32 capabiliti
es); | |
| | | | |
| /** | | /** | |
| * ibus_input_context_property_activate | | * ibus_input_context_property_activate | |
| * @context: An IBusInputContext. | | * @context: An IBusInputContext. | |
| * @prop_name: A property name (e.g. "InputMode.WideLatin") | | * @prop_name: A property name (e.g. "InputMode.WideLatin") | |
| * @state: A status of the property (e.g. PROP_STATE_CHECKED) | | * @state: A status of the property (e.g. PROP_STATE_CHECKED) | |
| | | | |
| skipping to change at line 207 | | skipping to change at line 251 | |
| (IBusInputContext *context, | | (IBusInputContext *context, | |
| const gchar *prop_name, | | const gchar *prop_name, | |
| guint32 state); | | guint32 state); | |
| | | | |
| /** | | /** | |
| * ibus_input_context_focus_in: | | * ibus_input_context_focus_in: | |
| * @context: An IBusInputContext. | | * @context: An IBusInputContext. | |
| * | | * | |
| * Invoked when the client application get focus. | | * Invoked when the client application get focus. | |
| * | | * | |
|
| * @see_also: #IBusEngine::focus_in. | | * see_also: #IBusEngine::focus_in. | |
| */ | | */ | |
| void ibus_input_context_focus_in (IBusInputContext *context); | | void ibus_input_context_focus_in (IBusInputContext *context); | |
| | | | |
| /** | | /** | |
| * ibus_input_context_focus_out: | | * ibus_input_context_focus_out: | |
| * @context: An IBusInputContext. | | * @context: An IBusInputContext. | |
| * | | * | |
| * Invoked when the client application get focus. | | * Invoked when the client application get focus. | |
| * | | * | |
|
| * @see_also: #IBusEngine::focus_out. | | * see_also: #IBusEngine::focus_out. | |
| */ | | */ | |
| void ibus_input_context_focus_out (IBusInputContext *context); | | void ibus_input_context_focus_out (IBusInputContext *context); | |
| | | | |
| /** | | /** | |
| * ibus_input_context_reset: | | * ibus_input_context_reset: | |
| * @context: An IBusInputContext. | | * @context: An IBusInputContext. | |
| * | | * | |
| * Invoked when the IME is reset. | | * Invoked when the IME is reset. | |
| * | | * | |
|
| * @see_also: #IBusEngine::reset | | * see_also: #IBusEngine::reset | |
| */ | | */ | |
| void ibus_input_context_reset (IBusInputContext *context); | | void ibus_input_context_reset (IBusInputContext *context); | |
| | | | |
| /** | | /** | |
| * ibus_input_context_enable: | | * ibus_input_context_enable: | |
| * @context: An IBusInputContext. | | * @context: An IBusInputContext. | |
| * | | * | |
| * Invoked when the IME is enabled, either by IME switch hotkey or select f
rom the menu. | | * Invoked when the IME is enabled, either by IME switch hotkey or select f
rom the menu. | |
| * | | * | |
|
| * @see_also: #IBusEngine::enable | | * see_also: #IBusEngine::enable | |
| */ | | */ | |
| void ibus_input_context_enable (IBusInputContext *context); | | void ibus_input_context_enable (IBusInputContext *context); | |
| | | | |
| /** | | /** | |
| * ibus_input_context_disable: | | * ibus_input_context_disable: | |
| * @context: An IBusInputContext. | | * @context: An IBusInputContext. | |
| * | | * | |
| * Invoked when the IME is disabled, either by IME switch hotkey or select
from the menu. | | * Invoked when the IME is disabled, either by IME switch hotkey or select
from the menu. | |
| * | | * | |
|
| * @see_also: #IBusEngine::disable | | * see_also: #IBusEngine::disable | |
| */ | | */ | |
| void ibus_input_context_disable (IBusInputContext *context); | | void ibus_input_context_disable (IBusInputContext *context); | |
| | | | |
| /** | | /** | |
| * ibus_input_context_is_enabled: | | * ibus_input_context_is_enabled: | |
| * @context: An IBusInputContext. | | * @context: An IBusInputContext. | |
| * @returns: TRUE if the IME is enabled on the context. | | * @returns: TRUE if the IME is enabled on the context. | |
| * | | * | |
| * Returns TRUE if the IME is enabled on the context. | | * Returns TRUE if the IME is enabled on the context. | |
| */ | | */ | |
| gboolean ibus_input_context_is_enabled (IBusInputContext *context); | | gboolean ibus_input_context_is_enabled (IBusInputContext *context); | |
| | | | |
| /** | | /** | |
| * ibus_input_context_get_engine: | | * ibus_input_context_get_engine: | |
| * @context: An IBusInputContext. | | * @context: An IBusInputContext. | |
|
| * @returns: An IME engine description for the context | | * @returns: (transfer none): An IME engine description for the context | |
| * | | * | |
| * Returns an IME engine description for the context. | | * Returns an IME engine description for the context. | |
| */ | | */ | |
| IBusEngineDesc | | IBusEngineDesc | |
| *ibus_input_context_get_engine (IBusInputContext *context); | | *ibus_input_context_get_engine (IBusInputContext *context); | |
| | | | |
| /** | | /** | |
| * ibus_input_context_set_engine: | | * ibus_input_context_set_engine: | |
| * @context: An IBusInputContext. | | * @context: An IBusInputContext. | |
| * @name: A name of the engine. | | * @name: A name of the engine. | |
| | | | |
End of changes. 12 change blocks. |
| 12 lines changed or deleted | | 64 lines changed or added | |
|