src/Files.App/Actions/IAction.cs - main - githubmirror/Files

src/Files.App/Actions/IAction.cs

88 строк2 KB

yair100

Code Quality: Add Category, ExtendedLabel, AutomationId and AccessKey to actions (#18308)

27 мар 2026, 00:40

27 мар 2026, 00:406ef1f17

// Copyright (c) Files Community
// Licensed under the MIT License.

namespace Files.App.Actions
{
	public interface IAction
	{
		/// <summary>
		/// A label for display in context menus and toolbars
		/// </summary>
		string Label { get; }

		/// <summary>
		/// A brief description of what the action does.
		/// It will be used as the command name in the command palette.
		/// </summary>
		string Description { get; }

		/// <summary>
		/// Gets the extended label of this command, used to differentiate similar worded labels. Defaults to <see cref="Label"/>.
		/// </summary>
		string ExtendedLabel
			=> Label;

		/// <summary>
		/// Glyph information to display icon.
		/// </summary>
		RichGlyph Glyph
			=> RichGlyph.None;

		/// <summary>
		/// Access key hint used in menus.
		/// </summary>
		string AccessKey
			=> string.Empty;

		/// <summary>
		/// Primary hotkey to execute the action.
		/// </summary>
		HotKey HotKey
			=> HotKey.None;

		/// <summary>
		/// Secondary hotkey to execute the action.
		/// </summary>
		HotKey SecondHotKey
			=> HotKey.None;

		/// <summary>
		/// Tertiary hotkey to execute the action.
		/// </summary>
		HotKey ThirdHotKey
			=> HotKey.None;

		/// <summary>
		/// A hotkey with media keys.
		/// </summary>
		HotKey MediaHotKey
			=> HotKey.None;

		/// <summary>
		/// Gets the automation ID for UI testing.
		/// </summary>
		string AutomationId
			=> string.Empty;

		/// <summary>
		/// Returns whether the action is executable in the current context.
		/// </summary>
		bool IsExecutable
			=> true;

		/// <summary>
		/// Returns whether the action is accessible in any context.
		/// </summary>
		bool IsAccessibleGlobally
			=> true;

		ActionCategory Category
			=> ActionCategory.Unspecified;

		/// <summary>
		/// Executes the action asynchronously.
		/// </summary>
		/// <returns>A <see cref="Task"/> that represents the asynchronous operation.</returns>
		Task ExecuteAsync(object? parameter = null);
	}
}