Dnspy/dnSpy/dnSpy.Contracts.DnSpy/Command/ICommandInfoProvider.cs

73 lines
2.5 KiB
C#
Raw Normal View History

2021-09-20 18:20:01 +02:00
/*
Copyright (C) 2014-2019 de4dot@gmail.com
This file is part of dnSpy
dnSpy is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
dnSpy is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with dnSpy. If not, see <http://www.gnu.org/licenses/>.
*/
using System;
using System.Collections.Generic;
using System.ComponentModel.Composition;
namespace dnSpy.Contracts.Command {
/// <summary>
/// Converts raw input to a <see cref="CommandInfo"/>. Use
/// <see cref="ExportCommandInfoProviderAttribute"/> to export an instance.
/// </summary>
public interface ICommandInfoProvider {
/// <summary>
/// Gets all keyboard shortcuts
/// </summary>
/// <param name="target">Target object</param>
/// <returns></returns>
IEnumerable<CommandShortcut> GetCommandShortcuts(object target);
}
/// <summary>
/// Converts user input to a <see cref="CommandInfo"/>
/// </summary>
public interface ICommandInfoProvider2 : ICommandInfoProvider {
/// <summary>
/// Returns a <see cref="CommandInfo"/> created from user text
/// </summary>
/// <param name="target">Target object</param>
/// <param name="text">Text typed by the user</param>
/// <returns></returns>
CommandInfo? CreateFromTextInput(object target, string text);
}
/// <summary>Metadata</summary>
public interface ICommandInfoProviderMetadata {
/// <summary>See <see cref="ExportCommandInfoProviderAttribute.Order"/></summary>
double Order { get; }
}
/// <summary>
/// Exports a <see cref="ICommandInfoProvider"/> instance
/// </summary>
[MetadataAttribute, AttributeUsage(AttributeTargets.Class, AllowMultiple = false)]
public sealed class ExportCommandInfoProviderAttribute : ExportAttribute, ICommandInfoProviderMetadata {
/// <summary>Constructor</summary>
/// <param name="order">Order of this instance, eg. <see cref="CommandInfoProviderOrder.Default"/></param>
public ExportCommandInfoProviderAttribute(double order)
: base(typeof(ICommandInfoProvider)) => Order = order;
/// <summary>
/// Order of this instance
/// </summary>
public double Order { get; set; }
}
}