Skip to content

Feature: Added a description to each IAction #11828

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 32 commits into from
Apr 16, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
afee296
Create CommandList.md
hishitetsu Mar 24, 2023
0530bc9
Update CommandList.md
hishitetsu Mar 24, 2023
11a6e2c
Update CommandList.md
hishitetsu Mar 24, 2023
a3b54c0
Update CommandList.md
hishitetsu Mar 24, 2023
0bce3f9
Update CommandList.md
hishitetsu Mar 24, 2023
813782e
Update CommandList.md
hishitetsu Mar 24, 2023
2123dcd
Update CommandList.md
hishitetsu Mar 24, 2023
609e548
Update CommandList.md
hishitetsu Mar 24, 2023
8eec90d
Update CommandList.md
yaira2 Mar 24, 2023
53e8cb7
Share
hishitetsu Mar 26, 2023
3937f55
Update CommandList.md
hishitetsu Mar 26, 2023
a0768d3
Merge branch 'files-community:main' into CommandList
hishitetsu Mar 26, 2023
75b7db9
RefreshItems, OpenSettings, NavigateBack, NavigateForward, NavigateUp
hishitetsu Mar 27, 2023
1945967
Merge branch 'files-community:main' into CommandList
hishitetsu Mar 27, 2023
f22fffa
ToggleSelect, Rename, ReopenClosedTab
hishitetsu Mar 28, 2023
aa4b1b4
Merge branch 'files-community:main' into CommandList
hishitetsu Mar 28, 2023
579b726
A hotkey for OpenItem
hishitetsu Mar 28, 2023
2cce880
Search
hishitetsu Mar 29, 2023
12fbd62
Merge branch 'files-community:main' into CommandList
hishitetsu Mar 29, 2023
4a9054c
ToggleSidebar
hishitetsu Mar 30, 2023
2a19737
Merge branch 'files-community:main' into CommandList
hishitetsu Mar 30, 2023
4f3c2a8
PreviousTab, NextTab, CloseSelectedTab
hishitetsu Apr 1, 2023
be64f43
Merge branch 'files-community:main' into CommandList
hishitetsu Apr 1, 2023
85dbcce
Merge branch 'main' into CommandList
yaira2 Apr 2, 2023
367019b
FormatDrive
hishitetsu Apr 2, 2023
e737e6b
Merge branch 'files-community:main' into CommandList
hishitetsu Apr 2, 2023
ee55775
RunWithPowershell
hishitetsu Apr 4, 2023
da0b4c3
Merge branch 'files-community:main' into CommandList
hishitetsu Apr 4, 2023
9009be1
Alt key
hishitetsu Apr 12, 2023
53c40c2
OpenNewPane, ClosePane
hishitetsu Apr 15, 2023
578eca7
Merge branch 'files-community:main' into CommandList
hishitetsu Apr 15, 2023
f2cc664
Added descriptions to IAction
hishitetsu Apr 15, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
117 changes: 117 additions & 0 deletions specs/RichCommand/CommandList.md

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ internal class CompressIntoArchiveAction : BaseUIAction, IAction

public string Label => "CreateArchive".GetLocalizedResource();

public string Description => "TODO: Need to be described.";
public string Description => "CompressIntoArchiveDescription".GetLocalizedResource();

public override bool IsExecutable =>
IsContextPageTypeAdaptedToCommand() &&
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ internal class CompressIntoSevenZipAction : ObservableObject, IAction

public string Label => string.Format("CreateNamedArchive".GetLocalizedResource(), $"{ArchiveHelpers.DetermineArchiveNameFromSelection(context.SelectedItems)}.7z");

public string Description => "TODO: Need to be described.";
public string Description => "CompressIntoSevenZipDescription".GetLocalizedResource();

public bool IsExecutable => IsContextPageTypeAdaptedToCommand()
&& ArchiveHelpers.CanCompress(context.SelectedItems);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ internal class CompressIntoZipAction : ObservableObject, IAction

public string Label => string.Format("CreateNamedArchive".GetLocalizedResource(), $"{ArchiveHelpers.DetermineArchiveNameFromSelection(context.SelectedItems)}.zip");

public string Description => "TODO: Need to be described.";
public string Description => "CompressIntoZipDescription".GetLocalizedResource();

public bool IsExecutable => IsContextPageTypeAdaptedToCommand()
&& ArchiveHelpers.CanCompress(context.SelectedItems);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ internal class DecompressArchive : BaseUIAction, IAction

public string Label => "ExtractFiles".GetLocalizedResource();

public string Description => "TODO: Need to be described.";
public string Description => "DecompressArchiveDescription".GetLocalizedResource();

public HotKey HotKey { get; } = new(Keys.E, KeyModifiers.Ctrl);

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ internal class DecompressArchiveHere : BaseUIAction, IAction

public string Label => "ExtractHere".GetLocalizedResource();

public string Description => "TODO: Need to be described.";
public string Description => "DecompressArchiveHereDescription".GetLocalizedResource();

public override bool IsExecutable =>
IsContextPageTypeAdaptedToCommand() &&
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ internal class DecompressArchiveToChildFolderAction : BaseUIAction, IAction

public string Label => ComputeLabel();

public string Description => "TODO: Need to be described.";
public string Description => "DecompressArchiveToChildFolderDescription".GetLocalizedResource();

public override bool IsExecutable =>
IsContextPageTypeAdaptedToCommand() &&
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ internal class SetAsLockscreenBackgroundAction : BaseSetAsAction
{
public override string Label { get; } = "SetAsLockscreen".GetLocalizedResource();

public override string Description => "TODO: Need to be described.";
public override string Description => "SetAsLockscreenBackgroundDescription".GetLocalizedResource();

public override RichGlyph Glyph { get; } = new("\uEE3F");

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ internal class SetAsSlideshowBackgroundAction : BaseSetAsAction
{
public override string Label { get; } = "SetAsSlideshow".GetLocalizedResource();

public override string Description => "TODO: Need to be described.";
public override string Description => "SetAsSlideshowBackgroundDescription".GetLocalizedResource();

public override RichGlyph Glyph { get; } = new("\uE91B");

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ internal class SetAsWallpaperBackgroundAction : BaseSetAsAction
{
public override string Label { get; } = "SetAsBackground".GetLocalizedResource();

public override string Description => "TODO: Need to be described.";
public override string Description => "SetAsWallpaperBackgroundDescription".GetLocalizedResource();

public override RichGlyph Glyph { get; } = new("\uE91B");

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ internal class RotateLeftAction : BaseRotateAction
{
public override string Label { get; } = "RotateLeft".GetLocalizedResource();

public override string Description => "TODO: Need to be described.";
public override string Description => "RotateLeftDescription".GetLocalizedResource();

public override RichGlyph Glyph { get; } = new RichGlyph(opacityStyle: "ColorIconRotateLeft");

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ internal class RotateRightAction : BaseRotateAction
{
public override string Label { get; } = "RotateRight".GetLocalizedResource();

public override string Description => "TODO: Need to be described.";
public override string Description => "RotateRightDescription".GetLocalizedResource();

public override RichGlyph Glyph { get; } = new RichGlyph(opacityStyle: "ColorIconRotateRight");

Expand Down
2 changes: 1 addition & 1 deletion src/Files.App/Actions/Content/Install/InstallFontAction.cs
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ internal class InstallFontAction : ObservableObject, IAction

public string Label => "Install".GetLocalizedResource();

public string Description => "TODO: Need to be described.";
public string Description => "InstallFontDescription".GetLocalizedResource();

public bool IsExecutable => context.SelectedItems.Any() &&
context.SelectedItems.All(x => FileExtensionHelpers.IsFontFile(x.FileExtension)) &&
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ internal class InstallInfDriverAction : ObservableObject, IAction

public string Label => "Install".GetLocalizedResource();

public string Description => "TODO: Need to be described.";
public string Description => "InstallInfDriverDescription".GetLocalizedResource();

public RichGlyph Glyph { get; } = new("\uE9F5");

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ internal class LaunchQuickLookAction : ObservableObject, IAction

public string Label => "LaunchQuickLook".GetLocalizedResource();

public string Description => "TODO: Need to be described.";
public string Description => "LaunchQuickLookDescription".GetLocalizedResource();

public LaunchQuickLookAction()
{
Expand Down
2 changes: 1 addition & 1 deletion src/Files.App/Actions/Content/RefreshItemsAction.cs
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ internal class RefreshItemsAction : ObservableObject, IAction
private readonly IContentPageContext context = Ioc.Default.GetRequiredService<IContentPageContext>();

public string Label { get; } = "Refresh".GetLocalizedResource();
public string Description { get; } = "TODO";
public string Description { get; } = "RefreshItemsDescription".GetLocalizedResource();

public RichGlyph Glyph { get; } = new("\uE72C");

Expand Down
2 changes: 1 addition & 1 deletion src/Files.App/Actions/Content/Run/RunAsAdminAction.cs
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ internal class RunAsAdminAction : ObservableObject, IAction
public bool IsExecutable => context.SelectedItem is not null &&
FileExtensionHelpers.IsExecutableFile(context.SelectedItem.FileExtension);
public string Label => "RunAsAdministrator".GetLocalizedResource();
public string Description => "TODO: Need to be described.";
public string Description => "RunAsAdminDescription".GetLocalizedResource();
public RichGlyph Glyph => new("\uE7EF");

public RunAsAdminAction()
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ internal class RunAsAnotherUserAction : ObservableObject, IAction
public bool IsExecutable => context.SelectedItem is not null &&
FileExtensionHelpers.IsExecutableFile(context.SelectedItem.FileExtension);
public string Label => "BaseLayoutContextFlyoutRunAsAnotherUser/Text".GetLocalizedResource();
public string Description => "TODO: Need to be described.";
public string Description => "RunAsAnotherUserDescription".GetLocalizedResource();
public RichGlyph Glyph => new("\uE7EE");

public RunAsAnotherUserAction()
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ internal class RunWithPowershellAction : ObservableObject, IAction

public string Label => "RunWithPowerShell".GetLocalizedResource();

public string Description => "TODO: Need to be described.";
public string Description => "RunWithPowershellDescription".GetLocalizedResource();

public RichGlyph Glyph => new("\uE756");

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ internal class ClearSelectionAction : IAction

public string Label { get; } = "ClearSelection".GetLocalizedResource();

public string Description => "TODO: Need to be described.";
public string Description => "ClearSelectionDescription".GetLocalizedResource();

public RichGlyph Glyph { get; } = new("\uE8E6");

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ internal class InvertSelectionAction : IAction

public string Label { get; } = "InvertSelection".GetLocalizedResource();

public string Description => "TODO: Need to be described.";
public string Description => "InvertSelectionDescription".GetLocalizedResource();

public RichGlyph Glyph { get; } = new("\uE746");

Expand Down
2 changes: 1 addition & 1 deletion src/Files.App/Actions/Content/Selection/SelectAllAction.cs
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ internal class SelectAllAction : IAction

public string Label { get; } = "SelectAll".GetLocalizedResource();

public string Description => "TODO: Need to be described.";
public string Description => "SelectAllDescription".GetLocalizedResource();

public RichGlyph Glyph { get; } = new("\uE8B3");

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ namespace Files.App.Actions
internal class ToggleSelectAction : IAction
{
public string Label { get; } = "ToggleSelect".GetLocalizedResource();
public string Description => "TODO: Need to be described.";
public string Description => "ToggleSelectDescription".GetLocalizedResource();

public HotKey HotKey { get; } = new(Keys.Space, KeyModifiers.Ctrl);

Expand Down
2 changes: 1 addition & 1 deletion src/Files.App/Actions/Content/Share/ShareItemAction.cs
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ internal class ShareItemAction : ObservableObject, IAction

public string Label => "Share".GetLocalizedResource();

public string Description => "TODO: Need to be described.";
public string Description => "ShareItemDescription".GetLocalizedResource();

public RichGlyph Glyph { get; } = new RichGlyph(opacityStyle: "ColorIconShare");

Expand Down
30 changes: 26 additions & 4 deletions src/Files.App/Actions/Display/GroupAction.cs
Original file line number Diff line number Diff line change
Expand Up @@ -13,41 +13,53 @@ internal class GroupByNoneAction : GroupByAction
protected override GroupOption GroupOption { get; } = GroupOption.None;

public override string Label { get; } = "None".GetLocalizedResource();

public override string Description => "GroupByNoneDescription".GetLocalizedResource();
}

internal class GroupByNameAction : GroupByAction
{
protected override GroupOption GroupOption { get; } = GroupOption.Name;

public override string Label { get; } = "Name".GetLocalizedResource();

public override string Description => "GroupByNameDescription".GetLocalizedResource();
}

internal class GroupByDateModifiedAction : GroupByAction
{
protected override GroupOption GroupOption { get; } = GroupOption.DateModified;

public override string Label { get; } = "DateModifiedLowerCase".GetLocalizedResource();

public override string Description => "GroupByDateModifiedDescription".GetLocalizedResource();
}

internal class GroupByDateCreatedAction : GroupByAction
{
protected override GroupOption GroupOption { get; } = GroupOption.DateCreated;

public override string Label { get; } = "DateCreated".GetLocalizedResource();

public override string Description => "GroupByDateCreatedDescription".GetLocalizedResource();
}

internal class GroupBySizeAction : GroupByAction
{
protected override GroupOption GroupOption { get; } = GroupOption.Size;

public override string Label { get; } = "Size".GetLocalizedResource();

public override string Description => "GroupBySizeDescription".GetLocalizedResource();
}

internal class GroupByTypeAction : GroupByAction
{
protected override GroupOption GroupOption { get; } = GroupOption.FileType;

public override string Label { get; } = "Type".GetLocalizedResource();

public override string Description => "GroupByTypeDescription".GetLocalizedResource();
}

internal class GroupBySyncStatusAction : GroupByAction
Expand All @@ -56,6 +68,8 @@ internal class GroupBySyncStatusAction : GroupByAction

public override string Label { get; } = "SyncStatus".GetLocalizedResource();

public override string Description => "GroupBySyncStatusDescription".GetLocalizedResource();

protected override bool GetIsExecutable(ContentPageTypes pageType) => pageType is ContentPageTypes.CloudDrive;
}

Expand All @@ -64,6 +78,8 @@ internal class GroupByTagAction : GroupByAction
protected override GroupOption GroupOption { get; } = GroupOption.FileTag;

public override string Label { get; } = "FileTags".GetLocalizedResource();

public override string Description => "GroupByTagDescription".GetLocalizedResource();
}

internal class GroupByOriginalFolderAction : GroupByAction
Expand All @@ -72,6 +88,8 @@ internal class GroupByOriginalFolderAction : GroupByAction

public override string Label { get; } = "OriginalFolder".GetLocalizedResource();

public override string Description => "GroupByOriginalFolderDescription".GetLocalizedResource();

protected override bool GetIsExecutable(ContentPageTypes pageType) => pageType is ContentPageTypes.CloudDrive;
}

Expand All @@ -81,6 +99,8 @@ internal class GroupByDateDeletedAction : GroupByAction

public override string Label { get; } = "DateDeleted".GetLocalizedResource();

public override string Description => "GroupByDateDeletedDescription".GetLocalizedResource();

protected override bool GetIsExecutable(ContentPageTypes pageType) => pageType is ContentPageTypes.RecycleBin;
}

Expand All @@ -90,6 +110,8 @@ internal class GroupByFolderPathAction : GroupByAction

public override string Label { get; } = "FolderPath".GetLocalizedResource();

public override string Description => "GroupByFolderPathDescription".GetLocalizedResource();

protected override bool GetIsExecutable(ContentPageTypes pageType) => pageType is ContentPageTypes.Library;
}

Expand All @@ -102,7 +124,7 @@ internal abstract class GroupByAction : ObservableObject, IToggleAction

public abstract string Label { get; }

public string Description => "TODO: Need to be described.";
public abstract string Description { get; }

private bool isOn;
public bool IsOn => isOn;
Expand Down Expand Up @@ -146,7 +168,7 @@ internal class GroupAscendingAction : ObservableObject, IToggleAction

public string Label { get; } = "Ascending".GetLocalizedResource();

public string Description => "TODO: Need to be described.";
public string Description => "GroupAscendingDescription".GetLocalizedResource();

public bool IsOn => context.GroupDirection is SortDirection.Ascending;
public bool IsExecutable => context.GroupOption is not GroupOption.None;
Expand Down Expand Up @@ -182,7 +204,7 @@ internal class GroupDescendingAction : ObservableObject, IToggleAction

public string Label { get; } = "Descending".GetLocalizedResource();

public string Description => "TODO: Need to be described.";
public string Description => "GroupDescendingDescription".GetLocalizedResource();

public bool IsOn => context.GroupDirection is SortDirection.Descending;
public bool IsExecutable => context.GroupOption is not GroupOption.None;
Expand Down Expand Up @@ -218,7 +240,7 @@ internal class ToggleGroupDirectionAction : IAction

public string Label { get; } = "ToggleSortDirection".GetLocalizedResource();

public string Description => "TODO: Need to be described.";
public string Description => "ToggleGroupDirectionDescription".GetLocalizedResource();

public Task ExecuteAsync()
{
Expand Down
Loading