plectrum.control¶

class plectrum.control.AbstractSelectControl(items)[source]¶

Bases: prompt_toolkit.layout.controls.TokenListControl

Manage selection of items.

__init__(items)[source]¶: Initialise control with items to select from.

items¶: Return items.

Note

Return copy to avoid indirect mutation.

next_item()[source]¶: Move indicator to next item.

previous_item()[source]¶: Move indicator to previous item.

class plectrum.control.SingleSelectControl(items)[source]¶

Bases: plectrum.control.AbstractSelectControl

Manage selection of single item.

__init__(items)[source]¶: Initialise control with items to select from.

select_current_item()[source]¶: Select current item, replacing any existing selection.

next_item()[source]¶: Move indicator to next item and select it.

previous_item()[source]¶: Move indicator to previous item and select it.

class plectrum.control.MultiSelectControl(items)[source]¶

Bases: plectrum.control.AbstractSelectControl

Manage selection of multiple items.

toggle_current_item()[source]¶: Toggle selection of current item.