Caribou.KeyModel¶

Subclasses:: None

Methods¶

Inherited:: GObject.Object (37), Caribou.IScannableItem (4), Caribou.IKeyboardObject (2)
Structs:: GObject.ObjectClass (5)

class	`new` (name, text)
	`activate` ()
	`get_align` ()
	`get_extended_keys` ()
	`get_is_modifier` ()
	`get_keyval` ()
	`get_label` ()
	`get_name` ()
	`get_repeatable` ()
	`get_show_subkeys` ()
	`get_text` ()
	`get_toggle` ()
	`get_width` ()
	`press` ()
	`release` ()
	`set_align` (value)
	`set_is_modifier` (value)
	`set_label` (value)
	`set_repeatable` (value)
	`set_toggle` (value)
	`set_width` (value)

Virtual Methods¶

Inherited:: GObject.Object (7), Caribou.IScannableItem (4), Caribou.IKeyboardObject (2)

Properties¶

Inherited:: Caribou.IScannableItem (2)

Name	Type	Flags	Short Description
`align`	`str`	r/w	align
`is-modifier`	`bool`	r/w	is-modifier
`keyval`	`int`	r	keyval
`label`	`str`	r/w	label
`name`	`str`	r	name
`repeatable`	`bool`	r/w	repeatable
`show-subkeys`	`bool`	r	show-subkeys
`text`	`str`	r	text
`toggle`	`str`	r/w	toggle
`width`	`float`	r/w	width

Signals¶

Inherited:: GObject.Object (1), Caribou.IKeyboardObject (3)

Name	Short Description
`key-hold`
`key-hold-end`

Fields¶

Inherited:: GObject.Object (1), Caribou.IKeyboardObject (3)

Name	Type	Access	Description
modifier_state	`Caribou.ModifierState`	r/w
parent_instance	`GObject.Object`	r

Class Details¶

class Caribou.KeyModel(**kwargs)¶

Bases:: GObject.Object, Caribou.IScannableItem, Caribou.IKeyboardObject
Abstract:: No
Structure:: Caribou.KeyModelClass

classmethod new(name, text)¶

Parameters:

name (str) –
text (str or None) –

Return type:

Caribou.KeyModel

activate()¶

get_align()¶

Return type:: str

get_extended_keys()¶

Return type:: [Caribou.KeyModel]

get_is_modifier()¶

Return type:: bool

get_keyval()¶

Return type:: int

get_label()¶

Return type:: str

get_name()¶

Return type:: str

get_repeatable()¶

Return type:: bool

get_show_subkeys()¶

Return type:: bool

get_text()¶

Return type:: str or None

get_toggle()¶

Return type:: str

get_width()¶

Return type:: float

press()¶

release()¶

set_align(value)¶

Parameters:: value (str) –

set_is_modifier(value)¶

Parameters:: value (bool) –

set_label(value)¶

Parameters:: value (str) –

set_repeatable(value)¶

Parameters:: value (bool) –

set_toggle(value)¶

Parameters:: value (str) –

set_width(value)¶

Parameters:: value (float) –

Signal Details¶

Caribou.KeyModel.signals.key_hold(key_model)¶

Signal Name:: key-hold
Flags:: RUN_LAST
Parameters:: key_model (Caribou.KeyModel) – The object which received the signal

Caribou.KeyModel.signals.key_hold_end(key_model)¶

Signal Name:: key-hold-end
Flags:: RUN_LAST
Parameters:: key_model (Caribou.KeyModel) – The object which received the signal

Property Details¶

Caribou.KeyModel.props.align¶

Name:: align
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

align

Caribou.KeyModel.props.is_modifier¶

Name:: is-modifier
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE

is-modifier

Caribou.KeyModel.props.keyval¶

Name:: keyval
Type:: int
Default Value:: 0
Flags:: READABLE

keyval

Caribou.KeyModel.props.label¶

Name:: label
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

label

Caribou.KeyModel.props.name¶

Name:: name
Type:: str
Default Value:: None
Flags:: READABLE

name

Caribou.KeyModel.props.repeatable¶

Name:: repeatable
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE

repeatable

Caribou.KeyModel.props.show_subkeys¶

Name:: show-subkeys
Type:: bool
Default Value:: False
Flags:: READABLE

show-subkeys

Caribou.KeyModel.props.text¶

Name:: text
Type:: str
Default Value:: None
Flags:: READABLE

text

Caribou.KeyModel.props.toggle¶

Name:: toggle
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

toggle

Caribou.KeyModel.props.width¶

Name:: width
Type:: float
Default Value:: 1.0
Flags:: READABLE, WRITABLE

width