CaribouIKeyboardObject

CaribouIKeyboardObject — Common interface providing access to keys.

Functions

Signals

void key-clicked Run Last
void key-pressed Run Last
void key-released Run Last

Types and Values

Object Hierarchy

    GInterface
    ╰── CaribouIKeyboardObject

Prerequisites

CaribouIKeyboardObject requires GObject.

Known Implementations

CaribouIKeyboardObject is implemented by CaribouColumnModel, CaribouGroupModel, CaribouKeyModel, CaribouKeyboardModel, CaribouLevelModel and CaribouRowModel.

Description

This is implemented by all the keyboard components.

Functions

caribou_ikeyboard_object_get_children ()

CaribouIKeyboardObject **
caribou_ikeyboard_object_get_children (CaribouIKeyboardObject *self,
                                       int *result_length1);

Parameters

self

the CaribouIKeyboardObject instance

 

Returns

.

[array length=result_length1]


caribou_ikeyboard_object_get_keys ()

CaribouKeyModel **
caribou_ikeyboard_object_get_keys (CaribouIKeyboardObject *self,
                                   int *result_length1);

Parameters

self

the CaribouIKeyboardObject instance

 

Returns

.

[array length=result_length1]

Types and Values

CaribouIKeyboardObject

typedef struct _CaribouIKeyboardObject CaribouIKeyboardObject;

Common interface providing access to keys.

This is implemented by all the keyboard components.


struct CaribouIKeyboardObjectIface

struct CaribouIKeyboardObjectIface {
	GTypeInterface parent_iface;
	CaribouIKeyboardObject** (*get_children) (CaribouIKeyboardObject* self, int* result_length1);
	CaribouKeyModel** (*get_keys) (CaribouIKeyboardObject* self, int* result_length1);
};

Interface for creating CaribouIKeyboardObject implementations.

Members

GTypeInterface parent_iface;

the parent interface structure

 

get_children ()

virtual method called by caribou_ikeyboard_object_get_children()

 

get_keys ()

virtual method called by caribou_ikeyboard_object_get_keys()

 

Signal Details

The “key-clicked” signal

void
user_function (CaribouIKeyboardObject *ikeyboard_object,
               CaribouKeyModel        *key,
               gpointer                user_data)

Parameters

ikeyboard_object

the CaribouIKeyboardObject instance that received the signal

 

key

 

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last


The “key-pressed” signal

void
user_function (CaribouIKeyboardObject *ikeyboard_object,
               CaribouKeyModel        *key,
               gpointer                user_data)

Parameters

ikeyboard_object

the CaribouIKeyboardObject instance that received the signal

 

key

 

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last


The “key-released” signal

void
user_function (CaribouIKeyboardObject *ikeyboard_object,
               CaribouKeyModel        *key,
               gpointer                user_data)

Parameters

ikeyboard_object

the CaribouIKeyboardObject instance that received the signal

 

key

 

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last