Class SettingsEditor

Edits options for the settings window: changes are kept here, then applied to the running program or saved to the settings file, through an ISettingsStore.

Inheritance

object

SettingsEditor

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Uniform.Matrix.Hosting

Assembly: Uniform.Matrix.Hosting.dll

Syntax

public sealed class SettingsEditor

Constructors

SettingsEditor(ISettingsStore, IReadOnlyList<OptionInfo>)

Edit options stored in store.

Declaration

public SettingsEditor(ISettingsStore store, IReadOnlyList<OptionInfo> options)

Parameters

Type	Name	Description
ISettingsStore	store
IReadOnlyList<OptionInfo>	options

Properties

HasUnsavedChanges

Whether there are changes not saved to the settings file.

Declaration

public bool HasUnsavedChanges { get; }

Property Value

Type	Description
bool

Options

All options, in display order.

Declaration

public IReadOnlyList<OptionInfo> Options { get; }

Property Value

Type	Description
IReadOnlyList<OptionInfo>

SettingsPath

The settings file.

Declaration

public string SettingsPath { get; }

Property Value

Type	Description
string

Methods

Apply()

Apply edits to the running client; return the keys among them that need a restart.

Declaration

public IReadOnlyList<string> Apply()

Returns

Type	Description
IReadOnlyList<string>

DiscardEdits()

Discard edits that are not applied yet.

Declaration

public void DiscardEdits()

Export(string)

Write the current values that differ from the defaults to another file, e.g. to keep a copy; secrets are left out.

Declaration

public void Export(string path)

Parameters

Type	Name	Description
string	path

GetChange(OptionInfo)

Return whether option is edited or applied but not saved.

Declaration

public OptionChange GetChange(OptionInfo option)

Parameters

Type	Name	Description
OptionInfo	option

Returns

Type	Description
OptionChange

GetDisplayValue(OptionInfo)

Return the value as shown in the list: secrets hidden, unset as (not set).

Declaration

public string GetDisplayValue(OptionInfo option)

Parameters

Type	Name	Description
OptionInfo	option

Returns

Type	Description
string

GetSource(OptionInfo)

Return which layer sets the option, or edited for pending changes.

Declaration

public string GetSource(OptionInfo option)

Parameters

Type	Name	Description
OptionInfo	option

Returns

Type	Description
string

GetValue(OptionInfo)

Return the value shown for option: the edit, else the current value, else the default; null when unset.

Declaration

public string? GetValue(OptionInfo option)

Parameters

Type	Name	Description
OptionInfo	option

Returns

Type	Description
string

Load(string)

Load the known options of a settings file as edits; return how many were loaded.

Declaration

public int Load(string path)

Parameters

Type	Name	Description
string	path

Returns

Type	Description
int

Reset(OptionInfo)

Undo the latest unsaved step of option: discards an edit, else undo an applied change, else mark it for removal from the settings file on save, so the built-in default or appsettings.json applies.

Declaration

public OptionChange Reset(OptionInfo option)

Parameters

Type	Name	Description
OptionInfo	option

Returns

Type	Description
OptionChange	What was undone: Edited, Applied, or None for a reset to the default.

Save()

Save all edited and applied changes to the settings file, which also applies them; return the keys among them that need a restart.

Declaration

public IReadOnlyList<string> Save()

Returns

Type	Description
IReadOnlyList<string>

Set(OptionInfo, string)

Set option from text; return an error message when the text is not a valid value.

Declaration

public string? Set(OptionInfo option, string text)

Parameters

Type	Name	Description
OptionInfo	option
string	text

Returns

Type	Description
string