Caribou.IScannableGroup¶

Implementations:: Caribou.ScannableGroup

Methods¶

	`child_select` ()
	`child_step` (cycles)
	`get_scan_children` ()
	`get_scan_grouping` ()
	`get_selected_path` ()
	`get_step_path` ()
	`scan_reset` ()
	`set_scan_grouping` (value)

Virtual Methods¶

	`do_child_select` ()
	`do_child_step` (cycles)
	`do_get_scan_children` ()
	`do_get_scan_grouping` ()
	`do_get_selected_path` ()
	`do_get_step_path` ()
	`do_scan_reset` ()
	`do_set_scan_grouping` (value)

Properties¶

Name	Type	Flags	Short Description
`scan-grouping`	`Caribou.ScanGrouping`	r/w	scan-grouping

Signals¶

Name	Short Description
`scan-cleared`
`selected-item-changed`
`step-item-changed`

Fields¶

None

Class Details¶

class Caribou.IScannableGroup¶

Bases:: GObject.GInterface
Structure:: Caribou.IScannableGroupIface

child_select()¶

Return type:: Caribou.IScannableItem or None

child_step(cycles)¶

Parameters:: cycles (int) –
Return type:: Caribou.IScannableItem or None

get_scan_children()¶

Return type:: [Caribou.IScannableItem]

get_scan_grouping()¶

Return type:: Caribou.ScanGrouping

get_selected_path()¶

Return type:: [Caribou.IScannableItem]

get_step_path()¶

Return type:: [Caribou.IScannableItem]

scan_reset()¶

set_scan_grouping(value)¶

Parameters:: value (Caribou.ScanGrouping) –

do_child_select() virtual¶

Return type:: Caribou.IScannableItem or None

do_child_step(cycles) virtual¶

Parameters:: cycles (int) –
Return type:: Caribou.IScannableItem or None

do_get_scan_children() virtual¶

Return type:: [Caribou.IScannableItem]

do_get_scan_grouping() virtual¶

Return type:: Caribou.ScanGrouping

do_get_selected_path() virtual¶

Return type:: [Caribou.IScannableItem]

do_get_step_path() virtual¶

Return type:: [Caribou.IScannableItem]

do_scan_reset() virtual¶

do_set_scan_grouping(value) virtual¶

Parameters:: value (Caribou.ScanGrouping) –

Signal Details¶

Caribou.IScannableGroup.signals.scan_cleared(i_scannable_group)¶

Signal Name:: scan-cleared
Flags:: RUN_LAST
Parameters:: i_scannable_group (Caribou.IScannableGroup) – The object which received the signal

Caribou.IScannableGroup.signals.selected_item_changed(i_scannable_group, selected_item)¶

Signal Name:

selected-item-changed

Flags:

RUN_LAST

Parameters:

i_scannable_group (Caribou.IScannableGroup) – The object which received the signal
selected_item (Caribou.IScannableItem or None) –

Caribou.IScannableGroup.signals.step_item_changed(i_scannable_group, step_item)¶

Signal Name:

step-item-changed

Flags:

RUN_LAST

Parameters:

i_scannable_group (Caribou.IScannableGroup) – The object which received the signal
step_item (Caribou.IScannableItem or None) –

Property Details¶

Caribou.IScannableGroup.props.scan_grouping¶

Name:: scan-grouping
Type:: Caribou.ScanGrouping
Default Value:: Caribou.ScanGrouping.NONE
Flags:: READABLE, WRITABLE

scan-grouping