1
0
mirror of https://github.com/ppy/osu.git synced 2024-12-22 22:23:01 +08:00
osu-lazer/osu.Game/Overlays/Settings/SettingsItem.cs

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

243 lines
8.1 KiB
C#
Raw Normal View History

// Copyright (c) ppy Pty Ltd <contact@ppy.sh>. Licensed under the MIT Licence.
// See the LICENCE file in the repository root for full licence text.
2018-04-13 17:19:50 +08:00
2022-06-17 15:37:17 +08:00
#nullable disable
using System;
using System.Collections.Generic;
using System.Linq;
using osu.Framework.Allocation;
2019-02-21 18:04:31 +08:00
using osu.Framework.Bindables;
using osu.Framework.Graphics;
using osu.Framework.Graphics.Containers;
using osu.Framework.Graphics.Cursor;
using osu.Framework.Graphics.Sprites;
using osu.Framework.Graphics.UserInterface;
using osu.Framework.Localisation;
using osu.Game.Configuration;
using osu.Game.Graphics;
using osu.Game.Graphics.Sprites;
2021-05-04 15:59:22 +08:00
using osu.Game.Graphics.Containers;
using osuTK;
2018-04-13 17:19:50 +08:00
namespace osu.Game.Overlays.Settings
{
public abstract class SettingsItem<T> : Container, IFilterable, ISettingsItem, IHasCurrentValue<T>, IHasTooltip
{
protected abstract Drawable CreateControl();
2018-04-13 17:19:50 +08:00
2017-05-04 22:32:27 +08:00
protected Drawable Control { get; }
2018-04-13 17:19:50 +08:00
/// <summary>
/// The source component if this <see cref="SettingsItem{T}"/> was created via <see cref="SettingSourceAttribute"/>.
/// </summary>
public object SettingSourceObject { get; internal set; }
public const string CLASSIC_DEFAULT_SEARCH_TERM = @"has-classic-default";
2017-05-04 22:32:27 +08:00
private IHasCurrentValue<T> controlWithCurrent => Control as IHasCurrentValue<T>;
2018-04-13 17:19:50 +08:00
protected override Container<Drawable> Content => FlowContent;
2018-04-13 17:19:50 +08:00
protected readonly FillFlowContainer FlowContent;
2018-04-13 17:19:50 +08:00
private SpriteText labelText;
2018-04-13 17:19:50 +08:00
private OsuTextFlowContainer noticeText;
2021-05-04 15:59:22 +08:00
public bool ShowsDefaultIndicator = true;
2021-10-19 03:01:43 +08:00
private readonly Container defaultValueIndicatorContainer;
2018-04-13 17:19:50 +08:00
public LocalisableString TooltipText { get; set; }
[Resolved]
private OsuColour colours { get; set; }
public virtual LocalisableString LabelText
{
get => labelText?.Text ?? string.Empty;
set
{
if (labelText == null)
{
// construct lazily for cases where the label is not needed (may be provided by the Control).
2021-10-19 03:01:43 +08:00
FlowContent.Insert(-1, labelText = new OsuSpriteText());
updateDisabled();
}
2018-04-13 17:19:50 +08:00
labelText.Text = value;
updateLayout();
}
}
2018-04-13 17:19:50 +08:00
2021-05-04 15:59:22 +08:00
/// <summary>
/// Clear any warning text.
2021-05-04 15:59:22 +08:00
/// </summary>
public void ClearNoticeText()
2021-05-04 15:59:22 +08:00
{
noticeText?.Expire();
noticeText = null;
}
/// <summary>
/// Set the text to be displayed at the bottom of this <see cref="SettingsItem{T}"/>.
/// Generally used to provide feedback to a user about a sub-optimal setting.
/// </summary>
/// <param name="text">The text to display.</param>
/// <param name="isWarning">Whether the text is in a warning state. Will decide how this is visually represented.</param>
public void SetNoticeText(LocalisableString text, bool isWarning = false)
{
ClearNoticeText();
// construct lazily for cases where the label is not needed (may be provided by the Control).
FlowContent.Add(noticeText = new LinkFlowContainer(cp => cp.Colour = isWarning ? colours.Yellow : colours.Green)
{
RelativeSizeAxes = Axes.X,
AutoSizeAxes = Axes.Y,
Margin = new MarginPadding { Bottom = 5 },
Text = text,
});
2021-05-04 15:59:22 +08:00
}
public virtual Bindable<T> Current
{
2019-12-06 16:10:06 +08:00
get => controlWithCurrent.Current;
set => controlWithCurrent.Current = value;
}
2018-04-13 17:19:50 +08:00
public virtual IEnumerable<LocalisableString> FilterTerms
{
get
{
var keywords = new List<LocalisableString>(Keywords?.Select(k => (LocalisableString)k) ?? Array.Empty<LocalisableString>())
{
LabelText
};
if (HasClassicDefault)
keywords.Add(CLASSIC_DEFAULT_SEARCH_TERM);
return keywords;
}
}
2019-11-21 00:27:34 +08:00
public IEnumerable<string> Keywords { get; set; }
2018-04-13 17:19:50 +08:00
private bool matchingFilter = true;
public bool MatchingFilter
{
get => matchingFilter;
set
{
bool wasPresent = IsPresent;
matchingFilter = value;
if (IsPresent != wasPresent)
Invalidate(Invalidation.Presence);
}
}
public override bool IsPresent => base.IsPresent && MatchingFilter;
2018-04-13 17:19:50 +08:00
2019-03-28 23:29:07 +08:00
public bool FilteringActive { get; set; }
public event Action SettingChanged;
private T classicDefault;
public bool HasClassicDefault { get; private set; }
/// <summary>
/// A "classic" default value for this setting.
/// </summary>
public T ClassicDefault
{
set
{
classicDefault = value;
HasClassicDefault = true;
}
}
public void ApplyClassicDefault()
{
if (!HasClassicDefault)
throw new InvalidOperationException($"Cannot apply a classic default to a setting which doesn't have one defined via {nameof(ClassicDefault)}.");
Current.Value = classicDefault;
}
public void ApplyDefault() => Current.SetDefault();
protected SettingsItem()
{
RelativeSizeAxes = Axes.X;
AutoSizeAxes = Axes.Y;
Padding = new MarginPadding { Right = SettingsPanel.CONTENT_MARGINS };
2018-04-13 17:19:50 +08:00
2021-10-19 03:01:43 +08:00
InternalChildren = new Drawable[]
{
2021-10-19 03:01:43 +08:00
defaultValueIndicatorContainer = new Container
{
2021-10-19 03:01:43 +08:00
Width = SettingsPanel.CONTENT_MARGINS,
},
2021-10-19 05:30:38 +08:00
new Container
{
2021-10-19 03:01:43 +08:00
RelativeSizeAxes = Axes.X,
AutoSizeAxes = Axes.Y,
Padding = new MarginPadding { Left = SettingsPanel.CONTENT_MARGINS },
2021-10-19 05:30:38 +08:00
Child = FlowContent = new FillFlowContainer
{
RelativeSizeAxes = Axes.X,
AutoSizeAxes = Axes.Y,
Spacing = new Vector2(0, 10),
Child = Control = CreateControl(),
}
}
};
2018-04-13 17:19:50 +08:00
// IMPORTANT: all bindable logic is in constructor intentionally to support "CreateSettingsControls" being used in a context it is
// never loaded, but requires bindable storage.
if (controlWithCurrent == null)
throw new ArgumentException(@$"Control created via {nameof(CreateControl)} must implement {nameof(IHasCurrentValue<T>)}");
2019-12-06 16:10:06 +08:00
controlWithCurrent.Current.ValueChanged += _ => SettingChanged?.Invoke();
controlWithCurrent.Current.DisabledChanged += _ => updateDisabled();
}
[BackgroundDependencyLoader]
private void load()
{
// intentionally done before LoadComplete to avoid overhead.
if (ShowsDefaultIndicator)
{
2021-10-19 03:01:43 +08:00
defaultValueIndicatorContainer.Add(new RestoreDefaultValueButton<T>
{
Current = controlWithCurrent.Current,
Anchor = Anchor.Centre,
Origin = Anchor.Centre
2021-10-19 03:01:43 +08:00
});
updateLayout();
}
}
2018-04-13 17:19:50 +08:00
private void updateLayout()
{
2021-10-19 03:01:43 +08:00
bool hasLabel = labelText != null && !string.IsNullOrEmpty(labelText.Text.ToString());
2021-10-19 03:01:43 +08:00
// if the settings item is providing a label, the default value indicator should be centred vertically to the left of the label.
// otherwise, it should be centred vertically to the left of the main control of the settings item.
defaultValueIndicatorContainer.Height = hasLabel ? labelText.DrawHeight : Control.DrawHeight;
}
private void updateDisabled()
{
if (labelText != null)
labelText.Alpha = controlWithCurrent.Current.Disabled ? 0.3f : 1;
}
}
}