VolumeControl.Core.Input.Actions.Settings.IActionSettingInstance< T > Interface Template Reference

Represents an action setting instance. More...

Inheritance diagram for VolumeControl.Core.Input.Actions.Settings.IActionSettingInstance< T >:

Collaboration diagram for VolumeControl.Core.Input.Actions.Settings.IActionSettingInstance< T >:

Public Member Functions
void	Deconstruct (out bool isEnabled, out object? value)
	Deconstructs the action setting into a tuple that includes whether the setting is enabled or not, and its value. More...
void	Deconstruct (out bool isEnabled, out T? value)
	Deconstructs the action setting into a tuple that includes whether the setting is enabled or not, and its value. More...

Properties
ActionSettingDefinition	ActionSettingDefinition [get]
	Gets the definition object for this action setting instance. More...
string	Name [get]
	Gets the name of this action setting instance. More...
string?	Description [get]
	Gets the description of this action setting instance. More...
object?	Value [get, set]
	Gets or sets the value of this action setting instance. More...
Type	ValueType [get]
	Gets the value type of this action setting instance. More...
object?	DefaultValue [get]
	Gets the default value of this action setting instance. More...
bool	IsToggleable [get]
	Gets whether this action setting instance can be toggled on/off. More...
bool	IsEnabled [get, set]
	Gets or sets whether this action setting instance is enabled. More...
T?	Value [get, set]
	Gets or sets the value of this action setting instance. More...
T?	DefaultValue [get]
	Gets the default value of this action setting instance. More...

Detailed Description

Represents an action setting instance.

Represents a strongly-typed action setting instance.

Template Parameters

T	The value type of this action setting.

Member Function Documentation

Deconstruct() [1/2]

void VolumeControl.Core.Input.Actions.Settings.IActionSettingInstance< T >.Deconstruct	(	out bool	isEnabled,
		out object?	value
	)

Deconstructs the action setting into a tuple that includes whether the setting is enabled or not, and its value.

Parameters

isEnabled	true when the setting is enabled (or isn't toggleable); otherwise false.
value	The value of the setting.

Deconstruct() [2/2]

void VolumeControl.Core.Input.Actions.Settings.IActionSettingInstance< T >.Deconstruct	(	out bool	isEnabled,
		out T?	value
	)

Deconstructs the action setting into a tuple that includes whether the setting is enabled or not, and its value.

Parameters

isEnabled	true when the setting is enabled (or isn't toggleable); otherwise false.
value	The value of the setting.

Implemented in VolumeControl.Core.Input.Actions.Settings.ActionSettingInstance< T >.

Property Documentation

ActionSettingDefinition

ActionSettingDefinition VolumeControl.Core.Input.Actions.Settings.IActionSettingInstance< T >.ActionSettingDefinition

get

Gets the definition object for this action setting instance.

DefaultValue [1/2]

object? VolumeControl.Core.Input.Actions.Settings.IActionSettingInstance< T >.DefaultValue

get

Gets the default value of this action setting instance.

DefaultValue [2/2]

T? VolumeControl.Core.Input.Actions.Settings.IActionSettingInstance< T >.DefaultValue

get

Gets the default value of this action setting instance.

Description

string VolumeControl.Core.Input.Actions.Settings.IActionSettingInstance< T >.Description

get

Gets the description of this action setting instance.

IsEnabled

bool VolumeControl.Core.Input.Actions.Settings.IActionSettingInstance< T >.IsEnabled

getset

Gets or sets whether this action setting instance is enabled.

When IsToggleable is false, this always returns true and cannot be changed.

Returns

true when enabled or not toggleable; false when disabled.

Returns

true when enabled; false when disabled; null when IsToggleable is false.

IsToggleable

bool VolumeControl.Core.Input.Actions.Settings.IActionSettingInstance< T >.IsToggleable

get

Gets whether this action setting instance can be toggled on/off.

Name

string VolumeControl.Core.Input.Actions.Settings.IActionSettingInstance< T >.Name

get

Gets the name of this action setting instance.

Value [1/2]

object? VolumeControl.Core.Input.Actions.Settings.IActionSettingInstance< T >.Value

getset

Gets or sets the value of this action setting instance.

Value [2/2]

T? VolumeControl.Core.Input.Actions.Settings.IActionSettingInstance< T >.Value

getset

Gets or sets the value of this action setting instance.

ValueType

Type VolumeControl.Core.Input.Actions.Settings.IActionSettingInstance< T >.ValueType

get

Gets the value type of this action setting instance.

---

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

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