Interface IWtmuxComPlugin

Namespace

WTmux.Core.Plugins

Assembly

WTmux.Core.dll

COM interface for wtmux plugins. Plugin authors implement this interface in a COM server (in-process DLL or out-of-process EXE) and register it via an MSIX AppExtension with the "com.wtmux.plugin" contract.

[GeneratedComInterface(StringMarshalling = StringMarshalling.Utf16)]
[Guid("3A2F8E01-7B4C-4D5A-9E1F-0A2B3C4D5E01")]
[InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
[IUnknownDerived<InterfaceInformation, InterfaceImplementation>]
public interface IWtmuxComPlugin

Methods

ExpandVariable(string, string, int, string, int, bool, out string)

Expands a format variable registered by this plugin. Set result to empty string if the variable is not handled.

void ExpandVariable(string variableName, string sessionName, int windowIndex, string windowName, int paneIndex, bool prefixActive, out string result)

Parameters

variableName string

sessionName string

windowIndex int

windowName string

paneIndex int

prefixActive bool

result string

GetName(out string)

Returns the display name of the plugin.

void GetName(out string name)

Parameters

name string

Initialize(IWtmuxComPluginHost)

Called when the plugin is loaded. Use the host to register format variables and key bindings.

void Initialize(IWtmuxComPluginHost host)

Parameters

host IWtmuxComPluginHost

OnSessionCreated(string, int)

Called when a session is created.

void OnSessionCreated(string sessionName, int sessionId)

Parameters

sessionName string

sessionId int

OnSessionDestroyed(string, int)

Called when a session is destroyed.

void OnSessionDestroyed(string sessionName, int sessionId)

Parameters

sessionName string

sessionId int

Shutdown()

Called when the plugin is being unloaded.

void Shutdown()