IBusEngine

IBusEngine

Synopsis

                    IBusEngine;
IBusEngine *        ibus_engine_new                     (const gchar *name,
                                                         const gchar *path,
                                                         IBusConnection *connection);
void                ibus_engine_commit_text             (IBusEngine *engine,
                                                         IBusText *text);
void                ibus_engine_update_preedit_text     (IBusEngine *engine,
                                                         IBusText *text,
                                                         guint cursor_pos,
                                                         gboolean visible);
void                ibus_engine_show_preedit_text       (IBusEngine *engine);
void                ibus_engine_hide_preedit_text       (IBusEngine *engine);
void                ibus_engine_update_auxiliary_text   (IBusEngine *engine,
                                                         IBusText *text,
                                                         gboolean visible);
void                ibus_engine_show_auxiliary_text     (IBusEngine *engine);
void                ibus_engine_hide_auxiliary_text     (IBusEngine *engine);
void                ibus_engine_update_lookup_table     (IBusEngine *engine,
                                                         IBusLookupTable *lookup_table,
                                                         gboolean visible);
void                ibus_engine_update_lookup_table_fast
                                                        (IBusEngine *engine,
                                                         IBusLookupTable *lookup_table,
                                                         gboolean visible);
void                ibus_engine_show_lookup_table       (IBusEngine *engine);
void                ibus_engine_hide_lookup_table       (IBusEngine *engine);
void                ibus_engine_forward_key_event       (IBusEngine *engine,
                                                         guint keyval,
                                                         guint state);
void                ibus_engine_register_properties     (IBusEngine *engine,
                                                         IBusPropList *prop_list);
void                ibus_engine_update_property         (IBusEngine *engine,
                                                         IBusProperty *prop);
const gchar *       ibus_engine_get_name                (IBusEngine *engine);

Object Hierarchy

  GObject
   +----IBusObject
         +----IBusService
               +----IBusEngine

Properties

  "connection"               IBusConnection*       : Read / Write / Construct Only
  "name"                     gchar*                : Read / Write / Construct Only

Signals

  "cursor-down"                                    : Run Last
  "cursor-up"                                      : Run Last
  "disable"                                        : Run Last
  "enable"                                         : Run Last
  "focus-in"                                       : Run Last
  "focus-out"                                      : Run Last
  "page-down"                                      : Run Last
  "page-up"                                        : Run Last
  "process-key-event"                              : Run Last
  "property-activate"                              : Run Last
  "property-hide"                                  : Run Last
  "property-show"                                  : Run Last
  "reset"                                          : Run Last
  "set-capabilities"                               : Run Last
  "set-cursor-location"                            : Run Last

Description

Details

IBusEngine

typedef struct _IBusEngine IBusEngine;


ibus_engine_new ()

IBusEngine *        ibus_engine_new                     (const gchar *name,
                                                         const gchar *path,
                                                         IBusConnection *connection);

name :

path :

connection :

Returns :


ibus_engine_commit_text ()

void                ibus_engine_commit_text             (IBusEngine *engine,
                                                         IBusText *text);

engine :

text :


ibus_engine_update_preedit_text ()

void                ibus_engine_update_preedit_text     (IBusEngine *engine,
                                                         IBusText *text,
                                                         guint cursor_pos,
                                                         gboolean visible);

engine :

text :

cursor_pos :

visible :


ibus_engine_show_preedit_text ()

void                ibus_engine_show_preedit_text       (IBusEngine *engine);

engine :


ibus_engine_hide_preedit_text ()

void                ibus_engine_hide_preedit_text       (IBusEngine *engine);

engine :


ibus_engine_update_auxiliary_text ()

void                ibus_engine_update_auxiliary_text   (IBusEngine *engine,
                                                         IBusText *text,
                                                         gboolean visible);

engine :

text :

visible :


ibus_engine_show_auxiliary_text ()

void                ibus_engine_show_auxiliary_text     (IBusEngine *engine);

engine :


ibus_engine_hide_auxiliary_text ()

void                ibus_engine_hide_auxiliary_text     (IBusEngine *engine);

engine :


ibus_engine_update_lookup_table ()

void                ibus_engine_update_lookup_table     (IBusEngine *engine,
                                                         IBusLookupTable *lookup_table,
                                                         gboolean visible);

engine :

lookup_table :

visible :


ibus_engine_update_lookup_table_fast ()

void                ibus_engine_update_lookup_table_fast
                                                        (IBusEngine *engine,
                                                         IBusLookupTable *lookup_table,
                                                         gboolean visible);

engine :

lookup_table :

visible :


ibus_engine_show_lookup_table ()

void                ibus_engine_show_lookup_table       (IBusEngine *engine);

engine :


ibus_engine_hide_lookup_table ()

void                ibus_engine_hide_lookup_table       (IBusEngine *engine);

engine :


ibus_engine_forward_key_event ()

void                ibus_engine_forward_key_event       (IBusEngine *engine,
                                                         guint keyval,
                                                         guint state);

engine :

keyval :

state :


ibus_engine_register_properties ()

void                ibus_engine_register_properties     (IBusEngine *engine,
                                                         IBusPropList *prop_list);

engine :

prop_list :


ibus_engine_update_property ()

void                ibus_engine_update_property         (IBusEngine *engine,
                                                         IBusProperty *prop);

engine :

prop :


ibus_engine_get_name ()

const gchar *       ibus_engine_get_name                (IBusEngine *engine);

engine :

Returns :

Property Details

The "connection" property

  "connection"               IBusConnection*       : Read / Write / Construct Only

Connection for this IBusEngine.


The "name" property

  "name"                     gchar*                : Read / Write / Construct Only

Name of this IBusEngine.

Default value: "noname"

Signal Details

The "cursor-down" signal

void                user_function                      (IBusEngine *engine,
                                                        gpointer    user_data)      : Run Last

This signal is emitted whenever the down cursor key is pressed. Implement cursor_down() in extend class to receive this signal.

engine :

An IBusEngine.

user_data :

user data set when the signal handler was connected.

The "cursor-up" signal

void                user_function                      (IBusEngine *engine,
                                                        gpointer    user_data)      : Run Last

This signal is emitted whenever the up cursor key is pressed. Implement cursor_up() in extend class to receive this signal.

engine :

An IBusEngine.

user_data :

user data set when the signal handler was connected.

The "disable" signal

void                user_function                      (IBusEngine *engine,
                                                        gpointer    user_data)      : Run Last

This signal is emitted whenever the IME is disabled. Implement disable() in extend class to receive this signal.

engine :

An IBusEngine.

user_data :

user data set when the signal handler was connected.

The "enable" signal

void                user_function                      (IBusEngine *engine,
                                                        gpointer    user_data)      : Run Last

This signal is emitted whenever the IME is enabled. Implement enable() in extend class to receive this signal.

engine :

An IBusEngine.

user_data :

user data set when the signal handler was connected.

The "focus-in" signal

void                user_function                      (IBusEngine *engine,
                                                        gpointer    user_data)      : Run Last

This signal is emitted whenever the client application get the focus. Implement focus_in() in extend class to receive this signal.

engine :

An IBusEngine.

user_data :

user data set when the signal handler was connected.

The "focus-out" signal

void                user_function                      (IBusEngine *engine,
                                                        gpointer    user_data)      : Run Last

This signal is emitted whenever the client application lost the focus. Implement focus_out() in extend class to receive this signal.

engine :

An IBusEngine.

user_data :

user data set when the signal handler was connected.

The "page-down" signal

void                user_function                      (IBusEngine *engine,
                                                        gpointer    user_data)      : Run Last

This signal is emitted whenever the page-down key is pressed. Implement page_down() in extend class to receive this signal.

engine :

An IBusEngine.

user_data :

user data set when the signal handler was connected.

The "page-up" signal

void                user_function                      (IBusEngine *engine,
                                                        gpointer    user_data)      : Run Last

This signal is emitted whenever the page-up key is pressed. Implement page_up() in extend class to receive this signal.

engine :

An IBusEngine.

user_data :

user data set when the signal handler was connected.

The "process-key-event" signal

gboolean            user_function                      (IBusEngine *engine,
                                                        guint       keyval,
                                                        guint       state,
                                                        gpointer    user_data)      : Run Last

This signal is emitted whenever a key event is received. Implement process_key_event() in extend class to receive this signal.

engine :

An IBusEngine.

keyval :

KeySym of the key press.

state :

Key modifier flags

user_data :

user data set when the signal handler was connected.

The "property-activate" signal

void                user_function                      (IBusEngine *engine,
                                                        gchar      *arg1,
                                                        guint       arg2,
                                                        gpointer    user_data)      : Run Last

This signal is emitted whenever a property is activated or change changed. Implement property_activate() in extend class to receive this signal.

engine :

An IBusEngine.

user_data :

user data set when the signal handler was connected.

The "property-hide" signal

void                user_function                      (IBusEngine *engine,
                                                        gchar      *arg1,
                                                        gpointer    user_data)      : Run Last

This signal is emitted whenever a property is hidden. Implement property_hide() in extend class to receive this signal.

engine :

An IBusEngine.

user_data :

user data set when the signal handler was connected.

The "property-show" signal

void                user_function                      (IBusEngine *engine,
                                                        gchar      *arg1,
                                                        gpointer    user_data)      : Run Last

This signal is emitted whenever a property is shown. Implement property_show() in extend class to receive this signal.

engine :

An IBusEngine.

user_data :

user data set when the signal handler was connected.

The "reset" signal

void                user_function                      (IBusEngine *engine,
                                                        gpointer    user_data)      : Run Last

This signal is emitted whenever the IME is reset. Implement reset() in extend class to receive this signal.

engine :

An IBusEngine.

user_data :

user data set when the signal handler was connected.

The "set-capabilities" signal

void                user_function                      (IBusEngine *engine,
                                                        guint       arg1,
                                                        gpointer    user_data)      : Run Last

This signal is emitted whenever the client application capabilities is set. Implement set_cursor_location() in extend class to receive this signal.

engine :

An IBusEngine.

user_data :

user data set when the signal handler was connected.

The "set-cursor-location" signal

void                user_function                      (IBusEngine *engine,
                                                        gint        arg1,
                                                        gint        arg2,
                                                        gint        arg3,
                                                        gint        arg4,
                                                        gpointer    user_data)      : Run Last

This signal is emitted whenever the location of IME is set. Implement set_cursor_location() in extend class to receive this signal.

engine :

An IBusEngine.

user_data :

user data set when the signal handler was connected.