EekboardContext

EekboardContext — input context maintained by EekboardServer.

Synopsis

                    EekboardContext;
                    EekboardContextClass;
                    EekboardContextPrivate;
EekboardContext *   eekboard_context_new                (GDBusConnection *connection,
                                                         const gchar *object_path,
                                                         GCancellable *cancellable);
void                eekboard_context_set_keyboard       (EekboardContext *context,
                                                         guint keyboard_id,
                                                         GCancellable *cancellable);
void                eekboard_context_show_keyboard      (EekboardContext *context,
                                                         GCancellable *cancellable);
void                eekboard_context_hide_keyboard      (EekboardContext *context,
                                                         GCancellable *cancellable);
void                eekboard_context_set_group          (EekboardContext *context,
                                                         gint group,
                                                         GCancellable *cancellable);
void                eekboard_context_press_key          (EekboardContext *context,
                                                         guint keycode,
                                                         GCancellable *cancellable);
void                eekboard_context_release_key        (EekboardContext *context,
                                                         guint keycode,
                                                         GCancellable *cancellable);
gboolean            eekboard_context_is_keyboard_visible
                                                        (EekboardContext *context);
void                eekboard_context_set_enabled        (EekboardContext *context,
                                                         gboolean enabled);
gboolean            eekboard_context_is_enabled         (EekboardContext *context);

Object Hierarchy

  GObject
   +----GDBusProxy
         +----EekboardContext

Implemented Interfaces

EekboardContext implements GInitable and GAsyncInitable.

Properties

  "keyboard-visible"         gboolean              : Read

Signals

  "destroyed"                                      : Run Last
  "disabled"                                       : Run Last
  "enabled"                                        : Run Last
  "key-pressed"                                    : Run Last
  "key-released"                                   : Run Last

Description

The EekboardContext class provides a client access to remote input context.

Details

EekboardContext

typedef struct _EekboardContext EekboardContext;

The EekboardContext structure contains only private data and should only be accessed using the provided API.

EekboardContextClass

typedef struct {
    /* signals */
    void (*enabled)      (EekboardContext *self);
    void (*disabled)     (EekboardContext *self);
    void (*key_pressed)  (EekboardContext *self,
                          guint            keycode);
    void (*key_released) (EekboardContext *self,
                          guint            keycode);
    void (*destroyed)    (EekboardContext *self);
} EekboardContextClass;

enabled ()

 class handler for "enabled" signal

disabled ()

 class handler for "disabled" signal

key_pressed ()

 class handler for "key-pressed" signal

key_released ()

 class handler for "key-released" signal

destroyed ()

EekboardContextPrivate

typedef struct _EekboardContextPrivate EekboardContextPrivate;

eekboard_context_new ()

EekboardContext *   eekboard_context_new                (GDBusConnection *connection,
                                                         const gchar *object_path,
                                                         GCancellable *cancellable);

Create a D-Bus proxy of an input context maintained by eekboard-server. This function is seldom called from applications since eekboard_server_create_context() calls it implicitly.

connection :

 a GDBusConnection

object_path :

 object path

cancellable :

 a GCancellable

eekboard_context_set_keyboard ()

void                eekboard_context_set_keyboard       (EekboardContext *context,
                                                         guint keyboard_id,
                                                         GCancellable *cancellable);

Select a keyboard with ID keyboard_id in context.

context :

 an EekboardContext

keyboard_id :

 keyboard ID

cancellable :

 a GCancellable

eekboard_context_show_keyboard ()

void                eekboard_context_show_keyboard      (EekboardContext *context,
                                                         GCancellable *cancellable);

Request eekboard-server to show a keyboard set by eekboard_context_set_keyboard().

context :

 an EekboardContext

cancellable :

 a GCancellable

eekboard_context_hide_keyboard ()

void                eekboard_context_hide_keyboard      (EekboardContext *context,
                                                         GCancellable *cancellable);

Request eekboard-server to hide a keyboard.

context :

 an EekboardContext

cancellable :

 a GCancellable

eekboard_context_set_group ()

void                eekboard_context_set_group          (EekboardContext *context,
                                                         gint group,
                                                         GCancellable *cancellable);

Set the keyboard group of context.

context :

 an EekboardContext

group :

 group number

cancellable :

 a GCancellable

eekboard_context_press_key ()

void                eekboard_context_press_key          (EekboardContext *context,
                                                         guint keycode,
                                                         GCancellable *cancellable);

Tell eekboard-server that a key identified by keycode is pressed.

context :

 an EekboardContext

keycode :

 keycode number

cancellable :

 a GCancellable

eekboard_context_release_key ()

void                eekboard_context_release_key        (EekboardContext *context,
                                                         guint keycode,
                                                         GCancellable *cancellable);

Tell eekboard-server that a key identified by keycode is released.

context :

 an EekboardContext

keycode :

 keycode number

cancellable :

 a GCancellable

eekboard_context_is_keyboard_visible ()

gboolean            eekboard_context_is_keyboard_visible
                                                        (EekboardContext *context);

Check if keyboard is visible.

context :

 an EekboardContext

eekboard_context_set_enabled ()

void                eekboard_context_set_enabled        (EekboardContext *context,
                                                         gboolean enabled);

Set context enabled or disabled. This function is seldom called since the flag is set via D-Bus signal "enabled" and "disabled".

context :

 an EekboardContext

enabled :

 flag to indicate if context is enabled

eekboard_context_is_enabled ()

gboolean            eekboard_context_is_enabled         (EekboardContext *context);

Check if context is enabled.

context :

 an EekboardContext

Property Details

The "keyboard-visible" property

  "keyboard-visible"         gboolean              : Read

Flag to indicate if keyboard is visible or not.

Default value: FALSE

Signal Details

The "destroyed" signal

void                user_function                      (EekboardContext *context,
                                                        gpointer         user_data)      : Run Last

The ::destroyed signal is emitted each time the name of remote end is vanished.

context :

 an EekboardContext

user_data :

 user data set when the signal handler was connected.

The "disabled" signal

void                user_function                      (EekboardContext *context,
                                                        gpointer         user_data)      : Run Last

The ::disabled signal is emitted each time context is disabled.

context :

 an EekboardContext

user_data :

 user data set when the signal handler was connected.

The "enabled" signal

void                user_function                      (EekboardContext *context,
                                                        gpointer         user_data)      : Run Last

Emitted when context is enabled.

context :

 an EekboardContext

user_data :

 user data set when the signal handler was connected.

The "key-pressed" signal

void                user_function                      (EekboardContext *context,
                                                        guint            keycode,
                                                        gpointer         user_data)      : Run Last

The ::key-pressed signal is emitted each time a key is pressed in context.

context :

 an EekboardContext

keycode :

 keycode

user_data :

 user data set when the signal handler was connected.

The "key-released" signal

void                user_function                      (EekboardContext *context,
                                                        guint            keycode,
                                                        gpointer         user_data)      : Run Last

The ::key-released signal is emitted each time a key is released in context.

context :

 an EekboardContext

keycode :

 keycode

user_data :

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