public static void End(Application.RunState runState, bool closeDriver = true)public static void End(Application.RunState runState)| The runstate returned by the Begin(Toplevel) method. | -||
| System.Boolean | -closeDriver | -If true, closes the application. If false closes the toplevels only. |
-
-Call this method once per instance (or after Shutdown(Boolean) has been called). +Call this method once per instance (or after Shutdown() has been called).
Loads the right ConsoleDriver for the platform. @@ -670,7 +665,7 @@ This will cause
public static void Run(Toplevel view, bool closeDriver = true)public static void Run(Toplevel view)| The Toplevel tu run modally. | -||
| System.Boolean | -closeDriver | -Set to |
-
This method is used to start processing events @@ -719,11 +709,11 @@ Runs the main loop on the given Views such as Dialog boxes.
- To make a Run(Toplevel, Boolean) stop execution, call RequestStop(). + To make a Run(Toplevel) stop execution, call RequestStop().
- Calling Run(Toplevel, Boolean) is equivalent to calling Begin(Toplevel), followed by RunLoop(Application.RunState, Boolean), - and then calling End(Application.RunState, Boolean). + Calling Run(Toplevel) is equivalent to calling Begin(Toplevel), followed by RunLoop(Application.RunState, Boolean), + and then calling End(Application.RunState).
Alternatively, to have a program control the main loop and @@ -738,13 +728,12 @@ Runs the main loop on the given
public static void Run<T>()
-
where T : Toplevel, new()public static void Shutdown(bool closeDriver = true)public static void Shutdown()| Type | -Name | -Description | -
|---|---|---|
| System.Boolean | -closeDriver | -trueCloses the application.falseCloses toplevels only. |
-
public override bool OnMouseEvent(MouseEvent mouseEvent)public override bool MouseEvent(MouseEvent me)| MouseEvent | -mouseEvent | +me |
public override void PositionCursor()+ After keys are sent to the subviews on the + current view, all the view are + processed and the key is passed to the views + to allow some of them to process the keystroke + as a cold-key.
++ This functionality is used, for example, by + default buttons to act on the enter key. + Processing this as a hot-key would prevent + non-default buttons from consuming the enter + keypress when they have the focus. +
++ Before keys are sent to the subview on the + current view, all the views are + processed and the key is passed to the widgets + to allow some of them to process the keystroke + as a hot-key.
++ For example, if you implement a button that + has a hotkey ok "o", you would catch the + combination Alt-o here. If the event is + caught, you must return true to stop the + keystroke from being dispatched to other + views. +
++ Views can override this method if they are + interested in processing the given keystroke. + If they consume the keystroke, they must + return true to stop the keystroke from being + processed by other widgets or consumed by the + widget engine. If they return false, the + keystroke will be passed using the ProcessColdKey + method to other views to process. +
++ The View implementation does nothing but return false, + so it is not necessary to call base.ProcessKey if you + derive directly from View, but you should if you derive + other View subclasses. +
+true, if the event was handled, false otherwise.+ Views can override this method if they are + interested in processing the given keystroke. + If they consume the keystroke, they must + return true to stop the keystroke from being + processed by other widgets or consumed by the + widget engine. If they return false, the + keystroke will be passed using the ProcessColdKey + method to other views to process. +
++ The View implementation does nothing but return false, + so it is not necessary to call base.ProcessKey if you + derive directly from View, but you should if you derive + other View subclasses. +
++ Always use Bounds (view-relative) when calling Redraw(Rect), NOT Frame (superview-relative). +
++ Views should set the color that they want to use on entry, as otherwise this will inherit + the last color that was set globally on the driver. +
+
+ Overrides of Redraw(Rect) must ensure they do not set Driver.Clip to a clip region
+ larger than the region parameter.
+
true, if the event was handled, false otherwise.true, if the event was handled, false otherwise.true, if the event was handled, false otherwise.+ Views can override this method if they are + interested in processing the given keystroke. + If they consume the keystroke, they must + return true to stop the keystroke from being + processed by other widgets or consumed by the + widget engine. If they return false, the + keystroke will be passed using the ProcessColdKey + method to other views to process. +
++ The View implementation does nothing but return false, + so it is not necessary to call base.ProcessKey if you + derive directly from View, but you should if you derive + other View subclasses. +
++ Always use Bounds (view-relative) when calling Redraw(Rect), NOT Frame (superview-relative). +
++ Views should set the color that they want to use on entry, as otherwise this will inherit + the last color that was set globally on the driver. +
+
+ Overrides of Redraw(Rect) must ensure they do not set Driver.Clip to a clip region
+ larger than the region parameter.
+
true, if the event was handled, false otherwise.| Keys | Function |
|---|---|
| Delete, Backspace | Deletes the character before cursor. |
+ Views can override this method if they are + interested in processing the given keystroke. + If they consume the keystroke, they must + return true to stop the keystroke from being + processed by other widgets or consumed by the + widget engine. If they return false, the + keystroke will be passed using the ProcessColdKey + method to other views to process. +
++ The View implementation does nothing but return false, + so it is not necessary to call base.ProcessKey if you + derive directly from View, but you should if you derive + other View subclasses. +
++
+ Always use Bounds (view-relative) when calling Redraw(Rect), NOT Frame (superview-relative). +
++ Views should set the color that they want to use on entry, as otherwise this will inherit + the last color that was set globally on the driver. +
+
+ Overrides of Redraw(Rect) must ensure they do not set Driver.Clip to a clip region
+ larger than the region parameter.
+
+ Change the Frame when using the Absolute layout style to move or resize views. +
++ Altering the Frame of a view will trigger the redrawing of the + view as well as the redrawing of the affected regions of the SuperView. +
++ Views can override this method if they are + interested in processing the given keystroke. + If they consume the keystroke, they must + return true to stop the keystroke from being + processed by other widgets or consumed by the + widget engine. If they return false, the + keystroke will be passed using the ProcessColdKey + method to other views to process. +
++ The View implementation does nothing but return false, + so it is not necessary to call base.ProcessKey if you + derive directly from View, but you should if you derive + other View subclasses. +
++ Always use Bounds (view-relative) when calling Redraw(Rect), NOT Frame (superview-relative). +
++ Views should set the color that they want to use on entry, as otherwise this will inherit + the last color that was set globally on the driver. +
+
+ Overrides of Redraw(Rect) must ensure they do not set Driver.Clip to a clip region
+ larger than the region parameter.
+
+ The View will be created using Computed + coordinates with the given string. The initial size (Frame will be + adjusted to fit the contents of Text, including newlines ('\n') for multiple lines. +
+
+ If Height is greater than one, word wrapping is provided.
+
+ The View will be created at the given + coordinates with the given string. The size (Frame will be + adjusted to fit the contents of Text, including newlines ('\n') for multiple lines. +
++ No line wrapping is provided. +
+frame parameter.
++ The View will be created at the given + coordinates with the given string. The initial size (Frame will be + adjusted to fit the contents of Text, including newlines ('\n') for multiple lines. +
+
+ If rect.Height is greater than one, word wrapping is provided.
+
true, if the event was handled, false otherwise.true, if the event was handled, false otherwise.public override bool OnMouseEnter(MouseEvent mouseEvent)public override bool OnLeave(View view)| MouseEvent | -mouseEvent | -+ | View | +view | +The view that is getting focus. |
true, if the event was handled, false otherwise.+ Views can override this method if they are + interested in processing the given keystroke. + If they consume the keystroke, they must + return true to stop the keystroke from being + processed by other widgets or consumed by the + widget engine. If they return false, the + keystroke will be passed using the ProcessColdKey + method to other views to process. +
++ The View implementation does nothing but return false, + so it is not necessary to call base.ProcessKey if you + derive directly from View, but you should if you derive + other View subclasses. +
++ Always use Bounds (view-relative) when calling Redraw(Rect), NOT Frame (superview-relative). +
++ Views should set the color that they want to use on entry, as otherwise this will inherit + the last color that was set globally on the driver. +
+
+ Overrides of Redraw(Rect) must ensure they do not set Driver.Clip to a clip region
+ larger than the region parameter.
+
true, if the event was handled, false otherwise.true, if the event was handled, false otherwise.+ Before keys are sent to the subview on the + current view, all the views are + processed and the key is passed to the widgets + to allow some of them to process the keystroke + as a hot-key.
++ For example, if you implement a button that + has a hotkey ok "o", you would catch the + combination Alt-o here. If the event is + caught, you must return true to stop the + keystroke from being dispatched to other + views. +
++ Views can override this method if they are + interested in processing the given keystroke. + If they consume the keystroke, they must + return true to stop the keystroke from being + processed by other widgets or consumed by the + widget engine. If they return false, the + keystroke will be passed using the ProcessColdKey + method to other views to process. +
++ The View implementation does nothing but return false, + so it is not necessary to call base.ProcessKey if you + derive directly from View, but you should if you derive + other View subclasses. +
++ Always use Bounds (view-relative) when calling Redraw(Rect), NOT Frame (superview-relative). +
++ Views should set the color that they want to use on entry, as otherwise this will inherit + the last color that was set globally on the driver. +
+
+ Overrides of Redraw(Rect) must ensure they do not set Driver.Clip to a clip region
+ larger than the region parameter.
+
public MenuBarItem(ustring title, string help, Action action, Func<bool> canExecute = null)public MenuBarItem(ustring title, ustring help, Action action, Func<bool> canExecute = null, MenuItem parent = null)| Title for the menu item. | |||
| System.String | +NStack.ustring | help | Help text to display. |
| System.Func<System.Boolean> | canExecute | -Function to determine if the action can currently be executred. | +Function to determine if the action can currently be executed. | +
| MenuItem | +parent | +The parent MenuItem of this if exist, otherwise is null. |
public MenuBarItem(ustring title, MenuItem[] children)public MenuBarItem(ustring title, MenuItem[] children, MenuItem parent = null)| children | The items in the current menu. | +|
| MenuItem | +parent | +The parent MenuItem of this if exist, otherwise is null. | +
public int GetChildrenIndex(MenuItem children)| Type | +Name | +Description | +
|---|---|---|
| MenuItem | +children | ++ |
| Type | +Description | +
|---|---|
| System.Int32 | +Returns a value bigger than -1 if the MenuItem is a child of this. | +
public bool IsSubMenuOf(MenuItem menuItem)| Type | +Name | +Description | +
|---|---|---|
| MenuItem | +menuItem | ++ |
| Type | +Description | +
|---|---|
| System.Boolean | +Returns true if it is a child of this. false otherwise. |
+
public MenuBarItem SubMenu(MenuItem children)| Type | +Name | +Description | +
|---|---|---|
| MenuItem | +children | ++ |
| Type | +Description | +
|---|---|
| MenuBarItem | +Returns a MenuBarItem or null otherwise. | +
public MenuItem(ustring title, string help, Action action, Func<bool> canExecute = null)public MenuItem(ustring title, ustring help, Action action, Func<bool> canExecute = null, MenuItem parent = null)| Title for the menu item. | |||
| System.String | +NStack.ustring | help | Help text to display. |
| System.Func<System.Boolean> | canExecute | -Function to determine if the action can currently be executred. | -
public MenuItem(ustring title, MenuBarItem subMenu)| Type | -Name | -Description | -|||
|---|---|---|---|---|---|
| NStack.ustring | -title | -Title for the menu item. | +Function to determine if the action can currently be executed. | ||
| MenuBarItem | -subMenu | -The menu sub-menu. | +MenuItem | +parent | +The parent of this menu item. |
public MenuItem Parent { get; }| Type | +Description | +
|---|---|
| MenuItem | +The parent. | +
+ Always use Bounds (view-relative) when calling Redraw(Rect), NOT Frame (superview-relative). +
++ Views should set the color that they want to use on entry, as otherwise this will inherit + the last color that was set globally on the driver. +
+
+ Overrides of Redraw(Rect) must ensure they do not set Driver.Clip to a clip region
+ larger than the region parameter.
+
public int Cursor { get; set; }public DisplayModeLayout DisplayMode { get; set; }| Type | +Description | +
|---|---|
| DisplayModeLayout | ++ |
public int HorizontalSpace { get; set; }+ After keys are sent to the subviews on the + current view, all the view are + processed and the key is passed to the views + to allow some of them to process the keystroke + as a cold-key.
++ This functionality is used, for example, by + default buttons to act on the enter key. + Processing this as a hot-key would prevent + non-default buttons from consuming the enter + keypress when they have the focus. +
++ Views can override this method if they are + interested in processing the given keystroke. + If they consume the keystroke, they must + return true to stop the keystroke from being + processed by other widgets or consumed by the + widget engine. If they return false, the + keystroke will be passed using the ProcessColdKey + method to other views to process. +
++ The View implementation does nothing but return false, + so it is not necessary to call base.ProcessKey if you + derive directly from View, but you should if you derive + other View subclasses. +
++ Always use Bounds (view-relative) when calling Redraw(Rect), NOT Frame (superview-relative). +
++ Views should set the color that they want to use on entry, as otherwise this will inherit + the last color that was set globally on the driver. +
+
+ Overrides of Redraw(Rect) must ensure they do not set Driver.Clip to a clip region
+ larger than the region parameter.
+
true, if the event was handled, false otherwise.+ Always use Bounds (view-relative) when calling Redraw(Rect), NOT Frame (superview-relative). +
++ Views should set the color that they want to use on entry, as otherwise this will inherit + the last color that was set globally on the driver. +
+
+ Overrides of Redraw(Rect) must ensure they do not set Driver.Clip to a clip region
+ larger than the region parameter.
+
true if show vertical scroll indicator; otherwise, false.true if show horizontal scroll indicator; otherwise, false.true, if the event was handled, false otherwise.+ Views can override this method if they are + interested in processing the given keystroke. + If they consume the keystroke, they must + return true to stop the keystroke from being + processed by other widgets or consumed by the + widget engine. If they return false, the + keystroke will be passed using the ProcessColdKey + method to other views to process. +
++ The View implementation does nothing but return false, + so it is not necessary to call base.ProcessKey if you + derive directly from View, but you should if you derive + other View subclasses. +
++ Always use Bounds (view-relative) when calling Redraw(Rect), NOT Frame (superview-relative). +
++ Views should set the color that they want to use on entry, as otherwise this will inherit + the last color that was set globally on the driver. +
+
+ Overrides of Redraw(Rect) must ensure they do not set Driver.Clip to a clip region
+ larger than the region parameter.
+
true, if the event was handled, false otherwise.+ Before keys are sent to the subview on the + current view, all the views are + processed and the key is passed to the widgets + to allow some of them to process the keystroke + as a hot-key.
++ For example, if you implement a button that + has a hotkey ok "o", you would catch the + combination Alt-o here. If the event is + caught, you must return true to stop the + keystroke from being dispatched to other + views. +
++ Always use Bounds (view-relative) when calling Redraw(Rect), NOT Frame (superview-relative). +
++ Views should set the color that they want to use on entry, as otherwise this will inherit + the last color that was set globally on the driver. +
+
+ Overrides of Redraw(Rect) must ensure they do not set Driver.Clip to a clip region
+ larger than the region parameter.
+
true if can focus; otherwise, false.+ Change the Frame when using the Absolute layout style to move or resize views. +
++ Altering the Frame of a view will trigger the redrawing of the + view as well as the redrawing of the affected regions of the SuperView. +
+true, if the event was handled, false otherwise.true, if the event was handled, false otherwise.+ Always use Bounds (view-relative) when calling Redraw(Rect), NOT Frame (superview-relative). +
++ Views should set the color that they want to use on entry, as otherwise this will inherit + the last color that was set globally on the driver. +
+
+ Overrides of Redraw(Rect) must ensure they do not set Driver.Clip to a clip region
+ larger than the region parameter.
+
true if can focus; otherwise, false.true, if the event was handled, false otherwise.+ Views can override this method if they are + interested in processing the given keystroke. + If they consume the keystroke, they must + return true to stop the keystroke from being + processed by other widgets or consumed by the + widget engine. If they return false, the + keystroke will be passed using the ProcessColdKey + method to other views to process. +
++ The View implementation does nothing but return false, + so it is not necessary to call base.ProcessKey if you + derive directly from View, but you should if you derive + other View subclasses. +
++ Always use Bounds (view-relative) when calling Redraw(Rect), NOT Frame (superview-relative). +
++ Views should set the color that they want to use on entry, as otherwise this will inherit + the last color that was set globally on the driver. +
+
+ Overrides of Redraw(Rect) must ensure they do not set Driver.Clip to a clip region
+ larger than the region parameter.
+
true, if the event was handled, false otherwise.| Keys | Function |
|---|---|
| Delete, Backspace | Deletes the character before cursor. |
- Toplevels can be modally executing views, started by calling Run(Toplevel, Boolean). + Toplevels can be modally executing views, started by calling Run(Toplevel). They return control to the caller when RequestStop() has been called (which sets the Running property to false).
@@ -392,7 +395,7 @@ Toplevel views can be modally executed. A Toplevel is created when an application initialzies Terminal.Gui by callling Init(ConsoleDriver, IMainLoopDriver). The application Toplevel can be accessed via Top. Additional Toplevels can be created and run (e.g. Dialogs. To run a Toplevel, create the Toplevel and - call Run(Toplevel, Boolean). + call Run(Toplevel).Toplevels can also opt-in to more sophisticated initialization @@ -632,7 +635,9 @@ Gets or sets the status bar for this Toplevel
+ Views can override this method if they are + interested in processing the given keystroke. + If they consume the keystroke, they must + return true to stop the keystroke from being + processed by other widgets or consumed by the + widget engine. If they return false, the + keystroke will be passed using the ProcessColdKey + method to other views to process. +
++ The View implementation does nothing but return false, + so it is not necessary to call base.ProcessKey if you + derive directly from View, but you should if you derive + other View subclasses. +
++ Always use Bounds (view-relative) when calling Redraw(Rect), NOT Frame (superview-relative). +
++ Views should set the color that they want to use on entry, as otherwise this will inherit + the last color that was set globally on the driver. +
+
+ Overrides of Redraw(Rect) must ensure they do not set Driver.Clip to a clip region
+ larger than the region parameter.
+
true if can focus; otherwise, false.true if has focus; otherwise, false.public bool Visible { get; set; }| Type | +Description | +
|---|---|
| System.Boolean | ++ |
true, if the event was handled, false otherwise.true, if the event was handled, false otherwise.true, if the event was handled, false otherwise.true, if the event was handled, false otherwise.+ After keys are sent to the subviews on the + current view, all the view are + processed and the key is passed to the views + to allow some of them to process the keystroke + as a cold-key.
++ This functionality is used, for example, by + default buttons to act on the enter key. + Processing this as a hot-key would prevent + non-default buttons from consuming the enter + keypress when they have the focus. +
++ Before keys are sent to the subview on the + current view, all the views are + processed and the key is passed to the widgets + to allow some of them to process the keystroke + as a hot-key.
++ For example, if you implement a button that + has a hotkey ok "o", you would catch the + combination Alt-o here. If the event is + caught, you must return true to stop the + keystroke from being dispatched to other + views. +
++ Views can override this method if they are + interested in processing the given keystroke. + If they consume the keystroke, they must + return true to stop the keystroke from being + processed by other widgets or consumed by the + widget engine. If they return false, the + keystroke will be passed using the ProcessColdKey + method to other views to process. +
++ The View implementation does nothing but return false, + so it is not necessary to call base.ProcessKey if you + derive directly from View, but you should if you derive + other View subclasses. +
+Views should set the color that they want to use on entry, as otherwise this will inherit - the last color that was set coglobally on the driver. + the last color that was set globally on the driver.
Overrides of Redraw(Rect) must ensure they do not set Driver.Clip to a clip region
@@ -2980,32 +3094,15 @@ Sets the clip region to the specified view-relative region.
-
public void SetFocus(View view)public void SetFocus()| Type | -Name | -Description | -
|---|---|---|
| View | -view | -View. | -
true, if the event was handled, false otherwise.+ Always use Bounds (view-relative) when calling Redraw(Rect), NOT Frame (superview-relative). +
++ Views should set the color that they want to use on entry, as otherwise this will inherit + the last color that was set globally on the driver. +
+
+ Overrides of Redraw(Rect) must ensure they do not set Driver.Clip to a clip region
+ larger than the region parameter.
+
+
+
+
Overrides that do not call the base.Run(), must call Shutdown(Boolean) before returning.
+Overrides that do not call the base.Run(), must call Shutdown() before returning.
+
Base class for each demo/scenario.
@@ -107,6 +111,12 @@ ListViews. Press ENTER to run the selected scenario. Press CTRL-Q to exit it.
UI Catalog is a comprehensive sample app and scenario library for Terminal.Gui