108 lines
3.4 KiB
C#
108 lines
3.4 KiB
C#
/*
|
|
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.ComponentModel.Composition;
|
|
using dnSpy.Contracts.Images;
|
|
|
|
namespace dnSpy.Contracts.ToolBars {
|
|
/// <summary>
|
|
/// A button in the toolbar
|
|
/// </summary>
|
|
public interface IToolBarButton : IToolBarItem {
|
|
/// <summary>
|
|
/// Returns true if the toolbar item is enabled and its <see cref="Execute(IToolBarItemContext)"/>
|
|
/// method can be called.
|
|
/// </summary>
|
|
/// <param name="context">Context</param>
|
|
/// <returns></returns>
|
|
bool IsEnabled(IToolBarItemContext context);
|
|
|
|
/// <summary>
|
|
/// Executes the command
|
|
/// </summary>
|
|
/// <param name="context">Context</param>
|
|
void Execute(IToolBarItemContext context);
|
|
|
|
/// <summary>
|
|
/// Gets the header or null to use the header from the attribute
|
|
/// </summary>
|
|
/// <param name="context">Context</param>
|
|
/// <returns></returns>
|
|
string? GetHeader(IToolBarItemContext context);
|
|
|
|
/// <summary>
|
|
/// Gets the icon or null to use the icon from the attribute
|
|
/// </summary>
|
|
/// <param name="context">Context</param>
|
|
/// <returns></returns>
|
|
ImageReference? GetIcon(IToolBarItemContext context);
|
|
|
|
/// <summary>
|
|
/// Gets the tooltip or null to use the tooltip from the attribute
|
|
/// </summary>
|
|
/// <param name="context">Context</param>
|
|
/// <returns></returns>
|
|
string? GetToolTip(IToolBarItemContext context);
|
|
}
|
|
|
|
/// <summary>Metadata</summary>
|
|
public interface IToolBarButtonMetadata : IToolBarItemMetadata {
|
|
/// <summary>See <see cref="ExportToolBarButtonAttribute.Header"/></summary>
|
|
string? Header { get; }
|
|
/// <summary>See <see cref="ExportToolBarButtonAttribute.Icon"/></summary>
|
|
string? Icon { get; }
|
|
/// <summary>See <see cref="ExportToolBarButtonAttribute.ToolTip"/></summary>
|
|
string? ToolTip { get; }
|
|
/// <summary>See <see cref="ExportToolBarButtonAttribute.IsToggleButton"/></summary>
|
|
bool IsToggleButton { get; }
|
|
}
|
|
|
|
/// <summary>
|
|
/// Exports a toolbar button (<see cref="IToolBarButton"/>)
|
|
/// </summary>
|
|
[MetadataAttribute, AttributeUsage(AttributeTargets.Class, AllowMultiple = false)]
|
|
public sealed class ExportToolBarButtonAttribute : ExportToolBarItemAttribute, IToolBarButtonMetadata {
|
|
/// <summary>Constructor</summary>
|
|
public ExportToolBarButtonAttribute()
|
|
: base(typeof(IToolBarButton)) {
|
|
}
|
|
|
|
/// <summary>
|
|
/// Toolbar button header property value
|
|
/// </summary>
|
|
public string? Header { get; set; }
|
|
|
|
/// <summary>
|
|
/// Icon name
|
|
/// </summary>
|
|
public string? Icon { get; set; }
|
|
|
|
/// <summary>
|
|
/// Tooltip
|
|
/// </summary>
|
|
public string? ToolTip { get; set; }
|
|
|
|
/// <summary>
|
|
/// true if it's a toggle button. If true, you must implement <see cref="IToolBarToggleButton"/>.
|
|
/// </summary>
|
|
public bool IsToggleButton { get; set; }
|
|
}
|
|
}
|