Caribou.Scanner¶

Subclasses:: None

Methods¶

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

class	`new` ()
	`get_autorestart` ()
	`get_bind_settings` ()
	`get_inverse_scanning` ()
	`get_keyboard_key` ()
	`get_mouse_button` ()
	`get_scan_cycles` ()
	`get_scan_enabled` ()
	`get_scan_grouping` ()
	`get_step_time` ()
	`get_switch_device` ()
	`reset` ()
	`set_autorestart` (value)
	`set_inverse_scanning` (value)
	`set_keyboard` (keyboard)
	`set_keyboard_key` (value)
	`set_mouse_button` (value)
	`set_scan_cycles` (value)
	`set_scan_enabled` (value)
	`set_scan_grouping` (value)
	`set_step_time` (value)
	`set_switch_device` (value)

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

Name	Type	Flags	Short Description
`autorestart`	`bool`	r/w/c	autorestart
`bind-settings`	`bool`	r/w/co	bind-settings
`inverse-scanning`	`bool`	r/w/c	inverse-scanning
`keyboard-key`	`str`	r/w/c	keyboard-key
`mouse-button`	`int`	r/w/c	mouse-button
`scan-cycles`	`int`	r/w/c	scan-cycles
`scan-enabled`	`bool`	r/w/c	scan-enabled
`scan-grouping`	`int`	r/w/c	scan-grouping
`step-time`	`float`	r/w/c	step-time
`switch-device`	`str`	r/w/c	switch-device

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent_instance	`GObject.Object`	r

Class Details¶

class Caribou.Scanner(**kwargs)¶

Bases:: GObject.Object
Abstract:: No
Structure:: Caribou.ScannerClass

classmethod new()¶

Return type:: Caribou.Scanner

get_autorestart()¶

Return type:: bool

get_bind_settings()¶

Return type:: bool

get_inverse_scanning()¶

Return type:: bool

get_keyboard_key()¶

Return type:: str

get_mouse_button()¶

Return type:: int

get_scan_cycles()¶

Return type:: int

get_scan_enabled()¶

Return type:: bool

get_scan_grouping()¶

Return type:: int

get_step_time()¶

Return type:: float

get_switch_device()¶

Return type:: str

reset()¶

set_autorestart(value)¶

Parameters:: value (bool) –

set_inverse_scanning(value)¶

Parameters:: value (bool) –

set_keyboard(keyboard)¶

Parameters:: keyboard (Caribou.KeyboardModel) –

set_keyboard_key(value)¶

Parameters:: value (str) –

set_mouse_button(value)¶

Parameters:: value (int) –

set_scan_cycles(value)¶

Parameters:: value (int) –

set_scan_enabled(value)¶

Parameters:: value (bool) –

set_scan_grouping(value)¶

Parameters:: value (int) –

set_step_time(value)¶

Parameters:: value (float) –

set_switch_device(value)¶

Parameters:: value (str) –

Property Details¶

Caribou.Scanner.props.autorestart¶

Name:: autorestart
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE, CONSTRUCT

autorestart

Caribou.Scanner.props.bind_settings¶

Name:: bind-settings
Type:: bool
Default Value:: True
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

bind-settings

Caribou.Scanner.props.inverse_scanning¶

Name:: inverse-scanning
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE, CONSTRUCT

inverse-scanning

Caribou.Scanner.props.keyboard_key¶

Name:: keyboard-key
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT

keyboard-key

Caribou.Scanner.props.mouse_button¶

Name:: mouse-button
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE, CONSTRUCT

mouse-button

Caribou.Scanner.props.scan_cycles¶

Name:: scan-cycles
Type:: int
Default Value:: 1
Flags:: READABLE, WRITABLE, CONSTRUCT

scan-cycles

Caribou.Scanner.props.scan_enabled¶

Name:: scan-enabled
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE, CONSTRUCT

scan-enabled

Caribou.Scanner.props.scan_grouping¶

Name:: scan-grouping
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE, CONSTRUCT

scan-grouping

Caribou.Scanner.props.step_time¶

Name:: step-time
Type:: float
Default Value:: 0.0
Flags:: READABLE, WRITABLE, CONSTRUCT

step-time

Caribou.Scanner.props.switch_device¶

Name:: switch-device
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT

switch-device