Class TreeLayoutCommandPalettePlugin

Namespace

Whim.TreeLayout.CommandPalette

Assembly

Whim.TreeLayout.CommandPalette.dll

This plugin contains commands to interact with the tree layout via the command palette.

public class TreeLayoutCommandPalettePlugin : IPlugin

Inheritance

object

TreeLayoutCommandPalettePlugin

Implements

IPlugin

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

Creates a new instance of the tree layout command palette plugin.

Constructors

TreeLayoutCommandPalettePlugin(IContext, ITreeLayoutPlugin, ICommandPalettePlugin)

This plugin contains commands to interact with the tree layout via the command palette.

public TreeLayoutCommandPalettePlugin(IContext context, ITreeLayoutPlugin treeLayoutPlugin, ICommandPalettePlugin commandPalettePlugin)

Parameters

context IContext

treeLayoutPlugin ITreeLayoutPlugin

commandPalettePlugin ICommandPalettePlugin

Remarks

Creates a new instance of the tree layout command palette plugin.

Properties

Name

whim.tree_layout.command_palette

public string Name { get; }

Property Value

string

PluginCommands

The commands and keybinds for this plugin. These are registered during PreInitialize().

public IPluginCommands PluginCommands { get; }

Property Value

IPluginCommands

Remarks

Keybindings can be overridden by the user using SetKeybind(string, IKeybind).

Methods

LoadState(JsonElement)

Load the plugin's state from state.

public void LoadState(JsonElement state)

Parameters

state JsonElement

The plugin's state.

Remarks

State is loaded after PostInitialize() and the user's configuration has been loaded. Thus, be careful on how you interact with the user's configuration.

PostInitialize()

This method is to be called by the plugin manager. Initializes the plugin after the rest of the IContext has been initialized. Put things which rely on the rest of the context here.

public void PostInitialize()

PreInitialize()

This method is to be called by the plugin manager. Initializes the plugin before the IContext has been initialized. Put things like event listeners here or adding proxy layout engines (see AddProxyLayoutEngine(ProxyLayoutEngineCreator)).

public void PreInitialize()

SaveState()

Save the plugin's state as a JsonElement.

public JsonElement? SaveState()

Returns

JsonElement?

The plugin's state.