diff --git a/Terminal.Gui/Directory.Build.props b/Terminal.Gui/Directory.Build.props
index c549feaa8..b17add919 100644
--- a/Terminal.Gui/Directory.Build.props
+++ b/Terminal.Gui/Directory.Build.props
@@ -14,9 +14,9 @@
e.g. If AssemblyVersion is 1.2.3.4, Version could be EITHER 1.2.3.4 or 1.2.3-pre.4 depending on whether it's a pre-release or not.
-->
- 1.0.0-pre.5
- 1.0.0.5
- 1.0.0.5
+ 1.0.0-pre.6
+ 1.0.0.6
+ 1.0.0.6Miguel de Icaza, Charlie Kindel (@tig), @BDisp
diff --git a/Terminal.Gui/Terminal.Gui.csproj b/Terminal.Gui/Terminal.Gui.csproj
index 0b0dbe162..b732d1c84 100644
--- a/Terminal.Gui/Terminal.Gui.csproj
+++ b/Terminal.Gui/Terminal.Gui.csproj
@@ -22,11 +22,32 @@
Application framework for creating modern console applications using .NETTerminal.Gui is a framework for creating console user interfaces
- v1.00 -
+ v1.0.0-pre.6
* If StatusBar.Visible is set to false, TopLevel resizes correctly enabling hiding/showing of a StatusBar. UICatalog demonstrates.
* New sample/demo app - ReactiveExample - Shows how to use reactive extensions and ReactiveUI with gui.cs. (Thanks @worldbeater)
* BREAKING API CHANGE - Removed IEnumerable from View and Window. Use Subviews property instead. See #950.
-
+ * Fixes #998. Added a cancelable TextChanging event to prevent the TextChanged event being called if the changing is canceled.
+ * Fixes #1002. Added a AutoSize property to the View class.
+ * Fixes #1009. AutoHideScrollBars is causing ScrollView always redrawing.
+ * Update to .NET 5 RTM
+ * Fixes #995. Improving TextField to work properly with Unicode characters
+ * Fixes #999. Toplevel should only redraw the subviews if !NeedDisplay.IsEmpty or layoutNeeded.
+ * Fixes #992. TextFormatter class now respect the view dimensions. Some typo fixing too.
+ * Fixes #990. Pos and Dim only can be properly used when all the views are totally initialized.
+ * Fixes #979. Force call LayoutSubviews to perform layout.
+ * Fixes #988. Update NStack.Core to version 0.15.0
+ * Fixes #41 and #949. Unit test to compare the difference between System.Rune and System.Text.Rune.
+ * Fixes #881, #928. Allowing more key combinations.
+ * Fixes #976. Mouse prints sequence characters on the terminal and the screen is not fully cleared. Only for netcoreapp3.1.
+ * BREAKING API CHANGE - #950 - Remove IEnumerable from View and Window
+ * Fixes #959. CursorPosition with hotkeys.
+ * Fixes #963. Added support for Unicode in TextField.
+ * Fixes #961. Recreates the Frame when necessary.
+ * Fixes #957. Terminal.Gui nuget package in Reactive example version.
+ * Fixes #933. Updated to work with libncurses 6.2
+ * Fixes #225 and maybe #41. Allowing Rune.ColumnWidth greater than one.
+ * Use glyphs for checkmarks and selection.
+
v0.90 - "Feature Complete" pre-release of Terminal.Gui (aka gui.cs) 1.0. This release is a signficant upgrade from the previous published release (0.81). Most of the major changes and bug fixes are listed below. NOTE: This release includes breaking changes to the API; we will strive to avoid any more breaking changes before 1.0.
What's new:
@@ -112,12 +133,12 @@
* ScrollView updated to use pretty glyphs. (Thanks @tig!)
* Menubar now uses pretty arrow glyph for sub-menus. (Thanks @tig!)
* View now has a Text property, implemented via the new TextFormatting class. (Thanks @tig!)
- * TextAlignment is implemented once across all Views that support it.
- * Unicode support is now much more robust and complete; dozens of bugs fixed.
- * Any view dervied from View now has a Text property with multi-line text formatting, including word-wrap and hotkey support.
- * Label is now mostly just an alias for View; supports Clicked
- * Button is now a very thin class derived from View (no API changes).
- * Dozens of unit tests for TextAlignment are provided reducing the chance of regressions.
+ * TextAlignment is implemented once across all Views that support it.
+ * Unicode support is now much more robust and complete; dozens of bugs fixed.
+ * Any view dervied from View now has a Text property with multi-line text formatting, including word-wrap and hotkey support.
+ * Label is now mostly just an alias for View; supports Clicked
+ * Button is now a very thin class derived from View (no API changes).
+ * Dozens of unit tests for TextAlignment are provided reducing the chance of regressions.
* Fixes #351. Added a horizontal display for RadioGroup. (Thanks @bidsp!)
* Fixes #644. Added a UICatalog Scenario for a dynamic menu bar. (Thanks @bidsp!)
* Fixes #838. Added a Visible property to the View. (Thanks @bidsp!)
diff --git a/docs/README.html b/docs/README.html
index b732397af..f352cdeb1 100644
--- a/docs/README.html
+++ b/docs/README.html
@@ -76,10 +76,9 @@
If docfx fails with a Stackoverflow error. Just run it again. And again. Sometimes it takes a few times. If that doesn't work, create a fresh clone or delete the docfx/api, docfx/obj, and docs/ folders and run the steps above again.
diff --git a/docs/api/Terminal.Gui/Terminal.Gui.Application.html b/docs/api/Terminal.Gui/Terminal.Gui.Application.html
index d5e2a08da..8be91e8a4 100644
--- a/docs/api/Terminal.Gui/Terminal.Gui.Application.html
+++ b/docs/api/Terminal.Gui/Terminal.Gui.Application.html
@@ -211,33 +211,6 @@ See also System.Threading.Timeout
-
Loaded
-
-This event is fired once when the application is first loaded. The dimensions of the
-terminal are provided.
-
-
-
Declaration
-
-
public static Action<Application.ResizedEventArgs> Loaded
Invoked when the terminal was resized. The new size of the terminal is provided.
diff --git a/docs/api/Terminal.Gui/Terminal.Gui.Button.html b/docs/api/Terminal.Gui/Terminal.Gui.Button.html
index ca4c4e386..42c06ea0e 100644
--- a/docs/api/Terminal.Gui/Terminal.Gui.Button.html
+++ b/docs/api/Terminal.Gui/Terminal.Gui.Button.html
@@ -129,6 +129,15 @@ Button is a View that provides
diff --git a/docs/api/Terminal.Gui/Terminal.Gui.Dialog.html b/docs/api/Terminal.Gui/Terminal.Gui.Dialog.html
index e397f0e36..d75490387 100644
--- a/docs/api/Terminal.Gui/Terminal.Gui.Dialog.html
+++ b/docs/api/Terminal.Gui/Terminal.Gui.Dialog.html
@@ -133,9 +133,15 @@ or more Buttons. It defaults
diff --git a/docs/api/Terminal.Gui/Terminal.Gui.FileDialog.html b/docs/api/Terminal.Gui/Terminal.Gui.FileDialog.html
index 17e71694c..ed6130df4 100644
--- a/docs/api/Terminal.Gui/Terminal.Gui.FileDialog.html
+++ b/docs/api/Terminal.Gui/Terminal.Gui.FileDialog.html
@@ -140,9 +140,15 @@ Base class for the OpenDialo
diff --git a/docs/api/Terminal.Gui/Terminal.Gui.Key.html b/docs/api/Terminal.Gui/Terminal.Gui.Key.html
index b5b234066..bdf8c422c 100644
--- a/docs/api/Terminal.Gui/Terminal.Gui.Key.html
+++ b/docs/api/Terminal.Gui/Terminal.Gui.Key.html
@@ -100,9 +100,12 @@ public enum Key : uint
If the SpecialMask is set, then the value is that of the special mask,
otherwise, the value is the one of the lower bits (as extracted by CharMask)
+
+ Numerics keys are the values between 48 and 57 corresponding to 0 to 9
+
- Control keys are the values between 1 and 26 corresponding to Control-A to Control-Z
+ Upper alpha keys are the values between 65 and 90 corresponding to A to Z
Unicode runes are also stored here, the letter 'A" for example is encoded as a value 65 (not surfaced in the enum).
@@ -118,11 +121,23 @@ public enum Key : uint
+
+
A
+
+The key code for the user pressing Shift-A
+
+
AltMask
When this value is set, the Key encodes the sequence Alt-KeyValue.
And the actual value must be extracted by removing the AltMask.
+
+
+
+
B
+
+The key code for the user pressing Shift-B
@@ -135,6 +150,12 @@ Backspace key.
BackTab
Shift-tab key (backwards tab key).
+
+
+
+
C
+
+The key code for the user pressing Shift-C
@@ -143,168 +164,6 @@ Shift-tab key (backwards tab key).
Mask that indicates that this is a character value, values outside this range
indicate special characters like Alt-key combinations or special keys on the
keyboard like function keys, arrows keys and so on.
-
-
-
-
ControlA
-
-The key code for the user pressing Control-A
-
-
-
-
ControlB
-
-The key code for the user pressing Control-B
-
-
-
-
ControlC
-
-The key code for the user pressing Control-C
-
-
-
-
ControlD
-
-The key code for the user pressing Control-D
-
-
-
-
ControlE
-
-The key code for the user pressing Control-E
-
-
-
-
ControlF
-
-The key code for the user pressing Control-F
-
-
-
-
ControlG
-
-The key code for the user pressing Control-G
-
-
-
-
ControlH
-
-The key code for the user pressing Control-H
-
-
-
-
ControlI
-
-The key code for the user pressing Control-I (same as the tab key).
-
-
-
-
ControlJ
-
-The key code for the user pressing Control-J
-
-
-
-
ControlK
-
-The key code for the user pressing Control-K
-
-
-
-
ControlL
-
-The key code for the user pressing Control-L
-
-
-
-
ControlM
-
-The key code for the user pressing Control-M
-
-
-
-
ControlN
-
-The key code for the user pressing Control-N (same as the return key).
-
-
-
-
ControlO
-
-The key code for the user pressing Control-O
-
-
-
-
ControlP
-
-The key code for the user pressing Control-P
-
-
-
-
ControlQ
-
-The key code for the user pressing Control-Q
-
-
-
-
ControlR
-
-The key code for the user pressing Control-R
-
-
-
-
ControlS
-
-The key code for the user pressing Control-S
-
-
-
-
ControlSpace
-
-The key code for the user pressing Control-spacebar
-
-
-
-
ControlT
-
-The key code for the user pressing Control-T
-
-
-
-
ControlU
-
-The key code for the user pressing Control-U
-
-
-
-
ControlV
-
-The key code for the user pressing Control-V
-
-
-
-
ControlW
-
-The key code for the user pressing Control-W
-
-
-
-
ControlX
-
-The key code for the user pressing Control-X
-
-
-
-
ControlY
-
-The key code for the user pressing Control-Y
-
-
-
-
ControlZ
-
-The key code for the user pressing Control-Z
@@ -336,6 +195,72 @@ Cursor right key.
CursorUp
Cursor up key
+
+
+
+
D
+
+The key code for the user pressing Shift-D
+
+
+
+
D0
+
+Digit 0.
+
+
+
+
D1
+
+Digit 1.
+
+
+
+
D2
+
+Digit 2.
+
+
+
+
D3
+
+Digit 3.
+
+
+
+
D4
+
+Digit 4.
+
+
+
+
D5
+
+Digit 5.
+
+
+
+
D6
+
+Digit 6.
+
+
+
+
D7
+
+Digit 7.
+
+
+
+
D8
+
+Digit 8.
+
+
+
+
D9
+
+Digit 9.
@@ -348,6 +273,12 @@ The key code for the user pressing the delete key.
DeleteChar
Delete character key
+
+
+
+
E
+
+The key code for the user pressing Shift-E
@@ -366,6 +297,12 @@ The key code for the user pressing the return key.
Esc
The key code for the user pressing the escape key
+
+
+
+
F
+
+The key code for the user pressing Shift-F
@@ -438,18 +375,84 @@ F8 key.
F9
F9 key.
+
+
+
+
G
+
+The key code for the user pressing Shift-G
+
+
+
+
H
+
+The key code for the user pressing Shift-H
Home
Home key
+
+
+
+
I
+
+The key code for the user pressing Shift-I
InsertChar
Insert character key
+
+
+
+
J
+
+The key code for the user pressing Shift-J
+
+
+
+
K
+
+The key code for the user pressing Shift-K
+
+
+
+
L
+
+The key code for the user pressing Shift-L
+
+
+
+
M
+
+The key code for the user pressing Shift-M
+
+
+
+
N
+
+The key code for the user pressing Shift-N
+
+
+
+
Null
+
+The key code representing null or empty
+
+
+
+
O
+
+The key code for the user pressing Shift-O
+
+
+
+
P
+
+The key code for the user pressing Shift-P
@@ -462,6 +465,24 @@ Page Down key.
PageUp
Page Up key.
+
+
+
+
Q
+
+The key code for the user pressing Shift-Q
+
+
+
+
R
+
+The key code for the user pressing Shift-R
+
+
+
+
S
+
+The key code for the user pressing Shift-S
@@ -481,18 +502,60 @@ The key code for the user pressing the space bar
If the SpecialMask is set, then the value is that of the special mask,
otherwise, the value is the one of the lower bits (as extracted by CharMask).
+
+
+
+
T
+
+The key code for the user pressing Shift-T
Tab
The key code for the user pressing the tab key (forwards tab key).
+
+
+
+
U
+
+The key code for the user pressing Shift-U
Unknown
A key with an unknown mapping was raised.
+
+
+
+
V
+
+The key code for the user pressing Shift-V
+
+
+
+
W
+
+The key code for the user pressing Shift-W
+
+
+
+
X
+
+The key code for the user pressing Shift-X
+
+
+
+
Y
+
+The key code for the user pressing Shift-Y
+
+
+
+
Z
+
+The key code for the user pressing Shift-Z
diff --git a/docs/api/Terminal.Gui/Terminal.Gui.Label.html b/docs/api/Terminal.Gui/Terminal.Gui.Label.html
index 6a9bede8a..60d835679 100644
--- a/docs/api/Terminal.Gui/Terminal.Gui.Label.html
+++ b/docs/api/Terminal.Gui/Terminal.Gui.Label.html
@@ -129,6 +129,15 @@ The Label View displays a stri
diff --git a/docs/api/Terminal.Gui/Terminal.Gui.MenuBar.html b/docs/api/Terminal.Gui/Terminal.Gui.MenuBar.html
index 033f6c812..412d8e8cf 100644
--- a/docs/api/Terminal.Gui/Terminal.Gui.MenuBar.html
+++ b/docs/api/Terminal.Gui/Terminal.Gui.MenuBar.html
@@ -129,6 +129,15 @@ The MenuBar provides a menu for Terminal.Gui applications.
+This method can be overwritten by views that
+want to provide accelerator functionality
+(Alt-key for example), but without
+interefering with normal ProcessKey behavior.
+
+ 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.
+
+
+
+
ProcessHotKey(KeyEvent)
diff --git a/docs/api/Terminal.Gui/Terminal.Gui.MenuBarItem.html b/docs/api/Terminal.Gui/Terminal.Gui.MenuBarItem.html
index 48bcf84d7..27c0fb7a6 100644
--- a/docs/api/Terminal.Gui/Terminal.Gui.MenuBarItem.html
+++ b/docs/api/Terminal.Gui/Terminal.Gui.MenuBarItem.html
@@ -98,6 +98,12 @@ A MenuBarItem contains
diff --git a/docs/api/Terminal.Gui/Terminal.Gui.MenuItem.html b/docs/api/Terminal.Gui/Terminal.Gui.MenuItem.html
index bd660a408..c98e96ec5 100644
--- a/docs/api/Terminal.Gui/Terminal.Gui.MenuItem.html
+++ b/docs/api/Terminal.Gui/Terminal.Gui.MenuItem.html
@@ -128,26 +128,14 @@ A MenuItem has a title, an
-
diff --git a/docs/api/Terminal.Gui/Terminal.Gui.ProgressBar.html b/docs/api/Terminal.Gui/Terminal.Gui.ProgressBar.html
index aa69b5115..9de0225c7 100644
--- a/docs/api/Terminal.Gui/Terminal.Gui.ProgressBar.html
+++ b/docs/api/Terminal.Gui/Terminal.Gui.ProgressBar.html
@@ -129,6 +129,15 @@ A Progress Bar view that can indicate progress of an activity visually.
diff --git a/docs/api/Terminal.Gui/Terminal.Gui.ScrollBarView.html b/docs/api/Terminal.Gui/Terminal.Gui.ScrollBarView.html
index 2b4866607..f9d25d7ae 100644
--- a/docs/api/Terminal.Gui/Terminal.Gui.ScrollBarView.html
+++ b/docs/api/Terminal.Gui/Terminal.Gui.ScrollBarView.html
@@ -129,6 +129,15 @@ ScrollBarViews are views that display a 1-character scrollbar, either horizontal
diff --git a/docs/api/Terminal.Gui/Terminal.Gui.ScrollView.html b/docs/api/Terminal.Gui/Terminal.Gui.ScrollView.html
index 4c12a0de0..a49c193c4 100644
--- a/docs/api/Terminal.Gui/Terminal.Gui.ScrollView.html
+++ b/docs/api/Terminal.Gui/Terminal.Gui.ScrollView.html
@@ -129,6 +129,15 @@ Scrollviews are views that present a window into a virtual space where subviews
+
+
+
+
+
+
diff --git a/docs/api/Terminal.Gui/Terminal.Gui.StatusBar.html b/docs/api/Terminal.Gui/Terminal.Gui.StatusBar.html
index 8f59f5fd5..f3d4d7484 100644
--- a/docs/api/Terminal.Gui/Terminal.Gui.StatusBar.html
+++ b/docs/api/Terminal.Gui/Terminal.Gui.StatusBar.html
@@ -132,6 +132,15 @@ So for each context must be a new instance of a statusbar.
-Provides text formatting capabilities for console apps. Supports, hotkeys, horizontal alignment, multille lines, and word-based line wrap.
+Provides text formatting capabilities for console apps. Supports, hotkeys, horizontal alignment, multiple lines, and word-based line wrap.
@@ -237,7 +237,7 @@ The position in the text of the hotkey. The hotkey will be rendered using the ho
HotKeySpecifier
-The specifier character for the hotkey (e.g. '_'). Set to '\xffff' to disable hotkey support for this View instance. The default is '\xffff'.
+The specifier character for the hotkey (e.g. '_'). Set to '\xffff' to disable hotkey support for this View instance. The default is '\xffff'.
Declaration
@@ -292,7 +292,7 @@ the underlying Rune to be identified as a "private use" Unicode charac
Lines
-Gets the formatted lines.
+Gets the formatted lines.
Declaration
@@ -326,7 +326,7 @@ Upon a 'get' of this property, if the text needs to be formatted (if <
@@ -352,7 +352,7 @@ If it is false when Draw is called, the Draw call will be faster.
Remarks
-This is set to true when the properties of TextFormatter are set.
+This is set to true when the properties of TextFormatter are set.
@@ -360,7 +360,7 @@ This is set to true when the properties of
Size
-Gets or sets the size of the area the text will be constrainted to when formatted.
+Gets or sets the size of the area the text will be constrained to when formatted.
Declaration
@@ -593,8 +593,8 @@ Finds the hotkey and its location in text.
System.Boolean
firstUpperCase
-
If true the legacy behavior of identifying the first upper case character as the hotkey will be eanbled.
-Regardless of the value of this parameter, hotKeySpecifier takes precidence.
+
If true the legacy behavior of identifying the first upper case character as the hotkey will be enabled.
+Regardless of the value of this parameter, hotKeySpecifier takes precedence.
System.Int32
@@ -745,7 +745,7 @@ make the text just fit width. Spaces will not be added to the ends.
NStack.ustring
-
The justifed text.
+
The justified text.
@@ -803,7 +803,7 @@ Computes the number of lines needed to render the specified text given the width
MaxWidth(ustring, Int32)
-Computes the maximum width needed to render the text (single line or multple lines) given a minimum width.
+Computes the maximum width needed to render the text (single line or multiple lines) given a minimum width.
Declaration
@@ -906,8 +906,8 @@ Removes the hotkey specifier from text.
ReplaceHotKeyWithTag(ustring, Int32)
-Replaces the Rune at the index specfiied by the hotPos parameter with a tag identifying
-it as the hotkey.
+Replaces the Rune at the index specified by the hotPos parameter with a tag identifying
+it as the hotkey.
Declaration
@@ -986,7 +986,7 @@ Formats the provided text to fit within the width provided using word wrapping.
System.Int32
width
-
The width to contrain the text to
+
The width to contain the text to
diff --git a/docs/api/Terminal.Gui/Terminal.Gui.TextView.html b/docs/api/Terminal.Gui/Terminal.Gui.TextView.html
index 5a1a26676..291b829ac 100644
--- a/docs/api/Terminal.Gui/Terminal.Gui.TextView.html
+++ b/docs/api/Terminal.Gui/Terminal.Gui.TextView.html
@@ -129,6 +129,15 @@ Multi-line text editing View
+This method can be overwritten by views that
+want to provide accelerator functionality
+(Alt-key for example), but without
+interefering with normal ProcessKey behavior.
+
+
+
Declaration
+
+
public override bool ProcessColdKey(KeyEvent keyEvent)
+ 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.
+
+
+
+
ProcessKey(KeyEvent)
@@ -929,11 +1003,38 @@ the views have been laid out, and before the views are drawn for the first time.
+
-Fired once the Toplevel's MainLoop has started it's first iteration.
+Fired once the Toplevel's MainLoop has started it's first iteration.
Subscribe to this event to perform tasks when the Toplevel has been laid out and focus has been set.
-changes. A Ready event handler is a good place to finalize initialization after calling `Run()(topLevel)`.
+changes. A Ready event handler is a good place to finalize initialization after calling `Run()(topLevel)`.
Declaration
@@ -955,6 +1056,33 @@ changes. A Ready event handler is a good place to finalize initialization after
+
+
+
System.IDisposable
diff --git a/docs/api/Terminal.Gui/Terminal.Gui.View.html b/docs/api/Terminal.Gui/Terminal.Gui.View.html
index f6a7af11a..96e00d35a 100644
--- a/docs/api/Terminal.Gui/Terminal.Gui.View.html
+++ b/docs/api/Terminal.Gui/Terminal.Gui.View.html
@@ -424,6 +424,36 @@ Initializes a new instance of View
+
+
AutoSize
+
+Used by Text to resize the view's Bounds with the Size.
+Setting AutoSize to true only work if the Width and Height are null or
+Absolute values and doesn't work with Computed layout,
+to avoid breaking the Pos and Dim settings.
+
+
+
Declaration
+
+
public virtual bool AutoSize { get; set; }
+
+
Property Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Boolean
+
+
+
+
+
+
Bounds
@@ -892,6 +922,87 @@ Returns the most focused view in the chain of subviews (the leaf view that has t
+
+
Shortcut
+
+This is the global setting that can be used as a global shortcut to invoke an action if provided.
+
diff --git a/docs/api/Terminal.Gui/Terminal.Gui.html b/docs/api/Terminal.Gui/Terminal.Gui.html
index 8d0e605eb..ec1b4a8d4 100644
--- a/docs/api/Terminal.Gui/Terminal.Gui.html
+++ b/docs/api/Terminal.Gui/Terminal.Gui.html
@@ -260,6 +260,10 @@ ScrollBarViews are views that display a 1-character scrollbar, either horizontal
@@ -277,6 +281,10 @@ The Title will be changed after each ~.
A Title set to `~F1~ Help` will render as *F1* using HotNormal and
*Help* as HotNormal.
+
+
-Provides text formatting capabilities for console apps. Supports, hotkeys, horizontal alignment, multille lines, and word-based line wrap.
+Provides text formatting capabilities for console apps. Supports, hotkeys, horizontal alignment, multiple lines, and word-based line wrap.
diff --git a/docs/index.json b/docs/index.json
index 46c96642a..4798b2c3f 100644
--- a/docs/index.json
+++ b/docs/index.json
@@ -2,7 +2,7 @@
"api/Terminal.Gui/Terminal.Gui.Application.html": {
"href": "api/Terminal.Gui/Terminal.Gui.Application.html",
"title": "Class Application",
- "keywords": "Class Application A static, singelton class provding the main application driver for Terminal.Gui apps. Inheritance System.Object Application Inherited Members System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) System.Object.ToString() Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public static class Application Remarks Creates a instance of MainLoop to process input events, handle timers and other sources of data. It is accessible via the MainLoop property. You can hook up to the Iteration event to have your method invoked on each iteration of the MainLoop . When invoked sets the SynchronizationContext to one that is tied to the mainloop, allowing user code to use async/await. Examples // A simple Terminal.Gui app that creates a window with a frame and title with // 5 rows/columns of padding. Application.Init(); var win = new Window (\"Hello World - CTRL-Q to quit\") { X = 5, Y = 5, Width = Dim.Fill (5), Height = Dim.Fill (5) }; Application.Top.Add(win); Application.Run(); Fields Driver The current ConsoleDriver in use. Declaration public static ConsoleDriver Driver Field Value Type Description ConsoleDriver Iteration This event is raised on each iteration of the MainLoop Declaration public static Action Iteration Field Value Type Description System.Action Remarks See also System.Threading.Timeout Loaded This event is fired once when the application is first loaded. The dimensions of the terminal are provided. Declaration public static Action Loaded Field Value Type Description System.Action < Application.ResizedEventArgs > Resized Invoked when the terminal was resized. The new size of the terminal is provided. Declaration public static Action Resized Field Value Type Description System.Action < Application.ResizedEventArgs > RootMouseEvent Merely a debugging aid to see the raw mouse events Declaration public static Action RootMouseEvent Field Value Type Description System.Action < MouseEvent > UseSystemConsole If set, it forces the use of the System.Console-based driver. Declaration public static bool UseSystemConsole Field Value Type Description System.Boolean Properties Current The current Toplevel object. This is updated when Run() enters and leaves to point to the current Toplevel . Declaration public static Toplevel Current { get; } Property Value Type Description Toplevel The current. CurrentView TThe current View object being redrawn. Declaration public static View CurrentView { get; set; } Property Value Type Description View The current. MainLoop The MainLoop driver for the application Declaration public static MainLoop MainLoop { get; } Property Value Type Description MainLoop The main loop. Top The Toplevel object used for the application on startup ( Top ) Declaration public static Toplevel Top { get; } Property Value Type Description Toplevel The top. Methods Begin(Toplevel) Building block API: Prepares the provided Toplevel for execution. Declaration public static Application.RunState Begin(Toplevel toplevel) Parameters Type Name Description Toplevel toplevel Toplevel to prepare execution for. Returns Type Description Application.RunState The runstate handle that needs to be passed to the End(Application.RunState) method upon completion. 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 RunLoop(Application.RunState, Boolean) method, and then the End(Application.RunState) method upon termination which will undo these changes. End(Application.RunState) Building block API: completes the execution of a Toplevel that was started with Begin(Toplevel) . Declaration public static void End(Application.RunState runState) Parameters Type Name Description Application.RunState runState The runstate returned by the Begin(Toplevel) method. GrabMouse(View) Grabs the mouse, forcing all mouse events to be routed to the specified view until UngrabMouse is called. Declaration public static void GrabMouse(View view) Parameters Type Name Description View view View that will receive all mouse events until UngrabMouse is invoked. Init(ConsoleDriver, IMainLoopDriver) Initializes a new instance of Terminal.Gui Application. Declaration public static void Init(ConsoleDriver driver = null, IMainLoopDriver mainLoopDriver = null) Parameters Type Name Description ConsoleDriver driver IMainLoopDriver mainLoopDriver Remarks Call this method once per instance (or after Shutdown() has been called). Loads the right ConsoleDriver for the platform. Creates a Toplevel and assigns it to Top and CurrentView MakeCenteredRect(Size) Returns a rectangle that is centered in the screen for the provided size. Declaration public static Rect MakeCenteredRect(Size size) Parameters Type Name Description Size size Size for the rectangle. Returns Type Description Rect The centered rect. Refresh() Triggers a refresh of the entire display. Declaration public static void Refresh() RequestStop() Stops running the most recent Toplevel . Declaration public static void RequestStop() Remarks This will cause Run() to return. Calling RequestStop() is equivalent to setting the Running property on the curently running Toplevel to false. Run() Runs the application by calling Run(Toplevel) with the value of Top Declaration public static void Run() Run(Toplevel) Runs the main loop on the given Toplevel container. Declaration public static void Run(Toplevel view) Parameters Type Name Description Toplevel view The Toplevel tu run modally. Remarks This method is used to start processing events for the main application, but it is also used to run other modal View s such as Dialog boxes. To make a Run(Toplevel) stop execution, call RequestStop() . 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 process events manually, call Begin(Toplevel) to set things up manually and then repeatedly call RunLoop(Application.RunState, Boolean) with the wait parameter set to false. By doing this the RunLoop(Application.RunState, Boolean) method will only process any pending events, timers, idle handlers and then return control immediately. Run() Runs the application by calling Run(Toplevel) with a new instance of the specified Toplevel -derived class Declaration public static void Run() where T : Toplevel, new() Type Parameters Name Description T RunLoop(Application.RunState, Boolean) Building block API: Runs the main loop for the created dialog Declaration public static void RunLoop(Application.RunState state, bool wait = true) Parameters Type Name Description Application.RunState state The state returned by the Begin method. System.Boolean wait By default this is true which will execute the runloop waiting for events, if you pass false, you can use this method to run a single iteration of the events. Remarks Use the wait parameter to control whether this is a blocking or non-blocking call. Shutdown() Shutdown an application initialized with Init(ConsoleDriver, IMainLoopDriver) Declaration public static void Shutdown() UngrabMouse() Releases the mouse grab, so mouse events will be routed to the view on which the mouse is. Declaration public static void UngrabMouse()"
+ "keywords": "Class Application A static, singelton class provding the main application driver for Terminal.Gui apps. Inheritance System.Object Application Inherited Members System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) System.Object.ToString() Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public static class Application Remarks Creates a instance of MainLoop to process input events, handle timers and other sources of data. It is accessible via the MainLoop property. You can hook up to the Iteration event to have your method invoked on each iteration of the MainLoop . When invoked sets the SynchronizationContext to one that is tied to the mainloop, allowing user code to use async/await. Examples // A simple Terminal.Gui app that creates a window with a frame and title with // 5 rows/columns of padding. Application.Init(); var win = new Window (\"Hello World - CTRL-Q to quit\") { X = 5, Y = 5, Width = Dim.Fill (5), Height = Dim.Fill (5) }; Application.Top.Add(win); Application.Run(); Fields Driver The current ConsoleDriver in use. Declaration public static ConsoleDriver Driver Field Value Type Description ConsoleDriver Iteration This event is raised on each iteration of the MainLoop Declaration public static Action Iteration Field Value Type Description System.Action Remarks See also System.Threading.Timeout Resized Invoked when the terminal was resized. The new size of the terminal is provided. Declaration public static Action Resized Field Value Type Description System.Action < Application.ResizedEventArgs > RootMouseEvent Merely a debugging aid to see the raw mouse events Declaration public static Action RootMouseEvent Field Value Type Description System.Action < MouseEvent > UseSystemConsole If set, it forces the use of the System.Console-based driver. Declaration public static bool UseSystemConsole Field Value Type Description System.Boolean Properties Current The current Toplevel object. This is updated when Run() enters and leaves to point to the current Toplevel . Declaration public static Toplevel Current { get; } Property Value Type Description Toplevel The current. CurrentView TThe current View object being redrawn. Declaration public static View CurrentView { get; set; } Property Value Type Description View The current. MainLoop The MainLoop driver for the application Declaration public static MainLoop MainLoop { get; } Property Value Type Description MainLoop The main loop. Top The Toplevel object used for the application on startup ( Top ) Declaration public static Toplevel Top { get; } Property Value Type Description Toplevel The top. Methods Begin(Toplevel) Building block API: Prepares the provided Toplevel for execution. Declaration public static Application.RunState Begin(Toplevel toplevel) Parameters Type Name Description Toplevel toplevel Toplevel to prepare execution for. Returns Type Description Application.RunState The runstate handle that needs to be passed to the End(Application.RunState) method upon completion. 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 RunLoop(Application.RunState, Boolean) method, and then the End(Application.RunState) method upon termination which will undo these changes. End(Application.RunState) Building block API: completes the execution of a Toplevel that was started with Begin(Toplevel) . Declaration public static void End(Application.RunState runState) Parameters Type Name Description Application.RunState runState The runstate returned by the Begin(Toplevel) method. GrabMouse(View) Grabs the mouse, forcing all mouse events to be routed to the specified view until UngrabMouse is called. Declaration public static void GrabMouse(View view) Parameters Type Name Description View view View that will receive all mouse events until UngrabMouse is invoked. Init(ConsoleDriver, IMainLoopDriver) Initializes a new instance of Terminal.Gui Application. Declaration public static void Init(ConsoleDriver driver = null, IMainLoopDriver mainLoopDriver = null) Parameters Type Name Description ConsoleDriver driver IMainLoopDriver mainLoopDriver Remarks Call this method once per instance (or after Shutdown() has been called). Loads the right ConsoleDriver for the platform. Creates a Toplevel and assigns it to Top and CurrentView MakeCenteredRect(Size) Returns a rectangle that is centered in the screen for the provided size. Declaration public static Rect MakeCenteredRect(Size size) Parameters Type Name Description Size size Size for the rectangle. Returns Type Description Rect The centered rect. Refresh() Triggers a refresh of the entire display. Declaration public static void Refresh() RequestStop() Stops running the most recent Toplevel . Declaration public static void RequestStop() Remarks This will cause Run() to return. Calling RequestStop() is equivalent to setting the Running property on the curently running Toplevel to false. Run() Runs the application by calling Run(Toplevel) with the value of Top Declaration public static void Run() Run(Toplevel) Runs the main loop on the given Toplevel container. Declaration public static void Run(Toplevel view) Parameters Type Name Description Toplevel view The Toplevel tu run modally. Remarks This method is used to start processing events for the main application, but it is also used to run other modal View s such as Dialog boxes. To make a Run(Toplevel) stop execution, call RequestStop() . 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 process events manually, call Begin(Toplevel) to set things up manually and then repeatedly call RunLoop(Application.RunState, Boolean) with the wait parameter set to false. By doing this the RunLoop(Application.RunState, Boolean) method will only process any pending events, timers, idle handlers and then return control immediately. Run() Runs the application by calling Run(Toplevel) with a new instance of the specified Toplevel -derived class Declaration public static void Run() where T : Toplevel, new() Type Parameters Name Description T RunLoop(Application.RunState, Boolean) Building block API: Runs the main loop for the created dialog Declaration public static void RunLoop(Application.RunState state, bool wait = true) Parameters Type Name Description Application.RunState state The state returned by the Begin method. System.Boolean wait By default this is true which will execute the runloop waiting for events, if you pass false, you can use this method to run a single iteration of the events. Remarks Use the wait parameter to control whether this is a blocking or non-blocking call. Shutdown() Shutdown an application initialized with Init(ConsoleDriver, IMainLoopDriver) Declaration public static void Shutdown() UngrabMouse() Releases the mouse grab, so mouse events will be routed to the view on which the mouse is. Declaration public static void UngrabMouse()"
},
"api/Terminal.Gui/Terminal.Gui.Application.ResizedEventArgs.html": {
"href": "api/Terminal.Gui/Terminal.Gui.Application.ResizedEventArgs.html",
@@ -22,12 +22,12 @@
"api/Terminal.Gui/Terminal.Gui.Button.html": {
"href": "api/Terminal.Gui/Terminal.Gui.Button.html",
"title": "Class Button",
- "keywords": "Class Button Button is a View that provides an item that invokes an System.Action when activated by the user. Inheritance System.Object Responder View Button Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.CanFocus View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View) View.Add(View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.Redraw(Rect) View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.TextAlignment View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class Button : View, IDisposable, ISupportInitializeNotification, ISupportInitialize Remarks Provides a button showing text invokes an System.Action when clicked on with a mouse or when the user presses SPACE, ENTER, or hotkey. The hotkey is the first letter or digit following the first underscore ('_') in the button text. Use HotKeySpecifier to change the hotkey specifier from the default of ('_'). If no hotkey specifier is found, the first uppercase letter encountered will be used as the hotkey. When the button is configured as the default ( IsDefault ) and the user presses the ENTER key, if no other View processes the KeyEvent , the Button 's System.Action will be invoked. Constructors Button() Initializes a new instance of Button using Computed layout. Declaration public Button() Remarks The width of the Button is computed based on the text length. The height will always be 1. Button(ustring, Boolean) Initializes a new instance of Button using Computed layout. Declaration public Button(ustring text, bool is_default = false) Parameters Type Name Description NStack.ustring text The button's text System.Boolean is_default If true , a special decoration is used, and the user pressing the enter key in a Dialog will implicitly activate this button. Remarks The width of the Button is computed based on the text length. The height will always be 1. Button(Int32, Int32, ustring) Initializes a new instance of Button using Absolute layout, based on the given text Declaration public Button(int x, int y, ustring text) Parameters Type Name Description System.Int32 x X position where the button will be shown. System.Int32 y Y position where the button will be shown. NStack.ustring text The button's text Remarks The width of the Button is computed based on the text length. The height will always be 1. Button(Int32, Int32, ustring, Boolean) Initializes a new instance of Button using Absolute layout, based on the given text. Declaration public Button(int x, int y, ustring text, bool is_default) Parameters Type Name Description System.Int32 x X position where the button will be shown. System.Int32 y Y position where the button will be shown. NStack.ustring text The button's text System.Boolean is_default If true , a special decoration is used, and the user pressing the enter key in a Dialog will implicitly activate this button. Remarks The width of the Button is computed based on the text length. The height will always be 1. Properties IsDefault Gets or sets whether the Button is the default action to activate in a dialog. Declaration public bool IsDefault { get; set; } Property Value Type Description System.Boolean true if is default; otherwise, false . Text The text displayed by this Button . Declaration public ustring Text { get; set; } Property Value Type Description NStack.ustring Methods MouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public override bool MouseEvent(MouseEvent me) Parameters Type Name Description MouseEvent me Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides Responder.MouseEvent(MouseEvent) PositionCursor() Positions the cursor in the right position based on the currently focused view in the chain. Declaration public override void PositionCursor() Overrides View.PositionCursor() ProcessColdKey(KeyEvent) This method can be overwritten by views that want to provide accelerator functionality (Alt-key for example), but without interefering with normal ProcessKey behavior. Declaration public override bool ProcessColdKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides View.ProcessColdKey(KeyEvent) Remarks 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. ProcessHotKey(KeyEvent) This method can be overwritten by view that want to provide accelerator functionality (Alt-key for example). Declaration public override bool ProcessHotKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides View.ProcessHotKey(KeyEvent) Remarks 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. ProcessKey(KeyEvent) If the view is focused, gives the view a chance to process the keystroke. Declaration public override bool ProcessKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides View.ProcessKey(KeyEvent) Remarks 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. Events Clicked Clicked System.Action , raised when the user clicks the primary mouse button within the Bounds of this View or if the user presses the action key while this view is focused. (TODO: IsDefault) Declaration public event Action Clicked Event Type Type Description System.Action Remarks Client code can hook up to this event, it is raised when the button is activated either with the mouse or the keyboard. Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize"
+ "keywords": "Class Button Button is a View that provides an item that invokes an System.Action when activated by the user. Inheritance System.Object Responder View Button Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Shortcut View.ShortcutTag View.ShortcutAction View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.CanFocus View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View) View.Add(View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.Redraw(Rect) View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.AutoSize View.TextAlignment View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class Button : View, IDisposable, ISupportInitializeNotification, ISupportInitialize Remarks Provides a button showing text invokes an System.Action when clicked on with a mouse or when the user presses SPACE, ENTER, or hotkey. The hotkey is the first letter or digit following the first underscore ('_') in the button text. Use HotKeySpecifier to change the hotkey specifier from the default of ('_'). If no hotkey specifier is found, the first uppercase letter encountered will be used as the hotkey. When the button is configured as the default ( IsDefault ) and the user presses the ENTER key, if no other View processes the KeyEvent , the Button 's System.Action will be invoked. Constructors Button() Initializes a new instance of Button using Computed layout. Declaration public Button() Remarks The width of the Button is computed based on the text length. The height will always be 1. Button(ustring, Boolean) Initializes a new instance of Button using Computed layout. Declaration public Button(ustring text, bool is_default = false) Parameters Type Name Description NStack.ustring text The button's text System.Boolean is_default If true , a special decoration is used, and the user pressing the enter key in a Dialog will implicitly activate this button. Remarks The width of the Button is computed based on the text length. The height will always be 1. Button(Int32, Int32, ustring) Initializes a new instance of Button using Absolute layout, based on the given text Declaration public Button(int x, int y, ustring text) Parameters Type Name Description System.Int32 x X position where the button will be shown. System.Int32 y Y position where the button will be shown. NStack.ustring text The button's text Remarks The width of the Button is computed based on the text length. The height will always be 1. Button(Int32, Int32, ustring, Boolean) Initializes a new instance of Button using Absolute layout, based on the given text. Declaration public Button(int x, int y, ustring text, bool is_default) Parameters Type Name Description System.Int32 x X position where the button will be shown. System.Int32 y Y position where the button will be shown. NStack.ustring text The button's text System.Boolean is_default If true , a special decoration is used, and the user pressing the enter key in a Dialog will implicitly activate this button. Remarks The width of the Button is computed based on the text length. The height will always be 1. Properties IsDefault Gets or sets whether the Button is the default action to activate in a dialog. Declaration public bool IsDefault { get; set; } Property Value Type Description System.Boolean true if is default; otherwise, false . Text The text displayed by this Button . Declaration public ustring Text { get; set; } Property Value Type Description NStack.ustring Methods MouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public override bool MouseEvent(MouseEvent me) Parameters Type Name Description MouseEvent me Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides Responder.MouseEvent(MouseEvent) PositionCursor() Positions the cursor in the right position based on the currently focused view in the chain. Declaration public override void PositionCursor() Overrides View.PositionCursor() ProcessColdKey(KeyEvent) This method can be overwritten by views that want to provide accelerator functionality (Alt-key for example), but without interefering with normal ProcessKey behavior. Declaration public override bool ProcessColdKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides View.ProcessColdKey(KeyEvent) Remarks 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. ProcessHotKey(KeyEvent) This method can be overwritten by view that want to provide accelerator functionality (Alt-key for example). Declaration public override bool ProcessHotKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides View.ProcessHotKey(KeyEvent) Remarks 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. ProcessKey(KeyEvent) If the view is focused, gives the view a chance to process the keystroke. Declaration public override bool ProcessKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides View.ProcessKey(KeyEvent) Remarks 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. Events Clicked Clicked System.Action , raised when the user clicks the primary mouse button within the Bounds of this View or if the user presses the action key while this view is focused. (TODO: IsDefault) Declaration public event Action Clicked Event Type Type Description System.Action Remarks Client code can hook up to this event, it is raised when the button is activated either with the mouse or the keyboard. Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize"
},
"api/Terminal.Gui/Terminal.Gui.CheckBox.html": {
"href": "api/Terminal.Gui/Terminal.Gui.CheckBox.html",
"title": "Class CheckBox",
- "keywords": "Class CheckBox The CheckBox View shows an on/off toggle that the user can set Inheritance System.Object Responder View CheckBox Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.CanFocus View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View) View.Add(View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.TextAlignment View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class CheckBox : View, IDisposable, ISupportInitializeNotification, ISupportInitialize Constructors CheckBox() Initializes a new instance of CheckBox based on the given text, using Computed layout. Declaration public CheckBox() CheckBox(ustring, Boolean) Initializes a new instance of CheckBox based on the given text, using Computed layout. Declaration public CheckBox(ustring s, bool is_checked = false) Parameters Type Name Description NStack.ustring s S. System.Boolean is_checked If set to true is checked. CheckBox(Int32, Int32, ustring) Initializes a new instance of CheckBox using Absolute layout. Declaration public CheckBox(int x, int y, ustring s) Parameters Type Name Description System.Int32 x System.Int32 y NStack.ustring s Remarks The size of CheckBox is computed based on the text length. This CheckBox is not toggled. CheckBox(Int32, Int32, ustring, Boolean) Initializes a new instance of CheckBox using Absolute layout. Declaration public CheckBox(int x, int y, ustring s, bool is_checked) Parameters Type Name Description System.Int32 x System.Int32 y NStack.ustring s System.Boolean is_checked Remarks The size of CheckBox is computed based on the text length. Properties Checked The state of the CheckBox Declaration public bool Checked { get; set; } Property Value Type Description System.Boolean Text The text displayed by this CheckBox Declaration public ustring Text { get; set; } Property Value Type Description NStack.ustring Methods MouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public override bool MouseEvent(MouseEvent me) Parameters Type Name Description MouseEvent me Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides Responder.MouseEvent(MouseEvent) OnToggled(Boolean) Called when the Checked property changes. Invokes the Toggled event. Declaration public virtual void OnToggled(bool previousChecked) Parameters Type Name Description System.Boolean previousChecked PositionCursor() Positions the cursor in the right position based on the currently focused view in the chain. Declaration public override void PositionCursor() Overrides View.PositionCursor() ProcessKey(KeyEvent) If the view is focused, gives the view a chance to process the keystroke. Declaration public override bool ProcessKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides View.ProcessKey(KeyEvent) Remarks 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. Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds The bounds (view-relative region) to redraw. Overrides View.Redraw(Rect) Remarks 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. Events Toggled Toggled event, raised when the CheckBox is toggled. Declaration public event Action Toggled Event Type Type Description System.Action < System.Boolean > Remarks Client code can hook up to this event, it is raised when the CheckBox is activated either with the mouse or the keyboard. The passed bool contains the previous state. Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize"
+ "keywords": "Class CheckBox The CheckBox View shows an on/off toggle that the user can set Inheritance System.Object Responder View CheckBox Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Shortcut View.ShortcutTag View.ShortcutAction View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.CanFocus View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View) View.Add(View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.AutoSize View.TextAlignment View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class CheckBox : View, IDisposable, ISupportInitializeNotification, ISupportInitialize Constructors CheckBox() Initializes a new instance of CheckBox based on the given text, using Computed layout. Declaration public CheckBox() CheckBox(ustring, Boolean) Initializes a new instance of CheckBox based on the given text, using Computed layout. Declaration public CheckBox(ustring s, bool is_checked = false) Parameters Type Name Description NStack.ustring s S. System.Boolean is_checked If set to true is checked. CheckBox(Int32, Int32, ustring) Initializes a new instance of CheckBox using Absolute layout. Declaration public CheckBox(int x, int y, ustring s) Parameters Type Name Description System.Int32 x System.Int32 y NStack.ustring s Remarks The size of CheckBox is computed based on the text length. This CheckBox is not toggled. CheckBox(Int32, Int32, ustring, Boolean) Initializes a new instance of CheckBox using Absolute layout. Declaration public CheckBox(int x, int y, ustring s, bool is_checked) Parameters Type Name Description System.Int32 x System.Int32 y NStack.ustring s System.Boolean is_checked Remarks The size of CheckBox is computed based on the text length. Properties Checked The state of the CheckBox Declaration public bool Checked { get; set; } Property Value Type Description System.Boolean Text The text displayed by this CheckBox Declaration public ustring Text { get; set; } Property Value Type Description NStack.ustring Methods MouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public override bool MouseEvent(MouseEvent me) Parameters Type Name Description MouseEvent me Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides Responder.MouseEvent(MouseEvent) OnToggled(Boolean) Called when the Checked property changes. Invokes the Toggled event. Declaration public virtual void OnToggled(bool previousChecked) Parameters Type Name Description System.Boolean previousChecked PositionCursor() Positions the cursor in the right position based on the currently focused view in the chain. Declaration public override void PositionCursor() Overrides View.PositionCursor() ProcessKey(KeyEvent) If the view is focused, gives the view a chance to process the keystroke. Declaration public override bool ProcessKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides View.ProcessKey(KeyEvent) Remarks 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. Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds The bounds (view-relative region) to redraw. Overrides View.Redraw(Rect) Remarks 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. Events Toggled Toggled event, raised when the CheckBox is toggled. Declaration public event Action Toggled Event Type Type Description System.Action < System.Boolean > Remarks Client code can hook up to this event, it is raised when the CheckBox is activated either with the mouse or the keyboard. The passed bool contains the previous state. Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize"
},
"api/Terminal.Gui/Terminal.Gui.Clipboard.html": {
"href": "api/Terminal.Gui/Terminal.Gui.Clipboard.html",
@@ -52,7 +52,7 @@
"api/Terminal.Gui/Terminal.Gui.ComboBox.html": {
"href": "api/Terminal.Gui/Terminal.Gui.ComboBox.html",
"title": "Class ComboBox",
- "keywords": "Class ComboBox ComboBox control Inheritance System.Object Responder View ComboBox Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.CanFocus View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View) View.Add(View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.PositionCursor() View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.Focused View.MostFocused View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.TextAlignment View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class ComboBox : View, IDisposable, ISupportInitializeNotification, ISupportInitialize Constructors ComboBox() Public constructor Declaration public ComboBox() ComboBox(ustring) Public constructor Declaration public ComboBox(ustring text) Parameters Type Name Description NStack.ustring text ComboBox(Rect, IList) Public constructor Declaration public ComboBox(Rect rect, IList source) Parameters Type Name Description Rect rect System.Collections.IList source Properties ColorScheme Declaration public ColorScheme ColorScheme { get; set; } Property Value Type Description ColorScheme SelectedItem Gets the index of the currently selected item in the Source Declaration public int SelectedItem { get; } Property Value Type Description System.Int32 The selected item or -1 none selected. Source Gets or sets the IListDataSource backing this ComboBox , enabling custom rendering. Declaration public IListDataSource Source { get; set; } Property Value Type Description IListDataSource The source. Remarks Use SetSource(IList) to set a new System.Collections.IList source. Text The currently selected list item Declaration public ustring Text { get; set; } Property Value Type Description NStack.ustring Methods MouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public override bool MouseEvent(MouseEvent me) Parameters Type Name Description MouseEvent me Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides Responder.MouseEvent(MouseEvent) OnEnter(View) Method invoked when a view gets focus. Declaration public override bool OnEnter(View view) Parameters Type Name Description View view The view that is losing focus. Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides View.OnEnter(View) OnLeave(View) Method invoked when a view loses focus. Declaration public override bool OnLeave(View view) Parameters Type Name Description View view The view that is getting focus. Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides View.OnLeave(View) OnOpenSelectedItem() Invokes the OnOpenSelectedItem event if it is defined. Declaration public virtual bool OnOpenSelectedItem() Returns Type Description System.Boolean OnSelectedChanged() Invokes the SelectedChanged event if it is defined. Declaration public virtual bool OnSelectedChanged() Returns Type Description System.Boolean ProcessKey(KeyEvent) If the view is focused, gives the view a chance to process the keystroke. Declaration public override bool ProcessKey(KeyEvent e) Parameters Type Name Description KeyEvent e Returns Type Description System.Boolean Overrides View.ProcessKey(KeyEvent) Remarks 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. Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds The bounds (view-relative region) to redraw. Overrides View.Redraw(Rect) Remarks 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. SetSource(IList) Sets the source of the ComboBox to an System.Collections.IList . Declaration public void SetSource(IList source) Parameters Type Name Description System.Collections.IList source Remarks Use the Source property to set a new IListDataSource source and use custome rendering. Events OpenSelectedItem This event is raised when the user Double Clicks on an item or presses ENTER to open the selected item. Declaration public event Action OpenSelectedItem Event Type Type Description System.Action < ListViewItemEventArgs > SelectedItemChanged This event is raised when the selected item in the ComboBox has changed. Declaration public event Action SelectedItemChanged Event Type Type Description System.Action < ListViewItemEventArgs > Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize"
+ "keywords": "Class ComboBox ComboBox control Inheritance System.Object Responder View ComboBox Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Shortcut View.ShortcutTag View.ShortcutAction View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.CanFocus View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View) View.Add(View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.PositionCursor() View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.Focused View.MostFocused View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.AutoSize View.TextAlignment View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class ComboBox : View, IDisposable, ISupportInitializeNotification, ISupportInitialize Constructors ComboBox() Public constructor Declaration public ComboBox() ComboBox(ustring) Public constructor Declaration public ComboBox(ustring text) Parameters Type Name Description NStack.ustring text ComboBox(Rect, IList) Public constructor Declaration public ComboBox(Rect rect, IList source) Parameters Type Name Description Rect rect System.Collections.IList source Properties ColorScheme Declaration public ColorScheme ColorScheme { get; set; } Property Value Type Description ColorScheme SelectedItem Gets the index of the currently selected item in the Source Declaration public int SelectedItem { get; } Property Value Type Description System.Int32 The selected item or -1 none selected. Source Gets or sets the IListDataSource backing this ComboBox , enabling custom rendering. Declaration public IListDataSource Source { get; set; } Property Value Type Description IListDataSource The source. Remarks Use SetSource(IList) to set a new System.Collections.IList source. Text The currently selected list item Declaration public ustring Text { get; set; } Property Value Type Description NStack.ustring Methods MouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public override bool MouseEvent(MouseEvent me) Parameters Type Name Description MouseEvent me Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides Responder.MouseEvent(MouseEvent) OnEnter(View) Method invoked when a view gets focus. Declaration public override bool OnEnter(View view) Parameters Type Name Description View view The view that is losing focus. Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides View.OnEnter(View) OnLeave(View) Method invoked when a view loses focus. Declaration public override bool OnLeave(View view) Parameters Type Name Description View view The view that is getting focus. Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides View.OnLeave(View) OnOpenSelectedItem() Invokes the OnOpenSelectedItem event if it is defined. Declaration public virtual bool OnOpenSelectedItem() Returns Type Description System.Boolean OnSelectedChanged() Invokes the SelectedChanged event if it is defined. Declaration public virtual bool OnSelectedChanged() Returns Type Description System.Boolean ProcessKey(KeyEvent) If the view is focused, gives the view a chance to process the keystroke. Declaration public override bool ProcessKey(KeyEvent e) Parameters Type Name Description KeyEvent e Returns Type Description System.Boolean Overrides View.ProcessKey(KeyEvent) Remarks 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. Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds The bounds (view-relative region) to redraw. Overrides View.Redraw(Rect) Remarks 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. SetSource(IList) Sets the source of the ComboBox to an System.Collections.IList . Declaration public void SetSource(IList source) Parameters Type Name Description System.Collections.IList source Remarks Use the Source property to set a new IListDataSource source and use custome rendering. Events OpenSelectedItem This event is raised when the user Double Clicks on an item or presses ENTER to open the selected item. Declaration public event Action OpenSelectedItem Event Type Type Description System.Action < ListViewItemEventArgs > SelectedItemChanged This event is raised when the selected item in the ComboBox has changed. Declaration public event Action SelectedItemChanged Event Type Type Description System.Action < ListViewItemEventArgs > Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize"
},
"api/Terminal.Gui/Terminal.Gui.ConsoleDriver.DiagnosticFlags.html": {
"href": "api/Terminal.Gui/Terminal.Gui.ConsoleDriver.DiagnosticFlags.html",
@@ -67,7 +67,7 @@
"api/Terminal.Gui/Terminal.Gui.DateField.html": {
"href": "api/Terminal.Gui/Terminal.Gui.DateField.html",
"title": "Class DateField",
- "keywords": "Class DateField Simple Date editing View Inheritance System.Object Responder View TextField DateField Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members TextField.Used TextField.ReadOnly TextField.TextChanged TextField.OnLeave(View) TextField.Frame TextField.Text TextField.Secret TextField.CursorPosition TextField.PositionCursor() TextField.Redraw(Rect) TextField.CanFocus TextField.SelectedStart TextField.SelectedLength TextField.SelectedText TextField.ClearAllSelection() TextField.Copy() TextField.Cut() TextField.Paste() View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View) View.Add(View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.TextAlignment View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class DateField : TextField, IDisposable, ISupportInitializeNotification, ISupportInitialize Remarks The DateField View provides date editing functionality with mouse support. Constructors DateField() Initializes a new instance of DateField using Computed layout. Declaration public DateField() DateField(DateTime) Initializes a new instance of DateField using Computed layout. Declaration public DateField(DateTime date) Parameters Type Name Description System.DateTime date DateField(Int32, Int32, DateTime, Boolean) Initializes a new instance of DateField using Absolute layout. Declaration public DateField(int x, int y, DateTime date, bool isShort = false) Parameters Type Name Description System.Int32 x The x coordinate. System.Int32 y The y coordinate. System.DateTime date Initial date contents. System.Boolean isShort If true, shows only two digits for the year. Properties Date Gets or sets the date of the DateField . Declaration public DateTime Date { get; set; } Property Value Type Description System.DateTime Remarks IsShortFormat Get or set the date format for the widget. Declaration public bool IsShortFormat { get; set; } Property Value Type Description System.Boolean Methods MouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public override bool MouseEvent(MouseEvent ev) Parameters Type Name Description MouseEvent ev Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides TextField.MouseEvent(MouseEvent) OnDateChanged(DateTimeEventArgs) Event firing method for the DateChanged event. Declaration public virtual void OnDateChanged(DateTimeEventArgs args) Parameters Type Name Description DateTimeEventArgs < System.DateTime > args Event arguments ProcessKey(KeyEvent) Processes key presses for the TextField . Declaration public override bool ProcessKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides TextField.ProcessKey(KeyEvent) Remarks The TextField control responds to the following keys: Keys Function Delete , Backspace Deletes the character before cursor. Events DateChanged DateChanged event, raised when the Date property has changed. Declaration public event Action> DateChanged Event Type Type Description System.Action < DateTimeEventArgs < System.DateTime >> Remarks This event is raised when the Date property changes. Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize"
+ "keywords": "Class DateField Simple Date editing View Inheritance System.Object Responder View TextField DateField Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members TextField.Used TextField.ReadOnly TextField.TextChanging TextField.TextChanged TextField.OnLeave(View) TextField.Frame TextField.Text TextField.Secret TextField.CursorPosition TextField.PositionCursor() TextField.Redraw(Rect) TextField.CanFocus TextField.SelectedStart TextField.SelectedLength TextField.SelectedText TextField.ClearAllSelection() TextField.Copy() TextField.Cut() TextField.Paste() TextField.OnTextChanging(ustring) View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Shortcut View.ShortcutTag View.ShortcutAction View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View) View.Add(View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.AutoSize View.TextAlignment View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class DateField : TextField, IDisposable, ISupportInitializeNotification, ISupportInitialize Remarks The DateField View provides date editing functionality with mouse support. Constructors DateField() Initializes a new instance of DateField using Computed layout. Declaration public DateField() DateField(DateTime) Initializes a new instance of DateField using Computed layout. Declaration public DateField(DateTime date) Parameters Type Name Description System.DateTime date DateField(Int32, Int32, DateTime, Boolean) Initializes a new instance of DateField using Absolute layout. Declaration public DateField(int x, int y, DateTime date, bool isShort = false) Parameters Type Name Description System.Int32 x The x coordinate. System.Int32 y The y coordinate. System.DateTime date Initial date contents. System.Boolean isShort If true, shows only two digits for the year. Properties Date Gets or sets the date of the DateField . Declaration public DateTime Date { get; set; } Property Value Type Description System.DateTime Remarks IsShortFormat Get or set the date format for the widget. Declaration public bool IsShortFormat { get; set; } Property Value Type Description System.Boolean Methods MouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public override bool MouseEvent(MouseEvent ev) Parameters Type Name Description MouseEvent ev Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides TextField.MouseEvent(MouseEvent) OnDateChanged(DateTimeEventArgs) Event firing method for the DateChanged event. Declaration public virtual void OnDateChanged(DateTimeEventArgs args) Parameters Type Name Description DateTimeEventArgs < System.DateTime > args Event arguments ProcessKey(KeyEvent) Processes key presses for the TextField . Declaration public override bool ProcessKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides TextField.ProcessKey(KeyEvent) Remarks The TextField control responds to the following keys: Keys Function Delete , Backspace Deletes the character before cursor. Events DateChanged DateChanged event, raised when the Date property has changed. Declaration public event Action> DateChanged Event Type Type Description System.Action < DateTimeEventArgs < System.DateTime >> Remarks This event is raised when the Date property changes. Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize"
},
"api/Terminal.Gui/Terminal.Gui.DateTimeEventArgs-1.html": {
"href": "api/Terminal.Gui/Terminal.Gui.DateTimeEventArgs-1.html",
@@ -77,7 +77,7 @@
"api/Terminal.Gui/Terminal.Gui.Dialog.html": {
"href": "api/Terminal.Gui/Terminal.Gui.Dialog.html",
"title": "Class Dialog",
- "keywords": "Class Dialog The Dialog View is a Window that by default is centered and contains one or more Button s. It defaults to the Dialog color scheme and has a 1 cell padding around the edges. Inheritance System.Object Responder View Toplevel Window Dialog FileDialog Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members Window.Title Window.Add(View) Window.Remove(View) Window.RemoveAll() Window.Redraw(Rect) Window.MouseEvent(MouseEvent) Window.Text Window.TextAlignment Toplevel.Running Toplevel.Ready Toplevel.Create() Toplevel.CanFocus Toplevel.Modal Toplevel.MenuBar Toplevel.StatusBar Toplevel.OnKeyDown(KeyEvent) Toplevel.OnKeyUp(KeyEvent) Toplevel.WillPresent() View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View[]) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.PositionCursor() View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.KeyUp View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class Dialog : Window, IDisposable, ISupportInitializeNotification, ISupportInitialize Remarks To run the Dialog modally, create the Dialog , and pass it to Run() . This will execute the dialog until it terminates via the [ESC] or [CTRL-Q] key, or when one of the views or buttons added to the dialog calls RequestStop() . Constructors Dialog() Initializes a new instance of the Dialog class using Computed . Declaration public Dialog() Remarks Te Dialog will be vertically and horizontally centered in the container and the size will be 85% of the container. After initialzation use X , Y , Width , and Height to override this with a location or size. Use AddButton(Button) to add buttons to the dialog. Dialog(ustring, Int32, Int32, Button[]) Initializes a new instance of the Dialog class using Computed positioning and an optional set of Button s to display Declaration public Dialog(ustring title, int width, int height, params Button[] buttons) Parameters Type Name Description NStack.ustring title Title for the dialog. System.Int32 width Width for the dialog. System.Int32 height Height for the dialog. Button [] buttons Optional buttons to lay out at the bottom of the dialog. Remarks if width and height are both 0, the Dialog will be vertically and horizontally centered in the container and the size will be 85% of the container. After initialzation use X , Y , Width , and Height to override this with a location or size. Dialog(ustring, Button[]) Initializes a new instance of the Dialog class using Computed positioning and with an optional set of Button s to display Declaration public Dialog(ustring title, params Button[] buttons) Parameters Type Name Description NStack.ustring title Title for the dialog. Button [] buttons Optional buttons to lay out at the bottom of the dialog. Remarks Te Dialog will be vertically and horizontally centered in the container and the size will be 85% of the container. After initialzation use X , Y , Width , and Height to override this with a location or size. Methods AddButton(Button) Adds a Button to the Dialog , its layout will be controlled by the Dialog Declaration public void AddButton(Button button) Parameters Type Name Description Button button Button to add. ProcessKey(KeyEvent) If the view is focused, gives the view a chance to process the keystroke. Declaration public override bool ProcessKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides Toplevel.ProcessKey(KeyEvent) Remarks 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. Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize"
+ "keywords": "Class Dialog The Dialog View is a Window that by default is centered and contains one or more Button s. It defaults to the Dialog color scheme and has a 1 cell padding around the edges. Inheritance System.Object Responder View Toplevel Window Dialog FileDialog Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members Window.Title Window.Add(View) Window.Remove(View) Window.RemoveAll() Window.Redraw(Rect) Window.MouseEvent(MouseEvent) Window.Text Window.TextAlignment Toplevel.Running Toplevel.Loaded Toplevel.Ready Toplevel.Unloaded Toplevel.Create() Toplevel.CanFocus Toplevel.Modal Toplevel.MenuBar Toplevel.StatusBar Toplevel.OnKeyDown(KeyEvent) Toplevel.OnKeyUp(KeyEvent) Toplevel.ProcessColdKey(KeyEvent) Toplevel.WillPresent() View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Shortcut View.ShortcutTag View.ShortcutAction View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View[]) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.PositionCursor() View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessHotKey(KeyEvent) View.KeyDown View.KeyUp View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.AutoSize View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class Dialog : Window, IDisposable, ISupportInitializeNotification, ISupportInitialize Remarks To run the Dialog modally, create the Dialog , and pass it to Run() . This will execute the dialog until it terminates via the [ESC] or [CTRL-Q] key, or when one of the views or buttons added to the dialog calls RequestStop() . Constructors Dialog() Initializes a new instance of the Dialog class using Computed . Declaration public Dialog() Remarks Te Dialog will be vertically and horizontally centered in the container and the size will be 85% of the container. After initialzation use X , Y , Width , and Height to override this with a location or size. Use AddButton(Button) to add buttons to the dialog. Dialog(ustring, Int32, Int32, Button[]) Initializes a new instance of the Dialog class using Computed positioning and an optional set of Button s to display Declaration public Dialog(ustring title, int width, int height, params Button[] buttons) Parameters Type Name Description NStack.ustring title Title for the dialog. System.Int32 width Width for the dialog. System.Int32 height Height for the dialog. Button [] buttons Optional buttons to lay out at the bottom of the dialog. Remarks if width and height are both 0, the Dialog will be vertically and horizontally centered in the container and the size will be 85% of the container. After initialzation use X , Y , Width , and Height to override this with a location or size. Dialog(ustring, Button[]) Initializes a new instance of the Dialog class using Computed positioning and with an optional set of Button s to display Declaration public Dialog(ustring title, params Button[] buttons) Parameters Type Name Description NStack.ustring title Title for the dialog. Button [] buttons Optional buttons to lay out at the bottom of the dialog. Remarks Te Dialog will be vertically and horizontally centered in the container and the size will be 85% of the container. After initialzation use X , Y , Width , and Height to override this with a location or size. Methods AddButton(Button) Adds a Button to the Dialog , its layout will be controlled by the Dialog Declaration public void AddButton(Button button) Parameters Type Name Description Button button Button to add. ProcessKey(KeyEvent) If the view is focused, gives the view a chance to process the keystroke. Declaration public override bool ProcessKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides Toplevel.ProcessKey(KeyEvent) Remarks 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. Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize"
},
"api/Terminal.Gui/Terminal.Gui.Dim.html": {
"href": "api/Terminal.Gui/Terminal.Gui.Dim.html",
@@ -102,22 +102,22 @@
"api/Terminal.Gui/Terminal.Gui.FileDialog.html": {
"href": "api/Terminal.Gui/Terminal.Gui.FileDialog.html",
"title": "Class FileDialog",
- "keywords": "Class FileDialog Base class for the OpenDialog and the SaveDialog Inheritance System.Object Responder View Toplevel Window Dialog FileDialog OpenDialog SaveDialog Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members Dialog.AddButton(Button) Dialog.ProcessKey(KeyEvent) Window.Title Window.Add(View) Window.Remove(View) Window.RemoveAll() Window.Redraw(Rect) Window.MouseEvent(MouseEvent) Window.Text Window.TextAlignment Toplevel.Running Toplevel.Ready Toplevel.Create() Toplevel.CanFocus Toplevel.Modal Toplevel.MenuBar Toplevel.StatusBar Toplevel.OnKeyDown(KeyEvent) Toplevel.OnKeyUp(KeyEvent) View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View[]) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.PositionCursor() View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.KeyUp View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class FileDialog : Dialog, IDisposable, ISupportInitializeNotification, ISupportInitialize Constructors FileDialog() Initializes a new FileDialog . Declaration public FileDialog() FileDialog(ustring, ustring, ustring, ustring) Initializes a new instance of FileDialog Declaration public FileDialog(ustring title, ustring prompt, ustring nameFieldLabel, ustring message) Parameters Type Name Description NStack.ustring title The title. NStack.ustring prompt The prompt. NStack.ustring nameFieldLabel The name field label. NStack.ustring message The message. Properties AllowedFileTypes The array of filename extensions allowed, or null if all file extensions are allowed. Declaration public string[] AllowedFileTypes { get; set; } Property Value Type Description System.String [] The allowed file types. AllowsOtherFileTypes Gets or sets a value indicating whether this FileDialog allows the file to be saved with a different extension Declaration public bool AllowsOtherFileTypes { get; set; } Property Value Type Description System.Boolean true if allows other file types; otherwise, false . Canceled Check if the dialog was or not canceled. Declaration public bool Canceled { get; } Property Value Type Description System.Boolean CanCreateDirectories Gets or sets a value indicating whether this FileDialog can create directories. Declaration public bool CanCreateDirectories { get; set; } Property Value Type Description System.Boolean true if can create directories; otherwise, false . DirectoryPath Gets or sets the directory path for this panel Declaration public ustring DirectoryPath { get; set; } Property Value Type Description NStack.ustring The directory path. FilePath The File path that is currently shown on the panel Declaration public ustring FilePath { get; set; } Property Value Type Description NStack.ustring The absolute file path for the file path entered. IsExtensionHidden Gets or sets a value indicating whether this FileDialog is extension hidden. Declaration public bool IsExtensionHidden { get; set; } Property Value Type Description System.Boolean true if is extension hidden; otherwise, false . Message Gets or sets the message displayed to the user, defaults to nothing Declaration public ustring Message { get; set; } Property Value Type Description NStack.ustring The message. NameFieldLabel Gets or sets the name field label. Declaration public ustring NameFieldLabel { get; set; } Property Value Type Description NStack.ustring The name field label. Prompt Gets or sets the prompt label for the Button displayed to the user Declaration public ustring Prompt { get; set; } Property Value Type Description NStack.ustring The prompt. Methods WillPresent() Invoked by Begin(Toplevel) as part of the Run(Toplevel) after the views have been laid out, and before the views are drawn for the first time. Declaration public override void WillPresent() Overrides Toplevel.WillPresent() Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize"
+ "keywords": "Class FileDialog Base class for the OpenDialog and the SaveDialog Inheritance System.Object Responder View Toplevel Window Dialog FileDialog OpenDialog SaveDialog Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members Dialog.AddButton(Button) Dialog.ProcessKey(KeyEvent) Window.Title Window.Add(View) Window.Remove(View) Window.RemoveAll() Window.Redraw(Rect) Window.MouseEvent(MouseEvent) Window.Text Window.TextAlignment Toplevel.Running Toplevel.Loaded Toplevel.Ready Toplevel.Unloaded Toplevel.Create() Toplevel.CanFocus Toplevel.Modal Toplevel.MenuBar Toplevel.StatusBar Toplevel.OnKeyDown(KeyEvent) Toplevel.OnKeyUp(KeyEvent) Toplevel.ProcessColdKey(KeyEvent) View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Shortcut View.ShortcutTag View.ShortcutAction View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View[]) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.PositionCursor() View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessHotKey(KeyEvent) View.KeyDown View.KeyUp View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.AutoSize View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class FileDialog : Dialog, IDisposable, ISupportInitializeNotification, ISupportInitialize Constructors FileDialog() Initializes a new FileDialog . Declaration public FileDialog() FileDialog(ustring, ustring, ustring, ustring) Initializes a new instance of FileDialog Declaration public FileDialog(ustring title, ustring prompt, ustring nameFieldLabel, ustring message) Parameters Type Name Description NStack.ustring title The title. NStack.ustring prompt The prompt. NStack.ustring nameFieldLabel The name field label. NStack.ustring message The message. Properties AllowedFileTypes The array of filename extensions allowed, or null if all file extensions are allowed. Declaration public string[] AllowedFileTypes { get; set; } Property Value Type Description System.String [] The allowed file types. AllowsOtherFileTypes Gets or sets a value indicating whether this FileDialog allows the file to be saved with a different extension Declaration public bool AllowsOtherFileTypes { get; set; } Property Value Type Description System.Boolean true if allows other file types; otherwise, false . Canceled Check if the dialog was or not canceled. Declaration public bool Canceled { get; } Property Value Type Description System.Boolean CanCreateDirectories Gets or sets a value indicating whether this FileDialog can create directories. Declaration public bool CanCreateDirectories { get; set; } Property Value Type Description System.Boolean true if can create directories; otherwise, false . DirectoryPath Gets or sets the directory path for this panel Declaration public ustring DirectoryPath { get; set; } Property Value Type Description NStack.ustring The directory path. FilePath The File path that is currently shown on the panel Declaration public ustring FilePath { get; set; } Property Value Type Description NStack.ustring The absolute file path for the file path entered. IsExtensionHidden Gets or sets a value indicating whether this FileDialog is extension hidden. Declaration public bool IsExtensionHidden { get; set; } Property Value Type Description System.Boolean true if is extension hidden; otherwise, false . Message Gets or sets the message displayed to the user, defaults to nothing Declaration public ustring Message { get; set; } Property Value Type Description NStack.ustring The message. NameFieldLabel Gets or sets the name field label. Declaration public ustring NameFieldLabel { get; set; } Property Value Type Description NStack.ustring The name field label. Prompt Gets or sets the prompt label for the Button displayed to the user Declaration public ustring Prompt { get; set; } Property Value Type Description NStack.ustring The prompt. Methods WillPresent() Invoked by Begin(Toplevel) as part of the Run(Toplevel) after the views have been laid out, and before the views are drawn for the first time. Declaration public override void WillPresent() Overrides Toplevel.WillPresent() Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize"
},
"api/Terminal.Gui/Terminal.Gui.FrameView.html": {
"href": "api/Terminal.Gui/Terminal.Gui.FrameView.html",
"title": "Class FrameView",
- "keywords": "Class FrameView The FrameView is a container frame that draws a frame around the contents. It is similar to a GroupBox in Windows. Inheritance System.Object Responder View FrameView Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.CanFocus View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View[]) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.PositionCursor() View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessKey(KeyEvent) View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.MouseEvent(MouseEvent) Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class FrameView : View, IDisposable, ISupportInitializeNotification, ISupportInitialize Constructors FrameView() Initializes a new instance of the FrameView class using Computed layout. Declaration public FrameView() FrameView(ustring) Initializes a new instance of the FrameView class using Computed layout. Declaration public FrameView(ustring title) Parameters Type Name Description NStack.ustring title Title. FrameView(Rect, ustring) Initializes a new instance of the FrameView class using Absolute layout. Declaration public FrameView(Rect frame, ustring title = null) Parameters Type Name Description Rect frame Frame. NStack.ustring title Title. FrameView(Rect, ustring, View[]) Initializes a new instance of the FrameView class using Computed layout. Declaration public FrameView(Rect frame, ustring title, View[] views) Parameters Type Name Description Rect frame Frame. NStack.ustring title Title. View [] views Views. Properties Text The text displayed by the Label . Declaration public override ustring Text { get; set; } Property Value Type Description NStack.ustring Overrides View.Text TextAlignment Controls the text-alignment property of the label, changing it will redisplay the Label . Declaration public override TextAlignment TextAlignment { get; set; } Property Value Type Description TextAlignment The text alignment. Overrides View.TextAlignment Title The title to be displayed for this FrameView . Declaration public ustring Title { get; set; } Property Value Type Description NStack.ustring The title. Methods Add(View) Add the specified View to this container. Declaration public override void Add(View view) Parameters Type Name Description View view View to add to this container Overrides View.Add(View) Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds The bounds (view-relative region) to redraw. Overrides View.Redraw(Rect) Remarks 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. Remove(View) Removes a View from this container. Declaration public override void Remove(View view) Parameters Type Name Description View view Overrides View.Remove(View) Remarks RemoveAll() Removes all View s from this container. Declaration public override void RemoveAll() Overrides View.RemoveAll() Remarks Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize"
+ "keywords": "Class FrameView The FrameView is a container frame that draws a frame around the contents. It is similar to a GroupBox in Windows. Inheritance System.Object Responder View FrameView Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Shortcut View.ShortcutTag View.ShortcutAction View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.CanFocus View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View[]) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.PositionCursor() View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessKey(KeyEvent) View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.AutoSize View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.MouseEvent(MouseEvent) Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class FrameView : View, IDisposable, ISupportInitializeNotification, ISupportInitialize Constructors FrameView() Initializes a new instance of the FrameView class using Computed layout. Declaration public FrameView() FrameView(ustring) Initializes a new instance of the FrameView class using Computed layout. Declaration public FrameView(ustring title) Parameters Type Name Description NStack.ustring title Title. FrameView(Rect, ustring) Initializes a new instance of the FrameView class using Absolute layout. Declaration public FrameView(Rect frame, ustring title = null) Parameters Type Name Description Rect frame Frame. NStack.ustring title Title. FrameView(Rect, ustring, View[]) Initializes a new instance of the FrameView class using Computed layout. Declaration public FrameView(Rect frame, ustring title, View[] views) Parameters Type Name Description Rect frame Frame. NStack.ustring title Title. View [] views Views. Properties Text The text displayed by the Label . Declaration public override ustring Text { get; set; } Property Value Type Description NStack.ustring Overrides View.Text TextAlignment Controls the text-alignment property of the label, changing it will redisplay the Label . Declaration public override TextAlignment TextAlignment { get; set; } Property Value Type Description TextAlignment The text alignment. Overrides View.TextAlignment Title The title to be displayed for this FrameView . Declaration public ustring Title { get; set; } Property Value Type Description NStack.ustring The title. Methods Add(View) Add the specified View to this container. Declaration public override void Add(View view) Parameters Type Name Description View view View to add to this container Overrides View.Add(View) Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds The bounds (view-relative region) to redraw. Overrides View.Redraw(Rect) Remarks 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. Remove(View) Removes a View from this container. Declaration public override void Remove(View view) Parameters Type Name Description View view Overrides View.Remove(View) Remarks RemoveAll() Removes all View s from this container. Declaration public override void RemoveAll() Overrides View.RemoveAll() Remarks Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize"
},
"api/Terminal.Gui/Terminal.Gui.HexView.html": {
"href": "api/Terminal.Gui/Terminal.Gui.HexView.html",
"title": "Class HexView",
- "keywords": "Class HexView An hex viewer and editor View over a System.IO.Stream Inheritance System.Object Responder View HexView Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.CanFocus View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View) View.Add(View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.Text View.TextAlignment View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.MouseEvent(MouseEvent) Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class HexView : View, IDisposable, ISupportInitializeNotification, ISupportInitialize Remarks HexView provides a hex editor on top of a seekable System.IO.Stream with the left side showing an hex dump of the values in the System.IO.Stream and the right side showing the contents (filtered to non-control sequence ASCII characters). Users can switch from one side to the other by using the tab key. To enable editing, set AllowEdits to true. When AllowEdits is true the user can make changes to the hexadecimal values of the System.IO.Stream . Any changes are tracked in the Edits property (a System.Collections.Generic.SortedDictionary`2 ) indicating the position where the changes were made and the new values. A convenience method, ApplyEdits() will apply the edits to the System.IO.Stream . Control the first byte shown by setting the DisplayStart property to an offset in the stream. Constructors HexView() Initialzies a HexView class using Computed layout. Declaration public HexView() HexView(Stream) Initialzies a HexView class using Computed layout. Declaration public HexView(Stream source) Parameters Type Name Description System.IO.Stream source The System.IO.Stream to view and edit as hex, this System.IO.Stream must support seeking, or an exception will be thrown. Properties AllowEdits Gets or sets whether this HexView allow editing of the System.IO.Stream of the underlying System.IO.Stream . Declaration public bool AllowEdits { get; set; } Property Value Type Description System.Boolean true if allow edits; otherwise, false . DisplayStart Sets or gets the offset into the System.IO.Stream that will displayed at the top of the HexView Declaration public long DisplayStart { get; set; } Property Value Type Description System.Int64 The display start. Edits Gets a System.Collections.Generic.SortedDictionary`2 describing the edits done to the HexView . Each Key indicates an offset where an edit was made and the Value is the changed byte. Declaration public IReadOnlyDictionary Edits { get; } Property Value Type Description System.Collections.Generic.IReadOnlyDictionary < System.Int64 , System.Byte > The edits. Frame Gets or sets the frame for the view. The frame is relative to the view's container ( SuperView ). Declaration public override Rect Frame { get; set; } Property Value Type Description Rect The frame. Overrides View.Frame Remarks 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 . Source Sets or gets the System.IO.Stream the HexView is operating on; the stream must support seeking ( System.IO.Stream.CanSeek == true). Declaration public Stream Source { get; set; } Property Value Type Description System.IO.Stream The source. Methods ApplyEdits() This method applies andy edits made to the System.IO.Stream and resets the contents of the Edits property Declaration public void ApplyEdits() PositionCursor() Positions the cursor in the right position based on the currently focused view in the chain. Declaration public override void PositionCursor() Overrides View.PositionCursor() ProcessKey(KeyEvent) If the view is focused, gives the view a chance to process the keystroke. Declaration public override bool ProcessKey(KeyEvent keyEvent) Parameters Type Name Description KeyEvent keyEvent Contains the details about the key that produced the event. Returns Type Description System.Boolean Overrides View.ProcessKey(KeyEvent) Remarks 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. Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds The bounds (view-relative region) to redraw. Overrides View.Redraw(Rect) Remarks 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. Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize"
+ "keywords": "Class HexView An hex viewer and editor View over a System.IO.Stream Inheritance System.Object Responder View HexView Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Shortcut View.ShortcutTag View.ShortcutAction View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.CanFocus View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View) View.Add(View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.Text View.AutoSize View.TextAlignment View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.MouseEvent(MouseEvent) Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class HexView : View, IDisposable, ISupportInitializeNotification, ISupportInitialize Remarks HexView provides a hex editor on top of a seekable System.IO.Stream with the left side showing an hex dump of the values in the System.IO.Stream and the right side showing the contents (filtered to non-control sequence ASCII characters). Users can switch from one side to the other by using the tab key. To enable editing, set AllowEdits to true. When AllowEdits is true the user can make changes to the hexadecimal values of the System.IO.Stream . Any changes are tracked in the Edits property (a System.Collections.Generic.SortedDictionary`2 ) indicating the position where the changes were made and the new values. A convenience method, ApplyEdits() will apply the edits to the System.IO.Stream . Control the first byte shown by setting the DisplayStart property to an offset in the stream. Constructors HexView() Initialzies a HexView class using Computed layout. Declaration public HexView() HexView(Stream) Initialzies a HexView class using Computed layout. Declaration public HexView(Stream source) Parameters Type Name Description System.IO.Stream source The System.IO.Stream to view and edit as hex, this System.IO.Stream must support seeking, or an exception will be thrown. Properties AllowEdits Gets or sets whether this HexView allow editing of the System.IO.Stream of the underlying System.IO.Stream . Declaration public bool AllowEdits { get; set; } Property Value Type Description System.Boolean true if allow edits; otherwise, false . DisplayStart Sets or gets the offset into the System.IO.Stream that will displayed at the top of the HexView Declaration public long DisplayStart { get; set; } Property Value Type Description System.Int64 The display start. Edits Gets a System.Collections.Generic.SortedDictionary`2 describing the edits done to the HexView . Each Key indicates an offset where an edit was made and the Value is the changed byte. Declaration public IReadOnlyDictionary Edits { get; } Property Value Type Description System.Collections.Generic.IReadOnlyDictionary < System.Int64 , System.Byte > The edits. Frame Gets or sets the frame for the view. The frame is relative to the view's container ( SuperView ). Declaration public override Rect Frame { get; set; } Property Value Type Description Rect The frame. Overrides View.Frame Remarks 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 . Source Sets or gets the System.IO.Stream the HexView is operating on; the stream must support seeking ( System.IO.Stream.CanSeek == true). Declaration public Stream Source { get; set; } Property Value Type Description System.IO.Stream The source. Methods ApplyEdits() This method applies andy edits made to the System.IO.Stream and resets the contents of the Edits property Declaration public void ApplyEdits() PositionCursor() Positions the cursor in the right position based on the currently focused view in the chain. Declaration public override void PositionCursor() Overrides View.PositionCursor() ProcessKey(KeyEvent) If the view is focused, gives the view a chance to process the keystroke. Declaration public override bool ProcessKey(KeyEvent keyEvent) Parameters Type Name Description KeyEvent keyEvent Contains the details about the key that produced the event. Returns Type Description System.Boolean Overrides View.ProcessKey(KeyEvent) Remarks 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. Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds The bounds (view-relative region) to redraw. Overrides View.Redraw(Rect) Remarks 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. Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize"
},
"api/Terminal.Gui/Terminal.Gui.html": {
"href": "api/Terminal.Gui/Terminal.Gui.html",
"title": "Namespace Terminal.Gui",
- "keywords": "Namespace Terminal.Gui Classes Application A static, singelton class provding the main application driver for Terminal.Gui apps. Application.ResizedEventArgs Event arguments for the Resized event. Application.RunState Captures the execution state for the provided Terminal.Gui.Application.RunState.Toplevel view. Button Button is a View that provides an item that invokes an System.Action when activated by the user. CheckBox The CheckBox View shows an on/off toggle that the user can set Clipboard Provides cut, copy, and paste support for the clipboard. NOTE: Currently not implemented. Colors The default ColorScheme s for the application. ColorScheme Color scheme definitions, they cover some common scenarios and are used typically in containers such as Window and FrameView to set the scheme that is used by all the views contained inside. ComboBox ComboBox control ConsoleDriver ConsoleDriver is an abstract class that defines the requirements for a console driver. There are currently three implementations: Terminal.Gui.CursesDriver (for Unix and Mac), Terminal.Gui.WindowsDriver , and Terminal.Gui.NetDriver that uses the .NET Console API. DateField Simple Date editing View DateTimeEventArgs Defines the event arguments for DateChanged and TimeChanged events. Dialog The Dialog View is a Window that by default is centered and contains one or more Button s. It defaults to the Dialog color scheme and has a 1 cell padding around the edges. Dim Dim properties of a View to control the position. FakeConsole FakeDriver Implements a mock ConsoleDriver for unit testing FileDialog Base class for the OpenDialog and the SaveDialog FrameView The FrameView is a container frame that draws a frame around the contents. It is similar to a GroupBox in Windows. HexView An hex viewer and editor View over a System.IO.Stream KeyEvent Describes a keyboard event. KeyModifiers Identifies the state of the \"shift\"-keys within a event. Label The Label View displays a string at a given position and supports multiple lines separted by newline characters. Multi-line Labels support word wrap. ListView ListView View renders a scrollable list of data where each item can be activated to perform an action. ListViewItemEventArgs System.EventArgs for ListView events. ListWrapper Implements an IListDataSource that renders arbitrary System.Collections.IList instances for ListView . MainLoop Simple main loop implementation that can be used to monitor file descriptor, run timers and idle handlers. MenuBar The MenuBar provides a menu for Terminal.Gui applications. MenuBarItem A MenuBarItem contains MenuBarItem s or MenuItem s. MenuItem A MenuItem has a title, an associated help text, and an action to execute on activation. MessageBox MessageBox displays a modal message to the user, with a title, a message and a series of options that the user can choose from. NetMainLoop Mainloop intended to be used with the .NET System.Console API, and can be used on Windows and Unix, it is cross platform but lacks things like file descriptor monitoring. OpenDialog The OpenDialog provides an interactive dialog box for users to select files or directories. Pos Describes the position of a View which can be an absolute value, a percentage, centered, or relative to the ending dimension. Integer values are implicitly convertible to an absolute Pos . These objects are created using the static methods Percent, AnchorEnd, and Center. The Pos objects can be combined with the addition and subtraction operators. ProgressBar A Progress Bar view that can indicate progress of an activity visually. RadioGroup RadioGroup shows a group of radio labels, only one of those can be selected at a given time RadioGroup.SelectedItemChangedArgs Event arguments for the SelectedItemChagned event. Responder Responder base class implemented by objects that want to participate on keyboard and mouse input. SaveDialog The SaveDialog provides an interactive dialog box for users to pick a file to save. ScrollBarView ScrollBarViews are views that display a 1-character scrollbar, either horizontal or vertical ScrollView Scrollviews are views that present a window into a virtual space where subviews are added. Similar to the iOS UIScrollView. StatusBar A status bar is a View that snaps to the bottom of a Toplevel displaying set of StatusItem s. The StatusBar should be context sensitive. This means, if the main menu and an open text editor are visible, the items probably shown will be ~F1~ Help ~F2~ Save ~F3~ Load. While a dialog to ask a file to load is executed, the remaining commands will probably be ~F1~ Help. So for each context must be a new instance of a statusbar. StatusItem StatusItem objects are contained by StatusBar View s. Each StatusItem has a title, a shortcut (hotkey), and an Action that will be invoked when the Shortcut is pressed. The Shortcut will be a global hotkey for the application in the current context of the screen. The colour of the Title will be changed after each ~. A Title set to `~F1~ Help` will render as *F1* using HotNormal and *Help* as HotNormal . TextField Single-line text entry View TextFormatter Provides text formatting capabilities for console apps. Supports, hotkeys, horizontal alignment, multille lines, and word-based line wrap. TextView Multi-line text editing View TimeField Time editing View Toplevel Toplevel views can be modally executed. View View is the base class for all views on the screen and represents a visible element that can render itself and contains zero or more nested views. View.FocusEventArgs Defines the event arguments for Terminal.Gui.View.SetFocus(Terminal.Gui.View) View.KeyEventEventArgs Defines the event arguments for KeyEvent View.LayoutEventArgs Event arguments for the LayoutComplete event. View.MouseEventArgs Specifies the event arguments for MouseEvent Window A Toplevel View that draws a border around its Frame with a Title at the top. Structs Attribute Attributes are used as elements that contain both a foreground and a background or platform specific features MouseEvent Describes a mouse event Point Represents an ordered pair of integer x- and y-coordinates that defines a point in a two-dimensional plane. Rect Stores a set of four integers that represent the location and size of a rectangle Size Stores an ordered pair of integers, which specify a Height and Width. Interfaces IListDataSource Implement IListDataSource to provide custom rendering for a ListView . IMainLoopDriver Public interface to create your own platform specific main loop driver. Enums Color Basic colors that can be used to set the foreground and background colors in console applications. ConsoleDriver.DiagnosticFlags Enables diagnostic funcions DisplayModeLayout Used for choose the display mode of this RadioGroup Key The Key enumeration contains special encoding for some keys, but can also encode all the unicode values that can be passed. LayoutStyle Determines the LayoutStyle for a view, if Absolute, during LayoutSubviews, the value from the Frame will be used, if the value is Computed, then the Frame will be updated from the X, Y Pos objects and the Width and Height Dim objects. MenuItemCheckStyle Specifies how a MenuItem shows selection state. MouseFlags Mouse flags reported in MouseEvent . TextAlignment Text alignment enumeration, controls how text is displayed."
+ "keywords": "Namespace Terminal.Gui Classes Application A static, singelton class provding the main application driver for Terminal.Gui apps. Application.ResizedEventArgs Event arguments for the Resized event. Application.RunState Captures the execution state for the provided Terminal.Gui.Application.RunState.Toplevel view. Button Button is a View that provides an item that invokes an System.Action when activated by the user. CheckBox The CheckBox View shows an on/off toggle that the user can set Clipboard Provides cut, copy, and paste support for the clipboard. NOTE: Currently not implemented. Colors The default ColorScheme s for the application. ColorScheme Color scheme definitions, they cover some common scenarios and are used typically in containers such as Window and FrameView to set the scheme that is used by all the views contained inside. ComboBox ComboBox control ConsoleDriver ConsoleDriver is an abstract class that defines the requirements for a console driver. There are currently three implementations: Terminal.Gui.CursesDriver (for Unix and Mac), Terminal.Gui.WindowsDriver , and Terminal.Gui.NetDriver that uses the .NET Console API. DateField Simple Date editing View DateTimeEventArgs Defines the event arguments for DateChanged and TimeChanged events. Dialog The Dialog View is a Window that by default is centered and contains one or more Button s. It defaults to the Dialog color scheme and has a 1 cell padding around the edges. Dim Dim properties of a View to control the position. FakeConsole FakeDriver Implements a mock ConsoleDriver for unit testing FileDialog Base class for the OpenDialog and the SaveDialog FrameView The FrameView is a container frame that draws a frame around the contents. It is similar to a GroupBox in Windows. HexView An hex viewer and editor View over a System.IO.Stream KeyEvent Describes a keyboard event. KeyModifiers Identifies the state of the \"shift\"-keys within a event. Label The Label View displays a string at a given position and supports multiple lines separted by newline characters. Multi-line Labels support word wrap. ListView ListView View renders a scrollable list of data where each item can be activated to perform an action. ListViewItemEventArgs System.EventArgs for ListView events. ListWrapper Implements an IListDataSource that renders arbitrary System.Collections.IList instances for ListView . MainLoop Simple main loop implementation that can be used to monitor file descriptor, run timers and idle handlers. MenuBar The MenuBar provides a menu for Terminal.Gui applications. MenuBarItem A MenuBarItem contains MenuBarItem s or MenuItem s. MenuItem A MenuItem has a title, an associated help text, and an action to execute on activation. MessageBox MessageBox displays a modal message to the user, with a title, a message and a series of options that the user can choose from. NetMainLoop Mainloop intended to be used with the .NET System.Console API, and can be used on Windows and Unix, it is cross platform but lacks things like file descriptor monitoring. OpenDialog The OpenDialog provides an interactive dialog box for users to select files or directories. Pos Describes the position of a View which can be an absolute value, a percentage, centered, or relative to the ending dimension. Integer values are implicitly convertible to an absolute Pos . These objects are created using the static methods Percent, AnchorEnd, and Center. The Pos objects can be combined with the addition and subtraction operators. ProgressBar A Progress Bar view that can indicate progress of an activity visually. RadioGroup RadioGroup shows a group of radio labels, only one of those can be selected at a given time RadioGroup.SelectedItemChangedArgs Event arguments for the SelectedItemChagned event. Responder Responder base class implemented by objects that want to participate on keyboard and mouse input. SaveDialog The SaveDialog provides an interactive dialog box for users to pick a file to save. ScrollBarView ScrollBarViews are views that display a 1-character scrollbar, either horizontal or vertical ScrollView Scrollviews are views that present a window into a virtual space where subviews are added. Similar to the iOS UIScrollView. ShortcutHelper Represents a helper to manipulate shortcut keys used on views. StatusBar A status bar is a View that snaps to the bottom of a Toplevel displaying set of StatusItem s. The StatusBar should be context sensitive. This means, if the main menu and an open text editor are visible, the items probably shown will be ~F1~ Help ~F2~ Save ~F3~ Load. While a dialog to ask a file to load is executed, the remaining commands will probably be ~F1~ Help. So for each context must be a new instance of a statusbar. StatusItem StatusItem objects are contained by StatusBar View s. Each StatusItem has a title, a shortcut (hotkey), and an Action that will be invoked when the Shortcut is pressed. The Shortcut will be a global hotkey for the application in the current context of the screen. The colour of the Title will be changed after each ~. A Title set to `~F1~ Help` will render as *F1* using HotNormal and *Help* as HotNormal . TextChangingEventArgs An System.EventArgs which allows passing a cancelable new text value event. TextField Single-line text entry View TextFormatter Provides text formatting capabilities for console apps. Supports, hotkeys, horizontal alignment, multiple lines, and word-based line wrap. TextView Multi-line text editing View TimeField Time editing View Toplevel Toplevel views can be modally executed. View View is the base class for all views on the screen and represents a visible element that can render itself and contains zero or more nested views. View.FocusEventArgs Defines the event arguments for Terminal.Gui.View.SetFocus(Terminal.Gui.View) View.KeyEventEventArgs Defines the event arguments for KeyEvent View.LayoutEventArgs Event arguments for the LayoutComplete event. View.MouseEventArgs Specifies the event arguments for MouseEvent Window A Toplevel View that draws a border around its Frame with a Title at the top. Structs Attribute Attributes are used as elements that contain both a foreground and a background or platform specific features MouseEvent Describes a mouse event Point Represents an ordered pair of integer x- and y-coordinates that defines a point in a two-dimensional plane. Rect Stores a set of four integers that represent the location and size of a rectangle Size Stores an ordered pair of integers, which specify a Height and Width. Interfaces IListDataSource Implement IListDataSource to provide custom rendering for a ListView . IMainLoopDriver Public interface to create your own platform specific main loop driver. Enums Color Basic colors that can be used to set the foreground and background colors in console applications. ConsoleDriver.DiagnosticFlags Enables diagnostic funcions DisplayModeLayout Used for choose the display mode of this RadioGroup Key The Key enumeration contains special encoding for some keys, but can also encode all the unicode values that can be passed. LayoutStyle Determines the LayoutStyle for a view, if Absolute, during LayoutSubviews, the value from the Frame will be used, if the value is Computed, then the Frame will be updated from the X, Y Pos objects and the Width and Height Dim objects. MenuItemCheckStyle Specifies how a MenuItem shows selection state. MouseFlags Mouse flags reported in MouseEvent . TextAlignment Text alignment enumeration, controls how text is displayed."
},
"api/Terminal.Gui/Terminal.Gui.IListDataSource.html": {
"href": "api/Terminal.Gui/Terminal.Gui.IListDataSource.html",
@@ -132,7 +132,7 @@
"api/Terminal.Gui/Terminal.Gui.Key.html": {
"href": "api/Terminal.Gui/Terminal.Gui.Key.html",
"title": "Enum Key",
- "keywords": "Enum Key The Key enumeration contains special encoding for some keys, but can also encode all the unicode values that can be passed. Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax [Flags] public enum Key : uint Remarks If the SpecialMask is set, then the value is that of the special mask, otherwise, the value is the one of the lower bits (as extracted by CharMask ) Control keys are the values between 1 and 26 corresponding to Control-A to Control-Z Unicode runes are also stored here, the letter 'A\" for example is encoded as a value 65 (not surfaced in the enum). Fields Name Description AltMask When this value is set, the Key encodes the sequence Alt-KeyValue. And the actual value must be extracted by removing the AltMask. Backspace Backspace key. BackTab Shift-tab key (backwards tab key). CharMask Mask that indicates that this is a character value, values outside this range indicate special characters like Alt-key combinations or special keys on the keyboard like function keys, arrows keys and so on. ControlA The key code for the user pressing Control-A ControlB The key code for the user pressing Control-B ControlC The key code for the user pressing Control-C ControlD The key code for the user pressing Control-D ControlE The key code for the user pressing Control-E ControlF The key code for the user pressing Control-F ControlG The key code for the user pressing Control-G ControlH The key code for the user pressing Control-H ControlI The key code for the user pressing Control-I (same as the tab key). ControlJ The key code for the user pressing Control-J ControlK The key code for the user pressing Control-K ControlL The key code for the user pressing Control-L ControlM The key code for the user pressing Control-M ControlN The key code for the user pressing Control-N (same as the return key). ControlO The key code for the user pressing Control-O ControlP The key code for the user pressing Control-P ControlQ The key code for the user pressing Control-Q ControlR The key code for the user pressing Control-R ControlS The key code for the user pressing Control-S ControlSpace The key code for the user pressing Control-spacebar ControlT The key code for the user pressing Control-T ControlU The key code for the user pressing Control-U ControlV The key code for the user pressing Control-V ControlW The key code for the user pressing Control-W ControlX The key code for the user pressing Control-X ControlY The key code for the user pressing Control-Y ControlZ The key code for the user pressing Control-Z CtrlMask When this value is set, the Key encodes the sequence Ctrl-KeyValue. And the actual value must be extracted by removing the CtrlMask. CursorDown Cursor down key. CursorLeft Cursor left key. CursorRight Cursor right key. CursorUp Cursor up key Delete The key code for the user pressing the delete key. DeleteChar Delete character key End End key Enter The key code for the user pressing the return key. Esc The key code for the user pressing the escape key F1 F1 key. F10 F10 key. F11 F11 key. F12 F12 key. F2 F2 key. F3 F3 key. F4 F4 key. F5 F5 key. F6 F6 key. F7 F7 key. F8 F8 key. F9 F9 key. Home Home key InsertChar Insert character key PageDown Page Down key. PageUp Page Up key. ShiftMask When this value is set, the Key encodes the sequence Shift-KeyValue. Space The key code for the user pressing the space bar SpecialMask If the SpecialMask is set, then the value is that of the special mask, otherwise, the value is the one of the lower bits (as extracted by CharMask ). Tab The key code for the user pressing the tab key (forwards tab key). Unknown A key with an unknown mapping was raised."
+ "keywords": "Enum Key The Key enumeration contains special encoding for some keys, but can also encode all the unicode values that can be passed. Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax [Flags] public enum Key : uint Remarks If the SpecialMask is set, then the value is that of the special mask, otherwise, the value is the one of the lower bits (as extracted by CharMask ) Numerics keys are the values between 48 and 57 corresponding to 0 to 9 Upper alpha keys are the values between 65 and 90 corresponding to A to Z Unicode runes are also stored here, the letter 'A\" for example is encoded as a value 65 (not surfaced in the enum). Fields Name Description A The key code for the user pressing Shift-A AltMask When this value is set, the Key encodes the sequence Alt-KeyValue. And the actual value must be extracted by removing the AltMask. B The key code for the user pressing Shift-B Backspace Backspace key. BackTab Shift-tab key (backwards tab key). C The key code for the user pressing Shift-C CharMask Mask that indicates that this is a character value, values outside this range indicate special characters like Alt-key combinations or special keys on the keyboard like function keys, arrows keys and so on. CtrlMask When this value is set, the Key encodes the sequence Ctrl-KeyValue. And the actual value must be extracted by removing the CtrlMask. CursorDown Cursor down key. CursorLeft Cursor left key. CursorRight Cursor right key. CursorUp Cursor up key D The key code for the user pressing Shift-D D0 Digit 0. D1 Digit 1. D2 Digit 2. D3 Digit 3. D4 Digit 4. D5 Digit 5. D6 Digit 6. D7 Digit 7. D8 Digit 8. D9 Digit 9. Delete The key code for the user pressing the delete key. DeleteChar Delete character key E The key code for the user pressing Shift-E End End key Enter The key code for the user pressing the return key. Esc The key code for the user pressing the escape key F The key code for the user pressing Shift-F F1 F1 key. F10 F10 key. F11 F11 key. F12 F12 key. F2 F2 key. F3 F3 key. F4 F4 key. F5 F5 key. F6 F6 key. F7 F7 key. F8 F8 key. F9 F9 key. G The key code for the user pressing Shift-G H The key code for the user pressing Shift-H Home Home key I The key code for the user pressing Shift-I InsertChar Insert character key J The key code for the user pressing Shift-J K The key code for the user pressing Shift-K L The key code for the user pressing Shift-L M The key code for the user pressing Shift-M N The key code for the user pressing Shift-N Null The key code representing null or empty O The key code for the user pressing Shift-O P The key code for the user pressing Shift-P PageDown Page Down key. PageUp Page Up key. Q The key code for the user pressing Shift-Q R The key code for the user pressing Shift-R S The key code for the user pressing Shift-S ShiftMask When this value is set, the Key encodes the sequence Shift-KeyValue. Space The key code for the user pressing the space bar SpecialMask If the SpecialMask is set, then the value is that of the special mask, otherwise, the value is the one of the lower bits (as extracted by CharMask ). T The key code for the user pressing Shift-T Tab The key code for the user pressing the tab key (forwards tab key). U The key code for the user pressing Shift-U Unknown A key with an unknown mapping was raised. V The key code for the user pressing Shift-V W The key code for the user pressing Shift-W X The key code for the user pressing Shift-X Y The key code for the user pressing Shift-Y Z The key code for the user pressing Shift-Z"
},
"api/Terminal.Gui/Terminal.Gui.KeyEvent.html": {
"href": "api/Terminal.Gui/Terminal.Gui.KeyEvent.html",
@@ -147,7 +147,7 @@
"api/Terminal.Gui/Terminal.Gui.Label.html": {
"href": "api/Terminal.Gui/Terminal.Gui.Label.html",
"title": "Class Label",
- "keywords": "Class Label The Label View displays a string at a given position and supports multiple lines separted by newline characters. Multi-line Labels support word wrap. Inheritance System.Object Responder View Label Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.CanFocus View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View) View.Add(View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.PositionCursor() View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.Redraw(Rect) View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessKey(KeyEvent) View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.Text View.TextAlignment View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.MouseEvent(MouseEvent) Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class Label : View, IDisposable, ISupportInitializeNotification, ISupportInitialize Remarks The Label view is functionality identical to View and is included for API backwards compatibility. Constructors Label() Declaration public Label() Label(ustring) Initializes a new instance of View using Computed layout. Declaration public Label(ustring text) Parameters Type Name Description NStack.ustring text text to initialize the Text property with. Remarks 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. Label(Int32, Int32, ustring) Initializes a new instance of View using Absolute layout. Declaration public Label(int x, int y, ustring text) Parameters Type Name Description System.Int32 x column to locate the Label. System.Int32 y row to locate the Label. NStack.ustring text text to initialize the Text property with. Remarks 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. Label(Rect) Initializes a new instance of a Absolute View class with the absolute dimensions specified in the frame parameter. Declaration public Label(Rect frame) Parameters Type Name Description Rect frame The region covered by this view. Remarks This constructor intitalize a View with a LayoutStyle of Absolute . Use View() to initialize a View with LayoutStyle of Computed Label(Rect, ustring) Initializes a new instance of View using Absolute layout. Declaration public Label(Rect rect, ustring text) Parameters Type Name Description Rect rect Location. NStack.ustring text text to initialize the Text property with. Remarks 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. Methods OnMouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public override bool OnMouseEvent(MouseEvent mouseEvent) Parameters Type Name Description MouseEvent mouseEvent Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides View.OnMouseEvent(MouseEvent) Events Clicked Clicked System.Action , raised when the user clicks the primary mouse button within the Bounds of this View or if the user presses the action key while this view is focused. (TODO: IsDefault) Declaration public event Action Clicked Event Type Type Description System.Action Remarks Client code can hook up to this event, it is raised when the button is activated either with the mouse or the keyboard. Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize"
+ "keywords": "Class Label The Label View displays a string at a given position and supports multiple lines separted by newline characters. Multi-line Labels support word wrap. Inheritance System.Object Responder View Label Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Shortcut View.ShortcutTag View.ShortcutAction View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.CanFocus View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View) View.Add(View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.PositionCursor() View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.Redraw(Rect) View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessKey(KeyEvent) View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.Text View.AutoSize View.TextAlignment View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.MouseEvent(MouseEvent) Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class Label : View, IDisposable, ISupportInitializeNotification, ISupportInitialize Remarks The Label view is functionality identical to View and is included for API backwards compatibility. Constructors Label() Declaration public Label() Label(ustring) Initializes a new instance of View using Computed layout. Declaration public Label(ustring text) Parameters Type Name Description NStack.ustring text text to initialize the Text property with. Remarks 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. Label(Int32, Int32, ustring) Initializes a new instance of View using Absolute layout. Declaration public Label(int x, int y, ustring text) Parameters Type Name Description System.Int32 x column to locate the Label. System.Int32 y row to locate the Label. NStack.ustring text text to initialize the Text property with. Remarks 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. Label(Rect) Initializes a new instance of a Absolute View class with the absolute dimensions specified in the frame parameter. Declaration public Label(Rect frame) Parameters Type Name Description Rect frame The region covered by this view. Remarks This constructor intitalize a View with a LayoutStyle of Absolute . Use View() to initialize a View with LayoutStyle of Computed Label(Rect, ustring) Initializes a new instance of View using Absolute layout. Declaration public Label(Rect rect, ustring text) Parameters Type Name Description Rect rect Location. NStack.ustring text text to initialize the Text property with. Remarks 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. Methods OnMouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public override bool OnMouseEvent(MouseEvent mouseEvent) Parameters Type Name Description MouseEvent mouseEvent Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides View.OnMouseEvent(MouseEvent) Events Clicked Clicked System.Action , raised when the user clicks the primary mouse button within the Bounds of this View or if the user presses the action key while this view is focused. (TODO: IsDefault) Declaration public event Action Clicked Event Type Type Description System.Action Remarks Client code can hook up to this event, it is raised when the button is activated either with the mouse or the keyboard. Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize"
},
"api/Terminal.Gui/Terminal.Gui.LayoutStyle.html": {
"href": "api/Terminal.Gui/Terminal.Gui.LayoutStyle.html",
@@ -157,7 +157,7 @@
"api/Terminal.Gui/Terminal.Gui.ListView.html": {
"href": "api/Terminal.Gui/Terminal.Gui.ListView.html",
"title": "Class ListView",
- "keywords": "Class ListView ListView View renders a scrollable list of data where each item can be activated to perform an action. Inheritance System.Object Responder View ListView Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.CanFocus View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View) View.Add(View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.Text View.TextAlignment View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class ListView : View, IDisposable, ISupportInitializeNotification, ISupportInitialize Remarks The ListView displays lists of data and allows the user to scroll through the data. Items in the can be activated firing an event (with the ENTER key or a mouse double-click). If the AllowsMarking property is true, elements of the list can be marked by the user. By default ListView uses System.Object.ToString() to render the items of any System.Collections.IList object (e.g. arrays, System.Collections.Generic.List , and other collections). Alternatively, an object that implements the IListDataSource interface can be provided giving full control of what is rendered. ListView can display any object that implements the System.Collections.IList interface. System.String values are converted into NStack.ustring values before rendering, and other values are converted into System.String by calling System.Object.ToString() and then converting to NStack.ustring . To change the contents of the ListView, set the Source property (when providing custom rendering via IListDataSource ) or call SetSource(IList) an System.Collections.IList is being used. When AllowsMarking is set to true the rendering will prefix the rendered items with [x] or [ ] and bind the SPACE key to toggle the selection. To implement a different marking style set AllowsMarking to false and implement custom rendering. Constructors ListView() Initializes a new instance of ListView . Set the Source property to display something. Declaration public ListView() ListView(IList) Initializes a new instance of ListView that will display the contents of the object implementing the System.Collections.IList interface, with relative positioning. Declaration public ListView(IList source) Parameters Type Name Description System.Collections.IList source An System.Collections.IList data source, if the elements are strings or ustrings, the string is rendered, otherwise the ToString() method is invoked on the result. ListView(IListDataSource) Initializes a new instance of ListView that will display the provided data source, using relative positioning. Declaration public ListView(IListDataSource source) Parameters Type Name Description IListDataSource source IListDataSource object that provides a mechanism to render the data. The number of elements on the collection should not change, if you must change, set the \"Source\" property to reset the internal settings of the ListView. ListView(Rect, IList) Initializes a new instance of ListView that will display the contents of the object implementing the System.Collections.IList interface with an absolute position. Declaration public ListView(Rect rect, IList source) Parameters Type Name Description Rect rect Frame for the listview. System.Collections.IList source An IList data source, if the elements of the IList are strings or ustrings, the string is rendered, otherwise the ToString() method is invoked on the result. ListView(Rect, IListDataSource) Initializes a new instance of ListView with the provided data source and an absolute position Declaration public ListView(Rect rect, IListDataSource source) Parameters Type Name Description Rect rect Frame for the listview. IListDataSource source IListDataSource object that provides a mechanism to render the data. The number of elements on the collection should not change, if you must change, set the \"Source\" property to reset the internal settings of the ListView. Properties AllowsMarking Gets or sets whether this ListView allows items to be marked. Declaration public bool AllowsMarking { get; set; } Property Value Type Description System.Boolean true if allows marking elements of the list; otherwise, false . Remarks If set to true, ListView will render items marked items with \"[x]\", and unmarked items with \"[ ]\" spaces. SPACE key will toggle marking. AllowsMultipleSelection If set to true allows more than one item to be selected. If false only allow one item selected. Declaration public bool AllowsMultipleSelection { get; set; } Property Value Type Description System.Boolean SelectedItem Gets or sets the index of the currently selected item. Declaration public int SelectedItem { get; set; } Property Value Type Description System.Int32 The selected item. Source Gets or sets the IListDataSource backing this ListView , enabling custom rendering. Declaration public IListDataSource Source { get; set; } Property Value Type Description IListDataSource The source. Remarks Use SetSource(IList) to set a new System.Collections.IList source. TopItem Gets or sets the item that is displayed at the top of the ListView . Declaration public int TopItem { get; set; } Property Value Type Description System.Int32 The top item. Methods AllowsAll() Prevents marking if it's not allowed mark and if it's not allows multiple selection. Declaration public virtual bool AllowsAll() Returns Type Description System.Boolean MarkUnmarkRow() Marks an unmarked row. Declaration public virtual bool MarkUnmarkRow() Returns Type Description System.Boolean MouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public override bool MouseEvent(MouseEvent me) Parameters Type Name Description MouseEvent me Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides Responder.MouseEvent(MouseEvent) MoveDown() Moves the selected item index to the next row. Declaration public virtual bool MoveDown() Returns Type Description System.Boolean MoveEnd() Moves the selected item index to the last row. Declaration public virtual bool MoveEnd() Returns Type Description System.Boolean MoveHome() Moves the selected item index to the first row. Declaration public virtual bool MoveHome() Returns Type Description System.Boolean MovePageDown() Moves the selected item index to the previous page. Declaration public virtual bool MovePageDown() Returns Type Description System.Boolean MovePageUp() Moves the selected item index to the next page. Declaration public virtual bool MovePageUp() Returns Type Description System.Boolean MoveUp() Moves the selected item index to the previous row. Declaration public virtual bool MoveUp() Returns Type Description System.Boolean OnEnter(View) Method invoked when a view gets focus. Declaration public override bool OnEnter(View view) Parameters Type Name Description View view The view that is losing focus. Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides View.OnEnter(View) OnLeave(View) Method invoked when a view loses focus. Declaration public override bool OnLeave(View view) Parameters Type Name Description View view The view that is getting focus. Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides View.OnLeave(View) OnOpenSelectedItem() Invokes the OnOpenSelectedItem event if it is defined. Declaration public virtual bool OnOpenSelectedItem() Returns Type Description System.Boolean OnSelectedChanged() Invokes the SelectedChanged event if it is defined. Declaration public virtual bool OnSelectedChanged() Returns Type Description System.Boolean PositionCursor() Positions the cursor in the right position based on the currently focused view in the chain. Declaration public override void PositionCursor() Overrides View.PositionCursor() ProcessKey(KeyEvent) If the view is focused, gives the view a chance to process the keystroke. Declaration public override bool ProcessKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides View.ProcessKey(KeyEvent) Remarks 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. Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds The bounds (view-relative region) to redraw. Overrides View.Redraw(Rect) Remarks 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. SetSource(IList) Sets the source of the ListView to an System.Collections.IList . Declaration public void SetSource(IList source) Parameters Type Name Description System.Collections.IList source Remarks Use the Source property to set a new IListDataSource source and use custome rendering. SetSourceAsync(IList) Sets the source to an System.Collections.IList value asynchronously. Declaration public Task SetSourceAsync(IList source) Parameters Type Name Description System.Collections.IList source Returns Type Description System.Threading.Tasks.Task An item implementing the IList interface. Remarks Use the Source property to set a new IListDataSource source and use custome rendering. Events OpenSelectedItem This event is raised when the user Double Clicks on an item or presses ENTER to open the selected item. Declaration public event Action OpenSelectedItem Event Type Type Description System.Action < ListViewItemEventArgs > SelectedItemChanged This event is raised when the selected item in the ListView has changed. Declaration public event Action SelectedItemChanged Event Type Type Description System.Action < ListViewItemEventArgs > Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize"
+ "keywords": "Class ListView ListView View renders a scrollable list of data where each item can be activated to perform an action. Inheritance System.Object Responder View ListView Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Shortcut View.ShortcutTag View.ShortcutAction View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.CanFocus View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View) View.Add(View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.Text View.AutoSize View.TextAlignment View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class ListView : View, IDisposable, ISupportInitializeNotification, ISupportInitialize Remarks The ListView displays lists of data and allows the user to scroll through the data. Items in the can be activated firing an event (with the ENTER key or a mouse double-click). If the AllowsMarking property is true, elements of the list can be marked by the user. By default ListView uses System.Object.ToString() to render the items of any System.Collections.IList object (e.g. arrays, System.Collections.Generic.List , and other collections). Alternatively, an object that implements the IListDataSource interface can be provided giving full control of what is rendered. ListView can display any object that implements the System.Collections.IList interface. System.String values are converted into NStack.ustring values before rendering, and other values are converted into System.String by calling System.Object.ToString() and then converting to NStack.ustring . To change the contents of the ListView, set the Source property (when providing custom rendering via IListDataSource ) or call SetSource(IList) an System.Collections.IList is being used. When AllowsMarking is set to true the rendering will prefix the rendered items with [x] or [ ] and bind the SPACE key to toggle the selection. To implement a different marking style set AllowsMarking to false and implement custom rendering. Constructors ListView() Initializes a new instance of ListView . Set the Source property to display something. Declaration public ListView() ListView(IList) Initializes a new instance of ListView that will display the contents of the object implementing the System.Collections.IList interface, with relative positioning. Declaration public ListView(IList source) Parameters Type Name Description System.Collections.IList source An System.Collections.IList data source, if the elements are strings or ustrings, the string is rendered, otherwise the ToString() method is invoked on the result. ListView(IListDataSource) Initializes a new instance of ListView that will display the provided data source, using relative positioning. Declaration public ListView(IListDataSource source) Parameters Type Name Description IListDataSource source IListDataSource object that provides a mechanism to render the data. The number of elements on the collection should not change, if you must change, set the \"Source\" property to reset the internal settings of the ListView. ListView(Rect, IList) Initializes a new instance of ListView that will display the contents of the object implementing the System.Collections.IList interface with an absolute position. Declaration public ListView(Rect rect, IList source) Parameters Type Name Description Rect rect Frame for the listview. System.Collections.IList source An IList data source, if the elements of the IList are strings or ustrings, the string is rendered, otherwise the ToString() method is invoked on the result. ListView(Rect, IListDataSource) Initializes a new instance of ListView with the provided data source and an absolute position Declaration public ListView(Rect rect, IListDataSource source) Parameters Type Name Description Rect rect Frame for the listview. IListDataSource source IListDataSource object that provides a mechanism to render the data. The number of elements on the collection should not change, if you must change, set the \"Source\" property to reset the internal settings of the ListView. Properties AllowsMarking Gets or sets whether this ListView allows items to be marked. Declaration public bool AllowsMarking { get; set; } Property Value Type Description System.Boolean true if allows marking elements of the list; otherwise, false . Remarks If set to true, ListView will render items marked items with \"[x]\", and unmarked items with \"[ ]\" spaces. SPACE key will toggle marking. AllowsMultipleSelection If set to true allows more than one item to be selected. If false only allow one item selected. Declaration public bool AllowsMultipleSelection { get; set; } Property Value Type Description System.Boolean SelectedItem Gets or sets the index of the currently selected item. Declaration public int SelectedItem { get; set; } Property Value Type Description System.Int32 The selected item. Source Gets or sets the IListDataSource backing this ListView , enabling custom rendering. Declaration public IListDataSource Source { get; set; } Property Value Type Description IListDataSource The source. Remarks Use SetSource(IList) to set a new System.Collections.IList source. TopItem Gets or sets the item that is displayed at the top of the ListView . Declaration public int TopItem { get; set; } Property Value Type Description System.Int32 The top item. Methods AllowsAll() Prevents marking if it's not allowed mark and if it's not allows multiple selection. Declaration public virtual bool AllowsAll() Returns Type Description System.Boolean MarkUnmarkRow() Marks an unmarked row. Declaration public virtual bool MarkUnmarkRow() Returns Type Description System.Boolean MouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public override bool MouseEvent(MouseEvent me) Parameters Type Name Description MouseEvent me Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides Responder.MouseEvent(MouseEvent) MoveDown() Moves the selected item index to the next row. Declaration public virtual bool MoveDown() Returns Type Description System.Boolean MoveEnd() Moves the selected item index to the last row. Declaration public virtual bool MoveEnd() Returns Type Description System.Boolean MoveHome() Moves the selected item index to the first row. Declaration public virtual bool MoveHome() Returns Type Description System.Boolean MovePageDown() Moves the selected item index to the previous page. Declaration public virtual bool MovePageDown() Returns Type Description System.Boolean MovePageUp() Moves the selected item index to the next page. Declaration public virtual bool MovePageUp() Returns Type Description System.Boolean MoveUp() Moves the selected item index to the previous row. Declaration public virtual bool MoveUp() Returns Type Description System.Boolean OnEnter(View) Method invoked when a view gets focus. Declaration public override bool OnEnter(View view) Parameters Type Name Description View view The view that is losing focus. Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides View.OnEnter(View) OnLeave(View) Method invoked when a view loses focus. Declaration public override bool OnLeave(View view) Parameters Type Name Description View view The view that is getting focus. Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides View.OnLeave(View) OnOpenSelectedItem() Invokes the OnOpenSelectedItem event if it is defined. Declaration public virtual bool OnOpenSelectedItem() Returns Type Description System.Boolean OnSelectedChanged() Invokes the SelectedChanged event if it is defined. Declaration public virtual bool OnSelectedChanged() Returns Type Description System.Boolean PositionCursor() Positions the cursor in the right position based on the currently focused view in the chain. Declaration public override void PositionCursor() Overrides View.PositionCursor() ProcessKey(KeyEvent) If the view is focused, gives the view a chance to process the keystroke. Declaration public override bool ProcessKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides View.ProcessKey(KeyEvent) Remarks 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. Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds The bounds (view-relative region) to redraw. Overrides View.Redraw(Rect) Remarks 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. SetSource(IList) Sets the source of the ListView to an System.Collections.IList . Declaration public void SetSource(IList source) Parameters Type Name Description System.Collections.IList source Remarks Use the Source property to set a new IListDataSource source and use custome rendering. SetSourceAsync(IList) Sets the source to an System.Collections.IList value asynchronously. Declaration public Task SetSourceAsync(IList source) Parameters Type Name Description System.Collections.IList source Returns Type Description System.Threading.Tasks.Task An item implementing the IList interface. Remarks Use the Source property to set a new IListDataSource source and use custome rendering. Events OpenSelectedItem This event is raised when the user Double Clicks on an item or presses ENTER to open the selected item. Declaration public event Action OpenSelectedItem Event Type Type Description System.Action < ListViewItemEventArgs > SelectedItemChanged This event is raised when the selected item in the ListView has changed. Declaration public event Action SelectedItemChanged Event Type Type Description System.Action < ListViewItemEventArgs > Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize"
},
"api/Terminal.Gui/Terminal.Gui.ListViewItemEventArgs.html": {
"href": "api/Terminal.Gui/Terminal.Gui.ListViewItemEventArgs.html",
@@ -177,17 +177,17 @@
"api/Terminal.Gui/Terminal.Gui.MenuBar.html": {
"href": "api/Terminal.Gui/Terminal.Gui.MenuBar.html",
"title": "Class MenuBar",
- "keywords": "Class MenuBar The MenuBar provides a menu for Terminal.Gui applications. Inheritance System.Object Responder View MenuBar Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.CanFocus View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View) View.Add(View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessColdKey(KeyEvent) View.KeyDown View.KeyUp View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.Text View.TextAlignment View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class MenuBar : View, IDisposable, ISupportInitializeNotification, ISupportInitialize Remarks The MenuBar appears on the first row of the terminal. The MenuBar provides global hotkeys for the application. Constructors MenuBar() Initializes a new instance of the MenuBar . Declaration public MenuBar() MenuBar(MenuBarItem[]) Initializes a new instance of the MenuBar class with the specified set of toplevel menu items. Declaration public MenuBar(MenuBarItem[] menus) Parameters Type Name Description MenuBarItem [] menus Individual menu items; a null item will result in a separator being drawn. Properties IsMenuOpen True if the menu is open; otherwise false. Declaration public bool IsMenuOpen { get; protected set; } Property Value Type Description System.Boolean LastFocused Get the lasted focused view before open the menu. Declaration public View LastFocused { get; } Property Value Type Description View Menus Gets or sets the array of MenuBarItem s for the menu. Only set this when the MenuBar is vislble. Declaration public MenuBarItem[] Menus { get; set; } Property Value Type Description MenuBarItem [] The menu array. UseKeysUpDownAsKeysLeftRight Used for change the navigation key style. Declaration public bool UseKeysUpDownAsKeysLeftRight { get; set; } Property Value Type Description System.Boolean Methods CloseMenu() Closes the current Menu programatically, if open. Declaration public void CloseMenu() MouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public override bool MouseEvent(MouseEvent me) Parameters Type Name Description MouseEvent me Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides Responder.MouseEvent(MouseEvent) OnKeyDown(KeyEvent) Declaration public override bool OnKeyDown(KeyEvent keyEvent) Parameters Type Name Description KeyEvent keyEvent Contains the details about the key that produced the event. Returns Type Description System.Boolean Overrides View.OnKeyDown(KeyEvent) OnKeyUp(KeyEvent) Declaration public override bool OnKeyUp(KeyEvent keyEvent) Parameters Type Name Description KeyEvent keyEvent Contains the details about the key that produced the event. Returns Type Description System.Boolean Overrides View.OnKeyUp(KeyEvent) OnLeave(View) Method invoked when a view loses focus. Declaration public override bool OnLeave(View view) Parameters Type Name Description View view The view that is getting focus. Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides View.OnLeave(View) OnMenuClosing() Virtual method that will invoke the MenuClosing Declaration public virtual void OnMenuClosing() OnMenuOpening() Virtual method that will invoke the MenuOpening Declaration public virtual void OnMenuOpening() OpenMenu() Opens the current Menu programatically. Declaration public void OpenMenu() PositionCursor() Positions the cursor in the right position based on the currently focused view in the chain. Declaration public override void PositionCursor() Overrides View.PositionCursor() ProcessHotKey(KeyEvent) This method can be overwritten by view that want to provide accelerator functionality (Alt-key for example). Declaration public override bool ProcessHotKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides View.ProcessHotKey(KeyEvent) Remarks 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. ProcessKey(KeyEvent) If the view is focused, gives the view a chance to process the keystroke. Declaration public override bool ProcessKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides View.ProcessKey(KeyEvent) Remarks 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. Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds The bounds (view-relative region) to redraw. Overrides View.Redraw(Rect) Remarks 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. Events MenuClosing Raised when a menu is closing. Declaration public event Action MenuClosing Event Type Type Description System.Action MenuOpening Raised as a menu is opening. Declaration public event Action MenuOpening Event Type Type Description System.Action Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize"
+ "keywords": "Class MenuBar The MenuBar provides a menu for Terminal.Gui applications. Inheritance System.Object Responder View MenuBar Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Shortcut View.ShortcutTag View.ShortcutAction View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.CanFocus View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View) View.Add(View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.KeyDown View.KeyUp View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.Text View.AutoSize View.TextAlignment View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class MenuBar : View, IDisposable, ISupportInitializeNotification, ISupportInitialize Remarks The MenuBar appears on the first row of the terminal. The MenuBar provides global hotkeys for the application. Constructors MenuBar() Initializes a new instance of the MenuBar . Declaration public MenuBar() MenuBar(MenuBarItem[]) Initializes a new instance of the MenuBar class with the specified set of toplevel menu items. Declaration public MenuBar(MenuBarItem[] menus) Parameters Type Name Description MenuBarItem [] menus Individual menu items; a null item will result in a separator being drawn. Properties IsMenuOpen True if the menu is open; otherwise false. Declaration public bool IsMenuOpen { get; protected set; } Property Value Type Description System.Boolean LastFocused Get the lasted focused view before open the menu. Declaration public View LastFocused { get; } Property Value Type Description View Menus Gets or sets the array of MenuBarItem s for the menu. Only set this when the MenuBar is vislble. Declaration public MenuBarItem[] Menus { get; set; } Property Value Type Description MenuBarItem [] The menu array. ShortcutDelimiter Used for change the shortcut delimiter separator. Declaration public static ustring ShortcutDelimiter { get; set; } Property Value Type Description NStack.ustring UseKeysUpDownAsKeysLeftRight Used for change the navigation key style. Declaration public bool UseKeysUpDownAsKeysLeftRight { get; set; } Property Value Type Description System.Boolean Methods CloseMenu() Closes the current Menu programatically, if open. Declaration public void CloseMenu() MouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public override bool MouseEvent(MouseEvent me) Parameters Type Name Description MouseEvent me Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides Responder.MouseEvent(MouseEvent) OnKeyDown(KeyEvent) Declaration public override bool OnKeyDown(KeyEvent keyEvent) Parameters Type Name Description KeyEvent keyEvent Contains the details about the key that produced the event. Returns Type Description System.Boolean Overrides View.OnKeyDown(KeyEvent) OnKeyUp(KeyEvent) Declaration public override bool OnKeyUp(KeyEvent keyEvent) Parameters Type Name Description KeyEvent keyEvent Contains the details about the key that produced the event. Returns Type Description System.Boolean Overrides View.OnKeyUp(KeyEvent) OnLeave(View) Method invoked when a view loses focus. Declaration public override bool OnLeave(View view) Parameters Type Name Description View view The view that is getting focus. Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides View.OnLeave(View) OnMenuClosing() Virtual method that will invoke the MenuClosing Declaration public virtual void OnMenuClosing() OnMenuOpening() Virtual method that will invoke the MenuOpening Declaration public virtual void OnMenuOpening() OpenMenu() Opens the current Menu programatically. Declaration public void OpenMenu() PositionCursor() Positions the cursor in the right position based on the currently focused view in the chain. Declaration public override void PositionCursor() Overrides View.PositionCursor() ProcessColdKey(KeyEvent) This method can be overwritten by views that want to provide accelerator functionality (Alt-key for example), but without interefering with normal ProcessKey behavior. Declaration public override bool ProcessColdKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides View.ProcessColdKey(KeyEvent) Remarks 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. ProcessHotKey(KeyEvent) This method can be overwritten by view that want to provide accelerator functionality (Alt-key for example). Declaration public override bool ProcessHotKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides View.ProcessHotKey(KeyEvent) Remarks 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. ProcessKey(KeyEvent) If the view is focused, gives the view a chance to process the keystroke. Declaration public override bool ProcessKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides View.ProcessKey(KeyEvent) Remarks 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. Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds The bounds (view-relative region) to redraw. Overrides View.Redraw(Rect) Remarks 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. Events MenuClosing Raised when a menu is closing. Declaration public event Action MenuClosing Event Type Type Description System.Action MenuOpening Raised as a menu is opening. Declaration public event Action MenuOpening Event Type Type Description System.Action Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize"
},
"api/Terminal.Gui/Terminal.Gui.MenuBarItem.html": {
"href": "api/Terminal.Gui/Terminal.Gui.MenuBarItem.html",
"title": "Class MenuBarItem",
- "keywords": "Class MenuBarItem A MenuBarItem contains MenuBarItem s or MenuItem s. Inheritance System.Object MenuItem MenuBarItem Inherited Members MenuItem.HotKey MenuItem.Title MenuItem.Help MenuItem.Action MenuItem.CanExecute MenuItem.IsEnabled() MenuItem.Checked MenuItem.CheckType MenuItem.Parent MenuItem.GetMenuItem() MenuItem.GetMenuBarItem() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) System.Object.ToString() Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class MenuBarItem : MenuItem Constructors MenuBarItem() Initializes a new MenuBarItem . Declaration public MenuBarItem() MenuBarItem(ustring, ustring, Action, Func, MenuItem) Initializes a new MenuBarItem as a MenuItem . Declaration public MenuBarItem(ustring title, ustring help, Action action, Func canExecute = null, MenuItem parent = null) Parameters Type Name Description NStack.ustring title Title for the menu item. NStack.ustring help Help text to display. System.Action action Action to invoke when the menu item is activated. System.Func < System.Boolean > canExecute Function to determine if the action can currently be executed. MenuItem parent The parent MenuItem of this if exist, otherwise is null. MenuBarItem(ustring, MenuItem[], MenuItem) Initializes a new MenuBarItem . Declaration public MenuBarItem(ustring title, MenuItem[] children, MenuItem parent = null) Parameters Type Name Description NStack.ustring title Title for the menu item. MenuItem [] children The items in the current menu. MenuItem parent The parent MenuItem of this if exist, otherwise is null. MenuBarItem(MenuItem[]) Initializes a new MenuBarItem . Declaration public MenuBarItem(MenuItem[] children) Parameters Type Name Description MenuItem [] children The items in the current menu. Properties Children Gets or sets an array of MenuItem objects that are the children of this MenuBarItem Declaration public MenuItem[] Children { get; set; } Property Value Type Description MenuItem [] The children. Methods GetChildrenIndex(MenuItem) Get the index of the MenuItem parameter. Declaration public int GetChildrenIndex(MenuItem children) Parameters Type Name Description MenuItem children Returns Type Description System.Int32 Returns a value bigger than -1 if the MenuItem is a child of this. IsSubMenuOf(MenuItem) Check if the MenuItem parameter is a child of this. Declaration public bool IsSubMenuOf(MenuItem menuItem) Parameters Type Name Description MenuItem menuItem Returns Type Description System.Boolean Returns true if it is a child of this. false otherwise. SubMenu(MenuItem) Check if the children parameter is a MenuBarItem . Declaration public MenuBarItem SubMenu(MenuItem children) Parameters Type Name Description MenuItem children Returns Type Description MenuBarItem Returns a MenuBarItem or null otherwise."
+ "keywords": "Class MenuBarItem A MenuBarItem contains MenuBarItem s or MenuItem s. Inheritance System.Object MenuItem MenuBarItem Inherited Members MenuItem.HotKey MenuItem.Shortcut MenuItem.ShortcutTag MenuItem.Title MenuItem.Help MenuItem.Action MenuItem.CanExecute MenuItem.IsEnabled() MenuItem.Checked MenuItem.CheckType MenuItem.Parent MenuItem.GetMenuItem() MenuItem.GetMenuBarItem() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) System.Object.ToString() Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class MenuBarItem : MenuItem Constructors MenuBarItem() Initializes a new MenuBarItem . Declaration public MenuBarItem() MenuBarItem(ustring, ustring, Action, Func, MenuItem) Initializes a new MenuBarItem as a MenuItem . Declaration public MenuBarItem(ustring title, ustring help, Action action, Func canExecute = null, MenuItem parent = null) Parameters Type Name Description NStack.ustring title Title for the menu item. NStack.ustring help Help text to display. System.Action action Action to invoke when the menu item is activated. System.Func < System.Boolean > canExecute Function to determine if the action can currently be executed. MenuItem parent The parent MenuItem of this if exist, otherwise is null. MenuBarItem(ustring, MenuItem[], MenuItem) Initializes a new MenuBarItem . Declaration public MenuBarItem(ustring title, MenuItem[] children, MenuItem parent = null) Parameters Type Name Description NStack.ustring title Title for the menu item. MenuItem [] children The items in the current menu. MenuItem parent The parent MenuItem of this if exist, otherwise is null. MenuBarItem(MenuItem[]) Initializes a new MenuBarItem . Declaration public MenuBarItem(MenuItem[] children) Parameters Type Name Description MenuItem [] children The items in the current menu. Properties Children Gets or sets an array of MenuItem objects that are the children of this MenuBarItem Declaration public MenuItem[] Children { get; set; } Property Value Type Description MenuItem [] The children. Methods GetChildrenIndex(MenuItem) Get the index of the MenuItem parameter. Declaration public int GetChildrenIndex(MenuItem children) Parameters Type Name Description MenuItem children Returns Type Description System.Int32 Returns a value bigger than -1 if the MenuItem is a child of this. IsSubMenuOf(MenuItem) Check if the MenuItem parameter is a child of this. Declaration public bool IsSubMenuOf(MenuItem menuItem) Parameters Type Name Description MenuItem menuItem Returns Type Description System.Boolean Returns true if it is a child of this. false otherwise. SubMenu(MenuItem) Check if the children parameter is a MenuBarItem . Declaration public MenuBarItem SubMenu(MenuItem children) Parameters Type Name Description MenuItem children Returns Type Description MenuBarItem Returns a MenuBarItem or null otherwise."
},
"api/Terminal.Gui/Terminal.Gui.MenuItem.html": {
"href": "api/Terminal.Gui/Terminal.Gui.MenuItem.html",
"title": "Class MenuItem",
- "keywords": "Class MenuItem A MenuItem has a title, an associated help text, and an action to execute on activation. Inheritance System.Object MenuItem MenuBarItem Inherited Members System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) System.Object.ToString() Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class MenuItem Constructors MenuItem() Initializes a new instance of MenuItem Declaration public MenuItem() MenuItem(ustring, ustring, Action, Func, MenuItem) Initializes a new instance of MenuItem . Declaration public MenuItem(ustring title, ustring help, Action action, Func canExecute = null, MenuItem parent = null) Parameters Type Name Description NStack.ustring title Title for the menu item. NStack.ustring help Help text to display. System.Action action Action to invoke when the menu item is activated. System.Func < System.Boolean > canExecute Function to determine if the action can currently be executed. MenuItem parent The parent of this menu item. Fields HotKey The HotKey is used when the menu is active, the shortcut can be triggered when the menu is not active. For example HotKey would be \"N\" when the File Menu is open (assuming there is a \"_New\" entry if the ShortCut is set to \"Control-N\", this would be a global hotkey that would trigger as well Declaration public Rune HotKey Field Value Type Description System.Rune Properties Action Gets or sets the action to be invoked when the menu is triggered Declaration public Action Action { get; set; } Property Value Type Description System.Action Method to invoke. CanExecute Gets or sets the action to be invoked if the menu can be triggered Declaration public Func CanExecute { get; set; } Property Value Type Description System.Func < System.Boolean > Function to determine if action is ready to be executed. Checked Sets or gets whether the MenuItem shows a check indicator or not. See MenuItemCheckStyle . Declaration public bool Checked { get; set; } Property Value Type Description System.Boolean CheckType Sets or gets the type selection indicator the menu item will be displayed with. Declaration public MenuItemCheckStyle CheckType { get; set; } Property Value Type Description MenuItemCheckStyle Help Gets or sets the help text for the menu item. Declaration public ustring Help { get; set; } Property Value Type Description NStack.ustring The help text. Parent Gets or sets the parent for this MenuItem . Declaration public MenuItem Parent { get; } Property Value Type Description MenuItem The parent. Title Gets or sets the title. Declaration public ustring Title { get; set; } Property Value Type Description NStack.ustring The title. Methods GetMenuBarItem() Merely a debugging aid to see the interaction with main Declaration public bool GetMenuBarItem() Returns Type Description System.Boolean GetMenuItem() Merely a debugging aid to see the interaction with main Declaration public MenuItem GetMenuItem() Returns Type Description MenuItem IsEnabled() Shortcut to check if the menu item is enabled Declaration public bool IsEnabled() Returns Type Description System.Boolean"
+ "keywords": "Class MenuItem A MenuItem has a title, an associated help text, and an action to execute on activation. Inheritance System.Object MenuItem MenuBarItem Inherited Members System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) System.Object.ToString() Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class MenuItem Constructors MenuItem(ustring, ustring, Action, Func, MenuItem, Key) Initializes a new instance of MenuItem . Declaration public MenuItem(ustring title, ustring help, Action action, Func canExecute = null, MenuItem parent = null, Key shortcut = Key.Null) Parameters Type Name Description NStack.ustring title Title for the menu item. NStack.ustring help Help text to display. System.Action action Action to invoke when the menu item is activated. System.Func < System.Boolean > canExecute Function to determine if the action can currently be executed. MenuItem parent The Parent of this menu item. Key shortcut The Shortcut keystroke combination. MenuItem(Key) Initializes a new instance of MenuItem Declaration public MenuItem(Key shortcut = Key.Null) Parameters Type Name Description Key shortcut Fields HotKey The HotKey is used when the menu is active, the shortcut can be triggered when the menu is not active. For example HotKey would be \"N\" when the File Menu is open (assuming there is a \"_New\" entry if the Shortcut is set to \"Control-N\", this would be a global hotkey that would trigger as well Declaration public Rune HotKey Field Value Type Description System.Rune Properties Action Gets or sets the action to be invoked when the menu is triggered Declaration public Action Action { get; set; } Property Value Type Description System.Action Method to invoke. CanExecute Gets or sets the action to be invoked if the menu can be triggered Declaration public Func CanExecute { get; set; } Property Value Type Description System.Func < System.Boolean > Function to determine if action is ready to be executed. Checked Sets or gets whether the MenuItem shows a check indicator or not. See MenuItemCheckStyle . Declaration public bool Checked { get; set; } Property Value Type Description System.Boolean CheckType Sets or gets the type selection indicator the menu item will be displayed with. Declaration public MenuItemCheckStyle CheckType { get; set; } Property Value Type Description MenuItemCheckStyle Help Gets or sets the help text for the menu item. Declaration public ustring Help { get; set; } Property Value Type Description NStack.ustring The help text. Parent Gets or sets the parent for this MenuItem . Declaration public MenuItem Parent { get; } Property Value Type Description MenuItem The parent. Shortcut This is the global setting that can be used as a global Shortcut to invoke the action on the menu. Declaration public Key Shortcut { get; set; } Property Value Type Description Key ShortcutTag The keystroke combination used in the ShortcutTag as string. Declaration public ustring ShortcutTag { get; } Property Value Type Description NStack.ustring Title Gets or sets the title. Declaration public ustring Title { get; set; } Property Value Type Description NStack.ustring The title. Methods GetMenuBarItem() Merely a debugging aid to see the interaction with main Declaration public bool GetMenuBarItem() Returns Type Description System.Boolean GetMenuItem() Merely a debugging aid to see the interaction with main Declaration public MenuItem GetMenuItem() Returns Type Description MenuItem IsEnabled() Shortcut to check if the menu item is enabled Declaration public bool IsEnabled() Returns Type Description System.Boolean"
},
"api/Terminal.Gui/Terminal.Gui.MenuItemCheckStyle.html": {
"href": "api/Terminal.Gui/Terminal.Gui.MenuItemCheckStyle.html",
@@ -217,7 +217,7 @@
"api/Terminal.Gui/Terminal.Gui.OpenDialog.html": {
"href": "api/Terminal.Gui/Terminal.Gui.OpenDialog.html",
"title": "Class OpenDialog",
- "keywords": "Class OpenDialog The OpenDialog provides an interactive dialog box for users to select files or directories. Inheritance System.Object Responder View Toplevel Window Dialog FileDialog OpenDialog Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members FileDialog.WillPresent() FileDialog.Prompt FileDialog.NameFieldLabel FileDialog.Message FileDialog.CanCreateDirectories FileDialog.IsExtensionHidden FileDialog.DirectoryPath FileDialog.AllowedFileTypes FileDialog.AllowsOtherFileTypes FileDialog.FilePath FileDialog.Canceled Dialog.AddButton(Button) Dialog.ProcessKey(KeyEvent) Window.Title Window.Add(View) Window.Remove(View) Window.RemoveAll() Window.Redraw(Rect) Window.MouseEvent(MouseEvent) Window.Text Window.TextAlignment Toplevel.Running Toplevel.Ready Toplevel.Create() Toplevel.CanFocus Toplevel.Modal Toplevel.MenuBar Toplevel.StatusBar Toplevel.OnKeyDown(KeyEvent) Toplevel.OnKeyUp(KeyEvent) View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View[]) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.PositionCursor() View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.KeyUp View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class OpenDialog : FileDialog, IDisposable, ISupportInitializeNotification, ISupportInitialize Remarks The open dialog can be used to select files for opening, it can be configured to allow multiple items to be selected (based on the AllowsMultipleSelection) variable and you can control whether this should allow files or directories to be selected. To use, create an instance of OpenDialog , and pass it to Run() . This will run the dialog modally, and when this returns, the list of filds will be available on the FilePaths property. To select more than one file, users can use the spacebar, or control-t. Constructors OpenDialog() Initializes a new OpenDialog . Declaration public OpenDialog() OpenDialog(ustring, ustring) Initializes a new OpenDialog . Declaration public OpenDialog(ustring title, ustring message) Parameters Type Name Description NStack.ustring title NStack.ustring message Properties AllowsMultipleSelection Gets or sets a value indicating whether this OpenDialog allows multiple selection. Declaration public bool AllowsMultipleSelection { get; set; } Property Value Type Description System.Boolean true if allows multiple selection; otherwise, false , defaults to false. CanChooseDirectories Gets or sets a value indicating whether this OpenDialog can choose directories. Declaration public bool CanChooseDirectories { get; set; } Property Value Type Description System.Boolean true if can choose directories; otherwise, false defaults to false . CanChooseFiles Gets or sets a value indicating whether this OpenDialog can choose files. Declaration public bool CanChooseFiles { get; set; } Property Value Type Description System.Boolean true if can choose files; otherwise, false . Defaults to true FilePaths Returns the selected files, or an empty list if nothing has been selected Declaration public IReadOnlyList FilePaths { get; } Property Value Type Description System.Collections.Generic.IReadOnlyList < System.String > The file paths. Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize"
+ "keywords": "Class OpenDialog The OpenDialog provides an interactive dialog box for users to select files or directories. Inheritance System.Object Responder View Toplevel Window Dialog FileDialog OpenDialog Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members FileDialog.WillPresent() FileDialog.Prompt FileDialog.NameFieldLabel FileDialog.Message FileDialog.CanCreateDirectories FileDialog.IsExtensionHidden FileDialog.DirectoryPath FileDialog.AllowedFileTypes FileDialog.AllowsOtherFileTypes FileDialog.FilePath FileDialog.Canceled Dialog.AddButton(Button) Dialog.ProcessKey(KeyEvent) Window.Title Window.Add(View) Window.Remove(View) Window.RemoveAll() Window.Redraw(Rect) Window.MouseEvent(MouseEvent) Window.Text Window.TextAlignment Toplevel.Running Toplevel.Loaded Toplevel.Ready Toplevel.Unloaded Toplevel.Create() Toplevel.CanFocus Toplevel.Modal Toplevel.MenuBar Toplevel.StatusBar Toplevel.OnKeyDown(KeyEvent) Toplevel.OnKeyUp(KeyEvent) Toplevel.ProcessColdKey(KeyEvent) View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Shortcut View.ShortcutTag View.ShortcutAction View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View[]) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.PositionCursor() View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessHotKey(KeyEvent) View.KeyDown View.KeyUp View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.AutoSize View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class OpenDialog : FileDialog, IDisposable, ISupportInitializeNotification, ISupportInitialize Remarks The open dialog can be used to select files for opening, it can be configured to allow multiple items to be selected (based on the AllowsMultipleSelection) variable and you can control whether this should allow files or directories to be selected. To use, create an instance of OpenDialog , and pass it to Run() . This will run the dialog modally, and when this returns, the list of filds will be available on the FilePaths property. To select more than one file, users can use the spacebar, or control-t. Constructors OpenDialog() Initializes a new OpenDialog . Declaration public OpenDialog() OpenDialog(ustring, ustring) Initializes a new OpenDialog . Declaration public OpenDialog(ustring title, ustring message) Parameters Type Name Description NStack.ustring title NStack.ustring message Properties AllowsMultipleSelection Gets or sets a value indicating whether this OpenDialog allows multiple selection. Declaration public bool AllowsMultipleSelection { get; set; } Property Value Type Description System.Boolean true if allows multiple selection; otherwise, false , defaults to false. CanChooseDirectories Gets or sets a value indicating whether this OpenDialog can choose directories. Declaration public bool CanChooseDirectories { get; set; } Property Value Type Description System.Boolean true if can choose directories; otherwise, false defaults to false . CanChooseFiles Gets or sets a value indicating whether this OpenDialog can choose files. Declaration public bool CanChooseFiles { get; set; } Property Value Type Description System.Boolean true if can choose files; otherwise, false . Defaults to true FilePaths Returns the selected files, or an empty list if nothing has been selected Declaration public IReadOnlyList FilePaths { get; } Property Value Type Description System.Collections.Generic.IReadOnlyList < System.String > The file paths. Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize"
},
"api/Terminal.Gui/Terminal.Gui.Point.html": {
"href": "api/Terminal.Gui/Terminal.Gui.Point.html",
@@ -232,12 +232,12 @@
"api/Terminal.Gui/Terminal.Gui.ProgressBar.html": {
"href": "api/Terminal.Gui/Terminal.Gui.ProgressBar.html",
"title": "Class ProgressBar",
- "keywords": "Class ProgressBar A Progress Bar view that can indicate progress of an activity visually. Inheritance System.Object Responder View ProgressBar Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.CanFocus View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View) View.Add(View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.PositionCursor() View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessKey(KeyEvent) View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.Text View.TextAlignment View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.MouseEvent(MouseEvent) Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class ProgressBar : View, IDisposable, ISupportInitializeNotification, ISupportInitialize Remarks ProgressBar can operate in two modes, percentage mode, or activity mode. The progress bar starts in percentage mode and setting the Fraction property will reflect on the UI the progress made so far. Activity mode is used when the application has no way of knowing how much time is left, and is started when the Pulse() method is called. Call Pulse() repeatedly as progress is made. Constructors ProgressBar() Initializes a new instance of the ProgressBar class, starts in percentage mode and uses relative layout. Declaration public ProgressBar() ProgressBar(Rect) Initializes a new instance of the ProgressBar class, starts in percentage mode with an absolute position and size. Declaration public ProgressBar(Rect rect) Parameters Type Name Description Rect rect Rect. Properties Fraction Gets or sets the ProgressBar fraction to display, must be a value between 0 and 1. Declaration public float Fraction { get; set; } Property Value Type Description System.Single The fraction representing the progress. Methods Pulse() Notifies the ProgressBar that some progress has taken place. Declaration public void Pulse() Remarks If the ProgressBar is is percentage mode, it switches to activity mode. If is in activity mode, the marker is moved. Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect region) Parameters Type Name Description Rect region Overrides View.Redraw(Rect) Remarks 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. Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize"
+ "keywords": "Class ProgressBar A Progress Bar view that can indicate progress of an activity visually. Inheritance System.Object Responder View ProgressBar Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Shortcut View.ShortcutTag View.ShortcutAction View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.CanFocus View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View) View.Add(View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.PositionCursor() View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessKey(KeyEvent) View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.Text View.AutoSize View.TextAlignment View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.MouseEvent(MouseEvent) Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class ProgressBar : View, IDisposable, ISupportInitializeNotification, ISupportInitialize Remarks ProgressBar can operate in two modes, percentage mode, or activity mode. The progress bar starts in percentage mode and setting the Fraction property will reflect on the UI the progress made so far. Activity mode is used when the application has no way of knowing how much time is left, and is started when the Pulse() method is called. Call Pulse() repeatedly as progress is made. Constructors ProgressBar() Initializes a new instance of the ProgressBar class, starts in percentage mode and uses relative layout. Declaration public ProgressBar() ProgressBar(Rect) Initializes a new instance of the ProgressBar class, starts in percentage mode with an absolute position and size. Declaration public ProgressBar(Rect rect) Parameters Type Name Description Rect rect Rect. Properties Fraction Gets or sets the ProgressBar fraction to display, must be a value between 0 and 1. Declaration public float Fraction { get; set; } Property Value Type Description System.Single The fraction representing the progress. Methods Pulse() Notifies the ProgressBar that some progress has taken place. Declaration public void Pulse() Remarks If the ProgressBar is is percentage mode, it switches to activity mode. If is in activity mode, the marker is moved. Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect region) Parameters Type Name Description Rect region Overrides View.Redraw(Rect) Remarks 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. Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize"
},
"api/Terminal.Gui/Terminal.Gui.RadioGroup.html": {
"href": "api/Terminal.Gui/Terminal.Gui.RadioGroup.html",
"title": "Class RadioGroup",
- "keywords": "Class RadioGroup RadioGroup shows a group of radio labels, only one of those can be selected at a given time Inheritance System.Object Responder View RadioGroup Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.CanFocus View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View) View.Add(View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessHotKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.Text View.TextAlignment View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class RadioGroup : View, IDisposable, ISupportInitializeNotification, ISupportInitialize Constructors RadioGroup() Initializes a new instance of the RadioGroup class using Computed layout. Declaration public RadioGroup() RadioGroup(ustring[], Int32) Initializes a new instance of the RadioGroup class using Computed layout. Declaration public RadioGroup(ustring[] radioLabels, int selected = 0) Parameters Type Name Description NStack.ustring [] radioLabels The radio labels; an array of strings that can contain hotkeys using an underscore before the letter. System.Int32 selected The index of the item to be selected, the value is clamped to the number of items. RadioGroup(Int32, Int32, ustring[], Int32) Initializes a new instance of the RadioGroup class using Absolute layout. The View frame is computed from the provided radio labels. Declaration public RadioGroup(int x, int y, ustring[] radioLabels, int selected = 0) Parameters Type Name Description System.Int32 x The x coordinate. System.Int32 y The y coordinate. NStack.ustring [] radioLabels The radio labels; an array of strings that can contain hotkeys using an underscore before the letter. System.Int32 selected The item to be selected, the value is clamped to the number of items. RadioGroup(Rect, ustring[], Int32) Initializes a new instance of the RadioGroup class using Absolute layout. Declaration public RadioGroup(Rect rect, ustring[] radioLabels, int selected = 0) Parameters Type Name Description Rect rect Boundaries for the radio group. NStack.ustring [] radioLabels The radio labels; an array of strings that can contain hotkeys using an underscore before the letter. System.Int32 selected The index of item to be selected, the value is clamped to the number of items. Properties DisplayMode Gets or sets the DisplayModeLayout for this RadioGroup . Declaration public DisplayModeLayout DisplayMode { get; set; } Property Value Type Description DisplayModeLayout HorizontalSpace Gets or sets the horizontal space for this RadioGroup if the DisplayMode is Horizontal Declaration public int HorizontalSpace { get; set; } Property Value Type Description System.Int32 RadioLabels The radio labels to display Declaration public ustring[] RadioLabels { get; set; } Property Value Type Description NStack.ustring [] The radio labels. SelectedItem The currently selected item from the list of radio labels Declaration public int SelectedItem { get; set; } Property Value Type Description System.Int32 The selected. Methods MouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public override bool MouseEvent(MouseEvent me) Parameters Type Name Description MouseEvent me Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides Responder.MouseEvent(MouseEvent) OnSelectedItemChanged(Int32, Int32) Called whenever the current selected item changes. Invokes the SelectedItemChanged event. Declaration public virtual void OnSelectedItemChanged(int selectedItem, int previousSelectedItem) Parameters Type Name Description System.Int32 selectedItem System.Int32 previousSelectedItem PositionCursor() Positions the cursor in the right position based on the currently focused view in the chain. Declaration public override void PositionCursor() Overrides View.PositionCursor() ProcessColdKey(KeyEvent) This method can be overwritten by views that want to provide accelerator functionality (Alt-key for example), but without interefering with normal ProcessKey behavior. Declaration public override bool ProcessColdKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides View.ProcessColdKey(KeyEvent) Remarks 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. ProcessKey(KeyEvent) If the view is focused, gives the view a chance to process the keystroke. Declaration public override bool ProcessKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides View.ProcessKey(KeyEvent) Remarks 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. Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds The bounds (view-relative region) to redraw. Overrides View.Redraw(Rect) Remarks 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. Refresh() Allow to invoke the SelectedItemChanged after their creation. Declaration public void Refresh() Events SelectedItemChanged Invoked when the selected radio label has changed. Declaration public event Action SelectedItemChanged Event Type Type Description System.Action < RadioGroup.SelectedItemChangedArgs > Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize"
+ "keywords": "Class RadioGroup RadioGroup shows a group of radio labels, only one of those can be selected at a given time Inheritance System.Object Responder View RadioGroup Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Shortcut View.ShortcutTag View.ShortcutAction View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.CanFocus View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View) View.Add(View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessHotKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.Text View.AutoSize View.TextAlignment View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class RadioGroup : View, IDisposable, ISupportInitializeNotification, ISupportInitialize Constructors RadioGroup() Initializes a new instance of the RadioGroup class using Computed layout. Declaration public RadioGroup() RadioGroup(ustring[], Int32) Initializes a new instance of the RadioGroup class using Computed layout. Declaration public RadioGroup(ustring[] radioLabels, int selected = 0) Parameters Type Name Description NStack.ustring [] radioLabels The radio labels; an array of strings that can contain hotkeys using an underscore before the letter. System.Int32 selected The index of the item to be selected, the value is clamped to the number of items. RadioGroup(Int32, Int32, ustring[], Int32) Initializes a new instance of the RadioGroup class using Absolute layout. The View frame is computed from the provided radio labels. Declaration public RadioGroup(int x, int y, ustring[] radioLabels, int selected = 0) Parameters Type Name Description System.Int32 x The x coordinate. System.Int32 y The y coordinate. NStack.ustring [] radioLabels The radio labels; an array of strings that can contain hotkeys using an underscore before the letter. System.Int32 selected The item to be selected, the value is clamped to the number of items. RadioGroup(Rect, ustring[], Int32) Initializes a new instance of the RadioGroup class using Absolute layout. Declaration public RadioGroup(Rect rect, ustring[] radioLabels, int selected = 0) Parameters Type Name Description Rect rect Boundaries for the radio group. NStack.ustring [] radioLabels The radio labels; an array of strings that can contain hotkeys using an underscore before the letter. System.Int32 selected The index of item to be selected, the value is clamped to the number of items. Properties DisplayMode Gets or sets the DisplayModeLayout for this RadioGroup . Declaration public DisplayModeLayout DisplayMode { get; set; } Property Value Type Description DisplayModeLayout HorizontalSpace Gets or sets the horizontal space for this RadioGroup if the DisplayMode is Horizontal Declaration public int HorizontalSpace { get; set; } Property Value Type Description System.Int32 RadioLabels The radio labels to display Declaration public ustring[] RadioLabels { get; set; } Property Value Type Description NStack.ustring [] The radio labels. SelectedItem The currently selected item from the list of radio labels Declaration public int SelectedItem { get; set; } Property Value Type Description System.Int32 The selected. Methods MouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public override bool MouseEvent(MouseEvent me) Parameters Type Name Description MouseEvent me Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides Responder.MouseEvent(MouseEvent) OnSelectedItemChanged(Int32, Int32) Called whenever the current selected item changes. Invokes the SelectedItemChanged event. Declaration public virtual void OnSelectedItemChanged(int selectedItem, int previousSelectedItem) Parameters Type Name Description System.Int32 selectedItem System.Int32 previousSelectedItem PositionCursor() Positions the cursor in the right position based on the currently focused view in the chain. Declaration public override void PositionCursor() Overrides View.PositionCursor() ProcessColdKey(KeyEvent) This method can be overwritten by views that want to provide accelerator functionality (Alt-key for example), but without interefering with normal ProcessKey behavior. Declaration public override bool ProcessColdKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides View.ProcessColdKey(KeyEvent) Remarks 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. ProcessKey(KeyEvent) If the view is focused, gives the view a chance to process the keystroke. Declaration public override bool ProcessKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides View.ProcessKey(KeyEvent) Remarks 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. Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds The bounds (view-relative region) to redraw. Overrides View.Redraw(Rect) Remarks 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. Refresh() Allow to invoke the SelectedItemChanged after their creation. Declaration public void Refresh() Events SelectedItemChanged Invoked when the selected radio label has changed. Declaration public event Action SelectedItemChanged Event Type Type Description System.Action < RadioGroup.SelectedItemChangedArgs > Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize"
},
"api/Terminal.Gui/Terminal.Gui.RadioGroup.SelectedItemChangedArgs.html": {
"href": "api/Terminal.Gui/Terminal.Gui.RadioGroup.SelectedItemChangedArgs.html",
@@ -257,17 +257,22 @@
"api/Terminal.Gui/Terminal.Gui.SaveDialog.html": {
"href": "api/Terminal.Gui/Terminal.Gui.SaveDialog.html",
"title": "Class SaveDialog",
- "keywords": "Class SaveDialog The SaveDialog provides an interactive dialog box for users to pick a file to save. Inheritance System.Object Responder View Toplevel Window Dialog FileDialog SaveDialog Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members FileDialog.WillPresent() FileDialog.Prompt FileDialog.NameFieldLabel FileDialog.Message FileDialog.CanCreateDirectories FileDialog.IsExtensionHidden FileDialog.DirectoryPath FileDialog.AllowedFileTypes FileDialog.AllowsOtherFileTypes FileDialog.FilePath FileDialog.Canceled Dialog.AddButton(Button) Dialog.ProcessKey(KeyEvent) Window.Title Window.Add(View) Window.Remove(View) Window.RemoveAll() Window.Redraw(Rect) Window.MouseEvent(MouseEvent) Window.Text Window.TextAlignment Toplevel.Running Toplevel.Ready Toplevel.Create() Toplevel.CanFocus Toplevel.Modal Toplevel.MenuBar Toplevel.StatusBar Toplevel.OnKeyDown(KeyEvent) Toplevel.OnKeyUp(KeyEvent) View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View[]) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.PositionCursor() View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.KeyUp View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class SaveDialog : FileDialog, IDisposable, ISupportInitializeNotification, ISupportInitialize Remarks To use, create an instance of SaveDialog , and pass it to Run() . This will run the dialog modally, and when this returns, the FileName property will contain the selected file name or null if the user canceled. Constructors SaveDialog() Initializes a new SaveDialog . Declaration public SaveDialog() SaveDialog(ustring, ustring) Initializes a new SaveDialog . Declaration public SaveDialog(ustring title, ustring message) Parameters Type Name Description NStack.ustring title The title. NStack.ustring message The message. Properties FileName Gets the name of the file the user selected for saving, or null if the user canceled the SaveDialog . Declaration public ustring FileName { get; } Property Value Type Description NStack.ustring The name of the file. Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize"
+ "keywords": "Class SaveDialog The SaveDialog provides an interactive dialog box for users to pick a file to save. Inheritance System.Object Responder View Toplevel Window Dialog FileDialog SaveDialog Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members FileDialog.WillPresent() FileDialog.Prompt FileDialog.NameFieldLabel FileDialog.Message FileDialog.CanCreateDirectories FileDialog.IsExtensionHidden FileDialog.DirectoryPath FileDialog.AllowedFileTypes FileDialog.AllowsOtherFileTypes FileDialog.FilePath FileDialog.Canceled Dialog.AddButton(Button) Dialog.ProcessKey(KeyEvent) Window.Title Window.Add(View) Window.Remove(View) Window.RemoveAll() Window.Redraw(Rect) Window.MouseEvent(MouseEvent) Window.Text Window.TextAlignment Toplevel.Running Toplevel.Loaded Toplevel.Ready Toplevel.Unloaded Toplevel.Create() Toplevel.CanFocus Toplevel.Modal Toplevel.MenuBar Toplevel.StatusBar Toplevel.OnKeyDown(KeyEvent) Toplevel.OnKeyUp(KeyEvent) Toplevel.ProcessColdKey(KeyEvent) View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Shortcut View.ShortcutTag View.ShortcutAction View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View[]) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.PositionCursor() View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessHotKey(KeyEvent) View.KeyDown View.KeyUp View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.AutoSize View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class SaveDialog : FileDialog, IDisposable, ISupportInitializeNotification, ISupportInitialize Remarks To use, create an instance of SaveDialog , and pass it to Run() . This will run the dialog modally, and when this returns, the FileName property will contain the selected file name or null if the user canceled. Constructors SaveDialog() Initializes a new SaveDialog . Declaration public SaveDialog() SaveDialog(ustring, ustring) Initializes a new SaveDialog . Declaration public SaveDialog(ustring title, ustring message) Parameters Type Name Description NStack.ustring title The title. NStack.ustring message The message. Properties FileName Gets the name of the file the user selected for saving, or null if the user canceled the SaveDialog . Declaration public ustring FileName { get; } Property Value Type Description NStack.ustring The name of the file. Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize"
},
"api/Terminal.Gui/Terminal.Gui.ScrollBarView.html": {
"href": "api/Terminal.Gui/Terminal.Gui.ScrollBarView.html",
"title": "Class ScrollBarView",
- "keywords": "Class ScrollBarView ScrollBarViews are views that display a 1-character scrollbar, either horizontal or vertical Inheritance System.Object Responder View ScrollBarView Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.CanFocus View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View) View.Add(View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.PositionCursor() View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessKey(KeyEvent) View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.Text View.TextAlignment View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class ScrollBarView : View, IDisposable, ISupportInitializeNotification, ISupportInitialize Remarks The scrollbar is drawn to be a representation of the Size, assuming that the scroll position is set at Position. If the region to display the scrollbar is larger than three characters, arrow indicators are drawn. Constructors ScrollBarView() Initializes a new instance of the ScrollBarView class using Computed layout. Declaration public ScrollBarView() ScrollBarView(Int32, Int32, Boolean) Initializes a new instance of the ScrollBarView class using Computed layout. Declaration public ScrollBarView(int size, int position, bool isVertical) Parameters Type Name Description System.Int32 size The size that this scrollbar represents. System.Int32 position The position within this scrollbar. System.Boolean isVertical If set to true this is a vertical scrollbar, otherwise, the scrollbar is horizontal. ScrollBarView(Rect) Initializes a new instance of the ScrollBarView class using Absolute layout. Declaration public ScrollBarView(Rect rect) Parameters Type Name Description Rect rect Frame for the scrollbar. ScrollBarView(Rect, Int32, Int32, Boolean) Initializes a new instance of the ScrollBarView class using Absolute layout. Declaration public ScrollBarView(Rect rect, int size, int position, bool isVertical) Parameters Type Name Description Rect rect Frame for the scrollbar. System.Int32 size The size that this scrollbar represents. Sets the Size property. System.Int32 position The position within this scrollbar. Sets the Position property. System.Boolean isVertical If set to true this is a vertical scrollbar, otherwise, the scrollbar is horizontal. Sets the IsVertical property. Properties Host Get or sets the view that host this ScrollView Declaration public ScrollView Host { get; } Property Value Type Description ScrollView IsVertical If set to true this is a vertical scrollbar, otherwise, the scrollbar is horizontal. Declaration public bool IsVertical { get; set; } Property Value Type Description System.Boolean Position The position, relative to Size , to set the scrollbar at. Declaration public int Position { get; set; } Property Value Type Description System.Int32 The position. Size The size of content the scrollbar represents. Declaration public int Size { get; set; } Property Value Type Description System.Int32 The size. Remarks The Size is typically the size of the virtual content. E.g. when a Scrollbar is part of a ScrollView the Size is set to the appropriate dimension of ContentSize . Methods MouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public override bool MouseEvent(MouseEvent me) Parameters Type Name Description MouseEvent me Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides Responder.MouseEvent(MouseEvent) Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect region) Parameters Type Name Description Rect region Overrides View.Redraw(Rect) Remarks 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. Events ChangedPosition This event is raised when the position on the scrollbar has changed. Declaration public event Action ChangedPosition Event Type Type Description System.Action Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize"
+ "keywords": "Class ScrollBarView ScrollBarViews are views that display a 1-character scrollbar, either horizontal or vertical Inheritance System.Object Responder View ScrollBarView Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Shortcut View.ShortcutTag View.ShortcutAction View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.CanFocus View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View) View.Add(View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.PositionCursor() View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessKey(KeyEvent) View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.Text View.AutoSize View.TextAlignment View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class ScrollBarView : View, IDisposable, ISupportInitializeNotification, ISupportInitialize Remarks The scrollbar is drawn to be a representation of the Size, assuming that the scroll position is set at Position. If the region to display the scrollbar is larger than three characters, arrow indicators are drawn. Constructors ScrollBarView() Initializes a new instance of the ScrollBarView class using Computed layout. Declaration public ScrollBarView() ScrollBarView(Int32, Int32, Boolean) Initializes a new instance of the ScrollBarView class using Computed layout. Declaration public ScrollBarView(int size, int position, bool isVertical) Parameters Type Name Description System.Int32 size The size that this scrollbar represents. System.Int32 position The position within this scrollbar. System.Boolean isVertical If set to true this is a vertical scrollbar, otherwise, the scrollbar is horizontal. ScrollBarView(Rect) Initializes a new instance of the ScrollBarView class using Absolute layout. Declaration public ScrollBarView(Rect rect) Parameters Type Name Description Rect rect Frame for the scrollbar. ScrollBarView(Rect, Int32, Int32, Boolean) Initializes a new instance of the ScrollBarView class using Absolute layout. Declaration public ScrollBarView(Rect rect, int size, int position, bool isVertical) Parameters Type Name Description Rect rect Frame for the scrollbar. System.Int32 size The size that this scrollbar represents. Sets the Size property. System.Int32 position The position within this scrollbar. Sets the Position property. System.Boolean isVertical If set to true this is a vertical scrollbar, otherwise, the scrollbar is horizontal. Sets the IsVertical property. Properties Host Get or sets the view that host this ScrollView Declaration public ScrollView Host { get; } Property Value Type Description ScrollView IsVertical If set to true this is a vertical scrollbar, otherwise, the scrollbar is horizontal. Declaration public bool IsVertical { get; set; } Property Value Type Description System.Boolean Position The position, relative to Size , to set the scrollbar at. Declaration public int Position { get; set; } Property Value Type Description System.Int32 The position. Size The size of content the scrollbar represents. Declaration public int Size { get; set; } Property Value Type Description System.Int32 The size. Remarks The Size is typically the size of the virtual content. E.g. when a Scrollbar is part of a ScrollView the Size is set to the appropriate dimension of ContentSize . Methods MouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public override bool MouseEvent(MouseEvent me) Parameters Type Name Description MouseEvent me Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides Responder.MouseEvent(MouseEvent) Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect region) Parameters Type Name Description Rect region Overrides View.Redraw(Rect) Remarks 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. Events ChangedPosition This event is raised when the position on the scrollbar has changed. Declaration public event Action ChangedPosition Event Type Type Description System.Action Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize"
},
"api/Terminal.Gui/Terminal.Gui.ScrollView.html": {
"href": "api/Terminal.Gui/Terminal.Gui.ScrollView.html",
"title": "Class ScrollView",
- "keywords": "Class ScrollView Scrollviews are views that present a window into a virtual space where subviews are added. Similar to the iOS UIScrollView. Inheritance System.Object Responder View ScrollView Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.CanFocus View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View[]) View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.Text View.TextAlignment View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.BeginInit() View.EndInit() View.Visible Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class ScrollView : View, IDisposable, ISupportInitializeNotification, ISupportInitialize Remarks The subviews that are added to this ScrollView are offset by the ContentOffset property. The view itself is a window into the space represented by the ContentSize . Use the Constructors ScrollView() Initializes a new instance of the ScrollView class using Computed positioning. Declaration public ScrollView() ScrollView(Rect) Initializes a new instance of the ScrollView class using Absolute positioning. Declaration public ScrollView(Rect frame) Parameters Type Name Description Rect frame Properties AutoHideScrollBars If true the vertical/horizontal scroll bars won't be showed if it's not needed. Declaration public bool AutoHideScrollBars { get; set; } Property Value Type Description System.Boolean ContentOffset Represents the top left corner coordinate that is displayed by the scrollview Declaration public Point ContentOffset { get; set; } Property Value Type Description Point The content offset. ContentSize Represents the contents of the data shown inside the scrolview Declaration public Size ContentSize { get; set; } Property Value Type Description Size The size of the content. KeepContentAlwaysInViewport Get or sets if the view-port is kept always visible in the area of this ScrollView Declaration public bool KeepContentAlwaysInViewport { get; set; } Property Value Type Description System.Boolean ShowHorizontalScrollIndicator Gets or sets the visibility for the horizontal scroll indicator. Declaration public bool ShowHorizontalScrollIndicator { get; set; } Property Value Type Description System.Boolean true if show horizontal scroll indicator; otherwise, false . ShowVerticalScrollIndicator /// Gets or sets the visibility for the vertical scroll indicator. Declaration public bool ShowVerticalScrollIndicator { get; set; } Property Value Type Description System.Boolean true if show vertical scroll indicator; otherwise, false . Methods Add(View) Adds the view to the scrollview. Declaration public override void Add(View view) Parameters Type Name Description View view The view to add to the scrollview. Overrides View.Add(View) Dispose(Boolean) Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. Declaration protected override void Dispose(bool disposing) Parameters Type Name Description System.Boolean disposing Overrides View.Dispose(Boolean) Remarks If disposing equals true, the method has been called directly or indirectly by a user's code. Managed and unmanaged resources can be disposed. If disposing equals false, the method has been called by the runtime from inside the finalizer and you should not reference other objects. Only unmanaged resources can be disposed. MouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public override bool MouseEvent(MouseEvent me) Parameters Type Name Description MouseEvent me Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides Responder.MouseEvent(MouseEvent) PositionCursor() Positions the cursor in the right position based on the currently focused view in the chain. Declaration public override void PositionCursor() Overrides View.PositionCursor() ProcessKey(KeyEvent) If the view is focused, gives the view a chance to process the keystroke. Declaration public override bool ProcessKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides View.ProcessKey(KeyEvent) Remarks 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. Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect region) Parameters Type Name Description Rect region Overrides View.Redraw(Rect) Remarks 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. RemoveAll() Removes all widgets from this container. Declaration public override void RemoveAll() Overrides View.RemoveAll() Remarks ScrollDown(Int32) Scrolls the view down. Declaration public bool ScrollDown(int lines) Parameters Type Name Description System.Int32 lines Number of lines to scroll. Returns Type Description System.Boolean true , if left was scrolled, false otherwise. ScrollLeft(Int32) Scrolls the view to the left Declaration public bool ScrollLeft(int cols) Parameters Type Name Description System.Int32 cols Number of columns to scroll by. Returns Type Description System.Boolean true , if left was scrolled, false otherwise. ScrollRight(Int32) Scrolls the view to the right. Declaration public bool ScrollRight(int cols) Parameters Type Name Description System.Int32 cols Number of columns to scroll by. Returns Type Description System.Boolean true , if right was scrolled, false otherwise. ScrollUp(Int32) Scrolls the view up. Declaration public bool ScrollUp(int lines) Parameters Type Name Description System.Int32 lines Number of lines to scroll. Returns Type Description System.Boolean true , if left was scrolled, false otherwise. Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize"
+ "keywords": "Class ScrollView Scrollviews are views that present a window into a virtual space where subviews are added. Similar to the iOS UIScrollView. Inheritance System.Object Responder View ScrollView Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Shortcut View.ShortcutTag View.ShortcutAction View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.CanFocus View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View[]) View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.Text View.AutoSize View.TextAlignment View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.BeginInit() View.EndInit() View.Visible Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class ScrollView : View, IDisposable, ISupportInitializeNotification, ISupportInitialize Remarks The subviews that are added to this ScrollView are offset by the ContentOffset property. The view itself is a window into the space represented by the ContentSize . Use the Constructors ScrollView() Initializes a new instance of the ScrollView class using Computed positioning. Declaration public ScrollView() ScrollView(Rect) Initializes a new instance of the ScrollView class using Absolute positioning. Declaration public ScrollView(Rect frame) Parameters Type Name Description Rect frame Properties AutoHideScrollBars If true the vertical/horizontal scroll bars won't be showed if it's not needed. Declaration public bool AutoHideScrollBars { get; set; } Property Value Type Description System.Boolean ContentOffset Represents the top left corner coordinate that is displayed by the scrollview Declaration public Point ContentOffset { get; set; } Property Value Type Description Point The content offset. ContentSize Represents the contents of the data shown inside the scrolview Declaration public Size ContentSize { get; set; } Property Value Type Description Size The size of the content. KeepContentAlwaysInViewport Get or sets if the view-port is kept always visible in the area of this ScrollView Declaration public bool KeepContentAlwaysInViewport { get; set; } Property Value Type Description System.Boolean ShowHorizontalScrollIndicator Gets or sets the visibility for the horizontal scroll indicator. Declaration public bool ShowHorizontalScrollIndicator { get; set; } Property Value Type Description System.Boolean true if show horizontal scroll indicator; otherwise, false . ShowVerticalScrollIndicator /// Gets or sets the visibility for the vertical scroll indicator. Declaration public bool ShowVerticalScrollIndicator { get; set; } Property Value Type Description System.Boolean true if show vertical scroll indicator; otherwise, false . Methods Add(View) Adds the view to the scrollview. Declaration public override void Add(View view) Parameters Type Name Description View view The view to add to the scrollview. Overrides View.Add(View) Dispose(Boolean) Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. Declaration protected override void Dispose(bool disposing) Parameters Type Name Description System.Boolean disposing Overrides View.Dispose(Boolean) Remarks If disposing equals true, the method has been called directly or indirectly by a user's code. Managed and unmanaged resources can be disposed. If disposing equals false, the method has been called by the runtime from inside the finalizer and you should not reference other objects. Only unmanaged resources can be disposed. MouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public override bool MouseEvent(MouseEvent me) Parameters Type Name Description MouseEvent me Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides Responder.MouseEvent(MouseEvent) PositionCursor() Positions the cursor in the right position based on the currently focused view in the chain. Declaration public override void PositionCursor() Overrides View.PositionCursor() ProcessKey(KeyEvent) If the view is focused, gives the view a chance to process the keystroke. Declaration public override bool ProcessKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides View.ProcessKey(KeyEvent) Remarks 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. Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect region) Parameters Type Name Description Rect region Overrides View.Redraw(Rect) Remarks 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. RemoveAll() Removes all widgets from this container. Declaration public override void RemoveAll() Overrides View.RemoveAll() Remarks ScrollDown(Int32) Scrolls the view down. Declaration public bool ScrollDown(int lines) Parameters Type Name Description System.Int32 lines Number of lines to scroll. Returns Type Description System.Boolean true , if left was scrolled, false otherwise. ScrollLeft(Int32) Scrolls the view to the left Declaration public bool ScrollLeft(int cols) Parameters Type Name Description System.Int32 cols Number of columns to scroll by. Returns Type Description System.Boolean true , if left was scrolled, false otherwise. ScrollRight(Int32) Scrolls the view to the right. Declaration public bool ScrollRight(int cols) Parameters Type Name Description System.Int32 cols Number of columns to scroll by. Returns Type Description System.Boolean true , if right was scrolled, false otherwise. ScrollUp(Int32) Scrolls the view up. Declaration public bool ScrollUp(int lines) Parameters Type Name Description System.Int32 lines Number of lines to scroll. Returns Type Description System.Boolean true , if left was scrolled, false otherwise. Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize"
+ },
+ "api/Terminal.Gui/Terminal.Gui.ShortcutHelper.html": {
+ "href": "api/Terminal.Gui/Terminal.Gui.ShortcutHelper.html",
+ "title": "Class ShortcutHelper",
+ "keywords": "Class ShortcutHelper Represents a helper to manipulate shortcut keys used on views. Inheritance System.Object ShortcutHelper Inherited Members System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) System.Object.ToString() Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class ShortcutHelper Properties Shortcut This is the global setting that can be used as a global shortcut to invoke the action on the view. Declaration public virtual Key Shortcut { get; set; } Property Value Type Description Key ShortcutAction The action to run if the Shortcut is defined. Declaration public virtual Action ShortcutAction { get; set; } Property Value Type Description System.Action ShortcutTag The keystroke combination used in the Shortcut as string. Declaration public virtual ustring ShortcutTag { get; } Property Value Type Description NStack.ustring Methods CheckKeysFlagRange(Key, Key, Key) Lookup for a Key on range of keys. Declaration public static bool CheckKeysFlagRange(Key key, Key first, Key last) Parameters Type Name Description Key key The source key. Key first First key in range. Key last Last key in range. Returns Type Description System.Boolean FindAndOpenByShortcut(KeyEvent, View) Allows a view to run a ShortcutAction if defined. Declaration public static bool FindAndOpenByShortcut(KeyEvent kb, View view = null) Parameters Type Name Description KeyEvent kb The KeyEvent View view The View Returns Type Description System.Boolean true if defined false otherwise. GetKeyToString(Key, out Key) Return key as string. Declaration public static ustring GetKeyToString(Key key, out Key knm) Parameters Type Name Description Key key The key to extract. Key knm Correspond to the non modifier key. Returns Type Description NStack.ustring GetModifiersKey(KeyEvent) Gets the key with all the keys modifiers, especially the shift key that sometimes have to be injected later. Declaration public static Key GetModifiersKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb The KeyEvent to check. Returns Type Description Key The Key with all the keys modifiers. GetShortcutFromTag(ustring) Allows to retrieve a Key from a ShortcutTag Declaration public static Key GetShortcutFromTag(ustring tag) Parameters Type Name Description NStack.ustring tag The key as string. Returns Type Description Key GetShortcutTag(Key) Get the Shortcut key as string. Declaration public static ustring GetShortcutTag(Key shortcut) Parameters Type Name Description Key shortcut The shortcut key. Returns Type Description NStack.ustring PostShortcutValidation(Key) Used at key up validation. Declaration public static bool PostShortcutValidation(Key key) Parameters Type Name Description Key key The key to validate. Returns Type Description System.Boolean true if is valid. false otherwise. PreShortcutValidation(Key) Used at key down or key press validation. Declaration public static bool PreShortcutValidation(Key key) Parameters Type Name Description Key key The key to validate. Returns Type Description System.Boolean true if is valid. false otherwise."
},
"api/Terminal.Gui/Terminal.Gui.Size.html": {
"href": "api/Terminal.Gui/Terminal.Gui.Size.html",
@@ -277,7 +282,7 @@
"api/Terminal.Gui/Terminal.Gui.StatusBar.html": {
"href": "api/Terminal.Gui/Terminal.Gui.StatusBar.html",
"title": "Class StatusBar",
- "keywords": "Class StatusBar A status bar is a View that snaps to the bottom of a Toplevel displaying set of StatusItem s. The StatusBar should be context sensitive. This means, if the main menu and an open text editor are visible, the items probably shown will be ~F1~ Help ~F2~ Save ~F3~ Load. While a dialog to ask a file to load is executed, the remaining commands will probably be ~F1~ Help. So for each context must be a new instance of a statusbar. Inheritance System.Object Responder View StatusBar Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.CanFocus View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View) View.Add(View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.PositionCursor() View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.Text View.TextAlignment View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.BeginInit() View.EndInit() View.Visible Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class StatusBar : View, IDisposable, ISupportInitializeNotification, ISupportInitialize Constructors StatusBar() Initializes a new instance of the StatusBar class. Declaration public StatusBar() StatusBar(StatusItem[]) Initializes a new instance of the StatusBar class with the specified set of StatusItem s. The StatusBar will be drawn on the lowest line of the terminal or SuperView (if not null). Declaration public StatusBar(StatusItem[] items) Parameters Type Name Description StatusItem [] items A list of statusbar items. Properties Items The items that compose the StatusBar Declaration public StatusItem[] Items { get; set; } Property Value Type Description StatusItem [] Methods Dispose(Boolean) Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. Declaration protected override void Dispose(bool disposing) Parameters Type Name Description System.Boolean disposing Overrides View.Dispose(Boolean) Remarks If disposing equals true, the method has been called directly or indirectly by a user's code. Managed and unmanaged resources can be disposed. If disposing equals false, the method has been called by the runtime from inside the finalizer and you should not reference other objects. Only unmanaged resources can be disposed. MouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public override bool MouseEvent(MouseEvent me) Parameters Type Name Description MouseEvent me Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides Responder.MouseEvent(MouseEvent) ProcessHotKey(KeyEvent) This method can be overwritten by view that want to provide accelerator functionality (Alt-key for example). Declaration public override bool ProcessHotKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides View.ProcessHotKey(KeyEvent) Remarks 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. Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds The bounds (view-relative region) to redraw. Overrides View.Redraw(Rect) Remarks 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. Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize"
+ "keywords": "Class StatusBar A status bar is a View that snaps to the bottom of a Toplevel displaying set of StatusItem s. The StatusBar should be context sensitive. This means, if the main menu and an open text editor are visible, the items probably shown will be ~F1~ Help ~F2~ Save ~F3~ Load. While a dialog to ask a file to load is executed, the remaining commands will probably be ~F1~ Help. So for each context must be a new instance of a statusbar. Inheritance System.Object Responder View StatusBar Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Shortcut View.ShortcutTag View.ShortcutAction View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.CanFocus View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View) View.Add(View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.PositionCursor() View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.Text View.AutoSize View.TextAlignment View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.BeginInit() View.EndInit() View.Visible Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class StatusBar : View, IDisposable, ISupportInitializeNotification, ISupportInitialize Constructors StatusBar() Initializes a new instance of the StatusBar class. Declaration public StatusBar() StatusBar(StatusItem[]) Initializes a new instance of the StatusBar class with the specified set of StatusItem s. The StatusBar will be drawn on the lowest line of the terminal or SuperView (if not null). Declaration public StatusBar(StatusItem[] items) Parameters Type Name Description StatusItem [] items A list of statusbar items. Properties Items The items that compose the StatusBar Declaration public StatusItem[] Items { get; set; } Property Value Type Description StatusItem [] Methods Dispose(Boolean) Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. Declaration protected override void Dispose(bool disposing) Parameters Type Name Description System.Boolean disposing Overrides View.Dispose(Boolean) Remarks If disposing equals true, the method has been called directly or indirectly by a user's code. Managed and unmanaged resources can be disposed. If disposing equals false, the method has been called by the runtime from inside the finalizer and you should not reference other objects. Only unmanaged resources can be disposed. MouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public override bool MouseEvent(MouseEvent me) Parameters Type Name Description MouseEvent me Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides Responder.MouseEvent(MouseEvent) ProcessHotKey(KeyEvent) This method can be overwritten by view that want to provide accelerator functionality (Alt-key for example). Declaration public override bool ProcessHotKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides View.ProcessHotKey(KeyEvent) Remarks 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. Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds The bounds (view-relative region) to redraw. Overrides View.Redraw(Rect) Remarks 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. Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize"
},
"api/Terminal.Gui/Terminal.Gui.StatusItem.html": {
"href": "api/Terminal.Gui/Terminal.Gui.StatusItem.html",
@@ -289,30 +294,35 @@
"title": "Enum TextAlignment",
"keywords": "Enum TextAlignment Text alignment enumeration, controls how text is displayed. Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public enum TextAlignment Fields Name Description Centered Centers the text in the frame. Justified Shows the text as justified text in the frame. Left Aligns the text to the left of the frame. Right Aligns the text to the right side of the frame."
},
+ "api/Terminal.Gui/Terminal.Gui.TextChangingEventArgs.html": {
+ "href": "api/Terminal.Gui/Terminal.Gui.TextChangingEventArgs.html",
+ "title": "Class TextChangingEventArgs",
+ "keywords": "Class TextChangingEventArgs An System.EventArgs which allows passing a cancelable new text value event. Inheritance System.Object System.EventArgs TextChangingEventArgs Inherited Members System.EventArgs.Empty System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) System.Object.ToString() Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class TextChangingEventArgs : EventArgs Constructors TextChangingEventArgs(ustring) Initializes a new instance of TextChangingEventArgs Declaration public TextChangingEventArgs(ustring newText) Parameters Type Name Description NStack.ustring newText The new Text to be replaced. Properties Cancel Flag which allows to cancel the new text value. Declaration public bool Cancel { get; set; } Property Value Type Description System.Boolean NewText The new text to be replaced. Declaration public ustring NewText { get; set; } Property Value Type Description NStack.ustring"
+ },
"api/Terminal.Gui/Terminal.Gui.TextField.html": {
"href": "api/Terminal.Gui/Terminal.Gui.TextField.html",
"title": "Class TextField",
- "keywords": "Class TextField Single-line text entry View Inheritance System.Object Responder View TextField DateField TimeField Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View) View.Add(View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.TextAlignment View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class TextField : View, IDisposable, ISupportInitializeNotification, ISupportInitialize Remarks The TextField View provides editing functionality and mouse support. Constructors TextField() Initializes a new instance of the TextField class using Computed positioning. Declaration public TextField() TextField(ustring) Initializes a new instance of the TextField class using Computed positioning. Declaration public TextField(ustring text) Parameters Type Name Description NStack.ustring text Initial text contents. TextField(Int32, Int32, Int32, ustring) Initializes a new instance of the TextField class using Absolute positioning. Declaration public TextField(int x, int y, int w, ustring text) Parameters Type Name Description System.Int32 x The x coordinate. System.Int32 y The y coordinate. System.Int32 w The width. NStack.ustring text Initial text contents. TextField(String) Initializes a new instance of the TextField class using Computed positioning. Declaration public TextField(string text) Parameters Type Name Description System.String text Initial text contents. Properties CanFocus Gets or sets a value indicating whether this Responder can focus. Declaration public override bool CanFocus { get; set; } Property Value Type Description System.Boolean true if can focus; otherwise, false . Overrides View.CanFocus CursorPosition Sets or gets the current cursor position. Declaration public int CursorPosition { get; set; } Property Value Type Description System.Int32 Frame Gets or sets the frame for the view. The frame is relative to the view's container ( SuperView ). Declaration public override Rect Frame { get; set; } Property Value Type Description Rect The frame. Overrides View.Frame Remarks 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 . ReadOnly If set to true its not allow any changes in the text. Declaration public bool ReadOnly { get; set; } Property Value Type Description System.Boolean Secret Sets the secret property. Declaration public bool Secret { get; set; } Property Value Type Description System.Boolean Remarks This makes the text entry suitable for entering passwords. SelectedLength Length of the selected text. Declaration public int SelectedLength { get; set; } Property Value Type Description System.Int32 SelectedStart Start position of the selected text. Declaration public int SelectedStart { get; set; } Property Value Type Description System.Int32 SelectedText The selected text. Declaration public ustring SelectedText { get; set; } Property Value Type Description NStack.ustring Text Sets or gets the text held by the view. Declaration public ustring Text { get; set; } Property Value Type Description NStack.ustring Remarks Used Tracks whether the text field should be considered \"used\", that is, that the user has moved in the entry, so new input should be appended at the cursor position, rather than clearing the entry Declaration public bool Used { get; set; } Property Value Type Description System.Boolean Methods ClearAllSelection() Clear the selected text. Declaration public void ClearAllSelection() Copy() Copy the selected text to the clipboard. Declaration public virtual void Copy() Cut() Cut the selected text to the clipboard. Declaration public virtual void Cut() MouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public override bool MouseEvent(MouseEvent ev) Parameters Type Name Description MouseEvent ev Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides Responder.MouseEvent(MouseEvent) OnLeave(View) Method invoked when a view loses focus. Declaration public override bool OnLeave(View view) Parameters Type Name Description View view The view that is getting focus. Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides View.OnLeave(View) Paste() Paste the selected text from the clipboard. Declaration public virtual void Paste() PositionCursor() Sets the cursor position. Declaration public override void PositionCursor() Overrides View.PositionCursor() ProcessKey(KeyEvent) Processes key presses for the TextField . Declaration public override bool ProcessKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides View.ProcessKey(KeyEvent) Remarks The TextField control responds to the following keys: Keys Function Delete , Backspace Deletes the character before cursor. Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds The bounds (view-relative region) to redraw. Overrides View.Redraw(Rect) Remarks 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. Events TextChanged Changed event, raised when the text has changed. Declaration public event Action TextChanged Event Type Type Description System.Action < NStack.ustring > Remarks This event is raised when the Text changes. Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize"
+ "keywords": "Class TextField Single-line text entry View Inheritance System.Object Responder View TextField DateField TimeField Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Shortcut View.ShortcutTag View.ShortcutAction View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View) View.Add(View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.AutoSize View.TextAlignment View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class TextField : View, IDisposable, ISupportInitializeNotification, ISupportInitialize Remarks The TextField View provides editing functionality and mouse support. Constructors TextField() Initializes a new instance of the TextField class using Computed positioning. Declaration public TextField() TextField(ustring) Initializes a new instance of the TextField class using Computed positioning. Declaration public TextField(ustring text) Parameters Type Name Description NStack.ustring text Initial text contents. TextField(Int32, Int32, Int32, ustring) Initializes a new instance of the TextField class using Absolute positioning. Declaration public TextField(int x, int y, int w, ustring text) Parameters Type Name Description System.Int32 x The x coordinate. System.Int32 y The y coordinate. System.Int32 w The width. NStack.ustring text Initial text contents. TextField(String) Initializes a new instance of the TextField class using Computed positioning. Declaration public TextField(string text) Parameters Type Name Description System.String text Initial text contents. Properties CanFocus Gets or sets a value indicating whether this Responder can focus. Declaration public override bool CanFocus { get; set; } Property Value Type Description System.Boolean true if can focus; otherwise, false . Overrides View.CanFocus CursorPosition Sets or gets the current cursor position. Declaration public int CursorPosition { get; set; } Property Value Type Description System.Int32 Frame Gets or sets the frame for the view. The frame is relative to the view's container ( SuperView ). Declaration public override Rect Frame { get; set; } Property Value Type Description Rect The frame. Overrides View.Frame Remarks 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 . ReadOnly If set to true its not allow any changes in the text. Declaration public bool ReadOnly { get; set; } Property Value Type Description System.Boolean Secret Sets the secret property. Declaration public bool Secret { get; set; } Property Value Type Description System.Boolean Remarks This makes the text entry suitable for entering passwords. SelectedLength Length of the selected text. Declaration public int SelectedLength { get; set; } Property Value Type Description System.Int32 SelectedStart Start position of the selected text. Declaration public int SelectedStart { get; set; } Property Value Type Description System.Int32 SelectedText The selected text. Declaration public ustring SelectedText { get; set; } Property Value Type Description NStack.ustring Text Sets or gets the text held by the view. Declaration public ustring Text { get; set; } Property Value Type Description NStack.ustring Remarks Used Tracks whether the text field should be considered \"used\", that is, that the user has moved in the entry, so new input should be appended at the cursor position, rather than clearing the entry Declaration public bool Used { get; set; } Property Value Type Description System.Boolean Methods ClearAllSelection() Clear the selected text. Declaration public void ClearAllSelection() Copy() Copy the selected text to the clipboard. Declaration public virtual void Copy() Cut() Cut the selected text to the clipboard. Declaration public virtual void Cut() MouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public override bool MouseEvent(MouseEvent ev) Parameters Type Name Description MouseEvent ev Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides Responder.MouseEvent(MouseEvent) OnLeave(View) Method invoked when a view loses focus. Declaration public override bool OnLeave(View view) Parameters Type Name Description View view The view that is getting focus. Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides View.OnLeave(View) OnTextChanging(ustring) Virtual method that invoke the TextChanging event if it's defined. Declaration public virtual TextChangingEventArgs OnTextChanging(ustring newText) Parameters Type Name Description NStack.ustring newText The new text to be replaced. Returns Type Description TextChangingEventArgs Returns the TextChangingEventArgs Paste() Paste the selected text from the clipboard. Declaration public virtual void Paste() PositionCursor() Sets the cursor position. Declaration public override void PositionCursor() Overrides View.PositionCursor() ProcessKey(KeyEvent) Processes key presses for the TextField . Declaration public override bool ProcessKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides View.ProcessKey(KeyEvent) Remarks The TextField control responds to the following keys: Keys Function Delete , Backspace Deletes the character before cursor. Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds The bounds (view-relative region) to redraw. Overrides View.Redraw(Rect) Remarks 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. Events TextChanged Changed event, raised when the text has changed. Declaration public event Action TextChanged Event Type Type Description System.Action < NStack.ustring > Remarks This event is raised when the Text changes. TextChanging Changing event, raised before the Text changes and can be canceled or changing the new text. Declaration public event Action TextChanging Event Type Type Description System.Action < TextChangingEventArgs > Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize"
},
"api/Terminal.Gui/Terminal.Gui.TextFormatter.html": {
"href": "api/Terminal.Gui/Terminal.Gui.TextFormatter.html",
"title": "Class TextFormatter",
- "keywords": "Class TextFormatter Provides text formatting capabilities for console apps. Supports, hotkeys, horizontal alignment, multille lines, and word-based line wrap. Inheritance System.Object TextFormatter Inherited Members System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) System.Object.ToString() Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class TextFormatter Properties Alignment Controls the horizontal text-alignment property. Declaration public TextAlignment Alignment { get; set; } Property Value Type Description TextAlignment The text alignment. CursorPosition Gets the cursor position from HotKey . If the HotKey is defined, the cursor will be positioned over it. Declaration public int CursorPosition { get; set; } Property Value Type Description System.Int32 HotKey Gets the hotkey. Will be an upper case letter or digit. Declaration public Key HotKey { get; } Property Value Type Description Key HotKeyPos The position in the text of the hotkey. The hotkey will be rendered using the hot color. Declaration public int HotKeyPos { get; set; } Property Value Type Description System.Int32 HotKeySpecifier The specifier character for the hotkey (e.g. '_'). Set to '\\xffff' to disable hotkey support for this View instance. The default is '\\xffff'. Declaration public Rune HotKeySpecifier { get; set; } Property Value Type Description System.Rune HotKeyTagMask Specifies the mask to apply to the hotkey to tag it as the hotkey. The default value of 0x100000 causes the underlying Rune to be identified as a \"private use\" Unicode character. Declaration public uint HotKeyTagMask { get; set; } Property Value Type Description System.UInt32 Lines Gets the formatted lines. Declaration public List Lines { get; } Property Value Type Description System.Collections.Generic.List < NStack.ustring > Remarks Upon a 'get' of this property, if the text needs to be formatted (if NeedsFormat is true ) Format(ustring, Int32, TextAlignment, Boolean) will be called internally. NeedsFormat Gets or sets whether the TextFormatter needs to format the text when Draw(Rect, Attribute, Attribute) is called. If it is false when Draw is called, the Draw call will be faster. Declaration public bool NeedsFormat { get; set; } Property Value Type Description System.Boolean Remarks This is set to true when the properties of TextFormatter are set. Size Gets or sets the size of the area the text will be constrainted to when formatted. Declaration public Size Size { get; set; } Property Value Type Description Size Text The text to be displayed. This text is never modified. Declaration public virtual ustring Text { get; set; } Property Value Type Description NStack.ustring Methods CalcRect(Int32, Int32, ustring) Calculates the rectangle required to hold text, assuming no word wrapping. Declaration public static Rect CalcRect(int x, int y, ustring text) Parameters Type Name Description System.Int32 x The x location of the rectangle System.Int32 y The y location of the rectangle NStack.ustring text The text to measure Returns Type Description Rect ClipAndJustify(ustring, Int32, TextAlignment) Justifies text within a specified width. Declaration public static ustring ClipAndJustify(ustring text, int width, TextAlignment talign) Parameters Type Name Description NStack.ustring text The text to justify. System.Int32 width If the text length is greater that width it will be clipped. TextAlignment talign Alignment. Returns Type Description NStack.ustring Justified and clipped text. Draw(Rect, Attribute, Attribute) Draws the text held by TextFormatter to Driver using the colors specified. Declaration public void Draw(Rect bounds, Attribute normalColor, Attribute hotColor) Parameters Type Name Description Rect bounds Specifies the screen-relative location and maximum size for drawing the text. Attribute normalColor The color to use for all text except the hotkey Attribute hotColor The color to use to draw the hotkey FindHotKey(ustring, Rune, Boolean, out Int32, out Key) Finds the hotkey and its location in text. Declaration public static bool FindHotKey(ustring text, Rune hotKeySpecifier, bool firstUpperCase, out int hotPos, out Key hotKey) Parameters Type Name Description NStack.ustring text The text to look in. System.Rune hotKeySpecifier The hotkey specifier (e.g. '_') to look for. System.Boolean firstUpperCase If true the legacy behavior of identifying the first upper case character as the hotkey will be eanbled. Regardless of the value of this parameter, hotKeySpecifier takes precidence. System.Int32 hotPos Outputs the Rune index into text . Key hotKey Outputs the hotKey. Returns Type Description System.Boolean true if a hotkey was found; false otherwise. Format(ustring, Int32, TextAlignment, Boolean) Reformats text into lines, applying text alignment and optionally wrapping text to new lines on word boundaries. Declaration public static List Format(ustring text, int width, TextAlignment talign, bool wordWrap) Parameters Type Name Description NStack.ustring text System.Int32 width The width to bound the text to for word wrapping and clipping. TextAlignment talign Specifies how the text will be aligned horizontally. System.Boolean wordWrap If true , the text will be wrapped to new lines as need. If false , forces text to fit a single line. Line breaks are converted to spaces. The text will be clipped to width Returns Type Description System.Collections.Generic.List < NStack.ustring > A list of word wrapped lines. Remarks An empty text string will result in one empty line. If width is 0, a single, empty line will be returned. If width is int.MaxValue, the text will be formatted to the maximum width possible. Justify(ustring, Int32, Char) Justifies the text to fill the width provided. Space will be added between words (demarked by spaces and tabs) to make the text just fit width . Spaces will not be added to the ends. Declaration public static ustring Justify(ustring text, int width, char spaceChar = ' ') Parameters Type Name Description NStack.ustring text System.Int32 width System.Char spaceChar Character to replace whitespace and pad with. For debugging purposes. Returns Type Description NStack.ustring The justifed text. MaxLines(ustring, Int32) Computes the number of lines needed to render the specified text given the width. Declaration public static int MaxLines(ustring text, int width) Parameters Type Name Description NStack.ustring text Text, may contain newlines. System.Int32 width The minimum width for the text. Returns Type Description System.Int32 Number of lines. MaxWidth(ustring, Int32) Computes the maximum width needed to render the text (single line or multple lines) given a minimum width. Declaration public static int MaxWidth(ustring text, int width) Parameters Type Name Description NStack.ustring text Text, may contain newlines. System.Int32 width The minimum width for the text. Returns Type Description System.Int32 Max width of lines. RemoveHotKeySpecifier(ustring, Int32, Rune) Removes the hotkey specifier from text. Declaration public static ustring RemoveHotKeySpecifier(ustring text, int hotPos, Rune hotKeySpecifier) Parameters Type Name Description NStack.ustring text The text to manipulate. System.Int32 hotPos Returns the position of the hot-key in the text. -1 if not found. System.Rune hotKeySpecifier The hot-key specifier (e.g. '_') to look for. Returns Type Description NStack.ustring The input text with the hotkey specifier ('_') removed. ReplaceHotKeyWithTag(ustring, Int32) Replaces the Rune at the index specfiied by the hotPos parameter with a tag identifying it as the hotkey. Declaration public ustring ReplaceHotKeyWithTag(ustring text, int hotPos) Parameters Type Name Description NStack.ustring text The text to tag the hotkey in. System.Int32 hotPos The Rune index of the hotkey in text . Returns Type Description NStack.ustring The text with the hotkey tagged. Remarks The returned string will not render correctly without first un-doing the tag. To undo the tag, search for Runes with a bitmask of otKeyTagMask and remove that bitmask. WordWrap(ustring, Int32) Formats the provided text to fit within the width provided using word wrapping. Declaration public static List WordWrap(ustring text, int width) Parameters Type Name Description NStack.ustring text The text to word wrap System.Int32 width The width to contrain the text to Returns Type Description System.Collections.Generic.List < NStack.ustring > Returns a list of word wrapped lines. Remarks This method does not do any justification. This method strips Newline ('\\n' and '\\r\\n') sequences before processing."
+ "keywords": "Class TextFormatter Provides text formatting capabilities for console apps. Supports, hotkeys, horizontal alignment, multiple lines, and word-based line wrap. Inheritance System.Object TextFormatter Inherited Members System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) System.Object.ToString() Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class TextFormatter Properties Alignment Controls the horizontal text-alignment property. Declaration public TextAlignment Alignment { get; set; } Property Value Type Description TextAlignment The text alignment. CursorPosition Gets the cursor position from HotKey . If the HotKey is defined, the cursor will be positioned over it. Declaration public int CursorPosition { get; set; } Property Value Type Description System.Int32 HotKey Gets the hotkey. Will be an upper case letter or digit. Declaration public Key HotKey { get; } Property Value Type Description Key HotKeyPos The position in the text of the hotkey. The hotkey will be rendered using the hot color. Declaration public int HotKeyPos { get; set; } Property Value Type Description System.Int32 HotKeySpecifier The specifier character for the hotkey (e.g. '_'). Set to '\\xffff' to disable hotkey support for this View instance. The default is '\\xffff'. Declaration public Rune HotKeySpecifier { get; set; } Property Value Type Description System.Rune HotKeyTagMask Specifies the mask to apply to the hotkey to tag it as the hotkey. The default value of 0x100000 causes the underlying Rune to be identified as a \"private use\" Unicode character. Declaration public uint HotKeyTagMask { get; set; } Property Value Type Description System.UInt32 Lines Gets the formatted lines. Declaration public List Lines { get; } Property Value Type Description System.Collections.Generic.List < NStack.ustring > Remarks Upon a 'get' of this property, if the text needs to be formatted (if NeedsFormat is true ) Format(ustring, Int32, TextAlignment, Boolean) will be called internally. NeedsFormat Gets or sets whether the TextFormatter needs to format the text when Draw(Rect, Attribute, Attribute) is called. If it is false when Draw is called, the Draw call will be faster. Declaration public bool NeedsFormat { get; set; } Property Value Type Description System.Boolean Remarks This is set to true when the properties of TextFormatter are set. Size Gets or sets the size of the area the text will be constrained to when formatted. Declaration public Size Size { get; set; } Property Value Type Description Size Text The text to be displayed. This text is never modified. Declaration public virtual ustring Text { get; set; } Property Value Type Description NStack.ustring Methods CalcRect(Int32, Int32, ustring) Calculates the rectangle required to hold text, assuming no word wrapping. Declaration public static Rect CalcRect(int x, int y, ustring text) Parameters Type Name Description System.Int32 x The x location of the rectangle System.Int32 y The y location of the rectangle NStack.ustring text The text to measure Returns Type Description Rect ClipAndJustify(ustring, Int32, TextAlignment) Justifies text within a specified width. Declaration public static ustring ClipAndJustify(ustring text, int width, TextAlignment talign) Parameters Type Name Description NStack.ustring text The text to justify. System.Int32 width If the text length is greater that width it will be clipped. TextAlignment talign Alignment. Returns Type Description NStack.ustring Justified and clipped text. Draw(Rect, Attribute, Attribute) Draws the text held by TextFormatter to Driver using the colors specified. Declaration public void Draw(Rect bounds, Attribute normalColor, Attribute hotColor) Parameters Type Name Description Rect bounds Specifies the screen-relative location and maximum size for drawing the text. Attribute normalColor The color to use for all text except the hotkey Attribute hotColor The color to use to draw the hotkey FindHotKey(ustring, Rune, Boolean, out Int32, out Key) Finds the hotkey and its location in text. Declaration public static bool FindHotKey(ustring text, Rune hotKeySpecifier, bool firstUpperCase, out int hotPos, out Key hotKey) Parameters Type Name Description NStack.ustring text The text to look in. System.Rune hotKeySpecifier The hotkey specifier (e.g. '_') to look for. System.Boolean firstUpperCase If true the legacy behavior of identifying the first upper case character as the hotkey will be enabled. Regardless of the value of this parameter, hotKeySpecifier takes precedence. System.Int32 hotPos Outputs the Rune index into text . Key hotKey Outputs the hotKey. Returns Type Description System.Boolean true if a hotkey was found; false otherwise. Format(ustring, Int32, TextAlignment, Boolean) Reformats text into lines, applying text alignment and optionally wrapping text to new lines on word boundaries. Declaration public static List Format(ustring text, int width, TextAlignment talign, bool wordWrap) Parameters Type Name Description NStack.ustring text System.Int32 width The width to bound the text to for word wrapping and clipping. TextAlignment talign Specifies how the text will be aligned horizontally. System.Boolean wordWrap If true , the text will be wrapped to new lines as need. If false , forces text to fit a single line. Line breaks are converted to spaces. The text will be clipped to width Returns Type Description System.Collections.Generic.List < NStack.ustring > A list of word wrapped lines. Remarks An empty text string will result in one empty line. If width is 0, a single, empty line will be returned. If width is int.MaxValue, the text will be formatted to the maximum width possible. Justify(ustring, Int32, Char) Justifies the text to fill the width provided. Space will be added between words (demarked by spaces and tabs) to make the text just fit width . Spaces will not be added to the ends. Declaration public static ustring Justify(ustring text, int width, char spaceChar = ' ') Parameters Type Name Description NStack.ustring text System.Int32 width System.Char spaceChar Character to replace whitespace and pad with. For debugging purposes. Returns Type Description NStack.ustring The justified text. MaxLines(ustring, Int32) Computes the number of lines needed to render the specified text given the width. Declaration public static int MaxLines(ustring text, int width) Parameters Type Name Description NStack.ustring text Text, may contain newlines. System.Int32 width The minimum width for the text. Returns Type Description System.Int32 Number of lines. MaxWidth(ustring, Int32) Computes the maximum width needed to render the text (single line or multiple lines) given a minimum width. Declaration public static int MaxWidth(ustring text, int width) Parameters Type Name Description NStack.ustring text Text, may contain newlines. System.Int32 width The minimum width for the text. Returns Type Description System.Int32 Max width of lines. RemoveHotKeySpecifier(ustring, Int32, Rune) Removes the hotkey specifier from text. Declaration public static ustring RemoveHotKeySpecifier(ustring text, int hotPos, Rune hotKeySpecifier) Parameters Type Name Description NStack.ustring text The text to manipulate. System.Int32 hotPos Returns the position of the hot-key in the text. -1 if not found. System.Rune hotKeySpecifier The hot-key specifier (e.g. '_') to look for. Returns Type Description NStack.ustring The input text with the hotkey specifier ('_') removed. ReplaceHotKeyWithTag(ustring, Int32) Replaces the Rune at the index specified by the hotPos parameter with a tag identifying it as the hotkey. Declaration public ustring ReplaceHotKeyWithTag(ustring text, int hotPos) Parameters Type Name Description NStack.ustring text The text to tag the hotkey in. System.Int32 hotPos The Rune index of the hotkey in text . Returns Type Description NStack.ustring The text with the hotkey tagged. Remarks The returned string will not render correctly without first un-doing the tag. To undo the tag, search for Runes with a bitmask of otKeyTagMask and remove that bitmask. WordWrap(ustring, Int32) Formats the provided text to fit within the width provided using word wrapping. Declaration public static List WordWrap(ustring text, int width) Parameters Type Name Description NStack.ustring text The text to word wrap System.Int32 width The width to contain the text to Returns Type Description System.Collections.Generic.List < NStack.ustring > Returns a list of word wrapped lines. Remarks This method does not do any justification. This method strips Newline ('\\n' and '\\r\\n') sequences before processing."
},
"api/Terminal.Gui/Terminal.Gui.TextView.html": {
"href": "api/Terminal.Gui/Terminal.Gui.TextView.html",
"title": "Class TextView",
- "keywords": "Class TextView Multi-line text editing View Inheritance System.Object Responder View TextView Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View) View.Add(View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.TextAlignment View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class TextView : View, IDisposable, ISupportInitializeNotification, ISupportInitialize Remarks TextView provides a multi-line text editor. Users interact with it with the standard Emacs commands for movement or the arrow keys. Shortcut Action performed Left cursor, Control-b Moves the editing point left. Right cursor, Control-f Moves the editing point right. Alt-b Moves one word back. Alt-f Moves one word forward. Up cursor, Control-p Moves the editing point one line up. Down cursor, Control-n Moves the editing point one line down Home key, Control-a Moves the cursor to the beginning of the line. End key, Control-e Moves the cursor to the end of the line. Control-Home Scrolls to the first line and moves the cursor there. Control-End Scrolls to the last line and moves the cursor there. Delete, Control-d Deletes the character in front of the cursor. Backspace Deletes the character behind the cursor. Control-k Deletes the text until the end of the line and replaces the kill buffer with the deleted text. You can paste this text in a different place by using Control-y. Control-y Pastes the content of the kill ring into the current position. Alt-d Deletes the word above the cursor and adds it to the kill ring. You can paste the contents of the kill ring with Control-y. Control-q Quotes the next input character, to prevent the normal processing of key handling to take place. Constructors TextView() Initializes a TextView on the specified area, with dimensions controlled with the X, Y, Width and Height properties. Declaration public TextView() TextView(Rect) Initializes a TextView on the specified area, with absolute position and size. Declaration public TextView(Rect frame) Parameters Type Name Description Rect frame Remarks Properties CanFocus Gets or sets a value indicating whether this Responder can focus. Declaration public override bool CanFocus { get; set; } Property Value Type Description System.Boolean true if can focus; otherwise, false . Overrides View.CanFocus CurrentColumn Gets the cursor column. Declaration public int CurrentColumn { get; } Property Value Type Description System.Int32 The cursor column. CurrentRow Gets the current cursor row. Declaration public int CurrentRow { get; } Property Value Type Description System.Int32 ReadOnly Gets or sets whether the TextView is in read-only mode or not Declaration public bool ReadOnly { get; set; } Property Value Type Description System.Boolean Boolean value(Default false) Text Sets or gets the text in the TextView . Declaration public override ustring Text { get; set; } Property Value Type Description NStack.ustring Overrides View.Text Remarks Methods CloseFile() Closes the contents of the stream into the TextView . Declaration public bool CloseFile() Returns Type Description System.Boolean true , if stream was closed, false otherwise. LoadFile(String) Loads the contents of the file into the TextView . Declaration public bool LoadFile(string path) Parameters Type Name Description System.String path Path to the file to load. Returns Type Description System.Boolean true , if file was loaded, false otherwise. LoadStream(Stream) Loads the contents of the stream into the TextView . Declaration public void LoadStream(Stream stream) Parameters Type Name Description System.IO.Stream stream Stream to load the contents from. MouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public override bool MouseEvent(MouseEvent ev) Parameters Type Name Description MouseEvent ev Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides Responder.MouseEvent(MouseEvent) MoveEnd() Will scroll the TextView to the last line and position the cursor there. Declaration public void MoveEnd() MoveHome() Will scroll the TextView to the first line and position the cursor there. Declaration public void MoveHome() PositionCursor() Positions the cursor on the current row and column Declaration public override void PositionCursor() Overrides View.PositionCursor() ProcessKey(KeyEvent) If the view is focused, gives the view a chance to process the keystroke. Declaration public override bool ProcessKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides View.ProcessKey(KeyEvent) Remarks 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. Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds The bounds (view-relative region) to redraw. Overrides View.Redraw(Rect) Remarks 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. ScrollTo(Int32) Will scroll the TextView to display the specified row at the top Declaration public void ScrollTo(int row) Parameters Type Name Description System.Int32 row Row that should be displayed at the top, if the value is negative it will be reset to zero Events TextChanged Raised when the Text of the TextView changes. Declaration public event Action TextChanged Event Type Type Description System.Action Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize"
+ "keywords": "Class TextView Multi-line text editing View Inheritance System.Object Responder View TextView Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Shortcut View.ShortcutTag View.ShortcutAction View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View) View.Add(View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.AutoSize View.TextAlignment View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class TextView : View, IDisposable, ISupportInitializeNotification, ISupportInitialize Remarks TextView provides a multi-line text editor. Users interact with it with the standard Emacs commands for movement or the arrow keys. Shortcut Action performed Left cursor, Control-b Moves the editing point left. Right cursor, Control-f Moves the editing point right. Alt-b Moves one word back. Alt-f Moves one word forward. Up cursor, Control-p Moves the editing point one line up. Down cursor, Control-n Moves the editing point one line down Home key, Control-a Moves the cursor to the beginning of the line. End key, Control-e Moves the cursor to the end of the line. Control-Home Scrolls to the first line and moves the cursor there. Control-End Scrolls to the last line and moves the cursor there. Delete, Control-d Deletes the character in front of the cursor. Backspace Deletes the character behind the cursor. Control-k Deletes the text until the end of the line and replaces the kill buffer with the deleted text. You can paste this text in a different place by using Control-y. Control-y Pastes the content of the kill ring into the current position. Alt-d Deletes the word above the cursor and adds it to the kill ring. You can paste the contents of the kill ring with Control-y. Control-q Quotes the next input character, to prevent the normal processing of key handling to take place. Constructors TextView() Initializes a TextView on the specified area, with dimensions controlled with the X, Y, Width and Height properties. Declaration public TextView() TextView(Rect) Initializes a TextView on the specified area, with absolute position and size. Declaration public TextView(Rect frame) Parameters Type Name Description Rect frame Remarks Properties CanFocus Gets or sets a value indicating whether this Responder can focus. Declaration public override bool CanFocus { get; set; } Property Value Type Description System.Boolean true if can focus; otherwise, false . Overrides View.CanFocus CurrentColumn Gets the cursor column. Declaration public int CurrentColumn { get; } Property Value Type Description System.Int32 The cursor column. CurrentRow Gets the current cursor row. Declaration public int CurrentRow { get; } Property Value Type Description System.Int32 ReadOnly Gets or sets whether the TextView is in read-only mode or not Declaration public bool ReadOnly { get; set; } Property Value Type Description System.Boolean Boolean value(Default false) Text Sets or gets the text in the TextView . Declaration public override ustring Text { get; set; } Property Value Type Description NStack.ustring Overrides View.Text Remarks Methods CloseFile() Closes the contents of the stream into the TextView . Declaration public bool CloseFile() Returns Type Description System.Boolean true , if stream was closed, false otherwise. LoadFile(String) Loads the contents of the file into the TextView . Declaration public bool LoadFile(string path) Parameters Type Name Description System.String path Path to the file to load. Returns Type Description System.Boolean true , if file was loaded, false otherwise. LoadStream(Stream) Loads the contents of the stream into the TextView . Declaration public void LoadStream(Stream stream) Parameters Type Name Description System.IO.Stream stream Stream to load the contents from. MouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public override bool MouseEvent(MouseEvent ev) Parameters Type Name Description MouseEvent ev Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides Responder.MouseEvent(MouseEvent) MoveEnd() Will scroll the TextView to the last line and position the cursor there. Declaration public void MoveEnd() MoveHome() Will scroll the TextView to the first line and position the cursor there. Declaration public void MoveHome() PositionCursor() Positions the cursor on the current row and column Declaration public override void PositionCursor() Overrides View.PositionCursor() ProcessKey(KeyEvent) If the view is focused, gives the view a chance to process the keystroke. Declaration public override bool ProcessKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides View.ProcessKey(KeyEvent) Remarks 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. Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds The bounds (view-relative region) to redraw. Overrides View.Redraw(Rect) Remarks 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. ScrollTo(Int32) Will scroll the TextView to display the specified row at the top Declaration public void ScrollTo(int row) Parameters Type Name Description System.Int32 row Row that should be displayed at the top, if the value is negative it will be reset to zero Events TextChanged Raised when the Text of the TextView changes. Declaration public event Action TextChanged Event Type Type Description System.Action Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize"
},
"api/Terminal.Gui/Terminal.Gui.TimeField.html": {
"href": "api/Terminal.Gui/Terminal.Gui.TimeField.html",
"title": "Class TimeField",
- "keywords": "Class TimeField Time editing View Inheritance System.Object Responder View TextField TimeField Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members TextField.Used TextField.ReadOnly TextField.TextChanged TextField.OnLeave(View) TextField.Frame TextField.Text TextField.Secret TextField.CursorPosition TextField.PositionCursor() TextField.Redraw(Rect) TextField.CanFocus TextField.SelectedStart TextField.SelectedLength TextField.SelectedText TextField.ClearAllSelection() TextField.Copy() TextField.Cut() TextField.Paste() View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View) View.Add(View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.TextAlignment View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class TimeField : TextField, IDisposable, ISupportInitializeNotification, ISupportInitialize Remarks The TimeField View provides time editing functionality with mouse support. Constructors TimeField() Initializes a new instance of TimeField using Computed positioning. Declaration public TimeField() TimeField(Int32, Int32, TimeSpan, Boolean) Initializes a new instance of TimeField using Absolute positioning. Declaration public TimeField(int x, int y, TimeSpan time, bool isShort = false) Parameters Type Name Description System.Int32 x The x coordinate. System.Int32 y The y coordinate. System.TimeSpan time Initial time. System.Boolean isShort If true, the seconds are hidden. Sets the IsShortFormat property. TimeField(TimeSpan) Initializes a new instance of TimeField using Computed positioning. Declaration public TimeField(TimeSpan time) Parameters Type Name Description System.TimeSpan time Initial time Properties IsShortFormat Get or sets whether TimeField uses the short or long time format. Declaration public bool IsShortFormat { get; set; } Property Value Type Description System.Boolean Time Gets or sets the time of the TimeField . Declaration public TimeSpan Time { get; set; } Property Value Type Description System.TimeSpan Remarks Methods MouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public override bool MouseEvent(MouseEvent ev) Parameters Type Name Description MouseEvent ev Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides TextField.MouseEvent(MouseEvent) OnTimeChanged(DateTimeEventArgs) Event firing method that invokes the TimeChanged event. Declaration public virtual void OnTimeChanged(DateTimeEventArgs args) Parameters Type Name Description DateTimeEventArgs < System.TimeSpan > args The event arguments ProcessKey(KeyEvent) Processes key presses for the TextField . Declaration public override bool ProcessKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides TextField.ProcessKey(KeyEvent) Remarks The TextField control responds to the following keys: Keys Function Delete , Backspace Deletes the character before cursor. Events TimeChanged TimeChanged event, raised when the Date has changed. Declaration public event Action> TimeChanged Event Type Type Description System.Action < DateTimeEventArgs < System.TimeSpan >> Remarks This event is raised when the Time changes. Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize"
+ "keywords": "Class TimeField Time editing View Inheritance System.Object Responder View TextField TimeField Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members TextField.Used TextField.ReadOnly TextField.TextChanging TextField.TextChanged TextField.OnLeave(View) TextField.Frame TextField.Text TextField.Secret TextField.CursorPosition TextField.PositionCursor() TextField.Redraw(Rect) TextField.CanFocus TextField.SelectedStart TextField.SelectedLength TextField.SelectedText TextField.ClearAllSelection() TextField.Copy() TextField.Cut() TextField.Paste() TextField.OnTextChanging(ustring) View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Shortcut View.ShortcutTag View.ShortcutAction View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View) View.Add(View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.AutoSize View.TextAlignment View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class TimeField : TextField, IDisposable, ISupportInitializeNotification, ISupportInitialize Remarks The TimeField View provides time editing functionality with mouse support. Constructors TimeField() Initializes a new instance of TimeField using Computed positioning. Declaration public TimeField() TimeField(Int32, Int32, TimeSpan, Boolean) Initializes a new instance of TimeField using Absolute positioning. Declaration public TimeField(int x, int y, TimeSpan time, bool isShort = false) Parameters Type Name Description System.Int32 x The x coordinate. System.Int32 y The y coordinate. System.TimeSpan time Initial time. System.Boolean isShort If true, the seconds are hidden. Sets the IsShortFormat property. TimeField(TimeSpan) Initializes a new instance of TimeField using Computed positioning. Declaration public TimeField(TimeSpan time) Parameters Type Name Description System.TimeSpan time Initial time Properties IsShortFormat Get or sets whether TimeField uses the short or long time format. Declaration public bool IsShortFormat { get; set; } Property Value Type Description System.Boolean Time Gets or sets the time of the TimeField . Declaration public TimeSpan Time { get; set; } Property Value Type Description System.TimeSpan Remarks Methods MouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public override bool MouseEvent(MouseEvent ev) Parameters Type Name Description MouseEvent ev Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides TextField.MouseEvent(MouseEvent) OnTimeChanged(DateTimeEventArgs) Event firing method that invokes the TimeChanged event. Declaration public virtual void OnTimeChanged(DateTimeEventArgs args) Parameters Type Name Description DateTimeEventArgs < System.TimeSpan > args The event arguments ProcessKey(KeyEvent) Processes key presses for the TextField . Declaration public override bool ProcessKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides TextField.ProcessKey(KeyEvent) Remarks The TextField control responds to the following keys: Keys Function Delete , Backspace Deletes the character before cursor. Events TimeChanged TimeChanged event, raised when the Date has changed. Declaration public event Action> TimeChanged Event Type Type Description System.Action < DateTimeEventArgs < System.TimeSpan >> Remarks This event is raised when the Time changes. Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize"
},
"api/Terminal.Gui/Terminal.Gui.Toplevel.html": {
"href": "api/Terminal.Gui/Terminal.Gui.Toplevel.html",
"title": "Class Toplevel",
- "keywords": "Class Toplevel Toplevel views can be modally executed. Inheritance System.Object Responder View Toplevel Window Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View[]) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.PositionCursor() View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.KeyUp View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.Text View.TextAlignment View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.MouseEvent(MouseEvent) Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class Toplevel : View, IDisposable, ISupportInitializeNotification, ISupportInitialize Remarks 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). 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. Dialog s. To run a Toplevel, create the Toplevel and call Run(Toplevel) . Toplevels can also opt-in to more sophisticated initialization by implementing System.ComponentModel.ISupportInitialize . When they do so, the System.ComponentModel.ISupportInitialize.BeginInit() and System.ComponentModel.ISupportInitialize.EndInit() methods will be called before running the view. If first-run-only initialization is preferred, the System.ComponentModel.ISupportInitializeNotification can be implemented too, in which case the System.ComponentModel.ISupportInitialize methods will only be called if System.ComponentModel.ISupportInitializeNotification.IsInitialized is false . This allows proper View inheritance hierarchies to override base class layout code optimally by doing so only on first run, instead of on every run. Constructors Toplevel() Initializes a new instance of the Toplevel class with Computed layout, defaulting to full screen. Declaration public Toplevel() Toplevel(Rect) Initializes a new instance of the Toplevel class with the specified absolute layout. Declaration public Toplevel(Rect frame) Parameters Type Name Description Rect frame A superview-relative rectangle specifying the location and size for the new Toplevel Properties CanFocus Gets or sets a value indicating whether this Toplevel can focus. Declaration public override bool CanFocus { get; } Property Value Type Description System.Boolean true if can focus; otherwise, false . Overrides View.CanFocus MenuBar Gets or sets the menu for this Toplevel Declaration public MenuBar MenuBar { get; set; } Property Value Type Description MenuBar Modal Determines whether the Toplevel is modal or not. Causes ProcessKey(KeyEvent) to propagate keys upwards by default unless set to true . Declaration public bool Modal { get; set; } Property Value Type Description System.Boolean Running Gets or sets whether the MainLoop for this Toplevel is running or not. Declaration public bool Running { get; set; } Property Value Type Description System.Boolean Remarks Setting this property directly is discouraged. Use RequestStop() instead. StatusBar Gets or sets the status bar for this Toplevel Declaration public StatusBar StatusBar { get; set; } Property Value Type Description StatusBar Methods Add(View) Adds a subview (child) to this view. Declaration public override void Add(View view) Parameters Type Name Description View view Overrides View.Add(View) Remarks The Views that have been added to this view can be retrieved via the Subviews property. See also Remove(View) RemoveAll() Create() Convenience factory method that creates a new Toplevel with the current terminal dimensions. Declaration public static Toplevel Create() Returns Type Description Toplevel The create. OnKeyDown(KeyEvent) Declaration public override bool OnKeyDown(KeyEvent keyEvent) Parameters Type Name Description KeyEvent keyEvent Contains the details about the key that produced the event. Returns Type Description System.Boolean Overrides View.OnKeyDown(KeyEvent) OnKeyUp(KeyEvent) Declaration public override bool OnKeyUp(KeyEvent keyEvent) Parameters Type Name Description KeyEvent keyEvent Contains the details about the key that produced the event. Returns Type Description System.Boolean Overrides View.OnKeyUp(KeyEvent) ProcessKey(KeyEvent) If the view is focused, gives the view a chance to process the keystroke. Declaration public override bool ProcessKey(KeyEvent keyEvent) Parameters Type Name Description KeyEvent keyEvent Contains the details about the key that produced the event. Returns Type Description System.Boolean Overrides View.ProcessKey(KeyEvent) Remarks 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. Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds The bounds (view-relative region) to redraw. Overrides View.Redraw(Rect) Remarks 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. Remove(View) Removes a subview added via Add(View) or Add(View[]) from this View. Declaration public override void Remove(View view) Parameters Type Name Description View view Overrides View.Remove(View) Remarks RemoveAll() Removes all subviews (children) added via Add(View) or Add(View[]) from this View. Declaration public override void RemoveAll() Overrides View.RemoveAll() WillPresent() Invoked by Begin(Toplevel) as part of the Run(Toplevel) after the views have been laid out, and before the views are drawn for the first time. Declaration public virtual void WillPresent() Events Ready Fired once the Toplevel's MainLoop has started it's first iteration. Subscribe to this event to perform tasks when the Toplevel has been laid out and focus has been set. changes. A Ready event handler is a good place to finalize initialization after calling ` Run() (topLevel)`. Declaration public event Action Ready Event Type Type Description System.Action Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize"
+ "keywords": "Class Toplevel Toplevel views can be modally executed. Inheritance System.Object Responder View Toplevel Window Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Shortcut View.ShortcutTag View.ShortcutAction View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View[]) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.PositionCursor() View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessHotKey(KeyEvent) View.KeyDown View.KeyUp View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.Text View.AutoSize View.TextAlignment View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.MouseEvent(MouseEvent) Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class Toplevel : View, IDisposable, ISupportInitializeNotification, ISupportInitialize Remarks 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). 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. Dialog s. To run a Toplevel, create the Toplevel and call Run(Toplevel) . Toplevels can also opt-in to more sophisticated initialization by implementing System.ComponentModel.ISupportInitialize . When they do so, the System.ComponentModel.ISupportInitialize.BeginInit() and System.ComponentModel.ISupportInitialize.EndInit() methods will be called before running the view. If first-run-only initialization is preferred, the System.ComponentModel.ISupportInitializeNotification can be implemented too, in which case the System.ComponentModel.ISupportInitialize methods will only be called if System.ComponentModel.ISupportInitializeNotification.IsInitialized is false . This allows proper View inheritance hierarchies to override base class layout code optimally by doing so only on first run, instead of on every run. Constructors Toplevel() Initializes a new instance of the Toplevel class with Computed layout, defaulting to full screen. Declaration public Toplevel() Toplevel(Rect) Initializes a new instance of the Toplevel class with the specified absolute layout. Declaration public Toplevel(Rect frame) Parameters Type Name Description Rect frame A superview-relative rectangle specifying the location and size for the new Toplevel Properties CanFocus Gets or sets a value indicating whether this Toplevel can focus. Declaration public override bool CanFocus { get; } Property Value Type Description System.Boolean true if can focus; otherwise, false . Overrides View.CanFocus MenuBar Gets or sets the menu for this Toplevel Declaration public MenuBar MenuBar { get; set; } Property Value Type Description MenuBar Modal Determines whether the Toplevel is modal or not. Causes ProcessKey(KeyEvent) to propagate keys upwards by default unless set to true . Declaration public bool Modal { get; set; } Property Value Type Description System.Boolean Running Gets or sets whether the MainLoop for this Toplevel is running or not. Declaration public bool Running { get; set; } Property Value Type Description System.Boolean Remarks Setting this property directly is discouraged. Use RequestStop() instead. StatusBar Gets or sets the status bar for this Toplevel Declaration public StatusBar StatusBar { get; set; } Property Value Type Description StatusBar Methods Add(View) Adds a subview (child) to this view. Declaration public override void Add(View view) Parameters Type Name Description View view Overrides View.Add(View) Remarks The Views that have been added to this view can be retrieved via the Subviews property. See also Remove(View) RemoveAll() Create() Convenience factory method that creates a new Toplevel with the current terminal dimensions. Declaration public static Toplevel Create() Returns Type Description Toplevel The create. OnKeyDown(KeyEvent) Declaration public override bool OnKeyDown(KeyEvent keyEvent) Parameters Type Name Description KeyEvent keyEvent Contains the details about the key that produced the event. Returns Type Description System.Boolean Overrides View.OnKeyDown(KeyEvent) OnKeyUp(KeyEvent) Declaration public override bool OnKeyUp(KeyEvent keyEvent) Parameters Type Name Description KeyEvent keyEvent Contains the details about the key that produced the event. Returns Type Description System.Boolean Overrides View.OnKeyUp(KeyEvent) ProcessColdKey(KeyEvent) This method can be overwritten by views that want to provide accelerator functionality (Alt-key for example), but without interefering with normal ProcessKey behavior. Declaration public override bool ProcessColdKey(KeyEvent keyEvent) Parameters Type Name Description KeyEvent keyEvent Contains the details about the key that produced the event. Returns Type Description System.Boolean Overrides View.ProcessColdKey(KeyEvent) Remarks 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. ProcessKey(KeyEvent) If the view is focused, gives the view a chance to process the keystroke. Declaration public override bool ProcessKey(KeyEvent keyEvent) Parameters Type Name Description KeyEvent keyEvent Contains the details about the key that produced the event. Returns Type Description System.Boolean Overrides View.ProcessKey(KeyEvent) Remarks 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. Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds The bounds (view-relative region) to redraw. Overrides View.Redraw(Rect) Remarks 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. Remove(View) Removes a subview added via Add(View) or Add(View[]) from this View. Declaration public override void Remove(View view) Parameters Type Name Description View view Overrides View.Remove(View) Remarks RemoveAll() Removes all subviews (children) added via Add(View) or Add(View[]) from this View. Declaration public override void RemoveAll() Overrides View.RemoveAll() WillPresent() Invoked by Begin(Toplevel) as part of the Run(Toplevel) after the views have been laid out, and before the views are drawn for the first time. Declaration public virtual void WillPresent() Events Loaded Fired once the Toplevel's Application.RunState has begin loaded. A Loaded event handler is a good place to finalize initialization before calling ` RunLoop(Application.RunState, Boolean) . Declaration public event Action Loaded Event Type Type Description System.Action Ready Fired once the Toplevel's MainLoop has started it's first iteration. Subscribe to this event to perform tasks when the Toplevel has been laid out and focus has been set. changes. A Ready event handler is a good place to finalize initialization after calling ` Run() (topLevel)`. Declaration public event Action Ready Event Type Type Description System.Action Unloaded Fired once the Toplevel's Application.RunState has begin unloaded. A Unloaded event handler is a good place to disposing after calling ` End(Application.RunState) . Declaration public event Action Unloaded Event Type Type Description System.Action Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize"
},
"api/Terminal.Gui/Terminal.Gui.View.FocusEventArgs.html": {
"href": "api/Terminal.Gui/Terminal.Gui.View.FocusEventArgs.html",
@@ -322,7 +332,7 @@
"api/Terminal.Gui/Terminal.Gui.View.html": {
"href": "api/Terminal.Gui/Terminal.Gui.View.html",
"title": "Class View",
- "keywords": "Class View View is the base class for all views on the screen and represents a visible element that can render itself and contains zero or more nested views. Inheritance System.Object Responder View Button CheckBox ComboBox FrameView HexView Label ListView MenuBar ProgressBar RadioGroup ScrollBarView ScrollView StatusBar TextField TextView Toplevel Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members Responder.MouseEvent(MouseEvent) Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class View : Responder, IDisposable, ISupportInitializeNotification, ISupportInitialize Remarks The View defines the base functionality for user interface elements in Terminal.Gui. Views can contain one or more subviews, can respond to user input and render themselves on the screen. Views supports two layout styles: Absolute or Computed. The choice as to which layout style is used by the View is determined when the View is initizlied. To create a View using Absolute layout, call a constructor that takes a Rect parameter to specify the absolute position and size (the View. Frame )/. To create a View using Computed layout use a constructor that does not take a Rect parametr and set the X, Y, Width and Height properties on the view. Both approaches use coordinates that are relative to the container they are being added to. To switch between Absolute and Computed layout, use the LayoutStyle property. Computed layout is more flexible and supports dynamic console apps where controls adjust layout as the terminal resizes or other Views change size or position. The X, Y, Width and Height properties are Dim and Pos objects that dynamically update the position of a view. The X and Y properties are of type Pos and you can use either absolute positions, percentages or anchor points. The Width and Height properties are of type Dim and can use absolute position, percentages and anchors. These are useful as they will take care of repositioning views when view's frames are resized or if the terminal size changes. Absolute layout requires specifying coordinates and sizes of Views explicitly, and the View will typcialy stay in a fixed position and size. To change the position and size use the Frame property. Subviews (child views) can be added to a View by calling the Add(View) method. The container of a View can be accessed with the SuperView property. To flag a region of the View's Bounds to be redrawn call SetNeedsDisplay(Rect) . To flag the entire view for redraw call SetNeedsDisplay() . Views have a ColorScheme property that defines the default colors that subviews should use for rendering. This ensures that the views fit in the context where they are being used, and allows for themes to be plugged in. For example, the default colors for windows and toplevels uses a blue background, while it uses a white background for dialog boxes and a red background for errors. Subclasses should not rely on ColorScheme being set at construction time. If a ColorScheme is not set on a view, the view will inherit the value from its SuperView and the value might only be valid once a view has been added to a SuperView. By using ColorScheme applications will work both in color as well as black and white displays. Views that are focusable should implement the PositionCursor() to make sure that the cursor is placed in a location that makes sense. Unix terminals do not have a way of hiding the cursor, so it can be distracting to have the cursor left at the last focused view. So views should make sure that they place the cursor in a visually sensible place. The LayoutSubviews() method is invoked when the size or layout of a view has changed. The default processing system will keep the size and dimensions for views that use the Absolute , and will recompute the frames for the vies that use Computed . Constructors View() Initializes a new instance of View using Computed layout. Declaration public View() Remarks Use X , Y , Width , and Height properties to dynamically control the size and location of the view. The Label will be created using Computed coordinates. 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. This constructor intitalize a View with a LayoutStyle of Computed . Use X , Y , Width , and Height properties to dynamically control the size and location of the view. View(ustring) Initializes a new instance of View using Computed layout. Declaration public View(ustring text) Parameters Type Name Description NStack.ustring text text to initialize the Text property with. Remarks 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. View(Int32, Int32, ustring) Initializes a new instance of View using Absolute layout. Declaration public View(int x, int y, ustring text) Parameters Type Name Description System.Int32 x column to locate the Label. System.Int32 y row to locate the Label. NStack.ustring text text to initialize the Text property with. Remarks 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. View(Rect) Initializes a new instance of a Absolute View class with the absolute dimensions specified in the frame parameter. Declaration public View(Rect frame) Parameters Type Name Description Rect frame The region covered by this view. Remarks This constructor intitalize a View with a LayoutStyle of Absolute . Use View() to initialize a View with LayoutStyle of Computed View(Rect, ustring) Initializes a new instance of View using Absolute layout. Declaration public View(Rect rect, ustring text) Parameters Type Name Description Rect rect Location. NStack.ustring text text to initialize the Text property with. Remarks 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. Properties Bounds The bounds represent the View-relative rectangle used for this view; the area inside of the view. Declaration public Rect Bounds { get; set; } Property Value Type Description Rect The bounds. Remarks Updates to the Bounds update the Frame , and has the same side effects as updating the Frame . Because Bounds coordinates are relative to the upper-left corner of the View , the coordinates of the upper-left corner of the rectangle returned by this property are (0,0). Use this property to obtain the size and coordinates of the client area of the control for tasks such as drawing on the surface of the control. CanFocus Gets or sets a value indicating whether this Responder can focus. Declaration public override bool CanFocus { get; set; } Property Value Type Description System.Boolean true if can focus; otherwise, false . Overrides Responder.CanFocus ColorScheme The color scheme for this view, if it is not defined, it returns the SuperView 's color scheme. Declaration public ColorScheme ColorScheme { get; set; } Property Value Type Description ColorScheme Data Gets or sets arbitrary data for the view. Declaration public object Data { get; set; } Property Value Type Description System.Object Remarks This property is not used internally. Driver Points to the current driver in use by the view, it is a convenience property for simplifying the development of new views. Declaration public static ConsoleDriver Driver { get; } Property Value Type Description ConsoleDriver Focused Returns the currently focused view inside this view, or null if nothing is focused. Declaration public View Focused { get; } Property Value Type Description View The focused. Frame Gets or sets the frame for the view. The frame is relative to the view's container ( SuperView ). Declaration public virtual Rect Frame { get; set; } Property Value Type Description Rect The frame. Remarks 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 . HasFocus Gets or sets a value indicating whether this Responder has focus. Declaration public override bool HasFocus { get; } Property Value Type Description System.Boolean true if has focus; otherwise, false . Overrides Responder.HasFocus Height Gets or sets the height of the view. Only used whe LayoutStyle is Computed . Declaration public Dim Height { get; set; } Property Value Type Description Dim The height. HotKey Gets or sets the HotKey defined for this view. A user pressing HotKey on the keyboard while this view has focus will cause the Clicked event to fire. Declaration public Key HotKey { get; set; } Property Value Type Description Key HotKeySpecifier Gets or sets the specifier character for the hotkey (e.g. '_'). Set to '\\xffff' to disable hotkey support for this View instance. The default is '\\xffff'. Declaration public Rune HotKeySpecifier { get; set; } Property Value Type Description System.Rune Id Gets or sets an identifier for the view; Declaration public ustring Id { get; set; } Property Value Type Description NStack.ustring The identifier. Remarks The id should be unique across all Views that share a SuperView. IsCurrentTop Returns a value indicating if this View is currently on Top (Active) Declaration public bool IsCurrentTop { get; } Property Value Type Description System.Boolean IsInitialized Get or sets if the View was already initialized. This derived from System.ComponentModel.ISupportInitializeNotification to allow notify all the views that are being initialized. Declaration public bool IsInitialized { get; set; } Property Value Type Description System.Boolean LayoutStyle Controls how the View's Frame is computed during the LayoutSubviews method, if the style is set to Absolute , LayoutSubviews does not change the Frame . If the style is Computed the Frame is updated using the X , Y , Width , and Height properties. Declaration public LayoutStyle LayoutStyle { get; set; } Property Value Type Description LayoutStyle The layout style. MostFocused Returns the most focused view in the chain of subviews (the leaf view that has the focus). Declaration public View MostFocused { get; } Property Value Type Description View The most focused. Subviews This returns a list of the subviews contained by this view. Declaration public IList Subviews { get; } Property Value Type Description System.Collections.Generic.IList < View > The subviews. SuperView Returns the container for this view, or null if this view has not been added to a container. Declaration public View SuperView { get; } Property Value Type Description View The super view. TabIndex Indicates the index of the current View from the TabIndexes list. Declaration public int TabIndex { get; set; } Property Value Type Description System.Int32 TabIndexes This returns a tab index list of the subviews contained by this view. Declaration public IList TabIndexes { get; } Property Value Type Description System.Collections.Generic.IList < View > The tabIndexes. TabStop This only be true if the CanFocus is also true and the focus can be avoided by setting this to false Declaration public bool TabStop { get; set; } Property Value Type Description System.Boolean Text The text displayed by the View . Declaration public virtual ustring Text { get; set; } Property Value Type Description NStack.ustring Remarks If provided, the text will be drawn before any subviews are drawn. The text will be drawn starting at the view origin (0, 0) and will be formatted according to the TextAlignment property. If the view's height is greater than 1, the text will word-wrap to additional lines if it does not fit horizontally. If the view's height is 1, the text will be clipped. Set the HotKeySpecifier to enable hotkey support. To disable hotkey support set HotKeySpecifier to (Rune)0xffff . TextAlignment Gets or sets how the View's Text is aligned horizontally when drawn. Changing this property will redisplay the View . Declaration public virtual TextAlignment TextAlignment { get; set; } Property Value Type Description TextAlignment The text alignment. Visible Gets or sets the view visibility. Declaration public bool Visible { get; set; } Property Value Type Description System.Boolean WantContinuousButtonPressed Gets or sets a value indicating whether this View want continuous button pressed event. Declaration public virtual bool WantContinuousButtonPressed { get; set; } Property Value Type Description System.Boolean WantMousePositionReports Gets or sets a value indicating whether this View wants mouse position reports. Declaration public virtual bool WantMousePositionReports { get; set; } Property Value Type Description System.Boolean true if want mouse position reports; otherwise, false . Width Gets or sets the width of the view. Only used whe LayoutStyle is Computed . Declaration public Dim Width { get; set; } Property Value Type Description Dim The width. Remarks If LayoutStyle is Absolute changing this property has no effect and its value is indeterminate. X Gets or sets the X position for the view (the column). Only used whe LayoutStyle is Computed . Declaration public Pos X { get; set; } Property Value Type Description Pos The X Position. Remarks If LayoutStyle is Absolute changing this property has no effect and its value is indeterminate. Y Gets or sets the Y position for the view (the row). Only used whe LayoutStyle is Computed . Declaration public Pos Y { get; set; } Property Value Type Description Pos The y position (line). Remarks If LayoutStyle is Absolute changing this property has no effect and its value is indeterminate. Methods Add(View) Adds a subview (child) to this view. Declaration public virtual void Add(View view) Parameters Type Name Description View view Remarks The Views that have been added to this view can be retrieved via the Subviews property. See also Remove(View) RemoveAll() Add(View[]) Adds the specified views (children) to the view. Declaration public void Add(params View[] views) Parameters Type Name Description View [] views Array of one or more views (can be optional parameter). Remarks The Views that have been added to this view can be retrieved via the Subviews property. See also Remove(View) RemoveAll() AddRune(Int32, Int32, Rune) Displays the specified character in the specified column and row of the View. Declaration public void AddRune(int col, int row, Rune ch) Parameters Type Name Description System.Int32 col Column (view-relative). System.Int32 row Row (view-relative). System.Rune ch Ch. BeginInit() This derived from System.ComponentModel.ISupportInitializeNotification to allow notify all the views that are beginning initialized. Declaration public void BeginInit() BringSubviewForward(View) Moves the subview backwards in the hierarchy, only one step Declaration public void BringSubviewForward(View subview) Parameters Type Name Description View subview The subview to send backwards Remarks If you want to send the view all the way to the back use SendSubviewToBack. BringSubviewToFront(View) Brings the specified subview to the front so it is drawn on top of any other views. Declaration public void BringSubviewToFront(View subview) Parameters Type Name Description View subview The subview to send to the front Remarks SendSubviewToBack(View) . ChildNeedsDisplay() Indicates that any child views (in the Subviews list) need to be repainted. Declaration public void ChildNeedsDisplay() Clear() Clears the view region with the current color. Declaration public void Clear() Remarks This clears the entire region used by this view. Clear(Rect) Clears the specified region with the current color. Declaration public void Clear(Rect regionScreen) Parameters Type Name Description Rect regionScreen The screen-relative region to clear. Remarks ClearNeedsDisplay() Removes the SetNeedsDisplay() and the ChildNeedsDisplay() setting on this view. Declaration protected void ClearNeedsDisplay() ClipToBounds() Sets the ConsoleDriver 's clip region to the current View's Bounds . Declaration public Rect ClipToBounds() Returns Type Description Rect The existing driver's clip region, which can be then re-eapplied by setting Driver .Clip ( Clip ). Remarks Bounds is View-relative. Dispose(Boolean) Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. Declaration protected override void Dispose(bool disposing) Parameters Type Name Description System.Boolean disposing Overrides Responder.Dispose(Boolean) Remarks If disposing equals true, the method has been called directly or indirectly by a user's code. Managed and unmanaged resources can be disposed. If disposing equals false, the method has been called by the runtime from inside the finalizer and you should not reference other objects. Only unmanaged resources can be disposed. DrawFrame(Rect, Int32, Boolean) Draws a frame in the current view, clipped by the boundary of this view Declaration public void DrawFrame(Rect region, int padding = 0, bool fill = false) Parameters Type Name Description Rect region View-relative region for the frame to be drawn. System.Int32 padding The padding to add around the outside of the drawn frame. System.Boolean fill If set to true it fill will the contents. DrawHotString(ustring, Boolean, ColorScheme) Utility function to draw strings that contains a hotkey using a ColorScheme and the \"focused\" state. Declaration public void DrawHotString(ustring text, bool focused, ColorScheme scheme) Parameters Type Name Description NStack.ustring text String to display, the underscoore before a letter flags the next letter as the hotkey. System.Boolean focused If set to true this uses the focused colors from the color scheme, otherwise the regular ones. ColorScheme scheme The color scheme to use. DrawHotString(ustring, Attribute, Attribute) Utility function to draw strings that contain a hotkey. Declaration public void DrawHotString(ustring text, Attribute hotColor, Attribute normalColor) Parameters Type Name Description NStack.ustring text String to display, the hotkey specifier before a letter flags the next letter as the hotkey. Attribute hotColor Hot color. Attribute normalColor Normal color. Remarks The hotkey is any character following the hotkey specifier, which is the underscore ('_') character by default. The hotkey specifier can be changed via HotKeySpecifier EndInit() This derived from System.ComponentModel.ISupportInitializeNotification to allow notify all the views that are ending initialized. Declaration public void EndInit() EnsureFocus() Finds the first view in the hierarchy that wants to get the focus if nothing is currently focused, otherwise, it does nothing. Declaration public void EnsureFocus() FocusFirst() Focuses the first focusable subview if one exists. Declaration public void FocusFirst() FocusLast() Focuses the last focusable subview if one exists. Declaration public void FocusLast() FocusNext() Focuses the next view. Declaration public bool FocusNext() Returns Type Description System.Boolean true , if next was focused, false otherwise. FocusPrev() Focuses the previous view. Declaration public bool FocusPrev() Returns Type Description System.Boolean true , if previous was focused, false otherwise. LayoutSubviews() Invoked when a view starts executing or when the dimensions of the view have changed, for example in response to the container view or terminal resizing. Declaration public virtual void LayoutSubviews() Remarks Calls Terminal.Gui.View.OnLayoutComplete(Terminal.Gui.View.LayoutEventArgs) (which raises the LayoutComplete event) before it returns. Move(Int32, Int32) This moves the cursor to the specified column and row in the view. Declaration public void Move(int col, int row) Parameters Type Name Description System.Int32 col Col. System.Int32 row Row. OnAdded(View) Method invoked when a subview is being added to this view. Declaration public virtual void OnAdded(View view) Parameters Type Name Description View view The subview being added. OnDrawContent(Rect) Enables overrides to draw infinitely scrolled content and/or a background behind added controls. Declaration public virtual void OnDrawContent(Rect viewport) Parameters Type Name Description Rect viewport The view-relative rectangle describing the currently visible viewport into the View Remarks This method will be called before any subviews added with Add(View) have been drawn. OnEnter(View) Method invoked when a view gets focus. Declaration public override bool OnEnter(View view) Parameters Type Name Description View view The view that is losing focus. Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides Responder.OnEnter(View) OnKeyDown(KeyEvent) Declaration public override bool OnKeyDown(KeyEvent keyEvent) Parameters Type Name Description KeyEvent keyEvent Contains the details about the key that produced the event. Returns Type Description System.Boolean Overrides Responder.OnKeyDown(KeyEvent) OnKeyUp(KeyEvent) Declaration public override bool OnKeyUp(KeyEvent keyEvent) Parameters Type Name Description KeyEvent keyEvent Contains the details about the key that produced the event. Returns Type Description System.Boolean Overrides Responder.OnKeyUp(KeyEvent) OnLeave(View) Method invoked when a view loses focus. Declaration public override bool OnLeave(View view) Parameters Type Name Description View view The view that is getting focus. Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides Responder.OnLeave(View) OnMouseClick(View.MouseEventArgs) Invokes the MouseClick event. Declaration protected void OnMouseClick(View.MouseEventArgs args) Parameters Type Name Description View.MouseEventArgs args OnMouseEnter(MouseEvent) Method invoked when a mouse event is generated for the first time. Declaration public override bool OnMouseEnter(MouseEvent mouseEvent) Parameters Type Name Description MouseEvent mouseEvent Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides Responder.OnMouseEnter(MouseEvent) OnMouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public virtual bool OnMouseEvent(MouseEvent mouseEvent) Parameters Type Name Description MouseEvent mouseEvent Returns Type Description System.Boolean true , if the event was handled, false otherwise. OnMouseLeave(MouseEvent) Method invoked when a mouse event is generated for the last time. Declaration public override bool OnMouseLeave(MouseEvent mouseEvent) Parameters Type Name Description MouseEvent mouseEvent Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides Responder.OnMouseLeave(MouseEvent) OnRemoved(View) Method invoked when a subview is being removed from this view. Declaration public virtual void OnRemoved(View view) Parameters Type Name Description View view The subview being removed. PositionCursor() Positions the cursor in the right position based on the currently focused view in the chain. Declaration public virtual void PositionCursor() ProcessColdKey(KeyEvent) This method can be overwritten by views that want to provide accelerator functionality (Alt-key for example), but without interefering with normal ProcessKey behavior. Declaration public override bool ProcessColdKey(KeyEvent keyEvent) Parameters Type Name Description KeyEvent keyEvent Contains the details about the key that produced the event. Returns Type Description System.Boolean Overrides Responder.ProcessColdKey(KeyEvent) Remarks 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. ProcessHotKey(KeyEvent) This method can be overwritten by view that want to provide accelerator functionality (Alt-key for example). Declaration public override bool ProcessHotKey(KeyEvent keyEvent) Parameters Type Name Description KeyEvent keyEvent Returns Type Description System.Boolean Overrides Responder.ProcessHotKey(KeyEvent) Remarks 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. ProcessKey(KeyEvent) If the view is focused, gives the view a chance to process the keystroke. Declaration public override bool ProcessKey(KeyEvent keyEvent) Parameters Type Name Description KeyEvent keyEvent Contains the details about the key that produced the event. Returns Type Description System.Boolean Overrides Responder.ProcessKey(KeyEvent) Remarks 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. Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public virtual void Redraw(Rect bounds) Parameters Type Name Description Rect bounds The bounds (view-relative region) to redraw. Remarks 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. Remove(View) Removes a subview added via Add(View) or Add(View[]) from this View. Declaration public virtual void Remove(View view) Parameters Type Name Description View view Remarks RemoveAll() Removes all subviews (children) added via Add(View) or Add(View[]) from this View. Declaration public virtual void RemoveAll() ScreenToView(Int32, Int32) Converts a point from screen-relative coordinates to view-relative coordinates. Declaration public Point ScreenToView(int x, int y) Parameters Type Name Description System.Int32 x X screen-coordinate point. System.Int32 y Y screen-coordinate point. Returns Type Description Point The mapped point. SendSubviewBackwards(View) Moves the subview backwards in the hierarchy, only one step Declaration public void SendSubviewBackwards(View subview) Parameters Type Name Description View subview The subview to send backwards Remarks If you want to send the view all the way to the back use SendSubviewToBack. SendSubviewToBack(View) Sends the specified subview to the front so it is the first view drawn Declaration public void SendSubviewToBack(View subview) Parameters Type Name Description View subview The subview to send to the front Remarks BringSubviewToFront(View) . SetClip(Rect) Sets the clip region to the specified view-relative region. Declaration public Rect SetClip(Rect region) Parameters Type Name Description Rect region View-relative clip region. Returns Type Description Rect The previous screen-relative clip region. SetFocus() Causes the specified view and the entire parent hierarchy to have the focused order updated. Declaration public void SetFocus() SetNeedsDisplay() Sets a flag indicating this view needs to be redisplayed because its state has changed. Declaration public void SetNeedsDisplay() SetNeedsDisplay(Rect) Flags the view-relative region on this View as needing to be repainted. Declaration public void SetNeedsDisplay(Rect region) Parameters Type Name Description Rect region The view-relative region that must be flagged for repaint. ToString() Pretty prints the View Declaration public override string ToString() Returns Type Description System.String Overrides System.Object.ToString() Events Added Event fired when a subview is being added to this view. Declaration public event Action Added Event Type Type Description System.Action < View > DrawContent Event invoked when the content area of the View is to be drawn. Declaration public event Action DrawContent Event Type Type Description System.Action < Rect > Remarks Will be invoked before any subviews added with Add(View) have been drawn. Rect provides the view-relative rectangle describing the currently visible viewport into the View . Enter Event fired when the view gets focus. Declaration public event Action Enter Event Type Type Description System.Action < View.FocusEventArgs > Initialized Event called only once when the View is being initialized for the first time. Allows configurations and assignments to be performed before the View being shown. This derived from System.ComponentModel.ISupportInitializeNotification to allow notify all the views that are being initialized. Declaration public event EventHandler Initialized Event Type Type Description System.EventHandler KeyDown Invoked when a key is pressed Declaration public event Action KeyDown Event Type Type Description System.Action < View.KeyEventEventArgs > KeyPress Invoked when a character key is pressed and occurs after the key up event. Declaration public event Action KeyPress Event Type Type Description System.Action < View.KeyEventEventArgs > KeyUp Invoked when a key is released Declaration public event Action KeyUp Event Type Type Description System.Action < View.KeyEventEventArgs > LayoutComplete Fired after the Views's LayoutSubviews() method has completed. Declaration public event Action LayoutComplete Event Type Type Description System.Action < View.LayoutEventArgs > Remarks Subscribe to this event to perform tasks when the View has been resized or the layout has otherwise changed. LayoutStarted Fired after the Views's LayoutSubviews() method has completed. Declaration public event Action LayoutStarted Event Type Type Description System.Action < View.LayoutEventArgs > Remarks Subscribe to this event to perform tasks when the View has been resized or the layout has otherwise changed. Leave Event fired when the view looses focus. Declaration public event Action Leave Event Type Type Description System.Action < View.FocusEventArgs > MouseClick Event fired when a mouse event is generated. Declaration public event Action MouseClick Event Type Type Description System.Action < View.MouseEventArgs > MouseEnter Event fired when the view receives the mouse event for the first time. Declaration public event Action MouseEnter Event Type Type Description System.Action < View.MouseEventArgs > MouseLeave Event fired when the view receives a mouse event for the last time. Declaration public event Action MouseLeave Event Type Type Description System.Action < View.MouseEventArgs > Removed Event fired when a subview is being removed from this view. Declaration public event Action Removed Event Type Type Description System.Action < View > Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize"
+ "keywords": "Class View View is the base class for all views on the screen and represents a visible element that can render itself and contains zero or more nested views. Inheritance System.Object Responder View Button CheckBox ComboBox FrameView HexView Label ListView MenuBar ProgressBar RadioGroup ScrollBarView ScrollView StatusBar TextField TextView Toplevel Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members Responder.MouseEvent(MouseEvent) Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class View : Responder, IDisposable, ISupportInitializeNotification, ISupportInitialize Remarks The View defines the base functionality for user interface elements in Terminal.Gui. Views can contain one or more subviews, can respond to user input and render themselves on the screen. Views supports two layout styles: Absolute or Computed. The choice as to which layout style is used by the View is determined when the View is initizlied. To create a View using Absolute layout, call a constructor that takes a Rect parameter to specify the absolute position and size (the View. Frame )/. To create a View using Computed layout use a constructor that does not take a Rect parametr and set the X, Y, Width and Height properties on the view. Both approaches use coordinates that are relative to the container they are being added to. To switch between Absolute and Computed layout, use the LayoutStyle property. Computed layout is more flexible and supports dynamic console apps where controls adjust layout as the terminal resizes or other Views change size or position. The X, Y, Width and Height properties are Dim and Pos objects that dynamically update the position of a view. The X and Y properties are of type Pos and you can use either absolute positions, percentages or anchor points. The Width and Height properties are of type Dim and can use absolute position, percentages and anchors. These are useful as they will take care of repositioning views when view's frames are resized or if the terminal size changes. Absolute layout requires specifying coordinates and sizes of Views explicitly, and the View will typcialy stay in a fixed position and size. To change the position and size use the Frame property. Subviews (child views) can be added to a View by calling the Add(View) method. The container of a View can be accessed with the SuperView property. To flag a region of the View's Bounds to be redrawn call SetNeedsDisplay(Rect) . To flag the entire view for redraw call SetNeedsDisplay() . Views have a ColorScheme property that defines the default colors that subviews should use for rendering. This ensures that the views fit in the context where they are being used, and allows for themes to be plugged in. For example, the default colors for windows and toplevels uses a blue background, while it uses a white background for dialog boxes and a red background for errors. Subclasses should not rely on ColorScheme being set at construction time. If a ColorScheme is not set on a view, the view will inherit the value from its SuperView and the value might only be valid once a view has been added to a SuperView. By using ColorScheme applications will work both in color as well as black and white displays. Views that are focusable should implement the PositionCursor() to make sure that the cursor is placed in a location that makes sense. Unix terminals do not have a way of hiding the cursor, so it can be distracting to have the cursor left at the last focused view. So views should make sure that they place the cursor in a visually sensible place. The LayoutSubviews() method is invoked when the size or layout of a view has changed. The default processing system will keep the size and dimensions for views that use the Absolute , and will recompute the frames for the vies that use Computed . Constructors View() Initializes a new instance of View using Computed layout. Declaration public View() Remarks Use X , Y , Width , and Height properties to dynamically control the size and location of the view. The Label will be created using Computed coordinates. 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. This constructor intitalize a View with a LayoutStyle of Computed . Use X , Y , Width , and Height properties to dynamically control the size and location of the view. View(ustring) Initializes a new instance of View using Computed layout. Declaration public View(ustring text) Parameters Type Name Description NStack.ustring text text to initialize the Text property with. Remarks 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. View(Int32, Int32, ustring) Initializes a new instance of View using Absolute layout. Declaration public View(int x, int y, ustring text) Parameters Type Name Description System.Int32 x column to locate the Label. System.Int32 y row to locate the Label. NStack.ustring text text to initialize the Text property with. Remarks 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. View(Rect) Initializes a new instance of a Absolute View class with the absolute dimensions specified in the frame parameter. Declaration public View(Rect frame) Parameters Type Name Description Rect frame The region covered by this view. Remarks This constructor intitalize a View with a LayoutStyle of Absolute . Use View() to initialize a View with LayoutStyle of Computed View(Rect, ustring) Initializes a new instance of View using Absolute layout. Declaration public View(Rect rect, ustring text) Parameters Type Name Description Rect rect Location. NStack.ustring text text to initialize the Text property with. Remarks 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. Properties AutoSize Used by Text to resize the view's Bounds with the Size . Setting AutoSize to true only work if the Width and Height are null or Absolute values and doesn't work with Computed layout, to avoid breaking the Pos and Dim settings. Declaration public virtual bool AutoSize { get; set; } Property Value Type Description System.Boolean Bounds The bounds represent the View-relative rectangle used for this view; the area inside of the view. Declaration public Rect Bounds { get; set; } Property Value Type Description Rect The bounds. Remarks Updates to the Bounds update the Frame , and has the same side effects as updating the Frame . Because Bounds coordinates are relative to the upper-left corner of the View , the coordinates of the upper-left corner of the rectangle returned by this property are (0,0). Use this property to obtain the size and coordinates of the client area of the control for tasks such as drawing on the surface of the control. CanFocus Gets or sets a value indicating whether this Responder can focus. Declaration public override bool CanFocus { get; set; } Property Value Type Description System.Boolean true if can focus; otherwise, false . Overrides Responder.CanFocus ColorScheme The color scheme for this view, if it is not defined, it returns the SuperView 's color scheme. Declaration public ColorScheme ColorScheme { get; set; } Property Value Type Description ColorScheme Data Gets or sets arbitrary data for the view. Declaration public object Data { get; set; } Property Value Type Description System.Object Remarks This property is not used internally. Driver Points to the current driver in use by the view, it is a convenience property for simplifying the development of new views. Declaration public static ConsoleDriver Driver { get; } Property Value Type Description ConsoleDriver Focused Returns the currently focused view inside this view, or null if nothing is focused. Declaration public View Focused { get; } Property Value Type Description View The focused. Frame Gets or sets the frame for the view. The frame is relative to the view's container ( SuperView ). Declaration public virtual Rect Frame { get; set; } Property Value Type Description Rect The frame. Remarks 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 . HasFocus Gets or sets a value indicating whether this Responder has focus. Declaration public override bool HasFocus { get; } Property Value Type Description System.Boolean true if has focus; otherwise, false . Overrides Responder.HasFocus Height Gets or sets the height of the view. Only used whe LayoutStyle is Computed . Declaration public Dim Height { get; set; } Property Value Type Description Dim The height. HotKey Gets or sets the HotKey defined for this view. A user pressing HotKey on the keyboard while this view has focus will cause the Clicked event to fire. Declaration public Key HotKey { get; set; } Property Value Type Description Key HotKeySpecifier Gets or sets the specifier character for the hotkey (e.g. '_'). Set to '\\xffff' to disable hotkey support for this View instance. The default is '\\xffff'. Declaration public Rune HotKeySpecifier { get; set; } Property Value Type Description System.Rune Id Gets or sets an identifier for the view; Declaration public ustring Id { get; set; } Property Value Type Description NStack.ustring The identifier. Remarks The id should be unique across all Views that share a SuperView. IsCurrentTop Returns a value indicating if this View is currently on Top (Active) Declaration public bool IsCurrentTop { get; } Property Value Type Description System.Boolean IsInitialized Get or sets if the View was already initialized. This derived from System.ComponentModel.ISupportInitializeNotification to allow notify all the views that are being initialized. Declaration public bool IsInitialized { get; set; } Property Value Type Description System.Boolean LayoutStyle Controls how the View's Frame is computed during the LayoutSubviews method, if the style is set to Absolute , LayoutSubviews does not change the Frame . If the style is Computed the Frame is updated using the X , Y , Width , and Height properties. Declaration public LayoutStyle LayoutStyle { get; set; } Property Value Type Description LayoutStyle The layout style. MostFocused Returns the most focused view in the chain of subviews (the leaf view that has the focus). Declaration public View MostFocused { get; } Property Value Type Description View The most focused. Shortcut This is the global setting that can be used as a global shortcut to invoke an action if provided. Declaration public Key Shortcut { get; set; } Property Value Type Description Key ShortcutAction The action to run if the Shortcut is defined. Declaration public virtual Action ShortcutAction { get; set; } Property Value Type Description System.Action ShortcutTag The keystroke combination used in the Shortcut as string. Declaration public ustring ShortcutTag { get; } Property Value Type Description NStack.ustring Subviews This returns a list of the subviews contained by this view. Declaration public IList Subviews { get; } Property Value Type Description System.Collections.Generic.IList < View > The subviews. SuperView Returns the container for this view, or null if this view has not been added to a container. Declaration public View SuperView { get; } Property Value Type Description View The super view. TabIndex Indicates the index of the current View from the TabIndexes list. Declaration public int TabIndex { get; set; } Property Value Type Description System.Int32 TabIndexes This returns a tab index list of the subviews contained by this view. Declaration public IList TabIndexes { get; } Property Value Type Description System.Collections.Generic.IList < View > The tabIndexes. TabStop This only be true if the CanFocus is also true and the focus can be avoided by setting this to false Declaration public bool TabStop { get; set; } Property Value Type Description System.Boolean Text The text displayed by the View . Declaration public virtual ustring Text { get; set; } Property Value Type Description NStack.ustring Remarks If provided, the text will be drawn before any subviews are drawn. The text will be drawn starting at the view origin (0, 0) and will be formatted according to the TextAlignment property. If the view's height is greater than 1, the text will word-wrap to additional lines if it does not fit horizontally. If the view's height is 1, the text will be clipped. Set the HotKeySpecifier to enable hotkey support. To disable hotkey support set HotKeySpecifier to (Rune)0xffff . TextAlignment Gets or sets how the View's Text is aligned horizontally when drawn. Changing this property will redisplay the View . Declaration public virtual TextAlignment TextAlignment { get; set; } Property Value Type Description TextAlignment The text alignment. Visible Gets or sets the view visibility. Declaration public bool Visible { get; set; } Property Value Type Description System.Boolean WantContinuousButtonPressed Gets or sets a value indicating whether this View want continuous button pressed event. Declaration public virtual bool WantContinuousButtonPressed { get; set; } Property Value Type Description System.Boolean WantMousePositionReports Gets or sets a value indicating whether this View wants mouse position reports. Declaration public virtual bool WantMousePositionReports { get; set; } Property Value Type Description System.Boolean true if want mouse position reports; otherwise, false . Width Gets or sets the width of the view. Only used whe LayoutStyle is Computed . Declaration public Dim Width { get; set; } Property Value Type Description Dim The width. Remarks If LayoutStyle is Absolute changing this property has no effect and its value is indeterminate. X Gets or sets the X position for the view (the column). Only used whe LayoutStyle is Computed . Declaration public Pos X { get; set; } Property Value Type Description Pos The X Position. Remarks If LayoutStyle is Absolute changing this property has no effect and its value is indeterminate. Y Gets or sets the Y position for the view (the row). Only used whe LayoutStyle is Computed . Declaration public Pos Y { get; set; } Property Value Type Description Pos The y position (line). Remarks If LayoutStyle is Absolute changing this property has no effect and its value is indeterminate. Methods Add(View) Adds a subview (child) to this view. Declaration public virtual void Add(View view) Parameters Type Name Description View view Remarks The Views that have been added to this view can be retrieved via the Subviews property. See also Remove(View) RemoveAll() Add(View[]) Adds the specified views (children) to the view. Declaration public void Add(params View[] views) Parameters Type Name Description View [] views Array of one or more views (can be optional parameter). Remarks The Views that have been added to this view can be retrieved via the Subviews property. See also Remove(View) RemoveAll() AddRune(Int32, Int32, Rune) Displays the specified character in the specified column and row of the View. Declaration public void AddRune(int col, int row, Rune ch) Parameters Type Name Description System.Int32 col Column (view-relative). System.Int32 row Row (view-relative). System.Rune ch Ch. BeginInit() This derived from System.ComponentModel.ISupportInitializeNotification to allow notify all the views that are beginning initialized. Declaration public void BeginInit() BringSubviewForward(View) Moves the subview backwards in the hierarchy, only one step Declaration public void BringSubviewForward(View subview) Parameters Type Name Description View subview The subview to send backwards Remarks If you want to send the view all the way to the back use SendSubviewToBack. BringSubviewToFront(View) Brings the specified subview to the front so it is drawn on top of any other views. Declaration public void BringSubviewToFront(View subview) Parameters Type Name Description View subview The subview to send to the front Remarks SendSubviewToBack(View) . ChildNeedsDisplay() Indicates that any child views (in the Subviews list) need to be repainted. Declaration public void ChildNeedsDisplay() Clear() Clears the view region with the current color. Declaration public void Clear() Remarks This clears the entire region used by this view. Clear(Rect) Clears the specified region with the current color. Declaration public void Clear(Rect regionScreen) Parameters Type Name Description Rect regionScreen The screen-relative region to clear. Remarks ClearNeedsDisplay() Removes the SetNeedsDisplay() and the ChildNeedsDisplay() setting on this view. Declaration protected void ClearNeedsDisplay() ClipToBounds() Sets the ConsoleDriver 's clip region to the current View's Bounds . Declaration public Rect ClipToBounds() Returns Type Description Rect The existing driver's clip region, which can be then re-eapplied by setting Driver .Clip ( Clip ). Remarks Bounds is View-relative. Dispose(Boolean) Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. Declaration protected override void Dispose(bool disposing) Parameters Type Name Description System.Boolean disposing Overrides Responder.Dispose(Boolean) Remarks If disposing equals true, the method has been called directly or indirectly by a user's code. Managed and unmanaged resources can be disposed. If disposing equals false, the method has been called by the runtime from inside the finalizer and you should not reference other objects. Only unmanaged resources can be disposed. DrawFrame(Rect, Int32, Boolean) Draws a frame in the current view, clipped by the boundary of this view Declaration public void DrawFrame(Rect region, int padding = 0, bool fill = false) Parameters Type Name Description Rect region View-relative region for the frame to be drawn. System.Int32 padding The padding to add around the outside of the drawn frame. System.Boolean fill If set to true it fill will the contents. DrawHotString(ustring, Boolean, ColorScheme) Utility function to draw strings that contains a hotkey using a ColorScheme and the \"focused\" state. Declaration public void DrawHotString(ustring text, bool focused, ColorScheme scheme) Parameters Type Name Description NStack.ustring text String to display, the underscoore before a letter flags the next letter as the hotkey. System.Boolean focused If set to true this uses the focused colors from the color scheme, otherwise the regular ones. ColorScheme scheme The color scheme to use. DrawHotString(ustring, Attribute, Attribute) Utility function to draw strings that contain a hotkey. Declaration public void DrawHotString(ustring text, Attribute hotColor, Attribute normalColor) Parameters Type Name Description NStack.ustring text String to display, the hotkey specifier before a letter flags the next letter as the hotkey. Attribute hotColor Hot color. Attribute normalColor Normal color. Remarks The hotkey is any character following the hotkey specifier, which is the underscore ('_') character by default. The hotkey specifier can be changed via HotKeySpecifier EndInit() This derived from System.ComponentModel.ISupportInitializeNotification to allow notify all the views that are ending initialized. Declaration public void EndInit() EnsureFocus() Finds the first view in the hierarchy that wants to get the focus if nothing is currently focused, otherwise, it does nothing. Declaration public void EnsureFocus() FocusFirst() Focuses the first focusable subview if one exists. Declaration public void FocusFirst() FocusLast() Focuses the last focusable subview if one exists. Declaration public void FocusLast() FocusNext() Focuses the next view. Declaration public bool FocusNext() Returns Type Description System.Boolean true , if next was focused, false otherwise. FocusPrev() Focuses the previous view. Declaration public bool FocusPrev() Returns Type Description System.Boolean true , if previous was focused, false otherwise. LayoutSubviews() Invoked when a view starts executing or when the dimensions of the view have changed, for example in response to the container view or terminal resizing. Declaration public virtual void LayoutSubviews() Remarks Calls Terminal.Gui.View.OnLayoutComplete(Terminal.Gui.View.LayoutEventArgs) (which raises the LayoutComplete event) before it returns. Move(Int32, Int32) This moves the cursor to the specified column and row in the view. Declaration public void Move(int col, int row) Parameters Type Name Description System.Int32 col Col. System.Int32 row Row. OnAdded(View) Method invoked when a subview is being added to this view. Declaration public virtual void OnAdded(View view) Parameters Type Name Description View view The subview being added. OnDrawContent(Rect) Enables overrides to draw infinitely scrolled content and/or a background behind added controls. Declaration public virtual void OnDrawContent(Rect viewport) Parameters Type Name Description Rect viewport The view-relative rectangle describing the currently visible viewport into the View Remarks This method will be called before any subviews added with Add(View) have been drawn. OnEnter(View) Method invoked when a view gets focus. Declaration public override bool OnEnter(View view) Parameters Type Name Description View view The view that is losing focus. Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides Responder.OnEnter(View) OnKeyDown(KeyEvent) Declaration public override bool OnKeyDown(KeyEvent keyEvent) Parameters Type Name Description KeyEvent keyEvent Contains the details about the key that produced the event. Returns Type Description System.Boolean Overrides Responder.OnKeyDown(KeyEvent) OnKeyUp(KeyEvent) Declaration public override bool OnKeyUp(KeyEvent keyEvent) Parameters Type Name Description KeyEvent keyEvent Contains the details about the key that produced the event. Returns Type Description System.Boolean Overrides Responder.OnKeyUp(KeyEvent) OnLeave(View) Method invoked when a view loses focus. Declaration public override bool OnLeave(View view) Parameters Type Name Description View view The view that is getting focus. Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides Responder.OnLeave(View) OnMouseClick(View.MouseEventArgs) Invokes the MouseClick event. Declaration protected void OnMouseClick(View.MouseEventArgs args) Parameters Type Name Description View.MouseEventArgs args OnMouseEnter(MouseEvent) Method invoked when a mouse event is generated for the first time. Declaration public override bool OnMouseEnter(MouseEvent mouseEvent) Parameters Type Name Description MouseEvent mouseEvent Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides Responder.OnMouseEnter(MouseEvent) OnMouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public virtual bool OnMouseEvent(MouseEvent mouseEvent) Parameters Type Name Description MouseEvent mouseEvent Returns Type Description System.Boolean true , if the event was handled, false otherwise. OnMouseLeave(MouseEvent) Method invoked when a mouse event is generated for the last time. Declaration public override bool OnMouseLeave(MouseEvent mouseEvent) Parameters Type Name Description MouseEvent mouseEvent Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides Responder.OnMouseLeave(MouseEvent) OnRemoved(View) Method invoked when a subview is being removed from this view. Declaration public virtual void OnRemoved(View view) Parameters Type Name Description View view The subview being removed. PositionCursor() Positions the cursor in the right position based on the currently focused view in the chain. Declaration public virtual void PositionCursor() ProcessColdKey(KeyEvent) This method can be overwritten by views that want to provide accelerator functionality (Alt-key for example), but without interefering with normal ProcessKey behavior. Declaration public override bool ProcessColdKey(KeyEvent keyEvent) Parameters Type Name Description KeyEvent keyEvent Contains the details about the key that produced the event. Returns Type Description System.Boolean Overrides Responder.ProcessColdKey(KeyEvent) Remarks 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. ProcessHotKey(KeyEvent) This method can be overwritten by view that want to provide accelerator functionality (Alt-key for example). Declaration public override bool ProcessHotKey(KeyEvent keyEvent) Parameters Type Name Description KeyEvent keyEvent Returns Type Description System.Boolean Overrides Responder.ProcessHotKey(KeyEvent) Remarks 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. ProcessKey(KeyEvent) If the view is focused, gives the view a chance to process the keystroke. Declaration public override bool ProcessKey(KeyEvent keyEvent) Parameters Type Name Description KeyEvent keyEvent Contains the details about the key that produced the event. Returns Type Description System.Boolean Overrides Responder.ProcessKey(KeyEvent) Remarks 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. Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public virtual void Redraw(Rect bounds) Parameters Type Name Description Rect bounds The bounds (view-relative region) to redraw. Remarks 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. Remove(View) Removes a subview added via Add(View) or Add(View[]) from this View. Declaration public virtual void Remove(View view) Parameters Type Name Description View view Remarks RemoveAll() Removes all subviews (children) added via Add(View) or Add(View[]) from this View. Declaration public virtual void RemoveAll() ScreenToView(Int32, Int32) Converts a point from screen-relative coordinates to view-relative coordinates. Declaration public Point ScreenToView(int x, int y) Parameters Type Name Description System.Int32 x X screen-coordinate point. System.Int32 y Y screen-coordinate point. Returns Type Description Point The mapped point. SendSubviewBackwards(View) Moves the subview backwards in the hierarchy, only one step Declaration public void SendSubviewBackwards(View subview) Parameters Type Name Description View subview The subview to send backwards Remarks If you want to send the view all the way to the back use SendSubviewToBack. SendSubviewToBack(View) Sends the specified subview to the front so it is the first view drawn Declaration public void SendSubviewToBack(View subview) Parameters Type Name Description View subview The subview to send to the front Remarks BringSubviewToFront(View) . SetClip(Rect) Sets the clip region to the specified view-relative region. Declaration public Rect SetClip(Rect region) Parameters Type Name Description Rect region View-relative clip region. Returns Type Description Rect The previous screen-relative clip region. SetFocus() Causes the specified view and the entire parent hierarchy to have the focused order updated. Declaration public void SetFocus() SetNeedsDisplay() Sets a flag indicating this view needs to be redisplayed because its state has changed. Declaration public void SetNeedsDisplay() SetNeedsDisplay(Rect) Flags the view-relative region on this View as needing to be repainted. Declaration public void SetNeedsDisplay(Rect region) Parameters Type Name Description Rect region The view-relative region that must be flagged for repaint. ToString() Pretty prints the View Declaration public override string ToString() Returns Type Description System.String Overrides System.Object.ToString() Events Added Event fired when a subview is being added to this view. Declaration public event Action Added Event Type Type Description System.Action < View > DrawContent Event invoked when the content area of the View is to be drawn. Declaration public event Action DrawContent Event Type Type Description System.Action < Rect > Remarks Will be invoked before any subviews added with Add(View) have been drawn. Rect provides the view-relative rectangle describing the currently visible viewport into the View . Enter Event fired when the view gets focus. Declaration public event Action Enter Event Type Type Description System.Action < View.FocusEventArgs > Initialized Event called only once when the View is being initialized for the first time. Allows configurations and assignments to be performed before the View being shown. This derived from System.ComponentModel.ISupportInitializeNotification to allow notify all the views that are being initialized. Declaration public event EventHandler Initialized Event Type Type Description System.EventHandler KeyDown Invoked when a key is pressed Declaration public event Action KeyDown Event Type Type Description System.Action < View.KeyEventEventArgs > KeyPress Invoked when a character key is pressed and occurs after the key up event. Declaration public event Action KeyPress Event Type Type Description System.Action < View.KeyEventEventArgs > KeyUp Invoked when a key is released Declaration public event Action KeyUp Event Type Type Description System.Action < View.KeyEventEventArgs > LayoutComplete Fired after the Views's LayoutSubviews() method has completed. Declaration public event Action LayoutComplete Event Type Type Description System.Action < View.LayoutEventArgs > Remarks Subscribe to this event to perform tasks when the View has been resized or the layout has otherwise changed. LayoutStarted Fired after the Views's LayoutSubviews() method has completed. Declaration public event Action LayoutStarted Event Type Type Description System.Action < View.LayoutEventArgs > Remarks Subscribe to this event to perform tasks when the View has been resized or the layout has otherwise changed. Leave Event fired when the view looses focus. Declaration public event Action Leave Event Type Type Description System.Action < View.FocusEventArgs > MouseClick Event fired when a mouse event is generated. Declaration public event Action MouseClick Event Type Type Description System.Action < View.MouseEventArgs > MouseEnter Event fired when the view receives the mouse event for the first time. Declaration public event Action MouseEnter Event Type Type Description System.Action < View.MouseEventArgs > MouseLeave Event fired when the view receives a mouse event for the last time. Declaration public event Action MouseLeave Event Type Type Description System.Action < View.MouseEventArgs > Removed Event fired when a subview is being removed from this view. Declaration public event Action Removed Event Type Type Description System.Action < View > Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize"
},
"api/Terminal.Gui/Terminal.Gui.View.KeyEventEventArgs.html": {
"href": "api/Terminal.Gui/Terminal.Gui.View.KeyEventEventArgs.html",
@@ -342,7 +352,7 @@
"api/Terminal.Gui/Terminal.Gui.Window.html": {
"href": "api/Terminal.Gui/Terminal.Gui.Window.html",
"title": "Class Window",
- "keywords": "Class Window A Toplevel View that draws a border around its Frame with a Title at the top. Inheritance System.Object Responder View Toplevel Window Dialog Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members Toplevel.Running Toplevel.Ready Toplevel.Create() Toplevel.CanFocus Toplevel.Modal Toplevel.MenuBar Toplevel.StatusBar Toplevel.OnKeyDown(KeyEvent) Toplevel.OnKeyUp(KeyEvent) Toplevel.ProcessKey(KeyEvent) Toplevel.WillPresent() View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View[]) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.PositionCursor() View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.KeyUp View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class Window : Toplevel, IDisposable, ISupportInitializeNotification, ISupportInitialize Remarks The 'client area' of a Window is a rectangle deflated by one or more rows/columns from Bounds . A this time there is no API to determine this rectangle. Constructors Window() Initializes a new instance of the Window class using Computed positioning. Declaration public Window() Window(ustring) Initializes a new instance of the Window class with an optional title using Computed positioning. Declaration public Window(ustring title = null) Parameters Type Name Description NStack.ustring title Title. Remarks This constructor intitalize a View with a LayoutStyle of Computed . Use X , Y , Width , and Height properties to dynamically control the size and location of the view. Window(ustring, Int32) Initializes a new instance of the Window using Absolute positioning with the specified frame for its location, with the specified frame padding, and an optional title. Declaration public Window(ustring title = null, int padding = 0) Parameters Type Name Description NStack.ustring title Title. System.Int32 padding Number of characters to use for padding of the drawn frame. Remarks This constructor intitalize a View with a LayoutStyle of Computed . Use X , Y , Width , and Height properties to dynamically control the size and location of the view. Window(Rect, ustring) Initializes a new instance of the Window class with an optional title using Absolute positioning. Declaration public Window(Rect frame, ustring title = null) Parameters Type Name Description Rect frame Superview-relative rectangle specifying the location and size NStack.ustring title Title Remarks This constructor intitalizes a Window with a LayoutStyle of Absolute . Use constructors that do not take Rect parameters to initialize a Window with Computed . Window(Rect, ustring, Int32) Initializes a new instance of the Window using Absolute positioning with the specified frame for its location, with the specified frame padding, and an optional title. Declaration public Window(Rect frame, ustring title = null, int padding = 0) Parameters Type Name Description Rect frame Superview-relative rectangle specifying the location and size NStack.ustring title Title System.Int32 padding Number of characters to use for padding of the drawn frame. Remarks This constructor intitalizes a Window with a LayoutStyle of Absolute . Use constructors that do not take Rect parameters to initialize a Window with LayoutStyle of Computed Properties Text The text displayed by the Label . Declaration public override ustring Text { get; set; } Property Value Type Description NStack.ustring Overrides View.Text TextAlignment Controls the text-alignment property of the label, changing it will redisplay the Label . Declaration public override TextAlignment TextAlignment { get; set; } Property Value Type Description TextAlignment The text alignment. Overrides View.TextAlignment Title The title to be displayed for this window. Declaration public ustring Title { get; set; } Property Value Type Description NStack.ustring The title Methods Add(View) Adds a subview (child) to this view. Declaration public override void Add(View view) Parameters Type Name Description View view Overrides Toplevel.Add(View) Remarks The Views that have been added to this view can be retrieved via the Subviews property. See also Remove(View) RemoveAll() MouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public override bool MouseEvent(MouseEvent mouseEvent) Parameters Type Name Description MouseEvent mouseEvent Contains the details about the mouse event. Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides Responder.MouseEvent(MouseEvent) Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds The bounds (view-relative region) to redraw. Overrides Toplevel.Redraw(Rect) Remarks 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. Remove(View) Removes a subview added via Add(View) or Add(View[]) from this View. Declaration public override void Remove(View view) Parameters Type Name Description View view Overrides Toplevel.Remove(View) Remarks RemoveAll() Removes all subviews (children) added via Add(View) or Add(View[]) from this View. Declaration public override void RemoveAll() Overrides Toplevel.RemoveAll() Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize"
+ "keywords": "Class Window A Toplevel View that draws a border around its Frame with a Title at the top. Inheritance System.Object Responder View Toplevel Window Dialog Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members Toplevel.Running Toplevel.Loaded Toplevel.Ready Toplevel.Unloaded Toplevel.Create() Toplevel.CanFocus Toplevel.Modal Toplevel.MenuBar Toplevel.StatusBar Toplevel.OnKeyDown(KeyEvent) Toplevel.OnKeyUp(KeyEvent) Toplevel.ProcessKey(KeyEvent) Toplevel.ProcessColdKey(KeyEvent) Toplevel.WillPresent() View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Shortcut View.ShortcutTag View.ShortcutAction View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View[]) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.PositionCursor() View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessHotKey(KeyEvent) View.KeyDown View.KeyUp View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.AutoSize View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class Window : Toplevel, IDisposable, ISupportInitializeNotification, ISupportInitialize Remarks The 'client area' of a Window is a rectangle deflated by one or more rows/columns from Bounds . A this time there is no API to determine this rectangle. Constructors Window() Initializes a new instance of the Window class using Computed positioning. Declaration public Window() Window(ustring) Initializes a new instance of the Window class with an optional title using Computed positioning. Declaration public Window(ustring title = null) Parameters Type Name Description NStack.ustring title Title. Remarks This constructor intitalize a View with a LayoutStyle of Computed . Use X , Y , Width , and Height properties to dynamically control the size and location of the view. Window(ustring, Int32) Initializes a new instance of the Window using Absolute positioning with the specified frame for its location, with the specified frame padding, and an optional title. Declaration public Window(ustring title = null, int padding = 0) Parameters Type Name Description NStack.ustring title Title. System.Int32 padding Number of characters to use for padding of the drawn frame. Remarks This constructor intitalize a View with a LayoutStyle of Computed . Use X , Y , Width , and Height properties to dynamically control the size and location of the view. Window(Rect, ustring) Initializes a new instance of the Window class with an optional title using Absolute positioning. Declaration public Window(Rect frame, ustring title = null) Parameters Type Name Description Rect frame Superview-relative rectangle specifying the location and size NStack.ustring title Title Remarks This constructor intitalizes a Window with a LayoutStyle of Absolute . Use constructors that do not take Rect parameters to initialize a Window with Computed . Window(Rect, ustring, Int32) Initializes a new instance of the Window using Absolute positioning with the specified frame for its location, with the specified frame padding, and an optional title. Declaration public Window(Rect frame, ustring title = null, int padding = 0) Parameters Type Name Description Rect frame Superview-relative rectangle specifying the location and size NStack.ustring title Title System.Int32 padding Number of characters to use for padding of the drawn frame. Remarks This constructor intitalizes a Window with a LayoutStyle of Absolute . Use constructors that do not take Rect parameters to initialize a Window with LayoutStyle of Computed Properties Text The text displayed by the Label . Declaration public override ustring Text { get; set; } Property Value Type Description NStack.ustring Overrides View.Text TextAlignment Controls the text-alignment property of the label, changing it will redisplay the Label . Declaration public override TextAlignment TextAlignment { get; set; } Property Value Type Description TextAlignment The text alignment. Overrides View.TextAlignment Title The title to be displayed for this window. Declaration public ustring Title { get; set; } Property Value Type Description NStack.ustring The title Methods Add(View) Adds a subview (child) to this view. Declaration public override void Add(View view) Parameters Type Name Description View view Overrides Toplevel.Add(View) Remarks The Views that have been added to this view can be retrieved via the Subviews property. See also Remove(View) RemoveAll() MouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public override bool MouseEvent(MouseEvent mouseEvent) Parameters Type Name Description MouseEvent mouseEvent Contains the details about the mouse event. Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides Responder.MouseEvent(MouseEvent) Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds The bounds (view-relative region) to redraw. Overrides Toplevel.Redraw(Rect) Remarks 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. Remove(View) Removes a subview added via Add(View) or Add(View[]) from this View. Declaration public override void Remove(View view) Parameters Type Name Description View view Overrides Toplevel.Remove(View) Remarks RemoveAll() Removes all subviews (children) added via Add(View) or Add(View[]) from this View. Declaration public override void RemoveAll() Overrides Toplevel.RemoveAll() Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize"
},
"api/Terminal.Gui/Unix.Terminal.Curses.Event.html": {
"href": "api/Terminal.Gui/Unix.Terminal.Curses.Event.html",
@@ -352,7 +362,7 @@
"api/Terminal.Gui/Unix.Terminal.Curses.html": {
"href": "api/Terminal.Gui/Unix.Terminal.Curses.html",
"title": "Class Curses",
- "keywords": "Class Curses Inheritance System.Object Curses Inherited Members System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) System.Object.ToString() Namespace : Unix.Terminal Assembly : Terminal.Gui.dll Syntax public class Curses Fields A_BLINK Declaration public const int A_BLINK = 524288 Field Value Type Description System.Int32 A_BOLD Declaration public const int A_BOLD = 2097152 Field Value Type Description System.Int32 A_DIM Declaration public const int A_DIM = 1048576 Field Value Type Description System.Int32 A_INVIS Declaration public const int A_INVIS = 8388608 Field Value Type Description System.Int32 A_NORMAL Declaration public const int A_NORMAL = 0 Field Value Type Description System.Int32 A_PROTECT Declaration public const int A_PROTECT = 16777216 Field Value Type Description System.Int32 A_REVERSE Declaration public const int A_REVERSE = 262144 Field Value Type Description System.Int32 A_STANDOUT Declaration public const int A_STANDOUT = 65536 Field Value Type Description System.Int32 A_UNDERLINE Declaration public const int A_UNDERLINE = 131072 Field Value Type Description System.Int32 ACS_BLOCK Declaration public const int ACS_BLOCK = 4194352 Field Value Type Description System.Int32 ACS_BOARD Declaration public const int ACS_BOARD = 4194408 Field Value Type Description System.Int32 ACS_BTEE Declaration public const int ACS_BTEE = 4194422 Field Value Type Description System.Int32 ACS_BULLET Declaration public const int ACS_BULLET = 4194430 Field Value Type Description System.Int32 ACS_CKBOARD Declaration public const int ACS_CKBOARD = 4194401 Field Value Type Description System.Int32 ACS_DARROW Declaration public const int ACS_DARROW = 4194350 Field Value Type Description System.Int32 ACS_DEGREE Declaration public const int ACS_DEGREE = 4194406 Field Value Type Description System.Int32 ACS_DIAMOND Declaration public const int ACS_DIAMOND = 4194400 Field Value Type Description System.Int32 ACS_HLINE Declaration public const int ACS_HLINE = 4194417 Field Value Type Description System.Int32 ACS_LANTERN Declaration public const int ACS_LANTERN = 4194409 Field Value Type Description System.Int32 ACS_LARROW Declaration public const int ACS_LARROW = 4194348 Field Value Type Description System.Int32 ACS_LLCORNER Declaration public const int ACS_LLCORNER = 4194413 Field Value Type Description System.Int32 ACS_LRCORNER Declaration public const int ACS_LRCORNER = 4194410 Field Value Type Description System.Int32 ACS_LTEE Declaration public const int ACS_LTEE = 4194420 Field Value Type Description System.Int32 ACS_PLMINUS Declaration public const int ACS_PLMINUS = 4194407 Field Value Type Description System.Int32 ACS_PLUS Declaration public const int ACS_PLUS = 4194414 Field Value Type Description System.Int32 ACS_RARROW Declaration public const int ACS_RARROW = 4194347 Field Value Type Description System.Int32 ACS_RTEE Declaration public const int ACS_RTEE = 4194421 Field Value Type Description System.Int32 ACS_S1 Declaration public const int ACS_S1 = 4194415 Field Value Type Description System.Int32 ACS_S9 Declaration public const int ACS_S9 = 4194419 Field Value Type Description System.Int32 ACS_TTEE Declaration public const int ACS_TTEE = 4194423 Field Value Type Description System.Int32 ACS_UARROW Declaration public const int ACS_UARROW = 4194349 Field Value Type Description System.Int32 ACS_ULCORNER Declaration public const int ACS_ULCORNER = 4194412 Field Value Type Description System.Int32 ACS_URCORNER Declaration public const int ACS_URCORNER = 4194411 Field Value Type Description System.Int32 ACS_VLINE Declaration public const int ACS_VLINE = 4194424 Field Value Type Description System.Int32 AltKeyDown Declaration public const int AltKeyDown = 523 Field Value Type Description System.Int32 AltKeyEnd Declaration public const int AltKeyEnd = 528 Field Value Type Description System.Int32 AltKeyHome Declaration public const int AltKeyHome = 533 Field Value Type Description System.Int32 AltKeyLeft Declaration public const int AltKeyLeft = 543 Field Value Type Description System.Int32 AltKeyNPage Declaration public const int AltKeyNPage = 548 Field Value Type Description System.Int32 AltKeyPPage Declaration public const int AltKeyPPage = 553 Field Value Type Description System.Int32 AltKeyRight Declaration public const int AltKeyRight = 558 Field Value Type Description System.Int32 AltKeyUp Declaration public const int AltKeyUp = 564 Field Value Type Description System.Int32 COLOR_BLACK Declaration public const int COLOR_BLACK = 0 Field Value Type Description System.Int32 COLOR_BLUE Declaration public const int COLOR_BLUE = 4 Field Value Type Description System.Int32 COLOR_CYAN Declaration public const int COLOR_CYAN = 6 Field Value Type Description System.Int32 COLOR_GREEN Declaration public const int COLOR_GREEN = 2 Field Value Type Description System.Int32 COLOR_MAGENTA Declaration public const int COLOR_MAGENTA = 5 Field Value Type Description System.Int32 COLOR_RED Declaration public const int COLOR_RED = 1 Field Value Type Description System.Int32 COLOR_WHITE Declaration public const int COLOR_WHITE = 7 Field Value Type Description System.Int32 COLOR_YELLOW Declaration public const int COLOR_YELLOW = 3 Field Value Type Description System.Int32 CtrlKeyDown Declaration public const int CtrlKeyDown = 525 Field Value Type Description System.Int32 CtrlKeyEnd Declaration public const int CtrlKeyEnd = 530 Field Value Type Description System.Int32 CtrlKeyHome Declaration public const int CtrlKeyHome = 535 Field Value Type Description System.Int32 CtrlKeyLeft Declaration public const int CtrlKeyLeft = 545 Field Value Type Description System.Int32 CtrlKeyNPage Declaration public const int CtrlKeyNPage = 550 Field Value Type Description System.Int32 CtrlKeyPPage Declaration public const int CtrlKeyPPage = 555 Field Value Type Description System.Int32 CtrlKeyRight Declaration public const int CtrlKeyRight = 560 Field Value Type Description System.Int32 CtrlKeyUp Declaration public const int CtrlKeyUp = 566 Field Value Type Description System.Int32 DownEnd Declaration public const int DownEnd = 0 Field Value Type Description System.Int32 ERR Declaration public const int ERR = -1 Field Value Type Description System.Int32 Home Declaration public const int Home = 0 Field Value Type Description System.Int32 KEY_CODE_YES Declaration public const int KEY_CODE_YES = 256 Field Value Type Description System.Int32 KeyAlt Declaration public const int KeyAlt = 8192 Field Value Type Description System.Int32 KeyBackspace Declaration public const int KeyBackspace = 263 Field Value Type Description System.Int32 KeyBackTab Declaration public const int KeyBackTab = 353 Field Value Type Description System.Int32 KeyDeleteChar Declaration public const int KeyDeleteChar = 330 Field Value Type Description System.Int32 KeyDown Declaration public const int KeyDown = 258 Field Value Type Description System.Int32 KeyEnd Declaration public const int KeyEnd = 360 Field Value Type Description System.Int32 KeyF1 Declaration public const int KeyF1 = 265 Field Value Type Description System.Int32 KeyF10 Declaration public const int KeyF10 = 274 Field Value Type Description System.Int32 KeyF11 Declaration public const int KeyF11 = 275 Field Value Type Description System.Int32 KeyF12 Declaration public const int KeyF12 = 276 Field Value Type Description System.Int32 KeyF2 Declaration public const int KeyF2 = 266 Field Value Type Description System.Int32 KeyF3 Declaration public const int KeyF3 = 267 Field Value Type Description System.Int32 KeyF4 Declaration public const int KeyF4 = 268 Field Value Type Description System.Int32 KeyF5 Declaration public const int KeyF5 = 269 Field Value Type Description System.Int32 KeyF6 Declaration public const int KeyF6 = 270 Field Value Type Description System.Int32 KeyF7 Declaration public const int KeyF7 = 271 Field Value Type Description System.Int32 KeyF8 Declaration public const int KeyF8 = 272 Field Value Type Description System.Int32 KeyF9 Declaration public const int KeyF9 = 273 Field Value Type Description System.Int32 KeyHome Declaration public const int KeyHome = 262 Field Value Type Description System.Int32 KeyInsertChar Declaration public const int KeyInsertChar = 331 Field Value Type Description System.Int32 KeyLeft Declaration public const int KeyLeft = 260 Field Value Type Description System.Int32 KeyMouse Declaration public const int KeyMouse = 409 Field Value Type Description System.Int32 KeyNPage Declaration public const int KeyNPage = 338 Field Value Type Description System.Int32 KeyPPage Declaration public const int KeyPPage = 339 Field Value Type Description System.Int32 KeyResize Declaration public const int KeyResize = 410 Field Value Type Description System.Int32 KeyRight Declaration public const int KeyRight = 261 Field Value Type Description System.Int32 KeyTab Declaration public const int KeyTab = 9 Field Value Type Description System.Int32 KeyUp Declaration public const int KeyUp = 259 Field Value Type Description System.Int32 LC_ALL Declaration public const int LC_ALL = 6 Field Value Type Description System.Int32 LeftRightUpNPagePPage Declaration public const int LeftRightUpNPagePPage = 0 Field Value Type Description System.Int32 ShiftCtrlKeyDown Declaration public const int ShiftCtrlKeyDown = 526 Field Value Type Description System.Int32 ShiftCtrlKeyEnd Declaration public const int ShiftCtrlKeyEnd = 531 Field Value Type Description System.Int32 ShiftCtrlKeyHome Declaration public const int ShiftCtrlKeyHome = 536 Field Value Type Description System.Int32 ShiftCtrlKeyLeft Declaration public const int ShiftCtrlKeyLeft = 546 Field Value Type Description System.Int32 ShiftCtrlKeyNPage Declaration public const int ShiftCtrlKeyNPage = 551 Field Value Type Description System.Int32 ShiftCtrlKeyPPage Declaration public const int ShiftCtrlKeyPPage = 556 Field Value Type Description System.Int32 ShiftCtrlKeyRight Declaration public const int ShiftCtrlKeyRight = 561 Field Value Type Description System.Int32 ShiftCtrlKeyUp Declaration public const int ShiftCtrlKeyUp = 567 Field Value Type Description System.Int32 ShiftKeyDown Declaration public const int ShiftKeyDown = 336 Field Value Type Description System.Int32 ShiftKeyEnd Declaration public const int ShiftKeyEnd = 386 Field Value Type Description System.Int32 ShiftKeyHome Declaration public const int ShiftKeyHome = 391 Field Value Type Description System.Int32 ShiftKeyLeft Declaration public const int ShiftKeyLeft = 393 Field Value Type Description System.Int32 ShiftKeyNPage Declaration public const int ShiftKeyNPage = 396 Field Value Type Description System.Int32 ShiftKeyPPage Declaration public const int ShiftKeyPPage = 398 Field Value Type Description System.Int32 ShiftKeyRight Declaration public const int ShiftKeyRight = 402 Field Value Type Description System.Int32 ShiftKeyUp Declaration public const int ShiftKeyUp = 337 Field Value Type Description System.Int32 Properties ColorPairs Declaration public static int ColorPairs { get; } Property Value Type Description System.Int32 Cols Declaration public static int Cols { get; } Property Value Type Description System.Int32 HasColors Declaration public static bool HasColors { get; } Property Value Type Description System.Boolean Lines Declaration public static int Lines { get; } Property Value Type Description System.Int32 Methods addch(Int32) Declaration public static int addch(int ch) Parameters Type Name Description System.Int32 ch Returns Type Description System.Int32 addstr(String, Object[]) Declaration public static int addstr(string format, params object[] args) Parameters Type Name Description System.String format System.Object [] args Returns Type Description System.Int32 addwstr(String) Declaration public static int addwstr(string s) Parameters Type Name Description System.String s Returns Type Description System.Int32 attroff(Int32) Declaration public static int attroff(int attrs) Parameters Type Name Description System.Int32 attrs Returns Type Description System.Int32 attron(Int32) Declaration public static int attron(int attrs) Parameters Type Name Description System.Int32 attrs Returns Type Description System.Int32 attrset(Int32) Declaration public static int attrset(int attrs) Parameters Type Name Description System.Int32 attrs Returns Type Description System.Int32 cbreak() Declaration public static int cbreak() Returns Type Description System.Int32 CheckWinChange() Declaration public static bool CheckWinChange() Returns Type Description System.Boolean clearok(IntPtr, Boolean) Declaration public static int clearok(IntPtr win, bool bf) Parameters Type Name Description System.IntPtr win System.Boolean bf Returns Type Description System.Int32 COLOR_PAIRS() Declaration public static int COLOR_PAIRS() Returns Type Description System.Int32 ColorPair(Int32) Declaration public static int ColorPair(int n) Parameters Type Name Description System.Int32 n Returns Type Description System.Int32 doupdate() Declaration public static int doupdate() Returns Type Description System.Int32 echo() Declaration public static int echo() Returns Type Description System.Int32 endwin() Declaration public static int endwin() Returns Type Description System.Int32 get_wch(out Int32) Declaration public static int get_wch(out int sequence) Parameters Type Name Description System.Int32 sequence Returns Type Description System.Int32 getch() Declaration public static int getch() Returns Type Description System.Int32 getmouse(out Curses.MouseEvent) Declaration public static uint getmouse(out Curses.MouseEvent ev) Parameters Type Name Description Curses.MouseEvent ev Returns Type Description System.UInt32 halfdelay(Int32) Declaration public static int halfdelay(int t) Parameters Type Name Description System.Int32 t Returns Type Description System.Int32 has_colors() Declaration public static bool has_colors() Returns Type Description System.Boolean idcok(IntPtr, Boolean) Declaration public static void idcok(IntPtr win, bool bf) Parameters Type Name Description System.IntPtr win System.Boolean bf idlok(IntPtr, Boolean) Declaration public static int idlok(IntPtr win, bool bf) Parameters Type Name Description System.IntPtr win System.Boolean bf Returns Type Description System.Int32 immedok(IntPtr, Boolean) Declaration public static void immedok(IntPtr win, bool bf) Parameters Type Name Description System.IntPtr win System.Boolean bf init_pair(Int16, Int16, Int16) Declaration public static int init_pair(short pair, short f, short b) Parameters Type Name Description System.Int16 pair System.Int16 f System.Int16 b Returns Type Description System.Int32 InitColorPair(Int16, Int16, Int16) Declaration public static int InitColorPair(short pair, short foreground, short background) Parameters Type Name Description System.Int16 pair System.Int16 foreground System.Int16 background Returns Type Description System.Int32 initscr() Declaration public static Curses.Window initscr() Returns Type Description Curses.Window intrflush(IntPtr, Boolean) Declaration public static int intrflush(IntPtr win, bool bf) Parameters Type Name Description System.IntPtr win System.Boolean bf Returns Type Description System.Int32 IsAlt(Int32) Declaration public static int IsAlt(int key) Parameters Type Name Description System.Int32 key Returns Type Description System.Int32 isendwin() Declaration public static bool isendwin() Returns Type Description System.Boolean keypad(IntPtr, Boolean) Declaration public static int keypad(IntPtr win, bool bf) Parameters Type Name Description System.IntPtr win System.Boolean bf Returns Type Description System.Int32 leaveok(IntPtr, Boolean) Declaration public static int leaveok(IntPtr win, bool bf) Parameters Type Name Description System.IntPtr win System.Boolean bf Returns Type Description System.Int32 meta(IntPtr, Boolean) Declaration public static int meta(IntPtr win, bool bf) Parameters Type Name Description System.IntPtr win System.Boolean bf Returns Type Description System.Int32 mouseinterval(Int32) Declaration public static int mouseinterval(int interval) Parameters Type Name Description System.Int32 interval Returns Type Description System.Int32 mousemask(Curses.Event, out Curses.Event) Declaration public static Curses.Event mousemask(Curses.Event newmask, out Curses.Event oldmask) Parameters Type Name Description Curses.Event newmask Curses.Event oldmask Returns Type Description Curses.Event move(Int32, Int32) Declaration public static int move(int line, int col) Parameters Type Name Description System.Int32 line System.Int32 col Returns Type Description System.Int32 mvgetch(Int32, Int32) Declaration public static int mvgetch(int y, int x) Parameters Type Name Description System.Int32 y System.Int32 x Returns Type Description System.Int32 nl() Declaration public static int nl() Returns Type Description System.Int32 nocbreak() Declaration public static int nocbreak() Returns Type Description System.Int32 noecho() Declaration public static int noecho() Returns Type Description System.Int32 nonl() Declaration public static int nonl() Returns Type Description System.Int32 noqiflush() Declaration public static void noqiflush() noraw() Declaration public static int noraw() Returns Type Description System.Int32 notimeout(IntPtr, Boolean) Declaration public static int notimeout(IntPtr win, bool bf) Parameters Type Name Description System.IntPtr win System.Boolean bf Returns Type Description System.Int32 qiflush() Declaration public static void qiflush() raw() Declaration public static int raw() Returns Type Description System.Int32 redrawwin(IntPtr) Declaration public static int redrawwin(IntPtr win) Parameters Type Name Description System.IntPtr win Returns Type Description System.Int32 refresh() Declaration public static int refresh() Returns Type Description System.Int32 scrollok(IntPtr, Boolean) Declaration public static int scrollok(IntPtr win, bool bf) Parameters Type Name Description System.IntPtr win System.Boolean bf Returns Type Description System.Int32 setlocale(Int32, String) Declaration public static int setlocale(int cate, string locale) Parameters Type Name Description System.Int32 cate System.String locale Returns Type Description System.Int32 setscrreg(Int32, Int32) Declaration public static int setscrreg(int top, int bot) Parameters Type Name Description System.Int32 top System.Int32 bot Returns Type Description System.Int32 start_color() Declaration public static int start_color() Returns Type Description System.Int32 StartColor() Declaration public static int StartColor() Returns Type Description System.Int32 timeout(Int32) Declaration public static int timeout(int delay) Parameters Type Name Description System.Int32 delay Returns Type Description System.Int32 typeahead(IntPtr) Declaration public static int typeahead(IntPtr fd) Parameters Type Name Description System.IntPtr fd Returns Type Description System.Int32 ungetch(Int32) Declaration public static int ungetch(int ch) Parameters Type Name Description System.Int32 ch Returns Type Description System.Int32 ungetmouse(ref Curses.MouseEvent) Declaration public static uint ungetmouse(ref Curses.MouseEvent ev) Parameters Type Name Description Curses.MouseEvent ev Returns Type Description System.UInt32 use_default_colors() Declaration public static int use_default_colors() Returns Type Description System.Int32 UseDefaultColors() Declaration public static int UseDefaultColors() Returns Type Description System.Int32 waddch(IntPtr, Int32) Declaration public static int waddch(IntPtr win, int ch) Parameters Type Name Description System.IntPtr win System.Int32 ch Returns Type Description System.Int32 wmove(IntPtr, Int32, Int32) Declaration public static int wmove(IntPtr win, int line, int col) Parameters Type Name Description System.IntPtr win System.Int32 line System.Int32 col Returns Type Description System.Int32 wnoutrefresh(IntPtr) Declaration public static int wnoutrefresh(IntPtr win) Parameters Type Name Description System.IntPtr win Returns Type Description System.Int32 wrefresh(IntPtr) Declaration public static int wrefresh(IntPtr win) Parameters Type Name Description System.IntPtr win Returns Type Description System.Int32 wsetscrreg(IntPtr, Int32, Int32) Declaration public static int wsetscrreg(IntPtr win, int top, int bot) Parameters Type Name Description System.IntPtr win System.Int32 top System.Int32 bot Returns Type Description System.Int32 wtimeout(IntPtr, Int32) Declaration public static int wtimeout(IntPtr win, int delay) Parameters Type Name Description System.IntPtr win System.Int32 delay Returns Type Description System.Int32"
+ "keywords": "Class Curses Inheritance System.Object Curses Inherited Members System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) System.Object.ToString() Namespace : Unix.Terminal Assembly : Terminal.Gui.dll Syntax public class Curses Fields A_BLINK Declaration public const int A_BLINK = 524288 Field Value Type Description System.Int32 A_BOLD Declaration public const int A_BOLD = 2097152 Field Value Type Description System.Int32 A_DIM Declaration public const int A_DIM = 1048576 Field Value Type Description System.Int32 A_INVIS Declaration public const int A_INVIS = 8388608 Field Value Type Description System.Int32 A_NORMAL Declaration public const int A_NORMAL = 0 Field Value Type Description System.Int32 A_PROTECT Declaration public const int A_PROTECT = 16777216 Field Value Type Description System.Int32 A_REVERSE Declaration public const int A_REVERSE = 262144 Field Value Type Description System.Int32 A_STANDOUT Declaration public const int A_STANDOUT = 65536 Field Value Type Description System.Int32 A_UNDERLINE Declaration public const int A_UNDERLINE = 131072 Field Value Type Description System.Int32 ACS_BLOCK Declaration public const int ACS_BLOCK = 4194352 Field Value Type Description System.Int32 ACS_BOARD Declaration public const int ACS_BOARD = 4194408 Field Value Type Description System.Int32 ACS_BTEE Declaration public const int ACS_BTEE = 4194422 Field Value Type Description System.Int32 ACS_BULLET Declaration public const int ACS_BULLET = 4194430 Field Value Type Description System.Int32 ACS_CKBOARD Declaration public const int ACS_CKBOARD = 4194401 Field Value Type Description System.Int32 ACS_DARROW Declaration public const int ACS_DARROW = 4194350 Field Value Type Description System.Int32 ACS_DEGREE Declaration public const int ACS_DEGREE = 4194406 Field Value Type Description System.Int32 ACS_DIAMOND Declaration public const int ACS_DIAMOND = 4194400 Field Value Type Description System.Int32 ACS_HLINE Declaration public const int ACS_HLINE = 4194417 Field Value Type Description System.Int32 ACS_LANTERN Declaration public const int ACS_LANTERN = 4194409 Field Value Type Description System.Int32 ACS_LARROW Declaration public const int ACS_LARROW = 4194348 Field Value Type Description System.Int32 ACS_LLCORNER Declaration public const int ACS_LLCORNER = 4194413 Field Value Type Description System.Int32 ACS_LRCORNER Declaration public const int ACS_LRCORNER = 4194410 Field Value Type Description System.Int32 ACS_LTEE Declaration public const int ACS_LTEE = 4194420 Field Value Type Description System.Int32 ACS_PLMINUS Declaration public const int ACS_PLMINUS = 4194407 Field Value Type Description System.Int32 ACS_PLUS Declaration public const int ACS_PLUS = 4194414 Field Value Type Description System.Int32 ACS_RARROW Declaration public const int ACS_RARROW = 4194347 Field Value Type Description System.Int32 ACS_RTEE Declaration public const int ACS_RTEE = 4194421 Field Value Type Description System.Int32 ACS_S1 Declaration public const int ACS_S1 = 4194415 Field Value Type Description System.Int32 ACS_S9 Declaration public const int ACS_S9 = 4194419 Field Value Type Description System.Int32 ACS_TTEE Declaration public const int ACS_TTEE = 4194423 Field Value Type Description System.Int32 ACS_UARROW Declaration public const int ACS_UARROW = 4194349 Field Value Type Description System.Int32 ACS_ULCORNER Declaration public const int ACS_ULCORNER = 4194412 Field Value Type Description System.Int32 ACS_URCORNER Declaration public const int ACS_URCORNER = 4194411 Field Value Type Description System.Int32 ACS_VLINE Declaration public const int ACS_VLINE = 4194424 Field Value Type Description System.Int32 AltCtrlKeyEnd Declaration public const int AltCtrlKeyEnd = 532 Field Value Type Description System.Int32 AltCtrlKeyHome Declaration public const int AltCtrlKeyHome = 537 Field Value Type Description System.Int32 AltCtrlKeyNPage Declaration public const int AltCtrlKeyNPage = 552 Field Value Type Description System.Int32 AltCtrlKeyPPage Declaration public const int AltCtrlKeyPPage = 557 Field Value Type Description System.Int32 AltKeyDown Declaration public const int AltKeyDown = 523 Field Value Type Description System.Int32 AltKeyEnd Declaration public const int AltKeyEnd = 528 Field Value Type Description System.Int32 AltKeyHome Declaration public const int AltKeyHome = 533 Field Value Type Description System.Int32 AltKeyLeft Declaration public const int AltKeyLeft = 543 Field Value Type Description System.Int32 AltKeyNPage Declaration public const int AltKeyNPage = 548 Field Value Type Description System.Int32 AltKeyPPage Declaration public const int AltKeyPPage = 553 Field Value Type Description System.Int32 AltKeyRight Declaration public const int AltKeyRight = 558 Field Value Type Description System.Int32 AltKeyUp Declaration public const int AltKeyUp = 564 Field Value Type Description System.Int32 COLOR_BLACK Declaration public const int COLOR_BLACK = 0 Field Value Type Description System.Int32 COLOR_BLUE Declaration public const int COLOR_BLUE = 4 Field Value Type Description System.Int32 COLOR_CYAN Declaration public const int COLOR_CYAN = 6 Field Value Type Description System.Int32 COLOR_GREEN Declaration public const int COLOR_GREEN = 2 Field Value Type Description System.Int32 COLOR_MAGENTA Declaration public const int COLOR_MAGENTA = 5 Field Value Type Description System.Int32 COLOR_RED Declaration public const int COLOR_RED = 1 Field Value Type Description System.Int32 COLOR_WHITE Declaration public const int COLOR_WHITE = 7 Field Value Type Description System.Int32 COLOR_YELLOW Declaration public const int COLOR_YELLOW = 3 Field Value Type Description System.Int32 CtrlKeyDown Declaration public const int CtrlKeyDown = 525 Field Value Type Description System.Int32 CtrlKeyEnd Declaration public const int CtrlKeyEnd = 530 Field Value Type Description System.Int32 CtrlKeyHome Declaration public const int CtrlKeyHome = 535 Field Value Type Description System.Int32 CtrlKeyLeft Declaration public const int CtrlKeyLeft = 545 Field Value Type Description System.Int32 CtrlKeyNPage Declaration public const int CtrlKeyNPage = 550 Field Value Type Description System.Int32 CtrlKeyPPage Declaration public const int CtrlKeyPPage = 555 Field Value Type Description System.Int32 CtrlKeyRight Declaration public const int CtrlKeyRight = 560 Field Value Type Description System.Int32 CtrlKeyUp Declaration public const int CtrlKeyUp = 566 Field Value Type Description System.Int32 DownEnd Declaration public const int DownEnd = 0 Field Value Type Description System.Int32 ERR Declaration public const int ERR = -1 Field Value Type Description System.Int32 Home Declaration public const int Home = 0 Field Value Type Description System.Int32 KEY_CODE_SEQ Declaration public const int KEY_CODE_SEQ = 91 Field Value Type Description System.Int32 KEY_CODE_YES Declaration public const int KEY_CODE_YES = 256 Field Value Type Description System.Int32 KeyAlt Declaration public const int KeyAlt = 8192 Field Value Type Description System.Int32 KeyBackspace Declaration public const int KeyBackspace = 263 Field Value Type Description System.Int32 KeyBackTab Declaration public const int KeyBackTab = 353 Field Value Type Description System.Int32 KeyDeleteChar Declaration public const int KeyDeleteChar = 330 Field Value Type Description System.Int32 KeyDown Declaration public const int KeyDown = 258 Field Value Type Description System.Int32 KeyEnd Declaration public const int KeyEnd = 360 Field Value Type Description System.Int32 KeyF1 Declaration public const int KeyF1 = 265 Field Value Type Description System.Int32 KeyF10 Declaration public const int KeyF10 = 274 Field Value Type Description System.Int32 KeyF11 Declaration public const int KeyF11 = 275 Field Value Type Description System.Int32 KeyF12 Declaration public const int KeyF12 = 276 Field Value Type Description System.Int32 KeyF2 Declaration public const int KeyF2 = 266 Field Value Type Description System.Int32 KeyF3 Declaration public const int KeyF3 = 267 Field Value Type Description System.Int32 KeyF4 Declaration public const int KeyF4 = 268 Field Value Type Description System.Int32 KeyF5 Declaration public const int KeyF5 = 269 Field Value Type Description System.Int32 KeyF6 Declaration public const int KeyF6 = 270 Field Value Type Description System.Int32 KeyF7 Declaration public const int KeyF7 = 271 Field Value Type Description System.Int32 KeyF8 Declaration public const int KeyF8 = 272 Field Value Type Description System.Int32 KeyF9 Declaration public const int KeyF9 = 273 Field Value Type Description System.Int32 KeyHome Declaration public const int KeyHome = 262 Field Value Type Description System.Int32 KeyInsertChar Declaration public const int KeyInsertChar = 331 Field Value Type Description System.Int32 KeyLeft Declaration public const int KeyLeft = 260 Field Value Type Description System.Int32 KeyMouse Declaration public const int KeyMouse = 409 Field Value Type Description System.Int32 KeyNPage Declaration public const int KeyNPage = 338 Field Value Type Description System.Int32 KeyPPage Declaration public const int KeyPPage = 339 Field Value Type Description System.Int32 KeyResize Declaration public const int KeyResize = 410 Field Value Type Description System.Int32 KeyRight Declaration public const int KeyRight = 261 Field Value Type Description System.Int32 KeyTab Declaration public const int KeyTab = 9 Field Value Type Description System.Int32 KeyUp Declaration public const int KeyUp = 259 Field Value Type Description System.Int32 LC_ALL Declaration public const int LC_ALL = 6 Field Value Type Description System.Int32 LeftRightUpNPagePPage Declaration public const int LeftRightUpNPagePPage = 0 Field Value Type Description System.Int32 ShiftAltKeyDown Declaration public const int ShiftAltKeyDown = 524 Field Value Type Description System.Int32 ShiftAltKeyEnd Declaration public const int ShiftAltKeyEnd = 529 Field Value Type Description System.Int32 ShiftAltKeyHome Declaration public const int ShiftAltKeyHome = 534 Field Value Type Description System.Int32 ShiftAltKeyLeft Declaration public const int ShiftAltKeyLeft = 544 Field Value Type Description System.Int32 ShiftAltKeyNPage Declaration public const int ShiftAltKeyNPage = 549 Field Value Type Description System.Int32 ShiftAltKeyPPage Declaration public const int ShiftAltKeyPPage = 554 Field Value Type Description System.Int32 ShiftAltKeyRight Declaration public const int ShiftAltKeyRight = 559 Field Value Type Description System.Int32 ShiftAltKeyUp Declaration public const int ShiftAltKeyUp = 565 Field Value Type Description System.Int32 ShiftCtrlKeyDown Declaration public const int ShiftCtrlKeyDown = 526 Field Value Type Description System.Int32 ShiftCtrlKeyEnd Declaration public const int ShiftCtrlKeyEnd = 531 Field Value Type Description System.Int32 ShiftCtrlKeyHome Declaration public const int ShiftCtrlKeyHome = 536 Field Value Type Description System.Int32 ShiftCtrlKeyLeft Declaration public const int ShiftCtrlKeyLeft = 546 Field Value Type Description System.Int32 ShiftCtrlKeyNPage Declaration public const int ShiftCtrlKeyNPage = 551 Field Value Type Description System.Int32 ShiftCtrlKeyPPage Declaration public const int ShiftCtrlKeyPPage = 556 Field Value Type Description System.Int32 ShiftCtrlKeyRight Declaration public const int ShiftCtrlKeyRight = 561 Field Value Type Description System.Int32 ShiftCtrlKeyUp Declaration public const int ShiftCtrlKeyUp = 567 Field Value Type Description System.Int32 ShiftKeyDown Declaration public const int ShiftKeyDown = 336 Field Value Type Description System.Int32 ShiftKeyEnd Declaration public const int ShiftKeyEnd = 386 Field Value Type Description System.Int32 ShiftKeyHome Declaration public const int ShiftKeyHome = 391 Field Value Type Description System.Int32 ShiftKeyLeft Declaration public const int ShiftKeyLeft = 393 Field Value Type Description System.Int32 ShiftKeyNPage Declaration public const int ShiftKeyNPage = 396 Field Value Type Description System.Int32 ShiftKeyPPage Declaration public const int ShiftKeyPPage = 398 Field Value Type Description System.Int32 ShiftKeyRight Declaration public const int ShiftKeyRight = 402 Field Value Type Description System.Int32 ShiftKeyUp Declaration public const int ShiftKeyUp = 337 Field Value Type Description System.Int32 Properties ColorPairs Declaration public static int ColorPairs { get; } Property Value Type Description System.Int32 Cols Declaration public static int Cols { get; } Property Value Type Description System.Int32 HasColors Declaration public static bool HasColors { get; } Property Value Type Description System.Boolean Lines Declaration public static int Lines { get; } Property Value Type Description System.Int32 Methods addch(Int32) Declaration public static int addch(int ch) Parameters Type Name Description System.Int32 ch Returns Type Description System.Int32 addstr(String, Object[]) Declaration public static int addstr(string format, params object[] args) Parameters Type Name Description System.String format System.Object [] args Returns Type Description System.Int32 addwstr(String) Declaration public static int addwstr(string s) Parameters Type Name Description System.String s Returns Type Description System.Int32 attroff(Int32) Declaration public static int attroff(int attrs) Parameters Type Name Description System.Int32 attrs Returns Type Description System.Int32 attron(Int32) Declaration public static int attron(int attrs) Parameters Type Name Description System.Int32 attrs Returns Type Description System.Int32 attrset(Int32) Declaration public static int attrset(int attrs) Parameters Type Name Description System.Int32 attrs Returns Type Description System.Int32 cbreak() Declaration public static int cbreak() Returns Type Description System.Int32 CheckWinChange() Declaration public static bool CheckWinChange() Returns Type Description System.Boolean clearok(IntPtr, Boolean) Declaration public static int clearok(IntPtr win, bool bf) Parameters Type Name Description System.IntPtr win System.Boolean bf Returns Type Description System.Int32 COLOR_PAIRS() Declaration public static int COLOR_PAIRS() Returns Type Description System.Int32 ColorPair(Int32) Declaration public static int ColorPair(int n) Parameters Type Name Description System.Int32 n Returns Type Description System.Int32 doupdate() Declaration public static int doupdate() Returns Type Description System.Int32 echo() Declaration public static int echo() Returns Type Description System.Int32 endwin() Declaration public static int endwin() Returns Type Description System.Int32 get_wch(out Int32) Declaration public static int get_wch(out int sequence) Parameters Type Name Description System.Int32 sequence Returns Type Description System.Int32 getch() Declaration public static int getch() Returns Type Description System.Int32 getmouse(out Curses.MouseEvent) Declaration public static uint getmouse(out Curses.MouseEvent ev) Parameters Type Name Description Curses.MouseEvent ev Returns Type Description System.UInt32 halfdelay(Int32) Declaration public static int halfdelay(int t) Parameters Type Name Description System.Int32 t Returns Type Description System.Int32 has_colors() Declaration public static bool has_colors() Returns Type Description System.Boolean idcok(IntPtr, Boolean) Declaration public static void idcok(IntPtr win, bool bf) Parameters Type Name Description System.IntPtr win System.Boolean bf idlok(IntPtr, Boolean) Declaration public static int idlok(IntPtr win, bool bf) Parameters Type Name Description System.IntPtr win System.Boolean bf Returns Type Description System.Int32 immedok(IntPtr, Boolean) Declaration public static void immedok(IntPtr win, bool bf) Parameters Type Name Description System.IntPtr win System.Boolean bf init_pair(Int16, Int16, Int16) Declaration public static int init_pair(short pair, short f, short b) Parameters Type Name Description System.Int16 pair System.Int16 f System.Int16 b Returns Type Description System.Int32 InitColorPair(Int16, Int16, Int16) Declaration public static int InitColorPair(short pair, short foreground, short background) Parameters Type Name Description System.Int16 pair System.Int16 foreground System.Int16 background Returns Type Description System.Int32 initscr() Declaration public static Curses.Window initscr() Returns Type Description Curses.Window intrflush(IntPtr, Boolean) Declaration public static int intrflush(IntPtr win, bool bf) Parameters Type Name Description System.IntPtr win System.Boolean bf Returns Type Description System.Int32 IsAlt(Int32) Declaration public static int IsAlt(int key) Parameters Type Name Description System.Int32 key Returns Type Description System.Int32 isendwin() Declaration public static bool isendwin() Returns Type Description System.Boolean keypad(IntPtr, Boolean) Declaration public static int keypad(IntPtr win, bool bf) Parameters Type Name Description System.IntPtr win System.Boolean bf Returns Type Description System.Int32 leaveok(IntPtr, Boolean) Declaration public static int leaveok(IntPtr win, bool bf) Parameters Type Name Description System.IntPtr win System.Boolean bf Returns Type Description System.Int32 meta(IntPtr, Boolean) Declaration public static int meta(IntPtr win, bool bf) Parameters Type Name Description System.IntPtr win System.Boolean bf Returns Type Description System.Int32 mouseinterval(Int32) Declaration public static int mouseinterval(int interval) Parameters Type Name Description System.Int32 interval Returns Type Description System.Int32 mousemask(Curses.Event, out Curses.Event) Declaration public static Curses.Event mousemask(Curses.Event newmask, out Curses.Event oldmask) Parameters Type Name Description Curses.Event newmask Curses.Event oldmask Returns Type Description Curses.Event move(Int32, Int32) Declaration public static int move(int line, int col) Parameters Type Name Description System.Int32 line System.Int32 col Returns Type Description System.Int32 mvgetch(Int32, Int32) Declaration public static int mvgetch(int y, int x) Parameters Type Name Description System.Int32 y System.Int32 x Returns Type Description System.Int32 nl() Declaration public static int nl() Returns Type Description System.Int32 nocbreak() Declaration public static int nocbreak() Returns Type Description System.Int32 noecho() Declaration public static int noecho() Returns Type Description System.Int32 nonl() Declaration public static int nonl() Returns Type Description System.Int32 noqiflush() Declaration public static void noqiflush() noraw() Declaration public static int noraw() Returns Type Description System.Int32 notimeout(IntPtr, Boolean) Declaration public static int notimeout(IntPtr win, bool bf) Parameters Type Name Description System.IntPtr win System.Boolean bf Returns Type Description System.Int32 qiflush() Declaration public static void qiflush() raw() Declaration public static int raw() Returns Type Description System.Int32 redrawwin(IntPtr) Declaration public static int redrawwin(IntPtr win) Parameters Type Name Description System.IntPtr win Returns Type Description System.Int32 refresh() Declaration public static int refresh() Returns Type Description System.Int32 scrollok(IntPtr, Boolean) Declaration public static int scrollok(IntPtr win, bool bf) Parameters Type Name Description System.IntPtr win System.Boolean bf Returns Type Description System.Int32 setlocale(Int32, String) Declaration public static int setlocale(int cate, string locale) Parameters Type Name Description System.Int32 cate System.String locale Returns Type Description System.Int32 setscrreg(Int32, Int32) Declaration public static int setscrreg(int top, int bot) Parameters Type Name Description System.Int32 top System.Int32 bot Returns Type Description System.Int32 start_color() Declaration public static int start_color() Returns Type Description System.Int32 StartColor() Declaration public static int StartColor() Returns Type Description System.Int32 timeout(Int32) Declaration public static int timeout(int delay) Parameters Type Name Description System.Int32 delay Returns Type Description System.Int32 typeahead(IntPtr) Declaration public static int typeahead(IntPtr fd) Parameters Type Name Description System.IntPtr fd Returns Type Description System.Int32 ungetch(Int32) Declaration public static int ungetch(int ch) Parameters Type Name Description System.Int32 ch Returns Type Description System.Int32 ungetmouse(ref Curses.MouseEvent) Declaration public static uint ungetmouse(ref Curses.MouseEvent ev) Parameters Type Name Description Curses.MouseEvent ev Returns Type Description System.UInt32 use_default_colors() Declaration public static int use_default_colors() Returns Type Description System.Int32 UseDefaultColors() Declaration public static int UseDefaultColors() Returns Type Description System.Int32 waddch(IntPtr, Int32) Declaration public static int waddch(IntPtr win, int ch) Parameters Type Name Description System.IntPtr win System.Int32 ch Returns Type Description System.Int32 wmove(IntPtr, Int32, Int32) Declaration public static int wmove(IntPtr win, int line, int col) Parameters Type Name Description System.IntPtr win System.Int32 line System.Int32 col Returns Type Description System.Int32 wnoutrefresh(IntPtr) Declaration public static int wnoutrefresh(IntPtr win) Parameters Type Name Description System.IntPtr win Returns Type Description System.Int32 wrefresh(IntPtr) Declaration public static int wrefresh(IntPtr win) Parameters Type Name Description System.IntPtr win Returns Type Description System.Int32 wsetscrreg(IntPtr, Int32, Int32) Declaration public static int wsetscrreg(IntPtr win, int top, int bot) Parameters Type Name Description System.IntPtr win System.Int32 top System.Int32 bot Returns Type Description System.Int32 wtimeout(IntPtr, Int32) Declaration public static int wtimeout(IntPtr win, int delay) Parameters Type Name Description System.IntPtr win System.Int32 delay Returns Type Description System.Int32"
},
"api/Terminal.Gui/Unix.Terminal.Curses.MouseEvent.html": {
"href": "api/Terminal.Gui/Unix.Terminal.Curses.MouseEvent.html",
@@ -374,10 +384,35 @@
"title": "Class Binding",
"keywords": "Class Binding Inheritance System.Object Binding Inherited Members System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) System.Object.ToString() Namespace : UICatalog Assembly : UICatalog.dll Syntax public class Binding Constructors Binding(View, String, View, String, IValueConverter) Declaration public Binding(View source, string sourcePropertyName, View target, string targetPropertyName, IValueConverter valueConverter = null) Parameters Type Name Description View source System.String sourcePropertyName View target System.String targetPropertyName IValueConverter valueConverter Properties Source Declaration public View Source { get; } Property Value Type Description View SourcePropertyName Declaration public string SourcePropertyName { get; } Property Value Type Description System.String Target Declaration public View Target { get; } Property Value Type Description View TargetPropertyName Declaration public string TargetPropertyName { get; } Property Value Type Description System.String"
},
+ "api/UICatalog/UICatalog.DynamicMenuBarDetails.html": {
+ "href": "api/UICatalog/UICatalog.DynamicMenuBarDetails.html",
+ "title": "Class DynamicMenuBarDetails",
+ "keywords": "Class DynamicMenuBarDetails Inheritance System.Object Responder View FrameView DynamicMenuBarDetails Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members FrameView.Title FrameView.Add(View) FrameView.Remove(View) FrameView.RemoveAll() FrameView.Redraw(Rect) FrameView.Text FrameView.TextAlignment View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Shortcut View.ShortcutTag View.ShortcutAction View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.CanFocus View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View[]) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) Terminal.Gui.View.DrawHotString(ustring, Terminal.Gui.Attribute, Terminal.Gui.Attribute) Terminal.Gui.View.DrawHotString(ustring, System.Boolean, Terminal.Gui.ColorScheme) View.Move(Int32, Int32) View.PositionCursor() View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme Terminal.Gui.View.AddRune(System.Int32, System.Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessKey(KeyEvent) View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.AutoSize View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.MouseEvent(MouseEvent) Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : UICatalog Assembly : UICatalog.dll Syntax public class DynamicMenuBarDetails : FrameView, IDisposable, ISupportInitializeNotification, ISupportInitialize Constructors DynamicMenuBarDetails(MenuItem, Boolean) Declaration public DynamicMenuBarDetails(MenuItem menuItem = null, bool hasParent = false) Parameters Type Name Description MenuItem menuItem System.Boolean hasParent DynamicMenuBarDetails(ustring) Declaration public DynamicMenuBarDetails(ustring title) Parameters Type Name Description ustring title Fields _ckbIsTopLevel Declaration public CheckBox _ckbIsTopLevel Field Value Type Description CheckBox _ckbSubMenu Declaration public CheckBox _ckbSubMenu Field Value Type Description CheckBox _menuItem Declaration public MenuItem _menuItem Field Value Type Description MenuItem _rbChkStyle Declaration public RadioGroup _rbChkStyle Field Value Type Description RadioGroup _txtAction Declaration public TextView _txtAction Field Value Type Description TextView _txtHelp Declaration public TextField _txtHelp Field Value Type Description TextField _txtShortcut Declaration public TextField _txtShortcut Field Value Type Description TextField _txtTitle Declaration public TextField _txtTitle Field Value Type Description TextField Methods CreateAction(MenuItem, DynamicMenuItem) Declaration public Action CreateAction(MenuItem menuItem, DynamicMenuItem item) Parameters Type Name Description MenuItem menuItem DynamicMenuItem item Returns Type Description System.Action EditMenuBarItem(MenuItem) Declaration public void EditMenuBarItem(MenuItem menuItem) Parameters Type Name Description MenuItem menuItem EnterMenuItem() Declaration public DynamicMenuItem EnterMenuItem() Returns Type Description DynamicMenuItem UpdateParent(ref MenuItem) Declaration public void UpdateParent(ref MenuItem menuItem) Parameters Type Name Description MenuItem menuItem Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize"
+ },
+ "api/UICatalog/UICatalog.DynamicMenuBarSample.html": {
+ "href": "api/UICatalog/UICatalog.DynamicMenuBarSample.html",
+ "title": "Class DynamicMenuBarSample",
+ "keywords": "Class DynamicMenuBarSample Inheritance System.Object Responder View Toplevel Window DynamicMenuBarSample Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members Window.Title Window.Add(View) Window.Remove(View) Window.RemoveAll() Window.Redraw(Rect) Window.MouseEvent(MouseEvent) Window.Text Window.TextAlignment Toplevel.Running Toplevel.Loaded Toplevel.Ready Toplevel.Unloaded Toplevel.Create() Toplevel.CanFocus Toplevel.Modal Toplevel.MenuBar Toplevel.StatusBar Toplevel.OnKeyDown(KeyEvent) Toplevel.OnKeyUp(KeyEvent) Toplevel.ProcessKey(KeyEvent) Toplevel.ProcessColdKey(KeyEvent) Toplevel.WillPresent() View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Shortcut View.ShortcutTag View.ShortcutAction View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View[]) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) Terminal.Gui.View.DrawHotString(ustring, Terminal.Gui.Attribute, Terminal.Gui.Attribute) Terminal.Gui.View.DrawHotString(ustring, System.Boolean, Terminal.Gui.ColorScheme) View.Move(Int32, Int32) View.PositionCursor() View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme Terminal.Gui.View.AddRune(System.Int32, System.Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessHotKey(KeyEvent) View.KeyDown View.KeyUp View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.AutoSize View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : UICatalog Assembly : UICatalog.dll Syntax public class DynamicMenuBarSample : Window, IDisposable, ISupportInitializeNotification, ISupportInitialize Constructors DynamicMenuBarSample(ustring) Declaration public DynamicMenuBarSample(ustring title) Parameters Type Name Description ustring title Properties DataContext Declaration public DynamicMenuItemModel DataContext { get; set; } Property Value Type Description DynamicMenuItemModel Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize"
+ },
+ "api/UICatalog/UICatalog.DynamicMenuItem.html": {
+ "href": "api/UICatalog/UICatalog.DynamicMenuItem.html",
+ "title": "Class DynamicMenuItem",
+ "keywords": "Class DynamicMenuItem Inheritance System.Object DynamicMenuItem Inherited Members System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) System.Object.ToString() Namespace : UICatalog Assembly : UICatalog.dll Syntax public class DynamicMenuItem Constructors DynamicMenuItem() Declaration public DynamicMenuItem() DynamicMenuItem(ustring, Boolean) Declaration public DynamicMenuItem(ustring title, bool hasSubMenu = false) Parameters Type Name Description ustring title System.Boolean hasSubMenu DynamicMenuItem(ustring, ustring, ustring, Boolean, Boolean, MenuItemCheckStyle, ustring) Declaration public DynamicMenuItem(ustring title, ustring help, ustring action, bool isTopLevel, bool hasSubMenu, MenuItemCheckStyle checkStyle = MenuItemCheckStyle.NoCheck, ustring shortcut = null) Parameters Type Name Description ustring title ustring help ustring action System.Boolean isTopLevel System.Boolean hasSubMenu MenuItemCheckStyle checkStyle ustring shortcut Fields action Declaration public ustring action Field Value Type Description ustring checkStyle Declaration public MenuItemCheckStyle checkStyle Field Value Type Description MenuItemCheckStyle hasSubMenu Declaration public bool hasSubMenu Field Value Type Description System.Boolean help Declaration public ustring help Field Value Type Description ustring isTopLevel Declaration public bool isTopLevel Field Value Type Description System.Boolean shortcut Declaration public ustring shortcut Field Value Type Description ustring title Declaration public ustring title Field Value Type Description ustring"
+ },
+ "api/UICatalog/UICatalog.DynamicMenuItemList.html": {
+ "href": "api/UICatalog/UICatalog.DynamicMenuItemList.html",
+ "title": "Class DynamicMenuItemList",
+ "keywords": "Class DynamicMenuItemList Inheritance System.Object DynamicMenuItemList Inherited Members System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : UICatalog Assembly : UICatalog.dll Syntax public class DynamicMenuItemList Constructors DynamicMenuItemList() Declaration public DynamicMenuItemList() DynamicMenuItemList(ustring, MenuItem) Declaration public DynamicMenuItemList(ustring title, MenuItem menuItem) Parameters Type Name Description ustring title MenuItem menuItem Properties MenuItem Declaration public MenuItem MenuItem { get; set; } Property Value Type Description MenuItem Title Declaration public ustring Title { get; set; } Property Value Type Description ustring Methods ToString() Declaration public override string ToString() Returns Type Description System.String Overrides System.Object.ToString()"
+ },
+ "api/UICatalog/UICatalog.DynamicMenuItemModel.html": {
+ "href": "api/UICatalog/UICatalog.DynamicMenuItemModel.html",
+ "title": "Class DynamicMenuItemModel",
+ "keywords": "Class DynamicMenuItemModel Inheritance System.Object DynamicMenuItemModel Implements System.ComponentModel.INotifyPropertyChanged Inherited Members System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) System.Object.ToString() Namespace : UICatalog Assembly : UICatalog.dll Syntax public class DynamicMenuItemModel : INotifyPropertyChanged Constructors DynamicMenuItemModel() Declaration public DynamicMenuItemModel() Properties MenuBar Declaration public ustring MenuBar { get; set; } Property Value Type Description ustring Menus Declaration public List Menus { get; set; } Property Value Type Description System.Collections.Generic.List < DynamicMenuItemList > Parent Declaration public ustring Parent { get; set; } Property Value Type Description ustring Methods GetPropertyName(String) Declaration public string GetPropertyName(string propertyName = null) Parameters Type Name Description System.String propertyName Returns Type Description System.String Events PropertyChanged Declaration public event PropertyChangedEventHandler PropertyChanged Event Type Type Description System.ComponentModel.PropertyChangedEventHandler Implements System.ComponentModel.INotifyPropertyChanged"
+ },
"api/UICatalog/UICatalog.html": {
"href": "api/UICatalog/UICatalog.html",
"title": "Namespace UICatalog",
- "keywords": "Namespace UICatalog Classes Binding ListWrapperConverter Scenario Base class for each demo/scenario. To define a new scenario: Create a new .cs file in the Scenarios directory that derives from Scenario . Annotate the Scenario derived class with a attribute specifying the scenario's name and description. Add one or more Scenario.ScenarioCategory attributes to the class specifying which categories the sceanrio belongs to. If you don't specify a category the sceanrio will show up in \"All\". Implement the Setup() override which will be called when a user selects the scenario to run. Optionally, implement the and/or Run() overrides to provide a custom implementation. The UI Catalog program uses reflection to find all scenarios and adds them to the ListViews. Press ENTER to run the selected scenario. Press CTRL-Q to exit it. / Scenario.ScenarioCategory Defines the category names used to catagorize a Scenario Scenario.ScenarioMetadata Defines the metadata (Name and Description) for a Scenario UICatalogApp UI Catalog is a comprehensive sample app and scenario library for Terminal.Gui UStringValueConverter Interfaces IValueConverter"
+ "keywords": "Namespace UICatalog Classes Binding DynamicMenuBarDetails DynamicMenuBarSample DynamicMenuItem DynamicMenuItemList DynamicMenuItemModel ListWrapperConverter NumberToWords Scenario Base class for each demo/scenario. To define a new scenario: Create a new .cs file in the Scenarios directory that derives from Scenario . Annotate the Scenario derived class with a attribute specifying the scenario's name and description. Add one or more Scenario.ScenarioCategory attributes to the class specifying which categories the sceanrio belongs to. If you don't specify a category the sceanrio will show up in \"All\". Implement the Setup() override which will be called when a user selects the scenario to run. Optionally, implement the and/or Run() overrides to provide a custom implementation. The UI Catalog program uses reflection to find all scenarios and adds them to the ListViews. Press ENTER to run the selected scenario. Press CTRL-Q to exit it. / Scenario.ScenarioCategory Defines the category names used to catagorize a Scenario Scenario.ScenarioMetadata Defines the metadata (Name and Description) for a Scenario UICatalogApp UI Catalog is a comprehensive sample app and scenario library for Terminal.Gui UStringValueConverter Interfaces IValueConverter"
},
"api/UICatalog/UICatalog.IValueConverter.html": {
"href": "api/UICatalog/UICatalog.IValueConverter.html",
@@ -389,6 +424,11 @@
"title": "Class ListWrapperConverter",
"keywords": "Class ListWrapperConverter Inheritance System.Object ListWrapperConverter Implements IValueConverter Inherited Members System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) System.Object.ToString() Namespace : UICatalog Assembly : UICatalog.dll Syntax public class ListWrapperConverter : IValueConverter Methods Convert(Object, Object) Declaration public object Convert(object value, object parameter = null) Parameters Type Name Description System.Object value System.Object parameter Returns Type Description System.Object Implements IValueConverter"
},
+ "api/UICatalog/UICatalog.NumberToWords.html": {
+ "href": "api/UICatalog/UICatalog.NumberToWords.html",
+ "title": "Class NumberToWords",
+ "keywords": "Class NumberToWords Inheritance System.Object NumberToWords Inherited Members System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) System.Object.ToString() Namespace : UICatalog Assembly : UICatalog.dll Syntax public static class NumberToWords Methods Convert(Int64) Declaration public static string Convert(long i) Parameters Type Name Description System.Int64 i Returns Type Description System.String ConvertAmount(Double) Declaration public static string ConvertAmount(double amount) Parameters Type Name Description System.Double amount Returns Type Description System.String"
+ },
"api/UICatalog/UICatalog.Scenario.html": {
"href": "api/UICatalog/UICatalog.Scenario.html",
"title": "Class Scenario",
@@ -447,6 +487,6 @@
"README.html": {
"href": "README.html",
"title": "To Generate the Docs",
- "keywords": "This folder generates the API docs for Terminal.Gui. The API documentation is generated using the DocFX tool . The output of docfx gets put into the ./docs folder which is then checked in. The ./docs folder is then picked up by Github Pages and published to Miguel's Github Pages ( https://migueldeicaza.github.io/gui.cs/ ). To Generate the Docs Install DotFX https://dotnet.github.io/docfx/tutorial/docfx_getting_started.html From the solution root type ../docfx/build.ps1 Browse to http://localhost:8080 and verify everything looks good. Hit ctrl-c to stop the script. Commit to git. If docfx fails with a Stackoverflow error. Just run it again. And again. Sometimes it takes a few times. If that doesn't work, create a fresh clone or delete the docfx/api , docfx/obj , and docs/ folders and run the steps above again."
+ "keywords": "This folder generates the API docs for Terminal.Gui. The API documentation is generated using the DocFX tool . The output of docfx gets put into the ./docs folder which is then checked in. The ./docs folder is then picked up by Github Pages and published to Miguel's Github Pages ( https://migueldeicaza.github.io/gui.cs/ ). To Generate the Docs Install DotFX https://dotnet.github.io/docfx/tutorial/docfx_getting_started.html Change to the ./docfx folder and run ./build.ps1 Browse to http://localhost:8080 and verify everything looks good. Hit ctrl-c to stop the script. If docfx fails with a Stackoverflow error. Just run it again. And again. Sometimes it takes a few times. If that doesn't work, create a fresh clone or delete the docfx/api , docfx/obj , and docs/ folders and run the steps above again."
}
}
\ No newline at end of file
diff --git a/docs/manifest.json b/docs/manifest.json
index bff5500f2..5e3404528 100644
--- a/docs/manifest.json
+++ b/docs/manifest.json
@@ -1,6 +1,6 @@
{
"homepages": [],
- "source_base_path": "C:/Users/ckindel/s/gui.cs/docfx",
+ "source_base_path": "C:/Users/tig/s/gui.cs/docfx",
"xrefmap": "xrefmap.yml",
"files": [
{
@@ -18,7 +18,7 @@
"output": {
".html": {
"relative_path": "README.html",
- "hash": "ev8XMddJHQpjAxQfEx3K+g=="
+ "hash": "kN4VpPj0jYn/r2vGth0zpA=="
}
},
"is_incremental": false,
@@ -54,7 +54,7 @@
"output": {
".html": {
"relative_path": "api/Terminal.Gui/Terminal.Gui.Application.html",
- "hash": "VjWcOggx8Nyz+pnqXM/S8w=="
+ "hash": "adLHrrWcfONSreHrmFyZUA=="
}
},
"is_incremental": false,
@@ -78,7 +78,7 @@
"output": {
".html": {
"relative_path": "api/Terminal.Gui/Terminal.Gui.Button.html",
- "hash": "MGDPnRO4DDQCAW5qssWgEg=="
+ "hash": "utT05epj2Hi+qxjeaX0WOQ=="
}
},
"is_incremental": false,
@@ -90,7 +90,7 @@
"output": {
".html": {
"relative_path": "api/Terminal.Gui/Terminal.Gui.CheckBox.html",
- "hash": "2wOcWTizruL1IjY3a4y9Cg=="
+ "hash": "3RnSxXNyQj6UBe9LL+6xJw=="
}
},
"is_incremental": false,
@@ -150,7 +150,7 @@
"output": {
".html": {
"relative_path": "api/Terminal.Gui/Terminal.Gui.ComboBox.html",
- "hash": "Xgf4xAW3MKUDvQLcH38xNg=="
+ "hash": "IucJCcWKRIrerv41SqU7Gw=="
}
},
"is_incremental": false,
@@ -186,7 +186,7 @@
"output": {
".html": {
"relative_path": "api/Terminal.Gui/Terminal.Gui.DateField.html",
- "hash": "qjQFqRZU/FlE8iTQ7gSTyg=="
+ "hash": "6c6h6x3f1ItWKNrmfgSIAg=="
}
},
"is_incremental": false,
@@ -210,7 +210,7 @@
"output": {
".html": {
"relative_path": "api/Terminal.Gui/Terminal.Gui.Dialog.html",
- "hash": "ai6thSd8ww48dy4ntcnezA=="
+ "hash": "+j593zVXQ8IC9pxzKBZ5Uw=="
}
},
"is_incremental": false,
@@ -270,7 +270,7 @@
"output": {
".html": {
"relative_path": "api/Terminal.Gui/Terminal.Gui.FileDialog.html",
- "hash": "dmr8gIkWUApGKf7zk9HaGA=="
+ "hash": "Xz46dSeNJwJynF1vRwbKfA=="
}
},
"is_incremental": false,
@@ -282,7 +282,7 @@
"output": {
".html": {
"relative_path": "api/Terminal.Gui/Terminal.Gui.FrameView.html",
- "hash": "S9ZHUnRU90aJ7ZQfYfS5Fg=="
+ "hash": "8nKMxYO5f40EknIOdGacqA=="
}
},
"is_incremental": false,
@@ -294,7 +294,7 @@
"output": {
".html": {
"relative_path": "api/Terminal.Gui/Terminal.Gui.HexView.html",
- "hash": "4BTtNnROMXltXzUDMrLScg=="
+ "hash": "uESpSvrwm3Rulj4vE6k+kQ=="
}
},
"is_incremental": false,
@@ -330,7 +330,7 @@
"output": {
".html": {
"relative_path": "api/Terminal.Gui/Terminal.Gui.Key.html",
- "hash": "HD8zkl30/lQfcgqq2eO2xA=="
+ "hash": "iDEzBe7S3PdymFiUgdS/fg=="
}
},
"is_incremental": false,
@@ -366,7 +366,7 @@
"output": {
".html": {
"relative_path": "api/Terminal.Gui/Terminal.Gui.Label.html",
- "hash": "uSyh92D3WOYpbSHMGaHm9A=="
+ "hash": "KCMzohT34u0ZaHNKCTki2Q=="
}
},
"is_incremental": false,
@@ -390,7 +390,7 @@
"output": {
".html": {
"relative_path": "api/Terminal.Gui/Terminal.Gui.ListView.html",
- "hash": "tiujqjo270jmYwYrkOIp3w=="
+ "hash": "kqmIUV0LA7xbIHBnnBkSSQ=="
}
},
"is_incremental": false,
@@ -438,7 +438,7 @@
"output": {
".html": {
"relative_path": "api/Terminal.Gui/Terminal.Gui.MenuBar.html",
- "hash": "Jiu/7p2PWC3s5Hv6M3Yb4Q=="
+ "hash": "WliS5ePQFgPX3kZ264UoXA=="
}
},
"is_incremental": false,
@@ -450,7 +450,7 @@
"output": {
".html": {
"relative_path": "api/Terminal.Gui/Terminal.Gui.MenuBarItem.html",
- "hash": "AEwNmo1AFJgd8UT2ICeBdw=="
+ "hash": "nt2VHHxtwua0WwTXFp961Q=="
}
},
"is_incremental": false,
@@ -462,7 +462,7 @@
"output": {
".html": {
"relative_path": "api/Terminal.Gui/Terminal.Gui.MenuItem.html",
- "hash": "pUJF1Ucdd+dAjd54tXhq/Q=="
+ "hash": "sew43DZJxOYVDb+vIgweDg=="
}
},
"is_incremental": false,
@@ -534,7 +534,7 @@
"output": {
".html": {
"relative_path": "api/Terminal.Gui/Terminal.Gui.OpenDialog.html",
- "hash": "wPb+pub4Fbg+8qXIlIjW5g=="
+ "hash": "IRwx12E6EvLMg1F5O4oABQ=="
}
},
"is_incremental": false,
@@ -570,7 +570,7 @@
"output": {
".html": {
"relative_path": "api/Terminal.Gui/Terminal.Gui.ProgressBar.html",
- "hash": "cIgNlDHScc2ZbfbDSjViHw=="
+ "hash": "PIuKK5C+qVLaCFPwmWxJXg=="
}
},
"is_incremental": false,
@@ -594,7 +594,7 @@
"output": {
".html": {
"relative_path": "api/Terminal.Gui/Terminal.Gui.RadioGroup.html",
- "hash": "ACH8iMv6ctRvgf7eYzL7Tw=="
+ "hash": "V3o7GnXT4/xviAcRD/tzkA=="
}
},
"is_incremental": false,
@@ -630,7 +630,7 @@
"output": {
".html": {
"relative_path": "api/Terminal.Gui/Terminal.Gui.SaveDialog.html",
- "hash": "dRJK6tq1HjrhsML7NZhZuA=="
+ "hash": "4yggSUHTvg9LQVDHLpgMLQ=="
}
},
"is_incremental": false,
@@ -642,7 +642,7 @@
"output": {
".html": {
"relative_path": "api/Terminal.Gui/Terminal.Gui.ScrollBarView.html",
- "hash": "GHCkZfgoqRdqlK8tPXGb8A=="
+ "hash": "TFXQqoTP1ud2vataabjx+w=="
}
},
"is_incremental": false,
@@ -654,7 +654,19 @@
"output": {
".html": {
"relative_path": "api/Terminal.Gui/Terminal.Gui.ScrollView.html",
- "hash": "z+Q/6YffWSIt1jZ0dA7rTg=="
+ "hash": "h5QWbTxIO0sBhmly3SXuYw=="
+ }
+ },
+ "is_incremental": false,
+ "version": ""
+ },
+ {
+ "type": "ManagedReference",
+ "source_relative_path": "api/Terminal.Gui/Terminal.Gui.ShortcutHelper.yml",
+ "output": {
+ ".html": {
+ "relative_path": "api/Terminal.Gui/Terminal.Gui.ShortcutHelper.html",
+ "hash": "W8radBuvVaiAVH74YKIUWQ=="
}
},
"is_incremental": false,
@@ -678,7 +690,7 @@
"output": {
".html": {
"relative_path": "api/Terminal.Gui/Terminal.Gui.StatusBar.html",
- "hash": "2gjTR2GuA1aRdbSeI7qdzQ=="
+ "hash": "lWJ5lKCLyk51yOvIP/ALdg=="
}
},
"is_incremental": false,
@@ -708,13 +720,25 @@
"is_incremental": false,
"version": ""
},
+ {
+ "type": "ManagedReference",
+ "source_relative_path": "api/Terminal.Gui/Terminal.Gui.TextChangingEventArgs.yml",
+ "output": {
+ ".html": {
+ "relative_path": "api/Terminal.Gui/Terminal.Gui.TextChangingEventArgs.html",
+ "hash": "KqX/YMBpTSrExxNnRNyvxg=="
+ }
+ },
+ "is_incremental": false,
+ "version": ""
+ },
{
"type": "ManagedReference",
"source_relative_path": "api/Terminal.Gui/Terminal.Gui.TextField.yml",
"output": {
".html": {
"relative_path": "api/Terminal.Gui/Terminal.Gui.TextField.html",
- "hash": "eFNfdQmbf+a4IK3y8D7sTQ=="
+ "hash": "LYYE37F/9CUMCWGDyOmdVg=="
}
},
"is_incremental": false,
@@ -726,7 +750,7 @@
"output": {
".html": {
"relative_path": "api/Terminal.Gui/Terminal.Gui.TextFormatter.html",
- "hash": "oC59pqrEg2JpycU4CLutJA=="
+ "hash": "1kfDR820gyNVp7L/hLLcSg=="
}
},
"is_incremental": false,
@@ -738,7 +762,7 @@
"output": {
".html": {
"relative_path": "api/Terminal.Gui/Terminal.Gui.TextView.html",
- "hash": "/i4H4LUXJ5BJBgbpU4r7Cw=="
+ "hash": "26I0W6ZThd8Cn1NFmkMe7w=="
}
},
"is_incremental": false,
@@ -750,7 +774,7 @@
"output": {
".html": {
"relative_path": "api/Terminal.Gui/Terminal.Gui.TimeField.html",
- "hash": "pBhFs/Z1W7O5ykxZeBiWKg=="
+ "hash": "i0Vwrcum16UBFwR3wABnEw=="
}
},
"is_incremental": false,
@@ -762,7 +786,7 @@
"output": {
".html": {
"relative_path": "api/Terminal.Gui/Terminal.Gui.Toplevel.html",
- "hash": "BfiH5bxJ+FGiUAI6uvwN2Q=="
+ "hash": "UJCruEVW+HWJbHzrjH+Crg=="
}
},
"is_incremental": false,
@@ -822,7 +846,7 @@
"output": {
".html": {
"relative_path": "api/Terminal.Gui/Terminal.Gui.View.html",
- "hash": "mLYmfCPwtUlME2Cd8xyjwQ=="
+ "hash": "aK8/6Cv3AXSqiePJV3kEuw=="
}
},
"is_incremental": false,
@@ -834,7 +858,7 @@
"output": {
".html": {
"relative_path": "api/Terminal.Gui/Terminal.Gui.Window.html",
- "hash": "K3mbrO+N7wyuNIgf34XYWg=="
+ "hash": "WrriqfUgUxKmjwm9z+blrg=="
}
},
"is_incremental": false,
@@ -846,7 +870,7 @@
"output": {
".html": {
"relative_path": "api/Terminal.Gui/Terminal.Gui.html",
- "hash": "uflGhrwMrJrFgbsJVidvrA=="
+ "hash": "c5JOg0CHamuR5EDpkt46sQ=="
}
},
"is_incremental": false,
@@ -894,7 +918,7 @@
"output": {
".html": {
"relative_path": "api/Terminal.Gui/Unix.Terminal.Curses.html",
- "hash": "UWkh+wjXTijxDw5c7pR4QA=="
+ "hash": "4QDsFVabOA0Q3p5i2tPm2A=="
}
},
"is_incremental": false,
@@ -918,7 +942,7 @@
"output": {
".html": {
"relative_path": "api/Terminal.Gui/toc.html",
- "hash": "zRVMGYHssE4Qrw5sc0hDYw=="
+ "hash": "8rqMXtiXXJzLCJ5mqHASkQ=="
}
},
"is_incremental": false,
@@ -936,6 +960,66 @@
"is_incremental": false,
"version": ""
},
+ {
+ "type": "ManagedReference",
+ "source_relative_path": "api/UICatalog/UICatalog.DynamicMenuBarDetails.yml",
+ "output": {
+ ".html": {
+ "relative_path": "api/UICatalog/UICatalog.DynamicMenuBarDetails.html",
+ "hash": "pLj3dZLaJzF/UtKWzNGzyA=="
+ }
+ },
+ "is_incremental": false,
+ "version": ""
+ },
+ {
+ "type": "ManagedReference",
+ "source_relative_path": "api/UICatalog/UICatalog.DynamicMenuBarSample.yml",
+ "output": {
+ ".html": {
+ "relative_path": "api/UICatalog/UICatalog.DynamicMenuBarSample.html",
+ "hash": "qtKSZZH2hJLBNcr2H1rPGA=="
+ }
+ },
+ "is_incremental": false,
+ "version": ""
+ },
+ {
+ "type": "ManagedReference",
+ "source_relative_path": "api/UICatalog/UICatalog.DynamicMenuItem.yml",
+ "output": {
+ ".html": {
+ "relative_path": "api/UICatalog/UICatalog.DynamicMenuItem.html",
+ "hash": "I8EZesyrEOy2Mze78OogOA=="
+ }
+ },
+ "is_incremental": false,
+ "version": ""
+ },
+ {
+ "type": "ManagedReference",
+ "source_relative_path": "api/UICatalog/UICatalog.DynamicMenuItemList.yml",
+ "output": {
+ ".html": {
+ "relative_path": "api/UICatalog/UICatalog.DynamicMenuItemList.html",
+ "hash": "YlvazHxTTf2cvM+OxBYZzg=="
+ }
+ },
+ "is_incremental": false,
+ "version": ""
+ },
+ {
+ "type": "ManagedReference",
+ "source_relative_path": "api/UICatalog/UICatalog.DynamicMenuItemModel.yml",
+ "output": {
+ ".html": {
+ "relative_path": "api/UICatalog/UICatalog.DynamicMenuItemModel.html",
+ "hash": "zO9eknSK3VoThnRJz/jEVw=="
+ }
+ },
+ "is_incremental": false,
+ "version": ""
+ },
{
"type": "ManagedReference",
"source_relative_path": "api/UICatalog/UICatalog.IValueConverter.yml",
@@ -960,6 +1044,18 @@
"is_incremental": false,
"version": ""
},
+ {
+ "type": "ManagedReference",
+ "source_relative_path": "api/UICatalog/UICatalog.NumberToWords.yml",
+ "output": {
+ ".html": {
+ "relative_path": "api/UICatalog/UICatalog.NumberToWords.html",
+ "hash": "jgywMJSStUSHynPG8s0QDA=="
+ }
+ },
+ "is_incremental": false,
+ "version": ""
+ },
{
"type": "ManagedReference",
"source_relative_path": "api/UICatalog/UICatalog.Scenario.ScenarioCategory.yml",
@@ -1026,7 +1122,7 @@
"output": {
".html": {
"relative_path": "api/UICatalog/UICatalog.html",
- "hash": "aAEYVP9EGgOT6kGe/H1oJw=="
+ "hash": "NmbAKFGnPfR8lDG/Ir907A=="
}
},
"is_incremental": false,
@@ -1038,7 +1134,7 @@
"output": {
".html": {
"relative_path": "api/UICatalog/toc.html",
- "hash": "bQdsgk0lBMqDQpxbUU/KVw=="
+ "hash": "+2genCJa8SCpevQGmvSZ9w=="
}
},
"is_incremental": false,
@@ -1184,7 +1280,7 @@
"ManagedReferenceDocumentProcessor": {
"can_incremental": true,
"incrementalPhase": "build",
- "total_file_count": 83,
+ "total_file_count": 91,
"skipped_file_count": 83
},
"ResourceDocumentProcessor": {
diff --git a/docs/xrefmap.yml b/docs/xrefmap.yml
index 9145e768f..7ab47632c 100644
--- a/docs/xrefmap.yml
+++ b/docs/xrefmap.yml
@@ -103,12 +103,6 @@ references:
commentId: F:Terminal.Gui.Application.Iteration
fullName: Terminal.Gui.Application.Iteration
nameWithType: Application.Iteration
-- uid: Terminal.Gui.Application.Loaded
- name: Loaded
- href: api/Terminal.Gui/Terminal.Gui.Application.html#Terminal_Gui_Application_Loaded
- commentId: F:Terminal.Gui.Application.Loaded
- fullName: Terminal.Gui.Application.Loaded
- nameWithType: Application.Loaded
- uid: Terminal.Gui.Application.MainLoop
name: MainLoop
href: api/Terminal.Gui/Terminal.Gui.Application.html#Terminal_Gui_Application_MainLoop
@@ -3865,12 +3859,24 @@ references:
commentId: T:Terminal.Gui.Key
fullName: Terminal.Gui.Key
nameWithType: Key
+- uid: Terminal.Gui.Key.A
+ name: A
+ href: api/Terminal.Gui/Terminal.Gui.Key.html#Terminal_Gui_Key_A
+ commentId: F:Terminal.Gui.Key.A
+ fullName: Terminal.Gui.Key.A
+ nameWithType: Key.A
- uid: Terminal.Gui.Key.AltMask
name: AltMask
href: api/Terminal.Gui/Terminal.Gui.Key.html#Terminal_Gui_Key_AltMask
commentId: F:Terminal.Gui.Key.AltMask
fullName: Terminal.Gui.Key.AltMask
nameWithType: Key.AltMask
+- uid: Terminal.Gui.Key.B
+ name: B
+ href: api/Terminal.Gui/Terminal.Gui.Key.html#Terminal_Gui_Key_B
+ commentId: F:Terminal.Gui.Key.B
+ fullName: Terminal.Gui.Key.B
+ nameWithType: Key.B
- uid: Terminal.Gui.Key.Backspace
name: Backspace
href: api/Terminal.Gui/Terminal.Gui.Key.html#Terminal_Gui_Key_Backspace
@@ -3883,174 +3889,18 @@ references:
commentId: F:Terminal.Gui.Key.BackTab
fullName: Terminal.Gui.Key.BackTab
nameWithType: Key.BackTab
+- uid: Terminal.Gui.Key.C
+ name: C
+ href: api/Terminal.Gui/Terminal.Gui.Key.html#Terminal_Gui_Key_C
+ commentId: F:Terminal.Gui.Key.C
+ fullName: Terminal.Gui.Key.C
+ nameWithType: Key.C
- uid: Terminal.Gui.Key.CharMask
name: CharMask
href: api/Terminal.Gui/Terminal.Gui.Key.html#Terminal_Gui_Key_CharMask
commentId: F:Terminal.Gui.Key.CharMask
fullName: Terminal.Gui.Key.CharMask
nameWithType: Key.CharMask
-- uid: Terminal.Gui.Key.ControlA
- name: ControlA
- href: api/Terminal.Gui/Terminal.Gui.Key.html#Terminal_Gui_Key_ControlA
- commentId: F:Terminal.Gui.Key.ControlA
- fullName: Terminal.Gui.Key.ControlA
- nameWithType: Key.ControlA
-- uid: Terminal.Gui.Key.ControlB
- name: ControlB
- href: api/Terminal.Gui/Terminal.Gui.Key.html#Terminal_Gui_Key_ControlB
- commentId: F:Terminal.Gui.Key.ControlB
- fullName: Terminal.Gui.Key.ControlB
- nameWithType: Key.ControlB
-- uid: Terminal.Gui.Key.ControlC
- name: ControlC
- href: api/Terminal.Gui/Terminal.Gui.Key.html#Terminal_Gui_Key_ControlC
- commentId: F:Terminal.Gui.Key.ControlC
- fullName: Terminal.Gui.Key.ControlC
- nameWithType: Key.ControlC
-- uid: Terminal.Gui.Key.ControlD
- name: ControlD
- href: api/Terminal.Gui/Terminal.Gui.Key.html#Terminal_Gui_Key_ControlD
- commentId: F:Terminal.Gui.Key.ControlD
- fullName: Terminal.Gui.Key.ControlD
- nameWithType: Key.ControlD
-- uid: Terminal.Gui.Key.ControlE
- name: ControlE
- href: api/Terminal.Gui/Terminal.Gui.Key.html#Terminal_Gui_Key_ControlE
- commentId: F:Terminal.Gui.Key.ControlE
- fullName: Terminal.Gui.Key.ControlE
- nameWithType: Key.ControlE
-- uid: Terminal.Gui.Key.ControlF
- name: ControlF
- href: api/Terminal.Gui/Terminal.Gui.Key.html#Terminal_Gui_Key_ControlF
- commentId: F:Terminal.Gui.Key.ControlF
- fullName: Terminal.Gui.Key.ControlF
- nameWithType: Key.ControlF
-- uid: Terminal.Gui.Key.ControlG
- name: ControlG
- href: api/Terminal.Gui/Terminal.Gui.Key.html#Terminal_Gui_Key_ControlG
- commentId: F:Terminal.Gui.Key.ControlG
- fullName: Terminal.Gui.Key.ControlG
- nameWithType: Key.ControlG
-- uid: Terminal.Gui.Key.ControlH
- name: ControlH
- href: api/Terminal.Gui/Terminal.Gui.Key.html#Terminal_Gui_Key_ControlH
- commentId: F:Terminal.Gui.Key.ControlH
- fullName: Terminal.Gui.Key.ControlH
- nameWithType: Key.ControlH
-- uid: Terminal.Gui.Key.ControlI
- name: ControlI
- href: api/Terminal.Gui/Terminal.Gui.Key.html#Terminal_Gui_Key_ControlI
- commentId: F:Terminal.Gui.Key.ControlI
- fullName: Terminal.Gui.Key.ControlI
- nameWithType: Key.ControlI
-- uid: Terminal.Gui.Key.ControlJ
- name: ControlJ
- href: api/Terminal.Gui/Terminal.Gui.Key.html#Terminal_Gui_Key_ControlJ
- commentId: F:Terminal.Gui.Key.ControlJ
- fullName: Terminal.Gui.Key.ControlJ
- nameWithType: Key.ControlJ
-- uid: Terminal.Gui.Key.ControlK
- name: ControlK
- href: api/Terminal.Gui/Terminal.Gui.Key.html#Terminal_Gui_Key_ControlK
- commentId: F:Terminal.Gui.Key.ControlK
- fullName: Terminal.Gui.Key.ControlK
- nameWithType: Key.ControlK
-- uid: Terminal.Gui.Key.ControlL
- name: ControlL
- href: api/Terminal.Gui/Terminal.Gui.Key.html#Terminal_Gui_Key_ControlL
- commentId: F:Terminal.Gui.Key.ControlL
- fullName: Terminal.Gui.Key.ControlL
- nameWithType: Key.ControlL
-- uid: Terminal.Gui.Key.ControlM
- name: ControlM
- href: api/Terminal.Gui/Terminal.Gui.Key.html#Terminal_Gui_Key_ControlM
- commentId: F:Terminal.Gui.Key.ControlM
- fullName: Terminal.Gui.Key.ControlM
- nameWithType: Key.ControlM
-- uid: Terminal.Gui.Key.ControlN
- name: ControlN
- href: api/Terminal.Gui/Terminal.Gui.Key.html#Terminal_Gui_Key_ControlN
- commentId: F:Terminal.Gui.Key.ControlN
- fullName: Terminal.Gui.Key.ControlN
- nameWithType: Key.ControlN
-- uid: Terminal.Gui.Key.ControlO
- name: ControlO
- href: api/Terminal.Gui/Terminal.Gui.Key.html#Terminal_Gui_Key_ControlO
- commentId: F:Terminal.Gui.Key.ControlO
- fullName: Terminal.Gui.Key.ControlO
- nameWithType: Key.ControlO
-- uid: Terminal.Gui.Key.ControlP
- name: ControlP
- href: api/Terminal.Gui/Terminal.Gui.Key.html#Terminal_Gui_Key_ControlP
- commentId: F:Terminal.Gui.Key.ControlP
- fullName: Terminal.Gui.Key.ControlP
- nameWithType: Key.ControlP
-- uid: Terminal.Gui.Key.ControlQ
- name: ControlQ
- href: api/Terminal.Gui/Terminal.Gui.Key.html#Terminal_Gui_Key_ControlQ
- commentId: F:Terminal.Gui.Key.ControlQ
- fullName: Terminal.Gui.Key.ControlQ
- nameWithType: Key.ControlQ
-- uid: Terminal.Gui.Key.ControlR
- name: ControlR
- href: api/Terminal.Gui/Terminal.Gui.Key.html#Terminal_Gui_Key_ControlR
- commentId: F:Terminal.Gui.Key.ControlR
- fullName: Terminal.Gui.Key.ControlR
- nameWithType: Key.ControlR
-- uid: Terminal.Gui.Key.ControlS
- name: ControlS
- href: api/Terminal.Gui/Terminal.Gui.Key.html#Terminal_Gui_Key_ControlS
- commentId: F:Terminal.Gui.Key.ControlS
- fullName: Terminal.Gui.Key.ControlS
- nameWithType: Key.ControlS
-- uid: Terminal.Gui.Key.ControlSpace
- name: ControlSpace
- href: api/Terminal.Gui/Terminal.Gui.Key.html#Terminal_Gui_Key_ControlSpace
- commentId: F:Terminal.Gui.Key.ControlSpace
- fullName: Terminal.Gui.Key.ControlSpace
- nameWithType: Key.ControlSpace
-- uid: Terminal.Gui.Key.ControlT
- name: ControlT
- href: api/Terminal.Gui/Terminal.Gui.Key.html#Terminal_Gui_Key_ControlT
- commentId: F:Terminal.Gui.Key.ControlT
- fullName: Terminal.Gui.Key.ControlT
- nameWithType: Key.ControlT
-- uid: Terminal.Gui.Key.ControlU
- name: ControlU
- href: api/Terminal.Gui/Terminal.Gui.Key.html#Terminal_Gui_Key_ControlU
- commentId: F:Terminal.Gui.Key.ControlU
- fullName: Terminal.Gui.Key.ControlU
- nameWithType: Key.ControlU
-- uid: Terminal.Gui.Key.ControlV
- name: ControlV
- href: api/Terminal.Gui/Terminal.Gui.Key.html#Terminal_Gui_Key_ControlV
- commentId: F:Terminal.Gui.Key.ControlV
- fullName: Terminal.Gui.Key.ControlV
- nameWithType: Key.ControlV
-- uid: Terminal.Gui.Key.ControlW
- name: ControlW
- href: api/Terminal.Gui/Terminal.Gui.Key.html#Terminal_Gui_Key_ControlW
- commentId: F:Terminal.Gui.Key.ControlW
- fullName: Terminal.Gui.Key.ControlW
- nameWithType: Key.ControlW
-- uid: Terminal.Gui.Key.ControlX
- name: ControlX
- href: api/Terminal.Gui/Terminal.Gui.Key.html#Terminal_Gui_Key_ControlX
- commentId: F:Terminal.Gui.Key.ControlX
- fullName: Terminal.Gui.Key.ControlX
- nameWithType: Key.ControlX
-- uid: Terminal.Gui.Key.ControlY
- name: ControlY
- href: api/Terminal.Gui/Terminal.Gui.Key.html#Terminal_Gui_Key_ControlY
- commentId: F:Terminal.Gui.Key.ControlY
- fullName: Terminal.Gui.Key.ControlY
- nameWithType: Key.ControlY
-- uid: Terminal.Gui.Key.ControlZ
- name: ControlZ
- href: api/Terminal.Gui/Terminal.Gui.Key.html#Terminal_Gui_Key_ControlZ
- commentId: F:Terminal.Gui.Key.ControlZ
- fullName: Terminal.Gui.Key.ControlZ
- nameWithType: Key.ControlZ
- uid: Terminal.Gui.Key.CtrlMask
name: CtrlMask
href: api/Terminal.Gui/Terminal.Gui.Key.html#Terminal_Gui_Key_CtrlMask
@@ -4081,6 +3931,72 @@ references:
commentId: F:Terminal.Gui.Key.CursorUp
fullName: Terminal.Gui.Key.CursorUp
nameWithType: Key.CursorUp
+- uid: Terminal.Gui.Key.D
+ name: D
+ href: api/Terminal.Gui/Terminal.Gui.Key.html#Terminal_Gui_Key_D
+ commentId: F:Terminal.Gui.Key.D
+ fullName: Terminal.Gui.Key.D
+ nameWithType: Key.D
+- uid: Terminal.Gui.Key.D0
+ name: D0
+ href: api/Terminal.Gui/Terminal.Gui.Key.html#Terminal_Gui_Key_D0
+ commentId: F:Terminal.Gui.Key.D0
+ fullName: Terminal.Gui.Key.D0
+ nameWithType: Key.D0
+- uid: Terminal.Gui.Key.D1
+ name: D1
+ href: api/Terminal.Gui/Terminal.Gui.Key.html#Terminal_Gui_Key_D1
+ commentId: F:Terminal.Gui.Key.D1
+ fullName: Terminal.Gui.Key.D1
+ nameWithType: Key.D1
+- uid: Terminal.Gui.Key.D2
+ name: D2
+ href: api/Terminal.Gui/Terminal.Gui.Key.html#Terminal_Gui_Key_D2
+ commentId: F:Terminal.Gui.Key.D2
+ fullName: Terminal.Gui.Key.D2
+ nameWithType: Key.D2
+- uid: Terminal.Gui.Key.D3
+ name: D3
+ href: api/Terminal.Gui/Terminal.Gui.Key.html#Terminal_Gui_Key_D3
+ commentId: F:Terminal.Gui.Key.D3
+ fullName: Terminal.Gui.Key.D3
+ nameWithType: Key.D3
+- uid: Terminal.Gui.Key.D4
+ name: D4
+ href: api/Terminal.Gui/Terminal.Gui.Key.html#Terminal_Gui_Key_D4
+ commentId: F:Terminal.Gui.Key.D4
+ fullName: Terminal.Gui.Key.D4
+ nameWithType: Key.D4
+- uid: Terminal.Gui.Key.D5
+ name: D5
+ href: api/Terminal.Gui/Terminal.Gui.Key.html#Terminal_Gui_Key_D5
+ commentId: F:Terminal.Gui.Key.D5
+ fullName: Terminal.Gui.Key.D5
+ nameWithType: Key.D5
+- uid: Terminal.Gui.Key.D6
+ name: D6
+ href: api/Terminal.Gui/Terminal.Gui.Key.html#Terminal_Gui_Key_D6
+ commentId: F:Terminal.Gui.Key.D6
+ fullName: Terminal.Gui.Key.D6
+ nameWithType: Key.D6
+- uid: Terminal.Gui.Key.D7
+ name: D7
+ href: api/Terminal.Gui/Terminal.Gui.Key.html#Terminal_Gui_Key_D7
+ commentId: F:Terminal.Gui.Key.D7
+ fullName: Terminal.Gui.Key.D7
+ nameWithType: Key.D7
+- uid: Terminal.Gui.Key.D8
+ name: D8
+ href: api/Terminal.Gui/Terminal.Gui.Key.html#Terminal_Gui_Key_D8
+ commentId: F:Terminal.Gui.Key.D8
+ fullName: Terminal.Gui.Key.D8
+ nameWithType: Key.D8
+- uid: Terminal.Gui.Key.D9
+ name: D9
+ href: api/Terminal.Gui/Terminal.Gui.Key.html#Terminal_Gui_Key_D9
+ commentId: F:Terminal.Gui.Key.D9
+ fullName: Terminal.Gui.Key.D9
+ nameWithType: Key.D9
- uid: Terminal.Gui.Key.Delete
name: Delete
href: api/Terminal.Gui/Terminal.Gui.Key.html#Terminal_Gui_Key_Delete
@@ -4093,6 +4009,12 @@ references:
commentId: F:Terminal.Gui.Key.DeleteChar
fullName: Terminal.Gui.Key.DeleteChar
nameWithType: Key.DeleteChar
+- uid: Terminal.Gui.Key.E
+ name: E
+ href: api/Terminal.Gui/Terminal.Gui.Key.html#Terminal_Gui_Key_E
+ commentId: F:Terminal.Gui.Key.E
+ fullName: Terminal.Gui.Key.E
+ nameWithType: Key.E
- uid: Terminal.Gui.Key.End
name: End
href: api/Terminal.Gui/Terminal.Gui.Key.html#Terminal_Gui_Key_End
@@ -4111,6 +4033,12 @@ references:
commentId: F:Terminal.Gui.Key.Esc
fullName: Terminal.Gui.Key.Esc
nameWithType: Key.Esc
+- uid: Terminal.Gui.Key.F
+ name: F
+ href: api/Terminal.Gui/Terminal.Gui.Key.html#Terminal_Gui_Key_F
+ commentId: F:Terminal.Gui.Key.F
+ fullName: Terminal.Gui.Key.F
+ nameWithType: Key.F
- uid: Terminal.Gui.Key.F1
name: F1
href: api/Terminal.Gui/Terminal.Gui.Key.html#Terminal_Gui_Key_F1
@@ -4183,18 +4111,84 @@ references:
commentId: F:Terminal.Gui.Key.F9
fullName: Terminal.Gui.Key.F9
nameWithType: Key.F9
+- uid: Terminal.Gui.Key.G
+ name: G
+ href: api/Terminal.Gui/Terminal.Gui.Key.html#Terminal_Gui_Key_G
+ commentId: F:Terminal.Gui.Key.G
+ fullName: Terminal.Gui.Key.G
+ nameWithType: Key.G
+- uid: Terminal.Gui.Key.H
+ name: H
+ href: api/Terminal.Gui/Terminal.Gui.Key.html#Terminal_Gui_Key_H
+ commentId: F:Terminal.Gui.Key.H
+ fullName: Terminal.Gui.Key.H
+ nameWithType: Key.H
- uid: Terminal.Gui.Key.Home
name: Home
href: api/Terminal.Gui/Terminal.Gui.Key.html#Terminal_Gui_Key_Home
commentId: F:Terminal.Gui.Key.Home
fullName: Terminal.Gui.Key.Home
nameWithType: Key.Home
+- uid: Terminal.Gui.Key.I
+ name: I
+ href: api/Terminal.Gui/Terminal.Gui.Key.html#Terminal_Gui_Key_I
+ commentId: F:Terminal.Gui.Key.I
+ fullName: Terminal.Gui.Key.I
+ nameWithType: Key.I
- uid: Terminal.Gui.Key.InsertChar
name: InsertChar
href: api/Terminal.Gui/Terminal.Gui.Key.html#Terminal_Gui_Key_InsertChar
commentId: F:Terminal.Gui.Key.InsertChar
fullName: Terminal.Gui.Key.InsertChar
nameWithType: Key.InsertChar
+- uid: Terminal.Gui.Key.J
+ name: J
+ href: api/Terminal.Gui/Terminal.Gui.Key.html#Terminal_Gui_Key_J
+ commentId: F:Terminal.Gui.Key.J
+ fullName: Terminal.Gui.Key.J
+ nameWithType: Key.J
+- uid: Terminal.Gui.Key.K
+ name: K
+ href: api/Terminal.Gui/Terminal.Gui.Key.html#Terminal_Gui_Key_K
+ commentId: F:Terminal.Gui.Key.K
+ fullName: Terminal.Gui.Key.K
+ nameWithType: Key.K
+- uid: Terminal.Gui.Key.L
+ name: L
+ href: api/Terminal.Gui/Terminal.Gui.Key.html#Terminal_Gui_Key_L
+ commentId: F:Terminal.Gui.Key.L
+ fullName: Terminal.Gui.Key.L
+ nameWithType: Key.L
+- uid: Terminal.Gui.Key.M
+ name: M
+ href: api/Terminal.Gui/Terminal.Gui.Key.html#Terminal_Gui_Key_M
+ commentId: F:Terminal.Gui.Key.M
+ fullName: Terminal.Gui.Key.M
+ nameWithType: Key.M
+- uid: Terminal.Gui.Key.N
+ name: N
+ href: api/Terminal.Gui/Terminal.Gui.Key.html#Terminal_Gui_Key_N
+ commentId: F:Terminal.Gui.Key.N
+ fullName: Terminal.Gui.Key.N
+ nameWithType: Key.N
+- uid: Terminal.Gui.Key.Null
+ name: "Null"
+ href: api/Terminal.Gui/Terminal.Gui.Key.html#Terminal_Gui_Key_Null
+ commentId: F:Terminal.Gui.Key.Null
+ fullName: Terminal.Gui.Key.Null
+ nameWithType: Key.Null
+- uid: Terminal.Gui.Key.O
+ name: O
+ href: api/Terminal.Gui/Terminal.Gui.Key.html#Terminal_Gui_Key_O
+ commentId: F:Terminal.Gui.Key.O
+ fullName: Terminal.Gui.Key.O
+ nameWithType: Key.O
+- uid: Terminal.Gui.Key.P
+ name: P
+ href: api/Terminal.Gui/Terminal.Gui.Key.html#Terminal_Gui_Key_P
+ commentId: F:Terminal.Gui.Key.P
+ fullName: Terminal.Gui.Key.P
+ nameWithType: Key.P
- uid: Terminal.Gui.Key.PageDown
name: PageDown
href: api/Terminal.Gui/Terminal.Gui.Key.html#Terminal_Gui_Key_PageDown
@@ -4207,6 +4201,24 @@ references:
commentId: F:Terminal.Gui.Key.PageUp
fullName: Terminal.Gui.Key.PageUp
nameWithType: Key.PageUp
+- uid: Terminal.Gui.Key.Q
+ name: Q
+ href: api/Terminal.Gui/Terminal.Gui.Key.html#Terminal_Gui_Key_Q
+ commentId: F:Terminal.Gui.Key.Q
+ fullName: Terminal.Gui.Key.Q
+ nameWithType: Key.Q
+- uid: Terminal.Gui.Key.R
+ name: R
+ href: api/Terminal.Gui/Terminal.Gui.Key.html#Terminal_Gui_Key_R
+ commentId: F:Terminal.Gui.Key.R
+ fullName: Terminal.Gui.Key.R
+ nameWithType: Key.R
+- uid: Terminal.Gui.Key.S
+ name: S
+ href: api/Terminal.Gui/Terminal.Gui.Key.html#Terminal_Gui_Key_S
+ commentId: F:Terminal.Gui.Key.S
+ fullName: Terminal.Gui.Key.S
+ nameWithType: Key.S
- uid: Terminal.Gui.Key.ShiftMask
name: ShiftMask
href: api/Terminal.Gui/Terminal.Gui.Key.html#Terminal_Gui_Key_ShiftMask
@@ -4225,18 +4237,60 @@ references:
commentId: F:Terminal.Gui.Key.SpecialMask
fullName: Terminal.Gui.Key.SpecialMask
nameWithType: Key.SpecialMask
+- uid: Terminal.Gui.Key.T
+ name: T
+ href: api/Terminal.Gui/Terminal.Gui.Key.html#Terminal_Gui_Key_T
+ commentId: F:Terminal.Gui.Key.T
+ fullName: Terminal.Gui.Key.T
+ nameWithType: Key.T
- uid: Terminal.Gui.Key.Tab
name: Tab
href: api/Terminal.Gui/Terminal.Gui.Key.html#Terminal_Gui_Key_Tab
commentId: F:Terminal.Gui.Key.Tab
fullName: Terminal.Gui.Key.Tab
nameWithType: Key.Tab
+- uid: Terminal.Gui.Key.U
+ name: U
+ href: api/Terminal.Gui/Terminal.Gui.Key.html#Terminal_Gui_Key_U
+ commentId: F:Terminal.Gui.Key.U
+ fullName: Terminal.Gui.Key.U
+ nameWithType: Key.U
- uid: Terminal.Gui.Key.Unknown
name: Unknown
href: api/Terminal.Gui/Terminal.Gui.Key.html#Terminal_Gui_Key_Unknown
commentId: F:Terminal.Gui.Key.Unknown
fullName: Terminal.Gui.Key.Unknown
nameWithType: Key.Unknown
+- uid: Terminal.Gui.Key.V
+ name: V
+ href: api/Terminal.Gui/Terminal.Gui.Key.html#Terminal_Gui_Key_V
+ commentId: F:Terminal.Gui.Key.V
+ fullName: Terminal.Gui.Key.V
+ nameWithType: Key.V
+- uid: Terminal.Gui.Key.W
+ name: W
+ href: api/Terminal.Gui/Terminal.Gui.Key.html#Terminal_Gui_Key_W
+ commentId: F:Terminal.Gui.Key.W
+ fullName: Terminal.Gui.Key.W
+ nameWithType: Key.W
+- uid: Terminal.Gui.Key.X
+ name: X
+ href: api/Terminal.Gui/Terminal.Gui.Key.html#Terminal_Gui_Key_X
+ commentId: F:Terminal.Gui.Key.X
+ fullName: Terminal.Gui.Key.X
+ nameWithType: Key.X
+- uid: Terminal.Gui.Key.Y
+ name: Y
+ href: api/Terminal.Gui/Terminal.Gui.Key.html#Terminal_Gui_Key_Y
+ commentId: F:Terminal.Gui.Key.Y
+ fullName: Terminal.Gui.Key.Y
+ nameWithType: Key.Y
+- uid: Terminal.Gui.Key.Z
+ name: Z
+ href: api/Terminal.Gui/Terminal.Gui.Key.html#Terminal_Gui_Key_Z
+ commentId: F:Terminal.Gui.Key.Z
+ fullName: Terminal.Gui.Key.Z
+ nameWithType: Key.Z
- uid: Terminal.Gui.KeyEvent
name: KeyEvent
href: api/Terminal.Gui/Terminal.Gui.KeyEvent.html
@@ -5331,6 +5385,19 @@ references:
isSpec: "True"
fullName: Terminal.Gui.MenuBar.PositionCursor
nameWithType: MenuBar.PositionCursor
+- uid: Terminal.Gui.MenuBar.ProcessColdKey(Terminal.Gui.KeyEvent)
+ name: ProcessColdKey(KeyEvent)
+ href: api/Terminal.Gui/Terminal.Gui.MenuBar.html#Terminal_Gui_MenuBar_ProcessColdKey_Terminal_Gui_KeyEvent_
+ commentId: M:Terminal.Gui.MenuBar.ProcessColdKey(Terminal.Gui.KeyEvent)
+ fullName: Terminal.Gui.MenuBar.ProcessColdKey(Terminal.Gui.KeyEvent)
+ nameWithType: MenuBar.ProcessColdKey(KeyEvent)
+- uid: Terminal.Gui.MenuBar.ProcessColdKey*
+ name: ProcessColdKey
+ href: api/Terminal.Gui/Terminal.Gui.MenuBar.html#Terminal_Gui_MenuBar_ProcessColdKey_
+ commentId: Overload:Terminal.Gui.MenuBar.ProcessColdKey
+ isSpec: "True"
+ fullName: Terminal.Gui.MenuBar.ProcessColdKey
+ nameWithType: MenuBar.ProcessColdKey
- uid: Terminal.Gui.MenuBar.ProcessHotKey(Terminal.Gui.KeyEvent)
name: ProcessHotKey(KeyEvent)
href: api/Terminal.Gui/Terminal.Gui.MenuBar.html#Terminal_Gui_MenuBar_ProcessHotKey_Terminal_Gui_KeyEvent_
@@ -5370,6 +5437,19 @@ references:
isSpec: "True"
fullName: Terminal.Gui.MenuBar.Redraw
nameWithType: MenuBar.Redraw
+- uid: Terminal.Gui.MenuBar.ShortcutDelimiter
+ name: ShortcutDelimiter
+ href: api/Terminal.Gui/Terminal.Gui.MenuBar.html#Terminal_Gui_MenuBar_ShortcutDelimiter
+ commentId: P:Terminal.Gui.MenuBar.ShortcutDelimiter
+ fullName: Terminal.Gui.MenuBar.ShortcutDelimiter
+ nameWithType: MenuBar.ShortcutDelimiter
+- uid: Terminal.Gui.MenuBar.ShortcutDelimiter*
+ name: ShortcutDelimiter
+ href: api/Terminal.Gui/Terminal.Gui.MenuBar.html#Terminal_Gui_MenuBar_ShortcutDelimiter_
+ commentId: Overload:Terminal.Gui.MenuBar.ShortcutDelimiter
+ isSpec: "True"
+ fullName: Terminal.Gui.MenuBar.ShortcutDelimiter
+ nameWithType: MenuBar.ShortcutDelimiter
- uid: Terminal.Gui.MenuBar.UseKeysUpDownAsKeysLeftRight
name: UseKeysUpDownAsKeysLeftRight
href: api/Terminal.Gui/Terminal.Gui.MenuBar.html#Terminal_Gui_MenuBar_UseKeysUpDownAsKeysLeftRight
@@ -5487,21 +5567,21 @@ references:
commentId: T:Terminal.Gui.MenuItem
fullName: Terminal.Gui.MenuItem
nameWithType: MenuItem
-- uid: Terminal.Gui.MenuItem.#ctor
- name: MenuItem()
- href: api/Terminal.Gui/Terminal.Gui.MenuItem.html#Terminal_Gui_MenuItem__ctor
- commentId: M:Terminal.Gui.MenuItem.#ctor
- fullName: Terminal.Gui.MenuItem.MenuItem()
- nameWithType: MenuItem.MenuItem()
-- uid: Terminal.Gui.MenuItem.#ctor(NStack.ustring,NStack.ustring,System.Action,System.Func{System.Boolean},Terminal.Gui.MenuItem)
- name: MenuItem(ustring, ustring, Action, Func, MenuItem)
- href: api/Terminal.Gui/Terminal.Gui.MenuItem.html#Terminal_Gui_MenuItem__ctor_NStack_ustring_NStack_ustring_System_Action_System_Func_System_Boolean__Terminal_Gui_MenuItem_
- commentId: M:Terminal.Gui.MenuItem.#ctor(NStack.ustring,NStack.ustring,System.Action,System.Func{System.Boolean},Terminal.Gui.MenuItem)
- name.vb: MenuItem(ustring, ustring, Action, Func(Of Boolean), MenuItem)
- fullName: Terminal.Gui.MenuItem.MenuItem(NStack.ustring, NStack.ustring, System.Action, System.Func, Terminal.Gui.MenuItem)
- fullName.vb: Terminal.Gui.MenuItem.MenuItem(NStack.ustring, NStack.ustring, System.Action, System.Func(Of System.Boolean), Terminal.Gui.MenuItem)
- nameWithType: MenuItem.MenuItem(ustring, ustring, Action, Func, MenuItem)
- nameWithType.vb: MenuItem.MenuItem(ustring, ustring, Action, Func(Of Boolean), MenuItem)
+- uid: Terminal.Gui.MenuItem.#ctor(NStack.ustring,NStack.ustring,System.Action,System.Func{System.Boolean},Terminal.Gui.MenuItem,Terminal.Gui.Key)
+ name: MenuItem(ustring, ustring, Action, Func, MenuItem, Key)
+ href: api/Terminal.Gui/Terminal.Gui.MenuItem.html#Terminal_Gui_MenuItem__ctor_NStack_ustring_NStack_ustring_System_Action_System_Func_System_Boolean__Terminal_Gui_MenuItem_Terminal_Gui_Key_
+ commentId: M:Terminal.Gui.MenuItem.#ctor(NStack.ustring,NStack.ustring,System.Action,System.Func{System.Boolean},Terminal.Gui.MenuItem,Terminal.Gui.Key)
+ name.vb: MenuItem(ustring, ustring, Action, Func(Of Boolean), MenuItem, Key)
+ fullName: Terminal.Gui.MenuItem.MenuItem(NStack.ustring, NStack.ustring, System.Action, System.Func, Terminal.Gui.MenuItem, Terminal.Gui.Key)
+ fullName.vb: Terminal.Gui.MenuItem.MenuItem(NStack.ustring, NStack.ustring, System.Action, System.Func(Of System.Boolean), Terminal.Gui.MenuItem, Terminal.Gui.Key)
+ nameWithType: MenuItem.MenuItem(ustring, ustring, Action, Func, MenuItem, Key)
+ nameWithType.vb: MenuItem.MenuItem(ustring, ustring, Action, Func(Of Boolean), MenuItem, Key)
+- uid: Terminal.Gui.MenuItem.#ctor(Terminal.Gui.Key)
+ name: MenuItem(Key)
+ href: api/Terminal.Gui/Terminal.Gui.MenuItem.html#Terminal_Gui_MenuItem__ctor_Terminal_Gui_Key_
+ commentId: M:Terminal.Gui.MenuItem.#ctor(Terminal.Gui.Key)
+ fullName: Terminal.Gui.MenuItem.MenuItem(Terminal.Gui.Key)
+ nameWithType: MenuItem.MenuItem(Key)
- uid: Terminal.Gui.MenuItem.#ctor*
name: MenuItem
href: api/Terminal.Gui/Terminal.Gui.MenuItem.html#Terminal_Gui_MenuItem__ctor_
@@ -5632,6 +5712,32 @@ references:
isSpec: "True"
fullName: Terminal.Gui.MenuItem.Parent
nameWithType: MenuItem.Parent
+- uid: Terminal.Gui.MenuItem.Shortcut
+ name: Shortcut
+ href: api/Terminal.Gui/Terminal.Gui.MenuItem.html#Terminal_Gui_MenuItem_Shortcut
+ commentId: P:Terminal.Gui.MenuItem.Shortcut
+ fullName: Terminal.Gui.MenuItem.Shortcut
+ nameWithType: MenuItem.Shortcut
+- uid: Terminal.Gui.MenuItem.Shortcut*
+ name: Shortcut
+ href: api/Terminal.Gui/Terminal.Gui.MenuItem.html#Terminal_Gui_MenuItem_Shortcut_
+ commentId: Overload:Terminal.Gui.MenuItem.Shortcut
+ isSpec: "True"
+ fullName: Terminal.Gui.MenuItem.Shortcut
+ nameWithType: MenuItem.Shortcut
+- uid: Terminal.Gui.MenuItem.ShortcutTag
+ name: ShortcutTag
+ href: api/Terminal.Gui/Terminal.Gui.MenuItem.html#Terminal_Gui_MenuItem_ShortcutTag
+ commentId: P:Terminal.Gui.MenuItem.ShortcutTag
+ fullName: Terminal.Gui.MenuItem.ShortcutTag
+ nameWithType: MenuItem.ShortcutTag
+- uid: Terminal.Gui.MenuItem.ShortcutTag*
+ name: ShortcutTag
+ href: api/Terminal.Gui/Terminal.Gui.MenuItem.html#Terminal_Gui_MenuItem_ShortcutTag_
+ commentId: Overload:Terminal.Gui.MenuItem.ShortcutTag
+ isSpec: "True"
+ fullName: Terminal.Gui.MenuItem.ShortcutTag
+ nameWithType: MenuItem.ShortcutTag
- uid: Terminal.Gui.MenuItem.Title
name: Title
href: api/Terminal.Gui/Terminal.Gui.MenuItem.html#Terminal_Gui_MenuItem_Title
@@ -7767,6 +7873,158 @@ references:
isSpec: "True"
fullName: Terminal.Gui.ScrollView.ShowVerticalScrollIndicator
nameWithType: ScrollView.ShowVerticalScrollIndicator
+- uid: Terminal.Gui.ShortcutHelper
+ name: ShortcutHelper
+ href: api/Terminal.Gui/Terminal.Gui.ShortcutHelper.html
+ commentId: T:Terminal.Gui.ShortcutHelper
+ fullName: Terminal.Gui.ShortcutHelper
+ nameWithType: ShortcutHelper
+- uid: Terminal.Gui.ShortcutHelper.CheckKeysFlagRange(Terminal.Gui.Key,Terminal.Gui.Key,Terminal.Gui.Key)
+ name: CheckKeysFlagRange(Key, Key, Key)
+ href: api/Terminal.Gui/Terminal.Gui.ShortcutHelper.html#Terminal_Gui_ShortcutHelper_CheckKeysFlagRange_Terminal_Gui_Key_Terminal_Gui_Key_Terminal_Gui_Key_
+ commentId: M:Terminal.Gui.ShortcutHelper.CheckKeysFlagRange(Terminal.Gui.Key,Terminal.Gui.Key,Terminal.Gui.Key)
+ fullName: Terminal.Gui.ShortcutHelper.CheckKeysFlagRange(Terminal.Gui.Key, Terminal.Gui.Key, Terminal.Gui.Key)
+ nameWithType: ShortcutHelper.CheckKeysFlagRange(Key, Key, Key)
+- uid: Terminal.Gui.ShortcutHelper.CheckKeysFlagRange*
+ name: CheckKeysFlagRange
+ href: api/Terminal.Gui/Terminal.Gui.ShortcutHelper.html#Terminal_Gui_ShortcutHelper_CheckKeysFlagRange_
+ commentId: Overload:Terminal.Gui.ShortcutHelper.CheckKeysFlagRange
+ isSpec: "True"
+ fullName: Terminal.Gui.ShortcutHelper.CheckKeysFlagRange
+ nameWithType: ShortcutHelper.CheckKeysFlagRange
+- uid: Terminal.Gui.ShortcutHelper.FindAndOpenByShortcut(Terminal.Gui.KeyEvent,Terminal.Gui.View)
+ name: FindAndOpenByShortcut(KeyEvent, View)
+ href: api/Terminal.Gui/Terminal.Gui.ShortcutHelper.html#Terminal_Gui_ShortcutHelper_FindAndOpenByShortcut_Terminal_Gui_KeyEvent_Terminal_Gui_View_
+ commentId: M:Terminal.Gui.ShortcutHelper.FindAndOpenByShortcut(Terminal.Gui.KeyEvent,Terminal.Gui.View)
+ fullName: Terminal.Gui.ShortcutHelper.FindAndOpenByShortcut(Terminal.Gui.KeyEvent, Terminal.Gui.View)
+ nameWithType: ShortcutHelper.FindAndOpenByShortcut(KeyEvent, View)
+- uid: Terminal.Gui.ShortcutHelper.FindAndOpenByShortcut*
+ name: FindAndOpenByShortcut
+ href: api/Terminal.Gui/Terminal.Gui.ShortcutHelper.html#Terminal_Gui_ShortcutHelper_FindAndOpenByShortcut_
+ commentId: Overload:Terminal.Gui.ShortcutHelper.FindAndOpenByShortcut
+ isSpec: "True"
+ fullName: Terminal.Gui.ShortcutHelper.FindAndOpenByShortcut
+ nameWithType: ShortcutHelper.FindAndOpenByShortcut
+- uid: Terminal.Gui.ShortcutHelper.GetKeyToString(Terminal.Gui.Key,Terminal.Gui.Key@)
+ name: GetKeyToString(Key, out Key)
+ href: api/Terminal.Gui/Terminal.Gui.ShortcutHelper.html#Terminal_Gui_ShortcutHelper_GetKeyToString_Terminal_Gui_Key_Terminal_Gui_Key__
+ commentId: M:Terminal.Gui.ShortcutHelper.GetKeyToString(Terminal.Gui.Key,Terminal.Gui.Key@)
+ name.vb: GetKeyToString(Key, ByRef Key)
+ fullName: Terminal.Gui.ShortcutHelper.GetKeyToString(Terminal.Gui.Key, out Terminal.Gui.Key)
+ fullName.vb: Terminal.Gui.ShortcutHelper.GetKeyToString(Terminal.Gui.Key, ByRef Terminal.Gui.Key)
+ nameWithType: ShortcutHelper.GetKeyToString(Key, out Key)
+ nameWithType.vb: ShortcutHelper.GetKeyToString(Key, ByRef Key)
+- uid: Terminal.Gui.ShortcutHelper.GetKeyToString*
+ name: GetKeyToString
+ href: api/Terminal.Gui/Terminal.Gui.ShortcutHelper.html#Terminal_Gui_ShortcutHelper_GetKeyToString_
+ commentId: Overload:Terminal.Gui.ShortcutHelper.GetKeyToString
+ isSpec: "True"
+ fullName: Terminal.Gui.ShortcutHelper.GetKeyToString
+ nameWithType: ShortcutHelper.GetKeyToString
+- uid: Terminal.Gui.ShortcutHelper.GetModifiersKey(Terminal.Gui.KeyEvent)
+ name: GetModifiersKey(KeyEvent)
+ href: api/Terminal.Gui/Terminal.Gui.ShortcutHelper.html#Terminal_Gui_ShortcutHelper_GetModifiersKey_Terminal_Gui_KeyEvent_
+ commentId: M:Terminal.Gui.ShortcutHelper.GetModifiersKey(Terminal.Gui.KeyEvent)
+ fullName: Terminal.Gui.ShortcutHelper.GetModifiersKey(Terminal.Gui.KeyEvent)
+ nameWithType: ShortcutHelper.GetModifiersKey(KeyEvent)
+- uid: Terminal.Gui.ShortcutHelper.GetModifiersKey*
+ name: GetModifiersKey
+ href: api/Terminal.Gui/Terminal.Gui.ShortcutHelper.html#Terminal_Gui_ShortcutHelper_GetModifiersKey_
+ commentId: Overload:Terminal.Gui.ShortcutHelper.GetModifiersKey
+ isSpec: "True"
+ fullName: Terminal.Gui.ShortcutHelper.GetModifiersKey
+ nameWithType: ShortcutHelper.GetModifiersKey
+- uid: Terminal.Gui.ShortcutHelper.GetShortcutFromTag(NStack.ustring)
+ name: GetShortcutFromTag(ustring)
+ href: api/Terminal.Gui/Terminal.Gui.ShortcutHelper.html#Terminal_Gui_ShortcutHelper_GetShortcutFromTag_NStack_ustring_
+ commentId: M:Terminal.Gui.ShortcutHelper.GetShortcutFromTag(NStack.ustring)
+ fullName: Terminal.Gui.ShortcutHelper.GetShortcutFromTag(NStack.ustring)
+ nameWithType: ShortcutHelper.GetShortcutFromTag(ustring)
+- uid: Terminal.Gui.ShortcutHelper.GetShortcutFromTag*
+ name: GetShortcutFromTag
+ href: api/Terminal.Gui/Terminal.Gui.ShortcutHelper.html#Terminal_Gui_ShortcutHelper_GetShortcutFromTag_
+ commentId: Overload:Terminal.Gui.ShortcutHelper.GetShortcutFromTag
+ isSpec: "True"
+ fullName: Terminal.Gui.ShortcutHelper.GetShortcutFromTag
+ nameWithType: ShortcutHelper.GetShortcutFromTag
+- uid: Terminal.Gui.ShortcutHelper.GetShortcutTag(Terminal.Gui.Key)
+ name: GetShortcutTag(Key)
+ href: api/Terminal.Gui/Terminal.Gui.ShortcutHelper.html#Terminal_Gui_ShortcutHelper_GetShortcutTag_Terminal_Gui_Key_
+ commentId: M:Terminal.Gui.ShortcutHelper.GetShortcutTag(Terminal.Gui.Key)
+ fullName: Terminal.Gui.ShortcutHelper.GetShortcutTag(Terminal.Gui.Key)
+ nameWithType: ShortcutHelper.GetShortcutTag(Key)
+- uid: Terminal.Gui.ShortcutHelper.GetShortcutTag*
+ name: GetShortcutTag
+ href: api/Terminal.Gui/Terminal.Gui.ShortcutHelper.html#Terminal_Gui_ShortcutHelper_GetShortcutTag_
+ commentId: Overload:Terminal.Gui.ShortcutHelper.GetShortcutTag
+ isSpec: "True"
+ fullName: Terminal.Gui.ShortcutHelper.GetShortcutTag
+ nameWithType: ShortcutHelper.GetShortcutTag
+- uid: Terminal.Gui.ShortcutHelper.PostShortcutValidation(Terminal.Gui.Key)
+ name: PostShortcutValidation(Key)
+ href: api/Terminal.Gui/Terminal.Gui.ShortcutHelper.html#Terminal_Gui_ShortcutHelper_PostShortcutValidation_Terminal_Gui_Key_
+ commentId: M:Terminal.Gui.ShortcutHelper.PostShortcutValidation(Terminal.Gui.Key)
+ fullName: Terminal.Gui.ShortcutHelper.PostShortcutValidation(Terminal.Gui.Key)
+ nameWithType: ShortcutHelper.PostShortcutValidation(Key)
+- uid: Terminal.Gui.ShortcutHelper.PostShortcutValidation*
+ name: PostShortcutValidation
+ href: api/Terminal.Gui/Terminal.Gui.ShortcutHelper.html#Terminal_Gui_ShortcutHelper_PostShortcutValidation_
+ commentId: Overload:Terminal.Gui.ShortcutHelper.PostShortcutValidation
+ isSpec: "True"
+ fullName: Terminal.Gui.ShortcutHelper.PostShortcutValidation
+ nameWithType: ShortcutHelper.PostShortcutValidation
+- uid: Terminal.Gui.ShortcutHelper.PreShortcutValidation(Terminal.Gui.Key)
+ name: PreShortcutValidation(Key)
+ href: api/Terminal.Gui/Terminal.Gui.ShortcutHelper.html#Terminal_Gui_ShortcutHelper_PreShortcutValidation_Terminal_Gui_Key_
+ commentId: M:Terminal.Gui.ShortcutHelper.PreShortcutValidation(Terminal.Gui.Key)
+ fullName: Terminal.Gui.ShortcutHelper.PreShortcutValidation(Terminal.Gui.Key)
+ nameWithType: ShortcutHelper.PreShortcutValidation(Key)
+- uid: Terminal.Gui.ShortcutHelper.PreShortcutValidation*
+ name: PreShortcutValidation
+ href: api/Terminal.Gui/Terminal.Gui.ShortcutHelper.html#Terminal_Gui_ShortcutHelper_PreShortcutValidation_
+ commentId: Overload:Terminal.Gui.ShortcutHelper.PreShortcutValidation
+ isSpec: "True"
+ fullName: Terminal.Gui.ShortcutHelper.PreShortcutValidation
+ nameWithType: ShortcutHelper.PreShortcutValidation
+- uid: Terminal.Gui.ShortcutHelper.Shortcut
+ name: Shortcut
+ href: api/Terminal.Gui/Terminal.Gui.ShortcutHelper.html#Terminal_Gui_ShortcutHelper_Shortcut
+ commentId: P:Terminal.Gui.ShortcutHelper.Shortcut
+ fullName: Terminal.Gui.ShortcutHelper.Shortcut
+ nameWithType: ShortcutHelper.Shortcut
+- uid: Terminal.Gui.ShortcutHelper.Shortcut*
+ name: Shortcut
+ href: api/Terminal.Gui/Terminal.Gui.ShortcutHelper.html#Terminal_Gui_ShortcutHelper_Shortcut_
+ commentId: Overload:Terminal.Gui.ShortcutHelper.Shortcut
+ isSpec: "True"
+ fullName: Terminal.Gui.ShortcutHelper.Shortcut
+ nameWithType: ShortcutHelper.Shortcut
+- uid: Terminal.Gui.ShortcutHelper.ShortcutAction
+ name: ShortcutAction
+ href: api/Terminal.Gui/Terminal.Gui.ShortcutHelper.html#Terminal_Gui_ShortcutHelper_ShortcutAction
+ commentId: P:Terminal.Gui.ShortcutHelper.ShortcutAction
+ fullName: Terminal.Gui.ShortcutHelper.ShortcutAction
+ nameWithType: ShortcutHelper.ShortcutAction
+- uid: Terminal.Gui.ShortcutHelper.ShortcutAction*
+ name: ShortcutAction
+ href: api/Terminal.Gui/Terminal.Gui.ShortcutHelper.html#Terminal_Gui_ShortcutHelper_ShortcutAction_
+ commentId: Overload:Terminal.Gui.ShortcutHelper.ShortcutAction
+ isSpec: "True"
+ fullName: Terminal.Gui.ShortcutHelper.ShortcutAction
+ nameWithType: ShortcutHelper.ShortcutAction
+- uid: Terminal.Gui.ShortcutHelper.ShortcutTag
+ name: ShortcutTag
+ href: api/Terminal.Gui/Terminal.Gui.ShortcutHelper.html#Terminal_Gui_ShortcutHelper_ShortcutTag
+ commentId: P:Terminal.Gui.ShortcutHelper.ShortcutTag
+ fullName: Terminal.Gui.ShortcutHelper.ShortcutTag
+ nameWithType: ShortcutHelper.ShortcutTag
+- uid: Terminal.Gui.ShortcutHelper.ShortcutTag*
+ name: ShortcutTag
+ href: api/Terminal.Gui/Terminal.Gui.ShortcutHelper.html#Terminal_Gui_ShortcutHelper_ShortcutTag_
+ commentId: Overload:Terminal.Gui.ShortcutHelper.ShortcutTag
+ isSpec: "True"
+ fullName: Terminal.Gui.ShortcutHelper.ShortcutTag
+ nameWithType: ShortcutHelper.ShortcutTag
- uid: Terminal.Gui.Size
name: Size
href: api/Terminal.Gui/Terminal.Gui.Size.html
@@ -8154,6 +8412,51 @@ references:
commentId: F:Terminal.Gui.TextAlignment.Right
fullName: Terminal.Gui.TextAlignment.Right
nameWithType: TextAlignment.Right
+- uid: Terminal.Gui.TextChangingEventArgs
+ name: TextChangingEventArgs
+ href: api/Terminal.Gui/Terminal.Gui.TextChangingEventArgs.html
+ commentId: T:Terminal.Gui.TextChangingEventArgs
+ fullName: Terminal.Gui.TextChangingEventArgs
+ nameWithType: TextChangingEventArgs
+- uid: Terminal.Gui.TextChangingEventArgs.#ctor(NStack.ustring)
+ name: TextChangingEventArgs(ustring)
+ href: api/Terminal.Gui/Terminal.Gui.TextChangingEventArgs.html#Terminal_Gui_TextChangingEventArgs__ctor_NStack_ustring_
+ commentId: M:Terminal.Gui.TextChangingEventArgs.#ctor(NStack.ustring)
+ fullName: Terminal.Gui.TextChangingEventArgs.TextChangingEventArgs(NStack.ustring)
+ nameWithType: TextChangingEventArgs.TextChangingEventArgs(ustring)
+- uid: Terminal.Gui.TextChangingEventArgs.#ctor*
+ name: TextChangingEventArgs
+ href: api/Terminal.Gui/Terminal.Gui.TextChangingEventArgs.html#Terminal_Gui_TextChangingEventArgs__ctor_
+ commentId: Overload:Terminal.Gui.TextChangingEventArgs.#ctor
+ isSpec: "True"
+ fullName: Terminal.Gui.TextChangingEventArgs.TextChangingEventArgs
+ nameWithType: TextChangingEventArgs.TextChangingEventArgs
+- uid: Terminal.Gui.TextChangingEventArgs.Cancel
+ name: Cancel
+ href: api/Terminal.Gui/Terminal.Gui.TextChangingEventArgs.html#Terminal_Gui_TextChangingEventArgs_Cancel
+ commentId: P:Terminal.Gui.TextChangingEventArgs.Cancel
+ fullName: Terminal.Gui.TextChangingEventArgs.Cancel
+ nameWithType: TextChangingEventArgs.Cancel
+- uid: Terminal.Gui.TextChangingEventArgs.Cancel*
+ name: Cancel
+ href: api/Terminal.Gui/Terminal.Gui.TextChangingEventArgs.html#Terminal_Gui_TextChangingEventArgs_Cancel_
+ commentId: Overload:Terminal.Gui.TextChangingEventArgs.Cancel
+ isSpec: "True"
+ fullName: Terminal.Gui.TextChangingEventArgs.Cancel
+ nameWithType: TextChangingEventArgs.Cancel
+- uid: Terminal.Gui.TextChangingEventArgs.NewText
+ name: NewText
+ href: api/Terminal.Gui/Terminal.Gui.TextChangingEventArgs.html#Terminal_Gui_TextChangingEventArgs_NewText
+ commentId: P:Terminal.Gui.TextChangingEventArgs.NewText
+ fullName: Terminal.Gui.TextChangingEventArgs.NewText
+ nameWithType: TextChangingEventArgs.NewText
+- uid: Terminal.Gui.TextChangingEventArgs.NewText*
+ name: NewText
+ href: api/Terminal.Gui/Terminal.Gui.TextChangingEventArgs.html#Terminal_Gui_TextChangingEventArgs_NewText_
+ commentId: Overload:Terminal.Gui.TextChangingEventArgs.NewText
+ isSpec: "True"
+ fullName: Terminal.Gui.TextChangingEventArgs.NewText
+ nameWithType: TextChangingEventArgs.NewText
- uid: Terminal.Gui.TextField
name: TextField
href: api/Terminal.Gui/Terminal.Gui.TextField.html
@@ -8295,6 +8598,19 @@ references:
isSpec: "True"
fullName: Terminal.Gui.TextField.OnLeave
nameWithType: TextField.OnLeave
+- uid: Terminal.Gui.TextField.OnTextChanging(NStack.ustring)
+ name: OnTextChanging(ustring)
+ href: api/Terminal.Gui/Terminal.Gui.TextField.html#Terminal_Gui_TextField_OnTextChanging_NStack_ustring_
+ commentId: M:Terminal.Gui.TextField.OnTextChanging(NStack.ustring)
+ fullName: Terminal.Gui.TextField.OnTextChanging(NStack.ustring)
+ nameWithType: TextField.OnTextChanging(ustring)
+- uid: Terminal.Gui.TextField.OnTextChanging*
+ name: OnTextChanging
+ href: api/Terminal.Gui/Terminal.Gui.TextField.html#Terminal_Gui_TextField_OnTextChanging_
+ commentId: Overload:Terminal.Gui.TextField.OnTextChanging
+ isSpec: "True"
+ fullName: Terminal.Gui.TextField.OnTextChanging
+ nameWithType: TextField.OnTextChanging
- uid: Terminal.Gui.TextField.Paste
name: Paste()
href: api/Terminal.Gui/Terminal.Gui.TextField.html#Terminal_Gui_TextField_Paste
@@ -8431,6 +8747,12 @@ references:
commentId: E:Terminal.Gui.TextField.TextChanged
fullName: Terminal.Gui.TextField.TextChanged
nameWithType: TextField.TextChanged
+- uid: Terminal.Gui.TextField.TextChanging
+ name: TextChanging
+ href: api/Terminal.Gui/Terminal.Gui.TextField.html#Terminal_Gui_TextField_TextChanging
+ commentId: E:Terminal.Gui.TextField.TextChanging
+ fullName: Terminal.Gui.TextField.TextChanging
+ nameWithType: TextField.TextChanging
- uid: Terminal.Gui.TextField.Used
name: Used
href: api/Terminal.Gui/Terminal.Gui.TextField.html#Terminal_Gui_TextField_Used
@@ -9121,6 +9443,12 @@ references:
isSpec: "True"
fullName: Terminal.Gui.Toplevel.Create
nameWithType: Toplevel.Create
+- uid: Terminal.Gui.Toplevel.Loaded
+ name: Loaded
+ href: api/Terminal.Gui/Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_Loaded
+ commentId: E:Terminal.Gui.Toplevel.Loaded
+ fullName: Terminal.Gui.Toplevel.Loaded
+ nameWithType: Toplevel.Loaded
- uid: Terminal.Gui.Toplevel.MenuBar
name: MenuBar
href: api/Terminal.Gui/Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_MenuBar
@@ -9173,6 +9501,19 @@ references:
isSpec: "True"
fullName: Terminal.Gui.Toplevel.OnKeyUp
nameWithType: Toplevel.OnKeyUp
+- uid: Terminal.Gui.Toplevel.ProcessColdKey(Terminal.Gui.KeyEvent)
+ name: ProcessColdKey(KeyEvent)
+ href: api/Terminal.Gui/Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_ProcessColdKey_Terminal_Gui_KeyEvent_
+ commentId: M:Terminal.Gui.Toplevel.ProcessColdKey(Terminal.Gui.KeyEvent)
+ fullName: Terminal.Gui.Toplevel.ProcessColdKey(Terminal.Gui.KeyEvent)
+ nameWithType: Toplevel.ProcessColdKey(KeyEvent)
+- uid: Terminal.Gui.Toplevel.ProcessColdKey*
+ name: ProcessColdKey
+ href: api/Terminal.Gui/Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_ProcessColdKey_
+ commentId: Overload:Terminal.Gui.Toplevel.ProcessColdKey
+ isSpec: "True"
+ fullName: Terminal.Gui.Toplevel.ProcessColdKey
+ nameWithType: Toplevel.ProcessColdKey
- uid: Terminal.Gui.Toplevel.ProcessKey(Terminal.Gui.KeyEvent)
name: ProcessKey(KeyEvent)
href: api/Terminal.Gui/Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_ProcessKey_Terminal_Gui_KeyEvent_
@@ -9257,6 +9598,12 @@ references:
isSpec: "True"
fullName: Terminal.Gui.Toplevel.StatusBar
nameWithType: Toplevel.StatusBar
+- uid: Terminal.Gui.Toplevel.Unloaded
+ name: Unloaded
+ href: api/Terminal.Gui/Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_Unloaded
+ commentId: E:Terminal.Gui.Toplevel.Unloaded
+ fullName: Terminal.Gui.Toplevel.Unloaded
+ nameWithType: Toplevel.Unloaded
- uid: Terminal.Gui.Toplevel.WillPresent
name: WillPresent()
href: api/Terminal.Gui/Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_WillPresent
@@ -9354,6 +9701,19 @@ references:
isSpec: "True"
fullName: Terminal.Gui.View.AddRune
nameWithType: View.AddRune
+- uid: Terminal.Gui.View.AutoSize
+ name: AutoSize
+ href: api/Terminal.Gui/Terminal.Gui.View.html#Terminal_Gui_View_AutoSize
+ commentId: P:Terminal.Gui.View.AutoSize
+ fullName: Terminal.Gui.View.AutoSize
+ nameWithType: View.AutoSize
+- uid: Terminal.Gui.View.AutoSize*
+ name: AutoSize
+ href: api/Terminal.Gui/Terminal.Gui.View.html#Terminal_Gui_View_AutoSize_
+ commentId: Overload:Terminal.Gui.View.AutoSize
+ isSpec: "True"
+ fullName: Terminal.Gui.View.AutoSize
+ nameWithType: View.AutoSize
- uid: Terminal.Gui.View.BeginInit
name: BeginInit()
href: api/Terminal.Gui/Terminal.Gui.View.html#Terminal_Gui_View_BeginInit
@@ -10358,6 +10718,45 @@ references:
isSpec: "True"
fullName: Terminal.Gui.View.SetNeedsDisplay
nameWithType: View.SetNeedsDisplay
+- uid: Terminal.Gui.View.Shortcut
+ name: Shortcut
+ href: api/Terminal.Gui/Terminal.Gui.View.html#Terminal_Gui_View_Shortcut
+ commentId: P:Terminal.Gui.View.Shortcut
+ fullName: Terminal.Gui.View.Shortcut
+ nameWithType: View.Shortcut
+- uid: Terminal.Gui.View.Shortcut*
+ name: Shortcut
+ href: api/Terminal.Gui/Terminal.Gui.View.html#Terminal_Gui_View_Shortcut_
+ commentId: Overload:Terminal.Gui.View.Shortcut
+ isSpec: "True"
+ fullName: Terminal.Gui.View.Shortcut
+ nameWithType: View.Shortcut
+- uid: Terminal.Gui.View.ShortcutAction
+ name: ShortcutAction
+ href: api/Terminal.Gui/Terminal.Gui.View.html#Terminal_Gui_View_ShortcutAction
+ commentId: P:Terminal.Gui.View.ShortcutAction
+ fullName: Terminal.Gui.View.ShortcutAction
+ nameWithType: View.ShortcutAction
+- uid: Terminal.Gui.View.ShortcutAction*
+ name: ShortcutAction
+ href: api/Terminal.Gui/Terminal.Gui.View.html#Terminal_Gui_View_ShortcutAction_
+ commentId: Overload:Terminal.Gui.View.ShortcutAction
+ isSpec: "True"
+ fullName: Terminal.Gui.View.ShortcutAction
+ nameWithType: View.ShortcutAction
+- uid: Terminal.Gui.View.ShortcutTag
+ name: ShortcutTag
+ href: api/Terminal.Gui/Terminal.Gui.View.html#Terminal_Gui_View_ShortcutTag
+ commentId: P:Terminal.Gui.View.ShortcutTag
+ fullName: Terminal.Gui.View.ShortcutTag
+ nameWithType: View.ShortcutTag
+- uid: Terminal.Gui.View.ShortcutTag*
+ name: ShortcutTag
+ href: api/Terminal.Gui/Terminal.Gui.View.html#Terminal_Gui_View_ShortcutTag_
+ commentId: Overload:Terminal.Gui.View.ShortcutTag
+ isSpec: "True"
+ fullName: Terminal.Gui.View.ShortcutTag
+ nameWithType: View.ShortcutTag
- uid: Terminal.Gui.View.Subviews
name: Subviews
href: api/Terminal.Gui/Terminal.Gui.View.html#Terminal_Gui_View_Subviews
@@ -10764,6 +11163,380 @@ references:
isSpec: "True"
fullName: UICatalog.Binding.TargetPropertyName
nameWithType: Binding.TargetPropertyName
+- uid: UICatalog.DynamicMenuBarDetails
+ name: DynamicMenuBarDetails
+ href: api/UICatalog/UICatalog.DynamicMenuBarDetails.html
+ commentId: T:UICatalog.DynamicMenuBarDetails
+ fullName: UICatalog.DynamicMenuBarDetails
+ nameWithType: DynamicMenuBarDetails
+- uid: UICatalog.DynamicMenuBarDetails.#ctor(Terminal.Gui.MenuItem,System.Boolean)
+ name: DynamicMenuBarDetails(MenuItem, Boolean)
+ href: api/UICatalog/UICatalog.DynamicMenuBarDetails.html#UICatalog_DynamicMenuBarDetails__ctor_Terminal_Gui_MenuItem_System_Boolean_
+ commentId: M:UICatalog.DynamicMenuBarDetails.#ctor(Terminal.Gui.MenuItem,System.Boolean)
+ fullName: UICatalog.DynamicMenuBarDetails.DynamicMenuBarDetails(Terminal.Gui.MenuItem, System.Boolean)
+ nameWithType: DynamicMenuBarDetails.DynamicMenuBarDetails(MenuItem, Boolean)
+- uid: UICatalog.DynamicMenuBarDetails.#ctor(ustring)
+ name: DynamicMenuBarDetails(ustring)
+ href: api/UICatalog/UICatalog.DynamicMenuBarDetails.html#UICatalog_DynamicMenuBarDetails__ctor_ustring_
+ commentId: M:UICatalog.DynamicMenuBarDetails.#ctor(ustring)
+ fullName: UICatalog.DynamicMenuBarDetails.DynamicMenuBarDetails(ustring)
+ nameWithType: DynamicMenuBarDetails.DynamicMenuBarDetails(ustring)
+- uid: UICatalog.DynamicMenuBarDetails.#ctor*
+ name: DynamicMenuBarDetails
+ href: api/UICatalog/UICatalog.DynamicMenuBarDetails.html#UICatalog_DynamicMenuBarDetails__ctor_
+ commentId: Overload:UICatalog.DynamicMenuBarDetails.#ctor
+ isSpec: "True"
+ fullName: UICatalog.DynamicMenuBarDetails.DynamicMenuBarDetails
+ nameWithType: DynamicMenuBarDetails.DynamicMenuBarDetails
+- uid: UICatalog.DynamicMenuBarDetails._ckbIsTopLevel
+ name: _ckbIsTopLevel
+ href: api/UICatalog/UICatalog.DynamicMenuBarDetails.html#UICatalog_DynamicMenuBarDetails__ckbIsTopLevel
+ commentId: F:UICatalog.DynamicMenuBarDetails._ckbIsTopLevel
+ fullName: UICatalog.DynamicMenuBarDetails._ckbIsTopLevel
+ nameWithType: DynamicMenuBarDetails._ckbIsTopLevel
+- uid: UICatalog.DynamicMenuBarDetails._ckbSubMenu
+ name: _ckbSubMenu
+ href: api/UICatalog/UICatalog.DynamicMenuBarDetails.html#UICatalog_DynamicMenuBarDetails__ckbSubMenu
+ commentId: F:UICatalog.DynamicMenuBarDetails._ckbSubMenu
+ fullName: UICatalog.DynamicMenuBarDetails._ckbSubMenu
+ nameWithType: DynamicMenuBarDetails._ckbSubMenu
+- uid: UICatalog.DynamicMenuBarDetails._menuItem
+ name: _menuItem
+ href: api/UICatalog/UICatalog.DynamicMenuBarDetails.html#UICatalog_DynamicMenuBarDetails__menuItem
+ commentId: F:UICatalog.DynamicMenuBarDetails._menuItem
+ fullName: UICatalog.DynamicMenuBarDetails._menuItem
+ nameWithType: DynamicMenuBarDetails._menuItem
+- uid: UICatalog.DynamicMenuBarDetails._rbChkStyle
+ name: _rbChkStyle
+ href: api/UICatalog/UICatalog.DynamicMenuBarDetails.html#UICatalog_DynamicMenuBarDetails__rbChkStyle
+ commentId: F:UICatalog.DynamicMenuBarDetails._rbChkStyle
+ fullName: UICatalog.DynamicMenuBarDetails._rbChkStyle
+ nameWithType: DynamicMenuBarDetails._rbChkStyle
+- uid: UICatalog.DynamicMenuBarDetails._txtAction
+ name: _txtAction
+ href: api/UICatalog/UICatalog.DynamicMenuBarDetails.html#UICatalog_DynamicMenuBarDetails__txtAction
+ commentId: F:UICatalog.DynamicMenuBarDetails._txtAction
+ fullName: UICatalog.DynamicMenuBarDetails._txtAction
+ nameWithType: DynamicMenuBarDetails._txtAction
+- uid: UICatalog.DynamicMenuBarDetails._txtHelp
+ name: _txtHelp
+ href: api/UICatalog/UICatalog.DynamicMenuBarDetails.html#UICatalog_DynamicMenuBarDetails__txtHelp
+ commentId: F:UICatalog.DynamicMenuBarDetails._txtHelp
+ fullName: UICatalog.DynamicMenuBarDetails._txtHelp
+ nameWithType: DynamicMenuBarDetails._txtHelp
+- uid: UICatalog.DynamicMenuBarDetails._txtShortcut
+ name: _txtShortcut
+ href: api/UICatalog/UICatalog.DynamicMenuBarDetails.html#UICatalog_DynamicMenuBarDetails__txtShortcut
+ commentId: F:UICatalog.DynamicMenuBarDetails._txtShortcut
+ fullName: UICatalog.DynamicMenuBarDetails._txtShortcut
+ nameWithType: DynamicMenuBarDetails._txtShortcut
+- uid: UICatalog.DynamicMenuBarDetails._txtTitle
+ name: _txtTitle
+ href: api/UICatalog/UICatalog.DynamicMenuBarDetails.html#UICatalog_DynamicMenuBarDetails__txtTitle
+ commentId: F:UICatalog.DynamicMenuBarDetails._txtTitle
+ fullName: UICatalog.DynamicMenuBarDetails._txtTitle
+ nameWithType: DynamicMenuBarDetails._txtTitle
+- uid: UICatalog.DynamicMenuBarDetails.CreateAction(Terminal.Gui.MenuItem,UICatalog.DynamicMenuItem)
+ name: CreateAction(MenuItem, DynamicMenuItem)
+ href: api/UICatalog/UICatalog.DynamicMenuBarDetails.html#UICatalog_DynamicMenuBarDetails_CreateAction_Terminal_Gui_MenuItem_UICatalog_DynamicMenuItem_
+ commentId: M:UICatalog.DynamicMenuBarDetails.CreateAction(Terminal.Gui.MenuItem,UICatalog.DynamicMenuItem)
+ fullName: UICatalog.DynamicMenuBarDetails.CreateAction(Terminal.Gui.MenuItem, UICatalog.DynamicMenuItem)
+ nameWithType: DynamicMenuBarDetails.CreateAction(MenuItem, DynamicMenuItem)
+- uid: UICatalog.DynamicMenuBarDetails.CreateAction*
+ name: CreateAction
+ href: api/UICatalog/UICatalog.DynamicMenuBarDetails.html#UICatalog_DynamicMenuBarDetails_CreateAction_
+ commentId: Overload:UICatalog.DynamicMenuBarDetails.CreateAction
+ isSpec: "True"
+ fullName: UICatalog.DynamicMenuBarDetails.CreateAction
+ nameWithType: DynamicMenuBarDetails.CreateAction
+- uid: UICatalog.DynamicMenuBarDetails.EditMenuBarItem(Terminal.Gui.MenuItem)
+ name: EditMenuBarItem(MenuItem)
+ href: api/UICatalog/UICatalog.DynamicMenuBarDetails.html#UICatalog_DynamicMenuBarDetails_EditMenuBarItem_Terminal_Gui_MenuItem_
+ commentId: M:UICatalog.DynamicMenuBarDetails.EditMenuBarItem(Terminal.Gui.MenuItem)
+ fullName: UICatalog.DynamicMenuBarDetails.EditMenuBarItem(Terminal.Gui.MenuItem)
+ nameWithType: DynamicMenuBarDetails.EditMenuBarItem(MenuItem)
+- uid: UICatalog.DynamicMenuBarDetails.EditMenuBarItem*
+ name: EditMenuBarItem
+ href: api/UICatalog/UICatalog.DynamicMenuBarDetails.html#UICatalog_DynamicMenuBarDetails_EditMenuBarItem_
+ commentId: Overload:UICatalog.DynamicMenuBarDetails.EditMenuBarItem
+ isSpec: "True"
+ fullName: UICatalog.DynamicMenuBarDetails.EditMenuBarItem
+ nameWithType: DynamicMenuBarDetails.EditMenuBarItem
+- uid: UICatalog.DynamicMenuBarDetails.EnterMenuItem
+ name: EnterMenuItem()
+ href: api/UICatalog/UICatalog.DynamicMenuBarDetails.html#UICatalog_DynamicMenuBarDetails_EnterMenuItem
+ commentId: M:UICatalog.DynamicMenuBarDetails.EnterMenuItem
+ fullName: UICatalog.DynamicMenuBarDetails.EnterMenuItem()
+ nameWithType: DynamicMenuBarDetails.EnterMenuItem()
+- uid: UICatalog.DynamicMenuBarDetails.EnterMenuItem*
+ name: EnterMenuItem
+ href: api/UICatalog/UICatalog.DynamicMenuBarDetails.html#UICatalog_DynamicMenuBarDetails_EnterMenuItem_
+ commentId: Overload:UICatalog.DynamicMenuBarDetails.EnterMenuItem
+ isSpec: "True"
+ fullName: UICatalog.DynamicMenuBarDetails.EnterMenuItem
+ nameWithType: DynamicMenuBarDetails.EnterMenuItem
+- uid: UICatalog.DynamicMenuBarDetails.UpdateParent(Terminal.Gui.MenuItem@)
+ name: UpdateParent(ref MenuItem)
+ href: api/UICatalog/UICatalog.DynamicMenuBarDetails.html#UICatalog_DynamicMenuBarDetails_UpdateParent_Terminal_Gui_MenuItem__
+ commentId: M:UICatalog.DynamicMenuBarDetails.UpdateParent(Terminal.Gui.MenuItem@)
+ name.vb: UpdateParent(ByRef MenuItem)
+ fullName: UICatalog.DynamicMenuBarDetails.UpdateParent(ref Terminal.Gui.MenuItem)
+ fullName.vb: UICatalog.DynamicMenuBarDetails.UpdateParent(ByRef Terminal.Gui.MenuItem)
+ nameWithType: DynamicMenuBarDetails.UpdateParent(ref MenuItem)
+ nameWithType.vb: DynamicMenuBarDetails.UpdateParent(ByRef MenuItem)
+- uid: UICatalog.DynamicMenuBarDetails.UpdateParent*
+ name: UpdateParent
+ href: api/UICatalog/UICatalog.DynamicMenuBarDetails.html#UICatalog_DynamicMenuBarDetails_UpdateParent_
+ commentId: Overload:UICatalog.DynamicMenuBarDetails.UpdateParent
+ isSpec: "True"
+ fullName: UICatalog.DynamicMenuBarDetails.UpdateParent
+ nameWithType: DynamicMenuBarDetails.UpdateParent
+- uid: UICatalog.DynamicMenuBarSample
+ name: DynamicMenuBarSample
+ href: api/UICatalog/UICatalog.DynamicMenuBarSample.html
+ commentId: T:UICatalog.DynamicMenuBarSample
+ fullName: UICatalog.DynamicMenuBarSample
+ nameWithType: DynamicMenuBarSample
+- uid: UICatalog.DynamicMenuBarSample.#ctor(ustring)
+ name: DynamicMenuBarSample(ustring)
+ href: api/UICatalog/UICatalog.DynamicMenuBarSample.html#UICatalog_DynamicMenuBarSample__ctor_ustring_
+ commentId: M:UICatalog.DynamicMenuBarSample.#ctor(ustring)
+ fullName: UICatalog.DynamicMenuBarSample.DynamicMenuBarSample(ustring)
+ nameWithType: DynamicMenuBarSample.DynamicMenuBarSample(ustring)
+- uid: UICatalog.DynamicMenuBarSample.#ctor*
+ name: DynamicMenuBarSample
+ href: api/UICatalog/UICatalog.DynamicMenuBarSample.html#UICatalog_DynamicMenuBarSample__ctor_
+ commentId: Overload:UICatalog.DynamicMenuBarSample.#ctor
+ isSpec: "True"
+ fullName: UICatalog.DynamicMenuBarSample.DynamicMenuBarSample
+ nameWithType: DynamicMenuBarSample.DynamicMenuBarSample
+- uid: UICatalog.DynamicMenuBarSample.DataContext
+ name: DataContext
+ href: api/UICatalog/UICatalog.DynamicMenuBarSample.html#UICatalog_DynamicMenuBarSample_DataContext
+ commentId: P:UICatalog.DynamicMenuBarSample.DataContext
+ fullName: UICatalog.DynamicMenuBarSample.DataContext
+ nameWithType: DynamicMenuBarSample.DataContext
+- uid: UICatalog.DynamicMenuBarSample.DataContext*
+ name: DataContext
+ href: api/UICatalog/UICatalog.DynamicMenuBarSample.html#UICatalog_DynamicMenuBarSample_DataContext_
+ commentId: Overload:UICatalog.DynamicMenuBarSample.DataContext
+ isSpec: "True"
+ fullName: UICatalog.DynamicMenuBarSample.DataContext
+ nameWithType: DynamicMenuBarSample.DataContext
+- uid: UICatalog.DynamicMenuItem
+ name: DynamicMenuItem
+ href: api/UICatalog/UICatalog.DynamicMenuItem.html
+ commentId: T:UICatalog.DynamicMenuItem
+ fullName: UICatalog.DynamicMenuItem
+ nameWithType: DynamicMenuItem
+- uid: UICatalog.DynamicMenuItem.#ctor
+ name: DynamicMenuItem()
+ href: api/UICatalog/UICatalog.DynamicMenuItem.html#UICatalog_DynamicMenuItem__ctor
+ commentId: M:UICatalog.DynamicMenuItem.#ctor
+ fullName: UICatalog.DynamicMenuItem.DynamicMenuItem()
+ nameWithType: DynamicMenuItem.DynamicMenuItem()
+- uid: UICatalog.DynamicMenuItem.#ctor(ustring,System.Boolean)
+ name: DynamicMenuItem(ustring, Boolean)
+ href: api/UICatalog/UICatalog.DynamicMenuItem.html#UICatalog_DynamicMenuItem__ctor_ustring_System_Boolean_
+ commentId: M:UICatalog.DynamicMenuItem.#ctor(ustring,System.Boolean)
+ fullName: UICatalog.DynamicMenuItem.DynamicMenuItem(ustring, System.Boolean)
+ nameWithType: DynamicMenuItem.DynamicMenuItem(ustring, Boolean)
+- uid: UICatalog.DynamicMenuItem.#ctor(ustring,ustring,ustring,System.Boolean,System.Boolean,Terminal.Gui.MenuItemCheckStyle,ustring)
+ name: DynamicMenuItem(ustring, ustring, ustring, Boolean, Boolean, MenuItemCheckStyle, ustring)
+ href: api/UICatalog/UICatalog.DynamicMenuItem.html#UICatalog_DynamicMenuItem__ctor_ustring_ustring_ustring_System_Boolean_System_Boolean_Terminal_Gui_MenuItemCheckStyle_ustring_
+ commentId: M:UICatalog.DynamicMenuItem.#ctor(ustring,ustring,ustring,System.Boolean,System.Boolean,Terminal.Gui.MenuItemCheckStyle,ustring)
+ fullName: UICatalog.DynamicMenuItem.DynamicMenuItem(ustring, ustring, ustring, System.Boolean, System.Boolean, Terminal.Gui.MenuItemCheckStyle, ustring)
+ nameWithType: DynamicMenuItem.DynamicMenuItem(ustring, ustring, ustring, Boolean, Boolean, MenuItemCheckStyle, ustring)
+- uid: UICatalog.DynamicMenuItem.#ctor*
+ name: DynamicMenuItem
+ href: api/UICatalog/UICatalog.DynamicMenuItem.html#UICatalog_DynamicMenuItem__ctor_
+ commentId: Overload:UICatalog.DynamicMenuItem.#ctor
+ isSpec: "True"
+ fullName: UICatalog.DynamicMenuItem.DynamicMenuItem
+ nameWithType: DynamicMenuItem.DynamicMenuItem
+- uid: UICatalog.DynamicMenuItem.action
+ name: action
+ href: api/UICatalog/UICatalog.DynamicMenuItem.html#UICatalog_DynamicMenuItem_action
+ commentId: F:UICatalog.DynamicMenuItem.action
+ fullName: UICatalog.DynamicMenuItem.action
+ nameWithType: DynamicMenuItem.action
+- uid: UICatalog.DynamicMenuItem.checkStyle
+ name: checkStyle
+ href: api/UICatalog/UICatalog.DynamicMenuItem.html#UICatalog_DynamicMenuItem_checkStyle
+ commentId: F:UICatalog.DynamicMenuItem.checkStyle
+ fullName: UICatalog.DynamicMenuItem.checkStyle
+ nameWithType: DynamicMenuItem.checkStyle
+- uid: UICatalog.DynamicMenuItem.hasSubMenu
+ name: hasSubMenu
+ href: api/UICatalog/UICatalog.DynamicMenuItem.html#UICatalog_DynamicMenuItem_hasSubMenu
+ commentId: F:UICatalog.DynamicMenuItem.hasSubMenu
+ fullName: UICatalog.DynamicMenuItem.hasSubMenu
+ nameWithType: DynamicMenuItem.hasSubMenu
+- uid: UICatalog.DynamicMenuItem.help
+ name: help
+ href: api/UICatalog/UICatalog.DynamicMenuItem.html#UICatalog_DynamicMenuItem_help
+ commentId: F:UICatalog.DynamicMenuItem.help
+ fullName: UICatalog.DynamicMenuItem.help
+ nameWithType: DynamicMenuItem.help
+- uid: UICatalog.DynamicMenuItem.isTopLevel
+ name: isTopLevel
+ href: api/UICatalog/UICatalog.DynamicMenuItem.html#UICatalog_DynamicMenuItem_isTopLevel
+ commentId: F:UICatalog.DynamicMenuItem.isTopLevel
+ fullName: UICatalog.DynamicMenuItem.isTopLevel
+ nameWithType: DynamicMenuItem.isTopLevel
+- uid: UICatalog.DynamicMenuItem.shortcut
+ name: shortcut
+ href: api/UICatalog/UICatalog.DynamicMenuItem.html#UICatalog_DynamicMenuItem_shortcut
+ commentId: F:UICatalog.DynamicMenuItem.shortcut
+ fullName: UICatalog.DynamicMenuItem.shortcut
+ nameWithType: DynamicMenuItem.shortcut
+- uid: UICatalog.DynamicMenuItem.title
+ name: title
+ href: api/UICatalog/UICatalog.DynamicMenuItem.html#UICatalog_DynamicMenuItem_title
+ commentId: F:UICatalog.DynamicMenuItem.title
+ fullName: UICatalog.DynamicMenuItem.title
+ nameWithType: DynamicMenuItem.title
+- uid: UICatalog.DynamicMenuItemList
+ name: DynamicMenuItemList
+ href: api/UICatalog/UICatalog.DynamicMenuItemList.html
+ commentId: T:UICatalog.DynamicMenuItemList
+ fullName: UICatalog.DynamicMenuItemList
+ nameWithType: DynamicMenuItemList
+- uid: UICatalog.DynamicMenuItemList.#ctor
+ name: DynamicMenuItemList()
+ href: api/UICatalog/UICatalog.DynamicMenuItemList.html#UICatalog_DynamicMenuItemList__ctor
+ commentId: M:UICatalog.DynamicMenuItemList.#ctor
+ fullName: UICatalog.DynamicMenuItemList.DynamicMenuItemList()
+ nameWithType: DynamicMenuItemList.DynamicMenuItemList()
+- uid: UICatalog.DynamicMenuItemList.#ctor(ustring,Terminal.Gui.MenuItem)
+ name: DynamicMenuItemList(ustring, MenuItem)
+ href: api/UICatalog/UICatalog.DynamicMenuItemList.html#UICatalog_DynamicMenuItemList__ctor_ustring_Terminal_Gui_MenuItem_
+ commentId: M:UICatalog.DynamicMenuItemList.#ctor(ustring,Terminal.Gui.MenuItem)
+ fullName: UICatalog.DynamicMenuItemList.DynamicMenuItemList(ustring, Terminal.Gui.MenuItem)
+ nameWithType: DynamicMenuItemList.DynamicMenuItemList(ustring, MenuItem)
+- uid: UICatalog.DynamicMenuItemList.#ctor*
+ name: DynamicMenuItemList
+ href: api/UICatalog/UICatalog.DynamicMenuItemList.html#UICatalog_DynamicMenuItemList__ctor_
+ commentId: Overload:UICatalog.DynamicMenuItemList.#ctor
+ isSpec: "True"
+ fullName: UICatalog.DynamicMenuItemList.DynamicMenuItemList
+ nameWithType: DynamicMenuItemList.DynamicMenuItemList
+- uid: UICatalog.DynamicMenuItemList.MenuItem
+ name: MenuItem
+ href: api/UICatalog/UICatalog.DynamicMenuItemList.html#UICatalog_DynamicMenuItemList_MenuItem
+ commentId: P:UICatalog.DynamicMenuItemList.MenuItem
+ fullName: UICatalog.DynamicMenuItemList.MenuItem
+ nameWithType: DynamicMenuItemList.MenuItem
+- uid: UICatalog.DynamicMenuItemList.MenuItem*
+ name: MenuItem
+ href: api/UICatalog/UICatalog.DynamicMenuItemList.html#UICatalog_DynamicMenuItemList_MenuItem_
+ commentId: Overload:UICatalog.DynamicMenuItemList.MenuItem
+ isSpec: "True"
+ fullName: UICatalog.DynamicMenuItemList.MenuItem
+ nameWithType: DynamicMenuItemList.MenuItem
+- uid: UICatalog.DynamicMenuItemList.Title
+ name: Title
+ href: api/UICatalog/UICatalog.DynamicMenuItemList.html#UICatalog_DynamicMenuItemList_Title
+ commentId: P:UICatalog.DynamicMenuItemList.Title
+ fullName: UICatalog.DynamicMenuItemList.Title
+ nameWithType: DynamicMenuItemList.Title
+- uid: UICatalog.DynamicMenuItemList.Title*
+ name: Title
+ href: api/UICatalog/UICatalog.DynamicMenuItemList.html#UICatalog_DynamicMenuItemList_Title_
+ commentId: Overload:UICatalog.DynamicMenuItemList.Title
+ isSpec: "True"
+ fullName: UICatalog.DynamicMenuItemList.Title
+ nameWithType: DynamicMenuItemList.Title
+- uid: UICatalog.DynamicMenuItemList.ToString
+ name: ToString()
+ href: api/UICatalog/UICatalog.DynamicMenuItemList.html#UICatalog_DynamicMenuItemList_ToString
+ commentId: M:UICatalog.DynamicMenuItemList.ToString
+ fullName: UICatalog.DynamicMenuItemList.ToString()
+ nameWithType: DynamicMenuItemList.ToString()
+- uid: UICatalog.DynamicMenuItemList.ToString*
+ name: ToString
+ href: api/UICatalog/UICatalog.DynamicMenuItemList.html#UICatalog_DynamicMenuItemList_ToString_
+ commentId: Overload:UICatalog.DynamicMenuItemList.ToString
+ isSpec: "True"
+ fullName: UICatalog.DynamicMenuItemList.ToString
+ nameWithType: DynamicMenuItemList.ToString
+- uid: UICatalog.DynamicMenuItemModel
+ name: DynamicMenuItemModel
+ href: api/UICatalog/UICatalog.DynamicMenuItemModel.html
+ commentId: T:UICatalog.DynamicMenuItemModel
+ fullName: UICatalog.DynamicMenuItemModel
+ nameWithType: DynamicMenuItemModel
+- uid: UICatalog.DynamicMenuItemModel.#ctor
+ name: DynamicMenuItemModel()
+ href: api/UICatalog/UICatalog.DynamicMenuItemModel.html#UICatalog_DynamicMenuItemModel__ctor
+ commentId: M:UICatalog.DynamicMenuItemModel.#ctor
+ fullName: UICatalog.DynamicMenuItemModel.DynamicMenuItemModel()
+ nameWithType: DynamicMenuItemModel.DynamicMenuItemModel()
+- uid: UICatalog.DynamicMenuItemModel.#ctor*
+ name: DynamicMenuItemModel
+ href: api/UICatalog/UICatalog.DynamicMenuItemModel.html#UICatalog_DynamicMenuItemModel__ctor_
+ commentId: Overload:UICatalog.DynamicMenuItemModel.#ctor
+ isSpec: "True"
+ fullName: UICatalog.DynamicMenuItemModel.DynamicMenuItemModel
+ nameWithType: DynamicMenuItemModel.DynamicMenuItemModel
+- uid: UICatalog.DynamicMenuItemModel.GetPropertyName(System.String)
+ name: GetPropertyName(String)
+ href: api/UICatalog/UICatalog.DynamicMenuItemModel.html#UICatalog_DynamicMenuItemModel_GetPropertyName_System_String_
+ commentId: M:UICatalog.DynamicMenuItemModel.GetPropertyName(System.String)
+ fullName: UICatalog.DynamicMenuItemModel.GetPropertyName(System.String)
+ nameWithType: DynamicMenuItemModel.GetPropertyName(String)
+- uid: UICatalog.DynamicMenuItemModel.GetPropertyName*
+ name: GetPropertyName
+ href: api/UICatalog/UICatalog.DynamicMenuItemModel.html#UICatalog_DynamicMenuItemModel_GetPropertyName_
+ commentId: Overload:UICatalog.DynamicMenuItemModel.GetPropertyName
+ isSpec: "True"
+ fullName: UICatalog.DynamicMenuItemModel.GetPropertyName
+ nameWithType: DynamicMenuItemModel.GetPropertyName
+- uid: UICatalog.DynamicMenuItemModel.MenuBar
+ name: MenuBar
+ href: api/UICatalog/UICatalog.DynamicMenuItemModel.html#UICatalog_DynamicMenuItemModel_MenuBar
+ commentId: P:UICatalog.DynamicMenuItemModel.MenuBar
+ fullName: UICatalog.DynamicMenuItemModel.MenuBar
+ nameWithType: DynamicMenuItemModel.MenuBar
+- uid: UICatalog.DynamicMenuItemModel.MenuBar*
+ name: MenuBar
+ href: api/UICatalog/UICatalog.DynamicMenuItemModel.html#UICatalog_DynamicMenuItemModel_MenuBar_
+ commentId: Overload:UICatalog.DynamicMenuItemModel.MenuBar
+ isSpec: "True"
+ fullName: UICatalog.DynamicMenuItemModel.MenuBar
+ nameWithType: DynamicMenuItemModel.MenuBar
+- uid: UICatalog.DynamicMenuItemModel.Menus
+ name: Menus
+ href: api/UICatalog/UICatalog.DynamicMenuItemModel.html#UICatalog_DynamicMenuItemModel_Menus
+ commentId: P:UICatalog.DynamicMenuItemModel.Menus
+ fullName: UICatalog.DynamicMenuItemModel.Menus
+ nameWithType: DynamicMenuItemModel.Menus
+- uid: UICatalog.DynamicMenuItemModel.Menus*
+ name: Menus
+ href: api/UICatalog/UICatalog.DynamicMenuItemModel.html#UICatalog_DynamicMenuItemModel_Menus_
+ commentId: Overload:UICatalog.DynamicMenuItemModel.Menus
+ isSpec: "True"
+ fullName: UICatalog.DynamicMenuItemModel.Menus
+ nameWithType: DynamicMenuItemModel.Menus
+- uid: UICatalog.DynamicMenuItemModel.Parent
+ name: Parent
+ href: api/UICatalog/UICatalog.DynamicMenuItemModel.html#UICatalog_DynamicMenuItemModel_Parent
+ commentId: P:UICatalog.DynamicMenuItemModel.Parent
+ fullName: UICatalog.DynamicMenuItemModel.Parent
+ nameWithType: DynamicMenuItemModel.Parent
+- uid: UICatalog.DynamicMenuItemModel.Parent*
+ name: Parent
+ href: api/UICatalog/UICatalog.DynamicMenuItemModel.html#UICatalog_DynamicMenuItemModel_Parent_
+ commentId: Overload:UICatalog.DynamicMenuItemModel.Parent
+ isSpec: "True"
+ fullName: UICatalog.DynamicMenuItemModel.Parent
+ nameWithType: DynamicMenuItemModel.Parent
+- uid: UICatalog.DynamicMenuItemModel.PropertyChanged
+ name: PropertyChanged
+ href: api/UICatalog/UICatalog.DynamicMenuItemModel.html#UICatalog_DynamicMenuItemModel_PropertyChanged
+ commentId: E:UICatalog.DynamicMenuItemModel.PropertyChanged
+ fullName: UICatalog.DynamicMenuItemModel.PropertyChanged
+ nameWithType: DynamicMenuItemModel.PropertyChanged
- uid: UICatalog.IValueConverter
name: IValueConverter
href: api/UICatalog/UICatalog.IValueConverter.html
@@ -10802,6 +11575,38 @@ references:
isSpec: "True"
fullName: UICatalog.ListWrapperConverter.Convert
nameWithType: ListWrapperConverter.Convert
+- uid: UICatalog.NumberToWords
+ name: NumberToWords
+ href: api/UICatalog/UICatalog.NumberToWords.html
+ commentId: T:UICatalog.NumberToWords
+ fullName: UICatalog.NumberToWords
+ nameWithType: NumberToWords
+- uid: UICatalog.NumberToWords.Convert(System.Int64)
+ name: Convert(Int64)
+ href: api/UICatalog/UICatalog.NumberToWords.html#UICatalog_NumberToWords_Convert_System_Int64_
+ commentId: M:UICatalog.NumberToWords.Convert(System.Int64)
+ fullName: UICatalog.NumberToWords.Convert(System.Int64)
+ nameWithType: NumberToWords.Convert(Int64)
+- uid: UICatalog.NumberToWords.Convert*
+ name: Convert
+ href: api/UICatalog/UICatalog.NumberToWords.html#UICatalog_NumberToWords_Convert_
+ commentId: Overload:UICatalog.NumberToWords.Convert
+ isSpec: "True"
+ fullName: UICatalog.NumberToWords.Convert
+ nameWithType: NumberToWords.Convert
+- uid: UICatalog.NumberToWords.ConvertAmount(System.Double)
+ name: ConvertAmount(Double)
+ href: api/UICatalog/UICatalog.NumberToWords.html#UICatalog_NumberToWords_ConvertAmount_System_Double_
+ commentId: M:UICatalog.NumberToWords.ConvertAmount(System.Double)
+ fullName: UICatalog.NumberToWords.ConvertAmount(System.Double)
+ nameWithType: NumberToWords.ConvertAmount(Double)
+- uid: UICatalog.NumberToWords.ConvertAmount*
+ name: ConvertAmount
+ href: api/UICatalog/UICatalog.NumberToWords.html#UICatalog_NumberToWords_ConvertAmount_
+ commentId: Overload:UICatalog.NumberToWords.ConvertAmount
+ isSpec: "True"
+ fullName: UICatalog.NumberToWords.ConvertAmount
+ nameWithType: NumberToWords.ConvertAmount
- uid: UICatalog.Scenario
name: Scenario
href: api/UICatalog/UICatalog.Scenario.html
@@ -11385,6 +12190,30 @@ references:
isSpec: "True"
fullName: Unix.Terminal.Curses.addwstr
nameWithType: Curses.addwstr
+- uid: Unix.Terminal.Curses.AltCtrlKeyEnd
+ name: AltCtrlKeyEnd
+ href: api/Terminal.Gui/Unix.Terminal.Curses.html#Unix_Terminal_Curses_AltCtrlKeyEnd
+ commentId: F:Unix.Terminal.Curses.AltCtrlKeyEnd
+ fullName: Unix.Terminal.Curses.AltCtrlKeyEnd
+ nameWithType: Curses.AltCtrlKeyEnd
+- uid: Unix.Terminal.Curses.AltCtrlKeyHome
+ name: AltCtrlKeyHome
+ href: api/Terminal.Gui/Unix.Terminal.Curses.html#Unix_Terminal_Curses_AltCtrlKeyHome
+ commentId: F:Unix.Terminal.Curses.AltCtrlKeyHome
+ fullName: Unix.Terminal.Curses.AltCtrlKeyHome
+ nameWithType: Curses.AltCtrlKeyHome
+- uid: Unix.Terminal.Curses.AltCtrlKeyNPage
+ name: AltCtrlKeyNPage
+ href: api/Terminal.Gui/Unix.Terminal.Curses.html#Unix_Terminal_Curses_AltCtrlKeyNPage
+ commentId: F:Unix.Terminal.Curses.AltCtrlKeyNPage
+ fullName: Unix.Terminal.Curses.AltCtrlKeyNPage
+ nameWithType: Curses.AltCtrlKeyNPage
+- uid: Unix.Terminal.Curses.AltCtrlKeyPPage
+ name: AltCtrlKeyPPage
+ href: api/Terminal.Gui/Unix.Terminal.Curses.html#Unix_Terminal_Curses_AltCtrlKeyPPage
+ commentId: F:Unix.Terminal.Curses.AltCtrlKeyPPage
+ fullName: Unix.Terminal.Curses.AltCtrlKeyPPage
+ nameWithType: Curses.AltCtrlKeyPPage
- uid: Unix.Terminal.Curses.AltKeyDown
name: AltKeyDown
href: api/Terminal.Gui/Unix.Terminal.Curses.html#Unix_Terminal_Curses_AltKeyDown
@@ -12085,6 +12914,12 @@ references:
isSpec: "True"
fullName: Unix.Terminal.Curses.isendwin
nameWithType: Curses.isendwin
+- uid: Unix.Terminal.Curses.KEY_CODE_SEQ
+ name: KEY_CODE_SEQ
+ href: api/Terminal.Gui/Unix.Terminal.Curses.html#Unix_Terminal_Curses_KEY_CODE_SEQ
+ commentId: F:Unix.Terminal.Curses.KEY_CODE_SEQ
+ fullName: Unix.Terminal.Curses.KEY_CODE_SEQ
+ nameWithType: Curses.KEY_CODE_SEQ
- uid: Unix.Terminal.Curses.KEY_CODE_YES
name: KEY_CODE_YES
href: api/Terminal.Gui/Unix.Terminal.Curses.html#Unix_Terminal_Curses_KEY_CODE_YES
@@ -12595,6 +13430,54 @@ references:
isSpec: "True"
fullName: Unix.Terminal.Curses.setscrreg
nameWithType: Curses.setscrreg
+- uid: Unix.Terminal.Curses.ShiftAltKeyDown
+ name: ShiftAltKeyDown
+ href: api/Terminal.Gui/Unix.Terminal.Curses.html#Unix_Terminal_Curses_ShiftAltKeyDown
+ commentId: F:Unix.Terminal.Curses.ShiftAltKeyDown
+ fullName: Unix.Terminal.Curses.ShiftAltKeyDown
+ nameWithType: Curses.ShiftAltKeyDown
+- uid: Unix.Terminal.Curses.ShiftAltKeyEnd
+ name: ShiftAltKeyEnd
+ href: api/Terminal.Gui/Unix.Terminal.Curses.html#Unix_Terminal_Curses_ShiftAltKeyEnd
+ commentId: F:Unix.Terminal.Curses.ShiftAltKeyEnd
+ fullName: Unix.Terminal.Curses.ShiftAltKeyEnd
+ nameWithType: Curses.ShiftAltKeyEnd
+- uid: Unix.Terminal.Curses.ShiftAltKeyHome
+ name: ShiftAltKeyHome
+ href: api/Terminal.Gui/Unix.Terminal.Curses.html#Unix_Terminal_Curses_ShiftAltKeyHome
+ commentId: F:Unix.Terminal.Curses.ShiftAltKeyHome
+ fullName: Unix.Terminal.Curses.ShiftAltKeyHome
+ nameWithType: Curses.ShiftAltKeyHome
+- uid: Unix.Terminal.Curses.ShiftAltKeyLeft
+ name: ShiftAltKeyLeft
+ href: api/Terminal.Gui/Unix.Terminal.Curses.html#Unix_Terminal_Curses_ShiftAltKeyLeft
+ commentId: F:Unix.Terminal.Curses.ShiftAltKeyLeft
+ fullName: Unix.Terminal.Curses.ShiftAltKeyLeft
+ nameWithType: Curses.ShiftAltKeyLeft
+- uid: Unix.Terminal.Curses.ShiftAltKeyNPage
+ name: ShiftAltKeyNPage
+ href: api/Terminal.Gui/Unix.Terminal.Curses.html#Unix_Terminal_Curses_ShiftAltKeyNPage
+ commentId: F:Unix.Terminal.Curses.ShiftAltKeyNPage
+ fullName: Unix.Terminal.Curses.ShiftAltKeyNPage
+ nameWithType: Curses.ShiftAltKeyNPage
+- uid: Unix.Terminal.Curses.ShiftAltKeyPPage
+ name: ShiftAltKeyPPage
+ href: api/Terminal.Gui/Unix.Terminal.Curses.html#Unix_Terminal_Curses_ShiftAltKeyPPage
+ commentId: F:Unix.Terminal.Curses.ShiftAltKeyPPage
+ fullName: Unix.Terminal.Curses.ShiftAltKeyPPage
+ nameWithType: Curses.ShiftAltKeyPPage
+- uid: Unix.Terminal.Curses.ShiftAltKeyRight
+ name: ShiftAltKeyRight
+ href: api/Terminal.Gui/Unix.Terminal.Curses.html#Unix_Terminal_Curses_ShiftAltKeyRight
+ commentId: F:Unix.Terminal.Curses.ShiftAltKeyRight
+ fullName: Unix.Terminal.Curses.ShiftAltKeyRight
+ nameWithType: Curses.ShiftAltKeyRight
+- uid: Unix.Terminal.Curses.ShiftAltKeyUp
+ name: ShiftAltKeyUp
+ href: api/Terminal.Gui/Unix.Terminal.Curses.html#Unix_Terminal_Curses_ShiftAltKeyUp
+ commentId: F:Unix.Terminal.Curses.ShiftAltKeyUp
+ fullName: Unix.Terminal.Curses.ShiftAltKeyUp
+ nameWithType: Curses.ShiftAltKeyUp
- uid: Unix.Terminal.Curses.ShiftCtrlKeyDown
name: ShiftCtrlKeyDown
href: api/Terminal.Gui/Unix.Terminal.Curses.html#Unix_Terminal_Curses_ShiftCtrlKeyDown