Gui Class Reference

User-facing notification system for VS Code extension GUI integration. More...

Collaboration diagram for Gui:

Public Member Functions
	constructor (loggerInternals:LoggerInternals, fullyLoaded:boolean=false)
	Constructor for Gui logging class.

Detailed Description

User-facing notification system for VS Code extension GUI integration.

Implements the user interaction layer of the logging system, providing methods to display notifications, warnings, and errors directly in the VS Code interface. Features type-safe interactive buttons, consistent formatting, and appropriate visual styling for different message severity levels.

Notification Architecture:

• Information Messages: Blue notifications for status updates and confirmations
• Warning Messages: Yellow notifications for potential issues requiring attention
• Error Messages: Red notifications for critical failures requiring user action
• Debug Messages: Conditional notifications visible only in debug mode

Interactive Features:

• Template-based Buttons: Type-safe button definitions with compile-time checking
• User Response Handling: Thenable return values for button click processing
• Multiple Button Support: Unlimited interactive options per notification
• Consistent Styling: Automatic application of extension branding and formatting

Message Formatting: All notifications include automatic formatting with:

• Extension name prefix for brand recognition
• Timestamp integration for temporal context
• Log level indicators for severity classification
• Consistent visual styling across message types

User Experience Considerations:

• Non-intrusive: Notifications don't block user workflow
• Actionable: Interactive buttons provide clear user options
• Contextual: Messages include relevant information for user decision-making
• Accessible: Compatible with VS Code's accessibility features

Performance Characteristics:

• Asynchronous: All operations return promises for non-blocking behavior
• Lightweight: Minimal overhead for non-interactive notifications
• Conditional: Debug messages are filtered early when debug mode disabled

Definition at line 373 of file logger.ts.

Member Function Documentation

constructor()

Gui::constructor ( loggerInternals:LoggerInternals, fullyLoaded:boolean = false )

inline

Constructor for Gui logging class.

Parameters

loggerInternals	Shared logging utilities instance
depthSearch	Optional search depth (currently unused)

Initializes the GUI logger with shared utilities for consistent formatting and behavior across logging methods.

Definition at line 386 of file logger.ts.

---

The documentation for this class was generated from the following file:

• vscode/asperheader/src/modules/logger.ts