Class WidgetListSettingsUiBuilder

An implementation of ISettingsUiBuilder that uses a WidgetBuilder under-the-hood.

Inheritance

object

WidgetListSettingsUiBuilder

Implements

ISettingsUiBuilder

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: SociallyDistant.Core.UI.Recycling.SettingsWidgets

Assembly: SociallyDistant.Framework.dll

Syntax

public sealed class WidgetListSettingsUiBuilder : ISettingsUiBuilder

Constructors

WidgetListSettingsUiBuilder(WidgetBuilder)

Creates a new instance of the WidgetListSettingsUiBuilder class.

Declaration

public WidgetListSettingsUiBuilder(WidgetBuilder builder)

Parameters

Type	Name	Description
WidgetBuilder	builder	A WidgetBuilder instance to render widgets to.

Methods

AddSection(string, out int)

Creates a new labeled section to categorize fields under.

Declaration

public ISettingsUiBuilder AddSection(string sectionTitle, out int sectionId)

Parameters

Type	Name	Description
string	sectionTitle	The name of the section as shown in the UI
int	sectionId	A unique identifier representing the section

Returns

Type	Description
ISettingsUiBuilder

WithAction(string, string, Action, int)

Declaration

public ISettingsUiBuilder WithAction(string title, string description, Action clickCallback, int sectionId)

Parameters

Type	Name	Description
string	title
string	description
Action	clickCallback
int	sectionId

Returns

Type	Description
ISettingsUiBuilder

WithLabel(string, int)

Declaration

public ISettingsUiBuilder WithLabel(string labelText, int sectionId)

Parameters

Type	Name	Description
string	labelText
int	sectionId

Returns

Type	Description
ISettingsUiBuilder

WithSlider(string, string?, int, int, int, Action<int>, int)

Declaration

public ISettingsUiBuilder WithSlider(string title, string? description, int value, int minimum, int maximum, Action<int> changeCallback, int sectionId)

Parameters

Type	Name	Description
string	title
string	description
int	value
int	minimum
int	maximum
Action<int>	changeCallback
int	sectionId

Returns

Type	Description
ISettingsUiBuilder

WithSlider(string, string?, float, float, float, Action<float>, int)

Declaration

public ISettingsUiBuilder WithSlider(string title, string? description, float value, float minimum, float maximum, Action<float> changeCallback, int sectionId)

Parameters

Type	Name	Description
string	title
string	description
float	value
float	minimum
float	maximum
Action<float>	changeCallback
int	sectionId

Returns

Type	Description
ISettingsUiBuilder

WithStringDropdown(string, string?, int, string[], Action<int>, int)

Declaration

public ISettingsUiBuilder WithStringDropdown(string title, string? description, int currentIndex, string[] choices, Action<int> changeCallback, int sectionId)

Parameters

Type	Name	Description
string	title
string	description
int	currentIndex
string[]	choices
Action<int>	changeCallback
int	sectionId

Returns

Type	Description
ISettingsUiBuilder

WithTextField(string, string?, string?, Action<string?>, int)

Declaration

public ISettingsUiBuilder WithTextField(string title, string? description, string? currentValue, Action<string?> changeCallback, int sectionId)

Parameters

Type	Name	Description
string	title
string	description
string	currentValue
Action<string>	changeCallback
int	sectionId

Returns

Type	Description
ISettingsUiBuilder

WithToggle(string, string?, bool, Action<bool>, int, bool, string?)

Declaration

public ISettingsUiBuilder WithToggle(string title, string? description, bool value, Action<bool> changeCallback, int sectionId, bool requireConfirmation, string? confirmationMessage = null)

Parameters

Type	Name	Description
string	title
string	description
bool	value
Action<bool>	changeCallback
int	sectionId
bool	requireConfirmation
string	confirmationMessage

Returns

Type	Description
ISettingsUiBuilder

Implements

ISettingsUiBuilder