public class LineView : View, IDisposable, ISupportInitializeNotification, ISupportInitialize
Constructors
-
-
LineView()
+
+
LineView()
Creates a horizontal line
@@ -520,8 +523,8 @@ Creates a horizontal line
public LineView()
-
-
LineView(Orientation)
+
+
LineView(Orientation)
Creates a horizontal or vertical line based on orientation
@@ -549,11 +552,11 @@ Creates a horizontal or vertical line based on Properties
-
-
EndingAnchor
+
+
EndingAnchor
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
+If not specified then LineRune is used
Declaration
@@ -575,8 +578,8 @@ If not specified then
-
LineRune
+
+
LineRune
The symbol to use for drawing the line
@@ -600,8 +603,8 @@ The symbol to use for drawing the line
-
-
Orientation
+
+
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.
@@ -626,11 +629,11 @@ of the control to cover a relevant area based on the new direction.
-
-
StartingAnchor
+
+
StartingAnchor
The rune to display at the start of the line (left end of horizontal line or top end of vertical)
-If not specified then LineRune is used
+If not specified then LineRune is used
Declaration
@@ -654,8 +657,8 @@ If not specified then Methods
-
-
Redraw(Rect)
+
+
Redraw(Rect)
Draws the line including any starting/ending anchors
diff --git a/docs/api/Terminal.Gui/Terminal.Gui.PanelView.html b/docs/api/Terminal.Gui/Terminal.Gui.PanelView.html
index 361c42f1d..d11e0a77f 100644
--- a/docs/api/Terminal.Gui/Terminal.Gui.PanelView.html
+++ b/docs/api/Terminal.Gui/Terminal.Gui.PanelView.html
@@ -10,7 +10,7 @@
-
+
@@ -206,6 +206,9 @@ panel size, otherwise the panel will be resized based on the child and borders t
diff --git a/docs/api/Terminal.Gui/Terminal.Gui.ScrollView.html b/docs/api/Terminal.Gui/Terminal.Gui.ScrollView.html
index 1e2bd6a3a..4eb12f55d 100644
--- a/docs/api/Terminal.Gui/Terminal.Gui.ScrollView.html
+++ b/docs/api/Terminal.Gui/Terminal.Gui.ScrollView.html
@@ -10,7 +10,7 @@
-
+
@@ -204,6 +204,9 @@ Scrollviews are views that present a window into a virtual space where subviews
@@ -925,7 +950,7 @@ Reformats text into lines, applying text alignment and optionally wrapping text
-
Remarks
+
Remarks
An empty text string will result in one empty line.
@@ -937,6 +962,248 @@ 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.
+
+
GetMaxLengthForWidth(ustring, Int32)
+
+Gets the index position from the text based on the width.
+
+
+
Declaration
+
+
public static int GetMaxLengthForWidth(ustring text, int width)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
NStack.ustring
+
text
+
The text.
+
+
+
System.Int32
+
width
+
The width.
+
+
+
+
Returns
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Int32
+
The index of the text that fit the width.
+
+
+
+
+
GetMaxLengthForWidth(List<Rune>, Int32)
+
+Gets the index position from the list based on the width.
+
+
+
Declaration
+
+
public static int GetMaxLengthForWidth(List<Rune> runes, int width)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.Collections.Generic.List<System.Rune>
+
runes
+
The runes.
+
+
+
System.Int32
+
width
+
The width.
+
+
+
+
Returns
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Int32
+
The index of the list that fit the width.
+
+
+
+
+
GetSumMaxCharWidth(ustring, Int32, Int32)
+
+Gets the maximum characters width from the text based on the startIndex
+and the length.
+
+
+
Declaration
+
+
public static int GetSumMaxCharWidth(ustring text, int startIndex = -1, int length = -1)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
NStack.ustring
+
text
+
The text.
+
+
+
System.Int32
+
startIndex
+
The start index.
+
+
+
System.Int32
+
length
+
The length.
+
+
+
+
Returns
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Int32
+
The maximum characters width.
+
+
+
+
+
GetSumMaxCharWidth(List<ustring>, Int32, Int32)
+
+Gets the maximum characters width from the list based on the startIndex
+and the length.
+
+
+
Declaration
+
+
public static int GetSumMaxCharWidth(List<ustring> lines, int startIndex = -1, int length = -1)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.Collections.Generic.List<NStack.ustring>
+
lines
+
The lines.
+
+
+
System.Int32
+
startIndex
+
The start index.
+
+
+
System.Int32
+
length
+
The length.
+
+
+
+
Returns
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Int32
+
The maximum characters width.
+
+
+
+
+
GetTextWidth(ustring)
+
+Gets the total width of the passed text.
+
+
+
Declaration
+
+
public static int GetTextWidth(ustring text)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
NStack.ustring
+
text
+
+
+
+
+
Returns
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Int32
+
The text width.
+
+
+
IsHorizontalDirection(TextDirection)
@@ -1106,7 +1373,7 @@ Check if it is a vertical direction
-
Justify(ustring, Int32, Char)
+
Justify(ustring, Int32, Char, TextDirection)
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.
@@ -1114,7 +1381,7 @@ 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 = ' ')
+
public static ustring Justify(ustring text, int width, char spaceChar = ' ', TextDirection textDirection = TextDirection.LeftRight_TopBottom)
Parameters
@@ -1141,6 +1408,11 @@ make the text just fit width. Spaces will not be added to the ends.
spaceChar
Character to replace whitespace and pad with. For debugging purposes.
@@ -1358,14 +1630,14 @@ The returned string will not render correctly without first un-doing the tag. To
Runes with a bitmask of otKeyTagMask and remove that bitmask.
@@ -1415,7 +1692,7 @@ Formats the provided text to fit within the width provided using word wrapping.
-
Remarks
+
Remarks
This method does not do any justification.
diff --git a/docs/api/Terminal.Gui/Terminal.Gui.TextValidateField.html b/docs/api/Terminal.Gui/Terminal.Gui.TextValidateField.html
index 64a350c6e..79c68060d 100644
--- a/docs/api/Terminal.Gui/Terminal.Gui.TextValidateField.html
+++ b/docs/api/Terminal.Gui/Terminal.Gui.TextValidateField.html
@@ -10,7 +10,7 @@
-
+
@@ -204,6 +204,9 @@ Text field that validates input through a View.Height
diff --git a/docs/api/Terminal.Gui/Terminal.Gui.html b/docs/api/Terminal.Gui/Terminal.Gui.html
index 4d90fed1c..0a3c826af 100644
--- a/docs/api/Terminal.Gui/Terminal.Gui.html
+++ b/docs/api/Terminal.Gui/Terminal.Gui.html
@@ -10,7 +10,7 @@
-
+
@@ -130,6 +130,10 @@ Provides cut, copy, and paste support for the clipboard with OS interaction.
@@ -219,6 +223,10 @@ Identifies the state of the "shift"-keys within a event.
The Label View displays a string at a given position and supports multiple lines separated by newline characters.
Multi-line Labels support word wrap.
+
+
diff --git a/docs/articles/index.html b/docs/articles/index.html
index 37aad5d7d..d3b0869de 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 83020e430..e4b5291c4 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 478caece3..6ee2787e9 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 6991c9d6d..f6f2cd381 100644
--- a/docs/articles/overview.html
+++ b/docs/articles/overview.html
@@ -8,7 +8,7 @@
Terminal.Gui API Overview
-
+
@@ -94,6 +94,7 @@ class Demo {
var n = MessageBox.Query (50, 7,
"Question", "Do you like console apps?", "Yes", "No");
+ Application.Shutdown ();
return n;
}
}
@@ -122,6 +123,7 @@ class Demo {
};
Application.Top.Add (label);
Application.Run ();
+ Application.Shutdown ();
}
}
Typically, you will want your application to have more than a label, you might
@@ -151,6 +153,7 @@ class Demo {
// Add both menu and win in a single call
Application.Top.Add (menu, win);
Application.Run ();
+ Application.Shutdown ();
}
}
Views
@@ -294,6 +297,7 @@ class Demo {
// Add both menu and win in a single call
top.Add (win, menu);
Application.Run (top);
+ Application.Shutdown ();
}
}
Window Views
diff --git a/docs/articles/tableview.html b/docs/articles/tableview.html
index 2e0bdc40a..82b4dbed0 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 6b09df9a2..deed2311c 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 3cdc91b70..6b27a2ff5 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 68efafe07..ec513810f 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 a3143cf77..186efee4c 100644
--- a/docs/index.json
+++ b/docs/index.json
@@ -27,12 +27,12 @@
"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(View) Drawn the BorderThickness more the Padding more the BorderStyle and the Effect3D . Declaration public void DrawContent(View view = null) Parameters Type Name Description View view DrawFullContent() Same as DrawContent(View) 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 >"
+ "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(View, Boolean) Drawn the BorderThickness more the Padding more the BorderStyle and the Effect3D . Declaration public void DrawContent(View view = null, bool fill = true) Parameters Type Name Description View view The view to draw. System.Boolean fill If it will clear or not the content area. DrawFullContent() Same as DrawContent(View, Boolean) 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.Resized Toplevel.AlternateForwardKeyChanged Toplevel.OnAlternateForwardKeyChanged(Key) Toplevel.AlternateBackwardKeyChanged Toplevel.OnAlternateBackwardKeyChanged(Key) Toplevel.QuitKeyChanged Toplevel.OnQuitKeyChanged(Key) 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.HotKeyChanged 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, Boolean) 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.DrawContentComplete View.OnDrawContentComplete(Rect) View.SetFocus() View.KeyPress View.InvokeKeybindings(KeyEvent) View.AddKeyBinding(Key, Command) View.ReplaceKeyBinding(Key, Key) View.ContainsKeyBinding(Key) View.ClearKeybindings() View.ClearKeybinding(Key) View.ClearKeybinding(Command) View.AddCommand(Command, Func>) View.GetSupportedCommands() View.GetKeyFromCommand(Command) 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() View.GetTopSuperView() 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"
+ "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.Resized Toplevel.AlternateForwardKeyChanged Toplevel.OnAlternateForwardKeyChanged(Key) Toplevel.AlternateBackwardKeyChanged Toplevel.OnAlternateBackwardKeyChanged(Key) Toplevel.QuitKeyChanged Toplevel.OnQuitKeyChanged(Key) 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.HotKeyChanged 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.TextFormatter 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, Boolean) 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.DrawContentComplete View.OnDrawContentComplete(Rect) View.SetFocus() View.KeyPress View.InvokeKeybindings(KeyEvent) View.AddKeyBinding(Key, Command) View.ReplaceKeyBinding(Key, Key) View.ContainsKeyBinding(Key) View.ClearKeybindings() View.ClearKeybinding(Key) View.ClearKeybinding(Command) View.AddCommand(Command, Func>) View.GetSupportedCommands() View.GetKeyFromCommand(Command) 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() View.GetTopSuperView() 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",
@@ -42,12 +42,12 @@
"api/Terminal.Gui/Terminal.Gui.Button.html": {
"href": "api/Terminal.Gui/Terminal.Gui.Button.html",
"title": "Class Button",
- "keywords": "Class Button Button is a View that provides an item that invokes an System.Action when activated by the user. Inheritance System.Object Responder View Button Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.CanFocusChanged View.EnabledChanged View.VisibleChanged View.HotKeyChanged 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, Boolean) 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.DrawContentComplete View.OnDrawContentComplete(Rect) View.SetFocus() View.KeyPress View.InvokeKeybindings(KeyEvent) View.AddKeyBinding(Key, Command) View.ReplaceKeyBinding(Key, Key) View.ContainsKeyBinding(Key) View.ClearKeybindings() View.ClearKeybinding(Key) View.ClearKeybinding(Command) View.AddCommand(Command, Func>) View.GetSupportedCommands() View.GetKeyFromCommand(Command) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.TextAlignment View.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() View.GetTopSuperView() 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 AutoSize Declaration public override bool AutoSize { get; set; } Property Value Type Description System.Boolean Overrides View.AutoSize HotKey Declaration public override Key HotKey { get; set; } Property Value Type Description Key Overrides View.HotKey HotKeySpecifier Declaration public override Rune HotKeySpecifier { get; set; } Property Value Type Description System.Rune Overrides View.HotKeySpecifier 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 Declaration public override ustring Text { get; set; } Property Value Type Description NStack.ustring Overrides View.Text 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) OnClicked() Virtual method to invoke the Clicked event. Declaration public virtual void OnClicked() 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) Redraw(Rect) Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds Overrides View.Redraw(Rect) 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.HotKeyChanged 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.TextFormatter 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, Boolean) 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.DrawContentComplete View.OnDrawContentComplete(Rect) View.SetFocus() View.KeyPress View.InvokeKeybindings(KeyEvent) View.AddKeyBinding(Key, Command) View.ReplaceKeyBinding(Key, Key) View.ContainsKeyBinding(Key) View.ClearKeybindings() View.ClearKeybinding(Key) View.ClearKeybinding(Command) View.AddCommand(Command, Func>) View.GetSupportedCommands() View.GetKeyFromCommand(Command) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.TextAlignment View.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() View.GetTopSuperView() 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 AutoSize Declaration public override bool AutoSize { get; set; } Property Value Type Description System.Boolean Overrides View.AutoSize HotKey Declaration public override Key HotKey { get; set; } Property Value Type Description Key Overrides View.HotKey HotKeySpecifier Declaration public override Rune HotKeySpecifier { get; set; } Property Value Type Description System.Rune Overrides View.HotKeySpecifier 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 Declaration public override ustring Text { get; set; } Property Value Type Description NStack.ustring Overrides View.Text 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) OnClicked() Virtual method to invoke the Clicked event. Declaration public virtual void OnClicked() 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) Redraw(Rect) Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds Overrides View.Redraw(Rect) 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.CanFocusChanged View.EnabledChanged View.VisibleChanged View.HotKeyChanged 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, Boolean) 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.DrawContentComplete View.OnDrawContentComplete(Rect) View.SetFocus() View.KeyPress View.InvokeKeybindings(KeyEvent) View.AddKeyBinding(Key, Command) View.ReplaceKeyBinding(Key, Key) View.ContainsKeyBinding(Key) View.ClearKeybindings() View.ClearKeybinding(Key) View.ClearKeybinding(Command) View.AddCommand(Command, Func>) View.GetSupportedCommands() View.GetKeyFromCommand(Command) 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() View.GetTopSuperView() 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 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 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.HotKeyChanged 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.TextFormatter 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, Boolean) 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.DrawContentComplete View.OnDrawContentComplete(Rect) View.SetFocus() View.KeyPress View.InvokeKeybindings(KeyEvent) View.AddKeyBinding(Key, Command) View.ReplaceKeyBinding(Key, Key) View.ContainsKeyBinding(Key) View.ClearKeybindings() View.ClearKeybinding(Key) View.ClearKeybinding(Command) View.AddCommand(Command, Func>) View.GetSupportedCommands() View.GetKeyFromCommand(Command) 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() View.GetTopSuperView() 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 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 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",
@@ -64,6 +64,11 @@
"title": "Enum Color",
"keywords": "Enum Color Basic colors that can be used to set the foreground and background colors in console applications. Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public enum Color Fields Name Description Black The black color. Blue The blue color. BrightBlue The bright bBlue color. BrightCyan The bright cyan color. BrightGreen The bright green color. BrightMagenta The bright magenta color. BrightRed The bright red color. BrightYellow The bright yellow color. Brown The brown color. Cyan The cyan color. DarkGray The dark gray color. Gray The gray color. Green The green color. Magenta The magenta color. Red The red color. White The White color."
},
+ "api/Terminal.Gui/Terminal.Gui.ColorPicker.html": {
+ "href": "api/Terminal.Gui/Terminal.Gui.ColorPicker.html",
+ "title": "Class ColorPicker",
+ "keywords": "Class ColorPicker The ColorPicker View Color picker. Inheritance System.Object Responder View ColorPicker 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.HotKeyChanged 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.TextFormatter 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, Boolean) 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.DrawContentComplete View.OnDrawContentComplete(Rect) View.SetFocus() View.KeyPress View.InvokeKeybindings(KeyEvent) View.AddKeyBinding(Key, Command) View.ReplaceKeyBinding(Key, Key) View.ContainsKeyBinding(Key) View.ClearKeybindings() View.ClearKeybinding(Key) View.ClearKeybinding(Command) View.AddCommand(Command, Func>) View.GetSupportedCommands() View.GetKeyFromCommand(Command) 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() View.GetTopSuperView() 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 ColorPicker : View, IDisposable, ISupportInitializeNotification, ISupportInitialize Constructors ColorPicker() Initializes a new instance of ColorPicker . Declaration public ColorPicker() ColorPicker(ustring) Initializes a new instance of ColorPicker . Declaration public ColorPicker(ustring title) Parameters Type Name Description NStack.ustring title Title. ColorPicker(Int32, Int32, ustring) Initializes a new instance of ColorPicker . Declaration public ColorPicker(int x, int y, ustring title) Parameters Type Name Description System.Int32 x X location. System.Int32 y Y location. NStack.ustring title Title ColorPicker(Point, ustring) Initializes a new instance of ColorPicker . Declaration public ColorPicker(Point point, ustring title) Parameters Type Name Description Point point Location point. NStack.ustring title Title. Properties Cursor Cursor for the selected color. Declaration public Point Cursor { get; set; } Property Value Type Description Point SelectedColor Selected color. Declaration public Color SelectedColor { get; set; } Property Value Type Description Color 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) MoveDown() Moves the selected item index to the next row. Declaration public virtual bool MoveDown() Returns Type Description System.Boolean MoveLeft() Moves the selected item index to the previous column. Declaration public virtual bool MoveLeft() Returns Type Description System.Boolean MoveRight() Moves the selected item index to the next column. Declaration public virtual bool MoveRight() 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 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 ColorChanged Fired when a color is picked. Declaration public event Action ColorChanged Event Type Type Description System.Action Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize"
+ },
"api/Terminal.Gui/Terminal.Gui.Colors.html": {
"href": "api/Terminal.Gui/Terminal.Gui.Colors.html",
"title": "Class Colors",
@@ -77,7 +82,7 @@
"api/Terminal.Gui/Terminal.Gui.ComboBox.html": {
"href": "api/Terminal.Gui/Terminal.Gui.ComboBox.html",
"title": "Class ComboBox",
- "keywords": "Class ComboBox ComboBox control Inheritance System.Object Responder View ComboBox Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.CanFocusChanged View.EnabledChanged View.VisibleChanged View.HotKeyChanged 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, Boolean) 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.DrawContentComplete View.OnDrawContentComplete(Rect) View.SetFocus() View.KeyPress View.InvokeKeybindings(KeyEvent) View.AddKeyBinding(Key, Command) View.ReplaceKeyBinding(Key, Key) View.ContainsKeyBinding(Key) View.ClearKeybindings() View.ClearKeybinding(Key) View.ClearKeybinding(Command) View.AddCommand(Command, Func>) View.GetSupportedCommands() View.GetKeyFromCommand(Command) 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() View.GetTopSuperView() 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 IsShow Gets the drop down list state, expanded or collapsed. Declaration public bool IsShow { get; } Property Value Type Description System.Boolean 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; set; } 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 Collapse() Collapses the drop down list. Returns true if the state chagned or false if it was already collapsed and no action was taken Declaration public virtual bool Collapse() Returns Type Description System.Boolean Expand() Expands the drop down list. Returns true if the state chagned or false if it was already expanded and no action was taken Declaration public virtual bool Expand() 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) 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.HotKeyChanged 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.TextFormatter 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, Boolean) 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.DrawContentComplete View.OnDrawContentComplete(Rect) View.SetFocus() View.KeyPress View.InvokeKeybindings(KeyEvent) View.AddKeyBinding(Key, Command) View.ReplaceKeyBinding(Key, Key) View.ContainsKeyBinding(Key) View.ClearKeybindings() View.ClearKeybinding(Key) View.ClearKeybinding(Command) View.AddCommand(Command, Func>) View.GetSupportedCommands() View.GetKeyFromCommand(Command) 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() View.GetTopSuperView() 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 IsShow Gets the drop down list state, expanded or collapsed. Declaration public bool IsShow { get; } Property Value Type Description System.Boolean 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; set; } 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 Collapse() Collapses the drop down list. Returns true if the state chagned or false if it was already collapsed and no action was taken Declaration public virtual bool Collapse() Returns Type Description System.Boolean Expand() Expands the drop down list. Returns true if the state chagned or false if it was already expanded and no action was taken Declaration public virtual bool Expand() 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) 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.Command.html": {
"href": "api/Terminal.Gui/Terminal.Gui.Command.html",
@@ -92,12 +97,12 @@
"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 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 HRLine Horizontal line character for rounded corners. Declaration public Rune HRLine 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 LLRCorner Lower left rounded corner Declaration public Rune LLRCorner 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 LRRCorner Lower right rounded corner Declaration public Rune LRRCorner 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 ULRCorner Upper left rounded corner Declaration public Rune ULRCorner 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 URRCorner Upper right rounded corner Declaration public Rune URRCorner 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 VRLine Vertical line character for rounded corners. Declaration public Rune VRLine 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()"
+ "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 HRLine Horizontal line character for rounded corners. Declaration public Rune HRLine 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 LLRCorner Lower left rounded corner Declaration public Rune LLRCorner 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 LRRCorner Lower right rounded corner Declaration public Rune LRRCorner 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 ULRCorner Upper left rounded corner Declaration public Rune ULRCorner 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 URRCorner Upper right rounded corner Declaration public Rune URRCorner 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 VRLine Vertical line character for rounded corners. Declaration public Rune VRLine 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. IsValidContent(Int32, Int32, Rect) Ensures that the column and line are in a valid range from the size of the driver. Declaration public bool IsValidContent(int col, int row, Rect clip) Parameters Type Name Description System.Int32 col The column. System.Int32 row The row. Rect clip The clip. Returns Type Description System.Boolean true if it's a valid range, false otherwise. 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() UpdateOffScreen() Reset and recreate the contents and the driver buffer. Declaration public abstract void UpdateOffScreen() 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.ContextMenu.html": {
"href": "api/Terminal.Gui/Terminal.Gui.ContextMenu.html",
"title": "Class ContextMenu",
- "keywords": "Class ContextMenu A context menu window derived from MenuBar containing menu items which can be opened in any position. Inheritance System.Object ContextMenu 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 sealed class ContextMenu : IDisposable Constructors ContextMenu() Initialize a context menu with empty menu items. Declaration public ContextMenu() ContextMenu(Int32, Int32, MenuBarItem) Initialize a context menu with menu items. Declaration public ContextMenu(int x, int y, MenuBarItem menuItems) Parameters Type Name Description System.Int32 x The left position. System.Int32 y The top position. MenuBarItem menuItems The menu items. ContextMenu(View, MenuBarItem) Initialize a context menu with menu items from a host View . Declaration public ContextMenu(View host, MenuBarItem menuItems) Parameters Type Name Description View host The host view. MenuBarItem menuItems The menu items. Properties ForceMinimumPosToZero Gets or sets whether forces the minimum position to zero if the left or right position are negative. Declaration public bool ForceMinimumPosToZero { get; set; } Property Value Type Description System.Boolean Host The host View which position will be used, otherwise if it's null the container will be used. Declaration public View Host { get; set; } Property Value Type Description View IsShow Gets information whether menu is showing or not. Declaration public static bool IsShow { get; } Property Value Type Description System.Boolean Key The Key used to activate the context menu by keyboard. Declaration public Key Key { get; set; } Property Value Type Description Key MenuBar Gets the MenuBar that is hosting this context menu. Declaration public MenuBar MenuBar { get; } Property Value Type Description MenuBar MenuItens Gets or sets the menu items for this context menu. Declaration public MenuBarItem MenuItens { get; set; } Property Value Type Description MenuBarItem MouseFlags The MouseFlags used to activate the context menu by mouse. Declaration public MouseFlags MouseFlags { get; set; } Property Value Type Description MouseFlags Position Gets or set the menu position. Declaration public Point Position { get; set; } Property Value Type Description Point UseSubMenusSingleFrame Gets or sets if the sub-menus must be displayed in a single or multiple frames. Declaration public bool UseSubMenusSingleFrame { get; set; } Property Value Type Description System.Boolean Methods Dispose() Declaration public void Dispose() Hide() Close the MenuItens menu items. Declaration public void Hide() Show() Open the MenuItens menu items. Declaration public void Show() Events KeyChanged Event invoked when the Key is changed. Declaration public event Action KeyChanged Event Type Type Description System.Action < Key > MouseFlagsChanged Event invoked when the MouseFlags is changed. Declaration public event Action MouseFlagsChanged Event Type Type Description System.Action < MouseFlags > Implements System.IDisposable"
+ "keywords": "Class ContextMenu A context menu window derived from MenuBar containing menu items which can be opened in any position. Inheritance System.Object ContextMenu 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 sealed class ContextMenu : IDisposable Constructors ContextMenu() Initialize a context menu with empty menu items. Declaration public ContextMenu() ContextMenu(Int32, Int32, MenuBarItem) Initialize a context menu with menu items. Declaration public ContextMenu(int x, int y, MenuBarItem menuItems) Parameters Type Name Description System.Int32 x The left position. System.Int32 y The top position. MenuBarItem menuItems The menu items. ContextMenu(View, MenuBarItem) Initialize a context menu with menu items from a host View . Declaration public ContextMenu(View host, MenuBarItem menuItems) Parameters Type Name Description View host The host view. MenuBarItem menuItems The menu items. Properties ForceMinimumPosToZero Gets or sets whether forces the minimum position to zero if the left or right position are negative. Declaration public bool ForceMinimumPosToZero { get; set; } Property Value Type Description System.Boolean Host The host View which position will be used, otherwise if it's null the container will be used. Declaration public View Host { get; set; } Property Value Type Description View IsShow Gets information whether menu is showing or not. Declaration public static bool IsShow { get; } Property Value Type Description System.Boolean Key The Key used to activate the context menu by keyboard. Declaration public Key Key { get; set; } Property Value Type Description Key MenuBar Gets the MenuBar that is hosting this context menu. Declaration public MenuBar MenuBar { get; } Property Value Type Description MenuBar MenuItems Gets or sets the menu items for this context menu. Declaration public MenuBarItem MenuItems { get; set; } Property Value Type Description MenuBarItem MouseFlags The MouseFlags used to activate the context menu by mouse. Declaration public MouseFlags MouseFlags { get; set; } Property Value Type Description MouseFlags Position Gets or set the menu position. Declaration public Point Position { get; set; } Property Value Type Description Point UseSubMenusSingleFrame Gets or sets if the sub-menus must be displayed in a single or multiple frames. Declaration public bool UseSubMenusSingleFrame { get; set; } Property Value Type Description System.Boolean Methods Dispose() Declaration public void Dispose() Hide() Close the MenuItems menu items. Declaration public void Hide() Show() Open the MenuItems menu items. Declaration public void Show() Events KeyChanged Event invoked when the Key is changed. Declaration public event Action KeyChanged Event Type Type Description System.Action < Key > MouseFlagsChanged Event invoked when the MouseFlags is changed. Declaration public event Action MouseFlagsChanged Event Type Type Description System.Action < MouseFlags > Implements System.IDisposable"
},
"api/Terminal.Gui/Terminal.Gui.CursorVisibility.html": {
"href": "api/Terminal.Gui/Terminal.Gui.CursorVisibility.html",
@@ -107,7 +112,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.Autocomplete TextField.Frame TextField.Text TextField.Secret TextField.ScrollOffset TextField.IsDirty TextField.HasHistoryChanges TextField.ContextMenu TextField.PositionCursor() TextField.Redraw(Rect) TextField.CanFocus TextField.KillWordBackwards() TextField.KillWordForwards() TextField.SelectAll() TextField.DeleteAll() TextField.SelectedStart TextField.SelectedLength TextField.SelectedText TextField.ClearAllSelection() TextField.Copy() TextField.Cut() TextField.Paste() TextField.OnTextChanging(ustring) TextField.DesiredCursorVisibility TextField.OnEnter(View) TextField.InsertText(String, Boolean) TextField.ClearHistoryChanges() View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.CanFocusChanged View.EnabledChanged View.VisibleChanged View.HotKeyChanged 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, Boolean) 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.DrawContentComplete View.OnDrawContentComplete(Rect) View.SetFocus() View.KeyPress View.InvokeKeybindings(KeyEvent) View.AddKeyBinding(Key, Command) View.ReplaceKeyBinding(Key, Key) View.ContainsKeyBinding(Key) View.ClearKeybindings() View.ClearKeybinding(Key) View.ClearKeybinding(Command) View.AddCommand(Command, Func>) View.GetSupportedCommands() View.GetKeyFromCommand(Command) 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() View.GetTopSuperView() 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 CursorPosition Declaration public override int CursorPosition { get; set; } Property Value Type Description System.Int32 Overrides TextField.CursorPosition 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 DeleteCharLeft(Boolean) Declaration public override void DeleteCharLeft(bool useOldCursorPos = true) Parameters Type Name Description System.Boolean useOldCursorPos Overrides TextField.DeleteCharLeft(Boolean) DeleteCharRight() Declaration public override void DeleteCharRight() Overrides TextField.DeleteCharRight() 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.Autocomplete TextField.Frame TextField.Text TextField.Secret TextField.ScrollOffset TextField.IsDirty TextField.HasHistoryChanges TextField.ContextMenu TextField.PositionCursor() TextField.Redraw(Rect) TextField.CanFocus TextField.KillWordBackwards() TextField.KillWordForwards() TextField.SelectAll() TextField.DeleteAll() TextField.SelectedStart TextField.SelectedLength TextField.SelectedText TextField.ClearAllSelection() TextField.Copy() TextField.Cut() TextField.Paste() TextField.OnTextChanging(ustring) TextField.DesiredCursorVisibility TextField.OnEnter(View) TextField.InsertText(String, Boolean) TextField.ClearHistoryChanges() View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.CanFocusChanged View.EnabledChanged View.VisibleChanged View.HotKeyChanged 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.TextFormatter 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, Boolean) 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.DrawContentComplete View.OnDrawContentComplete(Rect) View.SetFocus() View.KeyPress View.InvokeKeybindings(KeyEvent) View.AddKeyBinding(Key, Command) View.ReplaceKeyBinding(Key, Key) View.ContainsKeyBinding(Key) View.ClearKeybindings() View.ClearKeybinding(Key) View.ClearKeybinding(Command) View.AddCommand(Command, Func>) View.GetSupportedCommands() View.GetKeyFromCommand(Command) 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() View.GetTopSuperView() 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 CursorPosition Declaration public override int CursorPosition { get; set; } Property Value Type Description System.Int32 Overrides TextField.CursorPosition 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 DeleteCharLeft(Boolean) Declaration public override void DeleteCharLeft(bool useOldCursorPos = true) Parameters Type Name Description System.Boolean useOldCursorPos Overrides TextField.DeleteCharLeft(Boolean) DeleteCharRight() Declaration public override void DeleteCharRight() Overrides TextField.DeleteCharRight() 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",
@@ -117,7 +122,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.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.Resized Toplevel.AlternateForwardKeyChanged Toplevel.OnAlternateForwardKeyChanged(Key) Toplevel.AlternateBackwardKeyChanged Toplevel.OnAlternateBackwardKeyChanged(Key) Toplevel.QuitKeyChanged Toplevel.OnQuitKeyChanged(Key) 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.HotKeyChanged 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, Boolean) 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.DrawContentComplete View.OnDrawContentComplete(Rect) View.SetFocus() View.KeyPress View.InvokeKeybindings(KeyEvent) View.AddKeyBinding(Key, Command) View.ReplaceKeyBinding(Key, Key) View.ContainsKeyBinding(Key) View.ClearKeybindings() View.ClearKeybinding(Key) View.ClearKeybinding(Command) View.AddCommand(Command, Func>) View.GetSupportedCommands() View.GetKeyFromCommand(Command) 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() View.GetTopSuperView() 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"
+ "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.Resized Toplevel.AlternateForwardKeyChanged Toplevel.OnAlternateForwardKeyChanged(Key) Toplevel.AlternateBackwardKeyChanged Toplevel.OnAlternateBackwardKeyChanged(Key) Toplevel.QuitKeyChanged Toplevel.OnQuitKeyChanged(Key) 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.HotKeyChanged 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.TextFormatter 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, Boolean) 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.DrawContentComplete View.OnDrawContentComplete(Rect) View.SetFocus() View.KeyPress View.InvokeKeybindings(KeyEvent) View.AddKeyBinding(Key, Command) View.ReplaceKeyBinding(Key, Key) View.ContainsKeyBinding(Key) View.ClearKeybindings() View.ClearKeybinding(Key) View.ClearKeybinding(Command) View.AddCommand(Command, Func>) View.GetSupportedCommands() View.GetKeyFromCommand(Command) 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() View.GetTopSuperView() 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",
@@ -137,7 +142,7 @@
"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, 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 ConsoleDriver.HRLine ConsoleDriver.VRLine ConsoleDriver.ULRCorner ConsoleDriver.LLRCorner ConsoleDriver.URRCorner ConsoleDriver.LRRCorner 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()"
+ "keywords": "Class FakeDriver Implements a mock ConsoleDriver for unit testing Inheritance System.Object ConsoleDriver FakeDriver Inherited Members ConsoleDriver.TerminalResized ConsoleDriver.MakePrintable(Rune) ConsoleDriver.IsValidContent(Int32, Int32, Rect) 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 ConsoleDriver.HRLine ConsoleDriver.VRLine ConsoleDriver.ULRCorner ConsoleDriver.LLRCorner ConsoleDriver.URRCorner ConsoleDriver.LRRCorner 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() UpdateOffScreen() Declaration public override void UpdateOffScreen() Overrides ConsoleDriver.UpdateOffScreen() UpdateScreen() Declaration public override void UpdateScreen() Overrides ConsoleDriver.UpdateScreen()"
},
"api/Terminal.Gui/Terminal.Gui.FakeMainLoop.html": {
"href": "api/Terminal.Gui/Terminal.Gui.FakeMainLoop.html",
@@ -147,12 +152,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.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.Resized Toplevel.AlternateForwardKeyChanged Toplevel.OnAlternateForwardKeyChanged(Key) Toplevel.AlternateBackwardKeyChanged Toplevel.OnAlternateBackwardKeyChanged(Key) Toplevel.QuitKeyChanged Toplevel.OnQuitKeyChanged(Key) 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.HotKeyChanged 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, Boolean) 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.DrawContentComplete View.OnDrawContentComplete(Rect) View.SetFocus() View.KeyPress View.InvokeKeybindings(KeyEvent) View.AddKeyBinding(Key, Command) View.ReplaceKeyBinding(Key, Key) View.ContainsKeyBinding(Key) View.ClearKeybindings() View.ClearKeybinding(Key) View.ClearKeybinding(Command) View.AddCommand(Command, Func>) View.GetSupportedCommands() View.GetKeyFromCommand(Command) 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() View.GetTopSuperView() 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"
+ "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.Resized Toplevel.AlternateForwardKeyChanged Toplevel.OnAlternateForwardKeyChanged(Key) Toplevel.AlternateBackwardKeyChanged Toplevel.OnAlternateBackwardKeyChanged(Key) Toplevel.QuitKeyChanged Toplevel.OnQuitKeyChanged(Key) 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.HotKeyChanged 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.TextFormatter 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, Boolean) 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.DrawContentComplete View.OnDrawContentComplete(Rect) View.SetFocus() View.KeyPress View.InvokeKeybindings(KeyEvent) View.AddKeyBinding(Key, Command) View.ReplaceKeyBinding(Key, Key) View.ContainsKeyBinding(Key) View.ClearKeybindings() View.ClearKeybinding(Key) View.ClearKeybinding(Command) View.AddCommand(Command, Func>) View.GetSupportedCommands() View.GetKeyFromCommand(Command) 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() View.GetTopSuperView() 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.CanFocusChanged View.EnabledChanged View.VisibleChanged View.HotKeyChanged 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, Boolean) 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.DrawContentComplete View.OnDrawContentComplete(Rect) View.SetFocus() View.KeyPress View.ProcessKey(KeyEvent) View.InvokeKeybindings(KeyEvent) View.AddKeyBinding(Key, Command) View.ReplaceKeyBinding(Key, Key) View.ContainsKeyBinding(Key) View.ClearKeybindings() View.ClearKeybinding(Key) View.ClearKeybinding(Command) View.AddCommand(Command, Func>) View.GetSupportedCommands() View.GetKeyFromCommand(Command) 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() View.GetTopSuperView() 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"
+ "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.HotKeyChanged 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.TextFormatter 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, Boolean) 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.DrawContentComplete View.OnDrawContentComplete(Rect) View.SetFocus() View.KeyPress View.ProcessKey(KeyEvent) View.InvokeKeybindings(KeyEvent) View.AddKeyBinding(Key, Command) View.ReplaceKeyBinding(Key, Key) View.ContainsKeyBinding(Key) View.ClearKeybindings() View.ClearKeybinding(Key) View.ClearKeybinding(Command) View.AddCommand(Command, Func>) View.GetSupportedCommands() View.GetKeyFromCommand(Command) 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() View.GetTopSuperView() 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",
@@ -247,7 +252,7 @@
"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.CanFocusChanged View.EnabledChanged View.VisibleChanged View.HotKeyChanged 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, Boolean) 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.DrawContentComplete View.OnDrawContentComplete(Rect) View.SetFocus() View.KeyPress View.InvokeKeybindings(KeyEvent) View.AddKeyBinding(Key, Command) View.ReplaceKeyBinding(Key, Key) View.ContainsKeyBinding(Key) View.ClearKeybindings() View.ClearKeybinding(Key) View.ClearKeybinding(Command) View.AddCommand(Command, Func>) View.GetSupportedCommands() View.GetKeyFromCommand(Command) 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() View.GetTopSuperView() 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 PageDown() Scrolls the graph down 1 page Declaration public void PageDown() PageUp() Scrolls the graph up 1 page Declaration public void PageUp() 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 Scroll(Single, Single) Scrolls the view by a given number of units in graph space. See CellSize to translate this into rows/cols Declaration public void Scroll(float offsetX, float offsetY) Parameters Type Name Description System.Single offsetX System.Single offsetY 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.HotKeyChanged 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.TextFormatter 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, Boolean) 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.DrawContentComplete View.OnDrawContentComplete(Rect) View.SetFocus() View.KeyPress View.InvokeKeybindings(KeyEvent) View.AddKeyBinding(Key, Command) View.ReplaceKeyBinding(Key, Key) View.ContainsKeyBinding(Key) View.ClearKeybindings() View.ClearKeybinding(Key) View.ClearKeybinding(Command) View.AddCommand(Command, Func>) View.GetSupportedCommands() View.GetKeyFromCommand(Command) 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() View.GetTopSuperView() 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 PageDown() Scrolls the graph down 1 page Declaration public void PageDown() PageUp() Scrolls the graph up 1 page Declaration public void PageUp() 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 Scroll(Single, Single) Scrolls the view by a given number of units in graph space. See CellSize to translate this into rows/cols Declaration public void Scroll(float offsetX, float offsetY) Parameters Type Name Description System.Single offsetX System.Single offsetY 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.HexViewEventArgs.html": {
"href": "api/Terminal.Gui/Terminal.Gui.HexView.HexViewEventArgs.html",
@@ -257,12 +262,12 @@
"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.CanFocusChanged View.EnabledChanged View.VisibleChanged View.HotKeyChanged 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, Boolean) 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.DrawContentComplete View.OnDrawContentComplete(Rect) View.SetFocus() View.KeyPress View.InvokeKeybindings(KeyEvent) View.AddKeyBinding(Key, Command) View.ReplaceKeyBinding(Key, Key) View.ContainsKeyBinding(Key) View.ClearKeybindings() View.ClearKeybinding(Key) View.ClearKeybinding(Command) View.AddCommand(Command, Func>) View.GetSupportedCommands() View.GetKeyFromCommand(Command) 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() View.GetTopSuperView() 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(Stream) 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() Initializes a HexView class using Computed layout. Declaration public HexView() HexView(Stream) Initializes 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 . BytesPerLine The bytes length per line. Declaration public int BytesPerLine { get; } Property Value Type Description System.Int32 CursorPosition Gets the current cursor position starting at one for both, line and column. Declaration public Point CursorPosition { get; } Property Value Type Description Point 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 Position Gets the current character position starting at one, related to the System.IO.Stream . Declaration public long Position { get; } Property Value Type Description System.Int64 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(Stream) This method applies and edits made to the System.IO.Stream and resets the contents of the Edits property. Declaration public void ApplyEdits(Stream stream = null) Parameters Type Name Description System.IO.Stream stream If provided also applies the changes to the passed System.IO.Stream DiscardEdits() This method discards the edits made to the System.IO.Stream by resetting the contents of the Edits property. Declaration public void DiscardEdits() MouseEvent(MouseEvent) Declaration public override bool MouseEvent(MouseEvent me) Parameters Type Name Description MouseEvent me Returns Type Description System.Boolean Overrides Responder.MouseEvent(MouseEvent) OnEdited(KeyValuePair) Method used to invoke the Edited event passing the System.Collections.Generic.KeyValuePair . Declaration public virtual void OnEdited(KeyValuePair keyValuePair) Parameters Type Name Description System.Collections.Generic.KeyValuePair < System.Int64 , System.Byte > keyValuePair The key value pair. OnEnter(View) Declaration public override bool OnEnter(View view) Parameters Type Name Description View view Returns Type Description System.Boolean Overrides View.OnEnter(View) OnPositionChanged() Method used to invoke the PositionChanged event passing the HexView.HexViewEventArgs arguments. Declaration public virtual void OnPositionChanged() 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) Events Edited Event to be invoked when an edit is made on the System.IO.Stream . Declaration public event Action> Edited Event Type Type Description System.Action < System.Collections.Generic.KeyValuePair < System.Int64 , System.Byte >> PositionChanged Event to be invoked when the position and cursor position changes. Declaration public event Action PositionChanged Event Type Type Description System.Action < HexView.HexViewEventArgs > 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.HotKeyChanged 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.TextFormatter 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, Boolean) 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.DrawContentComplete View.OnDrawContentComplete(Rect) View.SetFocus() View.KeyPress View.InvokeKeybindings(KeyEvent) View.AddKeyBinding(Key, Command) View.ReplaceKeyBinding(Key, Key) View.ContainsKeyBinding(Key) View.ClearKeybindings() View.ClearKeybinding(Key) View.ClearKeybinding(Command) View.AddCommand(Command, Func>) View.GetSupportedCommands() View.GetKeyFromCommand(Command) 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() View.GetTopSuperView() 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(Stream) 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() Initializes a HexView class using Computed layout. Declaration public HexView() HexView(Stream) Initializes 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 . BytesPerLine The bytes length per line. Declaration public int BytesPerLine { get; } Property Value Type Description System.Int32 CursorPosition Gets the current cursor position starting at one for both, line and column. Declaration public Point CursorPosition { get; } Property Value Type Description Point 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 Position Gets the current character position starting at one, related to the System.IO.Stream . Declaration public long Position { get; } Property Value Type Description System.Int64 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(Stream) This method applies and edits made to the System.IO.Stream and resets the contents of the Edits property. Declaration public void ApplyEdits(Stream stream = null) Parameters Type Name Description System.IO.Stream stream If provided also applies the changes to the passed System.IO.Stream DiscardEdits() This method discards the edits made to the System.IO.Stream by resetting the contents of the Edits property. Declaration public void DiscardEdits() MouseEvent(MouseEvent) Declaration public override bool MouseEvent(MouseEvent me) Parameters Type Name Description MouseEvent me Returns Type Description System.Boolean Overrides Responder.MouseEvent(MouseEvent) OnEdited(KeyValuePair) Method used to invoke the Edited event passing the System.Collections.Generic.KeyValuePair . Declaration public virtual void OnEdited(KeyValuePair keyValuePair) Parameters Type Name Description System.Collections.Generic.KeyValuePair < System.Int64 , System.Byte > keyValuePair The key value pair. OnEnter(View) Declaration public override bool OnEnter(View view) Parameters Type Name Description View view Returns Type Description System.Boolean Overrides View.OnEnter(View) OnPositionChanged() Method used to invoke the PositionChanged event passing the HexView.HexViewEventArgs arguments. Declaration public virtual void OnPositionChanged() 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) Events Edited Event to be invoked when an edit is made on the System.IO.Stream . Declaration public event Action> Edited Event Type Type Description System.Action < System.Collections.Generic.KeyValuePair < System.Int64 , System.Byte >> PositionChanged Event to be invoked when the position and cursor position changes. Declaration public event Action PositionChanged Event Type Type Description System.Action < HexView.HexViewEventArgs > 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, 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. ContextMenu A context menu window derived from MenuBar containing menu items which can be opened in any position. 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 HexView.HexViewEventArgs Defines the event arguments for PositionChanged event. 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. ListViewRowEventArgs System.EventArgs used by the RowRender event. 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. MenuClosingEventArgs An System.EventArgs which allows passing a cancelable menu closing event. 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 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. SelectedItemChangedArgs Event arguments for the SelectedItemChagned event. 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 TextFieldAutocomplete Renders an overlay on another view at a given point that allows selecting from a range of 'autocomplete' options. An implementation on a TextField. 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 TextViewAutocomplete Renders an overlay on another view at a given point that allows selecting from a range of 'autocomplete' options. An implementation on a TextView. 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 IAutocomplete Renders an overlay on another view at a given point that allows selecting from a range of 'autocomplete' options. 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. Command Actions which can be performed by the application or bound to keys in a View control. 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"
+ "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. ColorPicker The ColorPicker View Color picker. 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. ContextMenu A context menu window derived from MenuBar containing menu items which can be opened in any position. 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 HexView.HexViewEventArgs Defines the event arguments for PositionChanged event. 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. LineView A straight line control either horizontal or vertical 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. ListViewRowEventArgs System.EventArgs used by the RowRender event. 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. MenuClosingEventArgs An System.EventArgs which allows passing a cancelable menu closing event. 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 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. SelectedItemChangedArgs Event arguments for the SelectedItemChagned event. 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 TextFieldAutocomplete Renders an overlay on another view at a given point that allows selecting from a range of 'autocomplete' options. An implementation on a TextField. 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 TextViewAutocomplete Renders an overlay on another view at a given point that allows selecting from a range of 'autocomplete' options. An implementation on a TextView. 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 IAutocomplete Renders an overlay on another view at a given point that allows selecting from a range of 'autocomplete' options. 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. Command Actions which can be performed by the application or bound to keys in a View control. 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.IAutocomplete.html": {
"href": "api/Terminal.Gui/Terminal.Gui.IAutocomplete.html",
@@ -307,17 +312,22 @@
"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 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.HotKeyChanged 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, Boolean) 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.DrawContentComplete View.OnDrawContentComplete(Rect) View.SetFocus() View.KeyPress View.ProcessKey(KeyEvent) View.InvokeKeybindings(KeyEvent) View.AddKeyBinding(Key, Command) View.ReplaceKeyBinding(Key, Key) View.ContainsKeyBinding(Key) View.ClearKeybindings() View.ClearKeybinding(Key) View.ClearKeybinding(Command) View.AddCommand(Command, Func>) View.GetSupportedCommands() View.GetKeyFromCommand(Command) 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() View.GetTopSuperView() 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"
+ "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.HotKeyChanged 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.TextFormatter 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, Boolean) 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.DrawContentComplete View.OnDrawContentComplete(Rect) View.SetFocus() View.KeyPress View.ProcessKey(KeyEvent) View.InvokeKeybindings(KeyEvent) View.AddKeyBinding(Key, Command) View.ReplaceKeyBinding(Key, Key) View.ContainsKeyBinding(Key) View.ClearKeybindings() View.ClearKeybinding(Key) View.ClearKeybinding(Command) View.AddCommand(Command, Func>) View.GetSupportedCommands() View.GetKeyFromCommand(Command) 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() View.GetTopSuperView() 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, Boolean) Declaration public Label(ustring text, bool autosize = true) Parameters Type Name Description NStack.ustring text System.Boolean autosize Label(ustring, TextDirection, Boolean) Declaration public Label(ustring text, TextDirection direction, bool autosize = true) Parameters Type Name Description NStack.ustring text TextDirection direction System.Boolean autosize Label(Int32, Int32, ustring, Boolean) Declaration public Label(int x, int y, ustring text, bool autosize = true) Parameters Type Name Description System.Int32 x System.Int32 y NStack.ustring text System.Boolean autosize Label(Rect, ustring, Boolean) Declaration public Label(Rect rect, ustring text, bool autosize = false) Parameters Type Name Description Rect rect NStack.ustring text System.Boolean autosize Label(Rect, Boolean) Declaration public Label(Rect frame, bool autosize = false) Parameters Type Name Description Rect frame System.Boolean autosize 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",
"title": "Enum LayoutStyle",
"keywords": "Enum 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. Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public enum LayoutStyle Fields Name Description Absolute The position and size of the view are based on the Frame value. Computed The position and size of the view will be computed based on the X, Y, Width and Height properties and set on the Frame."
},
+ "api/Terminal.Gui/Terminal.Gui.LineView.html": {
+ "href": "api/Terminal.Gui/Terminal.Gui.LineView.html",
+ "title": "Class LineView",
+ "keywords": "Class LineView A straight line control either horizontal or vertical Inheritance System.Object Responder View LineView 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.HotKeyChanged 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.TextFormatter 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, Boolean) 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.DrawContentComplete View.OnDrawContentComplete(Rect) View.SetFocus() View.KeyPress View.ProcessKey(KeyEvent) View.InvokeKeybindings(KeyEvent) View.AddKeyBinding(Key, Command) View.ReplaceKeyBinding(Key, Key) View.ContainsKeyBinding(Key) View.ClearKeybindings() View.ClearKeybinding(Key) View.ClearKeybinding(Command) View.AddCommand(Command, Func>) View.GetSupportedCommands() View.GetKeyFromCommand(Command) 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() View.GetTopSuperView() 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 LineView : View, IDisposable, ISupportInitializeNotification, ISupportInitialize Constructors LineView() Creates a horizontal line Declaration public LineView() LineView(Orientation) Creates a horizontal or vertical line based on orientation Declaration public LineView(Orientation orientation) Parameters Type Name Description Orientation orientation Properties EndingAnchor 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. Declaration public Orientation Orientation { get; set; } Property Value Type Description Orientation StartingAnchor The rune to display at the start of the line (left end of horizontal line or top end of vertical) If not specified then LineRune is used Declaration public Rune? StartingAnchor { get; set; } Property Value Type Description System.Nullable < System.Rune > Methods Redraw(Rect) Draws the line including any starting/ending anchors 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.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.CanFocusChanged View.EnabledChanged View.VisibleChanged View.HotKeyChanged 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, Boolean) 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.DrawContentComplete View.OnDrawContentComplete(Rect) View.SetFocus() View.KeyPress View.InvokeKeybindings(KeyEvent) View.AddKeyBinding(Key, Command) View.ReplaceKeyBinding(Key, Key) View.ContainsKeyBinding(Key) View.ClearKeybindings() View.ClearKeybinding(Key) View.ClearKeybinding(Command) View.AddCommand(Command, Func>) View.GetSupportedCommands() View.GetKeyFromCommand(Command) 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() View.GetTopSuperView() 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 OnRowRender(ListViewRowEventArgs) Virtual method that will invoke the RowRender . Declaration public virtual void OnRowRender(ListViewRowEventArgs rowEventArgs) Parameters Type Name Description ListViewRowEventArgs rowEventArgs 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 bool ScrollDown(int lines) Parameters Type Name Description System.Int32 lines Number of lines to scroll down. Returns Type Description System.Boolean ScrollLeft(Int32) Scrolls the view left. Declaration public virtual bool ScrollLeft(int cols) Parameters Type Name Description System.Int32 cols Number of columns to scroll left. Returns Type Description System.Boolean ScrollRight(Int32) Scrolls the view right. Declaration public virtual bool ScrollRight(int cols) Parameters Type Name Description System.Int32 cols Number of columns to scroll right. Returns Type Description System.Boolean ScrollUp(Int32) Scrolls the view up. Declaration public virtual bool ScrollUp(int lines) Parameters Type Name Description System.Int32 lines Number of lines to scroll up. Returns Type Description System.Boolean 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 > RowRender This event is invoked when this ListView is being drawn before rendering. Declaration public event Action RowRender Event Type Type Description System.Action < ListViewRowEventArgs > 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.HotKeyChanged 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.TextFormatter 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, Boolean) 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.DrawContentComplete View.OnDrawContentComplete(Rect) View.SetFocus() View.KeyPress View.InvokeKeybindings(KeyEvent) View.AddKeyBinding(Key, Command) View.ReplaceKeyBinding(Key, Key) View.ContainsKeyBinding(Key) View.ClearKeybindings() View.ClearKeybinding(Key) View.ClearKeybinding(Command) View.AddCommand(Command, Func>) View.GetSupportedCommands() View.GetKeyFromCommand(Command) 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() View.GetTopSuperView() 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 OnRowRender(ListViewRowEventArgs) Virtual method that will invoke the RowRender . Declaration public virtual void OnRowRender(ListViewRowEventArgs rowEventArgs) Parameters Type Name Description ListViewRowEventArgs rowEventArgs 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 bool ScrollDown(int lines) Parameters Type Name Description System.Int32 lines Number of lines to scroll down. Returns Type Description System.Boolean ScrollLeft(Int32) Scrolls the view left. Declaration public virtual bool ScrollLeft(int cols) Parameters Type Name Description System.Int32 cols Number of columns to scroll left. Returns Type Description System.Boolean ScrollRight(Int32) Scrolls the view right. Declaration public virtual bool ScrollRight(int cols) Parameters Type Name Description System.Int32 cols Number of columns to scroll right. Returns Type Description System.Boolean ScrollUp(Int32) Scrolls the view up. Declaration public virtual bool ScrollUp(int lines) Parameters Type Name Description System.Int32 lines Number of lines to scroll up. Returns Type Description System.Boolean 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 > RowRender This event is invoked when this ListView is being drawn before rendering. Declaration public event Action RowRender Event Type Type Description System.Action < ListViewRowEventArgs > 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",
@@ -342,12 +352,12 @@
"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.CanFocusChanged View.EnabledChanged View.VisibleChanged View.HotKeyChanged View.HotKey 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, Boolean) 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.DrawContentComplete View.OnDrawContentComplete(Rect) View.SetFocus() View.KeyPress View.InvokeKeybindings(KeyEvent) View.AddKeyBinding(Key, Command) View.ReplaceKeyBinding(Key, Key) View.ContainsKeyBinding(Key) View.ClearKeybindings() View.ClearKeybinding(Key) View.ClearKeybinding(Command) View.AddCommand(Command, Func>) View.GetSupportedCommands() View.GetKeyFromCommand(Command) 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() View.GetTopSuperView() 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 HotKeySpecifier The specifier character for the hotkey to all menus. Declaration public static Rune HotKeySpecifier { get; } Property Value Type Description System.Rune 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 visible. 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 UseSubMenusSingleFrame Gets or sets if the sub-menus must be displayed in a single or multiple frames. Declaration public bool UseSubMenusSingleFrame { get; set; } Property Value Type Description System.Boolean Methods CloseMenu(Boolean) Closes the current Menu programatically, if open and not canceled. Declaration public bool CloseMenu(bool ignoreUseSubMenusSingleFrame = false) Parameters Type Name Description System.Boolean ignoreUseSubMenusSingleFrame 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) 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) OnMenuAllClosed() Virtual method that will invoke the MenuAllClosed Declaration public virtual void OnMenuAllClosed() OnMenuClosing(MenuBarItem, Boolean, Boolean) Virtual method that will invoke the MenuClosing Declaration public virtual MenuClosingEventArgs OnMenuClosing(MenuBarItem currentMenu, bool reopen, bool isSubMenu) Parameters Type Name Description MenuBarItem currentMenu The current menu to be closed. System.Boolean reopen Whether the current menu will be reopen. System.Boolean isSubMenu Whether is a sub-menu or not. Returns Type Description MenuClosingEventArgs OnMenuOpened() Virtual method that will invoke the MenuOpened event if it's defined. Declaration public virtual void OnMenuOpened() 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 MenuAllClosed Raised when all the menu are closed. Declaration public event Action MenuAllClosed Event Type Type Description System.Action MenuClosing Raised when a menu is closing passing MenuClosingEventArgs . Declaration public event Action MenuClosing Event Type Type Description System.Action < MenuClosingEventArgs > MenuOpened Raised when a menu is opened. Declaration public event Action