CaribouKeyModel

CaribouKeyModel — Object representing a key in a column.

Functions

Properties

gchar * align Read / Write
gboolean is-modifier Read / Write
guint keyval Read
gchar * label Read / Write
gchar * name Read
gboolean repeatable Read / Write
gboolean scan-selected Read / Write
gboolean scan-stepping Read / Write
gboolean show-subkeys Read
gchar * text Read
gchar * toggle Read / Write
gdouble width Read / Write

Signals

void key-hold Run Last
void key-hold-end Run Last

Types and Values

Object Hierarchy

    GEnum
    ╰── CaribouModifierState
    GObject
    ╰── CaribouKeyModel

Implemented Interfaces

CaribouKeyModel implements CaribouIScannableItem and CaribouIKeyboardObject.

Description

This is used for implementing custom keyboard service.

Functions

caribou_key_model_press ()

void
caribou_key_model_press (CaribouKeyModel *self);

Parameters

self

the CaribouKeyModel instance

 

caribou_key_model_release ()

void
caribou_key_model_release (CaribouKeyModel *self);

Parameters

self

the CaribouKeyModel instance

 

caribou_key_model_get_extended_keys ()

CaribouKeyModel **
caribou_key_model_get_extended_keys (CaribouKeyModel *self,
                                     int *result_length1);

Parameters

self

the CaribouKeyModel instance

 

Returns

.

[array length=result_length1]


caribou_key_model_activate ()

void
caribou_key_model_activate (CaribouKeyModel *self);

Parameters

self

the CaribouKeyModel instance

 

caribou_key_model_new ()

CaribouKeyModel *
caribou_key_model_new (const gchar *name,
                       const gchar *text);

Parameters

name

 

 

text

 

 

caribou_key_model_get_align ()

const gchar *
caribou_key_model_get_align (CaribouKeyModel *self);

Get and return the current value of the "align" property.

Parameters

self

the CaribouKeyModel instance to query

 

Returns

the value of the "align" property


caribou_key_model_set_align ()

void
caribou_key_model_set_align (CaribouKeyModel *self,
                             const gchar *value);

Set the value of the "align" property to value .

Parameters

self

the CaribouKeyModel instance to modify

 

value

the new value of the "align" property

 

caribou_key_model_get_width ()

gdouble
caribou_key_model_get_width (CaribouKeyModel *self);

Get and return the current value of the "width" property.

Parameters

self

the CaribouKeyModel instance to query

 

Returns

the value of the "width" property


caribou_key_model_set_width ()

void
caribou_key_model_set_width (CaribouKeyModel *self,
                             gdouble value);

Set the value of the "width" property to value .

Parameters

self

the CaribouKeyModel instance to modify

 

value

the new value of the "width" property

 

caribou_key_model_get_toggle ()

const gchar *
caribou_key_model_get_toggle (CaribouKeyModel *self);

Get and return the current value of the "toggle" property.

Parameters

self

the CaribouKeyModel instance to query

 

Returns

the value of the "toggle" property


caribou_key_model_set_toggle ()

void
caribou_key_model_set_toggle (CaribouKeyModel *self,
                              const gchar *value);

Set the value of the "toggle" property to value .

Parameters

self

the CaribouKeyModel instance to modify

 

value

the new value of the "toggle" property

 

caribou_key_model_get_repeatable ()

gboolean
caribou_key_model_get_repeatable (CaribouKeyModel *self);

Get and return the current value of the "repeatable" property.

Parameters

self

the CaribouKeyModel instance to query

 

Returns

the value of the "repeatable" property


caribou_key_model_set_repeatable ()

void
caribou_key_model_set_repeatable (CaribouKeyModel *self,
                                  gboolean value);

Set the value of the "repeatable" property to value .

Parameters

self

the CaribouKeyModel instance to modify

 

value

the new value of the "repeatable" property

 

caribou_key_model_get_is_modifier ()

gboolean
caribou_key_model_get_is_modifier (CaribouKeyModel *self);

Get and return the current value of the "is-modifier" property.

Parameters

self

the CaribouKeyModel instance to query

 

Returns

the value of the "is-modifier" property


caribou_key_model_set_is_modifier ()

void
caribou_key_model_set_is_modifier (CaribouKeyModel *self,
                                   gboolean value);

Set the value of the "is-modifier" property to value .

Parameters

self

the CaribouKeyModel instance to modify

 

value

the new value of the "is-modifier" property

 

caribou_key_model_get_show_subkeys ()

gboolean
caribou_key_model_get_show_subkeys (CaribouKeyModel *self);

Get and return the current value of the "show-subkeys" property.

Parameters

self

the CaribouKeyModel instance to query

 

Returns

the value of the "show-subkeys" property


caribou_key_model_get_name ()

const gchar *
caribou_key_model_get_name (CaribouKeyModel *self);

Get and return the current value of the "name" property.

Parameters

self

the CaribouKeyModel instance to query

 

Returns

the value of the "name" property


caribou_key_model_get_keyval ()

guint
caribou_key_model_get_keyval (CaribouKeyModel *self);

Get and return the current value of the "keyval" property.

Parameters

self

the CaribouKeyModel instance to query

 

Returns

the value of the "keyval" property


caribou_key_model_get_text ()

const gchar *
caribou_key_model_get_text (CaribouKeyModel *self);

Get and return the current value of the "text" property.

Parameters

self

the CaribouKeyModel instance to query

 

Returns

the value of the "text" property


caribou_key_model_get_label ()

const gchar *
caribou_key_model_get_label (CaribouKeyModel *self);

Get and return the current value of the "label" property.

Parameters

self

the CaribouKeyModel instance to query

 

Returns

the value of the "label" property


caribou_key_model_set_label ()

void
caribou_key_model_set_label (CaribouKeyModel *self,
                             const gchar *value);

Set the value of the "label" property to value .

Parameters

self

the CaribouKeyModel instance to modify

 

value

the new value of the "label" property

 

Types and Values

CARIBOU_TYPE_KEY_MODEL

#define CARIBOU_TYPE_KEY_MODEL (caribou_key_model_get_type ())

The type for CaribouKeyModel.


struct CaribouKeyModel

struct CaribouKeyModel;

Object representing a key in a column.

This is used for implementing custom keyboard service.


struct CaribouKeyModelClass

struct CaribouKeyModelClass {
	GObjectClass parent_class;
};

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

Members


enum CaribouModifierState

Members

CARIBOU_MODIFIER_STATE_NONE

   

CARIBOU_MODIFIER_STATE_LATCHED

   

CARIBOU_MODIFIER_STATE_LOCKED

   

Property Details

The “align” property

  “align”                    gchar *

align.

Flags: Read / Write

Default value: NULL


The “is-modifier” property

  “is-modifier”              gboolean

is-modifier.

Flags: Read / Write

Default value: FALSE


The “keyval” property

  “keyval”                   guint

keyval.

Flags: Read

Default value: 0


The “label” property

  “label”                    gchar *

label.

Flags: Read / Write

Default value: NULL


The “name” property

  “name”                     gchar *

name.

Flags: Read

Default value: NULL


The “repeatable” property

  “repeatable”               gboolean

repeatable.

Flags: Read / Write

Default value: FALSE


The “scan-selected” property

  “scan-selected”            gboolean

scan-selected.

Flags: Read / Write

Default value: FALSE


The “scan-stepping” property

  “scan-stepping”            gboolean

scan-stepping.

Flags: Read / Write

Default value: FALSE


The “show-subkeys” property

  “show-subkeys”             gboolean

show-subkeys.

Flags: Read

Default value: FALSE


The “text” property

  “text”                     gchar *

text.

Flags: Read

Default value: NULL


The “toggle” property

  “toggle”                   gchar *

toggle.

Flags: Read / Write

Default value: NULL


The “width” property

  “width”                    gdouble

width.

Flags: Read / Write

Default value: 1

Signal Details

The “key-hold” signal

void
user_function (CaribouKeyModel *key_model,
               gpointer         user_data)

Parameters

key_model

the CaribouKeyModel instance that received the signal

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last


The “key-hold-end” signal

void
user_function (CaribouKeyModel *key_model,
               gpointer         user_data)

Parameters

key_model

the CaribouKeyModel instance that received the signal

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last