EekboardContextService

## EekboardContextService EekboardContextService — base server implementation of eekboard input context service |

## Synopsis

    #define             EEKBOARD_CONTEXT_SERVICE_PATH
    #define             EEKBOARD_CONTEXT_SERVICE_INTERFACE
    struct              EekboardContextService;
    struct              EekboardContextServiceClass;
    void                eekboard_context_service_enable     (EekboardContextService *context);
    void                eekboard_context_service_disable    (EekboardContextService *context);
    EekKeyboard *       eekboard_context_service_get_keyboard
                                                            (EekboardContextService *context);
    gboolean            eekboard_context_service_get_fullscreen
                                                            (EekboardContextService *context);
    const gchar *       eekboard_context_service_get_client_name
                                                            (EekboardContextService *context);
                        EekboardContextServicePrivate;

## Object Hierarchy

      GObject
       +----EekboardContextService

## Properties

      "client-name"              gchar*                : Read / Write
      "connection"               GDBusConnection*      : Read / Write / Construct
      "fullscreen"               gboolean              : Read / Write
      "keyboard"                 EekKeyboard*          : Read / Write
      "object-path"              gchar*                : Read / Write / Construct
      "visible"                  gboolean              : Read / Write

## Signals

      "destroyed"                                      : Run Last
      "disabled"                                       : Run Last
      "enabled"                                        : Run Last

## Description

The EekboardService class provides a base server side implementation of eekboard input context service.

## Details

### EEKBOARD_CONTEXT_SERVICE_PATH

    #define EEKBOARD_CONTEXT_SERVICE_PATH "/org/fedorahosted/Eekboard/Context_%d"

### EEKBOARD_CONTEXT_SERVICE_INTERFACE

    #define EEKBOARD_CONTEXT_SERVICE_INTERFACE "org.fedorahosted.Eekboard.Context"

### struct EekboardContextService

    struct EekboardContextService;

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

### struct EekboardContextServiceClass

    struct EekboardContextServiceClass {
        EekKeyboard *(*create_keyboard)    (EekboardContextService *self,
                                            const gchar            *keyboard_type);
        void         (*show_keyboard)      (EekboardContextService *self);
        void         (*hide_keyboard)      (EekboardContextService *self);

        /* signals */
        void         (*enabled)            (EekboardContextService *self);
        void         (*disabled)           (EekboardContextService *self);
        void         (*destroyed)          (EekboardContextService *self);
    };

`create_keyboard` () | virtual function for create a keyboard from string
`show_keyboard` () | virtual function for show a keyboard
`hide_keyboard` () | virtual function for hide a keyboard
`enabled` () | class handler for "enabled" signal
`disabled` () | class handler for "disabled" signal
`destroyed` () |

### eekboard_context_service_enable ()

    void                eekboard_context_service_enable     (EekboardContextService *context);

Enable `context`. This function is called when `context` is pushed by `eekboard_service_push_context()`.

`context` : | an EekboardContextService

### eekboard_context_service_disable ()

    void                eekboard_context_service_disable    (EekboardContextService *context);

Disable `context`. This function is called when `context` is pushed by `eekboard_service_pop_context()`.

`context` : | an EekboardContextService

### eekboard_context_service_get_keyboard ()

    EekKeyboard *       eekboard_context_service_get_keyboard
                                                            (EekboardContextService *context);

Get keyboard currently active in `context`.

`context` : | an EekboardContextService
Returns : | an EekKeyboard. [transfer none]

### eekboard_context_service_get_fullscreen ()

    gboolean            eekboard_context_service_get_fullscreen
                                                            (EekboardContextService *context);

Check if keyboard is rendered in fullscreen mode in `context`.

`context` : | an EekboardContextService
Returns : | `TRUE` or `FALSE`

### eekboard_context_service_get_client_name ()

    const gchar *       eekboard_context_service_get_client_name
                                                            (EekboardContextService *context);

Get the name of client which created `context`.

`context` : | an EekboardContextService
Returns : | a string. [transfer none]

### EekboardContextServicePrivate

    typedef struct _EekboardContextServicePrivate EekboardContextServicePrivate;

## Property Details

### The `"client-name"` property

      "client-name"              gchar*                : Read / Write

Name of a client who created this context service.

Default value: NULL

### The `"connection"` property

      "connection"               GDBusConnection*      : Read / Write / Construct

D-Bus connection.

### The `"fullscreen"` property

      "fullscreen"               gboolean              : Read / Write

Flag to indicate if keyboard is rendered in fullscreen mode.

Default value: FALSE

### The `"keyboard"` property

      "keyboard"                 EekKeyboard*          : Read / Write

An EekKeyboard currently active in this context.

### The `"object-path"` property

      "object-path"              gchar*                : Read / Write / Construct

D-Bus object path.

Default value: NULL

### The `"visible"` property

      "visible"                  gboolean              : Read / Write

Flag to indicate if keyboard is visible or not.

Default value: FALSE

## Signal Details

### The `"destroyed"` signal

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

Emitted when `context` is destroyed.

`context` : | an EekboardContextService
`user_data` : | user data set when the signal handler was connected.

### The `"disabled"` signal

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

Emitted when `context` is enabled.

`context` : | an EekboardContextService
`user_data` : | user data set when the signal handler was connected.

### The `"enabled"` signal

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

Emitted when `context` is enabled.

`context` : | an EekboardContextService
`user_data` : | user data set when the signal handler was connected.