VolumeControl.Core.Input.IHotkey Interface Reference

Represents a Win32 global hotkey. More...

Inheritance diagram for VolumeControl.Core.Input.IHotkey:

Collaboration diagram for VolumeControl.Core.Input.IHotkey:

Properties
string	Name [get, set]
	Gets or sets the friendly name of this hotkey. More...
ushort	ID [get]
	Gets the ID number of this hotkey. More...
EFriendlyKey	Key [get, set]
	Gets or sets the main key for this hotkey. More...
EModifierKey	Modifiers [get, set]
	Gets or sets the modifier keys for this hotkey. More...
bool	Alt [get, set]
	Gets or sets whether the Alt modifier key is enabled. More...
bool	Shift [get, set]
	Gets or sets whether the Shift modifier key is enabled. More...
bool	Ctrl [get, set]
	Gets or sets whether the Ctrl modifier key is enabled. More...
bool	Win [get, set]
	Gets or sets whether the Win modifier key is enabled. More...
bool	NoRepeat [get, set]
	Gets or sets whether NoRepeat is enabled. More...
bool	IsRegistered [get, set]
	Gets or sets whether this hotkey is registered with the Win32 API. More...
HotkeyActionInstance?	Action [get, set]
	Gets or sets the action that this hotkey triggers when pressed. More...
Properties inherited from VolumeControl.Core.Input.IHotkeyMessageHook
HwndSourceHook	MessageHook [get]
	Gets the windows message hook method. More...

Events
HotkeyPressedEventHandler?	Pressed
	Occurs when the hotkey combination was pressed. More...
HotkeyRegisteringEventHandler?	Registering
	Occurs when the hotkey is about to be registered for any reason. More...
EventHandler?	Registered
	Occurs when the hotkey has been registered for any reason. More...
HotkeyRegisteringEventHandler?	Unregistering
	Occurs when the hotkey is about to be unregistered for any reason. More...
EventHandler?	Unregistered
	Occurs when the hotkey has been unregistered for any reason. More...

Detailed Description

Represents a Win32 global hotkey.

Property Documentation

Action

HotkeyActionInstance? VolumeControl.Core.Input.IHotkey.Action

getset

Gets or sets the action that this hotkey triggers when pressed.

Referenced by VolumeControl.Core.Input.Json.JsonHotkey.JsonHotkey().

Alt

bool VolumeControl.Core.Input.IHotkey.Alt

getset

Gets or sets whether the Alt modifier key is enabled.

Ctrl

bool VolumeControl.Core.Input.IHotkey.Ctrl

getset

Gets or sets whether the Ctrl modifier key is enabled.

ID

ushort VolumeControl.Core.Input.IHotkey.ID

get

Gets the ID number of this hotkey.

Referenced by VolumeControl.Core.Input.HotkeyMessageHookAbstractor.AddHotkey(), and VolumeControl.Core.Input.HotkeyMessageHookAbstractor.RemoveHotkey().

IsRegistered

bool VolumeControl.Core.Input.IHotkey.IsRegistered

getset

Gets or sets whether this hotkey is registered with the Win32 API.

Returns

true when the hotkey is enabled; otherwise false.

Referenced by VolumeControl.Core.Input.HotkeyMessageHookAbstractor.AddHotkey(), VolumeControl.Core.Input.Json.JsonHotkey.JsonHotkey(), and VolumeControl.Core.Input.HotkeyMessageHookAbstractor.RemoveHotkey().

Key

EFriendlyKey VolumeControl.Core.Input.IHotkey.Key

getset

Gets or sets the main key for this hotkey.

Referenced by VolumeControl.Core.Input.HotkeyMessageHookAbstractor.AddHotkey(), VolumeControl.Core.Input.HotkeyExtensions.GetStringRepresentation(), and VolumeControl.Core.Input.Json.JsonHotkey.JsonHotkey().

Modifiers

EModifierKey VolumeControl.Core.Input.IHotkey.Modifiers

getset

Gets or sets the modifier keys for this hotkey.

Referenced by VolumeControl.Core.Input.HotkeyMessageHookAbstractor.AddHotkey(), VolumeControl.Core.Input.HotkeyExtensions.GetStringRepresentation(), and VolumeControl.Core.Input.Json.JsonHotkey.JsonHotkey().

Name

string VolumeControl.Core.Input.IHotkey.Name

getset

Gets or sets the friendly name of this hotkey.

Referenced by VolumeControl.Core.Input.Json.JsonHotkey.JsonHotkey().

NoRepeat

bool VolumeControl.Core.Input.IHotkey.NoRepeat

getset

Gets or sets whether NoRepeat is enabled.

Shift

bool VolumeControl.Core.Input.IHotkey.Shift

getset

Gets or sets whether the Shift modifier key is enabled.

Win

bool VolumeControl.Core.Input.IHotkey.Win

getset

Gets or sets whether the Win modifier key is enabled.

Event Documentation

Pressed

HotkeyPressedEventHandler? VolumeControl.Core.Input.IHotkey.Pressed

Occurs when the hotkey combination was pressed.

Registered

EventHandler? VolumeControl.Core.Input.IHotkey.Registered

Occurs when the hotkey has been registered for any reason.

Registering

HotkeyRegisteringEventHandler? VolumeControl.Core.Input.IHotkey.Registering

Occurs when the hotkey is about to be registered for any reason.

Unregistered

EventHandler? VolumeControl.Core.Input.IHotkey.Unregistered

Occurs when the hotkey has been unregistered for any reason.

Referenced by VolumeControl.Core.Input.HotkeyMessageHookAbstractor.AddHotkey(), and VolumeControl.Core.Input.HotkeyMessageHookAbstractor.RemoveHotkey().

Unregistering

HotkeyRegisteringEventHandler? VolumeControl.Core.Input.IHotkey.Unregistering

Occurs when the hotkey is about to be unregistered for any reason.

Referenced by VolumeControl.Core.Input.HotkeyMessageHookAbstractor.AddHotkey(), and VolumeControl.Core.Input.HotkeyMessageHookAbstractor.RemoveHotkey().

---

The documentation for this interface was generated from the following file:

• /home/runner/work/volume-control/volume-control/VolumeControl.Core/Input/IHotkey.cs