HotkeysService | tabby-core

Hierarchy

HotkeysService

Constructors

Private constructor

new HotkeysService(zone: NgZone, config: ConfigService, hotkeyProviders: HotkeyProvider[], hostApp: HostAppService): HotkeysService

- Defined in tabby-core/src/services/hotkeys.service.ts:82
Parameters
- zone: NgZone
- config: ConfigService
- hotkeyProviders: HotkeyProvider[]
- hostApp: HostAppService
Returns HotkeysService

Properties

Private _hotkey

_hotkey: Subject<string> = ...

Private _hotkeyOff

_hotkeyOff: Subject<string> = ...

Private _key

_key: Subject<string> = ...

Private _keyEvent

_keyEvent: Subject<MouseEvent | KeyboardEvent | WheelEvent> = ...

Private _keystroke

_keystroke: Subject<string> = ...

Private disabledLevel

disabledLevel: number = 0

Private hotkeyDescriptions

hotkeyDescriptions: IHotkeyDescription[] = []

Private lastEventTimestamp

lastEventTimestamp: number = 0

Private lastKeystrokes

lastKeystrokes: PastKeystroke[] = []

Private lastWheelTimestamp

lastWheelTimestamp: null | number = null

Private pressedHotkey

pressedHotkey: null | string = null

Private pressedKeyTimestamps

pressedKeyTimestamps: Map<string, number> = ...

Private pressedKeys

pressedKeys: Set<string> = ...

Private pressedKeystroke

pressedKeystroke: null | string = null

Private recognitionPhase

recognitionPhase: boolean = true

Private suppressNextKeyupKeystroke

suppressNextKeyupKeystroke: boolean = false

Accessors

hotkey$

get hotkey$(): Observable<string>

- Defined in tabby-core/src/services/hotkeys.service.ts:38
Fired for each recognized hotkey

Returns Observable<string>

hotkeyOff$

get hotkeyOff$(): Observable<string>

- Defined in tabby-core/src/services/hotkeys.service.ts:47
Fired for once hotkey is released

Returns Observable<string>

key$

get key$(): Observable<string>

- Defined in tabby-core/src/services/hotkeys.service.ts:52
Fired for each singular key

Returns Observable<string>

keyEvent$

get keyEvent$(): Observable<MouseEvent | KeyboardEvent | WheelEvent>

- Defined in tabby-core/src/services/hotkeys.service.ts:57
Fired for each key event

Returns Observable<MouseEvent | KeyboardEvent | WheelEvent>

keystroke$

get keystroke$(): Observable<string>

- Defined in tabby-core/src/services/hotkeys.service.ts:62
Fired for each singular key combination

Returns Observable<string>

unfilteredHotkey$

get unfilteredHotkey$(): Observable<string>

- Defined in tabby-core/src/services/hotkeys.service.ts:33
Fired for each recognized hotkey

Returns Observable<string>

Methods

Private addPressedKey

addPressedKey(keyName: string, eventData: KeyEventData): void

- Defined in tabby-core/src/services/hotkeys.service.ts:400
Parameters
- keyName: string
- eventData: KeyEventData
Returns void

clearCurrentKeystrokes

clearCurrentKeystrokes(): void

- Defined in tabby-core/src/services/hotkeys.service.ts:304
Returns void

disable

disable(): void

- Defined in tabby-core/src/services/hotkeys.service.ts:320
Returns void

Private emitHotkeyOff

emitHotkeyOff(hotkey: string): void

- Defined in tabby-core/src/services/hotkeys.service.ts:365
Parameters
- hotkey: string
Returns void

Private emitHotkeyOn

emitHotkeyOn(hotkey: string): void

- Defined in tabby-core/src/services/hotkeys.service.ts:353
Parameters
- hotkey: string
Returns void

enable

enable(): void

- Defined in tabby-core/src/services/hotkeys.service.ts:316
Returns void

getCurrentKeystrokes

getCurrentKeystrokes(): string[]

- Defined in tabby-core/src/services/hotkeys.service.ts:244
Returns string[]

getHotkeyDescription

getHotkeyDescription(id: string): IHotkeyDescription

- Defined in tabby-core/src/services/hotkeys.service.ts:312
Parameters
- id: string
Returns IHotkeyDescription

getHotkeyDescriptions

getHotkeyDescriptions(): Promise<IHotkeyDescription[]>

- Defined in tabby-core/src/services/hotkeys.service.ts:328
Returns Promise<IHotkeyDescription[]>

Private getHotkeysConfig

getHotkeysConfig(): {}

- Defined in tabby-core/src/services/hotkeys.service.ts:371
Returns {}

Private getHotkeysConfigRecursive

getHotkeysConfigRecursive(branch: any): {}

- Defined in tabby-core/src/services/hotkeys.service.ts:375
Parameters
- branch: any
Returns {}

isEnabled

isEnabled(): boolean

- Defined in tabby-core/src/services/hotkeys.service.ts:324
Returns boolean

matchActiveHotkey

matchActiveHotkey(partial?: boolean): null | string

- Defined in tabby-core/src/services/hotkeys.service.ts:251
Parameters
- partial: boolean = false
Returns null | string

pushKeyEvent

pushKeyEvent(eventName: string, nativeEvent: MouseEvent | KeyboardEvent | WheelEvent): void

- Defined in tabby-core/src/services/hotkeys.service.ts:129
Adds a new key event to the buffer

Parameters
- eventName: string
  
  DOM event name
- nativeEvent: MouseEvent | KeyboardEvent | WheelEvent
  
  event object
Returns void

Private removePressedKey

removePressedKey(key: string): void

- Defined in tabby-core/src/services/hotkeys.service.ts:405
Parameters
- key: string
Returns void

Private updateModifiers

updateModifiers(event: KeyEventData): void

- Defined in tabby-core/src/services/hotkeys.service.ts:337
Parameters
- event: KeyEventData
Returns void

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

Private constructor

Parameters

zone: NgZone

config: ConfigService

hotkeyProviders: HotkeyProvider[]

hostApp: HostAppService

Returns HotkeysService

Properties

Private _hotkey

Private _hotkeyOff

Private _key

Private _keyEvent

Private _keystroke

Private disabledLevel

Private hotkeyDescriptions

Private lastEventTimestamp

Private lastKeystrokes

Private lastWheelTimestamp

Private pressedHotkey

Private pressedKeyTimestamps

Private pressedKeys

Private pressedKeystroke

Private recognitionPhase

Private suppressNextKeyupKeystroke

Accessors

hotkey$

Returns Observable<string>

hotkeyOff$

Returns Observable<string>

key$

Returns Observable<string>

keyEvent$

Returns Observable<MouseEvent | KeyboardEvent | WheelEvent>

keystroke$

Returns Observable<string>

unfilteredHotkey$

Returns Observable<string>

Methods

Private addPressedKey

Parameters

keyName: string

eventData: KeyEventData

Returns void

clearCurrentKeystrokes

Returns void

disable

Returns void

Private emitHotkeyOff

Parameters

hotkey: string

Returns void

Private emitHotkeyOn

Parameters

hotkey: string

Returns void

enable

Returns void

getCurrentKeystrokes

Returns string[]

getHotkeyDescription

Parameters

id: string

Returns IHotkeyDescription

getHotkeyDescriptions

Returns Promise<IHotkeyDescription[]>

Private getHotkeysConfig

Returns {}

Private getHotkeysConfigRecursive

Parameters

branch: any

Returns {}

isEnabled

Returns boolean