Caribou.DisplayAdapter¶

Subclasses:: Caribou.NullAdapter, Caribou.XAdapter

Methods¶

Inherited:: GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`get_default` ()
class	`set_default` (adapter)
	`get_current_group` ()
	`get_display` ()
	`get_groups` ()
	`keyval_press` (keyval)
	`keyval_release` (keyval)
	`mod_latch` (mask)
	`mod_lock` (mask)
	`mod_unlatch` (mask)
	`mod_unlock` (mask)
	`register_button_func` (button, func, *func_target)
	`register_key_func` (keyval, func, *func_target)

Virtual Methods¶

Inherited:: GObject.Object (7)

	`do_get_current_group` ()
	`do_get_groups` ()
	`do_keyval_press` (keyval)
	`do_keyval_release` (keyval)
	`do_mod_latch` (mask)
	`do_mod_lock` (mask)
	`do_mod_unlatch` (mask)
	`do_mod_unlock` (mask)
	`do_register_button_func` (button, func, func_target)
	`do_register_key_func` (keyval, func, func_target)

Properties¶

Name	Type	Flags	Short Description
`display`	`Gdk.Display`	r/w/co	display

Signals¶

Inherited:: GObject.Object (1)

Name	Short Description
`config-changed`
`group-changed`
`modifiers-changed`

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent_instance	`GObject.Object`	r

Class Details¶

class Caribou.DisplayAdapter(**kwargs)¶

Bases:: GObject.Object
Abstract:: Yes
Structure:: Caribou.DisplayAdapterClass

classmethod get_default()¶

Return type:: Caribou.DisplayAdapter

classmethod set_default(adapter)¶

Parameters:: adapter (Caribou.DisplayAdapter) –
Return type:: bool

get_current_group()¶

Return type:: (int, group_name: str, variant_name: str)

get_display()¶

Return type:: Gdk.Display

get_groups()¶

Return type:: (group_names: [str], variant_names: [str])

keyval_press(keyval)¶

Parameters:: keyval (int) –

keyval_release(keyval)¶

Parameters:: keyval (int) –

mod_latch(mask)¶

Parameters:: mask (int) –

mod_lock(mask)¶

Parameters:: mask (int) –

mod_unlatch(mask)¶

Parameters:: mask (int) –

mod_unlock(mask)¶

Parameters:: mask (int) –

register_button_func(button, func, *func_target)¶

Parameters:

button (int) –
func (Caribou.KeyButtonCallback or None) –
func_target (object or None) –

register_key_func(keyval, func, *func_target)¶

Parameters:

keyval (int) –
func (Caribou.KeyButtonCallback or None) –
func_target (object or None) –

do_get_current_group() virtual¶

Return type:: (int, group_name: str, variant_name: str)

do_get_groups() virtual¶

Return type:: (group_names: [str], variant_names: [str])

do_keyval_press(keyval) virtual¶

Parameters:: keyval (int) –

do_keyval_release(keyval) virtual¶

Parameters:: keyval (int) –

do_mod_latch(mask) virtual¶

Parameters:: mask (int) –

do_mod_lock(mask) virtual¶

Parameters:: mask (int) –

do_mod_unlatch(mask) virtual¶

Parameters:: mask (int) –

do_mod_unlock(mask) virtual¶

Parameters:: mask (int) –

do_register_button_func(button, func, func_target) virtual¶

Parameters:

button (int) –
func (Caribou.KeyButtonCallback or None) –
func_target (object or None) –

do_register_key_func(keyval, func, func_target) virtual¶

Parameters:

keyval (int) –
func (Caribou.KeyButtonCallback or None) –
func_target (object or None) –

Signal Details¶

Caribou.DisplayAdapter.signals.config_changed(display_adapter)¶

Signal Name:: config-changed
Flags:: RUN_LAST
Parameters:: display_adapter (Caribou.DisplayAdapter) – The object which received the signal

Caribou.DisplayAdapter.signals.group_changed(display_adapter, gid, group, variant)¶

Signal Name:

group-changed

Flags:

RUN_LAST

Parameters:

display_adapter (Caribou.DisplayAdapter) – The object which received the signal
gid (int) –
group (str) –
variant (str) –

Caribou.DisplayAdapter.signals.modifiers_changed(display_adapter, modifiers)¶

Signal Name:

modifiers-changed

Flags:

RUN_LAST

Parameters:

display_adapter (Caribou.DisplayAdapter) – The object which received the signal
modifiers (int) –

Property Details¶

Caribou.DisplayAdapter.props.display¶

Name:: display
Type:: Gdk.Display
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

display