|
@@ -433,14 +433,14 @@ namespace Terminal.Gui {
|
|
|
/// <summary>
|
|
|
/// Building block API: Prepares the provided <see cref="Toplevel"/> for execution.
|
|
|
/// </summary>
|
|
|
- /// <returns>The runstate handle that needs to be passed to the <see cref="End(RunState, bool)"/> method upon completion.</returns>
|
|
|
+ /// <returns>The runstate handle that needs to be passed to the <see cref="End(RunState)"/> method upon completion.</returns>
|
|
|
/// <param name="toplevel">Toplevel to prepare execution for.</param>
|
|
|
/// <remarks>
|
|
|
/// This method prepares the provided toplevel for running with the focus,
|
|
|
/// it adds this to the list of toplevels, sets up the mainloop to process the
|
|
|
/// event, lays out the subviews, focuses the first element, and draws the
|
|
|
/// toplevel in the screen. This is usually followed by executing
|
|
|
- /// the <see cref="RunLoop"/> method, and then the <see cref="End(RunState, bool)"/> method upon termination which will
|
|
|
+ /// the <see cref="RunLoop"/> method, and then the <see cref="End(RunState)"/> method upon termination which will
|
|
|
/// undo these changes.
|
|
|
/// </remarks>
|
|
|
public static RunState Begin (Toplevel toplevel)
|
|
@@ -477,7 +477,6 @@ namespace Terminal.Gui {
|
|
|
/// Building block API: completes the execution of a <see cref="Toplevel"/> that was started with <see cref="Begin(Toplevel)"/> .
|
|
|
/// </summary>
|
|
|
/// <param name="runState">The runstate returned by the <see cref="Begin(Toplevel)"/> method.</param>
|
|
|
- /// <param name="closeDriver">If <c>true</c>, closes the application. If <c>false</c> closes the toplevels only.</param>
|
|
|
public static void End (RunState runState)
|
|
|
{
|
|
|
if (runState == null)
|
|
@@ -489,7 +488,6 @@ namespace Terminal.Gui {
|
|
|
/// <summary>
|
|
|
/// Shutdown an application initialized with <see cref="Init(ConsoleDriver, IMainLoopDriver)"/>
|
|
|
/// </summary>
|
|
|
- /// <param name="closeDriver"><c>true</c>Closes the application.<c>false</c>Closes toplevels only.</param>
|
|
|
public static void Shutdown ()
|
|
|
{
|
|
|
// Shutdown is the bookend for Init. As such it needs to clean up all resources
|
|
@@ -615,7 +613,7 @@ namespace Terminal.Gui {
|
|
|
}
|
|
|
|
|
|
/// <summary>
|
|
|
- /// Runs the application by calling <see cref="Run(Toplevel, bool)"/> with the value of <see cref="Top"/>
|
|
|
+ /// Runs the application by calling <see cref="Run(Toplevel)"/> with the value of <see cref="Top"/>
|
|
|
/// </summary>
|
|
|
public static void Run ()
|
|
|
{
|
|
@@ -623,7 +621,7 @@ namespace Terminal.Gui {
|
|
|
}
|
|
|
|
|
|
/// <summary>
|
|
|
- /// Runs the application by calling <see cref="Run(Toplevel, bool)"/> with a new instance of the specified <see cref="Toplevel"/>-derived class
|
|
|
+ /// Runs the application by calling <see cref="Run(Toplevel)"/> with a new instance of the specified <see cref="Toplevel"/>-derived class
|
|
|
/// </summary>
|
|
|
public static void Run<T> () where T : Toplevel, new()
|
|
|
{
|
|
@@ -641,11 +639,11 @@ namespace Terminal.Gui {
|
|
|
/// run other modal <see cref="View"/>s such as <see cref="Dialog"/> boxes.
|
|
|
/// </para>
|
|
|
/// <para>
|
|
|
- /// To make a <see cref="Run(Toplevel, bool)"/> stop execution, call <see cref="Application.RequestStop"/>.
|
|
|
+ /// To make a <see cref="Run(Toplevel)"/> stop execution, call <see cref="Application.RequestStop"/>.
|
|
|
/// </para>
|
|
|
/// <para>
|
|
|
- /// Calling <see cref="Run(Toplevel, bool)"/> is equivalent to calling <see cref="Begin(Toplevel)"/>, followed by <see cref="RunLoop(RunState, bool)"/>,
|
|
|
- /// and then calling <see cref="End(RunState, bool)"/>.
|
|
|
+ /// Calling <see cref="Run(Toplevel)"/> is equivalent to calling <see cref="Begin(Toplevel)"/>, followed by <see cref="RunLoop(RunState, bool)"/>,
|
|
|
+ /// and then calling <see cref="End(RunState)"/>.
|
|
|
/// </para>
|
|
|
/// <para>
|
|
|
/// Alternatively, to have a program control the main loop and
|
|
@@ -656,7 +654,6 @@ namespace Terminal.Gui {
|
|
|
/// </para>
|
|
|
/// </remarks>
|
|
|
/// <param name="view">The <see cref="Toplevel"/> tu run modally.</param>
|
|
|
- /// <param name="closeDriver">Set to <true/> to cause the MainLoop to end when <see cref="End(RunState, bool)"/> is called, clsing the toplevels only.</param>
|
|
|
public static void Run (Toplevel view)
|
|
|
{
|
|
|
var runToken = Begin (view);
|