Volume Control
Application-specific hotkeys for Windows
VolumeControl.Core.Input.Actions.HotkeyActionManager Class Reference

Manages a list of HotkeyActionDefinitions. More...

Collaboration diagram for VolumeControl.Core.Input.Actions.HotkeyActionManager:

Public Member Functions

 HotkeyActionManager ()
 Creates a new HotkeyActionManager instance. More...
 
HotkeyActionDefinitionFindActionDefinition (string identifier, StringComparison stringComparison=StringComparison.Ordinal)
 Gets the hotkey action definition with the specified identifier . More...
 
void AddActionDefinition (HotkeyActionDefinition actionDefinition)
 Adds the specified actionDefinition to the manager. More...
 
void RemoveActionDefinition (HotkeyActionDefinition actionDefinition)
 Removes the specified actionDefinition from the manager. More...
 
void AddActionDefinitions (params HotkeyActionDefinition[] actionDefinitions)
 Adds the specified actionDefinitions to the manager. More...
 

Properties

IReadOnlyList< HotkeyActionDefinitionActionDefinitions [get]
 Gets the list of currently-loaded HotkeyActionDefinition objects. More...
 

Events

EventHandler< HotkeyActionDefinition >? AddedActionDefinition
 Occurs when an action definition is added to the list for any reason. More...
 
EventHandler< HotkeyActionDefinition >? RemovedActionDefinition
 Occurs when an action definition is removed from the list for any reason. More...
 

Detailed Description

Manages a list of HotkeyActionDefinitions.

Constructor & Destructor Documentation

◆ HotkeyActionManager()

VolumeControl.Core.Input.Actions.HotkeyActionManager.HotkeyActionManager ( )

Creates a new HotkeyActionManager instance.

Member Function Documentation

◆ AddActionDefinition()

void VolumeControl.Core.Input.Actions.HotkeyActionManager.AddActionDefinition ( HotkeyActionDefinition  actionDefinition)

Adds the specified actionDefinition to the manager.

Parameters
actionDefinitionA HotkeyActionDefinition instance to add to the list.
Exceptions
InvalidOperationExceptionThe specified actionDefinition is already in the list.

References VolumeControl.Core.Input.Actions.HotkeyActionManager.ActionDefinitions.

Referenced by VolumeControl.Core.Input.Actions.HotkeyActionManager.AddActionDefinitions().

Here is the caller graph for this function:

◆ AddActionDefinitions()

void VolumeControl.Core.Input.Actions.HotkeyActionManager.AddActionDefinitions ( params HotkeyActionDefinition[]  actionDefinitions)

Adds the specified actionDefinitions to the manager.

Parameters
actionDefinitionsAny number of HotkeyActionDefinition instances to add to the list.

References VolumeControl.Core.Input.Actions.HotkeyActionManager.AddActionDefinition().

Here is the call graph for this function:

◆ FindActionDefinition()

HotkeyActionDefinition? VolumeControl.Core.Input.Actions.HotkeyActionManager.FindActionDefinition ( string  identifier,
StringComparison  stringComparison = StringComparison.Ordinal 
)

Gets the hotkey action definition with the specified identifier .

Parameters
identifierThe identifier string associated with the action definition to get.
stringComparisonThe comparison type to use for string comparisons.
Returns
The HotkeyActionDefinition instance with the specified identifier if found; otherwise null.

Referenced by VolumeControl.Core.Input.Json.JsonHotkey.CreateInstance< THotkey >().

Here is the caller graph for this function:

◆ RemoveActionDefinition()

void VolumeControl.Core.Input.Actions.HotkeyActionManager.RemoveActionDefinition ( HotkeyActionDefinition  actionDefinition)

Removes the specified actionDefinition from the manager.

Parameters
actionDefinitionA HotkeyActionDefinition instance to remove from the list.
Exceptions
InvalidOperationExceptionThe specified actionDefinition is not in the list.

References VolumeControl.Core.Input.Actions.HotkeyActionManager.ActionDefinitions.

Property Documentation

◆ ActionDefinitions

IReadOnlyList<HotkeyActionDefinition> VolumeControl.Core.Input.Actions.HotkeyActionManager.ActionDefinitions
get

Event Documentation

◆ AddedActionDefinition

EventHandler<HotkeyActionDefinition>? VolumeControl.Core.Input.Actions.HotkeyActionManager.AddedActionDefinition

Occurs when an action definition is added to the list for any reason.

◆ RemovedActionDefinition

EventHandler<HotkeyActionDefinition>? VolumeControl.Core.Input.Actions.HotkeyActionManager.RemovedActionDefinition

Occurs when an action definition is removed from the list for any reason.


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