Class ConsoleWindowSystem

Namespace

SharpConsoleUI

Assembly

SharpConsoleUI.dll

The main window system that manages console windows, input processing, and rendering. Provides window management, focus handling, theming, and event processing for console applications.

public class ConsoleWindowSystem

Inheritance

object

ConsoleWindowSystem

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

BindingExtensions.BindTwoWay<TBuilder, TControl, TSource, TValue>(TBuilder, TSource, Expression<Func<TSource, TValue>>, Expression<Func<TControl, TValue>>)

BindingExtensions.BindTwoWay<TBuilder, TControl, TSource, TSrc, TTgt>(TBuilder, TSource, Expression<Func<TSource, TSrc>>, Expression<Func<TControl, TTgt>>, Func<TSrc, TTgt>, Func<TTgt, TSrc>)

BindingExtensions.Bind<TBuilder, TControl, TSource, TValue>(TBuilder, TSource, Expression<Func<TSource, TValue>>, Expression<Func<TControl, TValue>>)

BindingExtensions.Bind<TBuilder, TControl, TSource, TSrc, TTgt>(TBuilder, TSource, Expression<Func<TSource, TSrc>>, Expression<Func<TControl, TTgt>>, Func<TSrc, TTgt>)

Constructors

ConsoleWindowSystem(IConsoleDriver, PluginConfiguration?, ConsoleWindowSystemOptions?, RegistryConfiguration?)

Initializes a new instance of the ConsoleWindowSystem class with the default theme.

public ConsoleWindowSystem(IConsoleDriver driver, PluginConfiguration? pluginConfiguration = null, ConsoleWindowSystemOptions? options = null, RegistryConfiguration? registryConfiguration = null)

Parameters

driver IConsoleDriver

Pre-configured console driver.

pluginConfiguration PluginConfiguration

Optional plugin configuration for auto-loading plugins.

options ConsoleWindowSystemOptions

Optional configuration options for system behavior.

registryConfiguration RegistryConfiguration

Optional registry configuration for persistent key-value storage.

ConsoleWindowSystem(IConsoleDriver, ITheme, PluginConfiguration?, ConsoleWindowSystemOptions?, RegistryConfiguration?)

Initializes a new instance of the ConsoleWindowSystem class with a specific theme instance.

public ConsoleWindowSystem(IConsoleDriver driver, ITheme theme, PluginConfiguration? pluginConfiguration = null, ConsoleWindowSystemOptions? options = null, RegistryConfiguration? registryConfiguration = null)

Parameters

driver IConsoleDriver

Pre-configured console driver.

theme ITheme

The theme instance to use.

pluginConfiguration PluginConfiguration

Optional plugin configuration for auto-loading plugins.

options ConsoleWindowSystemOptions

Optional configuration options for system behavior.

registryConfiguration RegistryConfiguration

Optional registry configuration for persistent key-value storage.

ConsoleWindowSystem(IConsoleDriver, string, PluginConfiguration?, ConsoleWindowSystemOptions?, RegistryConfiguration?)

Initializes a new instance of the ConsoleWindowSystem class with a theme specified by name.

public ConsoleWindowSystem(IConsoleDriver driver, string themeName, PluginConfiguration? pluginConfiguration = null, ConsoleWindowSystemOptions? options = null, RegistryConfiguration? registryConfiguration = null)

Parameters

driver IConsoleDriver

Pre-configured console driver.

themeName string

The name of the theme to use.

pluginConfiguration PluginConfiguration

Optional plugin configuration for auto-loading plugins.

options ConsoleWindowSystemOptions

Optional configuration options for system behavior.

registryConfiguration RegistryConfiguration

Optional registry configuration for persistent key-value storage.

ConsoleWindowSystem(RenderMode, PluginConfiguration?, ConsoleWindowSystemOptions?, RegistryConfiguration?)

Initializes a new instance with a render mode.

public ConsoleWindowSystem(RenderMode renderMode, PluginConfiguration? pluginConfiguration = null, ConsoleWindowSystemOptions? options = null, RegistryConfiguration? registryConfiguration = null)

Parameters

renderMode RenderMode

The rendering mode to use.

pluginConfiguration PluginConfiguration

Optional plugin configuration for auto-loading plugins.

options ConsoleWindowSystemOptions

Optional configuration options for system behavior.

registryConfiguration RegistryConfiguration

Optional registry configuration for persistent key-value storage.

Fields

Performance

Gets the performance tracker for monitoring frame rates and render times.

public PerformanceTracker Performance

Field Value

PerformanceTracker

Properties

ActiveWindow

Gets the currently active window, or null if no window is active.

public Window? ActiveWindow { get; }

Property Value

Window

Animations

Gets the animation manager for creating and controlling tweened animations.

public AnimationManager Animations { get; }

Property Value

AnimationManager

ConsoleDriver

Gets or sets the console driver used for low-level console operations.

public IConsoleDriver ConsoleDriver { get; set; }

Property Value

IConsoleDriver

DesktopBottomRight

Gets the bottom-right coordinate of the usable desktop area (excluding status bars).

public Point DesktopBottomRight { get; }

Property Value

Point

DesktopDimensions

Gets the dimensions of the usable desktop area (excluding status bars).

public Size DesktopDimensions { get; }

Property Value

Size

DesktopPortalService

Gets the desktop portal service for managing desktop-level overlay portals.

public DesktopPortalService DesktopPortalService { get; }

Property Value

DesktopPortalService

DesktopUpperLeft

Gets the upper-left coordinate of the usable desktop area (excluding status bars).

public Point DesktopUpperLeft { get; }

Property Value

Point

IsIdle

Gets a value indicating whether the input system is currently idle (no input for the configured threshold).

public bool IsIdle { get; }

Property Value

bool

IsRunning

Gets a value indicating whether the window system is currently running.

public bool IsRunning { get; }

Property Value

bool

LogService

Gets the library-managed logging service. Subscribe to LogAdded event or call GetRecentLogs() to access internal logs.

public ILogService LogService { get; }

Property Value

ILogService

ModalStateService

Gets the modal state service for managing modal window behavior.

public ModalStateService ModalStateService { get; }

Property Value

ModalStateService

NotificationStateService

Gets the notification state service for managing notifications and toasts.

public NotificationStateService NotificationStateService { get; }

Property Value

NotificationStateService

Options

Gets or sets the current console window system options.

public ConsoleWindowSystemOptions Options { get; set; }

Property Value

ConsoleWindowSystemOptions

PluginStateService

Gets the plugin state service for managing plugins and their contributions.

public PluginStateService PluginStateService { get; }

Property Value

PluginStateService

RegistryStateService

Gets the registry state service for persistent key-value storage. Null if no RegistryConfiguration was provided at construction.

public RegistryStateService? RegistryStateService { get; }

Property Value

RegistryStateService

StatusBarStateService

Gets the status bar state service for managing status bars and Start menu.

public StatusBarStateService StatusBarStateService { get; }

Property Value

StatusBarStateService

Theme

Gets the theme used for styling windows and controls. Use ThemeStateService.CurrentTheme or ThemeStateService.SetTheme() for theme management.

public ITheme Theme { get; }

Property Value

ITheme

ThemeStateService

Gets the theme state service for managing theme application.

public ThemeStateService ThemeStateService { get; }

Property Value

ThemeStateService

WindowStateService

Gets the window state service for managing window lifecycle and state.

public WindowStateService WindowStateService { get; }

Property Value

WindowStateService

Windows

Gets a read-only dictionary of all windows in the system, keyed by their GUID.

public IReadOnlyDictionary<string, Window> Windows { get; }

Property Value

IReadOnlyDictionary<string, Window>

Methods

AddWindow(Window, bool)

Adds a window to the window system.

public Window AddWindow(Window window, bool activateWindow = true)

Parameters

window Window

The window to add.

activateWindow bool

Whether to activate the window after adding. Defaults to true.

Returns

Window

The added window.

CloseModalWindow(Window?)

Closes a modal window and optionally activates its parent window.

public void CloseModalWindow(Window? modalWindow)

Parameters

modalWindow Window

The modal window to close. If null or not a modal window, the method returns without action.

CloseWindow(Window?, bool, bool)

Closes a window and removes it from the window system.

public bool CloseWindow(Window? window, bool activateParent = true, bool force = false)

Parameters

window Window

The window to close. If null or not in the system, returns false.

activateParent bool

Whether to activate the parent window after closing. Defaults to true.

force bool

If true, forces the window to close even if IsClosable is false or OnClosing cancels.

Returns

bool

True if the window was closed successfully; false otherwise.

CycleActiveWindow()

Cycles to the next active window (Ctrl+T handler).

public void CycleActiveWindow()

EnqueueOnUIThread(Action)

Enqueues an action to be executed on the UI thread during the next main loop iteration. Safe to call from any thread. Actions run between input processing and rendering.

public void EnqueueOnUIThread(Action action)

Parameters

action Action

The action to execute on the UI thread.

GetWindowAtPoint(Point)

Finds the topmost window at the specified point.

public Window? GetWindowAtPoint(Point point)

Parameters

point Point

The point in absolute screen coordinates.

Returns

Window

The topmost window at the point, or null if none found.

ProcessOnce()

Processes one iteration of the main loop (input, display, cursor). This is useful for modal dialogs that need to block while still processing UI events.

public void ProcessOnce()

RequestExit(int)

Requests the window system to exit with the specified exit code.

public void RequestExit(int exitCode)

Parameters

exitCode int

Run()

Starts the main event loop of the window system. Blocks until Shutdown(int) is called.

public int Run()

Returns

int

The exit code set by Shutdown(int) or 1 if an unhandled exception occurred.

SetActiveWindow(Window)

Sets the specified window as the active window, handling modal window logic and focus.

public void SetActiveWindow(Window window)

Parameters

window Window

The window to activate. If null, the method returns without action.

Shutdown(int)

Gracefully shuts down the console window system with the specified exit code

public void Shutdown(int exitCode = 0)

Parameters

exitCode int

The exit code to return

Events

IdleStateChanged

Raised when the input idle state changes (idle started or ended).

public event EventHandler<IdleStateEventArgs>? IdleStateChanged

Event Type

EventHandler<IdleStateEventArgs>