Interface IButlerChores

Namespace

Whim

Assembly

Whim.dll

Manage the movement of IWindows between IWorkspaces and IMonitors.

[Obsolete("Use transforms and pickers to interact with the store instead.")]
public interface IButlerChores

Methods

Activate(IWorkspace, IMonitor?)

Activates the given workspace in the active monitor, or the given monitor (if provided).

[Obsolete("Use the transform ActivateWorkspaceTransform instead.")]
void Activate(IWorkspace workspace, IMonitor? monitor = null)

Parameters

workspace IWorkspace

The workspace to activate.

monitor IMonitor

The monitor to activate the workspace in. If null, this will default to the active monitor.

ActivateAdjacent(IMonitor?, bool, bool)

Activates the next (or previous) workspace in the given monitor.

[Obsolete("Use the transform ActivateAdjacentWorkspaceTransform instead.")]
void ActivateAdjacent(IMonitor? monitor = null, bool reverse = false, bool skipActive = false)

Parameters

monitor IMonitor

The monitor to activate the next workspace in. Defaults to ActiveMonitor.

reverse bool

When true, gets the previous monitor, otherwise gets the next monitor. Defaults to false.

skipActive bool

When true, skips all workspaces that are active on any other monitor. Defaults to false.

FocusMonitorDesktop(IMonitor)

Focus the Windows desktop's window.

[Obsolete("Use the transform FocusMonitorDesktopTransform instead.")]
void FocusMonitorDesktop(IMonitor monitor)

Parameters

monitor IMonitor

LayoutAllActiveWorkspaces()

Triggers all active workspaces to update their layout. Active workspaces are those that are visible on a monitor.

[Obsolete("Use the transform LayoutAllActiveWorkspacesTransform instead.")]
void LayoutAllActiveWorkspaces()

MergeWorkspaceWindows(IWorkspace, IWorkspace)

Merges the windows of the given source into the given target.

[Obsolete("Use the transform MergeWorkspaceWindowsTransform instead.")]
void MergeWorkspaceWindows(IWorkspace source, IWorkspace target)

Parameters

source IWorkspace

The workspace to remove.

target IWorkspace

The workspace to merge the windows into.

MoveWindowEdgesInDirection(Direction, IPoint<int>, IWindow?)

Moves the given window by the given pixelsDeltas.

[Obsolete("Use the transform MoveWindowEdgesInDirectionTransform instead.")]
bool MoveWindowEdgesInDirection(Direction edges, IPoint<int> pixelsDeltas, IWindow? window = null)

Parameters

edges Direction

The edges to change.

pixelsDeltas IPoint<int>

The deltas (in pixels) to change the given edges by. When a value is positive, then the edge will move in the direction of the edges. The pixelsDeltas are in the coordinate space of the monitors, not the unit square.

window IWindow

Returns

bool

Whether the window's edges were moved.

MoveWindowToAdjacentWorkspace(IWindow?, bool, bool)

Moves the given window to the next (or previous) workspace.

[Obsolete("Use the transform MoveWindowToAdjacentWorkspaceTransform instead.")]
void MoveWindowToAdjacentWorkspace(IWindow? window = null, bool reverse = false, bool skipActive = false)

Parameters

window IWindow

The window to move. If null, this will default to the focused/active window.

reverse bool

When true, moves to the previous workspace, otherwise moves to the next workspace. Defaults to false.

skipActive bool

When true, skips all workspaces that are active on any other monitor. Defaults to false.

MoveWindowToMonitor(IMonitor, IWindow?)

Moves the given window to the given monitor.

[Obsolete("Use the transform MoveWindowToMonitorTransform instead.")]
void MoveWindowToMonitor(IMonitor monitor, IWindow? window = null)

Parameters

monitor IMonitor

The monitor to move the window to.

window IWindow

The window to move. If null, this will default to the focused/active window.

MoveWindowToNextMonitor(IWindow?)

Moves the given window to the next monitor.

[Obsolete("Use the transform MoveWindowToAdjacentMonitorTransform instead.")]
void MoveWindowToNextMonitor(IWindow? window = null)

Parameters

window IWindow

The window to move. If null, this will default to the focused/active window.

MoveWindowToPoint(IWindow, IPoint<int>)

Moves the given window to the given point.

[Obsolete("Use the transform MoveWindowToPointTransform instead.")]
void MoveWindowToPoint(IWindow window, IPoint<int> point)

Parameters

window IWindow

The window to move.

point IPoint<int>

The point to move the window to. The point is in the coordinate space of the monitors, not the unit square.

MoveWindowToPreviousMonitor(IWindow?)

Moves the given window to the previous monitor.

[Obsolete("Use the transform MoveWindowToAdjacentMonitorTransform instead.")]
void MoveWindowToPreviousMonitor(IWindow? window = null)

Parameters

window IWindow

The window to move. If null, this will default to the focused/active window.

MoveWindowToWorkspace(IWorkspace, IWindow?)

Moves the given window to the given workspace.

[Obsolete("Use the transform MoveWindowToWorkspaceTransform instead.")]
void MoveWindowToWorkspace(IWorkspace workspace, IWindow? window = null)

Parameters

workspace IWorkspace

The workspace to move the window to.

window IWindow

The window to move. If null, this will default to the focused/active window.

SwapWorkspaceWithAdjacentMonitor(IWorkspace?, bool)

Swap the given workspace with the adjacent monitor.

[Obsolete("Use the transform SwapWorkspaceWithAdjacentMonitorTransform instead.")]
void SwapWorkspaceWithAdjacentMonitor(IWorkspace? workspace = null, bool reverse = false)

Parameters

workspace IWorkspace

reverse bool

When true, swaps workspace with the previous monitor, otherwise with the next. Defaults to false.