diff --git a/Terminal.Gui/Terminal.Gui.csproj b/Terminal.Gui/Terminal.Gui.csproj
index bf35ed7f6..bba15aab1 100644
--- a/Terminal.Gui/Terminal.Gui.csproj
+++ b/Terminal.Gui/Terminal.Gui.csproj
@@ -43,53 +43,76 @@
Terminal.Gui is a framework for creating console user interfaces
+ v1.3.0
+ * #1491 Fix link to MainLoop docs in README.md
+ * #1489 Dynamic menu/statusbar and Enable property fix.
+ * #1488 Fixed label positions to begin at Margins not just bottom left of screen
+ * #1486 Scrollbarview ensures host always focused.
+ * #1484 NetDriver fixes keys modifiers not reseting and enter key on Windows Terminal.
+ * #1479 Trying updating FSharpExample to net5.0
+ * #1478 Fixes #1475. Selection ending with a white space error.
+ * #1476 Added PoshRedisViewer to the list of Showcases/Examples
+ * #1473 Bump ReportGenerator from 4.8.12 to 4.8.13
+ * #1472 ComboBox cursonDownKey nullref fix
+ * #1468 Fixes #1467. AlternateForward/BackwardKey bypasses dialog modality
+ * #1466 Fixes WindowsDriver HeightAsBuffer set to false.
+ * #1450 Added Application.QuitKey property to allow change the quitting application key.
+ * #1449 Bump ReactiveMarbles.ObservableEvents.SourceGenerator from 1.1.3 to 1.1.4
+ * #1448 Fixes #1445. Fixing more the Curses and WSL clipboard.
+ * #1447 Fixes #1446. Added more features to the Border and Toplevel focus.
+ * #1441 Fixes #1438. Backspace not redrawing screen under some situations.
+ * #1440 feature: Don't pull Terminal.Gui from NuGet, use ReactiveMarbles.ObservableEvents
+ * #1437 Fixed bug setting ColorScheme on Autocomplete
+ * #1436 Border feature
+ * #1432 tweaked readme
+
v1.2.1
- * Fixes code block fencing
- * NetDriver triple click mouse bug fix.
- * WindowsDriver double click mouse bug fix.
- * Fixes CursesDriver mouse and reset issue.
- * Correctly mark the .NET Framework reference assemblies as private.
- * Fix version conflicts caused by PR#1412
- * Autocomplete for TextView
- * Fixes #1402. Only WindowsDriver supports horizontal scroll.
- * Fixes #1396. Using the Loaded event instead the Ready event.
- * Fixes #1394. Added ReflectedType to check for overridden.
- * Fixes #1389. Added a unidirectional feature to the Marquee styles to the ProgressBar.
- * Fixes #1387. Allowing the UnitTests project to test internal keywords.
- * Fixes #1384. Added a VisibleChanged event on the View class.
- * Fixes #1381. Unit tests to demonstrate the Key enum ambiguity check.
- * Fixes #546. Enhancement ProgressBar.
- * Disables MinVer on Debug builds
- * Adds Lineview
- * CheckBox AutoSize should initialize with the Label default.
- * Fixes to avoid exception with the ComboBox in All Views Tester.
- * Simplifying FrameView constructors avoiding redundant code.
- * Button text should be centered by default.
- * Fixes #1078. ColorScheme setter now calls SetNeedsDisplay.
- * Bump ReportGenerator from 4.8.11 to 4.8.12
- * Fixes #1314. TextView now exposes file exceptions from callers.
- * Prevents application crash if OS clipboard is not supported.
- * Fixes #1358. Attribute.Foreground / Attribute.Background now working with CursesDriver
- * Added support for coloring cells in TableView
- * More unit test for issue #1344, testing IsVertical as False.
- * Fix for #1353 (tab view not refreshing in some circumstances)
+ * Fixes code block fencing
+ * NetDriver triple click mouse bug fix.
+ * WindowsDriver double click mouse bug fix.
+ * Fixes CursesDriver mouse and reset issue.
+ * Correctly mark the .NET Framework reference assemblies as private.
+ * Fix version conflicts caused by PR#1412
+ * Autocomplete for TextView
+ * Fixes #1402. Only WindowsDriver supports horizontal scroll.
+ * Fixes #1396. Using the Loaded event instead the Ready event.
+ * Fixes #1394. Added ReflectedType to check for overridden.
+ * Fixes #1389. Added a unidirectional feature to the Marquee styles to the ProgressBar.
+ * Fixes #1387. Allowing the UnitTests project to test internal keywords.
+ * Fixes #1384. Added a VisibleChanged event on the View class.
+ * Fixes #1381. Unit tests to demonstrate the Key enum ambiguity check.
+ * Fixes #546. Enhancement ProgressBar.
+ * Disables MinVer on Debug builds
+ * Adds Lineview
+ * CheckBox AutoSize should initialize with the Label default.
+ * Fixes to avoid exception with the ComboBox in All Views Tester.
+ * Simplifying FrameView constructors avoiding redundant code.
+ * Button text should be centered by default.
+ * Fixes #1078. ColorScheme setter now calls SetNeedsDisplay.
+ * Bump ReportGenerator from 4.8.11 to 4.8.12
+ * Fixes #1314. TextView now exposes file exceptions from callers.
+ * Prevents application crash if OS clipboard is not supported.
+ * Fixes #1358. Attribute.Foreground / Attribute.Background now working with CursesDriver
+ * Added support for coloring cells in TableView
+ * More unit test for issue #1344, testing IsVertical as False.
+ * Fix for #1353 (tab view not refreshing in some circumstances)
* Fixes #1344. Setting showBothScrollIndicator to false on the constructor don't throws NullReferenceException anymore.
- * Fixes #1341. Now if AutoSize is true the Bounds size is always updated by using the Dim.Fill or the Dim.Absolute.
- * Resolves: Add GitHub Codespaces configuration
- * Expose TextView color methods as protected virtual (allows custom colors)
- * Fixes InvalidOperationException from throwing when removing the label on the LabelsAsLabels scenario.
- * Added a Initialize method to the Window to simplify the constructors.
- * Fixes GetCurrentWidth and GetCurrentHeight providing the correct current values.
- * Fixes CursesDriver resize issue.
- * Toplevel improvement as a subviews container without frame borders.
- * Prevents ListView top to be less than zero if source count is zero.
- * Fixes #1326. Prevent selected item to be equal to the source count.
- * Fixes #1327. Fixes TextField backspace and canceling TextChanging.
- * Prevents WindowSize event from being always triggered in Netdriver unnecessarily.
- * Fix bug where series/annotations are added during render
- * Fixes #1318. Ensures that the OS clipboard is always sets.
- * Fixes #983. Improving clipboard with interaction with the OS.
- * Added Attributes tests; balanced Application.Init/Shutdown
+ * Fixes #1341. Now if AutoSize is true the Bounds size is always updated by using the Dim.Fill or the Dim.Absolute.
+ * Resolves: Add GitHub Codespaces configuration
+ * Expose TextView color methods as protected virtual (allows custom colors)
+ * Fixes InvalidOperationException from throwing when removing the label on the LabelsAsLabels scenario.
+ * Added a Initialize method to the Window to simplify the constructors.
+ * Fixes GetCurrentWidth and GetCurrentHeight providing the correct current values.
+ * Fixes CursesDriver resize issue.
+ * Toplevel improvement as a subviews container without frame borders.
+ * Prevents ListView top to be less than zero if source count is zero.
+ * Fixes #1326. Prevent selected item to be equal to the source count.
+ * Fixes #1327. Fixes TextField backspace and canceling TextChanging.
+ * Prevents WindowSize event from being always triggered in Netdriver unnecessarily.
+ * Fix bug where series/annotations are added during render
+ * Fixes #1318. Ensures that the OS clipboard is always sets.
+ * Fixes #983. Improving clipboard with interaction with the OS.
+ * Added Attributes tests; balanced Application.Init/Shutdown
v1.1.1
* Fixes #1307 - MainLoop timeouts duplicate keys error.
diff --git a/docs/README.html b/docs/README.html
index 2f2b6fe1b..ae102f953 100644
--- a/docs/README.html
+++ b/docs/README.html
@@ -8,7 +8,7 @@
To Generate the Docs
-
+
diff --git a/docs/api/Terminal.Gui/Terminal.Gui.Application.ResizedEventArgs.html b/docs/api/Terminal.Gui/Terminal.Gui.Application.ResizedEventArgs.html
index c922df67e..ceee1a92c 100644
--- a/docs/api/Terminal.Gui/Terminal.Gui.Application.ResizedEventArgs.html
+++ b/docs/api/Terminal.Gui/Terminal.Gui.Application.ResizedEventArgs.html
@@ -10,7 +10,7 @@
-
+
diff --git a/docs/api/Terminal.Gui/Terminal.Gui.Application.RunState.html b/docs/api/Terminal.Gui/Terminal.Gui.Application.RunState.html
index 348d05b34..180235874 100644
--- a/docs/api/Terminal.Gui/Terminal.Gui.Application.RunState.html
+++ b/docs/api/Terminal.Gui/Terminal.Gui.Application.RunState.html
@@ -10,7 +10,7 @@
-
+
diff --git a/docs/api/Terminal.Gui/Terminal.Gui.Application.html b/docs/api/Terminal.Gui/Terminal.Gui.Application.html
index b32ea9c33..5da7d7cf8 100644
--- a/docs/api/Terminal.Gui/Terminal.Gui.Application.html
+++ b/docs/api/Terminal.Gui/Terminal.Gui.Application.html
@@ -10,7 +10,7 @@
-
+
@@ -84,7 +84,7 @@
Class Application
-A static, singelton class provding the main application driver for Terminal.Gui apps.
+A static, singleton class providing the main application driver for Terminal.Gui apps.
@@ -291,6 +291,60 @@ If set, it forces the use of the System.Console-based driver.
+
+
AlternateBackwardKey
+
+Alternative key to navigate backwards through all views. Shift+Ctrl+Tab is always used.
+
+
+
Declaration
+
+
public static Key AlternateBackwardKey { get; set; }
Calling Run(Toplevel, Func<Exception, Boolean>) is equivalent to calling Begin(Toplevel), followed by RunLoop(Application.RunState, Boolean),
diff --git a/docs/api/Terminal.Gui/Terminal.Gui.Attribute.html b/docs/api/Terminal.Gui/Terminal.Gui.Attribute.html
index c6f8fe23f..5293f3dce 100644
--- a/docs/api/Terminal.Gui/Terminal.Gui.Attribute.html
+++ b/docs/api/Terminal.Gui/Terminal.Gui.Attribute.html
@@ -10,7 +10,7 @@
-
+
@@ -124,6 +124,36 @@ class to define color schemes that can be used in your application.
+
+
Attribute(Int32)
+
+Initializes a new instance of the Attribute struct with only the value passed to
+and trying to get the colors if defined.
+
+
+
Declaration
+
+
public Attribute(int value)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.Int32
+
value
+
Value.
+
+
+
+
+
Attribute(Int32, Color, Color)
@@ -132,7 +162,7 @@ Initializes a new instance of the
Declaration
-
public Attribute(int value, Color foreground = Color.Black, Color background = Color.Black)
+
public Attribute(int value, Color foreground, Color background)
Parameters
@@ -163,6 +193,36 @@ Initializes a new instance of the
+
Attribute(Color)
+
+Initializes a new instance of the Attribute struct
+with the same colors for the foreground and background.
+
+Return true if the given symbol should be considered part of a word
+and can be contained in matches. Base behaviour is to use System.Char.IsLetterOrDigit(System.Char)
+
+
+
Declaration
+
+
public virtual bool IsWordChar(Rune rune)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.Rune
+
rune
+
+
+
+
+
Returns
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Boolean
+
+
+
+
+
+
+
+
ProcessKey(TextView, KeyEvent)
+
+Handle key events before hostControl e.g. to make key events like
+up/down apply to the autocomplete control instead of changing the cursor position in
+the underlying text view.
+
+
+
Declaration
+
+
public bool ProcessKey(TextView hostControl, KeyEvent kb)
+A sealed Toplevel derived class to implement Border feature.
+This is only a wrapper to get borders on a toplevel and is recommended using another
+derived, like Window where is possible to have borders with or without
+border line or spacing around.
+
-Provides cut, copy, and paste support for the clipboard.
-NOTE: Currently not implemented.
+Provides cut, copy, and paste support for the clipboard with OS interaction.
@@ -130,7 +129,7 @@ NOTE: Currently not implemented.
Contents
-
+Get or sets the operation system clipboard, otherwise the contents field.
Declaration
@@ -152,6 +151,123 @@ NOTE: Currently not implemented.
+
+
+
+
IsSupported
+
+Returns true if the environmental dependencies are in place to interact with the OS clipboard.
+
+
+
Declaration
+
+
public static bool IsSupported { get; }
+
+
Property Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Boolean
+
+
+
+
+
Methods
+
+
+
+
+
TryGetClipboardData(out String)
+
+Gets the operation system clipboard if possible.
+
+
+
Declaration
+
+
public static bool TryGetClipboardData(out string result)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.String
+
result
+
Clipboard contents read
+
+
+
+
Returns
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Boolean
+
true if it was possible to read the OS clipboard.
+
+
+
+
+
+
+
TrySetClipboardData(String)
+
+Sets the operation system clipboard if possible.
+
+
+
Declaration
+
+
public static bool TrySetClipboardData(string text)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.String
+
text
+
+
+
+
+
Returns
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Boolean
+
True if the clipboard content was set successfully.
Draws a frame for a window with padding and an optional visible border inside the padding.
Declaration
-
public virtual void DrawWindowFrame(Rect region, int paddingLeft = 0, int paddingTop = 0, int paddingRight = 0, int paddingBottom = 0, bool border = true, bool fill = false)
+
public virtual void DrawWindowFrame(Rect region, int paddingLeft = 0, int paddingTop = 0, int paddingRight = 0, int paddingBottom = 0, bool border = true, bool fill = false, Border borderContent = null)
Parameters
@@ -1163,6 +1373,11 @@ Draws a frame for a window with padding and an optional visible border inside th
fill
If set to true it will clear the content area (the area inside the padding) with the current color, otherwise the content area will be left untouched.
To run the Dialog modally, create the Dialog, and pass it to Run(Func<Exception, Boolean>).
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().
+or buttons added to the dialog calls RequestStop(Toplevel).
-The Label View displays a string at a given position and supports multiple lines separted by newline characters. Multi-line Labels support word wrap.
+The Label View displays a string at a given position and supports multiple lines separated by newline characters.
+Multi-line Labels support word wrap.
@@ -123,6 +124,15 @@ The Label View displays a stri
-When time time specified passes, the callback will be invoked.
+When time specified passes, the callback will be invoked.
If the callback returns true, the timeout will be reset, repeating
the invocation. If it returns false, the timeout will stop and be removed.
@@ -409,7 +409,7 @@ Removes an idle handler added with
Declaration
-
public void RemoveIdle(Func<bool> token)
+
public bool RemoveIdle(Func<bool> token)
Parameters
@@ -428,6 +428,21 @@ Removes an idle handler added with Returns
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Boolean
+
+
+
+
@@ -438,7 +453,7 @@ Removes a previously scheduled timeout
Declaration
-
public void RemoveTimeout(object token)
+
public bool RemoveTimeout(object token)
Parameters
@@ -457,6 +472,21 @@ Removes a previously scheduled timeout
+
Returns
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Boolean
+
+
+
+
Remarks
The token parameter is the value returned by AddTimeout.
diff --git a/docs/api/Terminal.Gui/Terminal.Gui.MenuBar.html b/docs/api/Terminal.Gui/Terminal.Gui.MenuBar.html
index 7a8d86d12..656f3e7af 100644
--- a/docs/api/Terminal.Gui/Terminal.Gui.MenuBar.html
+++ b/docs/api/Terminal.Gui/Terminal.Gui.MenuBar.html
@@ -10,7 +10,7 @@
-
+
@@ -123,6 +123,15 @@ The MenuBar provides a menu for Terminal.Gui applications.
To use, create an instance of OpenDialog, and pass it to
Run(Func<Exception, Boolean>). This will run the dialog modally,
-and when this returns, the list of filds will be available on the FilePaths property.
+and when this returns, the list of files will be available on the FilePaths property.
To select more than one file, users can use the spacebar, or control-t.
@@ -545,14 +623,14 @@ Initializes a new OpenDialog
-
+A container for single Child that will allow to drawn Border in
+two ways. If UsePanelFrame the borders and the child will be accommodated in the available
+panel size, otherwise the panel will be resized based on the child and borders thickness sizes.
+
-If the ProgressBar is is percentage mode, it switches to activity
-mode. If is in activity mode, the marker is moved.
+If the ProgressBar is percentage mode, it switches to activity
+mode. If is in activity mode, the marker is moved.
diff --git a/docs/api/Terminal.Gui/Terminal.Gui.RectangleF.html b/docs/api/Terminal.Gui/Terminal.Gui.RectangleF.html
index 6e734ff3f..3f8a744d3 100644
--- a/docs/api/Terminal.Gui/Terminal.Gui.RectangleF.html
+++ b/docs/api/Terminal.Gui/Terminal.Gui.RectangleF.html
@@ -10,7 +10,7 @@
-
+
@@ -233,7 +233,7 @@ Gets the y-coordinate of the lower-right corner of the rectangular region define
diff --git a/docs/api/Terminal.Gui/Terminal.Gui.ScrollView.html b/docs/api/Terminal.Gui/Terminal.Gui.ScrollView.html
index c9bd048b1..6520b9ebd 100644
--- a/docs/api/Terminal.Gui/Terminal.Gui.ScrollView.html
+++ b/docs/api/Terminal.Gui/Terminal.Gui.ScrollView.html
@@ -10,7 +10,7 @@
-
+
@@ -123,6 +123,15 @@ Scrollviews are views that present a window into a virtual space where subviews
@@ -614,7 +641,7 @@ Gets or sets the visibility for the horizontal scroll indicator.
ShowVerticalScrollIndicator
-/// Gets or sets the visibility for the vertical scroll indicator.
+Gets or sets the visibility for the vertical scroll indicator.
Declaration
diff --git a/docs/api/Terminal.Gui/Terminal.Gui.ShortcutHelper.html b/docs/api/Terminal.Gui/Terminal.Gui.ShortcutHelper.html
index d3da93cd8..b862810e8 100644
--- a/docs/api/Terminal.Gui/Terminal.Gui.ShortcutHelper.html
+++ b/docs/api/Terminal.Gui/Terminal.Gui.ShortcutHelper.html
@@ -10,7 +10,7 @@
-
+
@@ -406,14 +406,14 @@ Gets the key with all the keys modifiers, especially the shift key that sometime
-
public static void MoveTo<T>(this Stack<T> stack, T valueToMove, int index = 0, IEqualityComparer<T> comparer = null)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.Collections.Generic.Stack<T>
+
stack
+
The stack object.
+
+
+
T
+
valueToMove
+
Value to move.
+
+
+
System.Int32
+
index
+
The index where to move.
+
+
+
System.Collections.Generic.IEqualityComparer<T>
+
comparer
+
The comparison object.
+
+
+
+
Type Parameters
+
+
+
+
Name
+
Description
+
+
+
+
+
T
+
The stack object type.
+
+
+
+
+
+
+
Replace<T>(Stack<T>, T, T, IEqualityComparer<T>)
+
+Replaces an stack object values that match with the value to replace.
+
+
+
Declaration
+
+
public static void Replace<T>(this Stack<T> stack, T valueToReplace, T valueToReplaceWith, IEqualityComparer<T> comparer = null)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.Collections.Generic.Stack<T>
+
stack
+
The stack object.
+
+
+
T
+
valueToReplace
+
Value to replace.
+
+
+
T
+
valueToReplaceWith
+
Value to replace with to what matches the value to replace.
+
+
+
System.Collections.Generic.IEqualityComparer<T>
+
comparer
+
The comparison object.
+
+
+
+
Type Parameters
+
+
+
+
Name
+
Description
+
+
+
+
+
T
+
The stack object type.
+
+
+
+
+
+
+
Swap<T>(Stack<T>, T, T, IEqualityComparer<T>)
+
+Swap two stack objects values that matches with the both values.
+
+
+
Declaration
+
+
public static void Swap<T>(this Stack<T> stack, T valueToSwapFrom, T valueToSwapTo, IEqualityComparer<T> comparer = null)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.Collections.Generic.Stack<T>
+
stack
+
The stack object.
+
+
+
T
+
valueToSwapFrom
+
Value to swap from.
+
+
+
T
+
valueToSwapTo
+
Value to swap to.
+
+
+
System.Collections.Generic.IEqualityComparer<T>
+
comparer
+
The comparison object.
+
+
+
+
Type Parameters
+
+
+
+
Name
+
Description
+
+
+
+
+
T
+
The stack object type.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/api/Terminal.Gui/Terminal.Gui.StatusBar.html b/docs/api/Terminal.Gui/Terminal.Gui.StatusBar.html
index 9093edf76..86f1d605c 100644
--- a/docs/api/Terminal.Gui/Terminal.Gui.StatusBar.html
+++ b/docs/api/Terminal.Gui/Terminal.Gui.StatusBar.html
@@ -10,7 +10,7 @@
-
+
@@ -126,6 +126,15 @@ So for each context must be a new instance of a statusbar.
Defines a delegate for returning custom representations of cell values. If not set then System.Object.ToString() is used. Return values from your delegate may be truncated e.g. based on MaxWidth
diff --git a/docs/api/Terminal.Gui/Terminal.Gui.TableView.RowColorGetterArgs.html b/docs/api/Terminal.Gui/Terminal.Gui.TableView.RowColorGetterArgs.html
new file mode 100644
index 000000000..8600bfba0
--- /dev/null
+++ b/docs/api/Terminal.Gui/Terminal.Gui.TableView.RowColorGetterArgs.html
@@ -0,0 +1,218 @@
+
+
+
+
+
+
+
+ Class TableView.RowColorGetterArgs
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/api/Terminal.Gui/Terminal.Gui.TableView.SelectedCellChangedEventArgs.html b/docs/api/Terminal.Gui/Terminal.Gui.TableView.SelectedCellChangedEventArgs.html
index 9acc5b0e7..86b10ec91 100644
--- a/docs/api/Terminal.Gui/Terminal.Gui.TableView.SelectedCellChangedEventArgs.html
+++ b/docs/api/Terminal.Gui/Terminal.Gui.TableView.SelectedCellChangedEventArgs.html
@@ -10,7 +10,7 @@
-
+
diff --git a/docs/api/Terminal.Gui/Terminal.Gui.TableView.TableSelection.html b/docs/api/Terminal.Gui/Terminal.Gui.TableView.TableSelection.html
index e89ce27ae..3b6ab2c35 100644
--- a/docs/api/Terminal.Gui/Terminal.Gui.TableView.TableSelection.html
+++ b/docs/api/Terminal.Gui/Terminal.Gui.TableView.TableSelection.html
@@ -10,7 +10,7 @@
-
+
diff --git a/docs/api/Terminal.Gui/Terminal.Gui.TableView.TableStyle.html b/docs/api/Terminal.Gui/Terminal.Gui.TableView.TableStyle.html
index e67c296a7..1ca33dd1e 100644
--- a/docs/api/Terminal.Gui/Terminal.Gui.TableView.TableStyle.html
+++ b/docs/api/Terminal.Gui/Terminal.Gui.TableView.TableStyle.html
@@ -10,7 +10,7 @@
-
+
@@ -182,6 +182,93 @@ Collection of columns for which you want special rendering (e.g. custom column l
+
+
ExpandLastColumn
+
+Determines rendering when the last column in the table is visible but it's
+content or MaxWidth is less than the remaining
+space in the control. True (the default) will expand the column to fill
+the remaining bounds of the control. False will draw a column ending line
+and leave a blank column that cannot be selected in the remaining space.
+
+
+
Declaration
+
+
public bool ExpandLastColumn { get; set; }
+
+
Property Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Boolean
+
+
+
+
+
+
+
+
InvertSelectedCellFirstCharacter
+
+True to invert the colors of the first symbol of the selected cell in the TableView.
+This gives the appearance of a cursor for when the ConsoleDriver doesn't otherwise show
+this
+
+
+
Declaration
+
+
public bool InvertSelectedCellFirstCharacter { get; set; }
+
+
Property Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Boolean
+
+
+
+
+
+
+
+
RowColorGetter
+
+Delegate for coloring specific rows in a different color. For cell color ColorGetter
+
+
+
Declaration
+
+
public TableView.RowColorGetterDelegate RowColorGetter { get; set; }
diff --git a/docs/api/Terminal.Gui/Terminal.Gui.TableView.html b/docs/api/Terminal.Gui/Terminal.Gui.TableView.html
index 28bd095a8..40715437e 100644
--- a/docs/api/Terminal.Gui/Terminal.Gui.TableView.html
+++ b/docs/api/Terminal.Gui/Terminal.Gui.TableView.html
@@ -10,7 +10,7 @@
-
+
@@ -125,6 +125,15 @@ View for tabular data based on a System.Data.DataTable
+Override to provide custom multi colouring to cells. Use Driver to
+with AddStr(ustring). The driver will already be
+in the correct place when rendering and you must render the full render
+or the view will not look right. For simpler provision of color use ColorGetter
+For changing the content that is rendered use RepresentationGetter
+
+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 bool AutoSize { get; set; }
+
+
Property Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Boolean
+
+
+
+
+
+
CursorPosition
@@ -468,14 +498,14 @@ Controls the vertical text-alignment property.
-
CalcRect(Int32, Int32, ustring)
+
CalcRect(Int32, Int32, ustring, TextDirection)
Calculates the rectangle required to hold text, assuming no word wrapping.
Declaration
-
public static Rect CalcRect(int x, int y, ustring text)
+
public static Rect CalcRect(int x, int y, ustring text, TextDirection direction = TextDirection.LeftRight_TopBottom)
Parameters
@@ -502,6 +532,11 @@ Calculates the rectangle required to hold text, assuming no word wrapping.
@@ -629,6 +664,57 @@ Justifies text within a specified width.
+
+
ClipOrPad(String, Int32)
+
+Adds trailing whitespace or truncates text
+so that it fits exactly width console units.
+Note that some unicode characters take 2+ columns
+
+
+
Declaration
+
+
public static string ClipOrPad(string text, int width)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.String
+
text
+
+
+
+
System.Int32
+
width
+
+
+
+
+
Returns
+
+
+
+
Type
+
Description
+
+
+
+
+
System.String
+
+
+
+
+
+
Draw(Rect, Attribute, Attribute)
diff --git a/docs/api/Terminal.Gui/Terminal.Gui.TextValidateField.html b/docs/api/Terminal.Gui/Terminal.Gui.TextValidateField.html
index 55a0c1d3f..b9b38dc73 100644
--- a/docs/api/Terminal.Gui/Terminal.Gui.TextValidateField.html
+++ b/docs/api/Terminal.Gui/Terminal.Gui.TextValidateField.html
@@ -10,7 +10,7 @@
-
+
@@ -123,6 +123,15 @@ Text field that validates input through a View.MouseClick
@@ -1222,6 +1277,126 @@ Closes the contents of the stream into the
+
ColorNormal()
+
+Sets the driver to the default color for the control where no text is being rendered. Defaults to Normal.
+
+
+
Declaration
+
+
protected virtual void ColorNormal()
+
+
+
+
+
ColorNormal(List<Rune>, Int32)
+
+Sets the Driver to an appropriate color for rendering the given idx of the
+current line. Override to provide custom coloring by calling SetAttribute(Attribute)
+Defaults to Normal.
+
+
+
Declaration
+
+
protected virtual void ColorNormal(List<Rune> line, int idx)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.Collections.Generic.List<System.Rune>
+
line
+
+
+
+
System.Int32
+
idx
+
+
+
+
+
+
+
+
ColorSelection(List<Rune>, Int32)
+
+Sets the Driver to an appropriate color for rendering the given idx of the
+current line. Override to provide custom coloring by calling SetAttribute(Attribute)
+Defaults to Focus.
+
+
+
Declaration
+
+
protected virtual void ColorSelection(List<Rune> line, int idx)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.Collections.Generic.List<System.Rune>
+
line
+
+
+
+
System.Int32
+
idx
+
+
+
+
+
+
+
+
ColorUsed(List<Rune>, Int32)
+
+Sets the Driver to an appropriate color for rendering the given idx of the
+current line. Override to provide custom coloring by calling SetAttribute(Attribute)
+Defaults to HotFocus.
+
+
+
Declaration
+
+
protected virtual void ColorUsed(List<Rune> line, int idx)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.Collections.Generic.List<System.Rune>
+
line
+
+
+
+
System.Int32
+
idx
+
+
+
+
+
+
Copy()
@@ -1246,6 +1421,33 @@ Cut the selected text to the clipboard contents.
+
+
DeleteTextBackwards()
+
+Deletes a single character from the position of the cursor
+
+
+
Declaration
+
+
public bool DeleteTextBackwards()
+
+
Returns
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Boolean
+
+
+
+
+
+
FindNextText(ustring, out Boolean, Boolean, Boolean, ustring, Boolean)
@@ -1396,6 +1598,65 @@ Reset the flag to stop continuous find.
+
+
GetCurrentLine()
+
+Returns the characters on the current line (where the cursor is positioned).
+Use CurrentColumn to determine the position of the cursor within
+that line
+
+
+
Declaration
+
+
public List<Rune> GetCurrentLine()
+
+
Returns
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Collections.Generic.List<System.Rune>
+
+
+
+
+
+
+
+
InsertText(String)
+
+Inserts the given toAdd text at the current cursor position
+exactly as if the user had just typed it
+
+Describes the thickness of a frame around a rectangle. Four System.Int32 values describe
+the Left, Top, Right, and Bottom sides
+of the rectangle, respectively.
+
+Initializes a new instance of the Thickness structure that has the
+specified uniform length on each side.
+
+
+
Declaration
+
+
public Thickness(int length)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.Int32
+
length
+
+
+
+
+
+
+
+
Thickness(Int32, Int32, Int32, Int32)
+
+Initializes a new instance of the Thickness structure that has specific
+lengths (supplied as a System.Int32) applied to each side of the rectangle.
+
+
+
Declaration
+
+
public Thickness(int left, int top, int right, int bottom)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.Int32
+
left
+
+
+
+
System.Int32
+
top
+
+
+
+
System.Int32
+
right
+
+
+
+
System.Int32
+
bottom
+
+
+
+
+
Fields
+
+
+
+
Bottom
+
+Gets or sets the width, in integers, of the lower side of the bounding rectangle.
+
+
+
Declaration
+
+
public int Bottom
+
+
Field Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Int32
+
+
+
+
+
+
+
Left
+
+Gets or sets the width, in integers, of the left side of the bounding rectangle.
+
+
+
Declaration
+
+
public int Left
+
+
Field Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Int32
+
+
+
+
+
+
+
Right
+
+Gets or sets the width, in integers, of the right side of the bounding rectangle.
+
+
+
Declaration
+
+
public int Right
+
+
Field Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Int32
+
+
+
+
+
+
+
Top
+
+Gets or sets the width, in integers, of the upper side of the bounding rectangle.
+
+Gets or sets if this Toplevel is a Mdi container.
+
+
+
Declaration
+
+
public bool IsMdiContainer { get; set; }
+
+
Property Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Boolean
+
+
+
+
+
+
MenuBar
@@ -527,7 +603,7 @@ Gets or sets the menu for this Toplevel
Declaration
-
public MenuBar MenuBar { get; set; }
+
public virtual MenuBar MenuBar { get; set; }
Property Value
@@ -602,7 +678,7 @@ Gets or sets whether the MainL
Remarks
-Setting this property directly is discouraged. Use RequestStop() instead.
+Setting this property directly is discouraged. Use RequestStop(Toplevel) instead.
@@ -614,7 +690,7 @@ Gets or sets the status bar for this Toplevel
Declaration
-
public StatusBar StatusBar { get; set; }
+
public virtual StatusBar StatusBar { get; set; }
Property Value
@@ -691,6 +767,123 @@ Convenience factory method that creates a new Toplevel with the current terminal
+
+
GetTopMdiChild(Type, String[])
+
+Gets the current visible toplevel Mdi child that match the arguments pattern.
+
+
+
Declaration
+
+
public View GetTopMdiChild(Type type = null, string[] exclude = null)
A signed integer that indicates the relative values of x and y, as shown in the following table.Value Meaning Less than zero
+x is less than y.Zero
+x equals y.Greater than zero
+x is greater than y.
@@ -3157,6 +3305,32 @@ Event fired when a subview is being added to this view.
+
CanFocusChanged
+
+Event fired when the CanFocus value is being changed.
+
+
+
Declaration
+
+
public event Action CanFocusChanged
+
+
Event Type
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Action
+
+
+
+
+
+
DrawContent
Event invoked when the content area of the View is to be drawn.
@@ -3192,6 +3366,32 @@ Rect provides the view-relative rectangle describing the currently visible viewp
+
EnabledChanged
+
+Event fired when the Enabled value is being changed.
+
+
+
Declaration
+
+
public event Action EnabledChanged
+
+
Event Type
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Action
+
+
+
+
+
+
Enter
Event fired when the view gets focus.
@@ -3512,6 +3712,32 @@ Event fired when a subview is being removed from this view.
+
+
+
VisibleChanged
+
+Event fired when the Visible value is being changed.
+
+The rune to display at the end of the line (right end of horizontal line or bottom end of vertical).
+If not specified then LineRune is used
+
+
+
Declaration
+
+
public Rune? EndingAnchor { get; set; }
+
+
Property Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Nullable<System.Rune>
+
+
+
+
+
+
+
+
LineRune
+
+The symbol to use for drawing the line
+
+
+
Declaration
+
+
public Rune LineRune { get; set; }
+
+
Property Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Rune
+
+
+
+
+
+
+
+
Orientation
+
+The direction of the line. If you change this you will need to manually update the Width/Height
+of the control to cover a relevant area based on the new direction.
+
-Initializes a new instance of the Window using Absolute positioning with the specified frame for its location, with the specified frame padding,
+Initializes a new instance of the Window using Computed positioning,
and an optional title.
Declaration
-
public Window(ustring title = null, int padding = 0)
+
public Window(ustring title = null, int padding = 0, Border border = null)
Parameters
@@ -536,11 +611,16 @@ and an optional title.
padding
Number of characters to use for padding of the drawn frame.
-This constructor intitalize a View with a LayoutStyle of Computed.
+This constructor initializes a View with a LayoutStyle of Computed.
Use X, Y, Width, and Height properties to dynamically control the size and location of the view.
@@ -579,13 +659,13 @@ Initializes a new instance of the Remarks
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.
@@ -593,7 +673,7 @@ and an optional title.
Declaration
-
public Window(Rect frame, ustring title = null, int padding = 0)
+
public Window(Rect frame, ustring title = null, int padding = 0, Border border = null)
Parameters
@@ -620,17 +700,49 @@ and an optional title.
padding
Number of characters to use for padding of the drawn frame.
-This constructor intitalizes a Window with a LayoutStyle of Absolute. Use constructors
+This constructor initializes a Window with a LayoutStyle of Absolute. Use constructors
that do not take Rect parameters to initialize a Window with LayoutStyle of Computed
-A static, singelton class provding the main application driver for Terminal.Gui apps.
+A static, singleton class providing the main application driver for Terminal.Gui apps.
@@ -98,6 +98,22 @@ Event arguments for the Application.RunState
Captures the execution state for the provided Terminal.Gui.Application.RunState.Toplevel view.
+
+
+
+A sealed Toplevel derived class to implement Border feature.
+This is only a wrapper to get borders on a toplevel and is recommended using another
+derived, like Window where is possible to have borders with or without
+border line or spacing around.
@@ -109,8 +125,11 @@ The CheckBoxClipboard
-Provides cut, copy, and paste support for the clipboard.
-NOTE: Currently not implemented.
+Provides cut, copy, and paste support for the clipboard with OS interaction.
+
+
-The Label View displays a string at a given position and supports multiple lines separted by newline characters. Multi-line Labels support word wrap.
+The Label View displays a string at a given position and supports multiple lines separated by newline characters.
+Multi-line Labels support word wrap.
+
+A container for single Child that will allow to drawn Border in
+two ways. If UsePanelFrame the borders and the child will be accommodated in the available
+panel size, otherwise the panel will be resized based on the child and borders thickness sizes.
+
+Describes the thickness of a frame around a rectangle. Four System.Int32 values describe
+the Left, Top, Right, and Bottom sides
+of the rectangle, respectively.
[Scenario.ScenarioMetadata("MultiColouredTable", "Demonstrates how to multi color cell contents")]
+[Scenario.ScenarioCategory("Controls")]
+public class MultiColouredTable : Scenario, IDisposable
diff --git a/docs/articles/index.html b/docs/articles/index.html
index 112d3b2e7..48679a3fe 100644
--- a/docs/articles/index.html
+++ b/docs/articles/index.html
@@ -8,7 +8,7 @@
Conceptual Documentation
-
+
diff --git a/docs/articles/keyboard.html b/docs/articles/keyboard.html
index 16368635d..20dc75b3c 100644
--- a/docs/articles/keyboard.html
+++ b/docs/articles/keyboard.html
@@ -8,7 +8,7 @@
Keyboard Event Processing
-
+
diff --git a/docs/articles/mainloop.html b/docs/articles/mainloop.html
index fd23387a7..0817592eb 100644
--- a/docs/articles/mainloop.html
+++ b/docs/articles/mainloop.html
@@ -8,7 +8,7 @@
Event Processing and the Application Main Loop
-
+
diff --git a/docs/articles/overview.html b/docs/articles/overview.html
index 47434d210..025a184e6 100644
--- a/docs/articles/overview.html
+++ b/docs/articles/overview.html
@@ -8,7 +8,7 @@
Terminal.Gui API Overview
-
+
diff --git a/docs/articles/tableview.html b/docs/articles/tableview.html
index fe6265876..44712bd2a 100644
--- a/docs/articles/tableview.html
+++ b/docs/articles/tableview.html
@@ -8,7 +8,7 @@
Table View
-
+
diff --git a/docs/articles/treeview.html b/docs/articles/treeview.html
index a0a503e6b..7c6b4bfaa 100644
--- a/docs/articles/treeview.html
+++ b/docs/articles/treeview.html
@@ -8,7 +8,7 @@
Tree View
-
+
diff --git a/docs/articles/views.html b/docs/articles/views.html
index 6a706a48b..631d7a0bc 100644
--- a/docs/articles/views.html
+++ b/docs/articles/views.html
@@ -8,7 +8,7 @@
Views
-
+
diff --git a/docs/index.html b/docs/index.html
index c9dfeee10..0a8853550 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -8,7 +8,7 @@
Terminal.Gui - Terminal UI toolkit for .NET
-
+
diff --git a/docs/index.json b/docs/index.json
index 05a281ee9..38630d580 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 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 AlwaysSetPosition Used only by Terminal.Gui.NetDriver to forcing always moving the cursor position when writing to the screen. Declaration public static bool AlwaysSetPosition { get; set; } Property Value Type Description System.Boolean Current The current Toplevel object. This is updated when Run(Func) enters and leaves to point to the current Toplevel . Declaration public static Toplevel Current { get; } Property Value Type Description Toplevel The current. HeightAsBuffer The current HeightAsBuffer used in the terminal. Declaration public static bool HeightAsBuffer { get; set; } Property Value Type Description System.Boolean 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 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(Func) to return. Calling RequestStop() is equivalent to setting the Running property on the curently running Toplevel to false. Run(Func) Runs the application by calling Run(Toplevel, Func) with the value of Top Declaration public static void Run(Func errorHandler = null) Parameters Type Name Description System.Func < System.Exception , System.Boolean > errorHandler Run(Toplevel, Func) Runs the main loop on the given Toplevel container. Declaration public static void Run(Toplevel view, Func errorHandler = null) Parameters Type Name Description Toplevel view The Toplevel tu run modally. System.Func < System.Exception , System.Boolean > errorHandler Handler for any unhandled exceptions (resumes when returns true, rethrows when null). 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, Func) stop execution, call RequestStop() . Calling Run(Toplevel, Func) 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. When errorHandler is null the exception is rethrown, when it returns true the application is resumed and when false method exits gracefully. Run(Func) Runs the application by calling Run(Toplevel, Func) with a new instance of the specified Toplevel -derived class Declaration public static void Run(Func errorHandler = null) where T : Toplevel, new() Parameters Type Name Description System.Func < System.Exception , System.Boolean > errorHandler 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, singleton class providing 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 AlternateBackwardKey Alternative key to navigate backwards through all views. Shift+Ctrl+Tab is always used. Declaration public static Key AlternateBackwardKey { get; set; } Property Value Type Description Key AlternateForwardKey Alternative key to navigate forwards through all views. Ctrl+Tab is always used. Declaration public static Key AlternateForwardKey { get; set; } Property Value Type Description Key AlwaysSetPosition Used only by Terminal.Gui.NetDriver to forcing always moving the cursor position when writing to the screen. Declaration public static bool AlwaysSetPosition { get; set; } Property Value Type Description System.Boolean Current The current Toplevel object. This is updated when Run(Func) enters and leaves to point to the current Toplevel . Declaration public static Toplevel Current { get; } Property Value Type Description Toplevel The current. HeightAsBuffer The current HeightAsBuffer used in the terminal. Declaration public static bool HeightAsBuffer { get; set; } Property Value Type Description System.Boolean MainLoop The MainLoop driver for the application Declaration public static MainLoop MainLoop { get; } Property Value Type Description MainLoop The main loop. MdiChildes Gets all the Mdi childes which represent all the not modal Toplevel from the MdiTop . Declaration public static List MdiChildes { get; } Property Value Type Description System.Collections.Generic.List < Toplevel > MdiTop The Toplevel object used for the application on startup which IsMdiContainer is true. Declaration public static Toplevel MdiTop { get; } Property Value Type Description Toplevel QuitKey Gets or sets the key to quit the application. Declaration public static Key QuitKey { get; set; } Property Value Type Description Key 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. DoEvents() Wakes up the mainloop that might be waiting on input, must be thread safe. Declaration public static void DoEvents() 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. EnsuresTopOnFront() Ensures that the superview of the most focused view is on front. Declaration public static void EnsuresTopOnFront() 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 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. MoveNext() Move to the next Mdi child from the MdiTop . Declaration public static void MoveNext() MovePrevious() Move to the previous Mdi child from the MdiTop . Declaration public static void MovePrevious() Refresh() Triggers a refresh of the entire display. Declaration public static void Refresh() RequestStop(Toplevel) Stops running the most recent Toplevel or the top if provided. Declaration public static void RequestStop(Toplevel top = null) Parameters Type Name Description Toplevel top The toplevel to request stop. Remarks This will cause Run(Func) to return. Calling RequestStop(Toplevel) is equivalent to setting the Running property on the currently running Toplevel to false. Run(Func) Runs the application by calling Run(Toplevel, Func) with the value of Top Declaration public static void Run(Func errorHandler = null) Parameters Type Name Description System.Func < System.Exception , System.Boolean > errorHandler Run(Toplevel, Func) Runs the main loop on the given Toplevel container. Declaration public static void Run(Toplevel view, Func errorHandler = null) Parameters Type Name Description Toplevel view The Toplevel to run modally. System.Func < System.Exception , System.Boolean > errorHandler Handler for any unhandled exceptions (resumes when returns true, rethrows when null). 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, Func) stop execution, call RequestStop(Toplevel) . Calling Run(Toplevel, Func) 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. When errorHandler is null the exception is rethrown, when it returns true the application is resumed and when false method exits gracefully. Run(Func) Runs the application by calling Run(Toplevel, Func) with a new instance of the specified Toplevel -derived class Declaration public static void Run(Func errorHandler = null) where T : Toplevel, new() Parameters Type Name Description System.Func < System.Exception , System.Boolean > errorHandler 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",
@@ -17,22 +17,47 @@
"api/Terminal.Gui/Terminal.Gui.Attribute.html": {
"href": "api/Terminal.Gui/Terminal.Gui.Attribute.html",
"title": "Struct Attribute",
- "keywords": "Struct Attribute Attributes are used as elements that contain both a foreground and a background or platform specific features Inherited Members System.ValueType.Equals(System.Object) System.ValueType.GetHashCode() System.ValueType.ToString() System.Object.Equals(System.Object, System.Object) System.Object.GetType() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public struct Attribute Remarks Attribute s are needed to map colors to terminal capabilities that might lack colors, on color scenarios, they encode both the foreground and the background color and are used in the ColorScheme class to define color schemes that can be used in your application. Constructors Attribute(Int32, Color, Color) Initializes a new instance of the Attribute struct. Declaration public Attribute(int value, Color foreground = Color.Black, Color background = Color.Black) Parameters Type Name Description System.Int32 value Value. Color foreground Foreground Color background Background Attribute(Color, Color) Initializes a new instance of the Attribute struct. Declaration public Attribute(Color foreground = Color.Black, Color background = Color.Black) Parameters Type Name Description Color foreground Foreground Color background Background Properties Background The background color. Declaration public Color Background { get; } Property Value Type Description Color Foreground The foreground color. Declaration public Color Foreground { get; } Property Value Type Description Color Value The color attribute value. Declaration public int Value { get; } Property Value Type Description System.Int32 Methods Get() Gets the current Attribute from the driver. Declaration public static Attribute Get() Returns Type Description Attribute The current attribute. Make(Color, Color) Creates an Attribute from the specified foreground and background. Declaration public static Attribute Make(Color foreground, Color background) Parameters Type Name Description Color foreground Foreground color to use. Color background Background color to use. Returns Type Description Attribute The make. Operators Implicit(Int32 to Attribute) Implicitly convert an integer value into an Attribute Declaration public static implicit operator Attribute(int v) Parameters Type Name Description System.Int32 v value Returns Type Description Attribute An attribute with the specified integer value. Implicit(Attribute to Int32) Implicit conversion from an Attribute to the underlying Int32 representation Declaration public static implicit operator int (Attribute c) Parameters Type Name Description Attribute c The attribute to convert Returns Type Description System.Int32 The integer value stored in the attribute."
+ "keywords": "Struct Attribute Attributes are used as elements that contain both a foreground and a background or platform specific features Inherited Members System.ValueType.Equals(System.Object) System.ValueType.GetHashCode() System.ValueType.ToString() System.Object.Equals(System.Object, System.Object) System.Object.GetType() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public struct Attribute Remarks Attribute s are needed to map colors to terminal capabilities that might lack colors, on color scenarios, they encode both the foreground and the background color and are used in the ColorScheme class to define color schemes that can be used in your application. Constructors Attribute(Int32) Initializes a new instance of the Attribute struct with only the value passed to and trying to get the colors if defined. Declaration public Attribute(int value) Parameters Type Name Description System.Int32 value Value. Attribute(Int32, Color, Color) Initializes a new instance of the Attribute struct. Declaration public Attribute(int value, Color foreground, Color background) Parameters Type Name Description System.Int32 value Value. Color foreground Foreground Color background Background Attribute(Color) Initializes a new instance of the Attribute struct with the same colors for the foreground and background. Declaration public Attribute(Color color) Parameters Type Name Description Color color The color. Attribute(Color, Color) Initializes a new instance of the Attribute struct. Declaration public Attribute(Color foreground = Color.Black, Color background = Color.Black) Parameters Type Name Description Color foreground Foreground Color background Background Properties Background The background color. Declaration public readonly Color Background { get; } Property Value Type Description Color Foreground The foreground color. Declaration public readonly Color Foreground { get; } Property Value Type Description Color Value The color attribute value. Declaration public readonly int Value { get; } Property Value Type Description System.Int32 Methods Get() Gets the current Attribute from the driver. Declaration public static Attribute Get() Returns Type Description Attribute The current attribute. Make(Color, Color) Creates an Attribute from the specified foreground and background. Declaration public static Attribute Make(Color foreground, Color background) Parameters Type Name Description Color foreground Foreground color to use. Color background Background color to use. Returns Type Description Attribute The make. Operators Implicit(Int32 to Attribute) Implicitly convert an integer value into an Attribute Declaration public static implicit operator Attribute(int v) Parameters Type Name Description System.Int32 v value Returns Type Description Attribute An attribute with the specified integer value. Implicit(Attribute to Int32) Implicit conversion from an Attribute to the underlying Int32 representation Declaration public static implicit operator int (Attribute c) Parameters Type Name Description Attribute c The attribute to convert Returns Type Description System.Int32 The integer value stored in the attribute."
+ },
+ "api/Terminal.Gui/Terminal.Gui.Autocomplete.html": {
+ "href": "api/Terminal.Gui/Terminal.Gui.Autocomplete.html",
+ "title": "Class Autocomplete",
+ "keywords": "Class Autocomplete Renders an overlay on another view at a given point that allows selecting from a range of 'autocomplete' options. Inheritance System.Object Autocomplete 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 Autocomplete Properties AllSuggestions The full set of all strings that can be suggested. Declaration public List AllSuggestions { get; set; } Property Value Type Description System.Collections.Generic.List < System.String > CloseKey The key that the user can press to close the currently popped autocomplete menu Declaration public Key CloseKey { get; set; } Property Value Type Description Key ColorScheme The colors to use to render the overlay. Accessing this property before the Application has been initialised will cause an error Declaration public ColorScheme ColorScheme { get; set; } Property Value Type Description ColorScheme MaxHeight The maximum number of visible rows in the autocomplete dropdown to render Declaration public int MaxHeight { get; set; } Property Value Type Description System.Int32 MaxWidth The maximum width of the autocomplete dropdown Declaration public int MaxWidth { get; set; } Property Value Type Description System.Int32 ScrollOffset When more suggestions are available than can be rendered the user can scroll down the dropdown list. This indicates how far down they have gone Declaration public int ScrollOffset { get; set; } Property Value Type Description System.Int32 SelectedIdx The currently selected index into Suggestions that the user has highlighted Declaration public int SelectedIdx { get; set; } Property Value Type Description System.Int32 SelectionKey The key that the user must press to accept the currently selected autocomplete suggestion Declaration public Key SelectionKey { get; set; } Property Value Type Description Key Suggestions The strings that form the current list of suggestions to render based on what the user has typed so far. Declaration public ReadOnlyCollection Suggestions { get; protected set; } Property Value Type Description System.Collections.ObjectModel.ReadOnlyCollection < System.String > Visible True if the autocomplete should be considered open and visible Declaration protected bool Visible { get; set; } Property Value Type Description System.Boolean Methods ClearSuggestions() Clears Suggestions Declaration public void ClearSuggestions() EnsureSelectedIdxIsValid() Updates SelectedIdx to be a valid index within Suggestions Declaration public void EnsureSelectedIdxIsValid() GenerateSuggestions(TextView) Populates Suggestions with all strings in AllSuggestions that match with the current cursor position/text in the hostControl Declaration public void GenerateSuggestions(TextView hostControl) Parameters Type Name Description TextView hostControl The text view that you want suggestions for IsWordChar(Rune) Return true if the given symbol should be considered part of a word and can be contained in matches. Base behaviour is to use System.Char.IsLetterOrDigit(System.Char) Declaration public virtual bool IsWordChar(Rune rune) Parameters Type Name Description System.Rune rune Returns Type Description System.Boolean ProcessKey(TextView, KeyEvent) Handle key events before hostControl e.g. to make key events like up/down apply to the autocomplete control instead of changing the cursor position in the underlying text view. Declaration public bool ProcessKey(TextView hostControl, KeyEvent kb) Parameters Type Name Description TextView hostControl KeyEvent kb Returns Type Description System.Boolean RenderOverlay(View, Point) Renders the autocomplete dialog inside the given view at the given point. Declaration public void RenderOverlay(View view, Point renderAt) Parameters Type Name Description View view The view the overlay should be rendered into Point renderAt"
+ },
+ "api/Terminal.Gui/Terminal.Gui.Border.html": {
+ "href": "api/Terminal.Gui/Terminal.Gui.Border.html",
+ "title": "Class Border",
+ "keywords": "Class Border Draws a border, background, or both around another element. Inheritance System.Object Border 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 Border Properties ActualHeight Gets the rendered height of this element. Declaration public int ActualHeight { get; } Property Value Type Description System.Int32 ActualWidth Gets the rendered width of this element. Declaration public int ActualWidth { get; } Property Value Type Description System.Int32 Background Gets or sets the Color that fills the area between the bounds of a Border . Declaration public Color Background { get; set; } Property Value Type Description Color BorderBrush Gets or sets the Color that draws the outer border color. Declaration public Color BorderBrush { get; set; } Property Value Type Description Color BorderStyle Specifies the BorderStyle for a view. Declaration public BorderStyle BorderStyle { get; set; } Property Value Type Description BorderStyle BorderThickness Gets or sets the relative Thickness of a Border . Declaration public Thickness BorderThickness { get; set; } Property Value Type Description Thickness Child Gets or sets the single child element of a View . Declaration public View Child { get; set; } Property Value Type Description View ChildContainer Gets or private sets by the Border.ToplevelContainer Declaration public Border.ToplevelContainer ChildContainer { get; } Property Value Type Description Border.ToplevelContainer DrawMarginFrame Gets or sets if a margin frame is drawn around the Child regardless the BorderStyle Declaration public bool DrawMarginFrame { get; set; } Property Value Type Description System.Boolean Effect3D Gets or sets the 3D effect around the Border . Declaration public bool Effect3D { get; set; } Property Value Type Description System.Boolean Effect3DBrush Gets or sets the color for the Border Declaration public Attribute? Effect3DBrush { get; set; } Property Value Type Description System.Nullable < Attribute > Effect3DOffset Get or sets the offset start position for the Effect3D Declaration public Point Effect3DOffset { get; set; } Property Value Type Description Point Padding Gets or sets a Thickness value that describes the amount of space between a Border and its child element. Declaration public Thickness Padding { get; set; } Property Value Type Description Thickness Parent Gets the parent Child parent if any. Declaration public View Parent { get; } Property Value Type Description View Methods DrawContent() Drawn the BorderThickness more the Padding more the BorderStyle and the Effect3D . Declaration public void DrawContent() DrawFullContent() Same as DrawContent() but drawing full frames for all borders. Declaration public void DrawFullContent() DrawTitle(View, Rect) Drawn the view text from a View . Declaration public void DrawTitle(View view, Rect rect) Parameters Type Name Description View view Rect rect GetSumThickness() Calculate the sum of the Padding and the BorderThickness Declaration public Thickness GetSumThickness() Returns Type Description Thickness The total of the Border Thickness OnBorderChanged() Invoke the BorderChanged event. Declaration public virtual void OnBorderChanged() Events BorderChanged Event to be invoked when any border property change. Declaration public event Action BorderChanged Event Type Type Description System.Action < Border >"
+ },
+ "api/Terminal.Gui/Terminal.Gui.Border.ToplevelContainer.html": {
+ "href": "api/Terminal.Gui/Terminal.Gui.Border.ToplevelContainer.html",
+ "title": "Class Border.ToplevelContainer",
+ "keywords": "Class Border.ToplevelContainer A sealed Toplevel derived class to implement Border feature. This is only a wrapper to get borders on a toplevel and is recommended using another derived, like Window where is possible to have borders with or without border line or spacing around. Inheritance System.Object Responder View Toplevel Border.ToplevelContainer Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members Toplevel.Running Toplevel.Loaded Toplevel.Ready Toplevel.Unloaded Toplevel.Activate Toplevel.Deactivate Toplevel.ChildClosed Toplevel.AllChildClosed Toplevel.Closing Toplevel.Closed Toplevel.ChildLoaded Toplevel.ChildUnloaded Toplevel.Create() Toplevel.CanFocus Toplevel.Modal Toplevel.MenuBar Toplevel.StatusBar Toplevel.IsMdiContainer Toplevel.IsMdiChild Toplevel.OnKeyDown(KeyEvent) Toplevel.OnKeyUp(KeyEvent) Toplevel.ProcessKey(KeyEvent) Toplevel.ProcessColdKey(KeyEvent) Toplevel.PositionToplevel(Toplevel) Toplevel.MouseEvent(MouseEvent) Toplevel.WillPresent() Toplevel.MoveNext() Toplevel.MovePrevious() Toplevel.RequestStop() Toplevel.RequestStop(Toplevel) Toplevel.PositionCursor() Toplevel.GetTopMdiChild(Type, String[]) Toplevel.ShowChild(Toplevel) View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.CanFocusChanged View.EnabledChanged View.VisibleChanged 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.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() 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.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.VerticalTextAlignment View.TextDirection View.IsInitialized View.Enabled View.Visible View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.OnEnabledChanged() View.OnVisibleChanged() View.Dispose(Boolean) View.BeginInit() View.EndInit() View.SetWidth(Int32, Int32) View.SetHeight(Int32, Int32) View.GetCurrentWidth(Int32) View.GetCurrentHeight(Int32) View.GetNormalColor() 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 sealed class ToplevelContainer : Toplevel, IDisposable, ISupportInitializeNotification, ISupportInitialize Constructors ToplevelContainer() Initializes with default null values. Declaration public ToplevelContainer() ToplevelContainer(Border, String) Initializes a Border.ToplevelContainer with a Computed Declaration public ToplevelContainer(Border border, string title = null) Parameters Type Name Description Border border The border. System.String title The title. ToplevelContainer(Rect, Border, String) Initializes a Border.ToplevelContainer with a Absolute Declaration public ToplevelContainer(Rect frame, Border border, string title = null) Parameters Type Name Description Rect frame The frame. Border border The border. System.String title The title. Properties Border Declaration public override Border Border { get; set; } Property Value Type Description Border Overrides View.Border Methods Add(View) Declaration public override void Add(View view) Parameters Type Name Description View view Overrides Toplevel.Add(View) OnCanFocusChanged() Declaration public override void OnCanFocusChanged() Overrides View.OnCanFocusChanged() Redraw(Rect) Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds Overrides Toplevel.Redraw(Rect) Remove(View) Declaration public override void Remove(View view) Parameters Type Name Description View view Overrides Toplevel.Remove(View) RemoveAll() Declaration public override void RemoveAll() Overrides Toplevel.RemoveAll() Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize"
+ },
+ "api/Terminal.Gui/Terminal.Gui.BorderStyle.html": {
+ "href": "api/Terminal.Gui/Terminal.Gui.BorderStyle.html",
+ "title": "Enum BorderStyle",
+ "keywords": "Enum BorderStyle Specifies the border style for a View and to be used by the Border class. Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public enum BorderStyle Fields Name Description Double The border is drawn with a double line limits. None No border is drawn. Single The border is drawn with a single line limits."
},
"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.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.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() 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.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.VerticalTextAlignment View.TextDirection 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 View.SetWidth(Int32, Int32) View.SetHeight(Int32, Int32) View.GetCurrentWidth(Int32) View.GetCurrentHeight(Int32) 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) Declaration public override bool MouseEvent(MouseEvent me) Parameters Type Name Description MouseEvent me Returns Type Description System.Boolean Overrides Responder.MouseEvent(MouseEvent) OnEnter(View) Declaration public override bool OnEnter(View view) Parameters Type Name Description View view Returns Type Description System.Boolean Overrides View.OnEnter(View) PositionCursor() Declaration public override void PositionCursor() Overrides View.PositionCursor() ProcessColdKey(KeyEvent) Declaration public override bool ProcessColdKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides View.ProcessColdKey(KeyEvent) ProcessHotKey(KeyEvent) Declaration public override bool ProcessHotKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides View.ProcessHotKey(KeyEvent) ProcessKey(KeyEvent) Declaration public override bool ProcessKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides View.ProcessKey(KeyEvent) 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.CanFocusChanged View.EnabledChanged View.VisibleChanged 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.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() 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.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.VerticalTextAlignment View.TextDirection View.IsInitialized View.Enabled View.Visible View.Border View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.OnCanFocusChanged() View.OnEnabledChanged() View.OnVisibleChanged() View.Dispose(Boolean) View.BeginInit() View.EndInit() View.SetWidth(Int32, Int32) View.SetHeight(Int32, Int32) View.GetCurrentWidth(Int32) View.GetCurrentHeight(Int32) View.GetNormalColor() 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) Declaration public override bool MouseEvent(MouseEvent me) Parameters Type Name Description MouseEvent me Returns Type Description System.Boolean Overrides Responder.MouseEvent(MouseEvent) OnEnter(View) Declaration public override bool OnEnter(View view) Parameters Type Name Description View view Returns Type Description System.Boolean Overrides View.OnEnter(View) PositionCursor() Declaration public override void PositionCursor() Overrides View.PositionCursor() ProcessColdKey(KeyEvent) Declaration public override bool ProcessColdKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides View.ProcessColdKey(KeyEvent) ProcessHotKey(KeyEvent) Declaration public override bool ProcessHotKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides View.ProcessHotKey(KeyEvent) ProcessKey(KeyEvent) Declaration public override bool ProcessKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides View.ProcessKey(KeyEvent) 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.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.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() 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.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.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.VerticalTextAlignment View.TextDirection 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 View.SetWidth(Int32, Int32) View.SetHeight(Int32, Int32) View.GetCurrentWidth(Int32) View.GetCurrentHeight(Int32) 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) Declaration public override bool MouseEvent(MouseEvent me) Parameters Type Name Description MouseEvent me Returns Type Description System.Boolean Overrides Responder.MouseEvent(MouseEvent) OnEnter(View) Declaration public override bool OnEnter(View view) Parameters Type Name Description View view Returns Type Description System.Boolean Overrides View.OnEnter(View) 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() Declaration public override void PositionCursor() Overrides View.PositionCursor() ProcessHotKey(KeyEvent) Declaration public override bool ProcessHotKey(KeyEvent ke) Parameters Type Name Description KeyEvent ke Returns Type Description System.Boolean Overrides View.ProcessHotKey(KeyEvent) ProcessKey(KeyEvent) Declaration public override bool ProcessKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides View.ProcessKey(KeyEvent) Redraw(Rect) Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds Overrides View.Redraw(Rect) 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.CanFocusChanged View.EnabledChanged View.VisibleChanged 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.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() 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.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.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.VerticalTextAlignment View.TextDirection View.IsInitialized View.Enabled View.Visible View.Border View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.OnCanFocusChanged() View.OnEnabledChanged() View.OnVisibleChanged() View.Dispose(Boolean) View.BeginInit() View.EndInit() View.SetWidth(Int32, Int32) View.SetHeight(Int32, Int32) View.GetCurrentWidth(Int32) View.GetCurrentHeight(Int32) View.GetNormalColor() 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) Declaration public override bool MouseEvent(MouseEvent me) Parameters Type Name Description MouseEvent me Returns Type Description System.Boolean Overrides Responder.MouseEvent(MouseEvent) OnEnter(View) Declaration public override bool OnEnter(View view) Parameters Type Name Description View view Returns Type Description System.Boolean Overrides View.OnEnter(View) 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() Declaration public override void PositionCursor() Overrides View.PositionCursor() ProcessHotKey(KeyEvent) Declaration public override bool ProcessHotKey(KeyEvent ke) Parameters Type Name Description KeyEvent ke Returns Type Description System.Boolean Overrides View.ProcessHotKey(KeyEvent) ProcessKey(KeyEvent) Declaration public override bool ProcessKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides View.ProcessKey(KeyEvent) Redraw(Rect) Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds Overrides View.Redraw(Rect) 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",
"title": "Class Clipboard",
- "keywords": "Class Clipboard Provides cut, copy, and paste support for the clipboard. NOTE: Currently not implemented. Inheritance System.Object Clipboard 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 Clipboard Properties Contents Declaration public static ustring Contents { get; set; } Property Value Type Description NStack.ustring"
+ "keywords": "Class Clipboard Provides cut, copy, and paste support for the clipboard with OS interaction. Inheritance System.Object Clipboard 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 Clipboard Properties Contents Get or sets the operation system clipboard, otherwise the contents field. Declaration public static ustring Contents { get; set; } Property Value Type Description NStack.ustring IsSupported Returns true if the environmental dependencies are in place to interact with the OS clipboard. Declaration public static bool IsSupported { get; } Property Value Type Description System.Boolean Methods TryGetClipboardData(out String) Gets the operation system clipboard if possible. Declaration public static bool TryGetClipboardData(out string result) Parameters Type Name Description System.String result Clipboard contents read Returns Type Description System.Boolean true if it was possible to read the OS clipboard. TrySetClipboardData(String) Sets the operation system clipboard if possible. Declaration public static bool TrySetClipboardData(string text) Parameters Type Name Description System.String text Returns Type Description System.Boolean True if the clipboard content was set successfully."
+ },
+ "api/Terminal.Gui/Terminal.Gui.ClipboardBase.html": {
+ "href": "api/Terminal.Gui/Terminal.Gui.ClipboardBase.html",
+ "title": "Class ClipboardBase",
+ "keywords": "Class ClipboardBase Shared abstract class to enforce rules from the implementation of the IClipboard interface. Inheritance System.Object ClipboardBase Implements IClipboard 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 abstract class ClipboardBase : IClipboard Properties IsSupported Returns true if the environmental dependencies are in place to interact with the OS clipboard Declaration public abstract bool IsSupported { get; } Property Value Type Description System.Boolean Methods GetClipboardData() Get the operation system clipboard. Declaration public string GetClipboardData() Returns Type Description System.String Exceptions Type Condition System.NotSupportedException Thrown if it was not possible to read the clipboard contents GetClipboardDataImpl() Get the operation system clipboard. Declaration protected abstract string GetClipboardDataImpl() Returns Type Description System.String SetClipboardData(String) Sets the operation system clipboard. Declaration public void SetClipboardData(string text) Parameters Type Name Description System.String text Exceptions Type Condition System.NotSupportedException Thrown if it was not possible to set the clipboard contents SetClipboardDataImpl(String) Sets the operation system clipboard. Declaration protected abstract void SetClipboardDataImpl(string text) Parameters Type Name Description System.String text TryGetClipboardData(out String) Gets the operation system clipboard if possible. Declaration public bool TryGetClipboardData(out string result) Parameters Type Name Description System.String result Clipboard contents read Returns Type Description System.Boolean true if it was possible to read the OS clipboard. TrySetClipboardData(String) Sets the operation system clipboard if possible. Declaration public bool TrySetClipboardData(string text) Parameters Type Name Description System.String text Returns Type Description System.Boolean True if the clipboard content was set successfully Implements IClipboard"
},
"api/Terminal.Gui/Terminal.Gui.Color.html": {
"href": "api/Terminal.Gui/Terminal.Gui.Color.html",
@@ -52,17 +77,17 @@
"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.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.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() 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.VerticalTextAlignment View.TextDirection 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 View.SetWidth(Int32, Int32) View.SetHeight(Int32, Int32) View.GetCurrentWidth(Int32) View.GetCurrentHeight(Int32) 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) Declaration public override bool MouseEvent(MouseEvent me) Parameters Type Name Description MouseEvent me Returns Type Description System.Boolean Overrides Responder.MouseEvent(MouseEvent) OnEnter(View) Declaration public override bool OnEnter(View view) Parameters Type Name Description View view Returns Type Description System.Boolean Overrides View.OnEnter(View) OnLeave(View) Declaration public override bool OnLeave(View view) Parameters Type Name Description View view Returns Type Description System.Boolean 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) Declaration public override bool ProcessKey(KeyEvent e) Parameters Type Name Description KeyEvent e Returns Type Description System.Boolean Overrides View.ProcessKey(KeyEvent) Redraw(Rect) Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds Overrides View.Redraw(Rect) 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.CanFocusChanged View.EnabledChanged View.VisibleChanged 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.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() 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.VerticalTextAlignment View.TextDirection View.IsInitialized View.Enabled View.Visible View.Border View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.OnCanFocusChanged() View.OnEnabledChanged() View.OnVisibleChanged() View.Dispose(Boolean) View.BeginInit() View.EndInit() View.SetWidth(Int32, Int32) View.SetHeight(Int32, Int32) View.GetCurrentWidth(Int32) View.GetCurrentHeight(Int32) View.GetNormalColor() 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 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 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) Declaration public override bool MouseEvent(MouseEvent me) Parameters Type Name Description MouseEvent me Returns Type Description System.Boolean Overrides Responder.MouseEvent(MouseEvent) OnEnter(View) Declaration public override bool OnEnter(View view) Parameters Type Name Description View view Returns Type Description System.Boolean Overrides View.OnEnter(View) OnLeave(View) Declaration public override bool OnLeave(View view) Parameters Type Name Description View view Returns Type Description System.Boolean 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) Declaration public override bool ProcessKey(KeyEvent e) Parameters Type Name Description KeyEvent e Returns Type Description System.Boolean Overrides View.ProcessKey(KeyEvent) Redraw(Rect) Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds Overrides View.Redraw(Rect) 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",
"title": "Enum ConsoleDriver.DiagnosticFlags",
- "keywords": "Enum ConsoleDriver.DiagnosticFlags Enables diagnostic functions Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax [Flags] public enum DiagnosticFlags : uint Fields Name Description FramePadding When Enabled, DrawWindowFrame(Rect, Int32, Int32, Int32, Int32, Boolean, Boolean) will use 'L', 'R', 'T', and 'B' for padding instead of ' '. FrameRuler When enabled, DrawWindowFrame(Rect, Int32, Int32, Int32, Int32, Boolean, Boolean) will draw a ruler in the frame for any side with a padding value greater than 0. Off All diagnostics off"
+ "keywords": "Enum ConsoleDriver.DiagnosticFlags Enables diagnostic functions Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax [Flags] public enum DiagnosticFlags : uint Fields Name Description FramePadding When Enabled, DrawWindowFrame(Rect, Int32, Int32, Int32, Int32, Boolean, Boolean, Border) will use 'L', 'R', 'T', and 'B' for padding instead of ' '. FrameRuler When enabled, DrawWindowFrame(Rect, Int32, Int32, Int32, Int32, Boolean, Boolean, Border) will draw a ruler in the frame for any side with a padding value greater than 0. Off All diagnostics off"
},
"api/Terminal.Gui/Terminal.Gui.ConsoleDriver.html": {
"href": "api/Terminal.Gui/Terminal.Gui.ConsoleDriver.html",
"title": "Class ConsoleDriver",
- "keywords": "Class 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. Inheritance System.Object ConsoleDriver FakeDriver 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 abstract class ConsoleDriver Fields BottomTee The bottom tee. Declaration public Rune BottomTee Field Value Type Description System.Rune Checked Checkmark. Declaration public Rune Checked Field Value Type Description System.Rune Diamond Diamond character Declaration public Rune Diamond Field Value Type Description System.Rune DownArrow Down Arrow. Declaration public Rune DownArrow Field Value Type Description System.Rune HLine Horizontal line character. Declaration public Rune HLine Field Value Type Description System.Rune LeftArrow Left Arrow. Declaration public Rune LeftArrow Field Value Type Description System.Rune LeftBracket Left frame/bracket (e.g. '[' for Button ). Declaration public Rune LeftBracket Field Value Type Description System.Rune LeftDefaultIndicator Left indicator for default action (e.g. for Button ). Declaration public Rune LeftDefaultIndicator Field Value Type Description System.Rune LeftTee Left tee Declaration public Rune LeftTee Field Value Type Description System.Rune LLCorner Lower left corner Declaration public Rune LLCorner Field Value Type Description System.Rune LRCorner Lower right corner Declaration public Rune LRCorner Field Value Type Description System.Rune OffMeterSegement Off Segment indicator for meter views (e.g. ProgressBar . Declaration public Rune OffMeterSegement Field Value Type Description System.Rune OnMeterSegment On Segment indicator for meter views (e.g. ProgressBar . Declaration public Rune OnMeterSegment Field Value Type Description System.Rune RightArrow Right Arrow. Declaration public Rune RightArrow Field Value Type Description System.Rune RightBracket Right frame/bracket (e.g. ']' for Button ). Declaration public Rune RightBracket Field Value Type Description System.Rune RightDefaultIndicator Right indicator for default action (e.g. for Button ). Declaration public Rune RightDefaultIndicator Field Value Type Description System.Rune RightTee Right tee Declaration public Rune RightTee Field Value Type Description System.Rune Selected Selected mark. Declaration public Rune Selected Field Value Type Description System.Rune Stipple Stipple pattern Declaration public Rune Stipple Field Value Type Description System.Rune TerminalResized The handler fired when the terminal is resized. Declaration protected Action TerminalResized Field Value Type Description System.Action TopTee Top tee Declaration public Rune TopTee Field Value Type Description System.Rune ULCorner Upper left corner Declaration public Rune ULCorner Field Value Type Description System.Rune UnChecked Un-checked checkmark. Declaration public Rune UnChecked Field Value Type Description System.Rune UnSelected Un-selected selected mark. Declaration public Rune UnSelected Field Value Type Description System.Rune UpArrow Up Arrow. Declaration public Rune UpArrow Field Value Type Description System.Rune URCorner Upper right corner Declaration public Rune URCorner Field Value Type Description System.Rune VLine Vertical line character. Declaration public Rune VLine Field Value Type Description System.Rune Properties Clip Controls the current clipping region that AddRune/AddStr is subject to. Declaration public Rect Clip { get; set; } Property Value Type Description Rect The clip. Cols The current number of columns in the terminal. Declaration public abstract int Cols { get; } Property Value Type Description System.Int32 Diagnostics Set flags to enable/disable ConsoleDriver diagnostics. Declaration public static ConsoleDriver.DiagnosticFlags Diagnostics { get; set; } Property Value Type Description ConsoleDriver.DiagnosticFlags HeightAsBuffer If false height is measured by the window height and thus no scrolling. If true then height is measured by the buffer height, enabling scrolling. Declaration public abstract bool HeightAsBuffer { get; set; } Property Value Type Description System.Boolean Rows The current number of rows in the terminal. Declaration public abstract int Rows { get; } Property Value Type Description System.Int32 Top The current top in the terminal. Declaration public abstract int Top { get; } Property Value Type Description System.Int32 Methods AddRune(Rune) Adds the specified rune to the display at the current cursor position Declaration public abstract void AddRune(Rune rune) Parameters Type Name Description System.Rune rune Rune to add. AddStr(ustring) Adds the specified Declaration public abstract void AddStr(ustring str) Parameters Type Name Description NStack.ustring str String. CookMouse() Enables the cooked event processing from the mouse driver Declaration public abstract void CookMouse() DrawFrame(Rect, Int32, Boolean) Draws a frame on the specified region with the specified padding around the frame. Declaration public virtual void DrawFrame(Rect region, int padding, bool fill) Parameters Type Name Description Rect region Screen relative region where the frame will be drawn. System.Int32 padding Padding to add on the sides. System.Boolean fill If set to true it will clear the contents with the current color, otherwise the contents will be left untouched. Remarks This API has been superseded by DrawWindowFrame(Rect, Int32, Int32, Int32, Int32, Boolean, Boolean) . DrawWindowFrame(Rect, Int32, Int32, Int32, Int32, Boolean, Boolean) Draws a frame for a window with padding and an optional visible border inside the padding. Declaration public virtual void DrawWindowFrame(Rect region, int paddingLeft = 0, int paddingTop = 0, int paddingRight = 0, int paddingBottom = 0, bool border = true, bool fill = false) Parameters Type Name Description Rect region Screen relative region where the frame will be drawn. System.Int32 paddingLeft Number of columns to pad on the left (if 0 the border will not appear on the left). System.Int32 paddingTop Number of rows to pad on the top (if 0 the border and title will not appear on the top). System.Int32 paddingRight Number of columns to pad on the right (if 0 the border will not appear on the right). System.Int32 paddingBottom Number of rows to pad on the bottom (if 0 the border will not appear on the bottom). System.Boolean border If set to true and any padding dimension is > 0 the border will be drawn. System.Boolean fill If set to true it will clear the content area (the area inside the padding) with the current color, otherwise the content area will be left untouched. DrawWindowTitle(Rect, ustring, Int32, Int32, Int32, Int32, TextAlignment) Draws the title for a Window-style view incorporating padding. Declaration public virtual void DrawWindowTitle(Rect region, ustring title, int paddingLeft, int paddingTop, int paddingRight, int paddingBottom, TextAlignment textAlignment = TextAlignment.Left) Parameters Type Name Description Rect region Screen relative region where the frame will be drawn. NStack.ustring title The title for the window. The title will only be drawn if title is not null or empty and paddingTop is greater than 0. System.Int32 paddingLeft Number of columns to pad on the left (if 0 the border will not appear on the left). System.Int32 paddingTop Number of rows to pad on the top (if 0 the border and title will not appear on the top). System.Int32 paddingRight Number of columns to pad on the right (if 0 the border will not appear on the right). System.Int32 paddingBottom Number of rows to pad on the bottom (if 0 the border will not appear on the bottom). TextAlignment textAlignment Not yet implemented. End() Ends the execution of the console driver. Declaration public abstract void End() EnsureCursorVisibility() Ensure the cursor visibility Declaration public abstract bool EnsureCursorVisibility() Returns Type Description System.Boolean true upon success GetAttribute() Gets the current Attribute . Declaration public abstract Attribute GetAttribute() Returns Type Description Attribute The current attribute. GetCursorVisibility(out CursorVisibility) Retreive the cursor caret visibility Declaration public abstract bool GetCursorVisibility(out CursorVisibility visibility) Parameters Type Name Description CursorVisibility visibility The current CursorVisibility Returns Type Description System.Boolean true upon success Init(Action) Initializes the driver Declaration public abstract void Init(Action terminalResized) Parameters Type Name Description System.Action terminalResized Method to invoke when the terminal is resized. MakeAttribute(Color, Color) Make the attribute for the foreground and background colors. Declaration public abstract Attribute MakeAttribute(Color fore, Color back) Parameters Type Name Description Color fore Foreground. Color back Background. Returns Type Description Attribute MakePrintable(Rune) Ensures a Rune is not a control character and can be displayed by translating characters below 0x20 to equivalent, printable, Unicode chars. Declaration public static Rune MakePrintable(Rune c) Parameters Type Name Description System.Rune c Rune to translate Returns Type Description System.Rune Move(Int32, Int32) Moves the cursor to the specified column and row. Declaration public abstract void Move(int col, int row) Parameters Type Name Description System.Int32 col Column to move the cursor to. System.Int32 row Row to move the cursor to. PrepareToRun(MainLoop, Action, Action, Action, Action) Prepare the driver and set the key and mouse events handlers. Declaration public abstract void PrepareToRun(MainLoop mainLoop, Action keyHandler, Action keyDownHandler, Action keyUpHandler, Action mouseHandler) Parameters Type Name Description MainLoop mainLoop The main loop. System.Action < KeyEvent > keyHandler The handler for ProcessKey System.Action < KeyEvent > keyDownHandler The handler for key down events System.Action < KeyEvent > keyUpHandler The handler for key up events System.Action < MouseEvent > mouseHandler The handler for mouse events Refresh() Updates the screen to reflect all the changes that have been done to the display buffer Declaration public abstract void Refresh() SendKeys(Char, ConsoleKey, Boolean, Boolean, Boolean) Allows sending keys without typing on a keyboard. Declaration public abstract void SendKeys(char keyChar, ConsoleKey key, bool shift, bool alt, bool control) Parameters Type Name Description System.Char keyChar The character key. System.ConsoleKey key The key. System.Boolean shift If shift key is sending. System.Boolean alt If alt key is sending. System.Boolean control If control key is sending. SetAttribute(Attribute) Selects the specified attribute as the attribute to use for future calls to AddRune, AddString. Declaration public abstract void SetAttribute(Attribute c) Parameters Type Name Description Attribute c C. SetColors(ConsoleColor, ConsoleColor) Set Colors from limit sets of colors. Declaration public abstract void SetColors(ConsoleColor foreground, ConsoleColor background) Parameters Type Name Description System.ConsoleColor foreground Foreground. System.ConsoleColor background Background. SetColors(Int16, Int16) Advanced uses - set colors to any pre-set pairs, you would need to init_color that independently with the R, G, B values. Declaration public abstract void SetColors(short foregroundColorId, short backgroundColorId) Parameters Type Name Description System.Int16 foregroundColorId Foreground color identifier. System.Int16 backgroundColorId Background color identifier. SetCursorVisibility(CursorVisibility) Change the cursor caret visibility Declaration public abstract bool SetCursorVisibility(CursorVisibility visibility) Parameters Type Name Description CursorVisibility visibility The wished CursorVisibility Returns Type Description System.Boolean true upon success SetTerminalResized(Action) Set the handler when the terminal is resized. Declaration public void SetTerminalResized(Action terminalResized) Parameters Type Name Description System.Action terminalResized StartReportingMouseMoves() Start of mouse moves. Declaration public abstract void StartReportingMouseMoves() StopReportingMouseMoves() Stop reporting mouses moves. Declaration public abstract void StopReportingMouseMoves() Suspend() Suspend the application, typically needs to save the state, suspend the app and upon return, reset the console driver. Declaration public abstract void Suspend() UncookMouse() Disables the cooked event processing from the mouse driver. At startup, it is assumed mouse events are cooked. Declaration public abstract void UncookMouse() UpdateCursor() Updates the location of the cursor position Declaration public abstract void UpdateCursor() UpdateScreen() Redraws the physical screen with the contents that have been queued up via any of the printing commands. Declaration public abstract void UpdateScreen()"
+ "keywords": "Class 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. Inheritance System.Object ConsoleDriver FakeDriver 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 abstract class ConsoleDriver Fields BlocksMeterSegment Blocks Segment indicator for meter views (e.g. ProgressBar . Declaration public Rune BlocksMeterSegment Field Value Type Description System.Rune BottomTee The bottom tee. Declaration public Rune BottomTee Field Value Type Description System.Rune Checked Checkmark. Declaration public Rune Checked Field Value Type Description System.Rune ContinuousMeterSegment Continuous Segment indicator for meter views (e.g. ProgressBar . Declaration public Rune ContinuousMeterSegment Field Value Type Description System.Rune Diamond Diamond character Declaration public Rune Diamond Field Value Type Description System.Rune DownArrow Down Arrow. Declaration public Rune DownArrow Field Value Type Description System.Rune HDLine Horizontal double line character. Declaration public Rune HDLine Field Value Type Description System.Rune HLine Horizontal line character. Declaration public Rune HLine Field Value Type Description System.Rune LeftArrow Left Arrow. Declaration public Rune LeftArrow Field Value Type Description System.Rune LeftBracket Left frame/bracket (e.g. '[' for Button ). Declaration public Rune LeftBracket Field Value Type Description System.Rune LeftDefaultIndicator Left indicator for default action (e.g. for Button ). Declaration public Rune LeftDefaultIndicator Field Value Type Description System.Rune LeftTee Left tee Declaration public Rune LeftTee Field Value Type Description System.Rune LLCorner Lower left corner Declaration public Rune LLCorner Field Value Type Description System.Rune LLDCorner Lower left double corner Declaration public Rune LLDCorner Field Value Type Description System.Rune LRCorner Lower right corner Declaration public Rune LRCorner Field Value Type Description System.Rune LRDCorner Lower right double corner Declaration public Rune LRDCorner Field Value Type Description System.Rune RightArrow Right Arrow. Declaration public Rune RightArrow Field Value Type Description System.Rune RightBracket Right frame/bracket (e.g. ']' for Button ). Declaration public Rune RightBracket Field Value Type Description System.Rune RightDefaultIndicator Right indicator for default action (e.g. for Button ). Declaration public Rune RightDefaultIndicator Field Value Type Description System.Rune RightTee Right tee Declaration public Rune RightTee Field Value Type Description System.Rune Selected Selected mark. Declaration public Rune Selected Field Value Type Description System.Rune Stipple Stipple pattern Declaration public Rune Stipple Field Value Type Description System.Rune TerminalResized The handler fired when the terminal is resized. Declaration protected Action TerminalResized Field Value Type Description System.Action TopTee Top tee Declaration public Rune TopTee Field Value Type Description System.Rune ULCorner Upper left corner Declaration public Rune ULCorner Field Value Type Description System.Rune ULDCorner Upper left double corner Declaration public Rune ULDCorner Field Value Type Description System.Rune UnChecked Un-checked checkmark. Declaration public Rune UnChecked Field Value Type Description System.Rune UnSelected Un-selected selected mark. Declaration public Rune UnSelected Field Value Type Description System.Rune UpArrow Up Arrow. Declaration public Rune UpArrow Field Value Type Description System.Rune URCorner Upper right corner Declaration public Rune URCorner Field Value Type Description System.Rune URDCorner Upper right double corner Declaration public Rune URDCorner Field Value Type Description System.Rune VDLine Vertical double line character. Declaration public Rune VDLine Field Value Type Description System.Rune VLine Vertical line character. Declaration public Rune VLine Field Value Type Description System.Rune Properties Clip Controls the current clipping region that AddRune/AddStr is subject to. Declaration public Rect Clip { get; set; } Property Value Type Description Rect The clip. Clipboard Get the operation system clipboard. Declaration public abstract IClipboard Clipboard { get; } Property Value Type Description IClipboard Cols The current number of columns in the terminal. Declaration public abstract int Cols { get; } Property Value Type Description System.Int32 Diagnostics Set flags to enable/disable ConsoleDriver diagnostics. Declaration public static ConsoleDriver.DiagnosticFlags Diagnostics { get; set; } Property Value Type Description ConsoleDriver.DiagnosticFlags HeightAsBuffer If false height is measured by the window height and thus no scrolling. If true then height is measured by the buffer height, enabling scrolling. Declaration public abstract bool HeightAsBuffer { get; set; } Property Value Type Description System.Boolean Left The current left in the terminal. Declaration public abstract int Left { get; } Property Value Type Description System.Int32 Rows The current number of rows in the terminal. Declaration public abstract int Rows { get; } Property Value Type Description System.Int32 Top The current top in the terminal. Declaration public abstract int Top { get; } Property Value Type Description System.Int32 Methods AddRune(Rune) Adds the specified rune to the display at the current cursor position Declaration public abstract void AddRune(Rune rune) Parameters Type Name Description System.Rune rune Rune to add. AddStr(ustring) Adds the specified Declaration public abstract void AddStr(ustring str) Parameters Type Name Description NStack.ustring str String. CookMouse() Enables the cooked event processing from the mouse driver Declaration public abstract void CookMouse() DrawFrame(Rect, Int32, Boolean) Draws a frame on the specified region with the specified padding around the frame. Declaration public virtual void DrawFrame(Rect region, int padding, bool fill) Parameters Type Name Description Rect region Screen relative region where the frame will be drawn. System.Int32 padding Padding to add on the sides. System.Boolean fill If set to true it will clear the contents with the current color, otherwise the contents will be left untouched. Remarks This API has been superseded by DrawWindowFrame(Rect, Int32, Int32, Int32, Int32, Boolean, Boolean, Border) . DrawWindowFrame(Rect, Int32, Int32, Int32, Int32, Boolean, Boolean, Border) Draws a frame for a window with padding and an optional visible border inside the padding. Declaration public virtual void DrawWindowFrame(Rect region, int paddingLeft = 0, int paddingTop = 0, int paddingRight = 0, int paddingBottom = 0, bool border = true, bool fill = false, Border borderContent = null) Parameters Type Name Description Rect region Screen relative region where the frame will be drawn. System.Int32 paddingLeft Number of columns to pad on the left (if 0 the border will not appear on the left). System.Int32 paddingTop Number of rows to pad on the top (if 0 the border and title will not appear on the top). System.Int32 paddingRight Number of columns to pad on the right (if 0 the border will not appear on the right). System.Int32 paddingBottom Number of rows to pad on the bottom (if 0 the border will not appear on the bottom). System.Boolean border If set to true and any padding dimension is > 0 the border will be drawn. System.Boolean fill If set to true it will clear the content area (the area inside the padding) with the current color, otherwise the content area will be left untouched. Border borderContent The Border to be used if defined. DrawWindowTitle(Rect, ustring, Int32, Int32, Int32, Int32, TextAlignment) Draws the title for a Window-style view incorporating padding. Declaration public virtual void DrawWindowTitle(Rect region, ustring title, int paddingLeft, int paddingTop, int paddingRight, int paddingBottom, TextAlignment textAlignment = TextAlignment.Left) Parameters Type Name Description Rect region Screen relative region where the frame will be drawn. NStack.ustring title The title for the window. The title will only be drawn if title is not null or empty and paddingTop is greater than 0. System.Int32 paddingLeft Number of columns to pad on the left (if 0 the border will not appear on the left). System.Int32 paddingTop Number of rows to pad on the top (if 0 the border and title will not appear on the top). System.Int32 paddingRight Number of columns to pad on the right (if 0 the border will not appear on the right). System.Int32 paddingBottom Number of rows to pad on the bottom (if 0 the border will not appear on the bottom). TextAlignment textAlignment Not yet implemented. End() Ends the execution of the console driver. Declaration public abstract void End() EnsureCursorVisibility() Ensure the cursor visibility Declaration public abstract bool EnsureCursorVisibility() Returns Type Description System.Boolean true upon success GetAttribute() Gets the current Attribute . Declaration public abstract Attribute GetAttribute() Returns Type Description Attribute The current attribute. GetColors(Int32, out Color, out Color) Gets the foreground and background colors based on the value. Declaration public abstract bool GetColors(int value, out Color foreground, out Color background) Parameters Type Name Description System.Int32 value The value. Color foreground The foreground. Color background The background. Returns Type Description System.Boolean GetCursorVisibility(out CursorVisibility) Retreive the cursor caret visibility Declaration public abstract bool GetCursorVisibility(out CursorVisibility visibility) Parameters Type Name Description CursorVisibility visibility The current CursorVisibility Returns Type Description System.Boolean true upon success Init(Action) Initializes the driver Declaration public abstract void Init(Action terminalResized) Parameters Type Name Description System.Action terminalResized Method to invoke when the terminal is resized. MakeAttribute(Color, Color) Make the attribute for the foreground and background colors. Declaration public abstract Attribute MakeAttribute(Color fore, Color back) Parameters Type Name Description Color fore Foreground. Color back Background. Returns Type Description Attribute MakePrintable(Rune) Ensures a Rune is not a control character and can be displayed by translating characters below 0x20 to equivalent, printable, Unicode chars. Declaration public static Rune MakePrintable(Rune c) Parameters Type Name Description System.Rune c Rune to translate Returns Type Description System.Rune Move(Int32, Int32) Moves the cursor to the specified column and row. Declaration public abstract void Move(int col, int row) Parameters Type Name Description System.Int32 col Column to move the cursor to. System.Int32 row Row to move the cursor to. PrepareToRun(MainLoop, Action, Action, Action, Action) Prepare the driver and set the key and mouse events handlers. Declaration public abstract void PrepareToRun(MainLoop mainLoop, Action keyHandler, Action keyDownHandler, Action keyUpHandler, Action mouseHandler) Parameters Type Name Description MainLoop mainLoop The main loop. System.Action < KeyEvent > keyHandler The handler for ProcessKey System.Action < KeyEvent > keyDownHandler The handler for key down events System.Action < KeyEvent > keyUpHandler The handler for key up events System.Action < MouseEvent > mouseHandler The handler for mouse events Refresh() Updates the screen to reflect all the changes that have been done to the display buffer Declaration public abstract void Refresh() SendKeys(Char, ConsoleKey, Boolean, Boolean, Boolean) Allows sending keys without typing on a keyboard. Declaration public abstract void SendKeys(char keyChar, ConsoleKey key, bool shift, bool alt, bool control) Parameters Type Name Description System.Char keyChar The character key. System.ConsoleKey key The key. System.Boolean shift If shift key is sending. System.Boolean alt If alt key is sending. System.Boolean control If control key is sending. SetAttribute(Attribute) Selects the specified attribute as the attribute to use for future calls to AddRune, AddString. Declaration public abstract void SetAttribute(Attribute c) Parameters Type Name Description Attribute c C. SetColors(ConsoleColor, ConsoleColor) Set Colors from limit sets of colors. Declaration public abstract void SetColors(ConsoleColor foreground, ConsoleColor background) Parameters Type Name Description System.ConsoleColor foreground Foreground. System.ConsoleColor background Background. SetColors(Int16, Int16) Advanced uses - set colors to any pre-set pairs, you would need to init_color that independently with the R, G, B values. Declaration public abstract void SetColors(short foregroundColorId, short backgroundColorId) Parameters Type Name Description System.Int16 foregroundColorId Foreground color identifier. System.Int16 backgroundColorId Background color identifier. SetCursorVisibility(CursorVisibility) Change the cursor caret visibility Declaration public abstract bool SetCursorVisibility(CursorVisibility visibility) Parameters Type Name Description CursorVisibility visibility The wished CursorVisibility Returns Type Description System.Boolean true upon success SetTerminalResized(Action) Set the handler when the terminal is resized. Declaration public void SetTerminalResized(Action terminalResized) Parameters Type Name Description System.Action terminalResized StartReportingMouseMoves() Start of mouse moves. Declaration public abstract void StartReportingMouseMoves() StopReportingMouseMoves() Stop reporting mouses moves. Declaration public abstract void StopReportingMouseMoves() Suspend() Suspend the application, typically needs to save the state, suspend the app and upon return, reset the console driver. Declaration public abstract void Suspend() UncookMouse() Disables the cooked event processing from the mouse driver. At startup, it is assumed mouse events are cooked. Declaration public abstract void UncookMouse() UpdateCursor() Updates the location of the cursor position Declaration public abstract void UpdateCursor() UpdateScreen() Redraws the physical screen with the contents that have been queued up via any of the printing commands. Declaration public abstract void UpdateScreen()"
},
"api/Terminal.Gui/Terminal.Gui.CursorVisibility.html": {
"href": "api/Terminal.Gui/Terminal.Gui.CursorVisibility.html",
@@ -72,7 +97,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.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) TextField.DesiredCursorVisibility TextField.OnEnter(View) 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.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() 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.AutoSize View.TextAlignment View.VerticalTextAlignment View.TextDirection 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 View.SetWidth(Int32, Int32) View.SetHeight(Int32, Int32) View.GetCurrentWidth(Int32) View.GetCurrentHeight(Int32) 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) Declaration public override bool MouseEvent(MouseEvent ev) Parameters Type Name Description MouseEvent ev Returns Type Description System.Boolean 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) Declaration public override bool ProcessKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides TextField.ProcessKey(KeyEvent) 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) TextField.DesiredCursorVisibility TextField.OnEnter(View) View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.CanFocusChanged View.EnabledChanged View.VisibleChanged 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.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() 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.AutoSize View.TextAlignment View.VerticalTextAlignment View.TextDirection View.IsInitialized View.Enabled View.Visible View.Border View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.OnCanFocusChanged() View.OnEnabledChanged() View.OnVisibleChanged() View.Dispose(Boolean) View.BeginInit() View.EndInit() View.SetWidth(Int32, Int32) View.SetHeight(Int32, Int32) View.GetCurrentWidth(Int32) View.GetCurrentHeight(Int32) View.GetNormalColor() 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) Declaration public override bool MouseEvent(MouseEvent ev) Parameters Type Name Description MouseEvent ev Returns Type Description System.Boolean 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) Declaration public override bool ProcessKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides TextField.ProcessKey(KeyEvent) 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",
@@ -82,7 +107,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.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.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() 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.VerticalTextAlignment View.TextDirection 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 View.SetWidth(Int32, Int32) View.SetHeight(Int32, Int32) View.GetCurrentWidth(Int32) View.GetCurrentHeight(Int32) 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(Func) . 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 initialization 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 initialization 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 initialization 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) Declaration public override bool ProcessKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides Toplevel.ProcessKey(KeyEvent) 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.Border Window.Add(View) Window.Remove(View) Window.RemoveAll() Window.Redraw(Rect) Window.OnCanFocusChanged() Window.Text Window.TextAlignment Toplevel.Running Toplevel.Loaded Toplevel.Ready Toplevel.Unloaded Toplevel.Activate Toplevel.Deactivate Toplevel.ChildClosed Toplevel.AllChildClosed Toplevel.Closing Toplevel.Closed Toplevel.ChildLoaded Toplevel.ChildUnloaded Toplevel.Create() Toplevel.CanFocus Toplevel.Modal Toplevel.MenuBar Toplevel.StatusBar Toplevel.IsMdiContainer Toplevel.IsMdiChild Toplevel.OnKeyDown(KeyEvent) Toplevel.OnKeyUp(KeyEvent) Toplevel.ProcessColdKey(KeyEvent) Toplevel.PositionToplevel(Toplevel) Toplevel.MouseEvent(MouseEvent) Toplevel.WillPresent() Toplevel.MoveNext() Toplevel.MovePrevious() Toplevel.RequestStop() Toplevel.RequestStop(Toplevel) Toplevel.PositionCursor() Toplevel.GetTopMdiChild(Type, String[]) Toplevel.ShowChild(Toplevel) View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.CanFocusChanged View.EnabledChanged View.VisibleChanged 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.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() 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.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.VerticalTextAlignment View.TextDirection View.IsInitialized View.Enabled View.Visible View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.OnEnabledChanged() View.OnVisibleChanged() View.Dispose(Boolean) View.BeginInit() View.EndInit() View.SetWidth(Int32, Int32) View.SetHeight(Int32, Int32) View.GetCurrentWidth(Int32) View.GetCurrentHeight(Int32) View.GetNormalColor() 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(Func) . 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(Toplevel) . 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 initialization 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 initialization 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 initialization 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) Declaration public override bool ProcessKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides Toplevel.ProcessKey(KeyEvent) Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize"
},
"api/Terminal.Gui/Terminal.Gui.Dim.html": {
"href": "api/Terminal.Gui/Terminal.Gui.Dim.html",
@@ -97,12 +122,12 @@
"api/Terminal.Gui/Terminal.Gui.FakeConsole.html": {
"href": "api/Terminal.Gui/Terminal.Gui.FakeConsole.html",
"title": "Class FakeConsole",
- "keywords": "Class FakeConsole Inheritance System.Object FakeConsole 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 FakeConsole Fields MockKeyPresses Declaration public static Stack MockKeyPresses Field Value Type Description System.Collections.Generic.Stack < System.ConsoleKeyInfo > Properties BackgroundColor Declaration public static ConsoleColor BackgroundColor { get; set; } Property Value Type Description System.ConsoleColor BufferHeight Declaration public static int BufferHeight { get; set; } Property Value Type Description System.Int32 BufferWidth Declaration public static int BufferWidth { get; set; } Property Value Type Description System.Int32 CapsLock Declaration public static bool CapsLock { get; } Property Value Type Description System.Boolean CursorLeft Declaration public static int CursorLeft { get; set; } Property Value Type Description System.Int32 CursorSize Declaration public static int CursorSize { get; set; } Property Value Type Description System.Int32 CursorTop Declaration public static int CursorTop { get; set; } Property Value Type Description System.Int32 CursorVisible Declaration public static bool CursorVisible { get; set; } Property Value Type Description System.Boolean Error Declaration public static TextWriter Error { get; } Property Value Type Description System.IO.TextWriter ForegroundColor Declaration public static ConsoleColor ForegroundColor { get; set; } Property Value Type Description System.ConsoleColor In Declaration public static TextReader In { get; } Property Value Type Description System.IO.TextReader InputEncoding Declaration public static Encoding InputEncoding { get; set; } Property Value Type Description System.Text.Encoding IsErrorRedirected Declaration public static bool IsErrorRedirected { get; } Property Value Type Description System.Boolean IsInputRedirected Declaration public static bool IsInputRedirected { get; } Property Value Type Description System.Boolean IsOutputRedirected Declaration public static bool IsOutputRedirected { get; } Property Value Type Description System.Boolean KeyAvailable Declaration public static bool KeyAvailable { get; } Property Value Type Description System.Boolean LargestWindowHeight Declaration public static int LargestWindowHeight { get; } Property Value Type Description System.Int32 LargestWindowWidth Declaration public static int LargestWindowWidth { get; } Property Value Type Description System.Int32 NumberLock Declaration public static bool NumberLock { get; } Property Value Type Description System.Boolean Out Declaration public static TextWriter Out { get; } Property Value Type Description System.IO.TextWriter OutputEncoding Declaration public static Encoding OutputEncoding { get; set; } Property Value Type Description System.Text.Encoding Title Declaration public static string Title { get; set; } Property Value Type Description System.String TreatControlCAsInput Declaration public static bool TreatControlCAsInput { get; set; } Property Value Type Description System.Boolean WindowHeight Declaration public static int WindowHeight { get; set; } Property Value Type Description System.Int32 WindowLeft Declaration public static int WindowLeft { get; set; } Property Value Type Description System.Int32 WindowTop Declaration public static int WindowTop { get; set; } Property Value Type Description System.Int32 WindowWidth Declaration public static int WindowWidth { get; set; } Property Value Type Description System.Int32 Methods Beep() Declaration public static void Beep() Beep(Int32, Int32) Declaration public static void Beep(int frequency, int duration) Parameters Type Name Description System.Int32 frequency System.Int32 duration Clear() Declaration public static void Clear() MoveBufferArea(Int32, Int32, Int32, Int32, Int32, Int32) Declaration public static void MoveBufferArea(int sourceLeft, int sourceTop, int sourceWidth, int sourceHeight, int targetLeft, int targetTop) Parameters Type Name Description System.Int32 sourceLeft System.Int32 sourceTop System.Int32 sourceWidth System.Int32 sourceHeight System.Int32 targetLeft System.Int32 targetTop MoveBufferArea(Int32, Int32, Int32, Int32, Int32, Int32, Char, ConsoleColor, ConsoleColor) Declaration public static void MoveBufferArea(int sourceLeft, int sourceTop, int sourceWidth, int sourceHeight, int targetLeft, int targetTop, char sourceChar, ConsoleColor sourceForeColor, ConsoleColor sourceBackColor) Parameters Type Name Description System.Int32 sourceLeft System.Int32 sourceTop System.Int32 sourceWidth System.Int32 sourceHeight System.Int32 targetLeft System.Int32 targetTop System.Char sourceChar System.ConsoleColor sourceForeColor System.ConsoleColor sourceBackColor OpenStandardError() Declaration public static Stream OpenStandardError() Returns Type Description System.IO.Stream OpenStandardError(Int32) Declaration public static Stream OpenStandardError(int bufferSize) Parameters Type Name Description System.Int32 bufferSize Returns Type Description System.IO.Stream OpenStandardInput() Declaration public static Stream OpenStandardInput() Returns Type Description System.IO.Stream OpenStandardInput(Int32) Declaration public static Stream OpenStandardInput(int bufferSize) Parameters Type Name Description System.Int32 bufferSize Returns Type Description System.IO.Stream OpenStandardOutput() Declaration public static Stream OpenStandardOutput() Returns Type Description System.IO.Stream OpenStandardOutput(Int32) Declaration public static Stream OpenStandardOutput(int bufferSize) Parameters Type Name Description System.Int32 bufferSize Returns Type Description System.IO.Stream Read() Declaration public static int Read() Returns Type Description System.Int32 ReadKey() Declaration public static ConsoleKeyInfo ReadKey() Returns Type Description System.ConsoleKeyInfo ReadKey(Boolean) Declaration public static ConsoleKeyInfo ReadKey(bool intercept) Parameters Type Name Description System.Boolean intercept Returns Type Description System.ConsoleKeyInfo ReadLine() Declaration public static string ReadLine() Returns Type Description System.String ResetColor() Declaration public static void ResetColor() SetBufferSize(Int32, Int32) Declaration public static void SetBufferSize(int width, int height) Parameters Type Name Description System.Int32 width System.Int32 height SetCursorPosition(Int32, Int32) Declaration public static void SetCursorPosition(int left, int top) Parameters Type Name Description System.Int32 left System.Int32 top SetError(TextWriter) Declaration public static void SetError(TextWriter newError) Parameters Type Name Description System.IO.TextWriter newError SetIn(TextReader) Declaration public static void SetIn(TextReader newIn) Parameters Type Name Description System.IO.TextReader newIn SetOut(TextWriter) Declaration public static void SetOut(TextWriter newOut) Parameters Type Name Description System.IO.TextWriter newOut SetWindowPosition(Int32, Int32) Declaration public static void SetWindowPosition(int left, int top) Parameters Type Name Description System.Int32 left System.Int32 top SetWindowSize(Int32, Int32) Declaration public static void SetWindowSize(int width, int height) Parameters Type Name Description System.Int32 width System.Int32 height Write(Boolean) Declaration public static void Write(bool value) Parameters Type Name Description System.Boolean value Write(Char) Declaration public static void Write(char value) Parameters Type Name Description System.Char value Write(Char[]) Declaration public static void Write(char[] buffer) Parameters Type Name Description System.Char [] buffer Write(Char[], Int32, Int32) Declaration public static void Write(char[] buffer, int index, int count) Parameters Type Name Description System.Char [] buffer System.Int32 index System.Int32 count Write(Decimal) Declaration public static void Write(decimal value) Parameters Type Name Description System.Decimal value Write(Double) Declaration public static void Write(double value) Parameters Type Name Description System.Double value Write(Int32) Declaration public static void Write(int value) Parameters Type Name Description System.Int32 value Write(Int64) Declaration public static void Write(long value) Parameters Type Name Description System.Int64 value Write(Object) Declaration public static void Write(object value) Parameters Type Name Description System.Object value Write(Single) Declaration public static void Write(float value) Parameters Type Name Description System.Single value Write(String) Declaration public static void Write(string value) Parameters Type Name Description System.String value Write(String, Object) Declaration public static void Write(string format, object arg0) Parameters Type Name Description System.String format System.Object arg0 Write(String, Object, Object) Declaration public static void Write(string format, object arg0, object arg1) Parameters Type Name Description System.String format System.Object arg0 System.Object arg1 Write(String, Object, Object, Object) Declaration public static void Write(string format, object arg0, object arg1, object arg2) Parameters Type Name Description System.String format System.Object arg0 System.Object arg1 System.Object arg2 Write(String, Object, Object, Object, Object) Declaration public static void Write(string format, object arg0, object arg1, object arg2, object arg3) Parameters Type Name Description System.String format System.Object arg0 System.Object arg1 System.Object arg2 System.Object arg3 Write(String, Object[]) Declaration public static void Write(string format, params object[] arg) Parameters Type Name Description System.String format System.Object [] arg Write(UInt32) Declaration public static void Write(uint value) Parameters Type Name Description System.UInt32 value Write(UInt64) Declaration public static void Write(ulong value) Parameters Type Name Description System.UInt64 value WriteLine() Declaration public static void WriteLine() WriteLine(Boolean) Declaration public static void WriteLine(bool value) Parameters Type Name Description System.Boolean value WriteLine(Char) Declaration public static void WriteLine(char value) Parameters Type Name Description System.Char value WriteLine(Char[]) Declaration public static void WriteLine(char[] buffer) Parameters Type Name Description System.Char [] buffer WriteLine(Char[], Int32, Int32) Declaration public static void WriteLine(char[] buffer, int index, int count) Parameters Type Name Description System.Char [] buffer System.Int32 index System.Int32 count WriteLine(Decimal) Declaration public static void WriteLine(decimal value) Parameters Type Name Description System.Decimal value WriteLine(Double) Declaration public static void WriteLine(double value) Parameters Type Name Description System.Double value WriteLine(Int32) Declaration public static void WriteLine(int value) Parameters Type Name Description System.Int32 value WriteLine(Int64) Declaration public static void WriteLine(long value) Parameters Type Name Description System.Int64 value WriteLine(Object) Declaration public static void WriteLine(object value) Parameters Type Name Description System.Object value WriteLine(Single) Declaration public static void WriteLine(float value) Parameters Type Name Description System.Single value WriteLine(String) Declaration public static void WriteLine(string value) Parameters Type Name Description System.String value WriteLine(String, Object) Declaration public static void WriteLine(string format, object arg0) Parameters Type Name Description System.String format System.Object arg0 WriteLine(String, Object, Object) Declaration public static void WriteLine(string format, object arg0, object arg1) Parameters Type Name Description System.String format System.Object arg0 System.Object arg1 WriteLine(String, Object, Object, Object) Declaration public static void WriteLine(string format, object arg0, object arg1, object arg2) Parameters Type Name Description System.String format System.Object arg0 System.Object arg1 System.Object arg2 WriteLine(String, Object, Object, Object, Object) Declaration public static void WriteLine(string format, object arg0, object arg1, object arg2, object arg3) Parameters Type Name Description System.String format System.Object arg0 System.Object arg1 System.Object arg2 System.Object arg3 WriteLine(String, Object[]) Declaration public static void WriteLine(string format, params object[] arg) Parameters Type Name Description System.String format System.Object [] arg WriteLine(UInt32) Declaration public static void WriteLine(uint value) Parameters Type Name Description System.UInt32 value WriteLine(UInt64) Declaration public static void WriteLine(ulong value) Parameters Type Name Description System.UInt64 value"
+ "keywords": "Class FakeConsole Inheritance System.Object FakeConsole 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 FakeConsole Fields HEIGHT Specifies the initial console height. Declaration public const int HEIGHT = 25 Field Value Type Description System.Int32 MockKeyPresses Declaration public static Stack MockKeyPresses Field Value Type Description System.Collections.Generic.Stack < System.ConsoleKeyInfo > WIDTH Specifies the initial console width. Declaration public const int WIDTH = 80 Field Value Type Description System.Int32 Properties BackgroundColor Declaration public static ConsoleColor BackgroundColor { get; set; } Property Value Type Description System.ConsoleColor BufferHeight Declaration public static int BufferHeight { get; set; } Property Value Type Description System.Int32 BufferWidth Declaration public static int BufferWidth { get; set; } Property Value Type Description System.Int32 CapsLock Declaration public static bool CapsLock { get; } Property Value Type Description System.Boolean CursorLeft Declaration public static int CursorLeft { get; set; } Property Value Type Description System.Int32 CursorSize Declaration public static int CursorSize { get; set; } Property Value Type Description System.Int32 CursorTop Declaration public static int CursorTop { get; set; } Property Value Type Description System.Int32 CursorVisible Declaration public static bool CursorVisible { get; set; } Property Value Type Description System.Boolean Error Declaration public static TextWriter Error { get; } Property Value Type Description System.IO.TextWriter ForegroundColor Declaration public static ConsoleColor ForegroundColor { get; set; } Property Value Type Description System.ConsoleColor In Declaration public static TextReader In { get; } Property Value Type Description System.IO.TextReader InputEncoding Declaration public static Encoding InputEncoding { get; set; } Property Value Type Description System.Text.Encoding IsErrorRedirected Declaration public static bool IsErrorRedirected { get; } Property Value Type Description System.Boolean IsInputRedirected Declaration public static bool IsInputRedirected { get; } Property Value Type Description System.Boolean IsOutputRedirected Declaration public static bool IsOutputRedirected { get; } Property Value Type Description System.Boolean KeyAvailable Declaration public static bool KeyAvailable { get; } Property Value Type Description System.Boolean LargestWindowHeight Declaration public static int LargestWindowHeight { get; } Property Value Type Description System.Int32 LargestWindowWidth Declaration public static int LargestWindowWidth { get; } Property Value Type Description System.Int32 NumberLock Declaration public static bool NumberLock { get; } Property Value Type Description System.Boolean Out Declaration public static TextWriter Out { get; } Property Value Type Description System.IO.TextWriter OutputEncoding Declaration public static Encoding OutputEncoding { get; set; } Property Value Type Description System.Text.Encoding Title Declaration public static string Title { get; set; } Property Value Type Description System.String TreatControlCAsInput Declaration public static bool TreatControlCAsInput { get; set; } Property Value Type Description System.Boolean WindowHeight Declaration public static int WindowHeight { get; set; } Property Value Type Description System.Int32 WindowLeft Declaration public static int WindowLeft { get; set; } Property Value Type Description System.Int32 WindowTop Declaration public static int WindowTop { get; set; } Property Value Type Description System.Int32 WindowWidth Declaration public static int WindowWidth { get; set; } Property Value Type Description System.Int32 Methods Beep() Declaration public static void Beep() Beep(Int32, Int32) Declaration public static void Beep(int frequency, int duration) Parameters Type Name Description System.Int32 frequency System.Int32 duration Clear() Declaration public static void Clear() MoveBufferArea(Int32, Int32, Int32, Int32, Int32, Int32) Declaration public static void MoveBufferArea(int sourceLeft, int sourceTop, int sourceWidth, int sourceHeight, int targetLeft, int targetTop) Parameters Type Name Description System.Int32 sourceLeft System.Int32 sourceTop System.Int32 sourceWidth System.Int32 sourceHeight System.Int32 targetLeft System.Int32 targetTop MoveBufferArea(Int32, Int32, Int32, Int32, Int32, Int32, Char, ConsoleColor, ConsoleColor) Declaration public static void MoveBufferArea(int sourceLeft, int sourceTop, int sourceWidth, int sourceHeight, int targetLeft, int targetTop, char sourceChar, ConsoleColor sourceForeColor, ConsoleColor sourceBackColor) Parameters Type Name Description System.Int32 sourceLeft System.Int32 sourceTop System.Int32 sourceWidth System.Int32 sourceHeight System.Int32 targetLeft System.Int32 targetTop System.Char sourceChar System.ConsoleColor sourceForeColor System.ConsoleColor sourceBackColor OpenStandardError() Declaration public static Stream OpenStandardError() Returns Type Description System.IO.Stream OpenStandardError(Int32) Declaration public static Stream OpenStandardError(int bufferSize) Parameters Type Name Description System.Int32 bufferSize Returns Type Description System.IO.Stream OpenStandardInput() Declaration public static Stream OpenStandardInput() Returns Type Description System.IO.Stream OpenStandardInput(Int32) Declaration public static Stream OpenStandardInput(int bufferSize) Parameters Type Name Description System.Int32 bufferSize Returns Type Description System.IO.Stream OpenStandardOutput() Declaration public static Stream OpenStandardOutput() Returns Type Description System.IO.Stream OpenStandardOutput(Int32) Declaration public static Stream OpenStandardOutput(int bufferSize) Parameters Type Name Description System.Int32 bufferSize Returns Type Description System.IO.Stream Read() Declaration public static int Read() Returns Type Description System.Int32 ReadKey() Declaration public static ConsoleKeyInfo ReadKey() Returns Type Description System.ConsoleKeyInfo ReadKey(Boolean) Declaration public static ConsoleKeyInfo ReadKey(bool intercept) Parameters Type Name Description System.Boolean intercept Returns Type Description System.ConsoleKeyInfo ReadLine() Declaration public static string ReadLine() Returns Type Description System.String ResetColor() Declaration public static void ResetColor() SetBufferSize(Int32, Int32) Declaration public static void SetBufferSize(int width, int height) Parameters Type Name Description System.Int32 width System.Int32 height SetCursorPosition(Int32, Int32) Declaration public static void SetCursorPosition(int left, int top) Parameters Type Name Description System.Int32 left System.Int32 top SetError(TextWriter) Declaration public static void SetError(TextWriter newError) Parameters Type Name Description System.IO.TextWriter newError SetIn(TextReader) Declaration public static void SetIn(TextReader newIn) Parameters Type Name Description System.IO.TextReader newIn SetOut(TextWriter) Declaration public static void SetOut(TextWriter newOut) Parameters Type Name Description System.IO.TextWriter newOut SetWindowPosition(Int32, Int32) Declaration public static void SetWindowPosition(int left, int top) Parameters Type Name Description System.Int32 left System.Int32 top SetWindowSize(Int32, Int32) Declaration public static void SetWindowSize(int width, int height) Parameters Type Name Description System.Int32 width System.Int32 height Write(Boolean) Declaration public static void Write(bool value) Parameters Type Name Description System.Boolean value Write(Char) Declaration public static void Write(char value) Parameters Type Name Description System.Char value Write(Char[]) Declaration public static void Write(char[] buffer) Parameters Type Name Description System.Char [] buffer Write(Char[], Int32, Int32) Declaration public static void Write(char[] buffer, int index, int count) Parameters Type Name Description System.Char [] buffer System.Int32 index System.Int32 count Write(Decimal) Declaration public static void Write(decimal value) Parameters Type Name Description System.Decimal value Write(Double) Declaration public static void Write(double value) Parameters Type Name Description System.Double value Write(Int32) Declaration public static void Write(int value) Parameters Type Name Description System.Int32 value Write(Int64) Declaration public static void Write(long value) Parameters Type Name Description System.Int64 value Write(Object) Declaration public static void Write(object value) Parameters Type Name Description System.Object value Write(Single) Declaration public static void Write(float value) Parameters Type Name Description System.Single value Write(String) Declaration public static void Write(string value) Parameters Type Name Description System.String value Write(String, Object) Declaration public static void Write(string format, object arg0) Parameters Type Name Description System.String format System.Object arg0 Write(String, Object, Object) Declaration public static void Write(string format, object arg0, object arg1) Parameters Type Name Description System.String format System.Object arg0 System.Object arg1 Write(String, Object, Object, Object) Declaration public static void Write(string format, object arg0, object arg1, object arg2) Parameters Type Name Description System.String format System.Object arg0 System.Object arg1 System.Object arg2 Write(String, Object, Object, Object, Object) Declaration public static void Write(string format, object arg0, object arg1, object arg2, object arg3) Parameters Type Name Description System.String format System.Object arg0 System.Object arg1 System.Object arg2 System.Object arg3 Write(String, Object[]) Declaration public static void Write(string format, params object[] arg) Parameters Type Name Description System.String format System.Object [] arg Write(UInt32) Declaration public static void Write(uint value) Parameters Type Name Description System.UInt32 value Write(UInt64) Declaration public static void Write(ulong value) Parameters Type Name Description System.UInt64 value WriteLine() Declaration public static void WriteLine() WriteLine(Boolean) Declaration public static void WriteLine(bool value) Parameters Type Name Description System.Boolean value WriteLine(Char) Declaration public static void WriteLine(char value) Parameters Type Name Description System.Char value WriteLine(Char[]) Declaration public static void WriteLine(char[] buffer) Parameters Type Name Description System.Char [] buffer WriteLine(Char[], Int32, Int32) Declaration public static void WriteLine(char[] buffer, int index, int count) Parameters Type Name Description System.Char [] buffer System.Int32 index System.Int32 count WriteLine(Decimal) Declaration public static void WriteLine(decimal value) Parameters Type Name Description System.Decimal value WriteLine(Double) Declaration public static void WriteLine(double value) Parameters Type Name Description System.Double value WriteLine(Int32) Declaration public static void WriteLine(int value) Parameters Type Name Description System.Int32 value WriteLine(Int64) Declaration public static void WriteLine(long value) Parameters Type Name Description System.Int64 value WriteLine(Object) Declaration public static void WriteLine(object value) Parameters Type Name Description System.Object value WriteLine(Single) Declaration public static void WriteLine(float value) Parameters Type Name Description System.Single value WriteLine(String) Declaration public static void WriteLine(string value) Parameters Type Name Description System.String value WriteLine(String, Object) Declaration public static void WriteLine(string format, object arg0) Parameters Type Name Description System.String format System.Object arg0 WriteLine(String, Object, Object) Declaration public static void WriteLine(string format, object arg0, object arg1) Parameters Type Name Description System.String format System.Object arg0 System.Object arg1 WriteLine(String, Object, Object, Object) Declaration public static void WriteLine(string format, object arg0, object arg1, object arg2) Parameters Type Name Description System.String format System.Object arg0 System.Object arg1 System.Object arg2 WriteLine(String, Object, Object, Object, Object) Declaration public static void WriteLine(string format, object arg0, object arg1, object arg2, object arg3) Parameters Type Name Description System.String format System.Object arg0 System.Object arg1 System.Object arg2 System.Object arg3 WriteLine(String, Object[]) Declaration public static void WriteLine(string format, params object[] arg) Parameters Type Name Description System.String format System.Object [] arg WriteLine(UInt32) Declaration public static void WriteLine(uint value) Parameters Type Name Description System.UInt32 value WriteLine(UInt64) Declaration public static void WriteLine(ulong value) Parameters Type Name Description System.UInt64 value"
},
"api/Terminal.Gui/Terminal.Gui.FakeDriver.html": {
"href": "api/Terminal.Gui/Terminal.Gui.FakeDriver.html",
"title": "Class FakeDriver",
- "keywords": "Class FakeDriver Implements a mock ConsoleDriver for unit testing Inheritance System.Object ConsoleDriver FakeDriver Inherited Members ConsoleDriver.TerminalResized ConsoleDriver.MakePrintable(Rune) ConsoleDriver.SetTerminalResized(Action) ConsoleDriver.DrawWindowTitle(Rect, ustring, Int32, Int32, Int32, Int32, TextAlignment) ConsoleDriver.Diagnostics ConsoleDriver.DrawWindowFrame(Rect, Int32, Int32, Int32, Int32, Boolean, Boolean) ConsoleDriver.DrawFrame(Rect, Int32, Boolean) ConsoleDriver.Clip ConsoleDriver.HLine ConsoleDriver.VLine ConsoleDriver.Stipple ConsoleDriver.Diamond ConsoleDriver.ULCorner ConsoleDriver.LLCorner ConsoleDriver.URCorner ConsoleDriver.LRCorner ConsoleDriver.LeftTee ConsoleDriver.RightTee ConsoleDriver.TopTee ConsoleDriver.BottomTee ConsoleDriver.Checked ConsoleDriver.UnChecked ConsoleDriver.Selected ConsoleDriver.UnSelected ConsoleDriver.RightArrow ConsoleDriver.LeftArrow ConsoleDriver.DownArrow ConsoleDriver.UpArrow ConsoleDriver.LeftDefaultIndicator ConsoleDriver.RightDefaultIndicator ConsoleDriver.LeftBracket ConsoleDriver.RightBracket ConsoleDriver.OnMeterSegment ConsoleDriver.OffMeterSegement 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 FakeDriver : ConsoleDriver Constructors FakeDriver() Declaration public FakeDriver() Properties Cols Declaration public override int Cols { get; } Property Value Type Description System.Int32 Overrides ConsoleDriver.Cols Contents Assists with testing, the format is rows, columns and 3 values on the last column: Rune, Attribute and Dirty Flag Declaration public int[,, ] Contents { get; } Property Value Type Description System.Int32 [,,] HeightAsBuffer Declaration public override bool HeightAsBuffer { get; set; } Property Value Type Description System.Boolean Overrides ConsoleDriver.HeightAsBuffer Rows Declaration public override int Rows { get; } Property Value Type Description System.Int32 Overrides ConsoleDriver.Rows Top Declaration public override int Top { get; } Property Value Type Description System.Int32 Overrides ConsoleDriver.Top Methods AddRune(Rune) Declaration public override void AddRune(Rune rune) Parameters Type Name Description System.Rune rune Overrides ConsoleDriver.AddRune(Rune) AddStr(ustring) Declaration public override void AddStr(ustring str) Parameters Type Name Description NStack.ustring str Overrides ConsoleDriver.AddStr(ustring) CookMouse() Declaration public override void CookMouse() Overrides ConsoleDriver.CookMouse() End() Declaration public override void End() Overrides ConsoleDriver.End() EnsureCursorVisibility() Declaration public override bool EnsureCursorVisibility() Returns Type Description System.Boolean Overrides ConsoleDriver.EnsureCursorVisibility() GetAttribute() Declaration public override Attribute GetAttribute() Returns Type Description Attribute Overrides ConsoleDriver.GetAttribute() GetCursorVisibility(out CursorVisibility) Declaration public override bool GetCursorVisibility(out CursorVisibility visibility) Parameters Type Name Description CursorVisibility visibility Returns Type Description System.Boolean Overrides ConsoleDriver.GetCursorVisibility(out CursorVisibility) Init(Action) Declaration public override void Init(Action terminalResized) Parameters Type Name Description System.Action terminalResized Overrides ConsoleDriver.Init(Action) MakeAttribute(Color, Color) Declaration public override Attribute MakeAttribute(Color fore, Color back) Parameters Type Name Description Color fore Color back Returns Type Description Attribute Overrides ConsoleDriver.MakeAttribute(Color, Color) Move(Int32, Int32) Declaration public override void Move(int col, int row) Parameters Type Name Description System.Int32 col System.Int32 row Overrides ConsoleDriver.Move(Int32, Int32) PrepareToRun(MainLoop, Action, Action, Action, Action) Declaration public override void PrepareToRun(MainLoop mainLoop, Action keyHandler, Action keyDownHandler, Action keyUpHandler, Action mouseHandler) Parameters Type Name Description MainLoop mainLoop System.Action < KeyEvent > keyHandler System.Action < KeyEvent > keyDownHandler System.Action < KeyEvent > keyUpHandler System.Action < MouseEvent > mouseHandler Overrides ConsoleDriver.PrepareToRun(MainLoop, Action, Action, Action, Action) Refresh() Declaration public override void Refresh() Overrides ConsoleDriver.Refresh() SendKeys(Char, ConsoleKey, Boolean, Boolean, Boolean) Declaration public override void SendKeys(char keyChar, ConsoleKey key, bool shift, bool alt, bool control) Parameters Type Name Description System.Char keyChar System.ConsoleKey key System.Boolean shift System.Boolean alt System.Boolean control Overrides ConsoleDriver.SendKeys(Char, ConsoleKey, Boolean, Boolean, Boolean) SetAttribute(Attribute) Declaration public override void SetAttribute(Attribute c) Parameters Type Name Description Attribute c Overrides ConsoleDriver.SetAttribute(Attribute) SetColors(ConsoleColor, ConsoleColor) Declaration public override void SetColors(ConsoleColor foreground, ConsoleColor background) Parameters Type Name Description System.ConsoleColor foreground System.ConsoleColor background Overrides ConsoleDriver.SetColors(ConsoleColor, ConsoleColor) SetColors(Int16, Int16) Declaration public override void SetColors(short foregroundColorId, short backgroundColorId) Parameters Type Name Description System.Int16 foregroundColorId System.Int16 backgroundColorId Overrides ConsoleDriver.SetColors(Int16, Int16) SetCursorVisibility(CursorVisibility) Declaration public override bool SetCursorVisibility(CursorVisibility visibility) Parameters Type Name Description CursorVisibility visibility Returns Type Description System.Boolean Overrides ConsoleDriver.SetCursorVisibility(CursorVisibility) StartReportingMouseMoves() Declaration public override void StartReportingMouseMoves() Overrides ConsoleDriver.StartReportingMouseMoves() StopReportingMouseMoves() Declaration public override void StopReportingMouseMoves() Overrides ConsoleDriver.StopReportingMouseMoves() Suspend() Declaration public override void Suspend() Overrides ConsoleDriver.Suspend() UncookMouse() Declaration public override void UncookMouse() Overrides ConsoleDriver.UncookMouse() UpdateCursor() Declaration public override void UpdateCursor() Overrides ConsoleDriver.UpdateCursor() UpdateScreen() Declaration public override void UpdateScreen() Overrides ConsoleDriver.UpdateScreen()"
+ "keywords": "Class FakeDriver Implements a mock ConsoleDriver for unit testing Inheritance System.Object ConsoleDriver FakeDriver Inherited Members ConsoleDriver.TerminalResized ConsoleDriver.MakePrintable(Rune) ConsoleDriver.SetTerminalResized(Action) ConsoleDriver.DrawWindowTitle(Rect, ustring, Int32, Int32, Int32, Int32, TextAlignment) ConsoleDriver.Diagnostics ConsoleDriver.DrawWindowFrame(Rect, Int32, Int32, Int32, Int32, Boolean, Boolean, Border) ConsoleDriver.DrawFrame(Rect, Int32, Boolean) ConsoleDriver.Clip ConsoleDriver.HLine ConsoleDriver.VLine ConsoleDriver.Stipple ConsoleDriver.Diamond ConsoleDriver.ULCorner ConsoleDriver.LLCorner ConsoleDriver.URCorner ConsoleDriver.LRCorner ConsoleDriver.LeftTee ConsoleDriver.RightTee ConsoleDriver.TopTee ConsoleDriver.BottomTee ConsoleDriver.Checked ConsoleDriver.UnChecked ConsoleDriver.Selected ConsoleDriver.UnSelected ConsoleDriver.RightArrow ConsoleDriver.LeftArrow ConsoleDriver.DownArrow ConsoleDriver.UpArrow ConsoleDriver.LeftDefaultIndicator ConsoleDriver.RightDefaultIndicator ConsoleDriver.LeftBracket ConsoleDriver.RightBracket ConsoleDriver.BlocksMeterSegment ConsoleDriver.ContinuousMeterSegment ConsoleDriver.HDLine ConsoleDriver.VDLine ConsoleDriver.ULDCorner ConsoleDriver.LLDCorner ConsoleDriver.URDCorner ConsoleDriver.LRDCorner 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 FakeDriver : ConsoleDriver Constructors FakeDriver() Declaration public FakeDriver() Properties Clipboard Declaration public override IClipboard Clipboard { get; } Property Value Type Description IClipboard Overrides ConsoleDriver.Clipboard Cols Declaration public override int Cols { get; } Property Value Type Description System.Int32 Overrides ConsoleDriver.Cols HeightAsBuffer Declaration public override bool HeightAsBuffer { get; set; } Property Value Type Description System.Boolean Overrides ConsoleDriver.HeightAsBuffer Left Declaration public override int Left { get; } Property Value Type Description System.Int32 Overrides ConsoleDriver.Left Rows Declaration public override int Rows { get; } Property Value Type Description System.Int32 Overrides ConsoleDriver.Rows Top Declaration public override int Top { get; } Property Value Type Description System.Int32 Overrides ConsoleDriver.Top Methods AddRune(Rune) Declaration public override void AddRune(Rune rune) Parameters Type Name Description System.Rune rune Overrides ConsoleDriver.AddRune(Rune) AddStr(ustring) Declaration public override void AddStr(ustring str) Parameters Type Name Description NStack.ustring str Overrides ConsoleDriver.AddStr(ustring) CookMouse() Declaration public override void CookMouse() Overrides ConsoleDriver.CookMouse() End() Declaration public override void End() Overrides ConsoleDriver.End() EnsureCursorVisibility() Declaration public override bool EnsureCursorVisibility() Returns Type Description System.Boolean Overrides ConsoleDriver.EnsureCursorVisibility() GetAttribute() Declaration public override Attribute GetAttribute() Returns Type Description Attribute Overrides ConsoleDriver.GetAttribute() GetColors(Int32, out Color, out Color) Declaration public override bool GetColors(int value, out Color foreground, out Color background) Parameters Type Name Description System.Int32 value Color foreground Color background Returns Type Description System.Boolean Overrides ConsoleDriver.GetColors(Int32, out Color, out Color) GetCursorVisibility(out CursorVisibility) Declaration public override bool GetCursorVisibility(out CursorVisibility visibility) Parameters Type Name Description CursorVisibility visibility Returns Type Description System.Boolean Overrides ConsoleDriver.GetCursorVisibility(out CursorVisibility) Init(Action) Declaration public override void Init(Action terminalResized) Parameters Type Name Description System.Action terminalResized Overrides ConsoleDriver.Init(Action) MakeAttribute(Color, Color) Declaration public override Attribute MakeAttribute(Color fore, Color back) Parameters Type Name Description Color fore Color back Returns Type Description Attribute Overrides ConsoleDriver.MakeAttribute(Color, Color) Move(Int32, Int32) Declaration public override void Move(int col, int row) Parameters Type Name Description System.Int32 col System.Int32 row Overrides ConsoleDriver.Move(Int32, Int32) PrepareToRun(MainLoop, Action, Action, Action, Action) Declaration public override void PrepareToRun(MainLoop mainLoop, Action keyHandler, Action keyDownHandler, Action keyUpHandler, Action mouseHandler) Parameters Type Name Description MainLoop mainLoop System.Action < KeyEvent > keyHandler System.Action < KeyEvent > keyDownHandler System.Action < KeyEvent > keyUpHandler System.Action < MouseEvent > mouseHandler Overrides ConsoleDriver.PrepareToRun(MainLoop, Action, Action, Action, Action) Refresh() Declaration public override void Refresh() Overrides ConsoleDriver.Refresh() SendKeys(Char, ConsoleKey, Boolean, Boolean, Boolean) Declaration public override void SendKeys(char keyChar, ConsoleKey key, bool shift, bool alt, bool control) Parameters Type Name Description System.Char keyChar System.ConsoleKey key System.Boolean shift System.Boolean alt System.Boolean control Overrides ConsoleDriver.SendKeys(Char, ConsoleKey, Boolean, Boolean, Boolean) SetAttribute(Attribute) Declaration public override void SetAttribute(Attribute c) Parameters Type Name Description Attribute c Overrides ConsoleDriver.SetAttribute(Attribute) SetBufferSize(Int32, Int32) Declaration public void SetBufferSize(int width, int height) Parameters Type Name Description System.Int32 width System.Int32 height SetColors(ConsoleColor, ConsoleColor) Declaration public override void SetColors(ConsoleColor foreground, ConsoleColor background) Parameters Type Name Description System.ConsoleColor foreground System.ConsoleColor background Overrides ConsoleDriver.SetColors(ConsoleColor, ConsoleColor) SetColors(Int16, Int16) Declaration public override void SetColors(short foregroundColorId, short backgroundColorId) Parameters Type Name Description System.Int16 foregroundColorId System.Int16 backgroundColorId Overrides ConsoleDriver.SetColors(Int16, Int16) SetCursorVisibility(CursorVisibility) Declaration public override bool SetCursorVisibility(CursorVisibility visibility) Parameters Type Name Description CursorVisibility visibility Returns Type Description System.Boolean Overrides ConsoleDriver.SetCursorVisibility(CursorVisibility) SetWindowPosition(Int32, Int32) Declaration public void SetWindowPosition(int left, int top) Parameters Type Name Description System.Int32 left System.Int32 top SetWindowSize(Int32, Int32) Declaration public void SetWindowSize(int width, int height) Parameters Type Name Description System.Int32 width System.Int32 height StartReportingMouseMoves() Declaration public override void StartReportingMouseMoves() Overrides ConsoleDriver.StartReportingMouseMoves() StopReportingMouseMoves() Declaration public override void StopReportingMouseMoves() Overrides ConsoleDriver.StopReportingMouseMoves() Suspend() Declaration public override void Suspend() Overrides ConsoleDriver.Suspend() UncookMouse() Declaration public override void UncookMouse() Overrides ConsoleDriver.UncookMouse() UpdateCursor() Declaration public override void UpdateCursor() Overrides ConsoleDriver.UpdateCursor() UpdateScreen() Declaration public override void UpdateScreen() Overrides ConsoleDriver.UpdateScreen()"
},
"api/Terminal.Gui/Terminal.Gui.FakeMainLoop.html": {
"href": "api/Terminal.Gui/Terminal.Gui.FakeMainLoop.html",
@@ -112,12 +137,12 @@
"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.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.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() 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.VerticalTextAlignment View.TextDirection 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 View.SetWidth(Int32, Int32) View.SetHeight(Int32, Int32) View.GetCurrentWidth(Int32) View.GetCurrentHeight(Int32) 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) Initializes a new instance of FileDialog Declaration public FileDialog(ustring title, ustring prompt, ustring message) Parameters Type Name Description NStack.ustring title The title. NStack.ustring prompt The prompt. NStack.ustring message The message. 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 of the file field label.. NStack.ustring message The message. FileDialog(ustring, ustring, ustring, ustring, ustring) Initializes a new instance of FileDialog Declaration public FileDialog(ustring title, ustring prompt, ustring nameDirLabel, ustring nameFieldLabel, ustring message) Parameters Type Name Description NStack.ustring title The title. NStack.ustring prompt The prompt. NStack.ustring nameDirLabel The name of the directory field label. NStack.ustring nameFieldLabel The name of the file 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. NameDirLabel Gets or sets the name of the directory field label. Declaration public ustring NameDirLabel { get; set; } Property Value Type Description NStack.ustring The name of the directory field label. 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() 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.Border Window.Add(View) Window.Remove(View) Window.RemoveAll() Window.Redraw(Rect) Window.OnCanFocusChanged() Window.Text Window.TextAlignment Toplevel.Running Toplevel.Loaded Toplevel.Ready Toplevel.Unloaded Toplevel.Activate Toplevel.Deactivate Toplevel.ChildClosed Toplevel.AllChildClosed Toplevel.Closing Toplevel.Closed Toplevel.ChildLoaded Toplevel.ChildUnloaded Toplevel.Create() Toplevel.CanFocus Toplevel.Modal Toplevel.MenuBar Toplevel.StatusBar Toplevel.IsMdiContainer Toplevel.IsMdiChild Toplevel.OnKeyDown(KeyEvent) Toplevel.OnKeyUp(KeyEvent) Toplevel.ProcessColdKey(KeyEvent) Toplevel.PositionToplevel(Toplevel) Toplevel.MouseEvent(MouseEvent) Toplevel.MoveNext() Toplevel.MovePrevious() Toplevel.RequestStop() Toplevel.RequestStop(Toplevel) Toplevel.PositionCursor() Toplevel.GetTopMdiChild(Type, String[]) Toplevel.ShowChild(Toplevel) View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.CanFocusChanged View.EnabledChanged View.VisibleChanged 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.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() 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.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.VerticalTextAlignment View.TextDirection View.IsInitialized View.Enabled View.Visible View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.OnEnabledChanged() View.OnVisibleChanged() View.Dispose(Boolean) View.BeginInit() View.EndInit() View.SetWidth(Int32, Int32) View.SetHeight(Int32, Int32) View.GetCurrentWidth(Int32) View.GetCurrentHeight(Int32) View.GetNormalColor() 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, ustring, List) Initializes a new instance of FileDialog Declaration public FileDialog(ustring title, ustring prompt, ustring nameDirLabel, ustring nameFieldLabel, ustring message, List allowedTypes = null) Parameters Type Name Description NStack.ustring title The title. NStack.ustring prompt The prompt. NStack.ustring nameDirLabel The name of the directory field label. NStack.ustring nameFieldLabel The name of the file field label.. NStack.ustring message The message. System.Collections.Generic.List < System.String > allowedTypes The allowed types. FileDialog(ustring, ustring, ustring, ustring, List) Initializes a new instance of FileDialog Declaration public FileDialog(ustring title, ustring prompt, ustring nameFieldLabel, ustring message, List allowedTypes = null) Parameters Type Name Description NStack.ustring title The title. NStack.ustring prompt The prompt. NStack.ustring nameFieldLabel The name of the file field label.. NStack.ustring message The message. System.Collections.Generic.List < System.String > allowedTypes The allowed types. FileDialog(ustring, ustring, ustring, List) Initializes a new instance of FileDialog Declaration public FileDialog(ustring title, ustring prompt, ustring message, List allowedTypes) Parameters Type Name Description NStack.ustring title The title. NStack.ustring prompt The prompt. NStack.ustring message The message. System.Collections.Generic.List < System.String > allowedTypes The allowed types. 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. NameDirLabel Gets or sets the name of the directory field label. Declaration public ustring NameDirLabel { get; set; } Property Value Type Description NStack.ustring The name of the directory field label. 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() 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.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.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() 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.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.VerticalTextAlignment View.TextDirection 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 View.SetWidth(Int32, Int32) View.SetHeight(Int32, Int32) View.GetCurrentWidth(Int32) View.GetCurrentHeight(Int32) 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) OnEnter(View) Declaration public override bool OnEnter(View view) Parameters Type Name Description View view Returns Type Description System.Boolean Overrides View.OnEnter(View) Redraw(Rect) Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds Overrides View.Redraw(Rect) 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.CanFocusChanged View.EnabledChanged View.VisibleChanged 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.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() 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.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.VerticalTextAlignment View.TextDirection View.IsInitialized View.Enabled View.Visible View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.OnEnabledChanged() View.OnVisibleChanged() View.Dispose(Boolean) View.BeginInit() View.EndInit() View.SetWidth(Int32, Int32) View.SetHeight(Int32, Int32) View.GetCurrentWidth(Int32) View.GetCurrentHeight(Int32) View.GetNormalColor() 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, Border) Initializes a new instance of the FrameView class using Computed layout. Declaration public FrameView(ustring title, Border border = null) Parameters Type Name Description NStack.ustring title Title. Border border The Border . FrameView(Rect, ustring, View[], Border) Initializes a new instance of the FrameView class using Absolute layout. Declaration public FrameView(Rect frame, ustring title = null, View[] views = null, Border border = null) Parameters Type Name Description Rect frame Frame. NStack.ustring title Title. View [] views Views. Border border The Border . Properties Border Declaration public override Border Border { get; set; } Property Value Type Description Border Overrides View.Border 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) OnCanFocusChanged() Declaration public override void OnCanFocusChanged() Overrides View.OnCanFocusChanged() OnEnter(View) Declaration public override bool OnEnter(View view) Parameters Type Name Description View view Returns Type Description System.Boolean Overrides View.OnEnter(View) Redraw(Rect) Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds Overrides View.Redraw(Rect) 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.Graphs.Axis.html": {
"href": "api/Terminal.Gui/Terminal.Gui.Graphs.Axis.html",
@@ -212,17 +237,22 @@
"api/Terminal.Gui/Terminal.Gui.GraphView.html": {
"href": "api/Terminal.Gui/Terminal.Gui.GraphView.html",
"title": "Class GraphView",
- "keywords": "Class GraphView Control for rendering graphs (bar, scatter etc) Inheritance System.Object Responder View GraphView 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.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() 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.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.VerticalTextAlignment View.TextDirection 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 View.SetWidth(Int32, Int32) View.SetHeight(Int32, Int32) View.GetCurrentWidth(Int32) View.GetCurrentHeight(Int32) 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 GraphView : View, IDisposable, ISupportInitializeNotification, ISupportInitialize Constructors GraphView() Creates a new graph with a 1 to 1 graph space with absolute layout Declaration public GraphView() Properties Annotations Elements drawn into graph after series have been drawn e.g. Legends etc Declaration public List Annotations { get; } Property Value Type Description System.Collections.Generic.List < IAnnotation > AxisX Horizontal axis Declaration public HorizontalAxis AxisX { get; set; } Property Value Type Description HorizontalAxis AxisY Vertical axis Declaration public VerticalAxis AxisY { get; set; } Property Value Type Description VerticalAxis CellSize Translates console width/height into graph space. Defaults to 1 row/col of console space being 1 unit of graph space. Declaration public PointF CellSize { get; set; } Property Value Type Description PointF GraphColor The color of the background of the graph and axis/labels Declaration public Attribute? GraphColor { get; set; } Property Value Type Description System.Nullable < Attribute > MarginBottom Amount of space to leave on bottom of control. Graph content ( Series ) will not be rendered in margins but axis labels may be Declaration public uint MarginBottom { get; set; } Property Value Type Description System.UInt32 MarginLeft Amount of space to leave on left of control. Graph content ( Series ) will not be rendered in margins but axis labels may be Declaration public uint MarginLeft { get; set; } Property Value Type Description System.UInt32 ScrollOffset The graph space position of the bottom left of the control. Changing this scrolls the viewport around in the graph Declaration public PointF ScrollOffset { get; set; } Property Value Type Description PointF Series Collection of data series that are rendered in the graph Declaration public List Series { get; } Property Value Type Description System.Collections.Generic.List < ISeries > Methods DrawLine(Point, Point, Rune) Draws a line between two points in screen space. Can be diagonals. Declaration public void DrawLine(Point start, Point end, Rune symbol) Parameters Type Name Description Point start Point end System.Rune symbol The symbol to use for the line GraphSpaceToScreen(PointF) Calculates the screen location for a given point in graph space. Bear in mind these be off screen Declaration public Point GraphSpaceToScreen(PointF location) Parameters Type Name Description PointF location Point in graph space that may or may not be represented in the visible area of graph currently presented. E.g. 0,0 for origin Returns Type Description Point Screen position (Column/Row) which would be used to render the graph location . Note that this can be outside the current client area of the control ProcessKey(KeyEvent) Declaration public override bool ProcessKey(KeyEvent keyEvent) Parameters Type Name Description KeyEvent keyEvent Returns Type Description System.Boolean Overrides View.ProcessKey(KeyEvent) Redraw(Rect) Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds Overrides View.Redraw(Rect) Reset() Clears all settings configured on the graph and resets all properties to default values ( CellSize , ScrollOffset etc) Declaration public void Reset() ScreenToGraphSpace(Int32, Int32) Returns the section of the graph that is represented by the given screen position Declaration public RectangleF ScreenToGraphSpace(int col, int row) Parameters Type Name Description System.Int32 col System.Int32 row Returns Type Description RectangleF ScreenToGraphSpace(Rect) Returns the section of the graph that is represented by the screen area Declaration public RectangleF ScreenToGraphSpace(Rect screenArea) Parameters Type Name Description Rect screenArea Returns Type Description RectangleF SetDriverColorToGraphColor() Sets the color attribute of Driver to the GraphColor (if defined) or ColorScheme otherwise. Declaration public void SetDriverColorToGraphColor() Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize"
+ "keywords": "Class GraphView Control for rendering graphs (bar, scatter etc) Inheritance System.Object Responder View GraphView 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.CanFocusChanged View.EnabledChanged View.VisibleChanged 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.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() 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.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.VerticalTextAlignment View.TextDirection View.IsInitialized View.Enabled View.Visible View.Border View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.OnCanFocusChanged() View.OnEnabledChanged() View.OnVisibleChanged() View.Dispose(Boolean) View.BeginInit() View.EndInit() View.SetWidth(Int32, Int32) View.SetHeight(Int32, Int32) View.GetCurrentWidth(Int32) View.GetCurrentHeight(Int32) View.GetNormalColor() 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 GraphView : View, IDisposable, ISupportInitializeNotification, ISupportInitialize Constructors GraphView() Creates a new graph with a 1 to 1 graph space with absolute layout Declaration public GraphView() Properties Annotations Elements drawn into graph after series have been drawn e.g. Legends etc Declaration public List Annotations { get; } Property Value Type Description System.Collections.Generic.List < IAnnotation > AxisX Horizontal axis Declaration public HorizontalAxis AxisX { get; set; } Property Value Type Description HorizontalAxis AxisY Vertical axis Declaration public VerticalAxis AxisY { get; set; } Property Value Type Description VerticalAxis CellSize Translates console width/height into graph space. Defaults to 1 row/col of console space being 1 unit of graph space. Declaration public PointF CellSize { get; set; } Property Value Type Description PointF GraphColor The color of the background of the graph and axis/labels Declaration public Attribute? GraphColor { get; set; } Property Value Type Description System.Nullable < Attribute > MarginBottom Amount of space to leave on bottom of control. Graph content ( Series ) will not be rendered in margins but axis labels may be Declaration public uint MarginBottom { get; set; } Property Value Type Description System.UInt32 MarginLeft Amount of space to leave on left of control. Graph content ( Series ) will not be rendered in margins but axis labels may be Declaration public uint MarginLeft { get; set; } Property Value Type Description System.UInt32 ScrollOffset The graph space position of the bottom left of the control. Changing this scrolls the viewport around in the graph Declaration public PointF ScrollOffset { get; set; } Property Value Type Description PointF Series Collection of data series that are rendered in the graph Declaration public List Series { get; } Property Value Type Description System.Collections.Generic.List < ISeries > Methods DrawLine(Point, Point, Rune) Draws a line between two points in screen space. Can be diagonals. Declaration public void DrawLine(Point start, Point end, Rune symbol) Parameters Type Name Description Point start Point end System.Rune symbol The symbol to use for the line GraphSpaceToScreen(PointF) Calculates the screen location for a given point in graph space. Bear in mind these be off screen Declaration public Point GraphSpaceToScreen(PointF location) Parameters Type Name Description PointF location Point in graph space that may or may not be represented in the visible area of graph currently presented. E.g. 0,0 for origin Returns Type Description Point Screen position (Column/Row) which would be used to render the graph location . Note that this can be outside the current client area of the control ProcessKey(KeyEvent) Declaration public override bool ProcessKey(KeyEvent keyEvent) Parameters Type Name Description KeyEvent keyEvent Returns Type Description System.Boolean Overrides View.ProcessKey(KeyEvent) Redraw(Rect) Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds Overrides View.Redraw(Rect) Reset() Clears all settings configured on the graph and resets all properties to default values ( CellSize , ScrollOffset etc) Declaration public void Reset() ScreenToGraphSpace(Int32, Int32) Returns the section of the graph that is represented by the given screen position Declaration public RectangleF ScreenToGraphSpace(int col, int row) Parameters Type Name Description System.Int32 col System.Int32 row Returns Type Description RectangleF ScreenToGraphSpace(Rect) Returns the section of the graph that is represented by the screen area Declaration public RectangleF ScreenToGraphSpace(Rect screenArea) Parameters Type Name Description Rect screenArea Returns Type Description RectangleF SetDriverColorToGraphColor() Sets the color attribute of Driver to the GraphColor (if defined) or ColorScheme otherwise. Declaration public void SetDriverColorToGraphColor() 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.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.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() 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.VerticalTextAlignment View.TextDirection 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 View.SetWidth(Int32, Int32) View.SetHeight(Int32, Int32) View.GetCurrentWidth(Int32) View.GetCurrentHeight(Int32) 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 . DesiredCursorVisibility Get / Set the wished cursor when the field is focused Declaration public CursorVisibility DesiredCursorVisibility { get; set; } Property Value Type Description CursorVisibility 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 Declaration public override Rect Frame { get; set; } Property Value Type Description Rect Overrides View.Frame 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() Declaration public override void PositionCursor() Overrides View.PositionCursor() ProcessKey(KeyEvent) Declaration public override bool ProcessKey(KeyEvent keyEvent) Parameters Type Name Description KeyEvent keyEvent Returns Type Description System.Boolean Overrides View.ProcessKey(KeyEvent) Redraw(Rect) Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds Overrides View.Redraw(Rect) 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.CanFocusChanged View.EnabledChanged View.VisibleChanged 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.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() 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.VerticalTextAlignment View.TextDirection View.IsInitialized View.Enabled View.Visible View.Border View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.OnCanFocusChanged() View.OnEnabledChanged() View.OnVisibleChanged() View.Dispose(Boolean) View.BeginInit() View.EndInit() View.SetWidth(Int32, Int32) View.SetHeight(Int32, Int32) View.GetCurrentWidth(Int32) View.GetCurrentHeight(Int32) View.GetNormalColor() 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 . DesiredCursorVisibility Get / Set the wished cursor when the field is focused Declaration public CursorVisibility DesiredCursorVisibility { get; set; } Property Value Type Description CursorVisibility 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 Declaration public override Rect Frame { get; set; } Property Value Type Description Rect Overrides View.Frame 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() Declaration public override void PositionCursor() Overrides View.PositionCursor() ProcessKey(KeyEvent) Declaration public override bool ProcessKey(KeyEvent keyEvent) Parameters Type Name Description KeyEvent keyEvent Returns Type Description System.Boolean Overrides View.ProcessKey(KeyEvent) Redraw(Rect) Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds Overrides View.Redraw(Rect) 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 FakeMainLoop 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. 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. GraphView Control for rendering graphs (bar, scatter etc) 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. 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 . TableView View for tabular data based on a System.Data.DataTable . See TableView Deep Dive for more information . TableView.CellActivatedEventArgs Defines the event arguments for CellActivated event TableView.ColumnStyle Describes how to render a given column in a TableView including Alignment and textual representation of cells (e.g. date formats) See TableView Deep Dive for more information . TableView.SelectedCellChangedEventArgs Defines the event arguments for SelectedCellChanged TableView.TableSelection Describes a selected region of the table TableView.TableStyle Defines rendering options that affect how the table is displayed. See TableView Deep Dive for more information . TabView Control that hosts multiple sub views, presenting a single one at once TabView.Tab A single tab in a TabView TabView.TabChangedEventArgs Describes a change in SelectedTab TabView.TabStyle Describes render stylistic selections of a TabView 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. TextValidateField Text field that validates input through a ITextValidateProvider TextView Multi-line text editing View TimeField Time editing View Toplevel Toplevel views can be modally executed. TreeView Convenience implementation of generic TreeView for any tree were all nodes implement ITreeNode . See TreeView Deep Dive for more information . TreeView Hierarchical tree view with expandable branches. Branch objects are dynamically determined when expanded using a user defined ITreeBuilder See TreeView Deep Dive for more information . 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. PointF Represents an ordered pair of x and y coordinates that define a point in a two-dimensional plane. Rect Stores a set of four integers that represent the location and size of a rectangle RectangleF Stores the location and size of a rectangular region. Size Stores an ordered pair of integers, which specify a Height and Width. SizeF Represents the size of a rectangular region with an ordered pair of width and height. Interfaces IListDataSource Implement IListDataSource to provide custom rendering for a ListView . IMainLoopDriver Public interface to create your own platform specific main loop driver. ITreeView Interface for all non generic members of TreeView See TreeView Deep Dive for more information . Enums Color Basic colors that can be used to set the foreground and background colors in console applications. ConsoleDriver.DiagnosticFlags Enables diagnostic functions CursorVisibility Cursors Visibility that are displayed 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. TextDirection Text direction enumeration, controls how text is displayed. VerticalTextAlignment Vertical text alignment enumeration, controls how text is displayed."
+ "keywords": "Namespace Terminal.Gui Classes Application A static, singleton class providing 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. Autocomplete Renders an overlay on another view at a given point that allows selecting from a range of 'autocomplete' options. Border Draws a border, background, or both around another element. Border.ToplevelContainer A sealed Toplevel derived class to implement Border feature. This is only a wrapper to get borders on a toplevel and is recommended using another derived, like Window where is possible to have borders with or without border line or spacing around. 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 with OS interaction. ClipboardBase Shared abstract class to enforce rules from the implementation of the IClipboard interface. 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 FakeMainLoop 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. 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. GraphView Control for rendering graphs (bar, scatter etc) 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 separated 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. MenuOpeningEventArgs An System.EventArgs which allows passing a cancelable menu opening event or replacing with a new MenuBarItem . 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. OpenDialog The OpenDialog provides an interactive dialog box for users to select files or directories. PanelView A container for single Child that will allow to drawn Border in two ways. If UsePanelFrame the borders and the child will be accommodated in the available panel size, otherwise the panel will be resized based on the child and borders thickness sizes. 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. StackExtensions Extension of System.Collections.Generic.Stack helper to work with specific System.Collections.Generic.IEqualityComparer 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 . TableView View for tabular data based on a System.Data.DataTable . See TableView Deep Dive for more information . TableView.CellActivatedEventArgs Defines the event arguments for CellActivated event TableView.CellColorGetterArgs Arguments for a TableView.CellColorGetterDelegate . Describes a cell for which a rendering ColorScheme is being sought TableView.ColumnStyle Describes how to render a given column in a TableView including Alignment and textual representation of cells (e.g. date formats) See TableView Deep Dive for more information . TableView.RowColorGetterArgs Arguments for TableView.RowColorGetterDelegate . Describes a row of data in a System.Data.DataTable for which ColorScheme is sought. TableView.SelectedCellChangedEventArgs Defines the event arguments for SelectedCellChanged TableView.TableSelection Describes a selected region of the table TableView.TableStyle Defines rendering options that affect how the table is displayed. See TableView Deep Dive for more information . TabView Control that hosts multiple sub views, presenting a single one at once TabView.Tab A single tab in a TabView TabView.TabChangedEventArgs Describes a change in SelectedTab TabView.TabStyle Describes render stylistic selections of a TabView 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. TextValidateField Text field that validates input through a ITextValidateProvider TextView Multi-line text editing View TimeField Time editing View Toplevel Toplevel views can be modally executed. ToplevelClosingEventArgs System.EventArgs implementation for the Closing event. ToplevelComparer Implements the System.Collections.Generic.IComparer to sort the Toplevel from the MdiChildes if needed. ToplevelEqualityComparer Implements the System.Collections.Generic.IEqualityComparer to comparing two Toplevel used by StackExtensions . TreeView Convenience implementation of generic TreeView for any tree were all nodes implement ITreeNode . See TreeView Deep Dive for more information . TreeView Hierarchical tree view with expandable branches. Branch objects are dynamically determined when expanded using a user defined ITreeBuilder See TreeView Deep Dive for more information . 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. PointF Represents an ordered pair of x and y coordinates that define a point in a two-dimensional plane. Rect Stores a set of four integers that represent the location and size of a rectangle RectangleF Stores the location and size of a rectangular region. Size Stores an ordered pair of integers, which specify a Height and Width. SizeF Represents the size of a rectangular region with an ordered pair of width and height. Thickness Describes the thickness of a frame around a rectangle. Four System.Int32 values describe the Left , Top , Right , and Bottom sides of the rectangle, respectively. Interfaces IClipboard Definition to interact with the OS clipboard. IListDataSource Implement IListDataSource to provide custom rendering for a ListView . IMainLoopDriver Public interface to create your own platform specific main loop driver. ITreeView Interface for all non generic members of TreeView See TreeView Deep Dive for more information . Enums BorderStyle Specifies the border style for a View and to be used by the Border class. Color Basic colors that can be used to set the foreground and background colors in console applications. ConsoleDriver.DiagnosticFlags Enables diagnostic functions CursorVisibility Cursors Visibility that are displayed 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 . OpenDialog.OpenMode Determine which System.IO type to open. ProgressBarFormat Specifies the format that a ProgressBar uses to indicate the visual presentation. ProgressBarStyle Specifies the style that a ProgressBar uses to indicate the progress of an operation. TextAlignment Text alignment enumeration, controls how text is displayed. TextDirection Text direction enumeration, controls how text is displayed. VerticalTextAlignment Vertical text alignment enumeration, controls how text is displayed. Delegates TableView.CellColorGetterDelegate Delegate for providing color to TableView cells based on the value being rendered TableView.RowColorGetterDelegate Delegate for providing color for a whole row of a TableView"
+ },
+ "api/Terminal.Gui/Terminal.Gui.IClipboard.html": {
+ "href": "api/Terminal.Gui/Terminal.Gui.IClipboard.html",
+ "title": "Interface IClipboard",
+ "keywords": "Interface IClipboard Definition to interact with the OS clipboard. Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public interface IClipboard Properties IsSupported Returns true if the environmental dependencies are in place to interact with the OS clipboard. Declaration bool IsSupported { get; } Property Value Type Description System.Boolean Methods GetClipboardData() Get the operation system clipboard. Declaration string GetClipboardData() Returns Type Description System.String Exceptions Type Condition System.NotSupportedException Thrown if it was not possible to read the clipboard contents. SetClipboardData(String) Sets the operation system clipboard. Declaration void SetClipboardData(string text) Parameters Type Name Description System.String text Exceptions Type Condition System.NotSupportedException Thrown if it was not possible to set the clipboard contents. TryGetClipboardData(out String) Gets the operation system clipboard if possible. Declaration bool TryGetClipboardData(out string result) Parameters Type Name Description System.String result Clipboard contents read Returns Type Description System.Boolean true if it was possible to read the OS clipboard. TrySetClipboardData(String) Sets the operation system clipboard if possible. Declaration bool TrySetClipboardData(string text) Parameters Type Name Description System.String text Returns Type Description System.Boolean True if the clipboard content was set successfully."
},
"api/Terminal.Gui/Terminal.Gui.IListDataSource.html": {
"href": "api/Terminal.Gui/Terminal.Gui.IListDataSource.html",
@@ -232,7 +262,7 @@
"api/Terminal.Gui/Terminal.Gui.IMainLoopDriver.html": {
"href": "api/Terminal.Gui/Terminal.Gui.IMainLoopDriver.html",
"title": "Interface IMainLoopDriver",
- "keywords": "Interface IMainLoopDriver Public interface to create your own platform specific main loop driver. Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public interface IMainLoopDriver Methods EventsPending(Boolean) Must report whether there are any events pending, or even block waiting for events. Declaration bool EventsPending(bool wait) Parameters Type Name Description System.Boolean wait If set to true wait until an event is available, otherwise return immediately. Returns Type Description System.Boolean true , if there were pending events, false otherwise. MainIteration() The interation function. Declaration void MainIteration() Setup(MainLoop) Initializes the main loop driver, gets the calling main loop for the initialization. Declaration void Setup(MainLoop mainLoop) Parameters Type Name Description MainLoop mainLoop Main loop. Wakeup() Wakes up the mainloop that might be waiting on input, must be thread safe. Declaration void Wakeup()"
+ "keywords": "Interface IMainLoopDriver Public interface to create your own platform specific main loop driver. Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public interface IMainLoopDriver Methods EventsPending(Boolean) Must report whether there are any events pending, or even block waiting for events. Declaration bool EventsPending(bool wait) Parameters Type Name Description System.Boolean wait If set to true wait until an event is available, otherwise return immediately. Returns Type Description System.Boolean true , if there were pending events, false otherwise. MainIteration() The iteration function. Declaration void MainIteration() Setup(MainLoop) Initializes the main loop driver, gets the calling main loop for the initialization. Declaration void Setup(MainLoop mainLoop) Parameters Type Name Description MainLoop mainLoop Main loop. Wakeup() Wakes up the mainloop that might be waiting on input, must be thread safe. Declaration void Wakeup()"
},
"api/Terminal.Gui/Terminal.Gui.ITreeView.html": {
"href": "api/Terminal.Gui/Terminal.Gui.ITreeView.html",
@@ -257,7 +287,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.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.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() 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.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.VerticalTextAlignment View.TextDirection View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible View.SetWidth(Int32, Int32) View.SetHeight(Int32, Int32) View.GetCurrentWidth(Int32) View.GetCurrentHeight(Int32) 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) Declaration public Label(ustring text) Parameters Type Name Description NStack.ustring text Label(Int32, Int32, ustring) Declaration public Label(int x, int y, ustring text) Parameters Type Name Description System.Int32 x System.Int32 y NStack.ustring text Label(Rect) Declaration public Label(Rect frame) Parameters Type Name Description Rect frame Label(Rect, ustring) Declaration public Label(Rect rect, ustring text) Parameters Type Name Description Rect rect NStack.ustring text Methods OnEnter(View) Declaration public override bool OnEnter(View view) Parameters Type Name Description View view Returns Type Description System.Boolean Overrides View.OnEnter(View) 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 separated 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.CanFocusChanged View.EnabledChanged View.VisibleChanged 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.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() 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.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.VerticalTextAlignment View.TextDirection View.IsInitialized View.Enabled View.Visible View.Border View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.OnCanFocusChanged() View.OnEnabledChanged() View.OnVisibleChanged() View.Dispose(Boolean) View.BeginInit() View.EndInit() View.SetWidth(Int32, Int32) View.SetHeight(Int32, Int32) View.GetCurrentWidth(Int32) View.GetCurrentHeight(Int32) View.GetNormalColor() 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) Declaration public Label(ustring text) Parameters Type Name Description NStack.ustring text Label(ustring, TextDirection) Declaration public Label(ustring text, TextDirection direction) Parameters Type Name Description NStack.ustring text TextDirection direction Label(Int32, Int32, ustring) Declaration public Label(int x, int y, ustring text) Parameters Type Name Description System.Int32 x System.Int32 y NStack.ustring text Label(Rect) Declaration public Label(Rect frame) Parameters Type Name Description Rect frame Label(Rect, ustring) Declaration public Label(Rect rect, ustring text) Parameters Type Name Description Rect rect NStack.ustring text Methods OnEnter(View) Declaration public override bool OnEnter(View view) Parameters Type Name Description View view Returns Type Description System.Boolean Overrides View.OnEnter(View) 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",
@@ -267,7 +297,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.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.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() 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.VerticalTextAlignment View.TextDirection 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 View.SetWidth(Int32, Int32) View.SetHeight(Int32, Int32) View.GetCurrentWidth(Int32) View.GetCurrentHeight(Int32) 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 LeftItem Gets or sets the left column where the item start to be displayed at on the ListView . Declaration public int LeftItem { get; set; } Property Value Type Description System.Int32 The left position. Maxlength Gets the widest item. Declaration public int Maxlength { get; } Property Value Type Description System.Int32 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) Declaration public override bool MouseEvent(MouseEvent me) Parameters Type Name Description MouseEvent me Returns Type Description System.Boolean 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) Declaration public override bool OnEnter(View view) Parameters Type Name Description View view Returns Type Description System.Boolean Overrides View.OnEnter(View) OnLeave(View) Declaration public override bool OnLeave(View view) Parameters Type Name Description View view Returns Type Description System.Boolean 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() Declaration public override void PositionCursor() Overrides View.PositionCursor() ProcessKey(KeyEvent) Declaration public override bool ProcessKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides View.ProcessKey(KeyEvent) Redraw(Rect) Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds Overrides View.Redraw(Rect) ScrollDown(Int32) Scrolls the view down. Declaration public virtual void ScrollDown(int lines) Parameters Type Name Description System.Int32 lines Number of lines to scroll down. ScrollLeft(Int32) Scrolls the view left. Declaration public virtual void ScrollLeft(int cols) Parameters Type Name Description System.Int32 cols Number of columns to scroll left. ScrollRight(Int32) Scrolls the view right. Declaration public virtual void ScrollRight(int cols) Parameters Type Name Description System.Int32 cols Number of columns to scroll right. ScrollUp(Int32) Scrolls the view up. Declaration public virtual void ScrollUp(int lines) Parameters Type Name Description System.Int32 lines Number of lines to scroll up. 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 custom 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.CanFocusChanged View.EnabledChanged View.VisibleChanged 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.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() 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.VerticalTextAlignment View.TextDirection View.IsInitialized View.Enabled View.Visible View.Border View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.OnCanFocusChanged() View.OnEnabledChanged() View.OnVisibleChanged() View.Dispose(Boolean) View.BeginInit() View.EndInit() View.SetWidth(Int32, Int32) View.SetHeight(Int32, Int32) View.GetCurrentWidth(Int32) View.GetCurrentHeight(Int32) View.GetNormalColor() 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 LeftItem Gets or sets the left column where the item start to be displayed at on the ListView . Declaration public int LeftItem { get; set; } Property Value Type Description System.Int32 The left position. Maxlength Gets the widest item. Declaration public int Maxlength { get; } Property Value Type Description System.Int32 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) Declaration public override bool MouseEvent(MouseEvent me) Parameters Type Name Description MouseEvent me Returns Type Description System.Boolean 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) Declaration public override bool OnEnter(View view) Parameters Type Name Description View view Returns Type Description System.Boolean Overrides View.OnEnter(View) OnLeave(View) Declaration public override bool OnLeave(View view) Parameters Type Name Description View view Returns Type Description System.Boolean 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() Declaration public override void PositionCursor() Overrides View.PositionCursor() ProcessKey(KeyEvent) Declaration public override bool ProcessKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides View.ProcessKey(KeyEvent) Redraw(Rect) Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds Overrides View.Redraw(Rect) ScrollDown(Int32) Scrolls the view down. Declaration public virtual void ScrollDown(int lines) Parameters Type Name Description System.Int32 lines Number of lines to scroll down. ScrollLeft(Int32) Scrolls the view left. Declaration public virtual void ScrollLeft(int cols) Parameters Type Name Description System.Int32 cols Number of columns to scroll left. ScrollRight(Int32) Scrolls the view right. Declaration public virtual void ScrollRight(int cols) Parameters Type Name Description System.Int32 cols Number of columns to scroll right. ScrollUp(Int32) Scrolls the view up. Declaration public virtual void ScrollUp(int lines) Parameters Type Name Description System.Int32 lines Number of lines to scroll up. 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 custom 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",
@@ -282,12 +312,12 @@
"api/Terminal.Gui/Terminal.Gui.MainLoop.html": {
"href": "api/Terminal.Gui/Terminal.Gui.MainLoop.html",
"title": "Class MainLoop",
- "keywords": "Class MainLoop Simple main loop implementation that can be used to monitor file descriptor, run timers and idle handlers. Inheritance System.Object MainLoop 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 MainLoop Remarks Monitoring of file descriptors is only available on Unix, there does not seem to be a way of supporting this on Windows. Constructors MainLoop(IMainLoopDriver) Creates a new Mainloop. Declaration public MainLoop(IMainLoopDriver driver) Parameters Type Name Description IMainLoopDriver driver Should match the ConsoleDriver (one of the implementations UnixMainLoop, NetMainLoop or WindowsMainLoop). Properties Driver The current IMainLoopDriver in use. Declaration public IMainLoopDriver Driver { get; } Property Value Type Description IMainLoopDriver The driver. Methods AddIdle(Func) Adds specified idle handler function to mainloop processing. The handler function will be called once per iteration of the main loop after other events have been handled. Declaration public Func AddIdle(Func idleHandler) Parameters Type Name Description System.Func < System.Boolean > idleHandler Token that can be used to remove the idle handler with RemoveIdle(Func) . Returns Type Description System.Func < System.Boolean > Remarks Remove an idle hander by calling RemoveIdle(Func) with the token this method returns. If the idleHandler returns false it will be removed and not called subsequently. AddTimeout(TimeSpan, Func) Adds a timeout to the mainloop. Declaration public object AddTimeout(TimeSpan time, Func callback) Parameters Type Name Description System.TimeSpan time System.Func < MainLoop , System.Boolean > callback Returns Type Description System.Object Remarks When time time specified passes, the callback will be invoked. If the callback returns true, the timeout will be reset, repeating the invocation. If it returns false, the timeout will stop and be removed. The returned value is a token that can be used to stop the timeout by calling RemoveTimeout(Object) . EventsPending(Boolean) Determines whether there are pending events to be processed. Declaration public bool EventsPending(bool wait = false) Parameters Type Name Description System.Boolean wait Returns Type Description System.Boolean Remarks You can use this method if you want to probe if events are pending. Typically used if you need to flush the input queue while still running some of your own code in your main thread. Invoke(Action) Runs action on the thread that is processing events Declaration public void Invoke(Action action) Parameters Type Name Description System.Action action the action to be invoked on the main processing thread. MainIteration() Runs one iteration of timers and file watches Declaration public void MainIteration() Remarks You use this to process all pending events (timers, idle handlers and file watches). You can use it like this: while (main.EvensPending ()) MainIteration (); RemoveIdle(Func) Removes an idle handler added with AddIdle(Func) from processing. Declaration public void RemoveIdle(Func token) Parameters Type Name Description System.Func < System.Boolean > token A token returned by AddIdle(Func) RemoveTimeout(Object) Removes a previously scheduled timeout Declaration public void RemoveTimeout(object token) Parameters Type Name Description System.Object token Remarks The token parameter is the value returned by AddTimeout. Run() Runs the mainloop. Declaration public void Run() Stop() Stops the mainloop. Declaration public void Stop()"
+ "keywords": "Class MainLoop Simple main loop implementation that can be used to monitor file descriptor, run timers and idle handlers. Inheritance System.Object MainLoop 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 MainLoop Remarks Monitoring of file descriptors is only available on Unix, there does not seem to be a way of supporting this on Windows. Constructors MainLoop(IMainLoopDriver) Creates a new Mainloop. Declaration public MainLoop(IMainLoopDriver driver) Parameters Type Name Description IMainLoopDriver driver Should match the ConsoleDriver (one of the implementations UnixMainLoop, NetMainLoop or WindowsMainLoop). Properties Driver The current IMainLoopDriver in use. Declaration public IMainLoopDriver Driver { get; } Property Value Type Description IMainLoopDriver The driver. Methods AddIdle(Func) Adds specified idle handler function to mainloop processing. The handler function will be called once per iteration of the main loop after other events have been handled. Declaration public Func AddIdle(Func idleHandler) Parameters Type Name Description System.Func < System.Boolean > idleHandler Token that can be used to remove the idle handler with RemoveIdle(Func) . Returns Type Description System.Func < System.Boolean > Remarks Remove an idle hander by calling RemoveIdle(Func) with the token this method returns. If the idleHandler returns false it will be removed and not called subsequently. AddTimeout(TimeSpan, Func) Adds a timeout to the mainloop. Declaration public object AddTimeout(TimeSpan time, Func callback) Parameters Type Name Description System.TimeSpan time System.Func < MainLoop , System.Boolean > callback Returns Type Description System.Object Remarks When time specified passes, the callback will be invoked. If the callback returns true, the timeout will be reset, repeating the invocation. If it returns false, the timeout will stop and be removed. The returned value is a token that can be used to stop the timeout by calling RemoveTimeout(Object) . EventsPending(Boolean) Determines whether there are pending events to be processed. Declaration public bool EventsPending(bool wait = false) Parameters Type Name Description System.Boolean wait Returns Type Description System.Boolean Remarks You can use this method if you want to probe if events are pending. Typically used if you need to flush the input queue while still running some of your own code in your main thread. Invoke(Action) Runs action on the thread that is processing events Declaration public void Invoke(Action action) Parameters Type Name Description System.Action action the action to be invoked on the main processing thread. MainIteration() Runs one iteration of timers and file watches Declaration public void MainIteration() Remarks You use this to process all pending events (timers, idle handlers and file watches). You can use it like this: while (main.EvensPending ()) MainIteration (); RemoveIdle(Func) Removes an idle handler added with AddIdle(Func) from processing. Declaration public bool RemoveIdle(Func token) Parameters Type Name Description System.Func < System.Boolean > token A token returned by AddIdle(Func) Returns Type Description System.Boolean RemoveTimeout(Object) Removes a previously scheduled timeout Declaration public bool RemoveTimeout(object token) Parameters Type Name Description System.Object token Returns Type Description System.Boolean Remarks The token parameter is the value returned by AddTimeout. Run() Runs the mainloop. Declaration public void Run() Stop() Stops the mainloop. Declaration public void Stop()"
},
"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.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.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() 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.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.VerticalTextAlignment View.TextDirection 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 View.SetWidth(Int32, Int32) View.SetHeight(Int32, Int32) View.GetCurrentWidth(Int32) View.GetCurrentHeight(Int32) 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) Declaration public override bool MouseEvent(MouseEvent me) Parameters Type Name Description MouseEvent me Returns Type Description System.Boolean Overrides Responder.MouseEvent(MouseEvent) OnEnter(View) Declaration public override bool OnEnter(View view) Parameters Type Name Description View view Returns Type Description System.Boolean Overrides View.OnEnter(View) OnKeyDown(KeyEvent) Declaration public override bool OnKeyDown(KeyEvent keyEvent) Parameters Type Name Description KeyEvent keyEvent Returns Type Description System.Boolean Overrides View.OnKeyDown(KeyEvent) OnKeyUp(KeyEvent) Declaration public override bool OnKeyUp(KeyEvent keyEvent) Parameters Type Name Description KeyEvent keyEvent Returns Type Description System.Boolean Overrides View.OnKeyUp(KeyEvent) OnLeave(View) Declaration public override bool OnLeave(View view) Parameters Type Name Description View view Returns Type Description System.Boolean 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() Declaration public override void PositionCursor() Overrides View.PositionCursor() ProcessColdKey(KeyEvent) Declaration public override bool ProcessColdKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides View.ProcessColdKey(KeyEvent) ProcessHotKey(KeyEvent) Declaration public override bool ProcessHotKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides View.ProcessHotKey(KeyEvent) ProcessKey(KeyEvent) Declaration public override bool ProcessKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides View.ProcessKey(KeyEvent) Redraw(Rect) Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds Overrides View.Redraw(Rect) 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.CanFocusChanged View.EnabledChanged View.VisibleChanged 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.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() 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.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.VerticalTextAlignment View.TextDirection View.IsInitialized View.Enabled View.Visible View.Border View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.OnCanFocusChanged() View.OnEnabledChanged() View.OnVisibleChanged() View.Dispose(Boolean) View.BeginInit() View.EndInit() View.SetWidth(Int32, Int32) View.SetHeight(Int32, Int32) View.GetCurrentWidth(Int32) View.GetCurrentHeight(Int32) View.GetNormalColor() 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) Declaration public override bool MouseEvent(MouseEvent me) Parameters Type Name Description MouseEvent me Returns Type Description System.Boolean Overrides Responder.MouseEvent(MouseEvent) OnEnter(View) Declaration public override bool OnEnter(View view) Parameters Type Name Description View view Returns Type Description System.Boolean Overrides View.OnEnter(View) OnKeyDown(KeyEvent) Declaration public override bool OnKeyDown(KeyEvent keyEvent) Parameters Type Name Description KeyEvent keyEvent Returns Type Description System.Boolean Overrides View.OnKeyDown(KeyEvent) OnKeyUp(KeyEvent) Declaration public override bool OnKeyUp(KeyEvent keyEvent) Parameters Type Name Description KeyEvent keyEvent Returns Type Description System.Boolean Overrides View.OnKeyUp(KeyEvent) OnLeave(View) Declaration public override bool OnLeave(View view) Parameters Type Name Description View view Returns Type Description System.Boolean Overrides View.OnLeave(View) OnMenuClosing() Virtual method that will invoke the MenuClosing Declaration public virtual void OnMenuClosing() OnMenuOpening(MenuBarItem) Virtual method that will invoke the MenuOpening event if it's defined. Declaration public virtual MenuOpeningEventArgs OnMenuOpening(MenuBarItem currentMenu) Parameters Type Name Description MenuBarItem currentMenu The current menu to be replaced. Returns Type Description MenuOpeningEventArgs Returns the MenuOpeningEventArgs OpenMenu() Opens the current Menu programatically. Declaration public void OpenMenu() PositionCursor() Declaration public override void PositionCursor() Overrides View.PositionCursor() ProcessColdKey(KeyEvent) Declaration public override bool ProcessColdKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides View.ProcessColdKey(KeyEvent) ProcessHotKey(KeyEvent) Declaration public override bool ProcessHotKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides View.ProcessHotKey(KeyEvent) ProcessKey(KeyEvent) Declaration public override bool ProcessKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides View.ProcessKey(KeyEvent) Redraw(Rect) Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds Overrides View.Redraw(Rect) 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 < MenuOpeningEventArgs > Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize"
},
"api/Terminal.Gui/Terminal.Gui.MenuBarItem.html": {
"href": "api/Terminal.Gui/Terminal.Gui.MenuBarItem.html",
@@ -304,6 +334,11 @@
"title": "Enum MenuItemCheckStyle",
"keywords": "Enum MenuItemCheckStyle Specifies how a MenuItem shows selection state. Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax [Flags] public enum MenuItemCheckStyle Fields Name Description Checked The menu item will indicate checked/un-checked state (see Checked . NoCheck The menu item will be shown normally, with no check indicator. Radio The menu item is part of a menu radio group (see Checked and will indicate selected state."
},
+ "api/Terminal.Gui/Terminal.Gui.MenuOpeningEventArgs.html": {
+ "href": "api/Terminal.Gui/Terminal.Gui.MenuOpeningEventArgs.html",
+ "title": "Class MenuOpeningEventArgs",
+ "keywords": "Class MenuOpeningEventArgs An System.EventArgs which allows passing a cancelable menu opening event or replacing with a new MenuBarItem . Inheritance System.Object System.EventArgs MenuOpeningEventArgs 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 MenuOpeningEventArgs : EventArgs Constructors MenuOpeningEventArgs(MenuBarItem) Initializes a new instance of MenuOpeningEventArgs Declaration public MenuOpeningEventArgs(MenuBarItem currentMenu) Parameters Type Name Description MenuBarItem currentMenu The current MenuBarItem parent. Properties Cancel Flag that allows you to cancel the opening of the menu. Declaration public bool Cancel { get; set; } Property Value Type Description System.Boolean CurrentMenu The current MenuBarItem parent. Declaration public MenuBarItem CurrentMenu { get; } Property Value Type Description MenuBarItem NewMenuBarItem The new MenuBarItem to be replaced. Declaration public MenuBarItem NewMenuBarItem { get; set; } Property Value Type Description MenuBarItem"
+ },
"api/Terminal.Gui/Terminal.Gui.MessageBox.html": {
"href": "api/Terminal.Gui/Terminal.Gui.MessageBox.html",
"title": "Class MessageBox",
@@ -322,17 +357,27 @@
"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.NameDirLabel 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.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() 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.VerticalTextAlignment View.TextDirection 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 View.SetWidth(Int32, Int32) View.SetHeight(Int32, Int32) View.GetCurrentWidth(Int32) View.GetCurrentHeight(Int32) 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(Func) . 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.NameDirLabel 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.Border Window.Add(View) Window.Remove(View) Window.RemoveAll() Window.Redraw(Rect) Window.OnCanFocusChanged() Window.Text Window.TextAlignment Toplevel.Running Toplevel.Loaded Toplevel.Ready Toplevel.Unloaded Toplevel.Activate Toplevel.Deactivate Toplevel.ChildClosed Toplevel.AllChildClosed Toplevel.Closing Toplevel.Closed Toplevel.ChildLoaded Toplevel.ChildUnloaded Toplevel.Create() Toplevel.CanFocus Toplevel.Modal Toplevel.MenuBar Toplevel.StatusBar Toplevel.IsMdiContainer Toplevel.IsMdiChild Toplevel.OnKeyDown(KeyEvent) Toplevel.OnKeyUp(KeyEvent) Toplevel.ProcessColdKey(KeyEvent) Toplevel.PositionToplevel(Toplevel) Toplevel.MouseEvent(MouseEvent) Toplevel.MoveNext() Toplevel.MovePrevious() Toplevel.RequestStop() Toplevel.RequestStop(Toplevel) Toplevel.PositionCursor() Toplevel.GetTopMdiChild(Type, String[]) Toplevel.ShowChild(Toplevel) View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.CanFocusChanged View.EnabledChanged View.VisibleChanged 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.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() 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.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.VerticalTextAlignment View.TextDirection View.IsInitialized View.Enabled View.Visible View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.OnEnabledChanged() View.OnVisibleChanged() View.Dispose(Boolean) View.BeginInit() View.EndInit() View.SetWidth(Int32, Int32) View.SetHeight(Int32, Int32) View.GetCurrentWidth(Int32) View.GetCurrentHeight(Int32) View.GetNormalColor() 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(Func) . This will run the dialog modally, and when this returns, the list of files 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, List, OpenDialog.OpenMode) Initializes a new OpenDialog . Declaration public OpenDialog(ustring title, ustring message, List allowedTypes = null, OpenDialog.OpenMode openMode = OpenDialog.OpenMode.File) Parameters Type Name Description NStack.ustring title The title. NStack.ustring message The message. System.Collections.Generic.List < System.String > allowedTypes The allowed types. OpenDialog.OpenMode openMode The open mode. 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.OpenDialog.OpenMode.html": {
+ "href": "api/Terminal.Gui/Terminal.Gui.OpenDialog.OpenMode.html",
+ "title": "Enum OpenDialog.OpenMode",
+ "keywords": "Enum OpenDialog.OpenMode Determine which System.IO type to open. Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public enum OpenMode Fields Name Description Directory Opens only directory or directories. File Opens only file or files. Mixed Opens files and directories."
+ },
+ "api/Terminal.Gui/Terminal.Gui.PanelView.html": {
+ "href": "api/Terminal.Gui/Terminal.Gui.PanelView.html",
+ "title": "Class PanelView",
+ "keywords": "Class PanelView A container for single Child that will allow to drawn Border in two ways. If UsePanelFrame the borders and the child will be accommodated in the available panel size, otherwise the panel will be resized based on the child and borders thickness sizes. Inheritance System.Object Responder View PanelView 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.CanFocusChanged View.EnabledChanged View.VisibleChanged 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.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() 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.Text View.AutoSize View.TextAlignment View.VerticalTextAlignment View.TextDirection View.IsInitialized View.Enabled View.Visible View.Border View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.OnCanFocusChanged() View.OnEnabledChanged() View.OnVisibleChanged() View.Dispose(Boolean) View.BeginInit() View.EndInit() View.SetWidth(Int32, Int32) View.SetHeight(Int32, Int32) View.GetCurrentWidth(Int32) View.GetCurrentHeight(Int32) View.GetNormalColor() 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 PanelView : View, IDisposable, ISupportInitializeNotification, ISupportInitialize Constructors PanelView() Initializes a panel with a null child. Declaration public PanelView() PanelView(View) Initializes a panel with a valid child. Declaration public PanelView(View child) Parameters Type Name Description View child Properties Child The child that will use this panel. Declaration public View Child { get; set; } Property Value Type Description View UsePanelFrame Gets or sets if the panel size will used, otherwise the child size. Declaration public bool UsePanelFrame { get; set; } Property Value Type Description System.Boolean Methods Add(View) Declaration public override void Add(View view) Parameters Type Name Description View view Overrides View.Add(View) Redraw(Rect) Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds Overrides View.Redraw(Rect) Remove(View) Declaration public override void Remove(View view) Parameters Type Name Description View view Overrides View.Remove(View) RemoveAll() Declaration public override void RemoveAll() Overrides View.RemoveAll() Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize"
},
"api/Terminal.Gui/Terminal.Gui.Point.html": {
"href": "api/Terminal.Gui/Terminal.Gui.Point.html",
"title": "Struct Point",
- "keywords": "Struct Point Represents an ordered pair of integer x- and y-coordinates that defines a point in a two-dimensional plane. Inherited Members System.Object.Equals(System.Object, System.Object) System.Object.GetType() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public struct Point Constructors Point(Int32, Int32) Point Constructor Declaration public Point(int x, int y) Parameters Type Name Description System.Int32 x System.Int32 y Remarks Creates a Point from a specified x,y coordinate pair. Point(Size) Point Constructor Declaration public Point(Size sz) Parameters Type Name Description Size sz Remarks Creates a Point from a Size value. Fields Empty Empty Shared Field Declaration public static readonly Point Empty Field Value Type Description Point Remarks An uninitialized Point Structure. X Gets or sets the x-coordinate of this Point. Declaration public int X Field Value Type Description System.Int32 Y Gets or sets the y-coordinate of this Point. Declaration public int Y Field Value Type Description System.Int32 Properties IsEmpty IsEmpty Property Declaration public bool IsEmpty { get; } Property Value Type Description System.Boolean Remarks Indicates if both X and Y are zero. Methods Add(Point, Size) Adds the specified Size to the specified Point. Declaration public static Point Add(Point pt, Size sz) Parameters Type Name Description Point pt The Point to add. Size sz The Size to add. Returns Type Description Point The Point that is the result of the addition operation. Equals(Object) Equals Method Declaration public override bool Equals(object obj) Parameters Type Name Description System.Object obj Returns Type Description System.Boolean Overrides System.ValueType.Equals(System.Object) Remarks Checks equivalence of this Point and another object. GetHashCode() GetHashCode Method Declaration public override int GetHashCode() Returns Type Description System.Int32 Overrides System.ValueType.GetHashCode() Remarks Calculates a hashing value. Offset(Int32, Int32) Offset Method Declaration public void Offset(int dx, int dy) Parameters Type Name Description System.Int32 dx System.Int32 dy Remarks Moves the Point a specified distance. Offset(Point) Translates this Point by the specified Point. Declaration public void Offset(Point p) Parameters Type Name Description Point p The Point used offset this Point. Subtract(Point, Size) Returns the result of subtracting specified Size from the specified Point. Declaration public static Point Subtract(Point pt, Size sz) Parameters Type Name Description Point pt The Point to be subtracted from. Size sz The Size to subtract from the Point. Returns Type Description Point The Point that is the result of the subtraction operation. ToString() ToString Method Declaration public override string ToString() Returns Type Description System.String Overrides System.ValueType.ToString() Remarks Formats the Point as a string in coordinate notation. Operators Addition(Point, Size) Addition Operator Declaration public static Point operator +(Point pt, Size sz) Parameters Type Name Description Point pt Size sz Returns Type Description Point Remarks Translates a Point using the Width and Height properties of the given Size . Equality(Point, Point) Equality Operator Declaration public static bool operator ==(Point left, Point right) Parameters Type Name Description Point left Point right Returns Type Description System.Boolean Remarks Compares two Point objects. The return value is based on the equivalence of the X and Y properties of the two points. Explicit(Point to Size) Point to Size Conversion Declaration public static explicit operator Size(Point p) Parameters Type Name Description Point p Returns Type Description Size Remarks Returns a Size based on the Coordinates of a given Point. Requires explicit cast. Inequality(Point, Point) Inequality Operator Declaration public static bool operator !=(Point left, Point right) Parameters Type Name Description Point left Point right Returns Type Description System.Boolean Remarks Compares two Point objects. The return value is based on the equivalence of the X and Y properties of the two points. Subtraction(Point, Size) Subtraction Operator Declaration public static Point operator -(Point pt, Size sz) Parameters Type Name Description Point pt Size sz Returns Type Description Point Remarks Translates a Point using the negation of the Width and Height properties of the given Size."
+ "keywords": "Struct Point Represents an ordered pair of integer x- and y-coordinates that defines a point in a two-dimensional plane. Inherited Members System.Object.Equals(System.Object, System.Object) System.Object.GetType() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public struct Point Constructors Point(Int32, Int32) Point Constructor Declaration public Point(int x, int y) Parameters Type Name Description System.Int32 x System.Int32 y Remarks Creates a Point from a specified x,y coordinate pair. Point(Size) Point Constructor Declaration public Point(Size sz) Parameters Type Name Description Size sz Remarks Creates a Point from a Size value. Fields Empty Empty Shared Field Declaration public static readonly Point Empty Field Value Type Description Point Remarks An uninitialized Point Structure. X Gets or sets the x-coordinate of this Point. Declaration public int X Field Value Type Description System.Int32 Y Gets or sets the y-coordinate of this Point. Declaration public int Y Field Value Type Description System.Int32 Properties IsEmpty IsEmpty Property Declaration public readonly bool IsEmpty { get; } Property Value Type Description System.Boolean Remarks Indicates if both X and Y are zero. Methods Add(Point, Size) Adds the specified Size to the specified Point. Declaration public static Point Add(Point pt, Size sz) Parameters Type Name Description Point pt The Point to add. Size sz The Size to add. Returns Type Description Point The Point that is the result of the addition operation. Equals(Object) Equals Method Declaration public override bool Equals(object obj) Parameters Type Name Description System.Object obj Returns Type Description System.Boolean Overrides System.ValueType.Equals(System.Object) Remarks Checks equivalence of this Point and another object. GetHashCode() GetHashCode Method Declaration public override int GetHashCode() Returns Type Description System.Int32 Overrides System.ValueType.GetHashCode() Remarks Calculates a hashing value. Offset(Int32, Int32) Offset Method Declaration public void Offset(int dx, int dy) Parameters Type Name Description System.Int32 dx System.Int32 dy Remarks Moves the Point a specified distance. Offset(Point) Translates this Point by the specified Point. Declaration public void Offset(Point p) Parameters Type Name Description Point p The Point used offset this Point. Subtract(Point, Size) Returns the result of subtracting specified Size from the specified Point. Declaration public static Point Subtract(Point pt, Size sz) Parameters Type Name Description Point pt The Point to be subtracted from. Size sz The Size to subtract from the Point. Returns Type Description Point The Point that is the result of the subtraction operation. ToString() ToString Method Declaration public override string ToString() Returns Type Description System.String Overrides System.ValueType.ToString() Remarks Formats the Point as a string in coordinate notation. Operators Addition(Point, Size) Addition Operator Declaration public static Point operator +(Point pt, Size sz) Parameters Type Name Description Point pt Size sz Returns Type Description Point Remarks Translates a Point using the Width and Height properties of the given Size . Equality(Point, Point) Equality Operator Declaration public static bool operator ==(Point left, Point right) Parameters Type Name Description Point left Point right Returns Type Description System.Boolean Remarks Compares two Point objects. The return value is based on the equivalence of the X and Y properties of the two points. Explicit(Point to Size) Point to Size Conversion Declaration public static explicit operator Size(Point p) Parameters Type Name Description Point p Returns Type Description Size Remarks Returns a Size based on the Coordinates of a given Point. Requires explicit cast. Inequality(Point, Point) Inequality Operator Declaration public static bool operator !=(Point left, Point right) Parameters Type Name Description Point left Point right Returns Type Description System.Boolean Remarks Compares two Point objects. The return value is based on the equivalence of the X and Y properties of the two points. Subtraction(Point, Size) Subtraction Operator Declaration public static Point operator -(Point pt, Size sz) Parameters Type Name Description Point pt Size sz Returns Type Description Point Remarks Translates a Point using the negation of the Width and Height properties of the given Size."
},
"api/Terminal.Gui/Terminal.Gui.PointF.html": {
"href": "api/Terminal.Gui/Terminal.Gui.PointF.html",
"title": "Struct PointF",
- "keywords": "Struct PointF Represents an ordered pair of x and y coordinates that define a point in a two-dimensional plane. Implements System.IEquatable < PointF > Inherited Members System.Object.Equals(System.Object, System.Object) System.Object.GetType() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public struct PointF : IEquatable Constructors PointF(Single, Single) Initializes a new instance of the PointF class with the specified coordinates. Declaration public PointF(float x, float y) Parameters Type Name Description System.Single x System.Single y Fields Empty Creates a new instance of the PointF class with member data left uninitialized. Declaration public static readonly PointF Empty Field Value Type Description PointF Properties IsEmpty Gets a value indicating whether this PointF is empty. Declaration [Browsable(false)] public bool IsEmpty { get; } Property Value Type Description System.Boolean X Gets the x-coordinate of this PointF . Declaration public float X { get; set; } Property Value Type Description System.Single Y Gets the y-coordinate of this PointF . Declaration public float Y { get; set; } Property Value Type Description System.Single Methods Add(PointF, Size) Translates a PointF by a given Size . Declaration public static PointF Add(PointF pt, Size sz) Parameters Type Name Description PointF pt Size sz Returns Type Description PointF Add(PointF, SizeF) Translates a PointF by a given SizeF . Declaration public static PointF Add(PointF pt, SizeF sz) Parameters Type Name Description PointF pt SizeF sz Returns Type Description PointF Equals(Object) Compares two PointF objects. The result specifies whether the values of the X and Y properties of the two PointF objects are equal. Declaration public override bool Equals(object obj) Parameters Type Name Description System.Object obj Returns Type Description System.Boolean Overrides System.ValueType.Equals(System.Object) Equals(PointF) Compares two PointF objects. The result specifies whether the values of the X and Y properties of the two PointF objects are equal. Declaration public bool Equals(PointF other) Parameters Type Name Description PointF other Returns Type Description System.Boolean GetHashCode() Generates a hashcode from the X and Y components Declaration public override int GetHashCode() Returns Type Description System.Int32 Overrides System.ValueType.GetHashCode() Subtract(PointF, Size) Translates a PointF by the negative of a given Size . Declaration public static PointF Subtract(PointF pt, Size sz) Parameters Type Name Description PointF pt Size sz Returns Type Description PointF Subtract(PointF, SizeF) Translates a PointF by the negative of a given SizeF . Declaration public static PointF Subtract(PointF pt, SizeF sz) Parameters Type Name Description PointF pt SizeF sz Returns Type Description PointF ToString() Returns a string including the X and Y values Declaration public override string ToString() Returns Type Description System.String Overrides System.ValueType.ToString() Operators Addition(PointF, Size) Translates a PointF by a given Size . Declaration public static PointF operator +(PointF pt, Size sz) Parameters Type Name Description PointF pt Size sz Returns Type Description PointF Addition(PointF, SizeF) Translates a PointF by a given SizeF . Declaration public static PointF operator +(PointF pt, SizeF sz) Parameters Type Name Description PointF pt SizeF sz Returns Type Description PointF Equality(PointF, PointF) Compares two PointF objects. The result specifies whether the values of the X and Y properties of the two PointF objects are equal. Declaration public static bool operator ==(PointF left, PointF right) Parameters Type Name Description PointF left PointF right Returns Type Description System.Boolean Inequality(PointF, PointF) Compares two PointF objects. The result specifies whether the values of the X or Y properties of the two PointF objects are unequal. Declaration public static bool operator !=(PointF left, PointF right) Parameters Type Name Description PointF left PointF right Returns Type Description System.Boolean Subtraction(PointF, Size) Translates a PointF by the negative of a given Size . Declaration public static PointF operator -(PointF pt, Size sz) Parameters Type Name Description PointF pt Size sz Returns Type Description PointF Subtraction(PointF, SizeF) Translates a PointF by the negative of a given SizeF . Declaration public static PointF operator -(PointF pt, SizeF sz) Parameters Type Name Description PointF pt SizeF sz Returns Type Description PointF Implements System.IEquatable"
+ "keywords": "Struct PointF Represents an ordered pair of x and y coordinates that define a point in a two-dimensional plane. Implements System.IEquatable < PointF > Inherited Members System.Object.Equals(System.Object, System.Object) System.Object.GetType() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public struct PointF : IEquatable Constructors PointF(Single, Single) Initializes a new instance of the PointF class with the specified coordinates. Declaration public PointF(float x, float y) Parameters Type Name Description System.Single x System.Single y Fields Empty Creates a new instance of the PointF class with member data left uninitialized. Declaration public static readonly PointF Empty Field Value Type Description PointF Properties IsEmpty Gets a value indicating whether this PointF is empty. Declaration [Browsable(false)] public readonly bool IsEmpty { get; } Property Value Type Description System.Boolean X Gets the x-coordinate of this PointF . Declaration public float X { get; set; } Property Value Type Description System.Single Y Gets the y-coordinate of this PointF . Declaration public float Y { get; set; } Property Value Type Description System.Single Methods Add(PointF, Size) Translates a PointF by a given Size . Declaration public static PointF Add(PointF pt, Size sz) Parameters Type Name Description PointF pt Size sz Returns Type Description PointF Add(PointF, SizeF) Translates a PointF by a given SizeF . Declaration public static PointF Add(PointF pt, SizeF sz) Parameters Type Name Description PointF pt SizeF sz Returns Type Description PointF Equals(Object) Compares two PointF objects. The result specifies whether the values of the X and Y properties of the two PointF objects are equal. Declaration public override bool Equals(object obj) Parameters Type Name Description System.Object obj Returns Type Description System.Boolean Overrides System.ValueType.Equals(System.Object) Equals(PointF) Compares two PointF objects. The result specifies whether the values of the X and Y properties of the two PointF objects are equal. Declaration public bool Equals(PointF other) Parameters Type Name Description PointF other Returns Type Description System.Boolean GetHashCode() Generates a hashcode from the X and Y components Declaration public override int GetHashCode() Returns Type Description System.Int32 Overrides System.ValueType.GetHashCode() Subtract(PointF, Size) Translates a PointF by the negative of a given Size . Declaration public static PointF Subtract(PointF pt, Size sz) Parameters Type Name Description PointF pt Size sz Returns Type Description PointF Subtract(PointF, SizeF) Translates a PointF by the negative of a given SizeF . Declaration public static PointF Subtract(PointF pt, SizeF sz) Parameters Type Name Description PointF pt SizeF sz Returns Type Description PointF ToString() Returns a string including the X and Y values Declaration public override string ToString() Returns Type Description System.String Overrides System.ValueType.ToString() Operators Addition(PointF, Size) Translates a PointF by a given Size . Declaration public static PointF operator +(PointF pt, Size sz) Parameters Type Name Description PointF pt Size sz Returns Type Description PointF Addition(PointF, SizeF) Translates a PointF by a given SizeF . Declaration public static PointF operator +(PointF pt, SizeF sz) Parameters Type Name Description PointF pt SizeF sz Returns Type Description PointF Equality(PointF, PointF) Compares two PointF objects. The result specifies whether the values of the X and Y properties of the two PointF objects are equal. Declaration public static bool operator ==(PointF left, PointF right) Parameters Type Name Description PointF left PointF right Returns Type Description System.Boolean Inequality(PointF, PointF) Compares two PointF objects. The result specifies whether the values of the X or Y properties of the two PointF objects are unequal. Declaration public static bool operator !=(PointF left, PointF right) Parameters Type Name Description PointF left PointF right Returns Type Description System.Boolean Subtraction(PointF, Size) Translates a PointF by the negative of a given Size . Declaration public static PointF operator -(PointF pt, Size sz) Parameters Type Name Description PointF pt Size sz Returns Type Description PointF Subtraction(PointF, SizeF) Translates a PointF by the negative of a given SizeF . Declaration public static PointF operator -(PointF pt, SizeF sz) Parameters Type Name Description PointF pt SizeF sz Returns Type Description PointF Implements System.IEquatable"
},
"api/Terminal.Gui/Terminal.Gui.Pos.html": {
"href": "api/Terminal.Gui/Terminal.Gui.Pos.html",
@@ -342,12 +387,22 @@
"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.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.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() 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.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.VerticalTextAlignment View.TextDirection 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 View.SetWidth(Int32, Int32) View.SetHeight(Int32, Int32) View.GetCurrentWidth(Int32) View.GetCurrentHeight(Int32) 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 OnEnter(View) Declaration public override bool OnEnter(View view) Parameters Type Name Description View view Returns Type Description System.Boolean Overrides View.OnEnter(View) 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) Declaration public override void Redraw(Rect region) Parameters Type Name Description Rect region Overrides View.Redraw(Rect) 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.CanFocusChanged View.EnabledChanged View.VisibleChanged 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.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() 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.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.TextAlignment View.VerticalTextAlignment View.TextDirection View.IsInitialized View.Enabled View.Visible View.Border View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.OnCanFocusChanged() View.OnEnabledChanged() View.OnVisibleChanged() View.Dispose(Boolean) View.BeginInit() View.EndInit() View.SetWidth(Int32, Int32) View.SetHeight(Int32, Int32) View.GetCurrentWidth(Int32) View.GetCurrentHeight(Int32) View.GetNormalColor() 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 BidirectionalMarquee Specifies if the MarqueeBlocks or the MarqueeContinuous styles is unidirectional or bidirectional. Declaration public bool BidirectionalMarquee { get; set; } Property Value Type Description System.Boolean 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. ProgressBarFormat Specifies the format that a ProgressBar uses to indicate the visual presentation. Declaration public ProgressBarFormat ProgressBarFormat { get; set; } Property Value Type Description ProgressBarFormat ProgressBarStyle Gets/Sets the progress bar style based on the ProgressBarStyle Declaration public ProgressBarStyle ProgressBarStyle { get; set; } Property Value Type Description ProgressBarStyle SegmentCharacter Segment indicator for meter views. Declaration public Rune SegmentCharacter { get; set; } Property Value Type Description System.Rune Text Declaration public override ustring Text { get; set; } Property Value Type Description NStack.ustring Overrides View.Text Methods OnEnter(View) Declaration public override bool OnEnter(View view) Parameters Type Name Description View view Returns Type Description System.Boolean Overrides View.OnEnter(View) Pulse() Notifies the ProgressBar that some progress has taken place. Declaration public void Pulse() Remarks If the ProgressBar is percentage mode, it switches to activity mode. If is in activity mode, the marker is moved. Redraw(Rect) Declaration public override void Redraw(Rect region) Parameters Type Name Description Rect region Overrides View.Redraw(Rect) Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize"
+ },
+ "api/Terminal.Gui/Terminal.Gui.ProgressBarFormat.html": {
+ "href": "api/Terminal.Gui/Terminal.Gui.ProgressBarFormat.html",
+ "title": "Enum ProgressBarFormat",
+ "keywords": "Enum ProgressBarFormat Specifies the format that a ProgressBar uses to indicate the visual presentation. Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public enum ProgressBarFormat Fields Name Description Framed A framed visual presentation showing only the progress bar. FramedPlusPercentage A framed visual presentation showing the progress bar and the percentage. FramedProgressPadded A framed visual presentation showing all with the progress bar padded. Simple A simple visual presentation showing only the progress bar. SimplePlusPercentage A simple visual presentation showing the progress bar and the percentage."
+ },
+ "api/Terminal.Gui/Terminal.Gui.ProgressBarStyle.html": {
+ "href": "api/Terminal.Gui/Terminal.Gui.ProgressBarStyle.html",
+ "title": "Enum ProgressBarStyle",
+ "keywords": "Enum ProgressBarStyle Specifies the style that a ProgressBar uses to indicate the progress of an operation. Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public enum ProgressBarStyle Fields Name Description Blocks Indicates progress by increasing the number of segmented blocks in a ProgressBar . Continuous Indicates progress by increasing the size of a smooth, continuous bar in a ProgressBar . MarqueeBlocks Indicates progress by continuously scrolling a block across a ProgressBar in a marquee fashion. MarqueeContinuous Indicates progress by continuously scrolling a block across a ProgressBar in a marquee fashion."
},
"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.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.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() 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.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.VerticalTextAlignment View.TextDirection 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 View.SetWidth(Int32, Int32) View.SetHeight(Int32, Int32) View.GetCurrentWidth(Int32) View.GetCurrentHeight(Int32) 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) Declaration public override bool MouseEvent(MouseEvent me) Parameters Type Name Description MouseEvent me Returns Type Description System.Boolean Overrides Responder.MouseEvent(MouseEvent) OnEnter(View) Declaration public override bool OnEnter(View view) Parameters Type Name Description View view Returns Type Description System.Boolean Overrides View.OnEnter(View) 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() Declaration public override void PositionCursor() Overrides View.PositionCursor() ProcessColdKey(KeyEvent) Declaration public override bool ProcessColdKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides View.ProcessColdKey(KeyEvent) ProcessKey(KeyEvent) Declaration public override bool ProcessKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides View.ProcessKey(KeyEvent) Redraw(Rect) Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds Overrides View.Redraw(Rect) 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.CanFocusChanged View.EnabledChanged View.VisibleChanged 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.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() 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.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.VerticalTextAlignment View.TextDirection View.IsInitialized View.Enabled View.Visible View.Border View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.OnCanFocusChanged() View.OnEnabledChanged() View.OnVisibleChanged() View.Dispose(Boolean) View.BeginInit() View.EndInit() View.SetWidth(Int32, Int32) View.SetHeight(Int32, Int32) View.GetCurrentWidth(Int32) View.GetCurrentHeight(Int32) View.GetNormalColor() 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) Declaration public override bool MouseEvent(MouseEvent me) Parameters Type Name Description MouseEvent me Returns Type Description System.Boolean Overrides Responder.MouseEvent(MouseEvent) OnEnter(View) Declaration public override bool OnEnter(View view) Parameters Type Name Description View view Returns Type Description System.Boolean Overrides View.OnEnter(View) 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() Declaration public override void PositionCursor() Overrides View.PositionCursor() ProcessColdKey(KeyEvent) Declaration public override bool ProcessColdKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides View.ProcessColdKey(KeyEvent) ProcessKey(KeyEvent) Declaration public override bool ProcessKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides View.ProcessKey(KeyEvent) Redraw(Rect) Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds Overrides View.Redraw(Rect) 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",
@@ -357,52 +412,57 @@
"api/Terminal.Gui/Terminal.Gui.Rect.html": {
"href": "api/Terminal.Gui/Terminal.Gui.Rect.html",
"title": "Struct Rect",
- "keywords": "Struct Rect Stores a set of four integers that represent the location and size of a rectangle Inherited Members System.Object.Equals(System.Object, System.Object) System.Object.GetType() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public struct Rect Constructors Rect(Int32, Int32, Int32, Int32) Rectangle Constructor Declaration public Rect(int x, int y, int width, int height) Parameters Type Name Description System.Int32 x System.Int32 y System.Int32 width System.Int32 height Remarks Creates a Rectangle from a specified x,y location and width and height values. Rect(Point, Size) Rectangle Constructor Declaration public Rect(Point location, Size size) Parameters Type Name Description Point location Size size Remarks Creates a Rectangle from Point and Size values. Fields Empty Empty Shared Field Declaration public static readonly Rect Empty Field Value Type Description Rect Remarks An uninitialized Rectangle Structure. X Gets or sets the x-coordinate of the upper-left corner of this Rectangle structure. Declaration public int X Field Value Type Description System.Int32 Y Gets or sets the y-coordinate of the upper-left corner of this Rectangle structure. Declaration public int Y Field Value Type Description System.Int32 Properties Bottom Bottom Property Declaration public int Bottom { get; } Property Value Type Description System.Int32 Remarks The Y coordinate of the bottom edge of the Rectangle. Read only. Height Gets or sets the height of this Rectangle structure. Declaration public int Height { get; set; } Property Value Type Description System.Int32 IsEmpty IsEmpty Property Declaration public bool IsEmpty { get; } Property Value Type Description System.Boolean Remarks Indicates if the width or height are zero. Read only. Left Left Property Declaration public int Left { get; } Property Value Type Description System.Int32 Remarks The X coordinate of the left edge of the Rectangle. Read only. Location Location Property Declaration public Point Location { get; set; } Property Value Type Description Point Remarks The Location of the top-left corner of the Rectangle. Right Right Property Declaration public int Right { get; } Property Value Type Description System.Int32 Remarks The X coordinate of the right edge of the Rectangle. Read only. Size Size Property Declaration public Size Size { get; set; } Property Value Type Description Size Remarks The Size of the Rectangle. Top Top Property Declaration public int Top { get; } Property Value Type Description System.Int32 Remarks The Y coordinate of the top edge of the Rectangle. Read only. Width Gets or sets the width of this Rect structure. Declaration public int Width { get; set; } Property Value Type Description System.Int32 Methods Contains(Int32, Int32) Contains Method Declaration public bool Contains(int x, int y) Parameters Type Name Description System.Int32 x System.Int32 y Returns Type Description System.Boolean Remarks Checks if an x,y coordinate lies within this Rectangle. Contains(Point) Contains Method Declaration public bool Contains(Point pt) Parameters Type Name Description Point pt Returns Type Description System.Boolean Remarks Checks if a Point lies within this Rectangle. Contains(Rect) Contains Method Declaration public bool Contains(Rect rect) Parameters Type Name Description Rect rect Returns Type Description System.Boolean Remarks Checks if a Rectangle lies entirely within this Rectangle. Equals(Object) Equals Method Declaration public override bool Equals(object obj) Parameters Type Name Description System.Object obj Returns Type Description System.Boolean Overrides System.ValueType.Equals(System.Object) Remarks Checks equivalence of this Rectangle and another object. FromLTRB(Int32, Int32, Int32, Int32) FromLTRB Shared Method Declaration public static Rect FromLTRB(int left, int top, int right, int bottom) Parameters Type Name Description System.Int32 left System.Int32 top System.Int32 right System.Int32 bottom Returns Type Description Rect Remarks Produces a Rectangle structure from left, top, right and bottom coordinates. GetHashCode() GetHashCode Method Declaration public override int GetHashCode() Returns Type Description System.Int32 Overrides System.ValueType.GetHashCode() Remarks Calculates a hashing value. Inflate(Int32, Int32) Inflate Method Declaration public void Inflate(int width, int height) Parameters Type Name Description System.Int32 width System.Int32 height Remarks Inflates the Rectangle by a specified width and height. Inflate(Rect, Int32, Int32) Inflate Shared Method Declaration public static Rect Inflate(Rect rect, int x, int y) Parameters Type Name Description Rect rect System.Int32 x System.Int32 y Returns Type Description Rect Remarks Produces a new Rectangle by inflating an existing Rectangle by the specified coordinate values. Inflate(Size) Inflate Method Declaration public void Inflate(Size size) Parameters Type Name Description Size size Remarks Inflates the Rectangle by a specified Size. Intersect(Rect) Intersect Method Declaration public void Intersect(Rect rect) Parameters Type Name Description Rect rect Remarks Replaces the Rectangle with the intersection of itself and another Rectangle. Intersect(Rect, Rect) Intersect Shared Method Declaration public static Rect Intersect(Rect a, Rect b) Parameters Type Name Description Rect a Rect b Returns Type Description Rect Remarks Produces a new Rectangle by intersecting 2 existing Rectangles. Returns null if there is no intersection. IntersectsWith(Rect) IntersectsWith Method Declaration public bool IntersectsWith(Rect rect) Parameters Type Name Description Rect rect Returns Type Description System.Boolean Remarks Checks if a Rectangle intersects with this one. Offset(Int32, Int32) Offset Method Declaration public void Offset(int x, int y) Parameters Type Name Description System.Int32 x System.Int32 y Remarks Moves the Rectangle a specified distance. Offset(Point) Offset Method Declaration public void Offset(Point pos) Parameters Type Name Description Point pos Remarks Moves the Rectangle a specified distance. ToString() ToString Method Declaration public override string ToString() Returns Type Description System.String Overrides System.ValueType.ToString() Remarks Formats the Rectangle as a string in (x,y,w,h) notation. Union(Rect, Rect) Union Shared Method Declaration public static Rect Union(Rect a, Rect b) Parameters Type Name Description Rect a Rect b Returns Type Description Rect Remarks Produces a new Rectangle from the union of 2 existing Rectangles. Operators Equality(Rect, Rect) Equality Operator Declaration public static bool operator ==(Rect left, Rect right) Parameters Type Name Description Rect left Rect right Returns Type Description System.Boolean Remarks Compares two Rectangle objects. The return value is based on the equivalence of the Location and Size properties of the two Rectangles. Inequality(Rect, Rect) Inequality Operator Declaration public static bool operator !=(Rect left, Rect right) Parameters Type Name Description Rect left Rect right Returns Type Description System.Boolean Remarks Compares two Rectangle objects. The return value is based on the equivalence of the Location and Size properties of the two Rectangles."
+ "keywords": "Struct Rect Stores a set of four integers that represent the location and size of a rectangle Inherited Members System.Object.Equals(System.Object, System.Object) System.Object.GetType() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public struct Rect Constructors Rect(Int32, Int32, Int32, Int32) Rectangle Constructor Declaration public Rect(int x, int y, int width, int height) Parameters Type Name Description System.Int32 x System.Int32 y System.Int32 width System.Int32 height Remarks Creates a Rectangle from a specified x,y location and width and height values. Rect(Point, Size) Rectangle Constructor Declaration public Rect(Point location, Size size) Parameters Type Name Description Point location Size size Remarks Creates a Rectangle from Point and Size values. Fields Empty Empty Shared Field Declaration public static readonly Rect Empty Field Value Type Description Rect Remarks An uninitialized Rectangle Structure. X Gets or sets the x-coordinate of the upper-left corner of this Rectangle structure. Declaration public int X Field Value Type Description System.Int32 Y Gets or sets the y-coordinate of the upper-left corner of this Rectangle structure. Declaration public int Y Field Value Type Description System.Int32 Properties Bottom Bottom Property Declaration public readonly int Bottom { get; } Property Value Type Description System.Int32 Remarks The Y coordinate of the bottom edge of the Rectangle. Read only. Height Gets or sets the height of this Rectangle structure. Declaration public int Height { get; set; } Property Value Type Description System.Int32 IsEmpty IsEmpty Property Declaration public readonly bool IsEmpty { get; } Property Value Type Description System.Boolean Remarks Indicates if the width or height are zero. Read only. Left Left Property Declaration public readonly int Left { get; } Property Value Type Description System.Int32 Remarks The X coordinate of the left edge of the Rectangle. Read only. Location Location Property Declaration public Point Location { get; set; } Property Value Type Description Point Remarks The Location of the top-left corner of the Rectangle. Right Right Property Declaration public readonly int Right { get; } Property Value Type Description System.Int32 Remarks The X coordinate of the right edge of the Rectangle. Read only. Size Size Property Declaration public Size Size { get; set; } Property Value Type Description Size Remarks The Size of the Rectangle. Top Top Property Declaration public readonly int Top { get; } Property Value Type Description System.Int32 Remarks The Y coordinate of the top edge of the Rectangle. Read only. Width Gets or sets the width of this Rect structure. Declaration public int Width { get; set; } Property Value Type Description System.Int32 Methods Contains(Int32, Int32) Contains Method Declaration public bool Contains(int x, int y) Parameters Type Name Description System.Int32 x System.Int32 y Returns Type Description System.Boolean Remarks Checks if an x,y coordinate lies within this Rectangle. Contains(Point) Contains Method Declaration public bool Contains(Point pt) Parameters Type Name Description Point pt Returns Type Description System.Boolean Remarks Checks if a Point lies within this Rectangle. Contains(Rect) Contains Method Declaration public bool Contains(Rect rect) Parameters Type Name Description Rect rect Returns Type Description System.Boolean Remarks Checks if a Rectangle lies entirely within this Rectangle. Equals(Object) Equals Method Declaration public override bool Equals(object obj) Parameters Type Name Description System.Object obj Returns Type Description System.Boolean Overrides System.ValueType.Equals(System.Object) Remarks Checks equivalence of this Rectangle and another object. FromLTRB(Int32, Int32, Int32, Int32) FromLTRB Shared Method Declaration public static Rect FromLTRB(int left, int top, int right, int bottom) Parameters Type Name Description System.Int32 left System.Int32 top System.Int32 right System.Int32 bottom Returns Type Description Rect Remarks Produces a Rectangle structure from left, top, right and bottom coordinates. GetHashCode() GetHashCode Method Declaration public override int GetHashCode() Returns Type Description System.Int32 Overrides System.ValueType.GetHashCode() Remarks Calculates a hashing value. Inflate(Int32, Int32) Inflate Method Declaration public void Inflate(int width, int height) Parameters Type Name Description System.Int32 width System.Int32 height Remarks Inflates the Rectangle by a specified width and height. Inflate(Rect, Int32, Int32) Inflate Shared Method Declaration public static Rect Inflate(Rect rect, int x, int y) Parameters Type Name Description Rect rect System.Int32 x System.Int32 y Returns Type Description Rect Remarks Produces a new Rectangle by inflating an existing Rectangle by the specified coordinate values. Inflate(Size) Inflate Method Declaration public void Inflate(Size size) Parameters Type Name Description Size size Remarks Inflates the Rectangle by a specified Size. Intersect(Rect) Intersect Method Declaration public void Intersect(Rect rect) Parameters Type Name Description Rect rect Remarks Replaces the Rectangle with the intersection of itself and another Rectangle. Intersect(Rect, Rect) Intersect Shared Method Declaration public static Rect Intersect(Rect a, Rect b) Parameters Type Name Description Rect a Rect b Returns Type Description Rect Remarks Produces a new Rectangle by intersecting 2 existing Rectangles. Returns null if there is no intersection. IntersectsWith(Rect) IntersectsWith Method Declaration public bool IntersectsWith(Rect rect) Parameters Type Name Description Rect rect Returns Type Description System.Boolean Remarks Checks if a Rectangle intersects with this one. Offset(Int32, Int32) Offset Method Declaration public void Offset(int x, int y) Parameters Type Name Description System.Int32 x System.Int32 y Remarks Moves the Rectangle a specified distance. Offset(Point) Offset Method Declaration public void Offset(Point pos) Parameters Type Name Description Point pos Remarks Moves the Rectangle a specified distance. ToString() ToString Method Declaration public override string ToString() Returns Type Description System.String Overrides System.ValueType.ToString() Remarks Formats the Rectangle as a string in (x,y,w,h) notation. Union(Rect, Rect) Union Shared Method Declaration public static Rect Union(Rect a, Rect b) Parameters Type Name Description Rect a Rect b Returns Type Description Rect Remarks Produces a new Rectangle from the union of 2 existing Rectangles. Operators Equality(Rect, Rect) Equality Operator Declaration public static bool operator ==(Rect left, Rect right) Parameters Type Name Description Rect left Rect right Returns Type Description System.Boolean Remarks Compares two Rectangle objects. The return value is based on the equivalence of the Location and Size properties of the two Rectangles. Inequality(Rect, Rect) Inequality Operator Declaration public static bool operator !=(Rect left, Rect right) Parameters Type Name Description Rect left Rect right Returns Type Description System.Boolean Remarks Compares two Rectangle objects. The return value is based on the equivalence of the Location and Size properties of the two Rectangles."
},
"api/Terminal.Gui/Terminal.Gui.RectangleF.html": {
"href": "api/Terminal.Gui/Terminal.Gui.RectangleF.html",
"title": "Struct RectangleF",
- "keywords": "Struct RectangleF Stores the location and size of a rectangular region. Implements System.IEquatable < RectangleF > Inherited Members System.Object.Equals(System.Object, System.Object) System.Object.GetType() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public struct RectangleF : IEquatable Constructors RectangleF(Single, Single, Single, Single) Initializes a new instance of the RectangleF class with the specified location and size. Declaration public RectangleF(float x, float y, float width, float height) Parameters Type Name Description System.Single x System.Single y System.Single width System.Single height RectangleF(PointF, SizeF) Initializes a new instance of the RectangleF class with the specified location and size. Declaration public RectangleF(PointF location, SizeF size) Parameters Type Name Description PointF location SizeF size Fields Empty Initializes a new instance of the RectangleF class. Declaration public static readonly RectangleF Empty Field Value Type Description RectangleF Properties Bottom Gets the y-coordinate of the lower-right corner of the rectangular region defined by this RectangleF . Declaration [Browsable(false)] public float Bottom { get; } Property Value Type Description System.Single Height Gets or sets the height of the rectangular region defined by this RectangleF . Declaration public float Height { get; set; } Property Value Type Description System.Single IsEmpty Tests whether this RectangleF has a Width or a Height of 0. Declaration [Browsable(false)] public bool IsEmpty { get; } Property Value Type Description System.Boolean Left Gets the x-coordinate of the upper-left corner of the rectangular region defined by this RectangleF . Declaration [Browsable(false)] public float Left { get; } Property Value Type Description System.Single Location Gets or sets the coordinates of the upper-left corner of the rectangular region represented by this RectangleF . Declaration [Browsable(false)] public PointF Location { get; set; } Property Value Type Description PointF Right Gets the x-coordinate of the lower-right corner of the rectangular region defined by this RectangleF . Declaration [Browsable(false)] public float Right { get; } Property Value Type Description System.Single Size Gets or sets the size of this RectangleF . Declaration [Browsable(false)] public SizeF Size { get; set; } Property Value Type Description SizeF Top Gets the y-coordinate of the upper-left corner of the rectangular region defined by this RectangleF . Declaration [Browsable(false)] public float Top { get; } Property Value Type Description System.Single Width Gets or sets the width of the rectangular region defined by this RectangleF . Declaration public float Width { get; set; } Property Value Type Description System.Single X Gets or sets the x-coordinate of the upper-left corner of the rectangular region defined by this RectangleF . Declaration public float X { get; set; } Property Value Type Description System.Single Y Gets or sets the y-coordinate of the upper-left corner of the rectangular region defined by this RectangleF . Declaration public float Y { get; set; } Property Value Type Description System.Single Methods Contains(Single, Single) Determines if the specified point is contained within the rectangular region defined by this Rect . Declaration public bool Contains(float x, float y) Parameters Type Name Description System.Single x System.Single y Returns Type Description System.Boolean Contains(PointF) Determines if the specified point is contained within the rectangular region defined by this Rect . Declaration public bool Contains(PointF pt) Parameters Type Name Description PointF pt Returns Type Description System.Boolean Contains(RectangleF) Determines if the rectangular region represented by rect is entirely contained within the rectangular region represented by this Rect . Declaration public bool Contains(RectangleF rect) Parameters Type Name Description RectangleF rect Returns Type Description System.Boolean Equals(Object) Tests whether obj is a RectangleF with the same location and size of this RectangleF . Declaration public override bool Equals(object obj) Parameters Type Name Description System.Object obj Returns Type Description System.Boolean Overrides System.ValueType.Equals(System.Object) Equals(RectangleF) Returns true if two RectangleF objects have equal location and size. Declaration public bool Equals(RectangleF other) Parameters Type Name Description RectangleF other Returns Type Description System.Boolean FromLTRB(Single, Single, Single, Single) Creates a new RectangleF with the specified location and size. Declaration public static RectangleF FromLTRB(float left, float top, float right, float bottom) Parameters Type Name Description System.Single left System.Single top System.Single right System.Single bottom Returns Type Description RectangleF GetHashCode() Gets the hash code for this RectangleF . Declaration public override int GetHashCode() Returns Type Description System.Int32 Overrides System.ValueType.GetHashCode() Inflate(Single, Single) Inflates this Rect by the specified amount. Declaration public void Inflate(float x, float y) Parameters Type Name Description System.Single x System.Single y Inflate(RectangleF, Single, Single) Creates a Rect that is inflated by the specified amount. Declaration public static RectangleF Inflate(RectangleF rect, float x, float y) Parameters Type Name Description RectangleF rect System.Single x System.Single y Returns Type Description RectangleF Inflate(SizeF) Inflates this Rect by the specified amount. Declaration public void Inflate(SizeF size) Parameters Type Name Description SizeF size Intersect(RectangleF) Creates a Rectangle that represents the intersection between this Rectangle and rect. Declaration public void Intersect(RectangleF rect) Parameters Type Name Description RectangleF rect Intersect(RectangleF, RectangleF) Creates a rectangle that represents the intersection between a and b. If there is no intersection, an empty rectangle is returned. Declaration public static RectangleF Intersect(RectangleF a, RectangleF b) Parameters Type Name Description RectangleF a RectangleF b Returns Type Description RectangleF IntersectsWith(RectangleF) Determines if this rectangle intersects with rect. Declaration public bool IntersectsWith(RectangleF rect) Parameters Type Name Description RectangleF rect Returns Type Description System.Boolean Offset(Single, Single) Adjusts the location of this rectangle by the specified amount. Declaration public void Offset(float x, float y) Parameters Type Name Description System.Single x System.Single y Offset(PointF) Adjusts the location of this rectangle by the specified amount. Declaration public void Offset(PointF pos) Parameters Type Name Description PointF pos ToString() Converts the Location and Size of this RectangleF to a human-readable string. Declaration public override string ToString() Returns Type Description System.String Overrides System.ValueType.ToString() Union(RectangleF, RectangleF) Creates a rectangle that represents the union between a and b. Declaration public static RectangleF Union(RectangleF a, RectangleF b) Parameters Type Name Description RectangleF a RectangleF b Returns Type Description RectangleF Operators Equality(RectangleF, RectangleF) Tests whether two RectangleF objects have equal location and size. Declaration public static bool operator ==(RectangleF left, RectangleF right) Parameters Type Name Description RectangleF left RectangleF right Returns Type Description System.Boolean Implicit(Rect to RectangleF) Converts the specified Rect to a RectangleF . Declaration public static implicit operator RectangleF(Rect r) Parameters Type Name Description Rect r Returns Type Description RectangleF Inequality(RectangleF, RectangleF) Tests whether two RectangleF objects differ in location or size. Declaration public static bool operator !=(RectangleF left, RectangleF right) Parameters Type Name Description RectangleF left RectangleF right Returns Type Description System.Boolean Implements System.IEquatable"
+ "keywords": "Struct RectangleF Stores the location and size of a rectangular region. Implements System.IEquatable < RectangleF > Inherited Members System.Object.Equals(System.Object, System.Object) System.Object.GetType() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public struct RectangleF : IEquatable Constructors RectangleF(Single, Single, Single, Single) Initializes a new instance of the RectangleF class with the specified location and size. Declaration public RectangleF(float x, float y, float width, float height) Parameters Type Name Description System.Single x System.Single y System.Single width System.Single height RectangleF(PointF, SizeF) Initializes a new instance of the RectangleF class with the specified location and size. Declaration public RectangleF(PointF location, SizeF size) Parameters Type Name Description PointF location SizeF size Fields Empty Initializes a new instance of the RectangleF class. Declaration public static readonly RectangleF Empty Field Value Type Description RectangleF Properties Bottom Gets the y-coordinate of the lower-right corner of the rectangular region defined by this RectangleF . Declaration [Browsable(false)] public readonly float Bottom { get; } Property Value Type Description System.Single Height Gets or sets the height of the rectangular region defined by this RectangleF . Declaration public float Height { get; set; } Property Value Type Description System.Single IsEmpty Tests whether this RectangleF has a Width or a Height of 0. Declaration [Browsable(false)] public readonly bool IsEmpty { get; } Property Value Type Description System.Boolean Left Gets the x-coordinate of the upper-left corner of the rectangular region defined by this RectangleF . Declaration [Browsable(false)] public readonly float Left { get; } Property Value Type Description System.Single Location Gets or sets the coordinates of the upper-left corner of the rectangular region represented by this RectangleF . Declaration [Browsable(false)] public PointF Location { get; set; } Property Value Type Description PointF Right Gets the x-coordinate of the lower-right corner of the rectangular region defined by this RectangleF . Declaration [Browsable(false)] public readonly float Right { get; } Property Value Type Description System.Single Size Gets or sets the size of this RectangleF . Declaration [Browsable(false)] public SizeF Size { get; set; } Property Value Type Description SizeF Top Gets the y-coordinate of the upper-left corner of the rectangular region defined by this RectangleF . Declaration [Browsable(false)] public readonly float Top { get; } Property Value Type Description System.Single Width Gets or sets the width of the rectangular region defined by this RectangleF . Declaration public float Width { get; set; } Property Value Type Description System.Single X Gets or sets the x-coordinate of the upper-left corner of the rectangular region defined by this RectangleF . Declaration public float X { get; set; } Property Value Type Description System.Single Y Gets or sets the y-coordinate of the upper-left corner of the rectangular region defined by this RectangleF . Declaration public float Y { get; set; } Property Value Type Description System.Single Methods Contains(Single, Single) Determines if the specified point is contained within the rectangular region defined by this Rect . Declaration public bool Contains(float x, float y) Parameters Type Name Description System.Single x System.Single y Returns Type Description System.Boolean Contains(PointF) Determines if the specified point is contained within the rectangular region defined by this Rect . Declaration public bool Contains(PointF pt) Parameters Type Name Description PointF pt Returns Type Description System.Boolean Contains(RectangleF) Determines if the rectangular region represented by rect is entirely contained within the rectangular region represented by this Rect . Declaration public bool Contains(RectangleF rect) Parameters Type Name Description RectangleF rect Returns Type Description System.Boolean Equals(Object) Tests whether obj is a RectangleF with the same location and size of this RectangleF . Declaration public override bool Equals(object obj) Parameters Type Name Description System.Object obj Returns Type Description System.Boolean Overrides System.ValueType.Equals(System.Object) Equals(RectangleF) Returns true if two RectangleF objects have equal location and size. Declaration public bool Equals(RectangleF other) Parameters Type Name Description RectangleF other Returns Type Description System.Boolean FromLTRB(Single, Single, Single, Single) Creates a new RectangleF with the specified location and size. Declaration public static RectangleF FromLTRB(float left, float top, float right, float bottom) Parameters Type Name Description System.Single left System.Single top System.Single right System.Single bottom Returns Type Description RectangleF GetHashCode() Gets the hash code for this RectangleF . Declaration public override int GetHashCode() Returns Type Description System.Int32 Overrides System.ValueType.GetHashCode() Inflate(Single, Single) Inflates this Rect by the specified amount. Declaration public void Inflate(float x, float y) Parameters Type Name Description System.Single x System.Single y Inflate(RectangleF, Single, Single) Creates a Rect that is inflated by the specified amount. Declaration public static RectangleF Inflate(RectangleF rect, float x, float y) Parameters Type Name Description RectangleF rect System.Single x System.Single y Returns Type Description RectangleF Inflate(SizeF) Inflates this Rect by the specified amount. Declaration public void Inflate(SizeF size) Parameters Type Name Description SizeF size Intersect(RectangleF) Creates a Rectangle that represents the intersection between this Rectangle and rect. Declaration public void Intersect(RectangleF rect) Parameters Type Name Description RectangleF rect Intersect(RectangleF, RectangleF) Creates a rectangle that represents the intersection between a and b. If there is no intersection, an empty rectangle is returned. Declaration public static RectangleF Intersect(RectangleF a, RectangleF b) Parameters Type Name Description RectangleF a RectangleF b Returns Type Description RectangleF IntersectsWith(RectangleF) Determines if this rectangle intersects with rect. Declaration public bool IntersectsWith(RectangleF rect) Parameters Type Name Description RectangleF rect Returns Type Description System.Boolean Offset(Single, Single) Adjusts the location of this rectangle by the specified amount. Declaration public void Offset(float x, float y) Parameters Type Name Description System.Single x System.Single y Offset(PointF) Adjusts the location of this rectangle by the specified amount. Declaration public void Offset(PointF pos) Parameters Type Name Description PointF pos ToString() Converts the Location and Size of this RectangleF to a human-readable string. Declaration public override string ToString() Returns Type Description System.String Overrides System.ValueType.ToString() Union(RectangleF, RectangleF) Creates a rectangle that represents the union between a and b. Declaration public static RectangleF Union(RectangleF a, RectangleF b) Parameters Type Name Description RectangleF a RectangleF b Returns Type Description RectangleF Operators Equality(RectangleF, RectangleF) Tests whether two RectangleF objects have equal location and size. Declaration public static bool operator ==(RectangleF left, RectangleF right) Parameters Type Name Description RectangleF left RectangleF right Returns Type Description System.Boolean Implicit(Rect to RectangleF) Converts the specified Rect to a RectangleF . Declaration public static implicit operator RectangleF(Rect r) Parameters Type Name Description Rect r Returns Type Description RectangleF Inequality(RectangleF, RectangleF) Tests whether two RectangleF objects differ in location or size. Declaration public static bool operator !=(RectangleF left, RectangleF right) Parameters Type Name Description RectangleF left RectangleF right Returns Type Description System.Boolean Implements System.IEquatable"
},
"api/Terminal.Gui/Terminal.Gui.Responder.html": {
"href": "api/Terminal.Gui/Terminal.Gui.Responder.html",
"title": "Class Responder",
- "keywords": "Class Responder Responder base class implemented by objects that want to participate on keyboard and mouse input. Inheritance System.Object Responder View Implements System.IDisposable 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 Responder : IDisposable Properties CanFocus Gets or sets a value indicating whether this Responder can focus. Declaration public virtual bool CanFocus { get; set; } Property Value Type Description System.Boolean true if can focus; otherwise, false . HasFocus Gets or sets a value indicating whether this Responder has focus. Declaration public virtual bool HasFocus { get; } Property Value Type Description System.Boolean true if has focus; otherwise, false . Methods Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resource. Declaration public void Dispose() Dispose(Boolean) Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. Declaration protected virtual void Dispose(bool disposing) Parameters Type Name Description System.Boolean disposing 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 virtual 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. OnEnter(View) Method invoked when a view gets focus. Declaration public virtual 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. OnKeyDown(KeyEvent) Method invoked when a key is pressed. Declaration public virtual 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 true if the event was handled OnKeyUp(KeyEvent) Method invoked when a key is released. Declaration public virtual 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 true if the event was handled OnLeave(View) Method invoked when a view loses focus. Declaration public virtual 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. OnMouseEnter(MouseEvent) Method invoked when a mouse event is generated for the first time. Declaration public virtual bool OnMouseEnter(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 virtual bool OnMouseLeave(MouseEvent mouseEvent) Parameters Type Name Description MouseEvent mouseEvent Returns Type Description System.Boolean true , if the event was handled, false otherwise. 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 virtual 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 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 virtual bool ProcessHotKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean 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 virtual 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 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"
+ "keywords": "Class Responder Responder base class implemented by objects that want to participate on keyboard and mouse input. Inheritance System.Object Responder View Implements System.IDisposable 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 Responder : IDisposable Properties CanFocus Gets or sets a value indicating whether this Responder can focus. Declaration public virtual bool CanFocus { get; set; } Property Value Type Description System.Boolean true if can focus; otherwise, false . Enabled Gets or sets a value indicating whether this Responder can respond to user interaction. Declaration public virtual bool Enabled { get; set; } Property Value Type Description System.Boolean HasFocus Gets or sets a value indicating whether this Responder has focus. Declaration public virtual bool HasFocus { get; } Property Value Type Description System.Boolean true if has focus; otherwise, false . Visible Gets or sets a value indicating whether this Responder and all its child controls are displayed. Declaration public virtual bool Visible { get; set; } Property Value Type Description System.Boolean Methods Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resource. Declaration public void Dispose() Dispose(Boolean) Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. Declaration protected virtual void Dispose(bool disposing) Parameters Type Name Description System.Boolean disposing 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 virtual 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. OnCanFocusChanged() Method invoked when the CanFocus property from a view is changed. Declaration public virtual void OnCanFocusChanged() OnEnabledChanged() Method invoked when the Enabled property from a view is changed. Declaration public virtual void OnEnabledChanged() OnEnter(View) Method invoked when a view gets focus. Declaration public virtual 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. OnKeyDown(KeyEvent) Method invoked when a key is pressed. Declaration public virtual 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 true if the event was handled OnKeyUp(KeyEvent) Method invoked when a key is released. Declaration public virtual 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 true if the event was handled OnLeave(View) Method invoked when a view loses focus. Declaration public virtual 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. OnMouseEnter(MouseEvent) Method invoked when a mouse event is generated for the first time. Declaration public virtual bool OnMouseEnter(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 virtual bool OnMouseLeave(MouseEvent mouseEvent) Parameters Type Name Description MouseEvent mouseEvent Returns Type Description System.Boolean true , if the event was handled, false otherwise. OnVisibleChanged() Method invoked when the Visible property from a view is changed. Declaration public virtual void OnVisibleChanged() 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 virtual 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 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 virtual bool ProcessHotKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean 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 virtual 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 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"
},
"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.NameDirLabel 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.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() 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.VerticalTextAlignment View.TextDirection 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 View.SetWidth(Int32, Int32) View.SetHeight(Int32, Int32) View.GetCurrentWidth(Int32) View.GetCurrentHeight(Int32) 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(Func) . 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.NameDirLabel 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.Border Window.Add(View) Window.Remove(View) Window.RemoveAll() Window.Redraw(Rect) Window.OnCanFocusChanged() Window.Text Window.TextAlignment Toplevel.Running Toplevel.Loaded Toplevel.Ready Toplevel.Unloaded Toplevel.Activate Toplevel.Deactivate Toplevel.ChildClosed Toplevel.AllChildClosed Toplevel.Closing Toplevel.Closed Toplevel.ChildLoaded Toplevel.ChildUnloaded Toplevel.Create() Toplevel.CanFocus Toplevel.Modal Toplevel.MenuBar Toplevel.StatusBar Toplevel.IsMdiContainer Toplevel.IsMdiChild Toplevel.OnKeyDown(KeyEvent) Toplevel.OnKeyUp(KeyEvent) Toplevel.ProcessColdKey(KeyEvent) Toplevel.PositionToplevel(Toplevel) Toplevel.MouseEvent(MouseEvent) Toplevel.MoveNext() Toplevel.MovePrevious() Toplevel.RequestStop() Toplevel.RequestStop(Toplevel) Toplevel.PositionCursor() Toplevel.GetTopMdiChild(Type, String[]) Toplevel.ShowChild(Toplevel) View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.CanFocusChanged View.EnabledChanged View.VisibleChanged 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.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() 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.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.VerticalTextAlignment View.TextDirection View.IsInitialized View.Enabled View.Visible View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.OnEnabledChanged() View.OnVisibleChanged() View.Dispose(Boolean) View.BeginInit() View.EndInit() View.SetWidth(Int32, Int32) View.SetHeight(Int32, Int32) View.GetCurrentWidth(Int32) View.GetCurrentHeight(Int32) View.GetNormalColor() 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(Func) . 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, List) Initializes a new SaveDialog . Declaration public SaveDialog(ustring title, ustring message, List allowedTypes = null) Parameters Type Name Description NStack.ustring title The title. NStack.ustring message The message. System.Collections.Generic.List < System.String > allowedTypes The allowed types. 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.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.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() 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.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.VerticalTextAlignment View.TextDirection 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 View.SetWidth(Int32, Int32) View.SetHeight(Int32, Int32) View.GetCurrentWidth(Int32) View.GetCurrentHeight(Int32) 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. ScrollBarView(View, Boolean, Boolean) Initializes a new instance of the ScrollBarView class using Computed layout. Declaration public ScrollBarView(View host, bool isVertical, bool showBothScrollIndicator = true) Parameters Type Name Description View host The view that will host this scrollbar. System.Boolean isVertical If set to true this is a vertical scrollbar, otherwise, the scrollbar is horizontal. System.Boolean showBothScrollIndicator If set to true (default) will have the other scrollbar, otherwise will have only one. 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 Host Get or sets the view that host this View Declaration public View Host { get; } Property Value Type Description View 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 KeepContentAlwaysInViewport Get or sets if the view-port is kept always visible in the area of this ScrollBarView Declaration public bool KeepContentAlwaysInViewport { get; set; } Property Value Type Description System.Boolean OtherScrollBarView Represent a vertical or horizontal ScrollBarView other than this. Declaration public ScrollBarView OtherScrollBarView { get; set; } Property Value Type Description ScrollBarView 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. ShowScrollIndicator Gets or sets the visibility for the vertical or horizontal scroll indicator. Declaration public bool ShowScrollIndicator { get; set; } Property Value Type Description System.Boolean true if show vertical or horizontal scroll indicator; otherwise, false . 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 View the Size is set to the appropriate dimension of Host . Methods MouseEvent(MouseEvent) Declaration public override bool MouseEvent(MouseEvent me) Parameters Type Name Description MouseEvent me Returns Type Description System.Boolean Overrides Responder.MouseEvent(MouseEvent) OnChangedPosition() Virtual method to invoke the ChangedPosition action event. Declaration public virtual void OnChangedPosition() OnEnter(View) Declaration public override bool OnEnter(View view) Parameters Type Name Description View view Returns Type Description System.Boolean Overrides View.OnEnter(View) Redraw(Rect) Declaration public override void Redraw(Rect region) Parameters Type Name Description Rect region Overrides View.Redraw(Rect) Refresh() Only used for a hosted view that will update and redraw the scrollbars. Declaration public virtual void Refresh() 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.CanFocusChanged View.EnabledChanged View.VisibleChanged 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.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() 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.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.VerticalTextAlignment View.TextDirection View.IsInitialized View.Enabled View.Visible View.Border View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.OnCanFocusChanged() View.OnEnabledChanged() View.OnVisibleChanged() View.Dispose(Boolean) View.BeginInit() View.EndInit() View.SetWidth(Int32, Int32) View.SetHeight(Int32, Int32) View.GetCurrentWidth(Int32) View.GetCurrentHeight(Int32) View.GetNormalColor() 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. ScrollBarView(View, Boolean, Boolean) Initializes a new instance of the ScrollBarView class using Computed layout. Declaration public ScrollBarView(View host, bool isVertical, bool showBothScrollIndicator = true) Parameters Type Name Description View host The view that will host this scrollbar. System.Boolean isVertical If set to true this is a vertical scrollbar, otherwise, the scrollbar is horizontal. System.Boolean showBothScrollIndicator If set to true (default) will have the other scrollbar, otherwise will have only one. 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 Host Get or sets the view that host this View Declaration public View Host { get; } Property Value Type Description View 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 KeepContentAlwaysInViewport Get or sets if the view-port is kept always visible in the area of this ScrollBarView Declaration public bool KeepContentAlwaysInViewport { get; set; } Property Value Type Description System.Boolean OtherScrollBarView Represent a vertical or horizontal ScrollBarView other than this. Declaration public ScrollBarView OtherScrollBarView { get; set; } Property Value Type Description ScrollBarView 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. ShowScrollIndicator Gets or sets the visibility for the vertical or horizontal scroll indicator. Declaration public bool ShowScrollIndicator { get; set; } Property Value Type Description System.Boolean true if show vertical or horizontal scroll indicator; otherwise, false . 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 View the Size is set to the appropriate dimension of Host . Methods MouseEvent(MouseEvent) Declaration public override bool MouseEvent(MouseEvent me) Parameters Type Name Description MouseEvent me Returns Type Description System.Boolean Overrides Responder.MouseEvent(MouseEvent) OnChangedPosition() Virtual method to invoke the ChangedPosition action event. Declaration public virtual void OnChangedPosition() OnEnter(View) Declaration public override bool OnEnter(View view) Parameters Type Name Description View view Returns Type Description System.Boolean Overrides View.OnEnter(View) Redraw(Rect) Declaration public override void Redraw(Rect region) Parameters Type Name Description Rect region Overrides View.Redraw(Rect) Refresh() Only used for a hosted view that will update and redraw the scrollbars. Declaration public virtual void Refresh() 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.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.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() 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.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.VerticalTextAlignment View.TextDirection View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.BeginInit() View.EndInit() View.Visible View.SetWidth(Int32, Int32) View.SetHeight(Int32, Int32) View.GetCurrentWidth(Int32) View.GetCurrentHeight(Int32) 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 scrollview 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) Declaration protected override void Dispose(bool disposing) Parameters Type Name Description System.Boolean disposing Overrides View.Dispose(Boolean) MouseEvent(MouseEvent) Declaration public override bool MouseEvent(MouseEvent me) Parameters Type Name Description MouseEvent me Returns Type Description System.Boolean Overrides Responder.MouseEvent(MouseEvent) OnEnter(View) Declaration public override bool OnEnter(View view) Parameters Type Name Description View view Returns Type Description System.Boolean Overrides View.OnEnter(View) PositionCursor() Declaration public override void PositionCursor() Overrides View.PositionCursor() ProcessKey(KeyEvent) Declaration public override bool ProcessKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides View.ProcessKey(KeyEvent) Redraw(Rect) Declaration public override void Redraw(Rect region) Parameters Type Name Description Rect region Overrides View.Redraw(Rect) 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.CanFocusChanged View.EnabledChanged View.VisibleChanged 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.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() 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.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.VerticalTextAlignment View.TextDirection View.IsInitialized View.Enabled View.Visible View.Border View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.OnCanFocusChanged() View.OnEnabledChanged() View.OnVisibleChanged() View.BeginInit() View.EndInit() View.SetWidth(Int32, Int32) View.SetHeight(Int32, Int32) View.GetCurrentWidth(Int32) View.GetCurrentHeight(Int32) View.GetNormalColor() 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 scrollview 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) Declaration protected override void Dispose(bool disposing) Parameters Type Name Description System.Boolean disposing Overrides View.Dispose(Boolean) MouseEvent(MouseEvent) Declaration public override bool MouseEvent(MouseEvent me) Parameters Type Name Description MouseEvent me Returns Type Description System.Boolean Overrides Responder.MouseEvent(MouseEvent) OnEnter(View) Declaration public override bool OnEnter(View view) Parameters Type Name Description View view Returns Type Description System.Boolean Overrides View.OnEnter(View) PositionCursor() Declaration public override void PositionCursor() Overrides View.PositionCursor() ProcessKey(KeyEvent) Declaration public override bool ProcessKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides View.ProcessKey(KeyEvent) Redraw(Rect) Declaration public override void Redraw(Rect region) Parameters Type Name Description Rect region Overrides View.Redraw(Rect) 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."
+ "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, ustring) Allows to retrieve a Key from a ShortcutTag Declaration public static Key GetShortcutFromTag(ustring tag, ustring delimiter = null) Parameters Type Name Description NStack.ustring tag The key as string. NStack.ustring delimiter The delimiter string. Returns Type Description Key GetShortcutTag(Key, ustring) Get the Shortcut key as string. Declaration public static ustring GetShortcutTag(Key shortcut, ustring delimiter = null) Parameters Type Name Description Key shortcut The shortcut key. NStack.ustring delimiter The delimiter string. 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",
"title": "Struct Size",
- "keywords": "Struct Size Stores an ordered pair of integers, which specify a Height and Width. Inherited Members System.Object.Equals(System.Object, System.Object) System.Object.GetType() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public struct Size Constructors Size(Int32, Int32) Size Constructor Declaration public Size(int width, int height) Parameters Type Name Description System.Int32 width System.Int32 height Remarks Creates a Size from specified dimensions. Size(Point) Size Constructor Declaration public Size(Point pt) Parameters Type Name Description Point pt Remarks Creates a Size from a Point value. Fields Empty Gets a Size structure that has a Height and Width value of 0. Declaration public static readonly Size Empty Field Value Type Description Size Properties Height Height Property Declaration public int Height { get; set; } Property Value Type Description System.Int32 Remarks The Height coordinate of the Size. IsEmpty IsEmpty Property Declaration public bool IsEmpty { get; } Property Value Type Description System.Boolean Remarks Indicates if both Width and Height are zero. Width Width Property Declaration public int Width { get; set; } Property Value Type Description System.Int32 Remarks The Width coordinate of the Size. Methods Add(Size, Size) Adds the width and height of one Size structure to the width and height of another Size structure. Declaration public static Size Add(Size sz1, Size sz2) Parameters Type Name Description Size sz1 The first Size structure to add. Size sz2 The second Size structure to add. Returns Type Description Size The add. Equals(Object) Equals Method Declaration public override bool Equals(object obj) Parameters Type Name Description System.Object obj Returns Type Description System.Boolean Overrides System.ValueType.Equals(System.Object) Remarks Checks equivalence of this Size and another object. GetHashCode() GetHashCode Method Declaration public override int GetHashCode() Returns Type Description System.Int32 Overrides System.ValueType.GetHashCode() Remarks Calculates a hashing value. Subtract(Size, Size) Subtracts the width and height of one Size structure to the width and height of another Size structure. Declaration public static Size Subtract(Size sz1, Size sz2) Parameters Type Name Description Size sz1 The first Size structure to subtract. Size sz2 The second Size structure to subtract. Returns Type Description Size The subtract. ToString() ToString Method Declaration public override string ToString() Returns Type Description System.String Overrides System.ValueType.ToString() Remarks Formats the Size as a string in coordinate notation. Operators Addition(Size, Size) Addition Operator Declaration public static Size operator +(Size sz1, Size sz2) Parameters Type Name Description Size sz1 Size sz2 Returns Type Description Size Remarks Addition of two Size structures. Equality(Size, Size) Equality Operator Declaration public static bool operator ==(Size sz1, Size sz2) Parameters Type Name Description Size sz1 Size sz2 Returns Type Description System.Boolean Remarks Compares two Size objects. The return value is based on the equivalence of the Width and Height properties of the two Sizes. Explicit(Size to Point) Size to Point Conversion Declaration public static explicit operator Point(Size size) Parameters Type Name Description Size size Returns Type Description Point Remarks Returns a Point based on the dimensions of a given Size. Requires explicit cast. Inequality(Size, Size) Inequality Operator Declaration public static bool operator !=(Size sz1, Size sz2) Parameters Type Name Description Size sz1 Size sz2 Returns Type Description System.Boolean Remarks Compares two Size objects. The return value is based on the equivalence of the Width and Height properties of the two Sizes. Subtraction(Size, Size) Subtraction Operator Declaration public static Size operator -(Size sz1, Size sz2) Parameters Type Name Description Size sz1 Size sz2 Returns Type Description Size Remarks Subtracts two Size structures."
+ "keywords": "Struct Size Stores an ordered pair of integers, which specify a Height and Width. Inherited Members System.Object.Equals(System.Object, System.Object) System.Object.GetType() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public struct Size Constructors Size(Int32, Int32) Size Constructor Declaration public Size(int width, int height) Parameters Type Name Description System.Int32 width System.Int32 height Remarks Creates a Size from specified dimensions. Size(Point) Size Constructor Declaration public Size(Point pt) Parameters Type Name Description Point pt Remarks Creates a Size from a Point value. Fields Empty Gets a Size structure that has a Height and Width value of 0. Declaration public static readonly Size Empty Field Value Type Description Size Properties Height Height Property Declaration public int Height { get; set; } Property Value Type Description System.Int32 Remarks The Height coordinate of the Size. IsEmpty IsEmpty Property Declaration public readonly bool IsEmpty { get; } Property Value Type Description System.Boolean Remarks Indicates if both Width and Height are zero. Width Width Property Declaration public int Width { get; set; } Property Value Type Description System.Int32 Remarks The Width coordinate of the Size. Methods Add(Size, Size) Adds the width and height of one Size structure to the width and height of another Size structure. Declaration public static Size Add(Size sz1, Size sz2) Parameters Type Name Description Size sz1 The first Size structure to add. Size sz2 The second Size structure to add. Returns Type Description Size The add. Equals(Object) Equals Method Declaration public override bool Equals(object obj) Parameters Type Name Description System.Object obj Returns Type Description System.Boolean Overrides System.ValueType.Equals(System.Object) Remarks Checks equivalence of this Size and another object. GetHashCode() GetHashCode Method Declaration public override int GetHashCode() Returns Type Description System.Int32 Overrides System.ValueType.GetHashCode() Remarks Calculates a hashing value. Subtract(Size, Size) Subtracts the width and height of one Size structure to the width and height of another Size structure. Declaration public static Size Subtract(Size sz1, Size sz2) Parameters Type Name Description Size sz1 The first Size structure to subtract. Size sz2 The second Size structure to subtract. Returns Type Description Size The subtract. ToString() ToString Method Declaration public override string ToString() Returns Type Description System.String Overrides System.ValueType.ToString() Remarks Formats the Size as a string in coordinate notation. Operators Addition(Size, Size) Addition Operator Declaration public static Size operator +(Size sz1, Size sz2) Parameters Type Name Description Size sz1 Size sz2 Returns Type Description Size Remarks Addition of two Size structures. Equality(Size, Size) Equality Operator Declaration public static bool operator ==(Size sz1, Size sz2) Parameters Type Name Description Size sz1 Size sz2 Returns Type Description System.Boolean Remarks Compares two Size objects. The return value is based on the equivalence of the Width and Height properties of the two Sizes. Explicit(Size to Point) Size to Point Conversion Declaration public static explicit operator Point(Size size) Parameters Type Name Description Size size Returns Type Description Point Remarks Returns a Point based on the dimensions of a given Size. Requires explicit cast. Inequality(Size, Size) Inequality Operator Declaration public static bool operator !=(Size sz1, Size sz2) Parameters Type Name Description Size sz1 Size sz2 Returns Type Description System.Boolean Remarks Compares two Size objects. The return value is based on the equivalence of the Width and Height properties of the two Sizes. Subtraction(Size, Size) Subtraction Operator Declaration public static Size operator -(Size sz1, Size sz2) Parameters Type Name Description Size sz1 Size sz2 Returns Type Description Size Remarks Subtracts two Size structures."
},
"api/Terminal.Gui/Terminal.Gui.SizeF.html": {
"href": "api/Terminal.Gui/Terminal.Gui.SizeF.html",
"title": "Struct SizeF",
- "keywords": "Struct SizeF Represents the size of a rectangular region with an ordered pair of width and height. Implements System.IEquatable < SizeF > Inherited Members System.Object.Equals(System.Object, System.Object) System.Object.GetType() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public struct SizeF : IEquatable Constructors SizeF(Single, Single) Initializes a new instance of the SizeF class from the specified dimensions. Declaration public SizeF(float width, float height) Parameters Type Name Description System.Single width System.Single height SizeF(PointF) Initializes a new instance of the SizeF class from the specified PointF . Declaration public SizeF(PointF pt) Parameters Type Name Description PointF pt SizeF(SizeF) Initializes a new instance of the SizeF class from the specified existing SizeF . Declaration public SizeF(SizeF size) Parameters Type Name Description SizeF size Fields Empty Initializes a new instance of the SizeF class. Declaration public static readonly SizeF Empty Field Value Type Description SizeF Properties Height Represents the vertical component of this SizeF . Declaration public float Height { get; set; } Property Value Type Description System.Single IsEmpty Tests whether this SizeF has zero width and height. Declaration [Browsable(false)] public bool IsEmpty { get; } Property Value Type Description System.Boolean Width Represents the horizontal component of this SizeF . Declaration public float Width { get; set; } Property Value Type Description System.Single Methods Add(SizeF, SizeF) Performs vector addition of two SizeF objects. Declaration public static SizeF Add(SizeF sz1, SizeF sz2) Parameters Type Name Description SizeF sz1 SizeF sz2 Returns Type Description SizeF Equals(Object) Tests to see whether the specified object is a SizeF with the same dimensions as this SizeF . Declaration public override bool Equals(object obj) Parameters Type Name Description System.Object obj Returns Type Description System.Boolean Overrides System.ValueType.Equals(System.Object) Equals(SizeF) Tests whether two SizeF objects are identical. Declaration public bool Equals(SizeF other) Parameters Type Name Description SizeF other Returns Type Description System.Boolean GetHashCode() Generates a hashcode from the width and height Declaration public override int GetHashCode() Returns Type Description System.Int32 Overrides System.ValueType.GetHashCode() Subtract(SizeF, SizeF) Contracts a SizeF by another SizeF . Declaration public static SizeF Subtract(SizeF sz1, SizeF sz2) Parameters Type Name Description SizeF sz1 SizeF sz2 Returns Type Description SizeF ToString() Creates a human-readable string that represents this SizeF . Declaration public override string ToString() Returns Type Description System.String Overrides System.ValueType.ToString() Operators Addition(SizeF, SizeF) Performs vector addition of two SizeF objects. Declaration public static SizeF operator +(SizeF sz1, SizeF sz2) Parameters Type Name Description SizeF sz1 SizeF sz2 Returns Type Description SizeF Division(SizeF, Single) Divides SizeF by a System.Single producing SizeF . Declaration public static SizeF operator /(SizeF left, float right) Parameters Type Name Description SizeF left Dividend of type SizeF . System.Single right Divisor of type System.Int32 . Returns Type Description SizeF Result of type SizeF . Equality(SizeF, SizeF) Tests whether two SizeF objects are identical. Declaration public static bool operator ==(SizeF sz1, SizeF sz2) Parameters Type Name Description SizeF sz1 SizeF sz2 Returns Type Description System.Boolean Explicit(SizeF to PointF) Converts the specified SizeF to a PointF . Declaration public static explicit operator PointF(SizeF size) Parameters Type Name Description SizeF size Returns Type Description PointF Inequality(SizeF, SizeF) Tests whether two SizeF objects are different. Declaration public static bool operator !=(SizeF sz1, SizeF sz2) Parameters Type Name Description SizeF sz1 SizeF sz2 Returns Type Description System.Boolean Multiply(Single, SizeF) Multiplies SizeF by a System.Single producing SizeF . Declaration public static SizeF operator *(float left, SizeF right) Parameters Type Name Description System.Single left Multiplier of type System.Single . SizeF right Multiplicand of type SizeF . Returns Type Description SizeF Product of type SizeF . Multiply(SizeF, Single) Multiplies SizeF by a System.Single producing SizeF . Declaration public static SizeF operator *(SizeF left, float right) Parameters Type Name Description SizeF left Multiplicand of type SizeF . System.Single right Multiplier of type System.Single . Returns Type Description SizeF Product of type SizeF . Subtraction(SizeF, SizeF) Contracts a SizeF by another SizeF Declaration public static SizeF operator -(SizeF sz1, SizeF sz2) Parameters Type Name Description SizeF sz1 SizeF sz2 Returns Type Description SizeF Implements System.IEquatable"
+ "keywords": "Struct SizeF Represents the size of a rectangular region with an ordered pair of width and height. Implements System.IEquatable < SizeF > Inherited Members System.Object.Equals(System.Object, System.Object) System.Object.GetType() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public struct SizeF : IEquatable Constructors SizeF(Single, Single) Initializes a new instance of the SizeF class from the specified dimensions. Declaration public SizeF(float width, float height) Parameters Type Name Description System.Single width System.Single height SizeF(PointF) Initializes a new instance of the SizeF class from the specified PointF . Declaration public SizeF(PointF pt) Parameters Type Name Description PointF pt SizeF(SizeF) Initializes a new instance of the SizeF class from the specified existing SizeF . Declaration public SizeF(SizeF size) Parameters Type Name Description SizeF size Fields Empty Initializes a new instance of the SizeF class. Declaration public static readonly SizeF Empty Field Value Type Description SizeF Properties Height Represents the vertical component of this SizeF . Declaration public float Height { get; set; } Property Value Type Description System.Single IsEmpty Tests whether this SizeF has zero width and height. Declaration [Browsable(false)] public readonly bool IsEmpty { get; } Property Value Type Description System.Boolean Width Represents the horizontal component of this SizeF . Declaration public float Width { get; set; } Property Value Type Description System.Single Methods Add(SizeF, SizeF) Performs vector addition of two SizeF objects. Declaration public static SizeF Add(SizeF sz1, SizeF sz2) Parameters Type Name Description SizeF sz1 SizeF sz2 Returns Type Description SizeF Equals(Object) Tests to see whether the specified object is a SizeF with the same dimensions as this SizeF . Declaration public override bool Equals(object obj) Parameters Type Name Description System.Object obj Returns Type Description System.Boolean Overrides System.ValueType.Equals(System.Object) Equals(SizeF) Tests whether two SizeF objects are identical. Declaration public bool Equals(SizeF other) Parameters Type Name Description SizeF other Returns Type Description System.Boolean GetHashCode() Generates a hashcode from the width and height Declaration public override int GetHashCode() Returns Type Description System.Int32 Overrides System.ValueType.GetHashCode() Subtract(SizeF, SizeF) Contracts a SizeF by another SizeF . Declaration public static SizeF Subtract(SizeF sz1, SizeF sz2) Parameters Type Name Description SizeF sz1 SizeF sz2 Returns Type Description SizeF ToString() Creates a human-readable string that represents this SizeF . Declaration public override string ToString() Returns Type Description System.String Overrides System.ValueType.ToString() Operators Addition(SizeF, SizeF) Performs vector addition of two SizeF objects. Declaration public static SizeF operator +(SizeF sz1, SizeF sz2) Parameters Type Name Description SizeF sz1 SizeF sz2 Returns Type Description SizeF Division(SizeF, Single) Divides SizeF by a System.Single producing SizeF . Declaration public static SizeF operator /(SizeF left, float right) Parameters Type Name Description SizeF left Dividend of type SizeF . System.Single right Divisor of type System.Int32 . Returns Type Description SizeF Result of type SizeF . Equality(SizeF, SizeF) Tests whether two SizeF objects are identical. Declaration public static bool operator ==(SizeF sz1, SizeF sz2) Parameters Type Name Description SizeF sz1 SizeF sz2 Returns Type Description System.Boolean Explicit(SizeF to PointF) Converts the specified SizeF to a PointF . Declaration public static explicit operator PointF(SizeF size) Parameters Type Name Description SizeF size Returns Type Description PointF Inequality(SizeF, SizeF) Tests whether two SizeF objects are different. Declaration public static bool operator !=(SizeF sz1, SizeF sz2) Parameters Type Name Description SizeF sz1 SizeF sz2 Returns Type Description System.Boolean Multiply(Single, SizeF) Multiplies SizeF by a System.Single producing SizeF . Declaration public static SizeF operator *(float left, SizeF right) Parameters Type Name Description System.Single left Multiplier of type System.Single . SizeF right Multiplicand of type SizeF . Returns Type Description SizeF Product of type SizeF . Multiply(SizeF, Single) Multiplies SizeF by a System.Single producing SizeF . Declaration public static SizeF operator *(SizeF left, float right) Parameters Type Name Description SizeF left Multiplicand of type SizeF . System.Single right Multiplier of type System.Single . Returns Type Description SizeF Product of type SizeF . Subtraction(SizeF, SizeF) Contracts a SizeF by another SizeF Declaration public static SizeF operator -(SizeF sz1, SizeF sz2) Parameters Type Name Description SizeF sz1 SizeF sz2 Returns Type Description SizeF Implements System.IEquatable"
+ },
+ "api/Terminal.Gui/Terminal.Gui.StackExtensions.html": {
+ "href": "api/Terminal.Gui/Terminal.Gui.StackExtensions.html",
+ "title": "Class StackExtensions",
+ "keywords": "Class StackExtensions Extension of System.Collections.Generic.Stack helper to work with specific System.Collections.Generic.IEqualityComparer Inheritance System.Object StackExtensions 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 StackExtensions Methods Contains(Stack, T, IEqualityComparer) Check if the stack object contains the value to find. Declaration public static bool Contains(this Stack stack, T valueToFind, IEqualityComparer comparer = null) Parameters Type Name Description System.Collections.Generic.Stack stack The stack object. T valueToFind Value to find. System.Collections.Generic.IEqualityComparer comparer The comparison object. Returns Type Description System.Boolean true If the value was found. false otherwise. Type Parameters Name Description T The stack object type. FindDuplicates(Stack, IEqualityComparer) Find all duplicates stack objects values. Declaration public static Stack FindDuplicates(this Stack stack, IEqualityComparer comparer = null) Parameters Type Name Description System.Collections.Generic.Stack stack The stack object. System.Collections.Generic.IEqualityComparer comparer The comparison object. Returns Type Description System.Collections.Generic.Stack The duplicates stack object. Type Parameters Name Description T The stack object type. MoveNext(Stack) Move the first stack object value to the end. Declaration public static void MoveNext(this Stack stack) Parameters Type Name Description System.Collections.Generic.Stack stack The stack object. Type Parameters Name Description T The stack object type. MovePrevious(Stack) Move the last stack object value to the top. Declaration public static void MovePrevious(this Stack stack) Parameters Type Name Description System.Collections.Generic.Stack stack The stack object. Type Parameters Name Description T The stack object type. MoveTo(Stack, T, Int32, IEqualityComparer) Move the stack object value to the index. Declaration public static void MoveTo(this Stack stack, T valueToMove, int index = 0, IEqualityComparer comparer = null) Parameters Type Name Description System.Collections.Generic.Stack stack The stack object. T valueToMove Value to move. System.Int32 index The index where to move. System.Collections.Generic.IEqualityComparer comparer The comparison object. Type Parameters Name Description T The stack object type. Replace(Stack, T, T, IEqualityComparer) Replaces an stack object values that match with the value to replace. Declaration public static void Replace(this Stack stack, T valueToReplace, T valueToReplaceWith, IEqualityComparer comparer = null) Parameters Type Name Description System.Collections.Generic.Stack stack The stack object. T valueToReplace Value to replace. T valueToReplaceWith Value to replace with to what matches the value to replace. System.Collections.Generic.IEqualityComparer comparer The comparison object. Type Parameters Name Description T The stack object type. Swap(Stack, T, T, IEqualityComparer) Swap two stack objects values that matches with the both values. Declaration public static void Swap(this Stack stack, T valueToSwapFrom, T valueToSwapTo, IEqualityComparer comparer = null) Parameters Type Name Description System.Collections.Generic.Stack stack The stack object. T valueToSwapFrom Value to swap from. T valueToSwapTo Value to swap to. System.Collections.Generic.IEqualityComparer comparer The comparison object. Type Parameters Name Description T The stack object type."
},
"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.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.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() 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.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.VerticalTextAlignment View.TextDirection View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.BeginInit() View.EndInit() View.Visible View.SetWidth(Int32, Int32) View.SetHeight(Int32, Int32) View.GetCurrentWidth(Int32) View.GetCurrentHeight(Int32) 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) Declaration protected override void Dispose(bool disposing) Parameters Type Name Description System.Boolean disposing Overrides View.Dispose(Boolean) MouseEvent(MouseEvent) Declaration public override bool MouseEvent(MouseEvent me) Parameters Type Name Description MouseEvent me Returns Type Description System.Boolean Overrides Responder.MouseEvent(MouseEvent) OnEnter(View) Declaration public override bool OnEnter(View view) Parameters Type Name Description View view Returns Type Description System.Boolean Overrides View.OnEnter(View) ProcessHotKey(KeyEvent) Declaration public override bool ProcessHotKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides View.ProcessHotKey(KeyEvent) Redraw(Rect) Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds Overrides View.Redraw(Rect) 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.CanFocusChanged View.EnabledChanged View.VisibleChanged 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.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() 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.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.VerticalTextAlignment View.TextDirection View.IsInitialized View.Enabled View.Visible View.Border View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.OnCanFocusChanged() View.OnEnabledChanged() View.OnVisibleChanged() View.BeginInit() View.EndInit() View.SetWidth(Int32, Int32) View.SetHeight(Int32, Int32) View.GetCurrentWidth(Int32) View.GetCurrentHeight(Int32) View.GetNormalColor() 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 [] ShortcutDelimiter Used for change the shortcut delimiter separator. Declaration public static ustring ShortcutDelimiter { get; set; } Property Value Type Description NStack.ustring Methods AddItemAt(Int32, StatusItem) Inserts a StatusItem in the specified index of Items . Declaration public void AddItemAt(int index, StatusItem item) Parameters Type Name Description System.Int32 index The zero-based index at which item should be inserted. StatusItem item The item to insert. Dispose(Boolean) Declaration protected override void Dispose(bool disposing) Parameters Type Name Description System.Boolean disposing Overrides View.Dispose(Boolean) MouseEvent(MouseEvent) Declaration public override bool MouseEvent(MouseEvent me) Parameters Type Name Description MouseEvent me Returns Type Description System.Boolean Overrides Responder.MouseEvent(MouseEvent) OnEnter(View) Declaration public override bool OnEnter(View view) Parameters Type Name Description View view Returns Type Description System.Boolean Overrides View.OnEnter(View) ProcessHotKey(KeyEvent) Declaration public override bool ProcessHotKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides View.ProcessHotKey(KeyEvent) Redraw(Rect) Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds Overrides View.Redraw(Rect) RemoveItem(Int32) Removes a StatusItem at specified index of Items . Declaration public StatusItem RemoveItem(int index) Parameters Type Name Description System.Int32 index The zero-based index of the item to remove. Returns Type Description StatusItem The StatusItem removed. Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize"
},
"api/Terminal.Gui/Terminal.Gui.StatusItem.html": {
"href": "api/Terminal.Gui/Terminal.Gui.StatusItem.html",
@@ -414,15 +474,35 @@
"title": "Class TableView.CellActivatedEventArgs",
"keywords": "Class TableView.CellActivatedEventArgs Defines the event arguments for CellActivated event Inheritance System.Object System.EventArgs TableView.CellActivatedEventArgs 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 CellActivatedEventArgs : EventArgs Constructors CellActivatedEventArgs(DataTable, Int32, Int32) Creates a new instance of arguments describing a cell being activated in TableView Declaration public CellActivatedEventArgs(DataTable t, int col, int row) Parameters Type Name Description System.Data.DataTable t System.Int32 col System.Int32 row Properties Col The column index of the Table cell that is being activated Declaration public int Col { get; } Property Value Type Description System.Int32 Row The row index of the Table cell that is being activated Declaration public int Row { get; } Property Value Type Description System.Int32 Table The current table to which the new indexes refer. May be null e.g. if selection change is the result of clearing the table from the view Declaration public DataTable Table { get; } Property Value Type Description System.Data.DataTable"
},
+ "api/Terminal.Gui/Terminal.Gui.TableView.CellColorGetterArgs.html": {
+ "href": "api/Terminal.Gui/Terminal.Gui.TableView.CellColorGetterArgs.html",
+ "title": "Class TableView.CellColorGetterArgs",
+ "keywords": "Class TableView.CellColorGetterArgs Arguments for a TableView.CellColorGetterDelegate . Describes a cell for which a rendering ColorScheme is being sought Inheritance System.Object TableView.CellColorGetterArgs 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 CellColorGetterArgs Properties CellValue The hard typed value being rendered in the cell for which color is needed Declaration public object CellValue { get; } Property Value Type Description System.Object ColIdex The index of column in Table for which color is needed Declaration public int ColIdex { get; } Property Value Type Description System.Int32 Representation The textual representation of CellValue (what will actually be drawn to the screen) Declaration public string Representation { get; } Property Value Type Description System.String RowIndex The index of the row in Table for which color is needed Declaration public int RowIndex { get; } Property Value Type Description System.Int32 RowScheme the color scheme that is going to be used to render the cell if no cell specific color scheme is returned Declaration public ColorScheme RowScheme { get; } Property Value Type Description ColorScheme Table The data table hosted by the TableView control. Declaration public DataTable Table { get; } Property Value Type Description System.Data.DataTable"
+ },
+ "api/Terminal.Gui/Terminal.Gui.TableView.CellColorGetterDelegate.html": {
+ "href": "api/Terminal.Gui/Terminal.Gui.TableView.CellColorGetterDelegate.html",
+ "title": "Delegate TableView.CellColorGetterDelegate",
+ "keywords": "Delegate TableView.CellColorGetterDelegate Delegate for providing color to TableView cells based on the value being rendered Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public delegate ColorScheme CellColorGetterDelegate(TableView.CellColorGetterArgs args); Parameters Type Name Description TableView.CellColorGetterArgs args Contains information about the cell for which color is needed Returns Type Description ColorScheme"
+ },
"api/Terminal.Gui/Terminal.Gui.TableView.ColumnStyle.html": {
"href": "api/Terminal.Gui/Terminal.Gui.TableView.ColumnStyle.html",
"title": "Class TableView.ColumnStyle",
- "keywords": "Class TableView.ColumnStyle Describes how to render a given column in a TableView including Alignment and textual representation of cells (e.g. date formats) See TableView Deep Dive for more information . Inheritance System.Object TableView.ColumnStyle 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 ColumnStyle Fields AlignmentGetter Defines a delegate for returning custom alignment per cell based on cell values. When specified this will override Alignment Declaration public Func AlignmentGetter Field Value Type Description System.Func < System.Object , TextAlignment > RepresentationGetter Defines a delegate for returning custom representations of cell values. If not set then System.Object.ToString() is used. Return values from your delegate may be truncated e.g. based on MaxWidth Declaration public Func RepresentationGetter Field Value Type Description System.Func < System.Object , System.String > Properties Alignment Defines the default alignment for all values rendered in this column. For custom alignment based on cell contents use AlignmentGetter . Declaration public TextAlignment Alignment { get; set; } Property Value Type Description TextAlignment Format Defines the format for values e.g. \"yyyy-MM-dd\" for dates Declaration public string Format { get; set; } Property Value Type Description System.String MaxWidth Set the maximum width of the column in characters. This value will be ignored if more than the tables MaxCellWidth . Defaults to DefaultMaxCellWidth Declaration public int MaxWidth { get; set; } Property Value Type Description System.Int32 MinWidth Set the minimum width of the column in characters. This value will be ignored if more than the tables MaxCellWidth or the MaxWidth Declaration public int MinWidth { get; set; } Property Value Type Description System.Int32 Methods GetAlignment(Object) Returns the alignment for the cell based on cellValue and AlignmentGetter / Alignment Declaration public TextAlignment GetAlignment(object cellValue) Parameters Type Name Description System.Object cellValue Returns Type Description TextAlignment GetRepresentation(Object) Returns the full string to render (which may be truncated if too long) that the current style says best represents the given value Declaration public string GetRepresentation(object value) Parameters Type Name Description System.Object value Returns Type Description System.String"
+ "keywords": "Class TableView.ColumnStyle Describes how to render a given column in a TableView including Alignment and textual representation of cells (e.g. date formats) See TableView Deep Dive for more information . Inheritance System.Object TableView.ColumnStyle 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 ColumnStyle Fields AlignmentGetter Defines a delegate for returning custom alignment per cell based on cell values. When specified this will override Alignment Declaration public Func AlignmentGetter Field Value Type Description System.Func < System.Object , TextAlignment > ColorGetter Defines a delegate for returning a custom color scheme per cell based on cell values. Return null for the default Declaration public TableView.CellColorGetterDelegate ColorGetter Field Value Type Description TableView.CellColorGetterDelegate RepresentationGetter Defines a delegate for returning custom representations of cell values. If not set then System.Object.ToString() is used. Return values from your delegate may be truncated e.g. based on MaxWidth Declaration public Func RepresentationGetter Field Value Type Description System.Func < System.Object , System.String > Properties Alignment Defines the default alignment for all values rendered in this column. For custom alignment based on cell contents use AlignmentGetter . Declaration public TextAlignment Alignment { get; set; } Property Value Type Description TextAlignment Format Defines the format for values e.g. \"yyyy-MM-dd\" for dates Declaration public string Format { get; set; } Property Value Type Description System.String MaxWidth Set the maximum width of the column in characters. This value will be ignored if more than the tables MaxCellWidth . Defaults to DefaultMaxCellWidth Declaration public int MaxWidth { get; set; } Property Value Type Description System.Int32 MinWidth Set the minimum width of the column in characters. This value will be ignored if more than the tables MaxCellWidth or the MaxWidth Declaration public int MinWidth { get; set; } Property Value Type Description System.Int32 Methods GetAlignment(Object) Returns the alignment for the cell based on cellValue and AlignmentGetter / Alignment Declaration public TextAlignment GetAlignment(object cellValue) Parameters Type Name Description System.Object cellValue Returns Type Description TextAlignment GetRepresentation(Object) Returns the full string to render (which may be truncated if too long) that the current style says best represents the given value Declaration public string GetRepresentation(object value) Parameters Type Name Description System.Object value Returns Type Description System.String"
},
"api/Terminal.Gui/Terminal.Gui.TableView.html": {
"href": "api/Terminal.Gui/Terminal.Gui.TableView.html",
"title": "Class TableView",
- "keywords": "Class TableView View for tabular data based on a System.Data.DataTable . See TableView Deep Dive for more information . Inheritance System.Object Responder View TableView 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.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() 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.VerticalTextAlignment View.TextDirection 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 View.SetWidth(Int32, Int32) View.SetHeight(Int32, Int32) View.GetCurrentWidth(Int32) View.GetCurrentHeight(Int32) 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 TableView : View, IDisposable, ISupportInitializeNotification, ISupportInitialize Constructors TableView() Initialzies a TableView class using Computed layout. Set the Table property to begin editing Declaration public TableView() TableView(DataTable) Initialzies a TableView class using Computed layout. Declaration public TableView(DataTable table) Parameters Type Name Description System.Data.DataTable table The table to display in the control Fields DefaultMaxCellWidth The default maximum cell width for MaxCellWidth and MaxWidth Declaration public const int DefaultMaxCellWidth = 100 Field Value Type Description System.Int32 Properties CellActivationKey The key which when pressed should trigger CellActivated event. Defaults to Enter. Declaration public Key CellActivationKey { get; set; } Property Value Type Description Key ColumnOffset Horizontal scroll offset. The index of the first column in Table to display when when rendering the view. Declaration public int ColumnOffset { get; set; } Property Value Type Description System.Int32 Remarks This property allows very wide tables to be rendered with horizontal scrolling FullRowSelect True to select the entire row at once. False to select individual cells. Defaults to false Declaration public bool FullRowSelect { get; set; } Property Value Type Description System.Boolean MaxCellWidth The maximum number of characters to render in any given column. This prevents one long column from pushing out all the others Declaration public int MaxCellWidth { get; set; } Property Value Type Description System.Int32 MultiSelect True to allow regions to be selected Declaration public bool MultiSelect { get; set; } Property Value Type Description System.Boolean MultiSelectedRegions When MultiSelect is enabled this property contain all rectangles of selected cells. Rectangles describe column/rows selected in Table (not screen coordinates) Declaration public Stack MultiSelectedRegions { get; } Property Value Type Description System.Collections.Generic.Stack < TableView.TableSelection > NullSymbol The text representation that should be rendered for cells with the value System.DBNull.Value Declaration public string NullSymbol { get; set; } Property Value Type Description System.String RowOffset Vertical scroll offset. The index of the first row in Table to display in the first non header line of the control when rendering the view. Declaration public int RowOffset { get; set; } Property Value Type Description System.Int32 SelectedColumn The index of System.Data.DataTable.Columns in Table that the user has currently selected Declaration public int SelectedColumn { get; set; } Property Value Type Description System.Int32 SelectedRow The index of System.Data.DataTable.Rows in Table that the user has currently selected Declaration public int SelectedRow { get; set; } Property Value Type Description System.Int32 SeparatorSymbol The symbol to add after each cell value and header value to visually seperate values (if not using vertical gridlines) Declaration public char SeparatorSymbol { get; set; } Property Value Type Description System.Char Style Contains options for changing how the table is rendered Declaration public TableView.TableStyle Style { get; set; } Property Value Type Description TableView.TableStyle Table The data table to render in the view. Setting this property automatically updates and redraws the control. Declaration public DataTable Table { get; set; } Property Value Type Description System.Data.DataTable Methods CellToScreen(Int32, Int32) Returns the screen position (relative to the control client area) that the given cell is rendered or null if it is outside the current scroll area or no table is loaded Declaration public Point? CellToScreen(int tableColumn, int tableRow) Parameters Type Name Description System.Int32 tableColumn The index of the Table column you are looking for, use System.Data.DataColumn.Ordinal System.Int32 tableRow The index of the row in Table that you are looking for Returns Type Description System.Nullable < Point > ChangeSelectionByOffset(Int32, Int32, Boolean) Moves the SelectedRow and SelectedColumn by the provided offsets. Optionally starting a box selection (see MultiSelect ) Declaration public void ChangeSelectionByOffset(int offsetX, int offsetY, bool extendExistingSelection) Parameters Type Name Description System.Int32 offsetX Offset in number of columns System.Int32 offsetY Offset in number of rows System.Boolean extendExistingSelection True to create a multi cell selection or adjust an existing one EnsureSelectedCellIsVisible() Updates scroll offsets to ensure that the selected cell is visible. Has no effect if Table has not been set. Declaration public void EnsureSelectedCellIsVisible() Remarks Changes will not be immediately visible in the display until you call SetNeedsDisplay() EnsureValidScrollOffsets() Updates ColumnOffset and RowOffset where they are outside the bounds of the table (by adjusting them to the nearest existing cell). Has no effect if Table has not been set. Declaration public void EnsureValidScrollOffsets() Remarks Changes will not be immediately visible in the display until you call SetNeedsDisplay() EnsureValidSelection() Updates SelectedColumn , SelectedRow and MultiSelectedRegions where they are outside the bounds of the table (by adjusting them to the nearest existing cell). Has no effect if Table has not been set. Declaration public void EnsureValidSelection() Remarks Changes will not be immediately visible in the display until you call SetNeedsDisplay() GetAllSelectedCells() Returns all cells in any MultiSelectedRegions (if MultiSelect is enabled) and the selected cell Declaration public IEnumerable GetAllSelectedCells() Returns Type Description System.Collections.Generic.IEnumerable < Point > IsSelected(Int32, Int32) Returns true if the given cell is selected either because it is the active cell or part of a multi cell selection (e.g. FullRowSelect ) Declaration public bool IsSelected(int col, int row) Parameters Type Name Description System.Int32 col System.Int32 row Returns Type Description System.Boolean MouseEvent(MouseEvent) Declaration public override bool MouseEvent(MouseEvent me) Parameters Type Name Description MouseEvent me Returns Type Description System.Boolean Overrides Responder.MouseEvent(MouseEvent) OnCellActivated(TableView.CellActivatedEventArgs) Invokes the CellActivated event Declaration protected virtual void OnCellActivated(TableView.CellActivatedEventArgs args) Parameters Type Name Description TableView.CellActivatedEventArgs args OnSelectedCellChanged(TableView.SelectedCellChangedEventArgs) Invokes the SelectedCellChanged event Declaration protected virtual void OnSelectedCellChanged(TableView.SelectedCellChangedEventArgs args) Parameters Type Name Description TableView.SelectedCellChangedEventArgs args PositionCursor() Positions the cursor in the area of the screen in which the start of the active cell is rendered. Calls base implementation if active cell is not visible due to scrolling or table is loaded etc Declaration public override void PositionCursor() Overrides View.PositionCursor() ProcessKey(KeyEvent) Declaration public override bool ProcessKey(KeyEvent keyEvent) Parameters Type Name Description KeyEvent keyEvent Returns Type Description System.Boolean Overrides View.ProcessKey(KeyEvent) Redraw(Rect) Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds Overrides View.Redraw(Rect) ScreenToCell(Int32, Int32) Returns the column and row of Table that corresponds to a given point on the screen (relative to the control client area). Returns null if the point is in the header, no table is loaded or outside the control bounds Declaration public Point? ScreenToCell(int clientX, int clientY) Parameters Type Name Description System.Int32 clientX X offset from the top left of the control System.Int32 clientY Y offset from the top left of the control Returns Type Description System.Nullable < Point > SelectAll() When MultiSelect is on, creates selection over all cells in the table (replacing any old selection regions) Declaration public void SelectAll() SetSelection(Int32, Int32, Boolean) Moves the SelectedRow and SelectedColumn to the given col/row in Table . Optionally starting a box selection (see MultiSelect ) Declaration public void SetSelection(int col, int row, bool extendExistingSelection) Parameters Type Name Description System.Int32 col System.Int32 row System.Boolean extendExistingSelection True to create a multi cell selection or adjust an existing one Update() Updates the view to reflect changes to Table and to ( ColumnOffset / RowOffset ) etc Declaration public void Update() Remarks This always calls SetNeedsDisplay() Events CellActivated This event is raised when a cell is activated e.g. by double clicking or pressing CellActivationKey Declaration public event Action CellActivated Event Type Type Description System.Action < TableView.CellActivatedEventArgs > SelectedCellChanged This event is raised when the selected cell in the table changes. Declaration public event Action SelectedCellChanged Event Type Type Description System.Action < TableView.SelectedCellChangedEventArgs > Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize"
+ "keywords": "Class TableView View for tabular data based on a System.Data.DataTable . See TableView Deep Dive for more information . Inheritance System.Object Responder View TableView 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.CanFocusChanged View.EnabledChanged View.VisibleChanged 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.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() 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.VerticalTextAlignment View.TextDirection View.IsInitialized View.Enabled View.Visible View.Border View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.OnCanFocusChanged() View.OnEnabledChanged() View.OnVisibleChanged() View.Dispose(Boolean) View.BeginInit() View.EndInit() View.SetWidth(Int32, Int32) View.SetHeight(Int32, Int32) View.GetCurrentWidth(Int32) View.GetCurrentHeight(Int32) View.GetNormalColor() 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 TableView : View, IDisposable, ISupportInitializeNotification, ISupportInitialize Constructors TableView() Initialzies a TableView class using Computed layout. Set the Table property to begin editing Declaration public TableView() TableView(DataTable) Initialzies a TableView class using Computed layout. Declaration public TableView(DataTable table) Parameters Type Name Description System.Data.DataTable table The table to display in the control Fields DefaultMaxCellWidth The default maximum cell width for MaxCellWidth and MaxWidth Declaration public const int DefaultMaxCellWidth = 100 Field Value Type Description System.Int32 Properties CellActivationKey The key which when pressed should trigger CellActivated event. Defaults to Enter. Declaration public Key CellActivationKey { get; set; } Property Value Type Description Key ColumnOffset Horizontal scroll offset. The index of the first column in Table to display when when rendering the view. Declaration public int ColumnOffset { get; set; } Property Value Type Description System.Int32 Remarks This property allows very wide tables to be rendered with horizontal scrolling FullRowSelect True to select the entire row at once. False to select individual cells. Defaults to false Declaration public bool FullRowSelect { get; set; } Property Value Type Description System.Boolean MaxCellWidth The maximum number of characters to render in any given column. This prevents one long column from pushing out all the others Declaration public int MaxCellWidth { get; set; } Property Value Type Description System.Int32 MultiSelect True to allow regions to be selected Declaration public bool MultiSelect { get; set; } Property Value Type Description System.Boolean MultiSelectedRegions When MultiSelect is enabled this property contain all rectangles of selected cells. Rectangles describe column/rows selected in Table (not screen coordinates) Declaration public Stack MultiSelectedRegions { get; } Property Value Type Description System.Collections.Generic.Stack < TableView.TableSelection > NullSymbol The text representation that should be rendered for cells with the value System.DBNull.Value Declaration public string NullSymbol { get; set; } Property Value Type Description System.String RowOffset Vertical scroll offset. The index of the first row in Table to display in the first non header line of the control when rendering the view. Declaration public int RowOffset { get; set; } Property Value Type Description System.Int32 SelectedColumn The index of System.Data.DataTable.Columns in Table that the user has currently selected Declaration public int SelectedColumn { get; set; } Property Value Type Description System.Int32 SelectedRow The index of System.Data.DataTable.Rows in Table that the user has currently selected Declaration public int SelectedRow { get; set; } Property Value Type Description System.Int32 SeparatorSymbol The symbol to add after each cell value and header value to visually seperate values (if not using vertical gridlines) Declaration public char SeparatorSymbol { get; set; } Property Value Type Description System.Char Style Contains options for changing how the table is rendered Declaration public TableView.TableStyle Style { get; set; } Property Value Type Description TableView.TableStyle Table The data table to render in the view. Setting this property automatically updates and redraws the control. Declaration public DataTable Table { get; set; } Property Value Type Description System.Data.DataTable Methods CellToScreen(Int32, Int32) Returns the screen position (relative to the control client area) that the given cell is rendered or null if it is outside the current scroll area or no table is loaded Declaration public Point? CellToScreen(int tableColumn, int tableRow) Parameters Type Name Description System.Int32 tableColumn The index of the Table column you are looking for, use System.Data.DataColumn.Ordinal System.Int32 tableRow The index of the row in Table that you are looking for Returns Type Description System.Nullable < Point > ChangeSelectionByOffset(Int32, Int32, Boolean) Moves the SelectedRow and SelectedColumn by the provided offsets. Optionally starting a box selection (see MultiSelect ) Declaration public void ChangeSelectionByOffset(int offsetX, int offsetY, bool extendExistingSelection) Parameters Type Name Description System.Int32 offsetX Offset in number of columns System.Int32 offsetY Offset in number of rows System.Boolean extendExistingSelection True to create a multi cell selection or adjust an existing one EnsureSelectedCellIsVisible() Updates scroll offsets to ensure that the selected cell is visible. Has no effect if Table has not been set. Declaration public void EnsureSelectedCellIsVisible() Remarks Changes will not be immediately visible in the display until you call SetNeedsDisplay() EnsureValidScrollOffsets() Updates ColumnOffset and RowOffset where they are outside the bounds of the table (by adjusting them to the nearest existing cell). Has no effect if Table has not been set. Declaration public void EnsureValidScrollOffsets() Remarks Changes will not be immediately visible in the display until you call SetNeedsDisplay() EnsureValidSelection() Updates SelectedColumn , SelectedRow and MultiSelectedRegions where they are outside the bounds of the table (by adjusting them to the nearest existing cell). Has no effect if Table has not been set. Declaration public void EnsureValidSelection() Remarks Changes will not be immediately visible in the display until you call SetNeedsDisplay() GetAllSelectedCells() Returns all cells in any MultiSelectedRegions (if MultiSelect is enabled) and the selected cell Declaration public IEnumerable GetAllSelectedCells() Returns Type Description System.Collections.Generic.IEnumerable < Point > IsSelected(Int32, Int32) Returns true if the given cell is selected either because it is the active cell or part of a multi cell selection (e.g. FullRowSelect ) Declaration public bool IsSelected(int col, int row) Parameters Type Name Description System.Int32 col System.Int32 row Returns Type Description System.Boolean MouseEvent(MouseEvent) Declaration public override bool MouseEvent(MouseEvent me) Parameters Type Name Description MouseEvent me Returns Type Description System.Boolean Overrides Responder.MouseEvent(MouseEvent) OnCellActivated(TableView.CellActivatedEventArgs) Invokes the CellActivated event Declaration protected virtual void OnCellActivated(TableView.CellActivatedEventArgs args) Parameters Type Name Description TableView.CellActivatedEventArgs args OnSelectedCellChanged(TableView.SelectedCellChangedEventArgs) Invokes the SelectedCellChanged event Declaration protected virtual void OnSelectedCellChanged(TableView.SelectedCellChangedEventArgs args) Parameters Type Name Description TableView.SelectedCellChangedEventArgs args PositionCursor() Positions the cursor in the area of the screen in which the start of the active cell is rendered. Calls base implementation if active cell is not visible due to scrolling or table is loaded etc Declaration public override void PositionCursor() Overrides View.PositionCursor() ProcessKey(KeyEvent) Declaration public override bool ProcessKey(KeyEvent keyEvent) Parameters Type Name Description KeyEvent keyEvent Returns Type Description System.Boolean Overrides View.ProcessKey(KeyEvent) Redraw(Rect) Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds Overrides View.Redraw(Rect) RenderCell(Attribute, String, Boolean) Override to provide custom multi colouring to cells. Use Driver to with AddStr(ustring) . The driver will already be in the correct place when rendering and you must render the full render or the view will not look right. For simpler provision of color use ColorGetter For changing the content that is rendered use RepresentationGetter Declaration protected virtual void RenderCell(Attribute cellColor, string render, bool isPrimaryCell) Parameters Type Name Description Attribute cellColor System.String render System.Boolean isPrimaryCell ScreenToCell(Int32, Int32) Returns the column and row of Table that corresponds to a given point on the screen (relative to the control client area). Returns null if the point is in the header, no table is loaded or outside the control bounds Declaration public Point? ScreenToCell(int clientX, int clientY) Parameters Type Name Description System.Int32 clientX X offset from the top left of the control System.Int32 clientY Y offset from the top left of the control Returns Type Description System.Nullable < Point > SelectAll() When MultiSelect is on, creates selection over all cells in the table (replacing any old selection regions) Declaration public void SelectAll() SetSelection(Int32, Int32, Boolean) Moves the SelectedRow and SelectedColumn to the given col/row in Table . Optionally starting a box selection (see MultiSelect ) Declaration public void SetSelection(int col, int row, bool extendExistingSelection) Parameters Type Name Description System.Int32 col System.Int32 row System.Boolean extendExistingSelection True to create a multi cell selection or adjust an existing one Update() Updates the view to reflect changes to Table and to ( ColumnOffset / RowOffset ) etc Declaration public void Update() Remarks This always calls SetNeedsDisplay() Events CellActivated This event is raised when a cell is activated e.g. by double clicking or pressing CellActivationKey Declaration public event Action CellActivated Event Type Type Description System.Action < TableView.CellActivatedEventArgs > SelectedCellChanged This event is raised when the selected cell in the table changes. Declaration public event Action SelectedCellChanged Event Type Type Description System.Action < TableView.SelectedCellChangedEventArgs > Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize"
+ },
+ "api/Terminal.Gui/Terminal.Gui.TableView.RowColorGetterArgs.html": {
+ "href": "api/Terminal.Gui/Terminal.Gui.TableView.RowColorGetterArgs.html",
+ "title": "Class TableView.RowColorGetterArgs",
+ "keywords": "Class TableView.RowColorGetterArgs Arguments for TableView.RowColorGetterDelegate . Describes a row of data in a System.Data.DataTable for which ColorScheme is sought. Inheritance System.Object TableView.RowColorGetterArgs 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 RowColorGetterArgs Properties RowIndex The index of the row in Table for which color is needed Declaration public int RowIndex { get; } Property Value Type Description System.Int32 Table The data table hosted by the TableView control. Declaration public DataTable Table { get; } Property Value Type Description System.Data.DataTable"
+ },
+ "api/Terminal.Gui/Terminal.Gui.TableView.RowColorGetterDelegate.html": {
+ "href": "api/Terminal.Gui/Terminal.Gui.TableView.RowColorGetterDelegate.html",
+ "title": "Delegate TableView.RowColorGetterDelegate",
+ "keywords": "Delegate TableView.RowColorGetterDelegate Delegate for providing color for a whole row of a TableView Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public delegate ColorScheme RowColorGetterDelegate(TableView.RowColorGetterArgs args); Parameters Type Name Description TableView.RowColorGetterArgs args Returns Type Description ColorScheme"
},
"api/Terminal.Gui/Terminal.Gui.TableView.SelectedCellChangedEventArgs.html": {
"href": "api/Terminal.Gui/Terminal.Gui.TableView.SelectedCellChangedEventArgs.html",
@@ -437,12 +517,12 @@
"api/Terminal.Gui/Terminal.Gui.TableView.TableStyle.html": {
"href": "api/Terminal.Gui/Terminal.Gui.TableView.TableStyle.html",
"title": "Class TableView.TableStyle",
- "keywords": "Class TableView.TableStyle Defines rendering options that affect how the table is displayed. See TableView Deep Dive for more information . Inheritance System.Object TableView.TableStyle 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 TableStyle Properties AlwaysShowHeaders When scrolling down always lock the column headers in place as the first row of the table Declaration public bool AlwaysShowHeaders { get; set; } Property Value Type Description System.Boolean ColumnStyles Collection of columns for which you want special rendering (e.g. custom column lengths, text alignment etc) Declaration public Dictionary ColumnStyles { get; set; } Property Value Type Description System.Collections.Generic.Dictionary < System.Data.DataColumn , TableView.ColumnStyle > ShowHorizontalHeaderOverline True to render a solid line above the headers Declaration public bool ShowHorizontalHeaderOverline { get; set; } Property Value Type Description System.Boolean ShowHorizontalHeaderUnderline True to render a solid line under the headers Declaration public bool ShowHorizontalHeaderUnderline { get; set; } Property Value Type Description System.Boolean ShowVerticalCellLines True to render a solid line vertical line between cells Declaration public bool ShowVerticalCellLines { get; set; } Property Value Type Description System.Boolean ShowVerticalHeaderLines True to render a solid line vertical line between headers Declaration public bool ShowVerticalHeaderLines { get; set; } Property Value Type Description System.Boolean Methods GetColumnStyleIfAny(DataColumn) Returns the entry from ColumnStyles for the given col or null if no custom styling is defined for it Declaration public TableView.ColumnStyle GetColumnStyleIfAny(DataColumn col) Parameters Type Name Description System.Data.DataColumn col Returns Type Description TableView.ColumnStyle GetOrCreateColumnStyle(DataColumn) Returns an existing TableView.ColumnStyle for the given col or creates a new one with default options Declaration public TableView.ColumnStyle GetOrCreateColumnStyle(DataColumn col) Parameters Type Name Description System.Data.DataColumn col Returns Type Description TableView.ColumnStyle"
+ "keywords": "Class TableView.TableStyle Defines rendering options that affect how the table is displayed. See TableView Deep Dive for more information . Inheritance System.Object TableView.TableStyle 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 TableStyle Properties AlwaysShowHeaders When scrolling down always lock the column headers in place as the first row of the table Declaration public bool AlwaysShowHeaders { get; set; } Property Value Type Description System.Boolean ColumnStyles Collection of columns for which you want special rendering (e.g. custom column lengths, text alignment etc) Declaration public Dictionary ColumnStyles { get; set; } Property Value Type Description System.Collections.Generic.Dictionary < System.Data.DataColumn , TableView.ColumnStyle > ExpandLastColumn Determines rendering when the last column in the table is visible but it's content or MaxWidth is less than the remaining space in the control. True (the default) will expand the column to fill the remaining bounds of the control. False will draw a column ending line and leave a blank column that cannot be selected in the remaining space. Declaration public bool ExpandLastColumn { get; set; } Property Value Type Description System.Boolean InvertSelectedCellFirstCharacter True to invert the colors of the first symbol of the selected cell in the TableView . This gives the appearance of a cursor for when the ConsoleDriver doesn't otherwise show this Declaration public bool InvertSelectedCellFirstCharacter { get; set; } Property Value Type Description System.Boolean RowColorGetter Delegate for coloring specific rows in a different color. For cell color ColorGetter Declaration public TableView.RowColorGetterDelegate RowColorGetter { get; set; } Property Value Type Description TableView.RowColorGetterDelegate ShowHorizontalHeaderOverline True to render a solid line above the headers Declaration public bool ShowHorizontalHeaderOverline { get; set; } Property Value Type Description System.Boolean ShowHorizontalHeaderUnderline True to render a solid line under the headers Declaration public bool ShowHorizontalHeaderUnderline { get; set; } Property Value Type Description System.Boolean ShowVerticalCellLines True to render a solid line vertical line between cells Declaration public bool ShowVerticalCellLines { get; set; } Property Value Type Description System.Boolean ShowVerticalHeaderLines True to render a solid line vertical line between headers Declaration public bool ShowVerticalHeaderLines { get; set; } Property Value Type Description System.Boolean Methods GetColumnStyleIfAny(DataColumn) Returns the entry from ColumnStyles for the given col or null if no custom styling is defined for it Declaration public TableView.ColumnStyle GetColumnStyleIfAny(DataColumn col) Parameters Type Name Description System.Data.DataColumn col Returns Type Description TableView.ColumnStyle GetOrCreateColumnStyle(DataColumn) Returns an existing TableView.ColumnStyle for the given col or creates a new one with default options Declaration public TableView.ColumnStyle GetOrCreateColumnStyle(DataColumn col) Parameters Type Name Description System.Data.DataColumn col Returns Type Description TableView.ColumnStyle"
},
"api/Terminal.Gui/Terminal.Gui.TabView.html": {
"href": "api/Terminal.Gui/Terminal.Gui.TabView.html",
"title": "Class TabView",
- "keywords": "Class TabView Control that hosts multiple sub views, presenting a single one at once Inheritance System.Object Responder View TabView 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.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() 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.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.VerticalTextAlignment View.TextDirection View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.BeginInit() View.EndInit() View.Visible View.SetWidth(Int32, Int32) View.SetHeight(Int32, Int32) View.GetCurrentWidth(Int32) View.GetCurrentHeight(Int32) 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 TabView : View, IDisposable, ISupportInitializeNotification, ISupportInitialize Constructors TabView() Initialzies a TabView class using Computed layout. Declaration public TabView() Fields DefaultMaxTabTextWidth The default MaxTabTextWidth to set on new TabView controls Declaration public const uint DefaultMaxTabTextWidth = 30U Field Value Type Description System.UInt32 Properties MaxTabTextWidth The maximum number of characters to render in a Tab header. This prevents one long tab from pushing out all the others. Declaration public uint MaxTabTextWidth { get; set; } Property Value Type Description System.UInt32 SelectedTab The currently selected member of Tabs chosen by the user Declaration public TabView.Tab SelectedTab { get; set; } Property Value Type Description TabView.Tab Style Render choices for how to display tabs. After making changes, call ApplyStyleChanges() Declaration public TabView.TabStyle Style { get; set; } Property Value Type Description TabView.TabStyle Tabs All tabs currently hosted by the control Declaration public IReadOnlyCollection Tabs { get; } Property Value Type Description System.Collections.Generic.IReadOnlyCollection < TabView.Tab > TabScrollOffset When there are too many tabs to render, this indicates the first tab to render on the screen. Declaration public int TabScrollOffset { get; set; } Property Value Type Description System.Int32 Methods AddTab(TabView.Tab, Boolean) Adds the given tab to Tabs Declaration public void AddTab(TabView.Tab tab, bool andSelect) Parameters Type Name Description TabView.Tab tab System.Boolean andSelect True to make the newly added Tab the SelectedTab ApplyStyleChanges() Updates the control to use the latest state settings in Style . This can change the size of the client area of the tab (for rendering the selected tab's content). This method includes a call to SetNeedsDisplay() Declaration public void ApplyStyleChanges() Dispose(Boolean) Disposes the control and all Tabs Declaration protected override void Dispose(bool disposing) Parameters Type Name Description System.Boolean disposing Overrides View.Dispose(Boolean) EnsureSelectedTabIsVisible() Updates TabScrollOffset to ensure that SelectedTab is visible Declaration public void EnsureSelectedTabIsVisible() EnsureValidScrollOffsets() Updates TabScrollOffset to be a valid index of Tabs Declaration public void EnsureValidScrollOffsets() Remarks Changes will not be immediately visible in the display until you call SetNeedsDisplay() OnSelectedTabChanged(TabView.Tab, TabView.Tab) Raises the SelectedTabChanged event Declaration protected virtual void OnSelectedTabChanged(TabView.Tab oldTab, TabView.Tab newTab) Parameters Type Name Description TabView.Tab oldTab TabView.Tab newTab ProcessKey(KeyEvent) Declaration public override bool ProcessKey(KeyEvent keyEvent) Parameters Type Name Description KeyEvent keyEvent Returns Type Description System.Boolean Overrides View.ProcessKey(KeyEvent) Redraw(Rect) Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds Overrides View.Redraw(Rect) RemoveTab(TabView.Tab) Removes the given tab from Tabs . Caller is responsible for disposing the tab's hosted View if appropriate. Declaration public void RemoveTab(TabView.Tab tab) Parameters Type Name Description TabView.Tab tab SwitchTabBy(Int32) Changes the SelectedTab by the given amount . Positive for right, negative for left. If no tab is currently selected then the first tab will become selected Declaration public void SwitchTabBy(int amount) Parameters Type Name Description System.Int32 amount Events SelectedTabChanged Event for when SelectedTab changes Declaration public event EventHandler SelectedTabChanged Event Type Type Description System.EventHandler < TabView.TabChangedEventArgs > Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize"
+ "keywords": "Class TabView Control that hosts multiple sub views, presenting a single one at once Inheritance System.Object Responder View TabView 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.CanFocusChanged View.EnabledChanged View.VisibleChanged 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.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() 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.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.VerticalTextAlignment View.TextDirection View.IsInitialized View.Enabled View.Visible View.Border View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.OnCanFocusChanged() View.OnEnabledChanged() View.OnVisibleChanged() View.BeginInit() View.EndInit() View.SetWidth(Int32, Int32) View.SetHeight(Int32, Int32) View.GetCurrentWidth(Int32) View.GetCurrentHeight(Int32) View.GetNormalColor() 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 TabView : View, IDisposable, ISupportInitializeNotification, ISupportInitialize Constructors TabView() Initialzies a TabView class using Computed layout. Declaration public TabView() Fields DefaultMaxTabTextWidth The default MaxTabTextWidth to set on new TabView controls Declaration public const uint DefaultMaxTabTextWidth = 30U Field Value Type Description System.UInt32 Properties MaxTabTextWidth The maximum number of characters to render in a Tab header. This prevents one long tab from pushing out all the others. Declaration public uint MaxTabTextWidth { get; set; } Property Value Type Description System.UInt32 SelectedTab The currently selected member of Tabs chosen by the user Declaration public TabView.Tab SelectedTab { get; set; } Property Value Type Description TabView.Tab Style Render choices for how to display tabs. After making changes, call ApplyStyleChanges() Declaration public TabView.TabStyle Style { get; set; } Property Value Type Description TabView.TabStyle Tabs All tabs currently hosted by the control Declaration public IReadOnlyCollection Tabs { get; } Property Value Type Description System.Collections.Generic.IReadOnlyCollection < TabView.Tab > TabScrollOffset When there are too many tabs to render, this indicates the first tab to render on the screen. Declaration public int TabScrollOffset { get; set; } Property Value Type Description System.Int32 Methods AddTab(TabView.Tab, Boolean) Adds the given tab to Tabs Declaration public void AddTab(TabView.Tab tab, bool andSelect) Parameters Type Name Description TabView.Tab tab System.Boolean andSelect True to make the newly added Tab the SelectedTab ApplyStyleChanges() Updates the control to use the latest state settings in Style . This can change the size of the client area of the tab (for rendering the selected tab's content). This method includes a call to SetNeedsDisplay() Declaration public void ApplyStyleChanges() Dispose(Boolean) Disposes the control and all Tabs Declaration protected override void Dispose(bool disposing) Parameters Type Name Description System.Boolean disposing Overrides View.Dispose(Boolean) EnsureSelectedTabIsVisible() Updates TabScrollOffset to ensure that SelectedTab is visible Declaration public void EnsureSelectedTabIsVisible() EnsureValidScrollOffsets() Updates TabScrollOffset to be a valid index of Tabs Declaration public void EnsureValidScrollOffsets() Remarks Changes will not be immediately visible in the display until you call SetNeedsDisplay() OnSelectedTabChanged(TabView.Tab, TabView.Tab) Raises the SelectedTabChanged event Declaration protected virtual void OnSelectedTabChanged(TabView.Tab oldTab, TabView.Tab newTab) Parameters Type Name Description TabView.Tab oldTab TabView.Tab newTab ProcessKey(KeyEvent) Declaration public override bool ProcessKey(KeyEvent keyEvent) Parameters Type Name Description KeyEvent keyEvent Returns Type Description System.Boolean Overrides View.ProcessKey(KeyEvent) Redraw(Rect) Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds Overrides View.Redraw(Rect) RemoveTab(TabView.Tab) Removes the given tab from Tabs . Caller is responsible for disposing the tab's hosted View if appropriate. Declaration public void RemoveTab(TabView.Tab tab) Parameters Type Name Description TabView.Tab tab SwitchTabBy(Int32) Changes the SelectedTab by the given amount . Positive for right, negative for left. If no tab is currently selected then the first tab will become selected Declaration public void SwitchTabBy(int amount) Parameters Type Name Description System.Int32 amount Events SelectedTabChanged Event for when SelectedTab changes Declaration public event EventHandler SelectedTabChanged Event Type Type Description System.EventHandler < TabView.TabChangedEventArgs > Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize"
},
"api/Terminal.Gui/Terminal.Gui.TabView.Tab.html": {
"href": "api/Terminal.Gui/Terminal.Gui.TabView.Tab.html",
@@ -472,22 +552,22 @@
"api/Terminal.Gui/Terminal.Gui.TextDirection.html": {
"href": "api/Terminal.Gui/Terminal.Gui.TextDirection.html",
"title": "Enum TextDirection",
- "keywords": "Enum TextDirection Text direction enumeration, controls how text is displayed. Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public enum TextDirection Fields Name Description BottomTop_LeftRight BottomTop_RightLeft LeftRight_BottomTop LeftRight_TopBottom Normal Horizontal RightLeft_BottomTop RightLeft_TopBottom TopBottom_LeftRight Normal Vertical TopBottom_RightLeft"
+ "keywords": "Enum TextDirection Text direction enumeration, controls how text is displayed. Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public enum TextDirection Fields Name Description BottomTop_LeftRight This is a vertical direction. O D L L L R E O H W BottomTop_RightLeft This is a vertical direction. D O L L R L O E W H LeftRight_BottomTop This is a horizontal direction. WORLD HELLO LeftRight_TopBottom Normal horizontal direction. HELLO WORLD RightLeft_BottomTop This is a horizontal direction. DLROW OLLEH RightLeft_TopBottom This is a horizontal direction. RTL OLLEH DLROW TopBottom_LeftRight Normal vertical direction. H W E O L R L L O D TopBottom_RightLeft This is a vertical direction. W H O E R L L L D O"
},
"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.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.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() 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.AutoSize View.TextAlignment View.VerticalTextAlignment View.TextDirection 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 View.SetWidth(Int32, Int32) View.SetHeight(Int32, Int32) View.GetCurrentWidth(Int32) View.GetCurrentHeight(Int32) 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 Declaration public override bool CanFocus { get; set; } Property Value Type Description System.Boolean Overrides View.CanFocus CursorPosition Sets or gets the current cursor position. Declaration public int CursorPosition { get; set; } Property Value Type Description System.Int32 DesiredCursorVisibility Get / Set the wished cursor when the field is focused Declaration public CursorVisibility DesiredCursorVisibility { get; set; } Property Value Type Description CursorVisibility Frame Declaration public override Rect Frame { get; set; } Property Value Type Description Rect Overrides View.Frame 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; } 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; } 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) Declaration public override bool MouseEvent(MouseEvent ev) Parameters Type Name Description MouseEvent ev Returns Type Description System.Boolean Overrides Responder.MouseEvent(MouseEvent) OnEnter(View) Declaration public override bool OnEnter(View view) Parameters Type Name Description View view Returns Type Description System.Boolean Overrides View.OnEnter(View) OnLeave(View) Declaration public override bool OnLeave(View view) Parameters Type Name Description View view Returns Type Description System.Boolean 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) Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds Overrides View.Redraw(Rect) 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"
+ "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.CanFocusChanged View.EnabledChanged View.VisibleChanged 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.ClearLayoutNeeded() View.SetNeedsDisplay(Rect) View.SetChildNeedsDisplay() 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.AutoSize View.TextAlignment View.VerticalTextAlignment View.TextDirection View.IsInitialized View.Enabled View.Visible View.Border View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.OnCanFocusChanged() View.OnEnabledChanged() View.OnVisibleChanged() View.Dispose(Boolean) View.BeginInit() View.EndInit() View.SetWidth(Int32, Int32) View.SetHeight(Int32, Int32) View.GetCurrentWidth(Int32) View.GetCurrentHeight(Int32) View.GetNormalColor() 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 Declaration public override bool CanFocus { get; set; } Property Value Type Description System.Boolean Overrides View.CanFocus CursorPosition Sets or gets the current cursor position. Declaration public int CursorPosition { get; set; } Property Value Type Description System.Int32 DesiredCursorVisibility Get / Set the wished cursor when the field is focused Declaration public CursorVisibility DesiredCursorVisibility { get; set; } Property Value Type Description CursorVisibility Frame Declaration public override Rect Frame { get; set; } Property Value Type Description Rect Overrides View.Frame 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; } 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; } 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) Declaration public override bool MouseEvent(MouseEvent ev) Parameters Type Name Description MouseEvent ev Returns Type Description System.Boolean Overrides Responder.MouseEvent(MouseEvent) OnEnter(View) Declaration public override bool OnEnter(View view) Parameters Type Name Description View view Returns Type Description System.Boolean Overrides View.OnEnter(View) OnLeave(View) Declaration public override bool OnLeave(View view) Parameters Type Name Description View view Returns Type Description System.Boolean 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) Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds Overrides View.Redraw(Rect) 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, 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 Direction Controls the text-direction property. Declaration public TextDirection Direction { get; set; } Property Value Type Description TextDirection The text vertical alignment. 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, Boolean, Boolean, Boolean, Int32) 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 VerticalAlignment Controls the vertical text-alignment property. Declaration public VerticalTextAlignment VerticalAlignment { get; set; } Property Value Type Description VerticalTextAlignment The text vertical alignment. 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, Boolean) Justifies text within a specified width. Declaration public static ustring ClipAndJustify(ustring text, int width, bool justify) 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. System.Boolean justify Justify. Returns Type Description NStack.ustring Justified and clipped text. 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, Boolean, Boolean, Boolean, Int32) 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, bool justify, bool wordWrap, bool preserveTrailingSpaces = false, int tabWidth = 0) Parameters Type Name Description NStack.ustring text System.Int32 width The width to bound the text to for word wrapping and clipping. System.Boolean justify Specifies whether the text should be justified. 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 System.Boolean preserveTrailingSpaces If true and 'wordWrap' also true, the wrapped text will keep the trailing spaces. If false , the trailing spaces will be trimmed. System.Int32 tabWidth The tab 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. Format(ustring, Int32, TextAlignment, Boolean, Boolean, Int32) 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, bool preserveTrailingSpaces = false, int tabWidth = 0) 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 System.Boolean preserveTrailingSpaces If true and 'wordWrap' also true, the wrapped text will keep the trailing spaces. If false , the trailing spaces will be trimmed. System.Int32 tabWidth The tab 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. IsHorizontalDirection(TextDirection) Check if it is a horizontal direction Declaration public static bool IsHorizontalDirection(TextDirection textDirection) Parameters Type Name Description TextDirection textDirection Returns Type Description System.Boolean IsLeftToRight(TextDirection) Check if it is Left to Right direction Declaration public static bool IsLeftToRight(TextDirection textDirection) Parameters Type Name Description TextDirection textDirection Returns Type Description System.Boolean IsTopToBottom(TextDirection) Check if it is Top to Bottom direction Declaration public static bool IsTopToBottom(TextDirection textDirection) Parameters Type Name Description TextDirection textDirection Returns Type Description System.Boolean IsVerticalDirection(TextDirection) Check if it is a vertical direction Declaration public static bool IsVerticalDirection(TextDirection textDirection) Parameters Type Name Description TextDirection textDirection Returns Type Description System.Boolean 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, Boolean, Int32) Formats the provided text to fit within the width provided using word wrapping. Declaration public static List WordWrap(ustring text, int width, bool preserveTrailingSpaces = false, int tabWidth = 0) Parameters Type Name Description NStack.ustring text The text to word wrap System.Int32 width The width to contain the text to System.Boolean preserveTrailingSpaces If true , the wrapped text will keep the trailing spaces. If false , the trailing spaces will be trimmed. System.Int32 tabWidth The tab width. 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. 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 bool AutoSize { get; set; } Property Value Type Description System.Boolean 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 Direction Controls the text-direction property. Declaration public TextDirection Direction { get; set; } Property Value Type Description TextDirection The text vertical alignment. 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, Boolean, Boolean, Boolean, Int32) 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 VerticalAlignment Controls the vertical text-alignment property. Declaration public VerticalTextAlignment VerticalAlignment { get; set; } Property Value Type Description VerticalTextAlignment The text vertical alignment. Methods CalcRect(Int32, Int32, ustring, TextDirection) Calculates the rectangle required to hold text, assuming no word wrapping. Declaration public static Rect CalcRect(int x, int y, ustring text, TextDirection direction = TextDirection.LeftRight_TopBottom) 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 TextDirection direction The text direction. Returns Type Description Rect ClipAndJustify(ustring, Int32, Boolean) Justifies text within a specified width. Declaration public static ustring ClipAndJustify(ustring text, int width, bool justify) 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. System.Boolean justify Justify. Returns Type Description NStack.ustring Justified and clipped text. 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. ClipOrPad(String, Int32) Adds trailing whitespace or truncates text so that it fits exactly width console units. Note that some unicode characters take 2+ columns Declaration public static string ClipOrPad(string text, int width) Parameters Type Name Description System.String text System.Int32 width Returns Type Description System.String 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, Boolean, Boolean, Boolean, Int32) Reformats text into lines, applying text alignment and optionally wrapping text to new lines on word boundaries. Declaration public static List