Defines an action setting, and provides methods for creating action setting instances. More...

Collaboration diagram for VolumeControl.Core.Input.Actions.Settings.ActionSettingDefinition:

Public Member Functions
IActionSettingInstance	CreateInstance ()
	Creates a new ActionSettingInstance<T> instance from this ActionSettingDefinition. More...

IActionSettingInstance	CreateInstance (bool? enabled, object? value)
	Creates a new ActionSettingInstance<T> instance from this ActionSettingDefinition and the specified value . More...

Properties
string	Name `[get]`
	Gets the name of the action setting. More...

string?	Description `[get]`
	Gets the description string of the action setting. More...

Type	ValueType `[get]`
	Gets the type of value that the action setting contains. More...

object?	DefaultValue `[get]`
	Gets the default value of the action setting. More...

DataTemplate?	DataTemplate `[get]`
	Gets the WPF DataTemplate to use for displaying the value editor control in the GUI. More...

bool	IsToggleable `[get]`
	Gets whether the action setting can be toggled on/off. More...

bool	StartsEnabled `[get]`
	Gets whether the action setting is enabled by default or not. More...

Detailed Description

Defines an action setting, and provides methods for creating action setting instances.

This class is created automatically when a hotkey action addon method is marked with HotkeyActionSettingAttribute.

Member Function Documentation

◆ CreateInstance() [1/2]

IActionSettingInstance VolumeControl.Core.Input.Actions.Settings.ActionSettingDefinition.CreateInstance ( )

Creates a new ActionSettingInstance<T> instance from this ActionSettingDefinition.

Returns: A new IActionSettingInstance instance.

References VolumeControl.Core.Input.Actions.Settings.ActionSettingDefinition.ValueType.

◆ CreateInstance() [2/2]

IActionSettingInstance VolumeControl.Core.Input.Actions.Settings.ActionSettingDefinition.CreateInstance	(	bool?	enabled,
		object?	value
	)

Creates a new ActionSettingInstance<T> instance from this ActionSettingDefinition and the specified value .

Parameters

enabled	Whether the action setting instance should start enabled. This does not have any effect if the setting is not toggleable.
value	A default value for the action setting instance.

References VolumeControl.Core.Input.Actions.Settings.ActionSettingDefinition.ValueType.

Property Documentation

◆ DataTemplate

DataTemplate? VolumeControl.Core.Input.Actions.Settings.ActionSettingDefinition.DataTemplate

get

Gets the WPF DataTemplate to use for displaying the value editor control in the GUI.

◆ DefaultValue

object? VolumeControl.Core.Input.Actions.Settings.ActionSettingDefinition.DefaultValue

get

Gets the default value of the action setting.

◆ Description

string? VolumeControl.Core.Input.Actions.Settings.ActionSettingDefinition.Description

get

Gets the description string of the action setting.

◆ IsToggleable

bool VolumeControl.Core.Input.Actions.Settings.ActionSettingDefinition.IsToggleable

get

Gets whether the action setting can be toggled on/off.

◆ Name

string VolumeControl.Core.Input.Actions.Settings.ActionSettingDefinition.Name

get

Gets the name of the action setting.

◆ StartsEnabled

bool VolumeControl.Core.Input.Actions.Settings.ActionSettingDefinition.StartsEnabled

get

Gets whether the action setting is enabled by default or not.

Has no effect when IsToggleable is false.

◆ ValueType

Type VolumeControl.Core.Input.Actions.Settings.ActionSettingDefinition.ValueType

get

Gets the type of value that the action setting contains.

Referenced by VolumeControl.Core.Input.Actions.Settings.ActionSettingDefinition.CreateInstance().

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

/home/runner/work/volume-control/volume-control/VolumeControl.Core/Input/Actions/Settings/ActionSettingDefinition.cs

Public Member Functions

Properties