CaribouDisplayAdapter: Reference Manual

CaribouDisplayAdapter

CaribouDisplayAdapter — Base class of singleton object providing access to the display server.

Functions

void	caribou_display_adapter_keyval_press ()
void	caribou_display_adapter_keyval_release ()
void	caribou_display_adapter_mod_lock ()
void	caribou_display_adapter_mod_unlock ()
void	caribou_display_adapter_mod_latch ()
void	caribou_display_adapter_mod_unlatch ()
guint	caribou_display_adapter_get_current_group ()
void	caribou_display_adapter_get_groups ()
void	caribou_display_adapter_register_key_func ()
void	caribou_display_adapter_register_button_func ()
GdkDisplay *	caribou_display_adapter_get_display ()
gboolean	caribou_display_adapter_set_default ()
CaribouDisplayAdapter *	caribou_display_adapter_get_default ()
CaribouNullAdapter *	caribou_null_adapter_new ()
void	(*CaribouKeyButtonCallback) ()

Properties

GdkDisplay *

display

Read / Write / Construct Only

Signals

void	config-changed	Run Last
void	group-changed	Run Last
void	modifiers-changed	Run Last

Types and Values

#define	CARIBOU_TYPE_DISPLAY_ADAPTER
struct	CaribouDisplayAdapter
struct	CaribouDisplayAdapterClass
#define	CARIBOU_TYPE_NULL_ADAPTER
struct	CaribouNullAdapter
struct	CaribouNullAdapterClass

Object Hierarchy

    GObject
    ╰── CaribouDisplayAdapter
        ├── CaribouNullAdapter
        ╰── CaribouXAdapter

Description

Functions

caribou_display_adapter_keyval_press ()

void
caribou_display_adapter_keyval_press (CaribouDisplayAdapter *self,
                                      guint keyval);

Send key press event.

Parameters

self

the CaribouDisplayAdapter instance

keyval

[in]

caribou_display_adapter_keyval_release ()

void
caribou_display_adapter_keyval_release
                               (CaribouDisplayAdapter *self,
                                guint keyval);

Send key release event.

Parameters

self

the CaribouDisplayAdapter instance

keyval

[in]

caribou_display_adapter_mod_lock ()

void
caribou_display_adapter_mod_lock (CaribouDisplayAdapter *self,
                                  guint mask);

Lock modifiers.

Parameters

self

the CaribouDisplayAdapter instance

mask

modifiers

[in]

caribou_display_adapter_mod_unlock ()

void
caribou_display_adapter_mod_unlock (CaribouDisplayAdapter *self,
                                    guint mask);

Unlock modifiers.

Parameters

self

the CaribouDisplayAdapter instance

mask

modifiers

[in]

caribou_display_adapter_mod_latch ()

void
caribou_display_adapter_mod_latch (CaribouDisplayAdapter *self,
                                   guint mask);

Latch modifiers.

Parameters

self

the CaribouDisplayAdapter instance

mask

modifiers

[in]

caribou_display_adapter_mod_unlatch ()

void
caribou_display_adapter_mod_unlatch (CaribouDisplayAdapter *self,
                                     guint mask);

Unlatch modifiers.

Parameters

self

the CaribouDisplayAdapter instance

mask

modifiers

[in]

caribou_display_adapter_get_current_group ()

guint
caribou_display_adapter_get_current_group
                               (CaribouDisplayAdapter *self,
                                gchar **group_name,
                                gchar **variant_name);

Get the current group.

Parameters

self

the CaribouDisplayAdapter instance

group_name

group name

[out]

variant_name

variant name

[out]

caribou_display_adapter_get_groups ()

void
caribou_display_adapter_get_groups (CaribouDisplayAdapter *self,
                                    gchar ***group_names,
                                    int *group_names_length1,
                                    gchar ***variant_names,
                                    int *variant_names_length1);

Get available groups.

Parameters

self	the CaribouDisplayAdapter instance
group_names	. list of groups .	[out][array length=group_names_length1]
group_names_length1	length of the `group_names` array
variant_names	. list of variants, indexed same as group_names .	[out][array length=variant_names_length1]
variant_names_length1	length of the `variant_names` array

caribou_display_adapter_register_key_func ()

void
caribou_display_adapter_register_key_func
                               (CaribouDisplayAdapter *self,
                                guint keyval,
                                CaribouKeyButtonCallback func,
                                void *func_target);

Parameters

self	the CaribouDisplayAdapter instance
keyval	. keyval .	[in]
func	. callback .	[in][allow-none]
func_target	user data to pass to `func` .	[allow-none][closure]

caribou_display_adapter_register_button_func ()

void
caribou_display_adapter_register_button_func
                               (CaribouDisplayAdapter *self,
                                guint button,
                                CaribouKeyButtonCallback func,
                                void *func_target);

Parameters

self	the CaribouDisplayAdapter instance
button	. button .	[in]
func	. callback .	[in][allow-none]
func_target	user data to pass to `func` .	[allow-none][closure]

caribou_display_adapter_get_display ()

GdkDisplay *
caribou_display_adapter_get_display (CaribouDisplayAdapter *self);

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

Display instance.

Parameters

self

the CaribouDisplayAdapter instance to query

Returns

the value of the "display" property

caribou_display_adapter_set_default ()

gboolean
caribou_display_adapter_set_default (CaribouDisplayAdapter *adapter);

Parameters

adapter

caribou_display_adapter_get_default ()

CaribouDisplayAdapter *
caribou_display_adapter_get_default (void);

caribou_null_adapter_new ()

CaribouNullAdapter *
caribou_null_adapter_new (void);

CaribouKeyButtonCallback ()

void
(*CaribouKeyButtonCallback) (guint keybuttoncode,
                             gboolean pressed,
                             void *user_data);

Parameters

keybuttoncode
pressed
user_data	data to pass to the delegate function.	[closure]

Types and Values

CARIBOU_TYPE_DISPLAY_ADAPTER

#define CARIBOU_TYPE_DISPLAY_ADAPTER (caribou_display_adapter_get_type ())

The type for CaribouDisplayAdapter.

struct CaribouDisplayAdapter

struct CaribouDisplayAdapter;

Base class of singleton object providing access to the display server.

struct CaribouDisplayAdapterClass

struct CaribouDisplayAdapterClass {
	GObjectClass parent_class;
	void (*keyval_press) (CaribouDisplayAdapter* self, guint keyval);
	void (*keyval_release) (CaribouDisplayAdapter* self, guint keyval);
	void (*mod_lock) (CaribouDisplayAdapter* self, guint mask);
	void (*mod_unlock) (CaribouDisplayAdapter* self, guint mask);
	void (*mod_latch) (CaribouDisplayAdapter* self, guint mask);
	void (*mod_unlatch) (CaribouDisplayAdapter* self, guint mask);
	guint (*get_current_group) (CaribouDisplayAdapter* self, gchar** group_name, gchar** variant_name);
	void (*get_groups) (CaribouDisplayAdapter* self, gchar*** group_names, int* group_names_length1, gchar*** variant_names, int* variant_names_length1);
	void (*register_key_func) (CaribouDisplayAdapter* self, guint keyval, CaribouKeyButtonCallback func, void* func_target);
	void (*register_button_func) (CaribouDisplayAdapter* self, guint button, CaribouKeyButtonCallback func, void* func_target);
};

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

Members

`keyval_press` ()	virtual method called by `caribou_display_adapter_keyval_press()`
`keyval_release` ()	virtual method called by `caribou_display_adapter_keyval_release()`
`mod_lock` ()	virtual method called by `caribou_display_adapter_mod_lock()`
`mod_unlock` ()	virtual method called by `caribou_display_adapter_mod_unlock()`
`mod_latch` ()	virtual method called by `caribou_display_adapter_mod_latch()`
`mod_unlatch` ()	virtual method called by `caribou_display_adapter_mod_unlatch()`
`get_current_group` ()	virtual method called by `caribou_display_adapter_get_current_group()`
`get_groups` ()	virtual method called by `caribou_display_adapter_get_groups()`
`register_key_func` ()	virtual method called by `caribou_display_adapter_register_key_func()`
`register_button_func` ()	virtual method called by `caribou_display_adapter_register_button_func()`

CARIBOU_TYPE_NULL_ADAPTER

#define CARIBOU_TYPE_NULL_ADAPTER (caribou_null_adapter_get_type ())

The type for CaribouNullAdapter.

struct CaribouNullAdapter

struct CaribouNullAdapter;

struct CaribouNullAdapterClass

struct CaribouNullAdapterClass {
	CaribouDisplayAdapterClass parent_class;
};

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

Members

Property Details

The `“display”` property

  “display”                  GdkDisplay *

Display instance.

Flags: Read / Write / Construct Only

Signal Details

The `“config-changed”` signal

void
user_function (CaribouDisplayAdapter *display_adapter,
               gpointer               user_data)

Signal emitted when the group configuration has changed.

Parameters

display_adapter	the CaribouDisplayAdapter instance that received the signal
user_data	user data set when the signal handler was connected.

Flags: Run Last

The `“group-changed”` signal

void
user_function (CaribouDisplayAdapter *display_adapter,
               guint                  gid,
               gchar                 *group,
               gchar                 *variant,
               gpointer               user_data)

Signal emitted when the current group has changed.

Parameters

display_adapter	the CaribouDisplayAdapter instance that received the signal
gid	. group index
group	. group name
variant	. variant name
user_data	user data set when the signal handler was connected.

Flags: Run Last

The `“modifiers-changed”` signal

void
user_function (CaribouDisplayAdapter *display_adapter,
               guint                  modifiers,
               gpointer               user_data)

Signal emitted when modifiers have changed.

Parameters

display_adapter	the CaribouDisplayAdapter instance that received the signal
modifiers
user_data	user data set when the signal handler was connected.

Flags: Run Last