104 lines
3.3 KiB
C#
104 lines
3.3 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.Collections.Generic;
|
||
|
|
using dnSpy.Contracts.Documents.TreeView;
|
||
|
|
|
||
|
|
namespace dnSpy.Contracts.Documents.Tabs {
|
||
|
|
/// <summary>
|
||
|
|
/// Contains the data used to generate the content shown in a tab. If it implements <see cref="IDisposable"/>,
|
||
|
|
/// it gets disposed when it's no longer in use.
|
||
|
|
/// </summary>
|
||
|
|
public abstract class DocumentTabContent {
|
||
|
|
/// <summary>
|
||
|
|
/// Gets all nodes used to generate the content
|
||
|
|
/// </summary>
|
||
|
|
public virtual IEnumerable<DocumentTreeNodeData> Nodes => Array.Empty<DocumentTreeNodeData>();
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
/// Called to show its content in the UI. Derive from <see cref="AsyncDocumentTabContent"/> to
|
||
|
|
/// create the content in a worker thread.
|
||
|
|
/// </summary>
|
||
|
|
/// <param name="ctx">UI Context created by <see cref="CreateUIContext(IDocumentTabUIContextLocator)"/></param>
|
||
|
|
/// <returns></returns>
|
||
|
|
public virtual void OnShow(IShowContext ctx) { }
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
/// Called when the content is hidden
|
||
|
|
/// </summary>
|
||
|
|
public virtual void OnHide() { }
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
/// Called when its tab has been selected. Only called if this is the tab's active content.
|
||
|
|
/// </summary>
|
||
|
|
public virtual void OnSelected() { }
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
/// Called when its tab has been unselected. Only called if this is the tab's active content.
|
||
|
|
/// </summary>
|
||
|
|
public virtual void OnUnselected() { }
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
/// Gets the title
|
||
|
|
/// </summary>
|
||
|
|
public abstract string Title { get; }
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
/// Gets the tooltip or null if none
|
||
|
|
/// </summary>
|
||
|
|
public virtual object? ToolTip => null;
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
/// true if <see cref="Clone"/> can be called
|
||
|
|
/// </summary>
|
||
|
|
public virtual bool CanClone => true;
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
/// Clones this instance. Can only be called if <see cref="CanClone"/> is true
|
||
|
|
/// </summary>
|
||
|
|
/// <returns></returns>
|
||
|
|
public abstract DocumentTabContent Clone();
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
/// Creates the <see cref="DocumentTabUIContext"/> instance needed by this instance. This
|
||
|
|
/// instance will only be used in this tab.
|
||
|
|
/// </summary>
|
||
|
|
/// <param name="locator">Can be used to get a per-tab shared instance</param>
|
||
|
|
/// <returns></returns>
|
||
|
|
public abstract DocumentTabUIContext CreateUIContext(IDocumentTabUIContextLocator locator);
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
/// Written by the owner <see cref="IDocumentTab"/> instance
|
||
|
|
/// </summary>
|
||
|
|
public IDocumentTab? DocumentTab {
|
||
|
|
get => documentTab;
|
||
|
|
set {
|
||
|
|
if (value is null)
|
||
|
|
throw new ArgumentNullException(nameof(value));
|
||
|
|
if (documentTab is null)
|
||
|
|
documentTab = value;
|
||
|
|
else if (documentTab != value)
|
||
|
|
throw new InvalidOperationException();
|
||
|
|
}
|
||
|
|
}
|
||
|
|
IDocumentTab? documentTab;
|
||
|
|
}
|
||
|
|
}
|