Class GapsLayoutEngine

Namespace

Whim.Gaps

Assembly

Whim.Gaps.dll

A proxy layout engine to add gaps to the layout.

public record GapsLayoutEngine : BaseProxyLayoutEngine, ILayoutEngine, IEquatable<BaseProxyLayoutEngine>, IEquatable<GapsLayoutEngine>

Inheritance

object

BaseProxyLayoutEngine

GapsLayoutEngine

Implements

ILayoutEngine

IEquatable<BaseProxyLayoutEngine>

IEquatable<GapsLayoutEngine>

Inherited Members

BaseProxyLayoutEngine.InnerLayoutEngine

BaseProxyLayoutEngine.Identity

BaseProxyLayoutEngine.Name

BaseProxyLayoutEngine.GetLayoutEngine<T>()

BaseProxyLayoutEngine.ContainsEqual(ILayoutEngine)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

GapsLayoutEngine(GapsConfig, ILayoutEngine)

Create a new instance of the proxy layout engine GapsLayoutEngine.

public GapsLayoutEngine(GapsConfig gapsConfig, ILayoutEngine innerLayoutEngine)

Parameters

gapsConfig GapsConfig

innerLayoutEngine ILayoutEngine

Properties

Count

The number of windows in the layout engine.

public override int Count { get; }

Property Value

int

Methods

AddWindow(IWindow)

Adds a window to the layout engine.

public override ILayoutEngine AddWindow(IWindow window)

Parameters

window IWindow

Returns

ILayoutEngine

The new ILayoutEngine after the add.

ContainsWindow(IWindow)

Determines whether the layout engine contains the window.

public override bool ContainsWindow(IWindow window)

Parameters

window IWindow

Returns

bool

True if the layout engine contains the window, otherwise false.

DoLayout(IRectangle<int>, IMonitor)

Performs a layout inside the available rectangle.

public override IEnumerable<IWindowState> DoLayout(IRectangle<int> rectangle, IMonitor monitor)

Parameters

rectangle IRectangle<int>

The available area to do a layout inside.

monitor IMonitor

The monitor which the layout is being done for.

Returns

IEnumerable<IWindowState>

The layout result.

Remarks

For a given rectangle, the layout engine should return the same result every time.

FocusWindowInDirection(Direction, IWindow)

Focuses the window in the direction. It's recommended that this method is not called directly, but rather through dispatching FocusWindowInDirectionTransform.

public override ILayoutEngine FocusWindowInDirection(Direction direction, IWindow window)

Parameters

direction Direction

The direction to focus in.

window IWindow

The origin window

Returns

ILayoutEngine

GetFirstWindow()

Retrieves the first window in the layout engine.

public override IWindow? GetFirstWindow()

Returns

IWindow

MinimizeWindowEnd(IWindow)

Called when a window is being unminimized - i.e., the window size will no longer be Minimized. The layout engine can choose to ignore this call, if it does not support unminimizing windows.

public override ILayoutEngine MinimizeWindowEnd(IWindow window)

Parameters

window IWindow

Returns

ILayoutEngine

MinimizeWindowStart(IWindow)

Called when a window is being minimized - i.e., the window size will become Minimized. The layout engine can choose to ignore this call, if it does not support minimizing windows.

public override ILayoutEngine MinimizeWindowStart(IWindow window)

Parameters

window IWindow

Returns

ILayoutEngine

MoveWindowEdgesInDirection(Direction, IPoint<double>, IWindow)

Moves the focused window's edges by the specified deltas.

public override ILayoutEngine MoveWindowEdgesInDirection(Direction edge, IPoint<double> deltas, IWindow window)

Parameters

edge Direction

deltas IPoint<double>

The deltas to change the given edges by. The deltas are in the range [0, 1] for both x and y (the unit square).

window IWindow

Returns

ILayoutEngine

The new ILayoutEngine after the move.

MoveWindowToPoint(IWindow, IPoint<double>)

Move the window to the point. The point has a coordinate space of [0, 1] for both x and y.

public override ILayoutEngine MoveWindowToPoint(IWindow window, IPoint<double> point)

Parameters

window IWindow

The window to move.

point IPoint<double>

The point to move the window to.

Returns

ILayoutEngine

The new ILayoutEngine after the move.

PerformCustomAction<T>(LayoutEngineCustomAction<T>)

Attempts to trigger a custom action in a layout engine.

public override ILayoutEngine PerformCustomAction<T>(LayoutEngineCustomAction<T> action)

Parameters

action LayoutEngineCustomAction<T>

Metadata about the action to perform, and the payload to perform it with.

Returns

ILayoutEngine

A new layout engine if the action is handled, otherwise it returns the current layout engine.

Type Parameters

T

The type of the action's payload.

Remarks

This method is used to handle custom actions that are not part of the ILayoutEngine interface. For example, the SliceLayoutEngine uses this method to promote/demote windows in the window stack.

RemoveWindow(IWindow)

Removes a window from the layout engine.

public override ILayoutEngine RemoveWindow(IWindow window)

Parameters

window IWindow

Returns

ILayoutEngine

The new ILayoutEngine after the remove.

SwapWindowInDirection(Direction, IWindow)

Swaps the window in the direction. It's recommended that this method is not called directly, but rather through duspatching SwapWindowInDirectionTransform.

public override ILayoutEngine SwapWindowInDirection(Direction direction, IWindow window)

Parameters

direction Direction

The direction to swap the window in.

window IWindow

The window to swap.

Returns

ILayoutEngine

The new ILayoutEngine after the swap.