CaribouKeyboardModel

CaribouKeyboardModel — Object representing a whole keyboard.

Functions

Properties

gchar * active-group Read
gchar * keyboard-file Read / Write / Construct Only
gchar * keyboard-type Read / Write / Construct Only

Signals

void group-added Run Last
void group-removed Run Last

Types and Values

Object Hierarchy

    GObject
    ╰── CaribouKeyboardModel

Implemented Interfaces

CaribouKeyboardModel implements CaribouIKeyboardObject.

Description

This is used for implementing custom keyboard service.

A keyboard object consists of CaribouGroupModel objects.

Functions

caribou_keyboard_model_get_groups ()

gchar **
caribou_keyboard_model_get_groups (CaribouKeyboardModel *self,
                                   int *result_length1);

Parameters

self

the CaribouKeyboardModel instance

 

Returns

.

[array length=result_length1]


caribou_keyboard_model_get_group ()

CaribouGroupModel *
caribou_keyboard_model_get_group (CaribouKeyboardModel *self,
                                  const gchar *group_name);

Parameters

self

the CaribouKeyboardModel instance

 

group_name

 

 

caribou_keyboard_model_new ()

CaribouKeyboardModel *
caribou_keyboard_model_new (void);

caribou_keyboard_model_get_active_group ()

const gchar *
caribou_keyboard_model_get_active_group
                               (CaribouKeyboardModel *self);

Get and return the current value of the "active-group" property.

Parameters

self

the CaribouKeyboardModel instance to query

 

Returns

the value of the "active-group" property


caribou_keyboard_model_get_keyboard_type ()

const gchar *
caribou_keyboard_model_get_keyboard_type
                               (CaribouKeyboardModel *self);

Get and return the current value of the "keyboard-type" property.

Parameters

self

the CaribouKeyboardModel instance to query

 

Returns

the value of the "keyboard-type" property


caribou_keyboard_model_get_keyboard_file ()

const gchar *
caribou_keyboard_model_get_keyboard_file
                               (CaribouKeyboardModel *self);

Get and return the current value of the "keyboard-file" property.

Parameters

self

the CaribouKeyboardModel instance to query

 

Returns

the value of the "keyboard-file" property

Types and Values

CARIBOU_TYPE_KEYBOARD_MODEL

#define CARIBOU_TYPE_KEYBOARD_MODEL (caribou_keyboard_model_get_type ())

The type for CaribouKeyboardModel.


struct CaribouKeyboardModel

struct CaribouKeyboardModel;

Object representing a whole keyboard.

This is used for implementing custom keyboard service.

A keyboard object consists of CaribouGroupModel objects.


struct CaribouKeyboardModelClass

struct CaribouKeyboardModelClass {
	GObjectClass parent_class;
};

The class structure for CARIBOU_TYPE_KEYBOARD_MODEL. All the fields in this structure are private and should never be accessed directly.

Members

Property Details

The “active-group” property

  “active-group”             gchar *

active-group.

Flags: Read

Default value: NULL


The “keyboard-file” property

  “keyboard-file”            gchar *

keyboard-file.

Flags: Read / Write / Construct Only

Default value: NULL


The “keyboard-type” property

  “keyboard-type”            gchar *

keyboard-type.

Flags: Read / Write / Construct Only

Default value: NULL

Signal Details

The “group-added” signal

void
user_function (CaribouKeyboardModel *keyboard_model,
               gchar                *name,
               gpointer              user_data)

Parameters

keyboard_model

the CaribouKeyboardModel instance that received the signal

 

name

 

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last


The “group-removed” signal

void
user_function (CaribouKeyboardModel *keyboard_model,
               gchar                *name,
               gpointer              user_data)

Parameters

keyboard_model

the CaribouKeyboardModel instance that received the signal

 

name

 

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last