Class CommandPalettePlugin

Namespace

Whim.CommandPalette

Assembly

Whim.CommandPalette.dll

Supports all classes in the .NET class hierarchy and provides low-level services to derived classes. This is the ultimate base class of all .NET classes; it is the root of the type hierarchy.

public class CommandPalettePlugin : ICommandPalettePlugin, IPlugin, IDisposable

Inheritance

object

CommandPalettePlugin

Implements

ICommandPalettePlugin

IPlugin

IDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

CommandPalettePlugin(IContext, CommandPaletteConfig)

Creates a new instance of the command palette plugin.

public CommandPalettePlugin(IContext context, CommandPaletteConfig commandPaletteConfig)

Parameters

context IContext

commandPaletteConfig CommandPaletteConfig

Properties

Config

The configuration for the command palette plugin.

public CommandPaletteConfig Config { get; }

Property Value

CommandPaletteConfig

Name

whim.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

Activate(BaseVariantConfig?)

Activate the command palette.

public void Activate(BaseVariantConfig? config = null)

Parameters

config BaseVariantConfig

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

public void Dispose()

Dispose(bool)

protected virtual void Dispose(bool disposing)

Parameters

disposing bool

Hide()

Hide the command palette.

public void Hide()

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.

Toggle()

Toggle the visibility of the command palette.

public void Toggle()