Class GapsPlugin

Namespace

Whim.Gaps

Assembly

Whim.Gaps.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 GapsPlugin : IGapsPlugin, IPlugin

Inheritance

object

GapsPlugin

Implements

IGapsPlugin

IPlugin

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

GapsPlugin(IContext, GapsConfig)

Creates a new instance of the gaps plugin.

public GapsPlugin(IContext context, GapsConfig gapsConfig)

Parameters

context IContext

gapsConfig GapsConfig

Properties

GapsConfig

The configuration for the gaps plugin.

public GapsConfig GapsConfig { get; }

Property Value

GapsConfig

Name

whim.gaps

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.

UpdateInnerGap(int)

Update the gap between windows by the delta.

public void UpdateInnerGap(int delta)

Parameters

delta int

UpdateOuterGap(int)

Update the gap between the parent layout engine and the area where windows are placed by the delta.

public void UpdateOuterGap(int delta)

Parameters

delta int