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_show_lookup_table       (IBusEngine *engine);
void                ibus_engine_hide_lookup_table       (IBusEngine *engine);
void                ibus_engine_forward_key_event       (IBusEngine *engine,
                                                         guint keyval,
                                                         gboolean is_press,
                                                         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_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,
                                                         gboolean is_press,
                                                         guint state);

engine :

keyval :

is_press :

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

The connection of engine object.

The "name" property

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

engine name.

Default value: "noname"

Signal Details

The "cursor-down" signal

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

ibusengine :

 the object which received the signal.

user_data :

 user data set when the signal handler was connected.

The "cursor-up" signal

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

ibusengine :

 the object which received the signal.

user_data :

 user data set when the signal handler was connected.

The "disable" signal

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

ibusengine :

 the object which received the signal.

user_data :

 user data set when the signal handler was connected.

The "enable" signal

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

ibusengine :

 the object which received the signal.

user_data :

 user data set when the signal handler was connected.

The "focus-in" signal

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

ibusengine :

 the object which received the signal.

user_data :

 user data set when the signal handler was connected.

The "focus-out" signal

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

ibusengine :

 the object which received the signal.

user_data :

 user data set when the signal handler was connected.

The "page-down" signal

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

ibusengine :

 the object which received the signal.

user_data :

 user data set when the signal handler was connected.

The "page-up" signal

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

ibusengine :

 the object which received the signal.

user_data :

 user data set when the signal handler was connected.

The "process-key-event" signal

gboolean            user_function                      (IBusEngine *ibusengine,
                                                        guint       arg1,
                                                        guint       arg2,
                                                        gpointer    user_data)       : Run Last

ibusengine :

 the object which received the signal.

arg1 :

arg2 :

user_data :

 user data set when the signal handler was connected.

Returns :

The "property-activate" signal

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

ibusengine :

 the object which received the signal.

Param2 :

Param3 :

user_data :

 user data set when the signal handler was connected.

The "property-hide" signal

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

ibusengine :

 the object which received the signal.

Param2 :

user_data :

 user data set when the signal handler was connected.

The "property-show" signal

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

ibusengine :

 the object which received the signal.

Param2 :

user_data :

 user data set when the signal handler was connected.

The "reset" signal

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

ibusengine :

 the object which received the signal.

user_data :

 user data set when the signal handler was connected.

The "set-capabilities" signal

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

ibusengine :

 the object which received the signal.

arg1 :

user_data :

 user data set when the signal handler was connected.

The "set-cursor-location" signal

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

ibusengine :

 the object which received the signal.

arg1 :

arg2 :

arg3 :

arg4 :

user_data :

 user data set when the signal handler was connected.
Generated by GTK-Doc V1.10