EekboardContextService

EekboardContextService — base server implementation of eekboard input context service

Functions

Properties

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

Signals

void destroyed Run Last
void disabled Run Last
void enabled Run Last

Types and Values

Object Hierarchy

    GObject
    ╰── EekboardContextService

Description

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

Functions

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().

Parameters

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().

Parameters

context

an EekboardContextService

 

eekboard_context_service_get_keyboard ()

EekKeyboard *
eekboard_context_service_get_keyboard (EekboardContextService *context);

Get keyboard currently active in context .

Parameters

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 .

Parameters

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 .

Parameters

context

an EekboardContextService

 

Returns

a string.

[transfer none]

Types and Values

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);
};

Members

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 ()

   

EekboardContextServicePrivate

typedef struct _EekboardContextServicePrivate EekboardContextServicePrivate;

Property Details

The “client-name” property

  “client-name”              char *

Name of a client who created this context service.

Owner: EekboardContextService

Flags: Read / Write

Default value: NULL


The “connection” property

  “connection”               GDBusConnection *

D-Bus connection.

Owner: EekboardContextService

Flags: Read / Write / Construct


The “fullscreen” property

  “fullscreen”               gboolean

Flag to indicate if keyboard is rendered in fullscreen mode.

Owner: EekboardContextService

Flags: Read / Write

Default value: FALSE


The “keyboard” property

  “keyboard”                 EekKeyboard *

An EekKeyboard currently active in this context.

Owner: EekboardContextService

Flags: Read / Write


The “object-path” property

  “object-path”              char *

D-Bus object path.

Owner: EekboardContextService

Flags: Read / Write / Construct

Default value: NULL


The “visible” property

  “visible”                  gboolean

Flag to indicate if keyboard is visible or not.

Owner: EekboardContextService

Flags: Read / Write

Default value: FALSE

Signal Details

The “destroyed” signal

void
user_function (EekboardContextService *context,
               gpointer                user_data)

Emitted when context is destroyed.

Parameters

context

an EekboardContextService

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last


The “disabled” signal

void
user_function (EekboardContextService *context,
               gpointer                user_data)

Emitted when context is enabled.

Parameters

context

an EekboardContextService

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last


The “enabled” signal

void
user_function (EekboardContextService *context,
               gpointer                user_data)

Emitted when context is enabled.

Parameters

context

an EekboardContextService

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last