// Copyright (c) ppy Pty Ltd . Licensed under the MIT Licence. // See the LICENCE file in the repository root for full licence text. using System; using System.Collections.Generic; using osu.Framework.Allocation; 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; using osu.Game.Graphics.Containers; using osuTK; namespace osu.Game.Overlays.Settings { public abstract class SettingsItem : Container, IFilterable, ISettingsItem, IHasCurrentValue, IHasTooltip { protected abstract Drawable CreateControl(); protected Drawable Control { get; } /// /// The source component if this was created via . /// public object SettingSourceObject { get; internal set; } private IHasCurrentValue controlWithCurrent => Control as IHasCurrentValue; protected override Container Content => FlowContent; protected readonly FillFlowContainer FlowContent; private SpriteText labelText; private OsuTextFlowContainer warningText; public bool ShowsDefaultIndicator = true; private readonly Container defaultValueIndicatorContainer; 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). FlowContent.Insert(-1, labelText = new OsuSpriteText()); updateDisabled(); } labelText.Text = value; updateLayout(); } } /// /// Text to be displayed at the bottom of this . /// Generally used to recommend the user change their setting as the current one is considered sub-optimal. /// public LocalisableString? WarningText { set { bool hasValue = value != default; if (warningText == null) { if (!hasValue) return; // construct lazily for cases where the label is not needed (may be provided by the Control). FlowContent.Add(warningText = new SettingsNoticeText(colours) { Margin = new MarginPadding { Bottom = 5 } }); } warningText.Alpha = hasValue ? 1 : 0; warningText.Text = value ?? default; } } public virtual Bindable Current { get => controlWithCurrent.Current; set => controlWithCurrent.Current = value; } public virtual IEnumerable FilterTerms => Keywords == null ? new[] { LabelText.ToString() } : new List(Keywords) { LabelText.ToString() }.ToArray(); public IEnumerable Keywords { get; set; } public override bool IsPresent => base.IsPresent && MatchingFilter; public bool MatchingFilter { get; set; } = true; public bool FilteringActive { get; set; } public event Action SettingChanged; protected SettingsItem() { RelativeSizeAxes = Axes.X; AutoSizeAxes = Axes.Y; Padding = new MarginPadding { Right = SettingsPanel.CONTENT_MARGINS }; InternalChildren = new Drawable[] { defaultValueIndicatorContainer = new Container { Width = SettingsPanel.CONTENT_MARGINS, }, new Container { RelativeSizeAxes = Axes.X, AutoSizeAxes = Axes.Y, Padding = new MarginPadding { Left = SettingsPanel.CONTENT_MARGINS }, Child = FlowContent = new FillFlowContainer { RelativeSizeAxes = Axes.X, AutoSizeAxes = Axes.Y, Spacing = new Vector2(0, 10), Child = Control = CreateControl(), } } }; // 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)}"); controlWithCurrent.Current.ValueChanged += _ => SettingChanged?.Invoke(); controlWithCurrent.Current.DisabledChanged += _ => updateDisabled(); } [BackgroundDependencyLoader] private void load() { // intentionally done before LoadComplete to avoid overhead. if (ShowsDefaultIndicator) { defaultValueIndicatorContainer.Add(new RestoreDefaultValueButton { Current = controlWithCurrent.Current, Anchor = Anchor.Centre, Origin = Anchor.Centre }); updateLayout(); } } private void updateLayout() { bool hasLabel = labelText != null && !string.IsNullOrEmpty(labelText.Text.ToString()); // 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; } } }