Git_Mirror/Terminal.Gui
1
0
Fork 0
mirror of https://github.com/gui-cs/Terminal.Gui.git synced 2026-01-02 01:03:29 +01:00
Code Issues Packages Projects Releases Wiki Activity

Fixes #4425 - ApplicationImpl internal (#4426)

Browse Source 
* Pulled from v2_release

* Refactor migration guide for Terminal.Gui v2

Restructured and expanded the migration guide to provide a comprehensive resource for transitioning from Terminal.Gui v1 to v2. Key updates include:

- Added a Table of Contents for easier navigation.
- Summarized major architectural changes in v2, including the instance-based application model, IRunnable architecture, and 24-bit TrueColor support.
- Updated examples to reflect new patterns, such as initializers replacing constructors and explicit disposal using `IDisposable`.
- Documented changes to the layout system, including the removal of `Absolute`/`Computed` styles and the introduction of `Viewport`.
- Standardized event patterns to use `object sender, EventArgs args`.
- Detailed updates to the Keyboard, Mouse, and Navigation APIs, including configurable key bindings and viewport-relative mouse coordinates.
- Replaced legacy components like `ScrollView` and `ContextMenu` with built-in scrolling and `PopoverMenu`.
- Clarified disposal rules and introduced best practices for resource management.
- Provided a complete migration example and a summary of breaking changes.

This update aims to simplify the migration process by addressing breaking changes, introducing new features, and aligning with modern .NET conventions.

* Refactor to use Application.Instance for lifecycle management

Replaced all occurrences of `ApplicationImpl.Instance` with the new `Application.Instance` property across the codebase to align with the updated application lifecycle model.

Encapsulated the `ApplicationImpl` class by making it `internal`, ensuring it is no longer directly accessible outside its assembly. Introduced the `[Obsolete]` `Application.Instance` property as a backward-compatible singleton for the legacy static `Application` model, while encouraging the use of `Application.Create()` for new code.

Updated `MessageBox` methods to use `Application.Instance` for consistent modal dialog management. Improved documentation to reflect these changes and emphasize the transition to the instance-based application model.

Performed code cleanup in multiple classes to ensure consistency and maintainability. These changes maintain backward compatibility while preparing the codebase for the eventual removal of the legacy `ApplicationImpl` class.

* Fix doc bug

* - Removed obsolete `.cd` class diagram files.
- Introduced `IRunnable` interface for decoupling component execution.
- Added fluent API for running dialogs and retrieving results.
- Enhanced `View` with `App` and `Driver` properties for better decoupling.
- Improved testability with support for mock and real applications.
- Implemented `IDisposable` for proper resource cleanup.
- Replaced `RunnableSessionStack` with `SessionStack` for session management.
- Updated driver architecture to align with the new model.
- Scoped `IKeyboard` to application contexts for modularity.
- Updated documentation with migration strategies and best practices.

These changes modernize the library, improve maintainability, and align with current development practices.
This commit is contained in:
Tig
2025-12-01 14:40:31 -07:00
committed by GitHub
parent 8e92327dbe
commit 0f72cf8a74
34 changed files with 278 additions and 833 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
Examples/UICatalog/Scenarios/CsvEditor.cs
View File

@@ -215,7 +215,7 @@ public class CsvEditor : Scenario
_tableView.Table.Columns
);
int? result = MessageBox.Query (ApplicationImpl.Instance,
int? result = MessageBox.Query (Application.Instance,
"Column Type",
"Pick a data type for the column",
"Date",
@@ -308,7 +308,7 @@ public class CsvEditor : Scenario
if (_tableView.SelectedColumn == -1)
{
MessageBox.ErrorQuery (ApplicationImpl.Instance, "No Column", "No column selected", "Ok");
MessageBox.ErrorQuery (Application.Instance, "No Column", "No column selected", "Ok");
return;
}
@@ -320,7 +320,7 @@ public class CsvEditor : Scenario
}
catch (Exception ex)
{
MessageBox.ErrorQuery (ApplicationImpl.Instance, "Could not remove column", ex.Message, "Ok");
MessageBox.ErrorQuery (Application.Instance, "Could not remove column", ex.Message, "Ok");
}
}
@@ -342,7 +342,7 @@ public class CsvEditor : Scenario
}
catch (Exception ex)
{
MessageBox.ErrorQuery (ApplicationImpl.Instance, 60, 20, "Failed to set text", ex.Message, "Ok");
MessageBox.ErrorQuery (Application.Instance, 60, 20, "Failed to set text", ex.Message, "Ok");
}
_tableView.Update ();
@@ -388,7 +388,7 @@ public class CsvEditor : Scenario
if (_tableView.SelectedColumn == -1)
{
MessageBox.ErrorQuery (ApplicationImpl.Instance, "No Column", "No column selected", "Ok");
MessageBox.ErrorQuery (Application.Instance, "No Column", "No column selected", "Ok");
return;
}
@@ -413,7 +413,7 @@ public class CsvEditor : Scenario
}
catch (Exception ex)
{
MessageBox.ErrorQuery (ApplicationImpl.Instance, "Error moving column", ex.Message, "Ok");
MessageBox.ErrorQuery (Application.Instance, "Error moving column", ex.Message, "Ok");
}
}
@@ -426,7 +426,7 @@ public class CsvEditor : Scenario
if (_tableView.SelectedRow == -1)
{
MessageBox.ErrorQuery (ApplicationImpl.Instance, "No Rows", "No row selected", "Ok");
MessageBox.ErrorQuery (Application.Instance, "No Rows", "No row selected", "Ok");
return;
}
@@ -462,7 +462,7 @@ public class CsvEditor : Scenario
}
catch (Exception ex)
{
MessageBox.ErrorQuery (ApplicationImpl.Instance, "Error moving column", ex.Message, "Ok");
MessageBox.ErrorQuery (Application.Instance, "Error moving column", ex.Message, "Ok");
}
}
@@ -470,7 +470,7 @@ public class CsvEditor : Scenario
{
if (_tableView?.Table is null)
{
MessageBox.ErrorQuery (ApplicationImpl.Instance, "No Table Loaded", "No table has currently be opened", "Ok");
MessageBox.ErrorQuery (Application.Instance, "No Table Loaded", "No table has currently be opened", "Ok");
return true;
}
@@ -582,7 +582,7 @@ public class CsvEditor : Scenario
}
catch (Exception ex)
{
MessageBox.ErrorQuery (ApplicationImpl.Instance,
MessageBox.ErrorQuery (Application.Instance,
"Open Failed",
$"Error on line {lineNumber}{Environment.NewLine}{ex.Message}",
"Ok"
@@ -612,7 +612,7 @@ public class CsvEditor : Scenario
{
if (_tableView?.Table is null || string.IsNullOrWhiteSpace (_currentFile) || _currentTable is null)
{
MessageBox.ErrorQuery (ApplicationImpl.Instance, "No file loaded", "No file is currently loaded", "Ok");
MessageBox.ErrorQuery (Application.Instance, "No file loaded", "No file is currently loaded", "Ok");
return;
}
@@ -674,7 +674,7 @@ public class CsvEditor : Scenario
if (col.DataType == typeof (string))
{
MessageBox.ErrorQuery (ApplicationImpl.Instance,
MessageBox.ErrorQuery (Application.Instance,
"Cannot Format Column",
"String columns cannot be Formatted, try adding a new column to the table with a date/numerical Type",
"Ok"
@@ -711,7 +711,7 @@ public class CsvEditor : Scenario
if (_tableView.SelectedColumn == -1)
{
MessageBox.ErrorQuery (ApplicationImpl.Instance, "No Column", "No column selected", "Ok");
MessageBox.ErrorQuery (Application.Instance, "No Column", "No column selected", "Ok");
return;
}