Interface Driver

Drivers are modular expansions to Roots. Drivers can be registered to multiple roots at the same time and contain hooks which are called by registered roots.

Drivers are commonly used to provide input to roots, but they could be used to provide other functionality.

interface Driver {
    onDisable(root: Root): void;
    onEnable(root: Root): void;
    onFocusCapturerChanged(root: Root, focusType: FocusType, oldCapturer: null | Widget, newCapturer: null | Widget): void;
    onFocusChanged(root: Root, focusType: FocusType, newFocus: null | Widget): void;
    update(root: Root): void;
}

Implemented by

Index

Methods

onDisable onEnable onFocusCapturerChanged onFocusChanged update

Methods

onDisable

onDisable(root): void
Hook called when driver is unregistered from an enabled root or when a root that this driver is registered to is disabled.
Parameters
- root: Root
Returns void
- Defined in src/core/Driver.ts:26

onEnable

onEnable(root): void
Hook called when driver is registered to an enabled root or when a root that this driver is registered to is enabled.
Parameters
- root: Root
Returns void
- Defined in src/core/Driver.ts:21

onFocusCapturerChanged

onFocusCapturerChanged(root, focusType, oldCapturer, newCapturer): void
Hook called by Root#dispatchEvent
Parameters
- root: Root
- focusType: FocusType
- oldCapturer: null | Widget
- newCapturer: null | Widget
Returns void
- Defined in src/core/Driver.ts:30

onFocusChanged

onFocusChanged(root, focusType, newFocus): void
Hook called by Root#requestFocus and Root#clearFocus
Parameters
- root: Root
- focusType: FocusType
- newFocus: null | Widget
Returns void
- Defined in src/core/Driver.ts:28

update

update(root): void
Hook called by Root#preLayoutUpdate
Parameters
- root: Root
Returns void
- Defined in src/core/Driver.ts:16