This PR adds improved override message generation for inheritance in SUI. The settings model now has an `OriginTag` to be able to denote where a `Profile` came from. This tag is used in the `SettingContainer` to generate a more specific override message. ## References #6800 - SUI Epic #8919 - SUI Inheritance PR #8804 - SUI Inheritance (old issue) ## Detailed Description of the Pull Request / Additional comments - **Terminal Settings Model** - Introduced `PROJECTED_SETTING` as a macro to more easily declare the functions for each setting - Introduced `<setting>OverrideSource` which finds the `Profile` that has \<setting\> defined - Introduced `OriginTag Profile::Origin {Custom, InBox, Generated}` to trace where a profile came from - `DefaultProfileUtils` creates profiles for profile generators. So that now sets the `Origin` tag to `Generated` - `CascadiaSettings::LoadDefaults()` tags all profiles created as `InBox`. - The view model had to ingest the API change to be able to interact with `<setting>OverrideSource` - **Override Message Generation** - The reset button now has a more specific tooltip - The reset button now only appears if base layer is being overridden - We use the settings model changes to determine the message to display for the target ## Validation Steps Performed Tested the following cases: - overrides nothing (inherited setting) - overrides value inherited from... - base layer - a profile generator - in-box profile - global settings should not have this feature
107 lines
4.1 KiB
Plaintext
107 lines
4.1 KiB
Plaintext
// Copyright (c) Microsoft Corporation.
|
|
// Licensed under the MIT license.
|
|
|
|
#include "IInheritable.idl.h"
|
|
|
|
#define INHERITABLE_PROFILE_SETTING(Type, Name) \
|
|
_BASE_INHERITABLE_SETTING(Type, Name); \
|
|
Microsoft.Terminal.Settings.Model.Profile Name##OverrideSource { get; }
|
|
|
|
namespace Microsoft.Terminal.Settings.Model
|
|
{
|
|
// This tag is used to identify the context in which the Profile was created
|
|
enum OriginTag
|
|
{
|
|
Custom = 0,
|
|
InBox,
|
|
Generated,
|
|
Fragment
|
|
};
|
|
|
|
enum CloseOnExitMode
|
|
{
|
|
Never = 0,
|
|
Graceful,
|
|
Always
|
|
};
|
|
|
|
[flags]
|
|
enum BellStyle
|
|
{
|
|
Audible = 0x1,
|
|
Visual = 0x2,
|
|
All = 0xffffffff
|
|
};
|
|
|
|
[flags]
|
|
enum ConvergedAlignment {
|
|
// low 4 bits are the horizontal
|
|
Horizontal_Center = 0x00,
|
|
Horizontal_Left = 0x01,
|
|
Horizontal_Right = 0x02,
|
|
|
|
// high 4 bits are the vertical
|
|
Vertical_Center = 0x00,
|
|
Vertical_Top = 0x10,
|
|
Vertical_Bottom = 0x20
|
|
};
|
|
|
|
[default_interface] runtimeclass Profile : Windows.Foundation.IStringable {
|
|
Profile();
|
|
Profile(Guid guid);
|
|
|
|
OriginTag Origin { get; };
|
|
|
|
INHERITABLE_PROFILE_SETTING(String, Name);
|
|
|
|
Boolean HasGuid();
|
|
Guid Guid;
|
|
|
|
INHERITABLE_PROFILE_SETTING(String, Source);
|
|
|
|
Boolean HasConnectionType();
|
|
Guid ConnectionType;
|
|
|
|
INHERITABLE_PROFILE_SETTING(Boolean, Hidden);
|
|
INHERITABLE_PROFILE_SETTING(String, Icon);
|
|
INHERITABLE_PROFILE_SETTING(CloseOnExitMode, CloseOnExit);
|
|
INHERITABLE_PROFILE_SETTING(String, TabTitle);
|
|
INHERITABLE_PROFILE_SETTING(Windows.Foundation.IReference<Windows.UI.Color>, TabColor);
|
|
INHERITABLE_PROFILE_SETTING(Boolean, SuppressApplicationTitle);
|
|
INHERITABLE_PROFILE_SETTING(Boolean, UseAcrylic);
|
|
INHERITABLE_PROFILE_SETTING(Double, AcrylicOpacity);
|
|
INHERITABLE_PROFILE_SETTING(Microsoft.Terminal.TerminalControl.ScrollbarState, ScrollState);
|
|
INHERITABLE_PROFILE_SETTING(String, FontFace);
|
|
INHERITABLE_PROFILE_SETTING(Int32, FontSize);
|
|
INHERITABLE_PROFILE_SETTING(Windows.UI.Text.FontWeight, FontWeight);
|
|
INHERITABLE_PROFILE_SETTING(String, Padding);
|
|
INHERITABLE_PROFILE_SETTING(String, Commandline);
|
|
|
|
INHERITABLE_PROFILE_SETTING(String, StartingDirectory);
|
|
String EvaluatedStartingDirectory { get; };
|
|
|
|
INHERITABLE_PROFILE_SETTING(String, BackgroundImagePath);
|
|
String ExpandedBackgroundImagePath { get; };
|
|
|
|
INHERITABLE_PROFILE_SETTING(Double, BackgroundImageOpacity);
|
|
INHERITABLE_PROFILE_SETTING(Windows.UI.Xaml.Media.Stretch, BackgroundImageStretchMode);
|
|
INHERITABLE_PROFILE_SETTING(ConvergedAlignment, BackgroundImageAlignment);
|
|
INHERITABLE_PROFILE_SETTING(Microsoft.Terminal.TerminalControl.TextAntialiasingMode, AntialiasingMode);
|
|
INHERITABLE_PROFILE_SETTING(Boolean, RetroTerminalEffect);
|
|
INHERITABLE_PROFILE_SETTING(String, PixelShaderPath);
|
|
INHERITABLE_PROFILE_SETTING(Boolean, ForceFullRepaintRendering);
|
|
INHERITABLE_PROFILE_SETTING(Boolean, SoftwareRendering);
|
|
INHERITABLE_PROFILE_SETTING(String, ColorSchemeName);
|
|
INHERITABLE_PROFILE_SETTING(Windows.Foundation.IReference<Windows.UI.Color>, Foreground);
|
|
INHERITABLE_PROFILE_SETTING(Windows.Foundation.IReference<Windows.UI.Color>, Background);
|
|
INHERITABLE_PROFILE_SETTING(Windows.Foundation.IReference<Windows.UI.Color>, SelectionBackground);
|
|
INHERITABLE_PROFILE_SETTING(Windows.Foundation.IReference<Windows.UI.Color>, CursorColor);
|
|
INHERITABLE_PROFILE_SETTING(Int32, HistorySize);
|
|
INHERITABLE_PROFILE_SETTING(Boolean, SnapOnInput);
|
|
INHERITABLE_PROFILE_SETTING(Boolean, AltGrAliasing);
|
|
INHERITABLE_PROFILE_SETTING(Microsoft.Terminal.TerminalControl.CursorStyle, CursorShape);
|
|
INHERITABLE_PROFILE_SETTING(UInt32, CursorHeight);
|
|
INHERITABLE_PROFILE_SETTING(BellStyle, BellStyle);
|
|
}
|
|
}
|