diff --git a/docfx/docs/migratingfromv1.md b/docfx/docs/migratingfromv1.md index 6677b0987..292368be2 100644 --- a/docfx/docs/migratingfromv1.md +++ b/docfx/docs/migratingfromv1.md @@ -81,7 +81,7 @@ When measuring the screen space taken up by a `string` you can use the extension + myString.GetColumns(); ``` -## `View Life Cycle Management +## View Life Cycle Management In v1, @Terminal.Gui.View was derived from `Responder` which supported `IDisposable`. In v2, `Responder` has been removed and @Terminal.Gui.View is the base-class supporting `IDisposable`. @@ -187,7 +187,7 @@ The API for handling keyboard input is significantly improved. See [Keyboard API + Application.KeyDown(object? sender, Key e) ``` -## **@"Terminal.Gui.Input.Command" has been expanded and simplified +## @Terminal.Gui.Input.Command has been expanded and simplified In v1, the `Command` enum had duplicate entries and inconsistent naming. In v2 it has been both expanded and simplified. @@ -306,7 +306,7 @@ In v2, this is made consistent and configurable: - `Key.CursorDown` - Operates identically to `Application.NextTabStopKey`. - `Key.CursorLeft` - Operates identically to `Application.PrevTabStopKey`. - `Key.CursorUp` - Operates identically to `Application.PrevTabStopKey`. -- `Application.NextTabGroupKey` (`Key.F6`) - Navigates to the next view in the view-hierarchy that is a `TabGroup` (see below). If there is no next, the first view which is a `TabGroup`` will gain focus. +- `Application.NextTabGroupKey` (`Key.F6`) - Navigates to the next view in the view-hierarchy that is a `TabGroup` (see below). If there is no next, the first view which is a `TabGroup` will gain focus. - `Application.PrevTabGroupKey` (`Key.F6.WithShift`) - Opposite of `Application.NextTabGroupKey`. `F6` was chosen to match [Windows](https://learn.microsoft.com/en-us/windows/apps/design/input/keyboard-accelerators#common-keyboard-accelerators) @@ -336,7 +336,7 @@ Alternatively, if you want to have key events as well as mouse events to fire an Previously events in Terminal.Gui used a mixture of `Action` (no arguments), `Action` (or other raw datatype) and `Action`. Now all events use the `EventHandler` [standard .net design pattern](https://learn.microsoft.com/en-us/dotnet/csharp/event-pattern#event-delegate-signatures). -For example, `event Action` TimeoutAdded` has become `event EventHandler TimeoutAdded` +For example, `event Action TimeoutAdded` has become `event EventHandler TimeoutAdded` This change was made for the following reasons: @@ -516,4 +516,4 @@ new ( * In v1, `Application.End` called `Dispose ()` on @Terminal.Gui.App.Application.Top (via `Runstate.Toplevel`). This was incorrect as it meant that after `Application.Run` returned, `Application.Top` had been disposed, and any code that wanted to interrogate the results of `Run` by accessing `Application.Top` only worked by accident. This is because GC had not actually happened; if it had the application would have crashed. In v2 `Application.End` does NOT call `Dispose`, and it is the caller to `Application.Run` who is responsible for disposing the `Toplevel` that was either passed to `Application.Run (View)` or created by `Application.Run ()`. -* Any code that creates a `Toplevel`, either by using `top = new()` or by calling either `top = Application.Run ()` or `top = ApplicationRun()` must call `top.Dispose` when complete. The exception to this is if `top` is passed to `myView.Add(top)` making it a subview of `myView`. This is because the semantics of `Add` are that the `myView` takes over responsibility for the subviews lifetimes. Of course, if someone calls `myView.Remove(top)` to remove said subview, they then re-take responsbility for `top`'s lifetime and they must call `top.Dispose`. \ No newline at end of file +* Any code that creates a `Toplevel`, either by using `top = new()` or by calling either `top = Application.Run ()` or `top = ApplicationRun()` must call `top.Dispose` when complete. The exception to this is if `top` is passed to `myView.Add(top)` making it a subview of `myView`. This is because the semantics of `Add` are that the `myView` takes over responsibility for the subviews lifetimes. Of course, if someone calls `myView.Remove(top)` to remove said subview, they then re-take responsbility for `top`'s lifetime and they must call `top.Dispose`.