VolumeControl.Core.Input.HotkeyWithError Class Reference

A Hotkey that also maintains an error state property. More...

Inheritance diagram for VolumeControl.Core.Input.HotkeyWithError:

Collaboration diagram for VolumeControl.Core.Input.HotkeyWithError:

Public Member Functions
	HotkeyWithError (EFriendlyKey key, EModifierKey modifiers, bool isRegistered)
	Creates a new HotkeyWithError instance with the specified parameters. More...
	HotkeyWithError (string name, EFriendlyKey key, EModifierKey modifiers, bool isRegistered)
	Creates a new HotkeyWithError instance with the specified parameters. More...
	HotkeyWithError (EFriendlyKey key, EModifierKey modifiers, bool isRegistered, HotkeyActionInstance actionInstance)
	Creates a new HotkeyWithError instance with the specified parameters. More...
	HotkeyWithError (string name, EFriendlyKey key, EModifierKey modifiers, bool isRegistered, HotkeyActionInstance actionInstance)
	Creates a new HotkeyWithError instance with the specified parameters. More...
Public Member Functions inherited from VolumeControl.Core.Input.Hotkey
	Hotkey (string name, EFriendlyKey key, EModifierKey modifiers, bool isRegistered, HotkeyActionInstance actionInstance)
	Creates a new Hotkey instance with the specified parameters. More...
	Hotkey (string name, EFriendlyKey key, EModifierKey modifiers, bool isRegistered)
	Hotkey (EFriendlyKey key, EModifierKey modifiers, bool isRegistered, HotkeyActionInstance actionInstance)
	Hotkey (EFriendlyKey key, EModifierKey modifiers, bool isRegistered)
void	GetNewID ()
	Gets a new ID from the WindowsHotkeyAPI. More...
void	Dispose ()
	Cleans up the Hotkey instance by unregistering it, if necessary. More...

Properties
string?	ErrorMessage [get]
	Gets the last error message that occurred relating to this hotkey instance. More...
bool	HasError [get]
	Gets whether More...
Properties inherited from VolumeControl.Core.Input.Hotkey
ushort	ID [get]
string	Name [get, set]
EFriendlyKey	Key [get, set]
EModifierKey	Modifiers [get, set]
bool	Alt [get, set]
bool	Shift [get, set]
bool	Ctrl [get, set]
bool	Win [get, set]
bool	NoRepeat [get, set]
HwndSourceHook	MessageHook [get]
bool	IsRegistered [get, set]
HotkeyActionInstance?	Action [get, set]
Properties inherited from VolumeControl.Core.Input.IHotkey
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...

Additional Inherited Members
Protected Member Functions inherited from VolumeControl.Core.Input.Hotkey
void	NotifyPropertyChanged ([CallerMemberName] string propertyName="")
	Triggers the PropertyChanged event. More...
virtual bool	RegisterHotkey ()
	Registers the hotkey with the Windows API. More...
virtual bool	UnregisterHotkey ()
	Unregisters the hotkey with the Windows API. More...
Events inherited from VolumeControl.Core.Input.Hotkey
HotkeyPressedEventHandler?	Pressed
	Occurs when the hotkey was pressed, after the Action has been triggered. More...
PropertyChangedEventHandler?	PropertyChanged
HotkeyRegisteringEventHandler?	Registering
EventHandler?	Registered
HotkeyRegisteringEventHandler?	Unregistering
EventHandler?	Unregistered
Events inherited from VolumeControl.Core.Input.IHotkey
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

A Hotkey that also maintains an error state property.

Constructor & Destructor Documentation

HotkeyWithError() [1/4]

VolumeControl.Core.Input.HotkeyWithError.HotkeyWithError	(	EFriendlyKey	key,
		EModifierKey	modifiers,
		bool	isRegistered
	)

Creates a new HotkeyWithError instance with the specified parameters.

HotkeyWithError() [2/4]

VolumeControl.Core.Input.HotkeyWithError.HotkeyWithError	(	string	name,
		EFriendlyKey	key,
		EModifierKey	modifiers,
		bool	isRegistered
	)

Creates a new HotkeyWithError instance with the specified parameters.

HotkeyWithError() [3/4]

VolumeControl.Core.Input.HotkeyWithError.HotkeyWithError	(	EFriendlyKey	key,
		EModifierKey	modifiers,
		bool	isRegistered,
		HotkeyActionInstance	actionInstance
	)

Creates a new HotkeyWithError instance with the specified parameters.

HotkeyWithError() [4/4]

VolumeControl.Core.Input.HotkeyWithError.HotkeyWithError	(	string	name,
		EFriendlyKey	key,
		EModifierKey	modifiers,
		bool	isRegistered,
		HotkeyActionInstance	actionInstance
	)

Creates a new HotkeyWithError instance with the specified parameters.

Property Documentation

ErrorMessage

string? VolumeControl.Core.Input.HotkeyWithError.ErrorMessage

get

Gets the last error message that occurred relating to this hotkey instance.

HasError

bool VolumeControl.Core.Input.HotkeyWithError.HasError

get

Gets whether

---

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

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