+ Creates a instance of MainLoop to process input events, handle timers and
+ other sources of data. It is accessible via the MainLoop property.
+
+
+ You can hook up to the Iteration event to have your method
+ invoked on each iteration of the MainLoop.
+
+
+ When invoked sets the SynchronizationContext to one that is tied
+ to the mainloop, allowing user code to use async/await.
+
+
+
Examples
+
+
// A simple Terminal.Gui app that creates a window with a frame and title with
+// 5 rows/columns of padding.
+Application.Init();
+var win = new Window ("Hello World - CTRL-Q to quit") {
+ X = 5,
+ Y = 5,
+ Width = Dim.Fill (5),
+ Height = Dim.Fill (5)
+};
+Application.Top.Add(win);
+Application.Run();
+Set to true to cause the RunLoop method to exit after the first iterations.
+Set to false (the default) to cause the RunLoop to continue running until Application.RequestStop() is called.
+
+
+
Declaration
+
+
public static bool ExitRunLoopAfterFirstIteration { get; set; }
The runstate handle that needs to be passed to the End(Application.RunState) method upon completion.
+
+
+
+
Remarks
+
+This method prepares the provided toplevel for running with the focus,
+it adds this to the list of toplevels, sets up the mainloop to process the
+event, lays out the subviews, focuses the first element, and draws the
+toplevel in the screen. This is usually followed by executing
+the RunLoop(Application.RunState, Boolean) method, and then the End(Application.RunState) method upon termination which will
+undo these changes.
+
+
+
DoEvents()
+
+Wakes up the mainloop that might be waiting on input, must be thread safe.
+
+
+
Declaration
+
+
public static void DoEvents()
+
+
+
End(Application.RunState)
+
+Building block API: completes the execution of a Toplevel that was started with Begin(Toplevel) .
+
+
+
Declaration
+
+
public static void End(Application.RunState runState)
+ Alternatively, to have a program control the main loop and
+ process events manually, call Begin(Toplevel) to set things up manually and then
+ repeatedly call RunLoop(Application.RunState, Boolean) with the wait parameter set to false. By doing this
+ the RunLoop(Application.RunState, Boolean) method will only process any pending events, timers, idle handlers and
+ then return control immediately.
+
+
+ When errorHandler is null the exception is rethrown, when it returns true the application is resumed and when false method exits gracefully.
+
By default this is true which will execute the runloop waiting for events, if you pass false, you can use this method to run a single iteration of the events.
+
+
+
+
Remarks
+
+Use the wait parameter to control whether this is a
+blocking or non-blocking call.
+
+Attributes are needed to map colors to terminal capabilities that might lack colors, on color
+scenarios, they encode both the foreground and the background color and are used in the ColorScheme
+class to define color schemes that can be used in your application.
+
+
Constructors
+
+
+
Attribute(Int32)
+
+Initializes a new instance of the Attribute struct with only the value passed to
+and trying to get the colors if defined.
+
+
+
Declaration
+
+
public Attribute(int value)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.Int32
+
value
+
Value.
+
+
+
+
+
Attribute(Int32, Color, Color)
+
+Initializes a new instance of the Attribute struct.
+
+
+
Declaration
+
+
public Attribute(int value, Color foreground, Color background)
+Given a line of characters, returns the word which ends at idx
+or null. Also returns null if the idx is positioned in the middle of a word.
+
+
+
Use this method to determine whether autocomplete should be shown when the cursor is at
+a given point in a line and to get the word from which suggestions should be generated.
+
+
+
Declaration
+
+
protected virtual string IdxToWord(List<Rune> line, int idx)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.Collections.Generic.List<System.Rune>
+
line
+
+
+
+
System.Int32
+
idx
+
+
+
+
+
Returns
+
+
+
+
Type
+
Description
+
+
+
+
+
System.String
+
+
+
+
+
+
InsertSelection(String)
+
+Called when the user confirms a selection at the current cursor location in
+the HostControl. The accepted string
+is the full autocomplete word to be inserted. Typically a host will have to
+remove some characters such that the accepted string
+completes the word instead of simply being appended.
+
+Return true if the given symbol should be considered part of a word
+and can be contained in matches. Base behavior is to use System.Char.IsLetterOrDigit(System.Char)
+
+
+
Declaration
+
+
public virtual bool IsWordChar(Rune rune)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.Rune
+
rune
+
+
+
+
+
Returns
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Boolean
+
+
+
+
+
+
MouseEvent(MouseEvent, Boolean)
+
+Handle mouse events before HostControl e.g. to make mouse events like
+report/click apply to the autocomplete control instead of changing the cursor position in
+the underlying text view.
+
+
+
Declaration
+
+
public virtual bool MouseEvent(MouseEvent me, bool fromHost = false)
+Moves the selection in the Autocomplete context menu down one
+
+
+
Declaration
+
+
protected void MoveDown()
+
+
+
MoveUp()
+
+Moves the selection in the Autocomplete context menu up one
+
+
+
Declaration
+
+
protected void MoveUp()
+
+
+
ProcessKey(KeyEvent)
+
+Handle key events before HostControl e.g. to make key events like
+up/down apply to the autocomplete control instead of changing the cursor position in
+the underlying text view.
+
+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.
+
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.
+
+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.
+
+Toggled event, raised when the CheckBox is toggled.
+
+
+
Declaration
+
+
public event Action<bool> 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.
+
+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.
+
+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.
+
+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)
+The DialogView is a Window that by default is centered and contains one
+or more Buttons. It defaults to the Dialog color scheme and has a 1 cell padding around the edges.
+
public class Dialog : Window, IDisposable, ISupportInitializeNotification, ISupportInitialize
+
+
Remarks
+
+To run the Dialog modally, create the Dialog, and pass it to Run(Func<Exception, Boolean>).
+This will execute the dialog until it terminates via the [ESC] or [CTRL-Q] key, or when one of the views
+or buttons added to the dialog calls RequestStop(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.
+
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 Buttons to display
+
+
+
Declaration
+
+
public Dialog(ustring title, params 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.
+
+
Properties
+
+
+
ButtonAlignment
+
+Determines how the DialogButtons are aligned along the
+bottom of the dialog.
+
+
+
Declaration
+
+
public Dialog.ButtonAlignments ButtonAlignment { get; set; }
+ Use the Dim objects on the Width or Height properties of a View to control the position.
+
+
+ These can be used to set the absolute position, when merely assigning an
+ integer value (via the implicit integer to Pos conversion), and they can be combined
+ to produce more useful layouts, like: Pos.Center - 3, which would shift the position
+ of the View 3 characters to the left after centering for example.
+
+
+
Methods
+
+
+
Equals(Object)
+
Determines whether the specified object is equal to the current object.
+
+
Declaration
+
+
public override bool Equals(object other)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.Object
+
other
+
The object to compare with the current object.
+
+
+
+
Returns
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Boolean
+
+true if the specified object is equal to the current object; otherwise, false.
+
+
+
+
Overrides
+
System.Object.Equals(System.Object)
+
+
Fill(Int32)
+
+Initializes a new instance of the Dim class that fills the dimension, but leaves the specified number of colums for a margin.
+
+
+This initializes a TextFieldthat is centered horizontally, is 50% of the way down,
+is 30% the height, and is 80% the width of the View it added to.
+
public static void MoveBufferArea(int sourceLeft, int sourceTop, int sourceWidth, int sourceHeight, int targetLeft, int targetTop, char sourceChar, ConsoleColor sourceForeColor, ConsoleColor sourceBackColor)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.Int32
+
sourceLeft
+
+
+
+
System.Int32
+
sourceTop
+
+
+
+
System.Int32
+
sourceWidth
+
+
+
+
System.Int32
+
sourceHeight
+
+
+
+
System.Int32
+
targetLeft
+
+
+
+
System.Int32
+
targetTop
+
+
+
+
System.Char
+
sourceChar
+
+
+
+
System.ConsoleColor
+
sourceForeColor
+
+
+
+
System.ConsoleColor
+
sourceBackColor
+
+
+
+
+
+
OpenStandardError()
+
+
+
+
+
Declaration
+
+
public static Stream OpenStandardError()
+
+
Returns
+
+
+
+
Type
+
Description
+
+
+
+
+
System.IO.Stream
+
+
+
+
+
+
OpenStandardError(Int32)
+
+
+
+
+
Declaration
+
+
public static Stream OpenStandardError(int bufferSize)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.Int32
+
bufferSize
+
+
+
+
+
Returns
+
+
+
+
Type
+
Description
+
+
+
+
+
System.IO.Stream
+
+
+
+
+
+
OpenStandardInput()
+
+
+
+
+
Declaration
+
+
public static Stream OpenStandardInput()
+
+
Returns
+
+
+
+
Type
+
Description
+
+
+
+
+
System.IO.Stream
+
+
+
+
+
+
OpenStandardInput(Int32)
+
+
+
+
+
Declaration
+
+
public static Stream OpenStandardInput(int bufferSize)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.Int32
+
bufferSize
+
+
+
+
+
Returns
+
+
+
+
Type
+
Description
+
+
+
+
+
System.IO.Stream
+
+
+
+
+
+
OpenStandardOutput()
+
+
+
+
+
Declaration
+
+
public static Stream OpenStandardOutput()
+
+
Returns
+
+
+
+
Type
+
Description
+
+
+
+
+
System.IO.Stream
+
+
+
+
+
+
OpenStandardOutput(Int32)
+
+
+
+
+
Declaration
+
+
public static Stream OpenStandardOutput(int bufferSize)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.Int32
+
bufferSize
+
+
+
+
+
Returns
+
+
+
+
Type
+
Description
+
+
+
+
+
System.IO.Stream
+
+
+
+
+
+
Read()
+
+
+
+
+
Declaration
+
+
public static int Read()
+
+
Returns
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Int32
+
+
+
+
+
+
ReadKey()
+
+
+
+
+
Declaration
+
+
public static ConsoleKeyInfo ReadKey()
+
+
Returns
+
+
+
+
Type
+
Description
+
+
+
+
+
System.ConsoleKeyInfo
+
+
+
+
+
+
ReadKey(Boolean)
+
+
+
+
+
Declaration
+
+
public static ConsoleKeyInfo ReadKey(bool intercept)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.Boolean
+
intercept
+
+
+
+
+
Returns
+
+
+
+
Type
+
Description
+
+
+
+
+
System.ConsoleKeyInfo
+
+
+
+
+
+
ReadLine()
+
+
+
+
+
Declaration
+
+
public static string ReadLine()
+
+
Returns
+
+
+
+
Type
+
Description
+
+
+
+
+
System.String
+
+
+
+
+
+
ResetColor()
+
+
+
+
+
Declaration
+
+
public static void ResetColor()
+
+
+
SetBufferSize(Int32, Int32)
+
+
+
+
+
Declaration
+
+
public static void SetBufferSize(int width, int height)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.Int32
+
width
+
+
+
+
System.Int32
+
height
+
+
+
+
+
+
SetCursorPosition(Int32, Int32)
+
+
+
+
+
Declaration
+
+
public static void SetCursorPosition(int left, int top)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.Int32
+
left
+
+
+
+
System.Int32
+
top
+
+
+
+
+
+
SetError(TextWriter)
+
+
+
+
+
Declaration
+
+
public static void SetError(TextWriter newError)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.IO.TextWriter
+
newError
+
+
+
+
+
+
SetIn(TextReader)
+
+
+
+
+
Declaration
+
+
public static void SetIn(TextReader newIn)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.IO.TextReader
+
newIn
+
+
+
+
+
+
SetOut(TextWriter)
+
+
+
+
+
Declaration
+
+
public static void SetOut(TextWriter newOut)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.IO.TextWriter
+
newOut
+
+
+
+
+
+
SetWindowPosition(Int32, Int32)
+
+
+
+
+
Declaration
+
+
public static void SetWindowPosition(int left, int top)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.Int32
+
left
+
+
+
+
System.Int32
+
top
+
+
+
+
+
+
SetWindowSize(Int32, Int32)
+
+
+
+
+
Declaration
+
+
public static void SetWindowSize(int width, int height)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.Int32
+
width
+
+
+
+
System.Int32
+
height
+
+
+
+
+
+
Write(Boolean)
+
+
+
+
+
Declaration
+
+
public static void Write(bool value)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.Boolean
+
value
+
+
+
+
+
+
Write(Char)
+
+
+
+
+
Declaration
+
+
public static void Write(char value)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.Char
+
value
+
+
+
+
+
+
Write(Char[])
+
+
+
+
+
Declaration
+
+
public static void Write(char[] buffer)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.Char[]
+
buffer
+
+
+
+
+
+
Write(Char[], Int32, Int32)
+
+
+
+
+
Declaration
+
+
public static void Write(char[] buffer, int index, int count)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.Char[]
+
buffer
+
+
+
+
System.Int32
+
index
+
+
+
+
System.Int32
+
count
+
+
+
+
+
+
Write(Decimal)
+
+
+
+
+
Declaration
+
+
public static void Write(decimal value)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.Decimal
+
value
+
+
+
+
+
+
Write(Double)
+
+
+
+
+
Declaration
+
+
public static void Write(double value)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.Double
+
value
+
+
+
+
+
+
Write(Int32)
+
+
+
+
+
Declaration
+
+
public static void Write(int value)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.Int32
+
value
+
+
+
+
+
+
Write(Int64)
+
+
+
+
+
Declaration
+
+
public static void Write(long value)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.Int64
+
value
+
+
+
+
+
+
Write(Object)
+
+
+
+
+
Declaration
+
+
public static void Write(object value)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.Object
+
value
+
+
+
+
+
+
Write(Single)
+
+
+
+
+
Declaration
+
+
public static void Write(float value)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.Single
+
value
+
+
+
+
+
+
Write(String)
+
+
+
+
+
Declaration
+
+
public static void Write(string value)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.String
+
value
+
+
+
+
+
+
Write(String, Object)
+
+
+
+
+
Declaration
+
+
public static void Write(string format, object arg0)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.String
+
format
+
+
+
+
System.Object
+
arg0
+
+
+
+
+
+
Write(String, Object, Object)
+
+
+
+
+
Declaration
+
+
public static void Write(string format, object arg0, object arg1)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.String
+
format
+
+
+
+
System.Object
+
arg0
+
+
+
+
System.Object
+
arg1
+
+
+
+
+
+
Write(String, Object, Object, Object)
+
+
+
+
+
Declaration
+
+
public static void Write(string format, object arg0, object arg1, object arg2)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.String
+
format
+
+
+
+
System.Object
+
arg0
+
+
+
+
System.Object
+
arg1
+
+
+
+
System.Object
+
arg2
+
+
+
+
+
+
Write(String, Object, Object, Object, Object)
+
+
+
+
+
Declaration
+
+
public static void Write(string format, object arg0, object arg1, object arg2, object arg3)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.String
+
format
+
+
+
+
System.Object
+
arg0
+
+
+
+
System.Object
+
arg1
+
+
+
+
System.Object
+
arg2
+
+
+
+
System.Object
+
arg3
+
+
+
+
+
+
Write(String, Object[])
+
+
+
+
+
Declaration
+
+
public static void Write(string format, params object[] arg)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.String
+
format
+
+
+
+
System.Object[]
+
arg
+
+
+
+
+
+
Write(UInt32)
+
+
+
+
+
Declaration
+
+
public static void Write(uint value)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.UInt32
+
value
+
+
+
+
+
+
Write(UInt64)
+
+
+
+
+
Declaration
+
+
public static void Write(ulong value)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.UInt64
+
value
+
+
+
+
+
+
WriteLine()
+
+
+
+
+
Declaration
+
+
public static void WriteLine()
+
+
+
WriteLine(Boolean)
+
+
+
+
+
Declaration
+
+
public static void WriteLine(bool value)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.Boolean
+
value
+
+
+
+
+
+
WriteLine(Char)
+
+
+
+
+
Declaration
+
+
public static void WriteLine(char value)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.Char
+
value
+
+
+
+
+
+
WriteLine(Char[])
+
+
+
+
+
Declaration
+
+
public static void WriteLine(char[] buffer)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.Char[]
+
buffer
+
+
+
+
+
+
WriteLine(Char[], Int32, Int32)
+
+
+
+
+
Declaration
+
+
public static void WriteLine(char[] buffer, int index, int count)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.Char[]
+
buffer
+
+
+
+
System.Int32
+
index
+
+
+
+
System.Int32
+
count
+
+
+
+
+
+
WriteLine(Decimal)
+
+
+
+
+
Declaration
+
+
public static void WriteLine(decimal value)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.Decimal
+
value
+
+
+
+
+
+
WriteLine(Double)
+
+
+
+
+
Declaration
+
+
public static void WriteLine(double value)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.Double
+
value
+
+
+
+
+
+
WriteLine(Int32)
+
+
+
+
+
Declaration
+
+
public static void WriteLine(int value)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.Int32
+
value
+
+
+
+
+
+
WriteLine(Int64)
+
+
+
+
+
Declaration
+
+
public static void WriteLine(long value)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.Int64
+
value
+
+
+
+
+
+
WriteLine(Object)
+
+
+
+
+
Declaration
+
+
public static void WriteLine(object value)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.Object
+
value
+
+
+
+
+
+
WriteLine(Single)
+
+
+
+
+
Declaration
+
+
public static void WriteLine(float value)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.Single
+
value
+
+
+
+
+
+
WriteLine(String)
+
+
+
+
+
Declaration
+
+
public static void WriteLine(string value)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.String
+
value
+
+
+
+
+
+
WriteLine(String, Object)
+
+
+
+
+
Declaration
+
+
public static void WriteLine(string format, object arg0)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.String
+
format
+
+
+
+
System.Object
+
arg0
+
+
+
+
+
+
WriteLine(String, Object, Object)
+
+
+
+
+
Declaration
+
+
public static void WriteLine(string format, object arg0, object arg1)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.String
+
format
+
+
+
+
System.Object
+
arg0
+
+
+
+
System.Object
+
arg1
+
+
+
+
+
+
WriteLine(String, Object, Object, Object)
+
+
+
+
+
Declaration
+
+
public static void WriteLine(string format, object arg0, object arg1, object arg2)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.String
+
format
+
+
+
+
System.Object
+
arg0
+
+
+
+
System.Object
+
arg1
+
+
+
+
System.Object
+
arg2
+
+
+
+
+
+
WriteLine(String, Object, Object, Object, Object)
+
+
+
+
+
Declaration
+
+
public static void WriteLine(string format, object arg0, object arg1, object arg2, object arg3)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.String
+
format
+
+
+
+
System.Object
+
arg0
+
+
+
+
System.Object
+
arg1
+
+
+
+
System.Object
+
arg2
+
+
+
+
System.Object
+
arg3
+
+
+
+
+
+
WriteLine(String, Object[])
+
+
+
+
+
Declaration
+
+
public static void WriteLine(string format, params object[] arg)
+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.
+
+Determines the spacing of bars along the axis. Defaults to 1 i.e.
+every 1 unit of graph space a bar is rendered. Note that you should
+also consider CellSize when changing this.
+
+
+
Declaration
+
+
public float BarEvery { get; set; }
+
+
Property Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Single
+
+
+
+
+
+
Bars
+
+Ordered collection of graph bars to position along axis
+
+Returns the Y screen position of the origin (typically 0,0) of graph space.
+Return value is bounded by the screen i.e. the axis is always rendered even
+if the origin is offscreen.
+
Defines the area available for the legend to render in
+(within the graph). This is in screen units (i.e. not graph space)
+
+
+
+
Properties
+
+
+
BeforeSeries
+
+Returns false i.e. Lengends render after series
+
+
+
Declaration
+
+
public bool BeforeSeries { get; }
+
+
Property Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Boolean
+
+
+
+
+
+
Border
+
+True to draw a solid border around the legend.
+Defaults to true. This border will be within the
+Bounds and so reduces the width/height
+available for text by 2
+
+
+
Declaration
+
+
public bool Border { get; set; }
+
+
Property Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Boolean
+
+
+
+
+
+
Bounds
+
+Defines the screen area available for the legend to render in
+
Array of colors that define bar color in each category. Length must match numberOfBarsPerCategory
+
+
+
+
Properties
+
+
+
Spacing
+
+The number of units of graph space between bars. Should be
+less than BarEvery
+
+
+
Declaration
+
+
public float Spacing { get; }
+
+
Property Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Single
+
+
+
+
+
+
SubSeries
+
+Sub collections. Each series contains the bars for a different category. Thus
+SubSeries[0].Bars[0] is the first bar on the axis and SubSeries[1].Bars[0] is the
+second etc
+
+
+
Declaration
+
+
public IReadOnlyCollection<BarSeries> SubSeries { get; }
+True to add text before plotting series. Defaults to false
+
+
+
Declaration
+
+
public bool BeforeSeries { get; set; }
+
+
Property Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Boolean
+
+
+
+
+
+
GraphPosition
+
+The location in graph space to draw the Text. This
+annotation will only show if the point is in the current viewable
+area of the graph presented in the GraphView
+
+Returns the X screen position of the origin (typically 0,0) of graph space.
+Return value is bounded by the screen i.e. the axis is always rendered even
+if the origin is offscreen.
+
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.
+
+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<long, byte> Edits { get; }
+Handle mouse events before HostControl e.g. to make mouse events like
+report/click apply to the autocomplete control instead of changing the cursor position in
+the underlying text view.
+
+Handle key events before HostControl e.g. to make key events like
+up/down apply to the autocomplete control instead of changing the cursor position in
+the underlying text view.
+
+ If the SpecialMask is set, then the value is that of the special mask,
+ otherwise, the value is the one of the lower bits (as extracted by CharMask)
+
+ Numerics keys are the values between 48 and 57 corresponding to 0 to 9
+
+
+
+ Upper alpha keys are the values between 65 and 90 corresponding to A to Z
+
+
+ Unicode runes are also stored here, the letter 'A" for example is encoded as a value 65 (not surfaced in the enum).
+
+
+
Fields
+
+
+
+
+
Name
+
Description
+
+
+
+
+
a
+
+The key code for the user pressing A
+
+
+
+
A
+
+The key code for the user pressing Shift-A
+
+
+
+
AltMask
+
+When this value is set, the Key encodes the sequence Alt-KeyValue.
+And the actual value must be extracted by removing the AltMask.
+
+
+
+
b
+
+The key code for the user pressing B
+
+
+
+
B
+
+The key code for the user pressing Shift-B
+
+
+
+
Backspace
+
+Backspace key.
+
+
+
+
BackTab
+
+Shift-tab key (backwards tab key).
+
+
+
+
c
+
+The key code for the user pressing C
+
+
+
+
C
+
+The key code for the user pressing Shift-C
+
+
+
+
CharMask
+
+Mask that indicates that this is a character value, values outside this range
+indicate special characters like Alt-key combinations or special keys on the
+keyboard like function keys, arrows keys and so on.
+
+
+
+
CtrlMask
+
+When this value is set, the Key encodes the sequence Ctrl-KeyValue.
+And the actual value must be extracted by removing the CtrlMask.
+
+
+
+
CursorDown
+
+Cursor down key.
+
+
+
+
CursorLeft
+
+Cursor left key.
+
+
+
+
CursorRight
+
+Cursor right key.
+
+
+
+
CursorUp
+
+Cursor up key
+
+
+
+
d
+
+The key code for the user pressing D
+
+
+
+
D
+
+The key code for the user pressing Shift-D
+
+
+
+
D0
+
+Digit 0.
+
+
+
+
D1
+
+Digit 1.
+
+
+
+
D2
+
+Digit 2.
+
+
+
+
D3
+
+Digit 3.
+
+
+
+
D4
+
+Digit 4.
+
+
+
+
D5
+
+Digit 5.
+
+
+
+
D6
+
+Digit 6.
+
+
+
+
D7
+
+Digit 7.
+
+
+
+
D8
+
+Digit 8.
+
+
+
+
D9
+
+Digit 9.
+
+
+
+
Delete
+
+The key code for the user pressing the delete key.
+
+
+
+
DeleteChar
+
+Delete character key
+
+
+
+
e
+
+The key code for the user pressing E
+
+
+
+
E
+
+The key code for the user pressing Shift-E
+
+
+
+
End
+
+End key
+
+
+
+
Enter
+
+The key code for the user pressing the return key.
+
+
+
+
Esc
+
+The key code for the user pressing the escape key
+
+
+
+
f
+
+The key code for the user pressing F
+
+
+
+
F
+
+The key code for the user pressing Shift-F
+
+
+
+
F1
+
+F1 key.
+
+
+
+
F10
+
+F10 key.
+
+
+
+
F11
+
+F11 key.
+
+
+
+
F12
+
+F12 key.
+
+
+
+
F2
+
+F2 key.
+
+
+
+
F3
+
+F3 key.
+
+
+
+
F4
+
+F4 key.
+
+
+
+
F5
+
+F5 key.
+
+
+
+
F6
+
+F6 key.
+
+
+
+
F7
+
+F7 key.
+
+
+
+
F8
+
+F8 key.
+
+
+
+
F9
+
+F9 key.
+
+
+
+
g
+
+The key code for the user pressing G
+
+
+
+
G
+
+The key code for the user pressing Shift-G
+
+
+
+
h
+
+The key code for the user pressing H
+
+
+
+
H
+
+The key code for the user pressing Shift-H
+
+
+
+
Home
+
+Home key
+
+
+
+
i
+
+The key code for the user pressing I
+
+
+
+
I
+
+The key code for the user pressing Shift-I
+
+
+
+
InsertChar
+
+Insert character key
+
+
+
+
j
+
+The key code for the user pressing J
+
+
+
+
J
+
+The key code for the user pressing Shift-J
+
+
+
+
k
+
+The key code for the user pressing K
+
+
+
+
K
+
+The key code for the user pressing Shift-K
+
+
+
+
l
+
+The key code for the user pressing L
+
+
+
+
L
+
+The key code for the user pressing Shift-L
+
+
+
+
m
+
+The key code for the user pressing M
+
+
+
+
M
+
+The key code for the user pressing Shift-M
+
+
+
+
n
+
+The key code for the user pressing N
+
+
+
+
N
+
+The key code for the user pressing Shift-N
+
+
+
+
Null
+
+The key code representing null or empty
+
+
+
+
o
+
+The key code for the user pressing O
+
+
+
+
O
+
+The key code for the user pressing Shift-O
+
+
+
+
p
+
+The key code for the user pressing P
+
+
+
+
P
+
+The key code for the user pressing Shift-P
+
+
+
+
PageDown
+
+Page Down key.
+
+
+
+
PageUp
+
+Page Up key.
+
+
+
+
q
+
+The key code for the user pressing Q
+
+
+
+
Q
+
+The key code for the user pressing Shift-Q
+
+
+
+
r
+
+The key code for the user pressing R
+
+
+
+
R
+
+The key code for the user pressing Shift-R
+
+
+
+
s
+
+The key code for the user pressing S
+
+
+
+
S
+
+The key code for the user pressing Shift-S
+
+
+
+
ShiftMask
+
+When this value is set, the Key encodes the sequence Shift-KeyValue.
+
+
+
+
Space
+
+The key code for the user pressing the space bar
+
+
+
+
SpecialMask
+
+If the SpecialMask is set, then the value is that of the special mask,
+otherwise, the value is the one of the lower bits (as extracted by CharMask).
+
+
+
+
t
+
+The key code for the user pressing T
+
+
+
+
T
+
+The key code for the user pressing Shift-T
+
+
+
+
Tab
+
+The key code for the user pressing the tab key (forwards tab key).
+
+Gets a value indicating whether the Alt key was pressed (real or synthesized)
+
+
+
Declaration
+
+
public bool IsAlt { get; }
+
+
Property Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Boolean
+
true if is alternate; otherwise, false.
+
+
+
+
+
IsCapslock
+
+Gets a value indicating whether the Caps lock key was pressed (real or synthesized)
+
+
+
Declaration
+
+
public bool IsCapslock { get; }
+
+
Property Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Boolean
+
true if is alternate; otherwise, false.
+
+
+
+
+
IsCtrl
+
+Determines whether the value is a control key (and NOT just the ctrl key)
+
+
+
Declaration
+
+
public bool IsCtrl { get; }
+
+
Property Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Boolean
+
true if is ctrl; otherwise, false.
+
+
+
+
+
IsNumlock
+
+Gets a value indicating whether the Num lock key was pressed (real or synthesized)
+
+
+
Declaration
+
+
public bool IsNumlock { get; }
+
+
Property Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Boolean
+
true if is alternate; otherwise, false.
+
+
+
+
+
IsScrolllock
+
+Gets a value indicating whether the Scroll lock key was pressed (real or synthesized)
+
+
+
Declaration
+
+
public bool IsScrolllock { get; }
+
+
Property Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Boolean
+
true if is alternate; otherwise, false.
+
+
+
+
+
IsShift
+
+Gets a value indicating whether the Shift key was pressed.
+
+
+
Declaration
+
+
public bool IsShift { get; }
+
+
Property Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Boolean
+
true if is shift; otherwise, false.
+
+
+
+
+
KeyValue
+
+The key value cast to an integer, you will typical use this for
+extracting the Unicode rune value out of a key, when none of the
+symbolic options are in use.
+
+The Label View displays a string at a given position and supports multiple lines separated by newline characters.
+Multi-line Labels support word wrap.
+
+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.
+
+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.
+
+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.
+
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<T>,
+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.
+
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.
+
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)
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.
+
+Gets the list of all timeouts sorted by the System.TimeSpan time ticks./>.
+A shorter limit time can be added at the end, but it will be called before an
+earlier addition that has a longer limit time.
+
+
+
Declaration
+
+
public SortedList<long, MainLoop.Timeout> Timeouts { get; }
+Adds specified idle handler function to mainloop processing. The handler function will be called once per iteration of the main loop after other events have been handled.
+
+When time specified passes, the callback will be invoked.
+If the callback returns true, the timeout will be reset, repeating
+the invocation. If it returns false, the timeout will stop and be removed.
+
+The returned value is a token that can be used to stop the timeout
+by calling RemoveTimeout(Object).
+
+
+
EventsPending(Boolean)
+
+Determines whether there are pending events to be processed.
+
+
+
Declaration
+
+
public bool EventsPending(bool wait = false)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.Boolean
+
wait
+
+
+
+
+
Returns
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Boolean
+
+
+
+
+
Remarks
+
+You can use this method if you want to probe if events are pending.
+Typically used if you need to flush the input queue while still
+running some of your own code in your main thread.
+
+
+
Invoke(Action)
+
+Runs action on the thread that is processing events
+
+
+
Declaration
+
+
public void Invoke(Action action)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.Action
+
action
+
the action to be invoked on the main processing thread.
+
+
+
+
+
MainIteration()
+
+Runs one iteration of timers and file watches
+
+
+
Declaration
+
+
public void MainIteration()
+
+
Remarks
+
+You use this to process all pending events (timers, idle handlers and file watches).
+
+You can use it like this:
+while (main.EvensPending ()) MainIteration ();
+
+The HotKey is used when the menu is active, the shortcut can be triggered when the menu is not active.
+For example HotKey would be "N" when the File Menu is open (assuming there is a "_New" entry
+if the Shortcut is set to "Control-N", this would be a global hotkey that would trigger as well
+
+
+
Declaration
+
+
public Rune HotKey
+
+
Field Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Rune
+
+
+
+
+
Properties
+
+
+
Action
+
+Gets or sets the action to be invoked when the menu is triggered
+
+
+
Declaration
+
+
public Action Action { get; set; }
+
+
Property Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Action
+
Method to invoke.
+
+
+
+
+
CanExecute
+
+Gets or sets the action to be invoked if the menu can be triggered
+
+
+
Declaration
+
+
public Func<bool> CanExecute { get; set; }
+
+
Property Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Func<System.Boolean>
+
Function to determine if action is ready to be executed.
var n = MessageBox.Query ("Quit Demo", "Are you sure you want to quit this demo?", "Yes", "No");
+if (n == 0)
+ quit = true;
+else
+ quit = false;
+
+
Properties
+
+
+
Clicked
+
+The index of the selected button, or -1 if the user pressed ESC to close the dialog.
+This is useful for web based console where by default there is no SynchronizationContext or TaskScheduler.
+
+
+
Declaration
+
+
public static int Clicked { get; }
+
+
Property Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Int32
+
+
+
+
+
Methods
+
+
+
ErrorQuery(ustring, ustring, ustring[])
+
+Presents an error MessageBox with the specified title and message and a list of buttons to show to the user.
+
+
+
Declaration
+
+
public static int ErrorQuery(ustring title, ustring message, params ustring[] buttons)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
NStack.ustring
+
title
+
Title for the query.
+
+
+
NStack.ustring
+
message
+
Message to display, might contain multiple lines.
+
+
+
NStack.ustring[]
+
buttons
+
Array of buttons to add.
+
+
+
+
Returns
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Int32
+
The index of the selected button, or -1 if the user pressed ESC to close the dialog.
+
+
+
+
Remarks
+
+The message box will be vertically and horizontally centered in the container and the size will be automatically determined
+from the size of the title, message. and buttons.
+
+
+
ErrorQuery(ustring, ustring, Int32, ustring[])
+
+Presents an error MessageBox with the specified title and message and a list of buttons to show to the user.
+
+
+
Declaration
+
+
public static int ErrorQuery(ustring title, ustring message, int defaultButton = 0, params ustring[] buttons)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
NStack.ustring
+
title
+
Title for the query.
+
+
+
NStack.ustring
+
message
+
Message to display, might contain multiple lines.
+
+
+
System.Int32
+
defaultButton
+
Index of the default button.
+
+
+
NStack.ustring[]
+
buttons
+
Array of buttons to add.
+
+
+
+
Returns
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Int32
+
The index of the selected button, or -1 if the user pressed ESC to close the dialog.
+
+
+
+
Remarks
+
+The message box will be vertically and horizontally centered in the container and the size will be automatically determined
+from the size of the title, message. and buttons.
+
The index of the selected button, or -1 if the user pressed ESC to close the dialog.
+
+
+
+
Remarks
+
+The message box will be vertically and horizontally centered in the container and the size will be automatically determined
+from the size of the title, message. and buttons.
+
+Presents an error MessageBox with the specified title and message and a list of buttons to show to the user.
+
+
+
Declaration
+
+
public static int Query(ustring title, ustring message, params ustring[] buttons)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
NStack.ustring
+
title
+
Title for the query.
+
+
+
NStack.ustring
+
message
+
Message to display, might contain multiple lines.
+
+
+
NStack.ustring[]
+
buttons
+
Array of buttons to add.
+
+
+
+
Returns
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Int32
+
The index of the selected button, or -1 if the user pressed ESC to close the dialog.
+
+
+
+
Remarks
+
+The message box will be vertically and horizontally centered in the container and the size will be automatically determined
+from the size of the message and buttons.
+
+
+
Query(ustring, ustring, Int32, ustring[])
+
+Presents an error MessageBox with the specified title and message and a list of buttons to show to the user.
+
+
+
Declaration
+
+
public static int Query(ustring title, ustring message, int defaultButton = 0, params ustring[] buttons)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
NStack.ustring
+
title
+
Title for the query.
+
+
+
NStack.ustring
+
message
+
Message to display, might contain multiple lines.
+
+
+
System.Int32
+
defaultButton
+
Index of the default button.
+
+
+
NStack.ustring[]
+
buttons
+
Array of buttons to add.
+
+
+
+
Returns
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Int32
+
The index of the selected button, or -1 if the user pressed ESC to close the dialog.
+
+
+
+
Remarks
+
+The message box will be vertically and horizontally centered in the container and the size will be automatically determined
+from the size of the message and buttons.
+
+
+
Query(ustring, ustring, Int32, Border, ustring[])
+
+Presents an error MessageBox with the specified title and message and a list of buttons to show to the user.
+
+
+
Declaration
+
+
public static int Query(ustring title, ustring message, int defaultButton = 0, Border border = null, params ustring[] buttons)
The index of the selected button, or -1 if the user pressed ESC to close the dialog.
+
+
+
+
Remarks
+
+The message box will be vertically and horizontally centered in the container and the size will be automatically determined
+from the size of the message and buttons.
+
+
+
Query(Int32, Int32, ustring, ustring, ustring[])
+
+Presents a normal MessageBox with the specified title and message and a list of buttons to show to the user.
+
+
+
Declaration
+
+
public static int Query(int width, int height, ustring title, ustring message, params ustring[] buttons)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.Int32
+
width
+
Width for the window.
+
+
+
System.Int32
+
height
+
Height for the window.
+
+
+
NStack.ustring
+
title
+
Title for the query.
+
+
+
NStack.ustring
+
message
+
Message to display, might contain multiple lines.
+
+
+
NStack.ustring[]
+
buttons
+
Array of buttons to add.
+
+
+
+
Returns
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Int32
+
The index of the selected button, or -1 if the user pressed ESC to close the dialog.
public class OpenDialog : FileDialog, IDisposable, ISupportInitializeNotification, ISupportInitialize
+
+
Remarks
+
+
+ The open dialog can be used to select files for opening, it can be configured to allow
+ multiple items to be selected (based on the AllowsMultipleSelection) variable and
+ you can control whether this should allow files or directories to be selected.
+
+
+ To use, create an instance of OpenDialog, and pass it to
+Run(Func<Exception, Boolean>). This will run the dialog modally,
+and when this returns, the list of files will be available on the FilePaths property.
+
+
+To select more than one file, users can use the spacebar, or control-t.
+
+A container for single Child that will allow to drawn Border in
+two ways. If UsePanelFrame the borders and the child will be accommodated in the available
+panel size, otherwise the panel will be resized based on the child and borders thickness sizes.
+
+Describes the 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.
+
+ Use the Pos objects on the X or Y properties of a view to control the position.
+
+
+ These can be used to set the absolute position, when merely assigning an
+ integer value (via the implicit integer to Pos conversion), and they can be combined
+ to produce more useful layouts, like: Pos.Center - 3, which would shift the position
+ of the View 3 characters to the left after centering for example.
+
+
+ It is possible to reference coordinates of another view by using the methods
+ Left(View), Right(View), Bottom(View), Top(View). The X(View) and Y(View) are
+ aliases to Left(View) and Top(View) respectively.
+
+
+
Methods
+
+
+
AnchorEnd(Int32)
+
+Creates a Pos object that is anchored to the end (right side or bottom) of the dimension,
+useful to flush the layout from the right or bottom.
+
public class ProgressBar : View, IDisposable, ISupportInitializeNotification, ISupportInitialize
+
+
Remarks
+
+
+ProgressBar can operate in two modes, percentage mode, or
+activity mode. The progress bar starts in percentage mode and
+setting the Fraction property will reflect on the UI the progress
+made so far. Activity mode is used when the application has no
+way of knowing how much time is left, and is started when the Pulse() method is called.
+Call Pulse() repeatedly as progress is made.
+
+
+
Constructors
+
+
+
ProgressBar()
+
+Initializes a new instance of the ProgressBar class, starts in percentage mode and uses relative layout.
+
+
+
Declaration
+
+
public ProgressBar()
+
+
+
ProgressBar(Rect)
+
+Initializes a new instance of the ProgressBar class, starts in percentage mode with an absolute position and size.
+
+Gets or sets a value indicating whether this Responder can focus.
+
+
+
Declaration
+
+
public virtual bool CanFocus { get; set; }
+
+
Property Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Boolean
+
true if can focus; otherwise, false.
+
+
+
+
+
Enabled
+
+Gets or sets a value indicating whether this Responder can respond to user interaction.
+
+
+
Declaration
+
+
public virtual bool Enabled { get; set; }
+
+
Property Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Boolean
+
+
+
+
+
+
HasFocus
+
+Gets or sets a value indicating whether this Responder has focus.
+
+
+
Declaration
+
+
public virtual bool HasFocus { get; }
+
+
Property Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Boolean
+
true if has focus; otherwise, false.
+
+
+
+
+
Visible
+
+Gets or sets a value indicating whether this Responder and all its child controls are displayed.
+
+
+
Declaration
+
+
public virtual bool Visible { get; set; }
+
+
Property Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Boolean
+
+
+
+
+
Methods
+
+
+
Dispose()
+
+Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resource.
+
+
+
Declaration
+
+
public void Dispose()
+
+
+
Dispose(Boolean)
+
+Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
+
+
+
Declaration
+
+
protected virtual void Dispose(bool disposing)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.Boolean
+
disposing
+
+
+
+
+
Remarks
+
+If disposing equals true, the method has been called directly
+or indirectly by a user's code. Managed and unmanaged resources
+can be disposed.
+If disposing equals false, the method has been called by the
+runtime from inside the finalizer and you should not reference
+other objects. Only unmanaged resources can be disposed.
+
+
+
MouseEvent(MouseEvent)
+
+Method invoked when a mouse event is generated
+
+
+
Declaration
+
+
public virtual bool MouseEvent(MouseEvent mouseEvent)
+Method invoked when the Visible property from a view is changed.
+
+
+
Declaration
+
+
public virtual void OnVisibleChanged()
+
+
+
ProcessColdKey(KeyEvent)
+
+This method can be overwritten by views that
+want to provide accelerator functionality
+(Alt-key for example), but without
+interefering with normal ProcessKey behavior.
+
+
+
Declaration
+
+
public virtual bool ProcessColdKey(KeyEvent keyEvent)
Contains the details about the key that produced the event.
+
+
+
+
Returns
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Boolean
+
+
+
+
+
Remarks
+
+
+ After keys are sent to the subviews on the
+ current view, all the view are
+ processed and the key is passed to the views
+ to allow some of them to process the keystroke
+ as a cold-key.
+
+ This functionality is used, for example, by
+ default buttons to act on the enter key.
+ Processing this as a hot-key would prevent
+ non-default buttons from consuming the enter
+ keypress when they have the focus.
+
+
+
+
ProcessHotKey(KeyEvent)
+
+This method can be overwritten by view that
+want to provide accelerator functionality
+(Alt-key for example).
+
+ Before keys are sent to the subview on the
+ current view, all the views are
+ processed and the key is passed to the widgets
+ to allow some of them to process the keystroke
+ as a hot-key.
+
+ For example, if you implement a button that
+ has a hotkey ok "o", you would catch the
+ combination Alt-o here. If the event is
+ caught, you must return true to stop the
+ keystroke from being dispatched to other
+ views.
+
+
+
+
ProcessKey(KeyEvent)
+
+If the view is focused, gives the view a
+chance to process the keystroke.
+
Contains the details about the key that produced the event.
+
+
+
+
Returns
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Boolean
+
+
+
+
+
Remarks
+
+
+ Views can override this method if they are
+ interested in processing the given keystroke.
+ If they consume the keystroke, they must
+ return true to stop the keystroke from being
+ processed by other widgets or consumed by the
+ widget engine. If they return false, the
+ keystroke will be passed using the ProcessColdKey
+ method to other views to process.
+
+
+ The View implementation does nothing but return false,
+ so it is not necessary to call base.ProcessKey if you
+ derive directly from View, but you should if you derive
+ other View subclasses.
+
public class SaveDialog : FileDialog, IDisposable, ISupportInitializeNotification, ISupportInitialize
+
+
Remarks
+
+
+ To use, create an instance of SaveDialog, and pass it to
+Run(Func<Exception, Boolean>). This will run the dialog modally,
+and when this returns, the FileNameproperty will contain the selected file name or
+null if the user canceled.
+
public class ScrollView : View, IDisposable, ISupportInitializeNotification, ISupportInitialize
+
+
Remarks
+
+
+ The subviews that are added to this ScrollView are offset by the
+ContentOffset property. The view itself is a window into the
+space represented by the ContentSize.
+
+
+ Use the
+
+
+
Constructors
+
+
+
ScrollView()
+
+Initializes a new instance of the ScrollView class using Computed positioning.
+
+
+
Declaration
+
+
public ScrollView()
+
+
+
ScrollView(Rect)
+
+Initializes a new instance of the ScrollView class using Absolute positioning.
+
+A status bar is a View that snaps to the bottom of a Toplevel displaying set of StatusItems.
+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.
+
public class StatusBar : View, IDisposable, ISupportInitializeNotification, ISupportInitialize
+
+
Constructors
+
+
+
StatusBar()
+
+Initializes a new instance of the StatusBar class.
+
+
+
Declaration
+
+
public StatusBar()
+
+
+
StatusBar(StatusItem[])
+
+Initializes a new instance of the StatusBar class with the specified set of StatusItems.
+The StatusBar will be drawn on the lowest line of the terminal or SuperView (if not null).
+
+StatusItem objects are contained by StatusBarViews.
+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.
+
+True to show a solid box around the edge of the control. Defaults to true.
+
+
+
Declaration
+
+
public bool ShowBorder { get; set; }
+
+
Property Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Boolean
+
+
+
+
+
+
ShowTopLine
+
+True to show the top lip of tabs. False to directly begin with tab text during
+rendering. When true header line occupies 3 rows, when false only 2.
+Defaults to true.
+
+
When TabsOnBottom is enabled this instead applies to the
+ bottommost line of the control
+
+
+
Declaration
+
+
public bool ShowTopLine { get; set; }
+
+
Property Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Boolean
+
+
+
+
+
+
TabsOnBottom
+
+True to render tabs at the bottom of the view instead of the top
+
+Updates the control to use the latest state settings in Style.
+This can change the size of the client area of the tab (for rendering the
+selected tab's content). This method includes a call
+to SetNeedsDisplay()
+
+Changes the SelectedTab by the given amount.
+Positive for right, negative for left. If no tab is currently selected then
+the first tab will become selected
+
+Defines a delegate for returning custom representations of cell values. If not set then System.Object.ToString() is used. Return values from your delegate may be truncated e.g. based on MaxWidth
+
+
+
Declaration
+
+
public Func<object, string> RepresentationGetter
+
+
Field Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Func<System.Object, System.String>
+
+
+
+
+
Properties
+
+
+
Alignment
+
+Defines the default alignment for all values rendered in this column. For custom alignment based on cell contents use AlignmentGetter.
+
+Defines the format for values e.g. "yyyy-MM-dd" for dates
+
+
+
Declaration
+
+
public string Format { get; set; }
+
+
Property Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.String
+
+
+
+
+
+
MaxWidth
+
+Set the maximum width of the column in characters. This value will be ignored if more than the tables MaxCellWidth. Defaults to DefaultMaxCellWidth
+
+
+
Declaration
+
+
public int MaxWidth { get; set; }
+
+
Property Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Int32
+
+
+
+
+
+
MinAcceptableWidth
+
+Enables flexible sizing of this column based on available screen space to render into.
+
+
+
Declaration
+
+
public int MinAcceptableWidth { get; set; }
+
+
Property Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Int32
+
+
+
+
+
+
MinWidth
+
+Set the minimum width of the column in characters. Setting this will ensure that
+even when a column has short content/header it still fills a given width of the control.
+
+
This value will be ignored if more than the tables MaxCellWidth
+or the MaxWidth
+
+
+For setting a flexible column width (down to a lower limit) use MinAcceptableWidth
+instead
+
+
+Creates a new instance of arguments describing a change in selected cell in a TableView
+
+
+
Declaration
+
+
public SelectedCellChangedEventArgs(DataTable t, int oldCol, int newCol, int oldRow, int newRow)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.Data.DataTable
+
t
+
+
+
+
System.Int32
+
oldCol
+
+
+
+
System.Int32
+
newCol
+
+
+
+
System.Int32
+
oldRow
+
+
+
+
System.Int32
+
newRow
+
+
+
+
+
Properties
+
+
+
NewCol
+
+The newly selected column index.
+
+
+
Declaration
+
+
public int NewCol { get; }
+
+
Property Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Int32
+
+
+
+
+
+
NewRow
+
+The newly selected row index.
+
+
+
Declaration
+
+
public int NewRow { get; }
+
+
Property Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Int32
+
+
+
+
+
+
OldCol
+
+The previous selected column index. May be invalid e.g. when the selection has been changed as a result of replacing the existing Table with a smaller one
+
+
+
Declaration
+
+
public int OldCol { get; }
+
+
Property Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Int32
+
+
+
+
+
+
OldRow
+
+The previous selected row index. May be invalid e.g. when the selection has been changed as a result of deleting rows from the table
+
+
+
Declaration
+
+
public int OldRow { get; }
+
+
Property Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Int32
+
+
+
+
+
+
Table
+
+The current table to which the new indexes refer. May be null e.g. if selection change is the result of clearing the table from the view
+
+Determines rendering when the last column in the table is visible but it's
+content or MaxWidth is less than the remaining
+space in the control. True (the default) will expand the column to fill
+the remaining bounds of the control. False will draw a column ending line
+and leave a blank column that cannot be selected in the remaining space.
+
+
+
Declaration
+
+
public bool ExpandLastColumn { get; set; }
+
+
Property Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Boolean
+
+
+
+
+
+
InvertSelectedCellFirstCharacter
+
+True to invert the colors of the first symbol of the selected cell in the TableView.
+This gives the appearance of a cursor for when the ConsoleDriver doesn't otherwise show
+this
+
+
+
Declaration
+
+
public bool InvertSelectedCellFirstCharacter { get; set; }
+
+
Property Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Boolean
+
+
+
+
+
+
RowColorGetter
+
+Delegate for coloring specific rows in a different color. For cell color ColorGetter
+
+
+
Declaration
+
+
public TableView.RowColorGetterDelegate RowColorGetter { get; set; }
public bool ShowHorizontalHeaderOverline { get; set; }
+
+
Property Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Boolean
+
+
+
+
+
+
ShowHorizontalHeaderUnderline
+
+True to render a solid line under the headers
+
+
+
Declaration
+
+
public bool ShowHorizontalHeaderUnderline { get; set; }
+
+
Property Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Boolean
+
+
+
+
+
+
ShowHorizontalScrollIndicators
+
+True to render a arrows on the right/left of the table when
+there are more column(s) that can be scrolled to. Requires
+ShowHorizontalHeaderUnderline to be true.
+Defaults to true
+
+
+
Declaration
+
+
public bool ShowHorizontalScrollIndicators { get; set; }
+
+
Property Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Boolean
+
+
+
+
+
+
ShowVerticalCellLines
+
+True to render a solid line vertical line between cells
+
+
+
Declaration
+
+
public bool ShowVerticalCellLines { get; set; }
+
+
Property Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Boolean
+
+
+
+
+
+
ShowVerticalHeaderLines
+
+True to render a solid line vertical line between headers
+
+
+
Declaration
+
+
public bool ShowVerticalHeaderLines { get; set; }
+
+
Property Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Boolean
+
+
+
+
+
+
SmoothHorizontalScrolling
+
+
+Determines how ColumnOffset is updated when scrolling
+right off the end of the currently visible area.
+
+
+If true then when scrolling right the scroll offset is increased the minimum required to show
+the new column. This may be slow if you have an incredibly large number of columns in
+your table and/or slow RepresentationGetter implementations
+
+
+If false then scroll offset is set to the currently selected column (i.e. PageRight).
+
+
+
+
Declaration
+
+
public bool SmoothHorizontalScrolling { get; set; }
+
+
Property Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Boolean
+
+
+
+
+
Methods
+
+
+
GetColumnStyleIfAny(DataColumn)
+
+Returns the entry from ColumnStyles for the given col or null if no custom styling is defined for it
+
+
+
Declaration
+
+
public TableView.ColumnStyle GetColumnStyleIfAny(DataColumn col)
+Horizontal scroll offset. The index of the first column in Table to display when when rendering the view.
+
+
+
Declaration
+
+
public int ColumnOffset { get; set; }
+
+
Property Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Int32
+
+
+
+
+
Remarks
+
This property allows very wide tables to be rendered with horizontal scrolling
+
+
FullRowSelect
+
+True to select the entire row at once. False to select individual cells. Defaults to false
+
+
+
Declaration
+
+
public bool FullRowSelect { get; set; }
+
+
Property Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Boolean
+
+
+
+
+
+
MaxCellWidth
+
+The maximum number of characters to render in any given column. This prevents one long column from pushing out all the others
+
+
+
Declaration
+
+
public int MaxCellWidth { get; set; }
+
+
Property Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Int32
+
+
+
+
+
+
MultiSelect
+
+True to allow regions to be selected
+
+
+
Declaration
+
+
public bool MultiSelect { get; set; }
+
+
Property Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Boolean
+
+
+
+
+
+
MultiSelectedRegions
+
+When MultiSelect is enabled this property contain all rectangles of selected cells. Rectangles describe column/rows selected in Table (not screen coordinates)
+
+
+
Declaration
+
+
public Stack<TableView.TableSelection> MultiSelectedRegions { get; }
+The data table to render in the view. Setting this property automatically updates and redraws the control.
+
+
+
Declaration
+
+
public DataTable Table { get; set; }
+
+
Property Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Data.DataTable
+
+
+
+
+
Methods
+
+
+
CellToScreen(Int32, Int32)
+
+Returns the screen position (relative to the control client area) that the given cell is rendered or null if it is outside the current scroll area or no table is loaded
+
+
+
Declaration
+
+
public Point? CellToScreen(int tableColumn, int tableRow)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.Int32
+
tableColumn
+
The index of the Table column you are looking for, use System.Data.DataColumn.Ordinal
+
+
+
System.Int32
+
tableRow
+
The index of the row in Table that you are looking for
public void ChangeSelectionByOffset(int offsetX, int offsetY, bool extendExistingSelection)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.Int32
+
offsetX
+
Offset in number of columns
+
+
+
System.Int32
+
offsetY
+
Offset in number of rows
+
+
+
System.Boolean
+
extendExistingSelection
+
True to create a multi cell selection or adjust an existing one
+
+
+
+
+
ChangeSelectionToEndOfRow(Boolean)
+
+Moves or extends the selection to the last cell in the current row
+
+
+
Declaration
+
+
public void ChangeSelectionToEndOfRow(bool extend)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.Boolean
+
extend
+
true to extend the current selection (if any) instead of replacing
+
+
+
+
+
ChangeSelectionToEndOfTable(Boolean)
+
+Moves or extends the selection to the final cell in the table
+
+
+
Declaration
+
+
public void ChangeSelectionToEndOfTable(bool extend)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.Boolean
+
extend
+
true to extend the current selection (if any) instead of replacing
+
+
+
+
+
ChangeSelectionToStartOfRow(Boolean)
+
+Moves or extends the selection to the first cell in the current row
+
+
+
Declaration
+
+
public void ChangeSelectionToStartOfRow(bool extend)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.Boolean
+
extend
+
true to extend the current selection (if any) instead of replacing
+
+
+
+
+
ChangeSelectionToStartOfTable(Boolean)
+
+Moves or extends the selection to the first cell in the table (0,0)
+
+
+
Declaration
+
+
public void ChangeSelectionToStartOfTable(bool extend)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.Boolean
+
extend
+
true to extend the current selection (if any) instead of replacing
+
+
+
+
+
EnsureSelectedCellIsVisible()
+
+Updates scroll offsets to ensure that the selected cell is visible. Has no effect if Table has not been set.
+
+
+
Declaration
+
+
public void EnsureSelectedCellIsVisible()
+
+
Remarks
+
Changes will not be immediately visible in the display until you call SetNeedsDisplay()
+
+
EnsureValidScrollOffsets()
+
+Updates ColumnOffset and RowOffset where they are outside the bounds of the table (by adjusting them to the nearest existing cell). Has no effect if Table has not been set.
+
+
+
Declaration
+
+
public void EnsureValidScrollOffsets()
+
+
Remarks
+
Changes will not be immediately visible in the display until you call SetNeedsDisplay()
+
+
EnsureValidSelection()
+
+Updates SelectedColumn, SelectedRow and MultiSelectedRegions where they are outside the bounds of the table (by adjusting them to the nearest existing cell). Has no effect if Table has not been set.
+
+
+
Declaration
+
+
public void EnsureValidSelection()
+
+
Remarks
+
Changes will not be immediately visible in the display until you call SetNeedsDisplay()
true to extend the current selection (if any) instead of replacing
+
+
+
+
+
PageUp(Boolean)
+
+Moves the selection up by one page
+
+
+
Declaration
+
+
public void PageUp(bool extend)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.Boolean
+
extend
+
true to extend the current selection (if any) instead of replacing
+
+
+
+
+
PositionCursor()
+
+Positions the cursor in the area of the screen in which the start of the active cell is rendered. Calls base implementation if active cell is not visible due to scrolling or table is loaded etc
+
+Override to provide custom multi colouring to cells. Use Driver to
+with AddStr(ustring). The driver will already be
+in the correct place when rendering and you must render the full render
+or the view will not look right. For simpler provision of color use ColorGetter
+For changing the content that is rendered use RepresentationGetter
+
+Returns the column and row of Table that corresponds to a given point on the screen (relative to the control client area). Returns null if the point is in the header, no table is loaded or outside the control bounds
+
+
+
Declaration
+
+
public Point? ScreenToCell(int clientX, int clientY)
+Indicates whatever the text has history changes or not.
+true if the text has history changes false otherwise.
+
+
+
Declaration
+
+
public bool HasHistoryChanges { get; }
+
+
Property Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Boolean
+
+
+
+
+
+
IsDirty
+
+Indicates whatever the text was changed or not.
+true if the text was changed false otherwise.
+
+
+
Declaration
+
+
public bool IsDirty { 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
+
+
+
+
+
+
ScrollOffset
+
+Gets the left offset position.
+
+
+
Declaration
+
+
public int ScrollOffset { get; }
+
+
Property Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Int32
+
+
+
+
+
+
Secret
+
+Sets the secret property.
+
+
+
Declaration
+
+
public bool Secret { get; set; }
+
+
Property Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Boolean
+
+
+
+
+
Remarks
+
+This makes the text entry suitable for entering passwords.
+
+
+
SelectedLength
+
+Length of the selected text.
+
+
+
Declaration
+
+
public int SelectedLength { get; }
+
+
Property Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Int32
+
+
+
+
+
+
SelectedStart
+
+Start position of the selected text.
+
+
+
Declaration
+
+
public int SelectedStart { get; set; }
+
+
Property Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Int32
+
+
+
+
+
+
SelectedText
+
+The selected text.
+
+
+
Declaration
+
+
public ustring SelectedText { get; }
+
+
Property Value
+
+
+
+
Type
+
Description
+
+
+
+
+
NStack.ustring
+
+
+
+
+
+
Text
+
+Sets or gets the text held by the view.
+
+
+
Declaration
+
+
public ustring Text { get; set; }
+
+
Property Value
+
+
+
+
Type
+
Description
+
+
+
+
+
NStack.ustring
+
+
+
+
+
Remarks
+
+
+
+
Used
+
+Tracks whether the text field should be considered "used", that is, that the user has moved in the entry, so new input should be appended at the cursor position, rather than clearing the entry
+
+
+
Declaration
+
+
public bool Used { get; set; }
+
+
Property Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Boolean
+
+
+
+
+
Methods
+
+
+
ClearAllSelection()
+
+Clear the selected text.
+
+
+
Declaration
+
+
public void ClearAllSelection()
+
+
+
ClearHistoryChanges()
+
+Allows clearing the Terminal.Gui.HistoryText.HistoryTextItem items updating the original text.
+
+
+
Declaration
+
+
public void ClearHistoryChanges()
+
+
+
Copy()
+
+Copy the selected text to the clipboard.
+
+
+
Declaration
+
+
public virtual void Copy()
+
+
+
Cut()
+
+Cut the selected text to the clipboard.
+
+
+
Declaration
+
+
public virtual void Cut()
+
+
+
DeleteAll()
+
+Deletes all text.
+
+
+
Declaration
+
+
public void DeleteAll()
+
+
+
DeleteCharLeft(Boolean)
+
+Deletes the left character.
+
+
+
Declaration
+
+
public virtual void DeleteCharLeft(bool useOldCursorPos = true)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.Boolean
+
useOldCursorPos
+
+
+
+
+
+
DeleteCharRight()
+
+Deletes the right character.
+
+
+
Declaration
+
+
public virtual void DeleteCharRight()
+
+
+
InsertText(String, Boolean)
+
+Inserts the given toAdd text at the current cursor position
+exactly as if the user had just typed it
+
+
+
Declaration
+
+
public void InsertText(string toAdd, bool useOldCursorPos = true)
+Renders an overlay on another view at a given point that allows selecting
+from a range of 'autocomplete' options.
+An implementation on a TextField.
+
+Used by Text to resize the view's Bounds with the Size.
+Setting AutoSize to true only work if the Width and Height are null or
+Absolute values and doesn't work with Computed layout,
+to avoid breaking the Pos and Dim settings.
+
+
+
Declaration
+
+
public bool AutoSize { get; set; }
+
+
Property Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Boolean
+
+
+
+
+
+
CursorPosition
+
+Gets the cursor position from HotKey. If the HotKey is defined, the cursor will be positioned over it.
+
+The position in the text of the hotkey. The hotkey will be rendered using the hot color.
+
+
+
Declaration
+
+
public int HotKeyPos { get; set; }
+
+
Property Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Int32
+
+
+
+
+
+
HotKeySpecifier
+
+The specifier character for the hotkey (e.g. '_'). Set to '\xffff' to disable hotkey support for this View instance. The default is '\xffff'.
+
+
+
Declaration
+
+
public Rune HotKeySpecifier { get; set; }
+
+
Property Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Rune
+
+
+
+
+
+
HotKeyTagMask
+
+Specifies the mask to apply to the hotkey to tag it as the hotkey. The default value of 0x100000 causes
+the underlying Rune to be identified as a "private use" Unicode character.
+
Specifies the screen-relative location and maximum container size.
+
+
+
+
+
FindHotKey(ustring, Rune, Boolean, out Int32, out Key)
+
+Finds the hotkey and its location in text.
+
+
+
Declaration
+
+
public static bool FindHotKey(ustring text, Rune hotKeySpecifier, bool firstUpperCase, out int hotPos, out Key hotKey)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
NStack.ustring
+
text
+
The text to look in.
+
+
+
System.Rune
+
hotKeySpecifier
+
The hotkey specifier (e.g. '_') to look for.
+
+
+
System.Boolean
+
firstUpperCase
+
If true the legacy behavior of identifying the first upper case character as the hotkey will be enabled.
+Regardless of the value of this parameter, hotKeySpecifier takes precedence.
+Reformats text into lines, applying text alignment and optionally wrapping text to new lines on word boundaries.
+
+
+
Declaration
+
+
public static List<ustring> Format(ustring text, int width, bool justify, bool wordWrap, bool preserveTrailingSpaces = false, int tabWidth = 0, TextDirection textDirection = TextDirection.LeftRight_TopBottom)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
NStack.ustring
+
text
+
+
+
+
System.Int32
+
width
+
The width to bound the text to for word wrapping and clipping.
+
+
+
System.Boolean
+
justify
+
Specifies whether the text should be justified.
+
+
+
System.Boolean
+
wordWrap
+
If true, the text will be wrapped to new lines as need. If false, forces text to fit a single line. Line breaks are converted to spaces. The text will be clipped to width
+
+
+
System.Boolean
+
preserveTrailingSpaces
+
If true and 'wordWrap' also true, the wrapped text will keep the trailing spaces. If false, the trailing spaces will be trimmed.
Specifies how the text will be aligned horizontally.
+
+
+
System.Boolean
+
wordWrap
+
If true, the text will be wrapped to new lines as need. If false, forces text to fit a single line. Line breaks are converted to spaces. The text will be clipped to width
+
+
+
System.Boolean
+
preserveTrailingSpaces
+
If true and 'wordWrap' also true, the wrapped text will keep the trailing spaces. If false, the trailing spaces will be trimmed.
+Justifies the text to fill the width provided. Space will be added between words (demarked by spaces and tabs) to
+make the text just fit width. Spaces will not be added to the ends.
+
+
+
Declaration
+
+
public static ustring Justify(ustring text, int width, char spaceChar = ' ', TextDirection textDirection = TextDirection.LeftRight_TopBottom)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
NStack.ustring
+
text
+
+
+
+
System.Int32
+
width
+
+
+
+
System.Char
+
spaceChar
+
Character to replace whitespace and pad with. For debugging purposes.
+Computes the number of lines needed to render the specified text given the width.
+
+
+
Declaration
+
+
public static int MaxLines(ustring text, int width)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
NStack.ustring
+
text
+
Text, may contain newlines.
+
+
+
System.Int32
+
width
+
The minimum width for the text.
+
+
+
+
Returns
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Int32
+
Number of lines.
+
+
+
+
+
MaxWidth(ustring, Int32)
+
+Computes the maximum width needed to render the text (single line or multiple lines) given a minimum width.
+
+
+
Declaration
+
+
public static int MaxWidth(ustring text, int width)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
NStack.ustring
+
text
+
Text, may contain newlines.
+
+
+
System.Int32
+
width
+
The minimum width for the text.
+
+
+
+
Returns
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Int32
+
Max width of lines.
+
+
+
+
+
RemoveHotKeySpecifier(ustring, Int32, Rune)
+
+Removes the hotkey specifier from text.
+
+
+
Declaration
+
+
public static ustring RemoveHotKeySpecifier(ustring text, int hotPos, Rune hotKeySpecifier)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
NStack.ustring
+
text
+
The text to manipulate.
+
+
+
System.Int32
+
hotPos
+
Returns the position of the hot-key in the text. -1 if not found.
+
+
+
System.Rune
+
hotKeySpecifier
+
The hot-key specifier (e.g. '_') to look for.
+
+
+
+
Returns
+
+
+
+
Type
+
Description
+
+
+
+
+
NStack.ustring
+
The input text with the hotkey specifier ('_') removed.
+
+
+
+
+
ReplaceHotKeyWithTag(ustring, Int32)
+
+Replaces the Rune at the index specified by the hotPos parameter with a tag identifying
+it as the hotkey.
+
+
+
Declaration
+
+
public ustring ReplaceHotKeyWithTag(ustring text, int hotPos)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
NStack.ustring
+
text
+
The text to tag the hotkey in.
+
+
+
System.Int32
+
hotPos
+
The Rune index of the hotkey in text.
+
+
+
+
Returns
+
+
+
+
Type
+
Description
+
+
+
+
+
NStack.ustring
+
The text with the hotkey tagged.
+
+
+
+
Remarks
+
+The returned string will not render correctly without first un-doing the tag. To undo the tag, search for
+Runes with a bitmask of otKeyTagMask and remove that bitmask.
+
public class TextView : View, IDisposable, ISupportInitializeNotification, ISupportInitialize
+
+
Remarks
+
+
+TextView provides a multi-line text editor. Users interact
+with it with the standard Emacs commands for movement or the arrow
+keys.
+
+
Shortcut
Action performed
Left cursor, Control-b
+ Moves the editing point left.
+
Right cursor, Control-f
+ Moves the editing point right.
+
Alt-b
+ Moves one word back.
+
Alt-f
+ Moves one word forward.
+
Up cursor, Control-p
+ Moves the editing point one line up.
+
Down cursor, Control-n
+ Moves the editing point one line down
+
Home key, Control-a
+ Moves the cursor to the beginning of the line.
+
End key, Control-e
+ Moves the cursor to the end of the line.
+
Control-Home
+ Scrolls to the first line and moves the cursor there.
+
Control-End
+ Scrolls to the last line and moves the cursor there.
+
Delete, Control-d
+ Deletes the character in front of the cursor.
+
Backspace
+ Deletes the character behind the cursor.
+
Control-k
+ Deletes the text until the end of the line and replaces the kill buffer
+ with the deleted text. You can paste this text in a different place by
+ using Control-y.
+
Control-y
+ Pastes the content of the kill ring into the current position.
+
Alt-d
+ Deletes the word above the cursor and adds it to the kill ring. You
+ can paste the contents of the kill ring with Control-y.
+
Control-q
+ Quotes the next input character, to prevent the normal processing of
+ key handling to take place.
+
+
+
Constructors
+
+
+
TextView()
+
+Initializes a TextView on the specified area,
+with dimensions controlled with the X, Y, Width and Height properties.
+
+
+
Declaration
+
+
public TextView()
+
+
+
TextView(Rect)
+
+Initializes a TextView on the specified area, with absolute position and size.
+
+Gets or sets a value indicating whether pressing ENTER in a TextView
+creates a new line of text in the view or activates the default button for the toplevel.
+
+
+
Declaration
+
+
public bool AllowsReturn { get; set; }
+
+
Property Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Boolean
+
+
+
+
+
+
AllowsTab
+
+Gets or sets whether the TextView inserts a tab character into the text or ignores
+tab input. If set to `false` and the user presses the tab key (or shift-tab) the focus will move to the
+next view (or previous with shift-tab). The default is `true`; if the user presses the tab key, a tab
+character will be inserted into the text.
+
+
+
Declaration
+
+
public bool AllowsTab { get; set; }
+
+
Property Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Boolean
+
+
+
+
+
+
Autocomplete
+
+Provides autocomplete context menu based on suggestions at the current cursor
+position. Populate AllSuggestions to enable this feature
+
+
+
Declaration
+
+
public IAutocomplete Autocomplete { get; protected set; }
+Tracks whether the text view should be considered "used", that is, that the user has moved in the entry,
+so new input should be appended at the cursor position, rather than clearing the entry
+
+
+
Declaration
+
+
public bool Used { get; set; }
+
+
Property Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Boolean
+
+
+
+
+
+
WordWrap
+
+Allows word wrap the to fit the available container width.
+
+
+
Declaration
+
+
public bool WordWrap { get; set; }
+
+
Property Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Boolean
+
+
+
+
+
Methods
+
+
+
ClearHistoryChanges()
+
+Allows clearing the Terminal.Gui.HistoryText.HistoryTextItem items updating the original text.
+
+
+
Declaration
+
+
public void ClearHistoryChanges()
+
+
+
CloseFile()
+
+Closes the contents of the stream into the TextView.
+
+
+
Declaration
+
+
public bool CloseFile()
+
+
Returns
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Boolean
+
true, if stream was closed, false otherwise.
+
+
+
+
+
ColorNormal()
+
+Sets the driver to the default color for the control where no text is being rendered. Defaults to Normal.
+
+
+
Declaration
+
+
protected virtual void ColorNormal()
+
+
+
ColorNormal(List<Rune>, Int32)
+
+Sets the Driver to an appropriate color for rendering the given idx of the
+current line. Override to provide custom coloring by calling SetAttribute(Attribute)
+Defaults to Normal.
+
+
+
Declaration
+
+
protected virtual void ColorNormal(List<Rune> line, int idx)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.Collections.Generic.List<System.Rune>
+
line
+
+
+
+
System.Int32
+
idx
+
+
+
+
+
+
ColorSelection(List<Rune>, Int32)
+
+Sets the Driver to an appropriate color for rendering the given idx of the
+current line. Override to provide custom coloring by calling SetAttribute(Attribute)
+Defaults to Focus.
+
+
+
Declaration
+
+
protected virtual void ColorSelection(List<Rune> line, int idx)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.Collections.Generic.List<System.Rune>
+
line
+
+
+
+
System.Int32
+
idx
+
+
+
+
+
+
ColorUsed(List<Rune>, Int32)
+
+Sets the Driver to an appropriate color for rendering the given idx of the
+current line. Override to provide custom coloring by calling SetAttribute(Attribute)
+Defaults to HotFocus.
+
+
+
Declaration
+
+
protected virtual void ColorUsed(List<Rune> line, int idx)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.Collections.Generic.List<System.Rune>
+
line
+
+
+
+
System.Int32
+
idx
+
+
+
+
+
+
Copy()
+
+Copy the selected text to the clipboard contents.
+
+
+
Declaration
+
+
public void Copy()
+
+
+
Cut()
+
+Cut the selected text to the clipboard contents.
+
+
+
Declaration
+
+
public void Cut()
+
+
+
DeleteAll()
+
+Deletes all text.
+
+
+
Declaration
+
+
public void DeleteAll()
+
+
+
DeleteCharLeft()
+
+Deletes all the selected or a single character at left from the position of the cursor.
+
+
+
Declaration
+
+
public void DeleteCharLeft()
+
+
+
DeleteCharRight()
+
+Deletes all the selected or a single character at right from the position of the cursor.
+
+
+
Declaration
+
+
public void DeleteCharRight()
+
+
+
FindNextText(ustring, out Boolean, Boolean, Boolean, ustring, Boolean)
+
+Find the next text based on the match case with the option to replace it.
+
trueIf all the text was backward searched.falseotherwise.
+
+
+
System.Boolean
+
matchCase
+
The match case setting.
+
+
+
System.Boolean
+
matchWholeWord
+
The match whole word setting.
+
+
+
NStack.ustring
+
textToReplace
+
The text to replace.
+
+
+
System.Boolean
+
replace
+
trueIf the text was found.falseotherwise.
+
+
+
+
Returns
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Boolean
+
trueIf the text was found.falseotherwise.
+
+
+
+
+
FindTextChanged()
+
+Reset the flag to stop continuous find.
+
+
+
Declaration
+
+
public void FindTextChanged()
+
+
+
GetCurrentLine()
+
+Returns the characters on the current line (where the cursor is positioned).
+Use CurrentColumn to determine the position of the cursor within
+that line
+
+
+
Declaration
+
+
public List<Rune> GetCurrentLine()
+
+
Returns
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Collections.Generic.List<System.Rune>
+
+
+
+
+
+
InsertText(String)
+
+Inserts the given toAdd text at the current cursor position
+exactly as if the user had just typed it
+
+
+
Declaration
+
+
public void InsertText(string toAdd)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.String
+
toAdd
+
Text to add
+
+
+
+
+
LoadFile(String)
+
+Loads the contents of the file into the TextView.
+
+
+
Declaration
+
+
public bool LoadFile(string path)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.String
+
path
+
Path to the file to load.
+
+
+
+
Returns
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Boolean
+
true, if file was loaded, false otherwise.
+
+
+
+
+
LoadStream(Stream)
+
+Loads the contents of the stream into the TextView.
+
+Will scroll the TextView to display the specified row at the top if isRow is true or
+will scroll the TextView to display the specified column at the left if isRow is false.
+
+
+
Declaration
+
+
public void ScrollTo(int idx, bool isRow = true)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.Int32
+
idx
+
Row that should be displayed at the top or Column that should be displayed at the left,
+ if the value is negative it will be reset to zero
+
+
+
System.Boolean
+
isRow
+
If true (default) the idx is a row, column otherwise.
+Renders an overlay on another view at a given point that allows selecting
+from a range of 'autocomplete' options.
+An implementation on a TextView.
+
+Describes the thickness of a frame around a rectangle. Four System.Int32 values describe
+the Left, Top, Right, and Bottom sides
+of the rectangle, respectively.
+
+Initializes a new instance of the Thickness structure that has the
+specified uniform length on each side.
+
+
+
Declaration
+
+
public Thickness(int length)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.Int32
+
length
+
+
+
+
+
+
Thickness(Int32, Int32, Int32, Int32)
+
+Initializes a new instance of the Thickness structure that has specific
+lengths (supplied as a System.Int32) applied to each side of the rectangle.
+
+
+
Declaration
+
+
public Thickness(int left, int top, int right, int bottom)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.Int32
+
left
+
+
+
+
System.Int32
+
top
+
+
+
+
System.Int32
+
right
+
+
+
+
System.Int32
+
bottom
+
+
+
+
+
Fields
+
+
Bottom
+
+Gets or sets the width, in integers, of the lower side of the bounding rectangle.
+
+
+
Declaration
+
+
public int Bottom
+
+
Field Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Int32
+
+
+
+
+
Left
+
+Gets or sets the width, in integers, of the left side of the bounding rectangle.
+
+
+
Declaration
+
+
public int Left
+
+
Field Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Int32
+
+
+
+
+
Right
+
+Gets or sets the width, in integers, of the right side of the bounding rectangle.
+
+
+
Declaration
+
+
public int Right
+
+
Field Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Int32
+
+
+
+
+
Top
+
+Gets or sets the width, in integers, of the upper side of the bounding rectangle.
+
+
+
Declaration
+
+
public int Top
+
+
Field Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Int32
+
+
+
+
+
Methods
+
+
+
ToString()
+
Returns the fully qualified type name of this instance.
+ Toplevels can also opt-in to more sophisticated initialization
+ by implementing System.ComponentModel.ISupportInitialize. When they do
+ so, the System.ComponentModel.ISupportInitialize.BeginInit() and
+System.ComponentModel.ISupportInitialize.EndInit() methods will be called
+before running the view.
+If first-run-only initialization is preferred, the System.ComponentModel.ISupportInitializeNotification
+can be implemented too, in which case the System.ComponentModel.ISupportInitialize
+methods will only be called if System.ComponentModel.ISupportInitializeNotification.IsInitialized
+is false. This allows proper View inheritance hierarchies
+to override base class layout code optimally by doing so only on first run,
+instead of on every run.
+
+
+
Constructors
+
+
+
Toplevel()
+
+Initializes a new instance of the Toplevel class with Computed layout, defaulting to full screen.
+
+
+
Declaration
+
+
public Toplevel()
+
+
+
Toplevel(Rect)
+
+Initializes a new instance of the Toplevel class with the specified absolute layout.
+
+Fired once the Toplevel's MainLoop has started it's first iteration.
+Subscribe to this event to perform tasks when the Toplevel has been laid out and focus has been set.
+changes. A Ready event handler is a good place to finalize initialization after calling `Run(Func<Exception, Boolean>)(topLevel)`.
+
+
+
Declaration
+
+
public event Action Ready
+
+
Event Type
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Action
+
+
+
+
+
Resized
+
+Invoked when the terminal was resized. The new Size of the terminal is provided.
+
A signed integer that indicates the relative values of x and y, as shown in the following table.Value Meaning Less than zero
+x is less than y.Zero
+x equals y.Greater than zero
+x is greater than y.
public class TreeView<T> : View, IDisposable, ISupportInitializeNotification, ISupportInitialize, ITreeView where T : class
+
+
Type Parameters
+
+
+
+
Name
+
Description
+
+
+
+
+
T
+
+
+
+
+
Constructors
+
+
+
TreeView()
+
+Creates a new tree view with absolute positioning.
+Use AddObjects(IEnumerable<T>) to set set root objects for the tree.
+Children will not be rendered until you set TreeBuilder
+
+
+
Declaration
+
+
public TreeView()
+
+
+
TreeView(ITreeBuilder<T>)
+
+Initialises TreeBuilder.Creates a new tree view with absolute
+positioning. Use AddObjects(IEnumerable<T>) to set set root
+objects for the tree.
+
+Collapses the supplied object if it is currently expanded
+
+
+
Declaration
+
+
public void Collapse(T toCollapse)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
T
+
toCollapse
+
The object to collapse
+
+
+
+
+
CollapseAll()
+
+Collapses all root nodes in the tree
+
+
+
Declaration
+
+
public void CollapseAll()
+
+
+
CollapseAll(T)
+
+Collapses the supplied object if it is currently expanded. Also collapses all children
+branches (this will only become apparent when/if the user expands it again)
+
+
+
Declaration
+
+
public void CollapseAll(T toCollapse)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
T
+
toCollapse
+
The object to collapse
+
+
+
+
+
CollapseImpl(T, Boolean)
+
+Implementation of Collapse(T) and CollapseAll(T). Performs
+operation and updates selection if disapeared
+
+Determines systems behaviour when the left arrow key is pressed. Default behaviour is
+to collapse the current tree node if possible otherwise changes selection to current
+branches parent
+
+
+
Declaration
+
+
protected virtual void CursorLeft(bool ctrl)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.Boolean
+
ctrl
+
+
+
+
+
+
EnsureVisible(T)
+
+Adjusts the ScrollOffsetVertical to ensure the given
+model is visible. Has no effect if already visible
+
+Returns the currently expanded children of the passed object. Returns an empty
+collection if the branch is not exposed or not expanded
+
+
+
Declaration
+
+
public IEnumerable<T> GetChildren(T o)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
T
+
o
+
An object in the tree
+
+
+
+
Returns
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Collections.Generic.IEnumerable<T>
+
+
+
+
+
+
GetContentWidth(Boolean)
+
+Returns the maximum width line in the tree including prefix and expansion symbols
+
+
+
Declaration
+
+
public int GetContentWidth(bool visible)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.Boolean
+
visible
+
True to consider only rows currently visible (based on window
+ bounds and ScrollOffsetVertical. False to calculate the width of
+every exposed branch in the tree
+
+
+
+
Returns
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Int32
+
+
+
+
+
+
GetObjectOnRow(Int32)
+
+Returns the object in the tree list that is currently visible
+at the provided row. Returns null if no object is at that location.
+
+
+If you have screen coordinates then use ScreenToView(Int32, Int32)
+to translate these into the client area of the TreeView<T>.
+
The object currently displayed on this row or null
+
+
+
+
+
GetObjectRow(T)
+
+
+Returns the Y coordinate within the Bounds of the
+tree at which toFind would be displayed or null if
+it is not currently exposed (e.g. its parent is collapsed).
+
+
+Note that the returned value can be negative if the TreeView is scrolled
+down and the toFind object is off the top of the view.
+
+
+
+
Declaration
+
+
public int? GetObjectRow(T toFind)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
T
+
toFind
+
+
+
+
+
Returns
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Nullable<System.Int32>
+
+
+
+
+
+
GetParent(T)
+
+Returns the parent object of o in the tree. Returns null if
+the object is not exposed in the tree
+
+
+
Declaration
+
+
public T GetParent(T o)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
T
+
o
+
An object in the tree
+
+
+
+
Returns
+
+
+
+
Type
+
Description
+
+
+
+
+
T
+
+
+
+
+
+
GetScrollOffsetOf(T)
+
+Returns the index of the object o if it is currently exposed (it's
+parent(s) have been expanded). This can be used with ScrollOffsetVertical
+and SetNeedsDisplay() to scroll to a specific object
+
+
+
Declaration
+
+
public int GetScrollOffsetOf(T o)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
T
+
o
+
An object that appears in your tree and is currently exposed
+
+
+
+
Returns
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Int32
+
The index the object was found at or -1 if it is not currently revealed or
+not in the tree at all
+
+
+
+
Remarks
+
Uses the Equals method and returns the first index at which the object is found
+ or -1 if it is not found
+
+
GoTo(T)
+
+Changes the SelectedObject to toSelect and scrolls to ensure
+it is visible. Has no effect if toSelect is not exposed in the tree (e.g.
+its parents are collapsed)
+
+
+
Declaration
+
+
public void GoTo(T toSelect)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
T
+
toSelect
+
+
+
+
+
+
GoToEnd()
+
+Changes the SelectedObject to the last object in the tree and scrolls so
+that it is visible
+
+Rebuilds the tree structure for all exposed objects starting with the root objects.
+Call this method when you know there are changes to the tree but don't know which
+objects have changed (otherwise use RefreshObject(T, Boolean))
+
+Constructs an implementation of ITreeBuilder<T> that calls the user
+defined method childGetter to determine children
+and canExpand to determine expandability
+
+
+
Declaration
+
+
public DelegateTreeBuilder(Func<T, IEnumerable<T>> childGetter, Func<T, bool> canExpand)
+Returns true if CanExpand(T) is implemented by this class
+
+
+
Declaration
+
+
bool SupportsCanExpand { get; }
+
+
Property Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Boolean
+
+
+
+
+
Methods
+
+
+
CanExpand(T)
+
+Returns true/false for whether a model has children. This method should be implemented
+when GetChildren(T) is an expensive operation otherwise
+SupportsCanExpand should return false (in which case this method will not
+be called)
+
+
+
Declaration
+
+
bool CanExpand(T toExpand)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
T
+
toExpand
+
+
+
+
+
Returns
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Boolean
+
+
+
+
+
Remarks
+
Only implement this method if you have a very fast way of determining whether
+an object can have children e.g. checking a Type (directories can always be expanded)
+
+
+
GetChildren(T)
+
+Returns all children of a given forObject which should be added to the
+tree as new branches underneath it
+
+Interface to implement when you want the regular (non generic) TreeView
+to automatically determine children for your class (without having to specify
+an ITreeBuilder<T>)
+
Pass true if you intend to
+implement CanExpand(T) otherwise false
+
+
+
+
Properties
+
+
+
SupportsCanExpand
+
+
+
Declaration
+
+
public bool SupportsCanExpand { get; protected set; }
+
+
Property Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Boolean
+
+
+
+
+
Methods
+
+
+
CanExpand(T)
+
+Override this method to return a rapid answer as to whether GetChildren(T)
+returns results. If you are implementing this method ensure you passed true in base
+constructor or set SupportsCanExpand
+
+
+
Declaration
+
+
public virtual bool CanExpand(T toExpand)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
T
+
toExpand
+
+
+
+
+
Returns
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Boolean
+
+
+
+
+
+
GetChildren(T)
+
+
+
Declaration
+
+
public abstract IEnumerable<T> GetChildren(T forObject)
+Symbol to use for branch nodes that can be collapsed (are currently expanded).
+Defaults to '-'. Set to null to hide
+
+
+
Declaration
+
+
public Rune? CollapseableSymbol { get; set; }
+
+
Property Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Nullable<System.Rune>
+
+
+
+
+
+
ColorExpandSymbol
+
+Set to true to highlight expand/collapse symbols in hot key color
+
+
+
Declaration
+
+
public bool ColorExpandSymbol { get; set; }
+
+
Property Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Boolean
+
+
+
+
+
+
ExpandableSymbol
+
+Symbol to use for branch nodes that can be expanded to indicate this to the user.
+Defaults to '+'. Set to null to hide
+
+
+
Declaration
+
+
public Rune? ExpandableSymbol { get; set; }
+
+
Property Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Nullable<System.Rune>
+
+
+
+
+
+
InvertExpandSymbolColors
+
+Invert console colours used to render the expand symbol
+
+
+
Declaration
+
+
public bool InvertExpandSymbolColors { get; set; }
+
+
Property Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Boolean
+
+
+
+
+
+
LeaveLastRow
+
+True to leave the last row of the control free for overwritting (e.g. by a scrollbar)
+When True scrolling will be triggered on the second last row of the control rather than
+the last.
+
+
+
Declaration
+
+
public bool LeaveLastRow { get; set; }
+
+
Property Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Boolean
+
+
+
+
+
+
ShowBranchLines
+
+True to render vertical lines under expanded nodes to show which node belongs to which
+parent. False to use only whitespace
+
+
+Interface to implement when you want the regular (non generic) TreeView
+to automatically determine children for your class (without having to specify
+an ITreeBuilder<T>)
+
+
+Indicates if the current focus event has already been processed and the driver should stop notifying any other event subscriber.
+Its important to set this value to true specially when updating any View's layout from inside the subscriber method.
+
+
+
Declaration
+
+
public bool Handled { get; set; }
+
+
Property Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Boolean
+
+
+
+
+
+
View
+
+Indicates the current view that gets or loses focus.
+
+Indicates if the current Key event has already been processed and the driver should stop notifying any other event subscriber.
+Its important to set this value to true specially when updating any View's layout from inside the subscriber method.
+
+Indicates if the current mouse event has already been processed and the driver should stop notifying any other event subscriber.
+Its important to set this value to true specially when updating any View's layout from inside the subscriber method.
+
public class View : Responder, IDisposable, ISupportInitializeNotification, ISupportInitialize
+
+
Remarks
+
+
+ The View defines the base functionality for user interface elements in Terminal.Gui. Views
+ can contain one or more subviews, can respond to user input and render themselves on the screen.
+
+
+ Views supports two layout styles: Absolute or Computed. The choice as to which layout style is used by the View
+ is determined when the View is initialized. To create a View using Absolute layout, call a constructor that takes a
+ Rect parameter to specify the absolute position and size (the View.Frame)/. To create a View
+ using Computed layout use a constructor that does not take a Rect parameter and set the X, Y, Width and Height
+ properties on the view. Both approaches use coordinates that are relative to the container they are being added to.
+
+
+ To switch between Absolute and Computed layout, use the LayoutStyle property.
+
+
+ Computed layout is more flexible and supports dynamic console apps where controls adjust layout
+ as the terminal resizes or other Views change size or position. The X, Y, Width and Height
+ properties are Dim and Pos objects that dynamically update the position of a view.
+ The X and Y properties are of type Pos
+ and you can use either absolute positions, percentages or anchor
+ points. The Width and Height properties are of type
+Dim and can use absolute position,
+percentages and anchors. These are useful as they will take
+care of repositioning views when view's frames are resized or
+if the terminal size changes.
+
+
+ Absolute layout requires specifying coordinates and sizes of Views explicitly, and the
+ View will typically stay in a fixed position and size. To change the position and size use the
+Frame property.
+
+
+ Subviews (child views) can be added to a View by calling the Add(View) method.
+ The container of a View can be accessed with the SuperView property.
+
+ Views have a ColorScheme property that defines the default colors that subviews
+ should use for rendering. This ensures that the views fit in the context where
+ they are being used, and allows for themes to be plugged in. For example, the
+ default colors for windows and toplevels uses a blue background, while it uses
+ a white background for dialog boxes and a red background for errors.
+
+
+ Subclasses should not rely on ColorScheme being
+ set at construction time. If a ColorScheme is not set on a view, the view will inherit the
+ value from its SuperView and the value might only be valid once a view has been
+ added to a SuperView.
+
+
+ By using ColorScheme applications will work both
+ in color as well as black and white displays.
+
+
+ Views that are focusable should implement the PositionCursor() to make sure that
+ the cursor is placed in a location that makes sense. Unix terminals do not have
+ a way of hiding the cursor, so it can be distracting to have the cursor left at
+ the last focused view. So views should make sure that they place the cursor
+ in a visually sensible place.
+
+
+ The LayoutSubviews() method is invoked when the size or layout of a view has
+ changed. The default processing system will keep the size and dimensions
+ for views that use the Absolute, and will recompute the
+ frames for the vies that use Computed.
+
+
+
Constructors
+
+
+
View()
+
+Initializes a new instance of View using Computed layout.
+
+
+
Declaration
+
+
public View()
+
+
Remarks
+
+
+ Use X, Y, Width, and Height properties to dynamically control the size and location of the view.
+ The Label will be created using Computed
+ coordinates. The initial size (Frame will be
+ adjusted to fit the contents of Text, including newlines ('\n') for multiple lines.
+
+
+ If Height is greater than one, word wrapping is provided.
+
+
+ This constructor initialize a View with a LayoutStyle of Computed.
+ Use X, Y, Width, and Height properties to dynamically control the size and location of the view.
+
+
+
+
View(ustring, TextDirection, Border)
+
+Initializes a new instance of View using Computed layout.
+
+
+
Declaration
+
+
public View(ustring text, TextDirection direction = TextDirection.LeftRight_TopBottom, Border border = null)
+ The View will be created using Computed
+ coordinates with the given string. The initial size (Frame will be
+ adjusted to fit the contents of Text, including newlines ('\n') for multiple lines.
+
+
+ If Height is greater than one, word wrapping is provided.
+
+
+
+
View(Int32, Int32, ustring)
+
+Initializes a new instance of View using Absolute layout.
+
+ The View will be created at the given
+ coordinates with the given string. The size (Frame will be
+ adjusted to fit the contents of Text, including newlines ('\n') for multiple lines.
+
+
+ No line wrapping is provided.
+
+
+
+
View(Rect)
+
+Initializes a new instance of a AbsoluteView class with the absolute
+dimensions specified in the frame parameter.
+
+ The View will be created at the given
+ coordinates with the given string. The initial size (Frame will be
+ adjusted to fit the contents of Text, including newlines ('\n') for multiple lines.
+
+
+ If rect.Height is greater than one, word wrapping is provided.
+
+
+
Properties
+
+
+
AutoSize
+
+Gets or sets a flag that determines whether the View will be automatically resized to fit the Text.
+The default is `false`. Set to `true` to turn on AutoSize. If AutoSize is `true` the Width
+and Height will always be used if the text size is lower. If the text size is higher the bounds will
+be resized to fit it.
+In addition, if ForceValidatePosDim is `true` the new values of Width and
+Height must be of the same types of the existing one to avoid breaking the Dim settings.
+
+Updates to the Bounds update the Frame,
+and has the same side effects as updating the Frame.
+
+
+Because Bounds coordinates are relative to the upper-left corner of the View,
+the coordinates of the upper-left corner of the rectangle returned by this property are (0,0).
+Use this property to obtain the size and coordinates of the client area of the
+control for tasks such as drawing on the surface of the control.
+
+Gets or sets the HotKey defined for this view. A user pressing HotKey on the keyboard while this view has focus will cause the Clicked event to fire.
+
+Gets or sets the specifier character for the hotkey (e.g. '_'). Set to '\xffff' to disable hotkey support for this View instance. The default is '\xffff'.
+
+
+
Declaration
+
+
public virtual Rune HotKeySpecifier { get; set; }
+
+
Property Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Rune
+
+
+
+
+
+
Id
+
+Gets or sets an identifier for the view;
+
+
+
Declaration
+
+
public ustring Id { get; set; }
+
+
Property Value
+
+
+
+
Type
+
Description
+
+
+
+
+
NStack.ustring
+
The identifier.
+
+
+
+
Remarks
+
The id should be unique across all Views that share a SuperView.
+
+
IsAdded
+
+Gets information if the view was already added to the SuperView.
+
+
+
Declaration
+
+
public bool IsAdded { get; }
+
+
Property Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Boolean
+
+
+
+
+
+
IsCurrentTop
+
+Returns a value indicating if this View is currently on Top (Active)
+
+
+
Declaration
+
+
public bool IsCurrentTop { get; }
+
+
Property Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Boolean
+
+
+
+
+
+
IsInitialized
+
+Get or sets if the View was already initialized.
+This derived from System.ComponentModel.ISupportInitializeNotification to allow notify all the views that are being initialized.
+
+
+
Declaration
+
+
public virtual bool IsInitialized { get; set; }
+
+
Property Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Boolean
+
+
+
+
+
+
LayoutStyle
+
+Controls how the View's Frame is computed during the LayoutSubviews method, if the style is set to Absolute,
+LayoutSubviews does not change the Frame. If the style is Computed the Frame is updated using
+the X, Y, Width, and Height properties.
+
+ If provided, the text will be drawn before any subviews are drawn.
+
+
+ The text will be drawn starting at the view origin (0, 0) and will be formatted according
+ to the TextAlignment property. If the view's height is greater than 1, the
+ text will word-wrap to additional lines if it does not fit horizontally. If the view's height
+ is 1, the text will be clipped.
+
+Removes all key bindings that trigger the given command. Views can have multiple different
+keys bound to the same command and this method will clear all of them.
+
+Invoked when a view starts executing or when the dimensions of the view have changed, for example in
+response to the container view or terminal resizing.
+
+
+
Declaration
+
+
public virtual void LayoutSubviews()
+
+
Remarks
+
+Calls Terminal.Gui.View.OnLayoutComplete(Terminal.Gui.View.LayoutEventArgs) (which raises the LayoutComplete event) before it returns.
+
+
+
Move(Int32, Int32, Boolean)
+
+This moves the cursor to the specified column and row in the view.
+
+
+
Declaration
+
+
public void Move(int col, int row, bool clipped = true)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.Int32
+
col
+
Col.
+
+
+
System.Int32
+
row
+
Row.
+
+
+
System.Boolean
+
clipped
+
Whether to clip the result of the ViewToScreen method,
+ if set to true, the col, row values are clamped to the screen (terminal) dimensions (0..TerminalDim-1).
+
+
+
+
+
OnAdded(View)
+
+Method invoked when a subview is being added to this view.
+
+Event called only once when the View is being initialized for the first time.
+Allows configurations and assignments to be performed before the View being shown.
+This derived from System.ComponentModel.ISupportInitializeNotification to allow notify all the views that are being initialized.
+
+
+
Declaration
+
+
public event EventHandler Initialized
+
+
Event Type
+
+
+
+
Type
+
Description
+
+
+
+
+
System.EventHandler
+
+
+
+
+
KeyDown
+
+Invoked when a key is pressed
+
+
+
Declaration
+
+
public event Action<View.KeyEventEventArgs> KeyDown
public class Window : Toplevel, IDisposable, ISupportInitializeNotification, ISupportInitialize
+
+
Remarks
+
+The 'client area' of a Window is a rectangle deflated by one or more rows/columns from Bounds. A this time there is no
+API to determine this rectangle.
+
+
Constructors
+
+
+
Window()
+
+Initializes a new instance of the Window class using Computed positioning.
+
+
+
Declaration
+
+
public Window()
+
+
+
Window(ustring)
+
+Initializes a new instance of the Window class with an optional title using Computed positioning.
+
+
+
Declaration
+
+
public Window(ustring title = null)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
NStack.ustring
+
title
+
Title.
+
+
+
+
Remarks
+
+This constructor initializes a View with a LayoutStyle of Computed.
+Use X, Y, Width, and Height properties to dynamically control the size and location of the view.
+
+
+
Window(ustring, Int32, Border)
+
+Initializes a new instance of the Window using Computed positioning,
+and an optional title.
+
+
+
Declaration
+
+
public Window(ustring title = null, int padding = 0, Border border = null)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
NStack.ustring
+
title
+
Title.
+
+
+
System.Int32
+
padding
+
Number of characters to use for padding of the drawn frame.
+This constructor initializes a View with a LayoutStyle of Computed.
+Use X, Y, Width, and Height properties to dynamically control the size and location of the view.
+
+
+
Window(Rect, ustring)
+
+Initializes a new instance of the Window class with an optional title using Absolute positioning.
+
Superview-relative rectangle specifying the location and size
+
+
+
NStack.ustring
+
title
+
Title
+
+
+
+
Remarks
+
+This constructor initializes a Window with a LayoutStyle of Absolute. Use constructors
+that do not take Rect parameters to initialize a Window with Computed.
+
+
+
Window(Rect, ustring, Int32, Border)
+
+Initializes a new instance of the Window using Absolute positioning with the specified frame for its location, with the specified frame padding,
+and an optional title.
+
+
+
Declaration
+
+
public Window(Rect frame, ustring title = null, int padding = 0, Border border = null)
+This constructor initializes a Window with a LayoutStyle of Absolute. Use constructors
+that do not take Rect parameters to initialize a Window with LayoutStyle of Computed
+
+Represents a basic step that is displayed in a Wizard. The Wizard.WizardStep view is divided horizontally in two. On the left is the
+content view where Views can be added, On the right is the help for the step.
+Set HelpText to set the help text. If the help text is empty the help pane will not
+be shown.
+
+If there are no Views added to the WizardStep the HelpText (if not empty) will fill the wizard step.
+
public class WizardStep : FrameView, IDisposable, ISupportInitializeNotification, ISupportInitialize
+
+
Remarks
+
+If Buttons are added, do not set IsDefault to true as this will conflict
+with the Next button of the Wizard.
+
+Subscribe to the VisibleChanged event to be notified when the step is active; see also: StepChanged.
+
+To enable or disable a step from being shown to the user, set Enabled.
+
+
+
Constructors
+
+
+
WizardStep(ustring)
+
+Initializes a new instance of the Wizard class using Computed positioning.
+
+
+
Declaration
+
+
public WizardStep(ustring title)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
NStack.ustring
+
title
+
Title for the Step. Will be appended to the containing Wizard's title as
+"Wizard Title - Wizard Step Title" when this step is active.
+
+
+
+
Remarks
+
+
+
Properties
+
+
+
BackButtonText
+
+Sets or gets the text for the back button. The back button will only be visible on
+steps after the first step.
+
+
+
Declaration
+
+
public ustring BackButtonText { get; set; }
+
+
Property Value
+
+
+
+
Type
+
Description
+
+
+
+
+
NStack.ustring
+
+
+
+
+
Remarks
+
The default text is "Back"
+
+
HelpText
+
+Sets or gets help text for the Wizard.WizardStep.If HelpText is empty
+the help pane will not be visible and the content will fill the entire WizardStep.
+
+
+
Declaration
+
+
public ustring HelpText { get; set; }
+
+
Property Value
+
+
+
+
Type
+
Description
+
+
+
+
+
NStack.ustring
+
+
+
+
+
Remarks
+
The help text is displayed using a read-only TextView.
+
+
NextButtonText
+
+Sets or gets the text for the next/finish button.
+
+
+
Declaration
+
+
public ustring NextButtonText { get; set; }
+
+
Property Value
+
+
+
+
Type
+
Description
+
+
+
+
+
NStack.ustring
+
+
+
+
+
Remarks
+
The default text is "Next..." if the Pane is not the last pane. Otherwise it is "Finish"
+Provides navigation and a user interface (UI) to collect related data across multiple steps. Each step (Wizard.WizardStep) can host
+arbitrary Views, much like a Dialog. Each step also has a pane for help text. Along the
+bottom of the Wizard view are customizable buttons enabling the user to navigate forward and backward through the Wizard.
+
public class Wizard : Dialog, IDisposable, ISupportInitializeNotification, ISupportInitialize
+
+
Remarks
+
+The Wizard can be displayed either as a modal (pop-up) Window (like Dialog) or as an embedded View.
+
+By default, Modal is true; launch the Wizard using `Application.Run(wizard)`.
+
+Set Modal to `false` to use Wizard as an embedded View, and add the Wizard to a containing view with Add(View).
+
+When used as a modal pop-up window, the Esc key will cause the Cancelled event to fire and (if the event is not cancelled),
+will cause RequestStop(Toplevel) to be called, closing the Wizard.
+
+When used as an embedded View, no frame is drawn around the Wizard. To detect if the user wants to cancel
+the Wizard, subscrie to the Cancelled event.
+
+
+
Constructors
+
+
+
Wizard()
+
+Initializes a new instance of the Wizard class using Computed positioning.
+
+
+
Declaration
+
+
public Wizard()
+
+
Remarks
+
+The Wizard will be vertically and horizontally centered in the container.
+After initialization use X, Y, Width, and Height change size and position.
+
+
+
Wizard(ustring)
+
+Initializes a new instance of the Wizard class using Computed positioning.
+
+The Wizard will be vertically and horizontally centered in the container.
+After initialization use X, Y, Width, and Height change size and position.
+
+
Properties
+
+
+
BackButton
+
+If the CurrentStep is not the first step in the wizard, this button causes
+the MovingBack event to be fired and the wizard moves to the previous step.
+
+Determines whether the Wizard is displayed as modal pop-up or not.
+
+The default is `true`. The Wizard will be shown with a frame with Title and will behave like
+any Toplevel window.
+
+If set to `false` the Wizard will have no frame and will behave like any embedded View.
+
+
+
+
Declaration
+
+
public bool Modal { get; set; }
+
+
Property Value
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Boolean
+
+
+
+
+
+
NextFinishButton
+
+If the CurrentStep is the last step in the wizard, this button causes
+the Finished event to be fired and the wizard to close. If the step is not the last step,
+the MovingNext event will be fired and the wizard will move next step.
+
+Returns the next enabled Wizard.WizardStep after the current step. Takes into account steps which
+are disabled. If CurrentStep is `null` returns the first enabled step.
+
The next step after the current step, if there is one; otherwise returns `null`, which
+indicates either there are no enabled steps or the current step is the last enabled step.
+
+
+
+
+
GetPreviousStep()
+
+Returns the first enabled Wizard.WizardStep before the current step. Takes into account steps which
+are disabled. If CurrentStep is `null` returns the last enabled step.
+
The first step ahead of the current step, if there is one; otherwise returns `null`, which
+indicates either there are no enabled steps or the current step is the first enabled step.
+
+
+
+
+
GoBack()
+
+Causes the wizad to move to the previous enabled step (or first step if CurrentStep is not set).
+If there is no previous step, does nothing.
+
+
+
Declaration
+
+
public void GoBack()
+
+
+
GoNext()
+
+Causes the wizad to move to the next enabled step (or last step if CurrentStep is not set).
+If there is no previous step, does nothing.
+
+This event is raised when the user has cancelled the Wizard by pressin the Esc key.
+To prevent a Modal Wizard from
+closing, cancel the event by setting Cancel to `true` before returning from the event handler.
+
+
+
Declaration
+
+
public event Action<Wizard.WizardButtonEventArgs> Cancelled
+This event is raised when the Next/Finish button in the Wizard is clicked. The Next/Finish button is always
+the last button in the array of Buttons passed to the Wizard constructor, if any. This event is only
+raised if the CurrentStep is the last Step in the Wizard flow
+(otherwise the Finished event is raised).
+
+
+
Declaration
+
+
public event Action<Wizard.WizardButtonEventArgs> Finished
+This event is raised when the Back button in the Wizard is clicked. The Back button is always
+the first button in the array of Buttons passed to the Wizard constructor, if any.
+
+
+
Declaration
+
+
public event Action<Wizard.WizardButtonEventArgs> MovingBack
+This event is raised when the Next/Finish button in the Wizard is clicked (or the user presses Enter).
+The Next/Finish button is always the last button in the array of Buttons passed to the Wizard constructor,
+if any. This event is only raised if the CurrentStep is the last Step in the Wizard flow
+(otherwise the Finished event is raised).
+
+
+
Declaration
+
+
public event Action<Wizard.WizardButtonEventArgs> MovingNext
+
+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.
+
+
+
+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.
+
+
+
+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.
+
+
+
+The DialogView is a Window that by default is centered and contains one
+or more Buttons. It defaults to the Dialog color scheme and has a 1 cell padding around the edges.
+
+
+
+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.
+
+
+
+The Label View displays a string at a given position and supports multiple lines separated by newline characters.
+Multi-line Labels support word wrap.
+
+
+
+A container for single Child that will allow to drawn Border in
+two ways. If UsePanelFrame the borders and the child will be accommodated in the available
+panel size, otherwise the panel will be resized based on the child and borders thickness sizes.
+
+
+
+Describes the 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.
+
+
+
+A status bar is a View that snaps to the bottom of a Toplevel displaying set of StatusItems.
+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 objects are contained by StatusBarViews.
+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.
+
+
+
+Renders an overlay on another view at a given point that allows selecting
+from a range of 'autocomplete' options.
+An implementation on a TextField.
+
+
+
+Renders an overlay on another view at a given point that allows selecting
+from a range of 'autocomplete' options.
+An implementation on a TextView.
+
+
+
+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.
+
+
+
+Provides navigation and a user interface (UI) to collect related data across multiple steps. Each step (Wizard.WizardStep) can host
+arbitrary Views, much like a Dialog. Each step also has a pane for help text. Along the
+bottom of the Wizard view are customizable buttons enabling the user to navigate forward and backward through the Wizard.
+
+
+
+Represents a basic step that is displayed in a Wizard. The Wizard.WizardStep view is divided horizontally in two. On the left is the
+content view where Views can be added, On the right is the help for the step.
+Set HelpText to set the help text. If the help text is empty the help pane will not
+be shown.
+
+If there are no Views added to the WizardStep the HelpText (if not empty) will fill the wizard step.
+
+
+
+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.
+
+
+
+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.
+
+
Add one or more Scenario.ScenarioCategory attributes to the class specifying which categories the scenario belongs to. If you don't specify a category the scenario will show up in "_All".
Implement the Setup() override which will be called when a user selects the scenario to run.
+The UI Catalog program uses reflection to find all scenarios and adds them to the
+ListViews. Press ENTER to run the selected scenario. Press CTRL-Q to exit it. /
+
Helper that provides the default Window implementation with a frame and
+label showing the name of the Scenario and logic to exit back to
+the Scenario picker UI.
+Override Init(Toplevel, ColorScheme) to provide any Toplevel behavior needed.
+
+
+
Declaration
+
+
public virtual void Init(Toplevel top, ColorScheme colorScheme)
[Scenario.ScenarioMetadata("All Views Tester", "Provides a test UI for all classes derived from View.")]
+[Scenario.ScenarioCategory("Layout")]
+[Scenario.ScenarioCategory("Tests")]
+[Scenario.ScenarioCategory("Top Level Windows")]
+public class AllViewsTester : Scenario, IDisposable
+
+
Methods
+
+
+
Init(Toplevel, ColorScheme)
+
+
+
Declaration
+
+
public override void Init(Toplevel top, ColorScheme colorScheme)
[Scenario.ScenarioMetadata("Text Direction and AutoSize", "Demos TextFormatter Direction and View AutoSize.")]
+[Scenario.ScenarioCategory("Text and Formatting")]
+public class AutoSizeAndDirectionText : Scenario, IDisposable
[Scenario.ScenarioMetadata("Buttons", "Demonstrates all sorts of Buttons.")]
+[Scenario.ScenarioCategory("Controls")]
+[Scenario.ScenarioCategory("Layout")]
+public class Buttons : Scenario, IDisposable
[Scenario.ScenarioMetadata("Character Map", "A Unicode character set viewier built as a custom control using the ScrollView control.")]
+[Scenario.ScenarioCategory("Text and Formatting")]
+[Scenario.ScenarioCategory("Controls")]
+[Scenario.ScenarioCategory("ScrollView")]
+public class CharacterMap : Scenario, IDisposable
[Scenario.ScenarioMetadata("Class Explorer", "Tree view explorer for classes by namespace based on TreeView.")]
+[Scenario.ScenarioCategory("Controls")]
+[Scenario.ScenarioCategory("TreeView")]
+public class ClassExplorer : Scenario, IDisposable
[Scenario.ScenarioMetadata("Clipping", "Used to test that things clip correctly")]
+[Scenario.ScenarioCategory("Tests")]
+public class Clipping : Scenario, IDisposable
+
+
Methods
+
+
+
Init(Toplevel, ColorScheme)
+
+
+
Declaration
+
+
public override void Init(Toplevel top, ColorScheme colorScheme)
This Scenario demonstrates how to use Termina.gui's Dim and Pos Layout System.
+[x] - Using Dim.Fill to fill a window
+[x] - Using Dim.Fill and Dim.Pos to automatically align controls based on an initial control
+[ ] - ...
[Scenario.ScenarioMetadata("Dialogs", "Demonstrates how to the Dialog class")]
+[Scenario.ScenarioCategory("Dialogs")]
+public class Dialogs : Scenario, IDisposable
[Scenario.ScenarioMetadata("Dynamic MenuBar", "Demonstrates how to change a MenuBar dynamically.")]
+[Scenario.ScenarioCategory("Top Level Windows")]
+[Scenario.ScenarioCategory("Menus")]
+public class DynamicMenuBar : Scenario, IDisposable
+
+
Methods
+
+
+
Init(Toplevel, ColorScheme)
+
+
+
Declaration
+
+
public override void Init(Toplevel top, ColorScheme colorScheme)
[Scenario.ScenarioMetadata("Dynamic StatusBar", "Demonstrates how to add and remove a StatusBar and change items dynamically.")]
+[Scenario.ScenarioCategory("Top Level Windows")]
+public class DynamicStatusBar : Scenario, IDisposable
+
+
Methods
+
+
+
Init(Toplevel, ColorScheme)
+
+
+
Declaration
+
+
public override void Init(Toplevel top, ColorScheme colorScheme)
[Scenario.ScenarioMetadata("Editor", "A Text Editor using the TextView control.")]
+[Scenario.ScenarioCategory("Controls")]
+[Scenario.ScenarioCategory("Dialogs")]
+[Scenario.ScenarioCategory("Text and Formatting")]
+[Scenario.ScenarioCategory("Top Level Windows")]
+[Scenario.ScenarioCategory("Files and IO")]
+[Scenario.ScenarioCategory("TextView")]
+public class Editor : Scenario, IDisposable
+
+
Methods
+
+
+
Init(Toplevel, ColorScheme)
+
+
+
Declaration
+
+
public override void Init(Toplevel top, ColorScheme colorScheme)
[Scenario.ScenarioMetadata("HexEditor", "A binary (hex) editor using the HexView control.")]
+[Scenario.ScenarioCategory("Controls")]
+[Scenario.ScenarioCategory("Dialogs")]
+[Scenario.ScenarioCategory("Text and Formatting")]
+[Scenario.ScenarioCategory("Top Level Windows")]
+[Scenario.ScenarioCategory("Files and IO")]
+public class HexEditor : Scenario, IDisposable
[Scenario.ScenarioMetadata("Invert Colors", "Invert the foreground and the background colors.")]
+[Scenario.ScenarioCategory("Colors")]
+[Scenario.ScenarioCategory("Text and Formatting")]
+public class InvertColors : Scenario, IDisposable
[Scenario.ScenarioMetadata("Keys", "Shows how to handle keyboard input")]
+[Scenario.ScenarioCategory("Mouse and Keyboard")]
+public class Keys : Scenario, IDisposable
+
+
Methods
+
+
+
Init(Toplevel, ColorScheme)
+
+
+
Declaration
+
+
public override void Init(Toplevel top, ColorScheme colorScheme)
[Scenario.ScenarioMetadata("Labels As Buttons", "Illustrates that Button is really just a Label++")]
+[Scenario.ScenarioCategory("Controls")]
+[Scenario.ScenarioCategory("Proof of Concept")]
+public class LabelsAsLabels : Scenario, IDisposable
[Scenario.ScenarioMetadata("List View With Selection", "ListView with columns and selection")]
+[Scenario.ScenarioCategory("Controls")]
+[Scenario.ScenarioCategory("ListView")]
+public class ListViewWithSelection : Scenario, IDisposable
[Scenario.ScenarioMetadata("ListView & ComboBox", "Demonstrates a ListView populating a ComboBox that acts as a filter.")]
+[Scenario.ScenarioCategory("Controls")]
+[Scenario.ScenarioCategory("ListView")]
+[Scenario.ScenarioCategory("ComboBox")]
+public class ListsAndCombos : Scenario, IDisposable
[Scenario.ScenarioMetadata("MessageBoxes", "Demonstrates how to use the MessageBox class.")]
+[Scenario.ScenarioCategory("Controls")]
+[Scenario.ScenarioCategory("Dialogs")]
+public class MessageBoxes : Scenario, IDisposable
[Scenario.ScenarioMetadata("Mouse", "Demonstrates how to capture mouse events")]
+[Scenario.ScenarioCategory("Mouse and Keyboard")]
+public class Mouse : Scenario, IDisposable
[Scenario.ScenarioMetadata("MultiColouredTable", "Demonstrates how to multi color cell contents.")]
+[Scenario.ScenarioCategory("Controls")]
+[Scenario.ScenarioCategory("Colors")]
+[Scenario.ScenarioCategory("TableView")]
+public class MultiColouredTable : Scenario, IDisposable
[Scenario.ScenarioMetadata("Generic", "Generic sample - A template for creating new Scenarios")]
+[Scenario.ScenarioCategory("Controls")]
+public class MyScenario : Scenario, IDisposable
[Scenario.ScenarioMetadata("Progress", "Shows off ProgressBar and Threading.")]
+[Scenario.ScenarioCategory("Controls")]
+[Scenario.ScenarioCategory("Threading")]
+[Scenario.ScenarioCategory("ProgressBar")]
+public class Progress : Scenario, IDisposable
[Scenario.ScenarioMetadata("Single BackgroundWorker", "A single BackgroundWorker threading opening another Toplevel")]
+[Scenario.ScenarioCategory("Threading")]
+[Scenario.ScenarioCategory("Top Level Windows")]
+public class SingleBackgroundWorker : Scenario, IDisposable
[Scenario.ScenarioMetadata("Syntax Highlighting", "Text editor with keyword highlighting using the TextView control.")]
+[Scenario.ScenarioCategory("Text and Formatting")]
+[Scenario.ScenarioCategory("Controls")]
+[Scenario.ScenarioCategory("TextView")]
+public class SyntaxHighlighting : Scenario, IDisposable
[Scenario.ScenarioMetadata("Tab View", "Demos TabView control with limited screen space in Absolute layout.")]
+[Scenario.ScenarioCategory("Controls")]
+[Scenario.ScenarioCategory("TabView")]
+public class TabViewExample : Scenario, IDisposable
[Scenario.ScenarioMetadata("TableEditor", "Implements data table editor using the TableView control.")]
+[Scenario.ScenarioCategory("TableView")]
+[Scenario.ScenarioCategory("Controls")]
+[Scenario.ScenarioCategory("Dialogs")]
+[Scenario.ScenarioCategory("Text and Formatting")]
+[Scenario.ScenarioCategory("Top Level Windows")]
+public class TableEditor : Scenario, IDisposable
+
+
Methods
+
+
+
BuildDemoDataTable(Int32, Int32)
+
Generates a new demo System.Data.DataTable with the given number of cols (min 5) and rows
+
+
+
Declaration
+
+
public static DataTable BuildDemoDataTable(int cols, int rows)
+
+
Parameters
+
+
+
+
Type
+
Name
+
Description
+
+
+
+
+
System.Int32
+
cols
+
+
+
+
System.Int32
+
rows
+
+
+
+
+
Returns
+
+
+
+
Type
+
Description
+
+
+
+
+
System.Data.DataTable
+
+
+
+
+
+
BuildSimpleDataTable(Int32, Int32)
+
Builds a simple table in which cell values contents are the index of the cell. This helps testing that scrolling etc is working correctly and not skipping out any rows/columns when paging
+
+
+
Declaration
+
+
public static DataTable BuildSimpleDataTable(int cols, int rows)
[Scenario.ScenarioMetadata("Text Input Controls", "Tests all text input controls")]
+[Scenario.ScenarioCategory("Controls")]
+[Scenario.ScenarioCategory("Mouse and Keyboard")]
+[Scenario.ScenarioCategory("Text and Formatting")]
+public class Text : Scenario, IDisposable
[Scenario.ScenarioMetadata("Simple Text Alignment", "Demonstrates horizontal text alignment")]
+[Scenario.ScenarioCategory("Text and Formatting")]
+public class TextAlignments : Scenario, IDisposable
[Scenario.ScenarioMetadata("Text Alignment and Direction", "Demos horiztonal and vertical text alignment and text direction.")]
+[Scenario.ScenarioCategory("Text and Formatting")]
+public class TextAlignmentsAndDirections : Scenario, IDisposable
[Scenario.ScenarioMetadata("TextFormatter Demo", "Demos and tests the TextFormatter class.")]
+[Scenario.ScenarioCategory("Text and Formatting")]
+public class TextFormatterDemo : Scenario, IDisposable
[Scenario.ScenarioMetadata("Threading", "Demonstration of how to use threading in different ways")]
+[Scenario.ScenarioCategory("Threading")]
+public class Threading : Scenario, IDisposable
[Scenario.ScenarioMetadata("Time And Date", "Illustrates TimeField and time & date handling")]
+[Scenario.ScenarioCategory("Controls")]
+[Scenario.ScenarioCategory("DateTime")]
+public class TimeAndDate : Scenario, IDisposable
[Scenario.ScenarioMetadata("TreeViewFileSystem", "Hierarchical file system explorer based on TreeView.")]
+[Scenario.ScenarioCategory("Controls")]
+[Scenario.ScenarioCategory("TreeView")]
+[Scenario.ScenarioCategory("Files and IO")]
+public class TreeViewFileSystem : Scenario, IDisposable
[Scenario.ScenarioMetadata("Unicode", "Tries to test Unicode in all controls (#204)")]
+[Scenario.ScenarioCategory("Text and Formatting")]
+[Scenario.ScenarioCategory("Controls")]
+public class UnicodeInMenu : Scenario, IDisposable
[Scenario.ScenarioMetadata("WizardAsView", "Shows using the Wizard class in an non-modal way")]
+[Scenario.ScenarioCategory("Wizards")]
+public class WizardAsView : Scenario, IDisposable
+
+
Methods
+
+
+
Init(Toplevel, ColorScheme)
+
+
+
Declaration
+
+
public override void Init(Toplevel top, ColorScheme colorScheme)
This Scenario demonstrates how to use Termina.gui's Dim and Pos Layout System.
+[x] - Using Dim.Fill to fill a window
+[x] - Using Dim.Fill and Dim.Pos to automatically align controls based on an initial control
+[ ] - ...
Add one or more Scenario.ScenarioCategory attributes to the class specifying which categories the scenario belongs to. If you don't specify a category the scenario will show up in "_All".
Implement the Setup() override which will be called when a user selects the scenario to run.
+The UI Catalog program uses reflection to find all scenarios and adds them to the
+ListViews. Press ENTER to run the selected scenario. Press CTRL-Q to exit it. /
+
\ No newline at end of file
diff --git a/docs/articles/index.html b/docs/articles/index.html
index 37aad5d7d..67ac50f67 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 95a0e02af..8ad4ee290 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 e6820ef27..79bc9059d 100644
--- a/docs/articles/mainloop.html
+++ b/docs/articles/mainloop.html
@@ -8,7 +8,7 @@
Event Processing and the Application Main Loop
-
+
@@ -93,11 +93,11 @@ toolkits before.
On Unix systems, it can monitor file descriptors for readability or writability.
The MainLoop property in the the
-Application
+Application
provides access to these functions.
When your code invokes Application.Run (Toplevel), the application
will prepare the current
-Toplevel instance by
+Toplevel instance by
redrawing the screen appropriately and then calling the mainloop to
run.
You can configure the Mainloop before calling Application.Run, or you
diff --git a/docs/articles/overview.html b/docs/articles/overview.html
index 2d5c8acd7..9b0297c34 100644
--- a/docs/articles/overview.html
+++ b/docs/articles/overview.html
@@ -8,7 +8,7 @@
Terminal.Gui API Overview
-
+
@@ -105,9 +105,9 @@ not to make a decision and instead pressed the ESC key).
the various views that are included. In the following sections, you
will see how applications are put together.
In the example above, you can see that we have initialized the runtime by calling the
-Init method in the Application class - this sets up the environment, initializes the color
+Init method in the Application class - this sets up the environment, initializes the color
schemes available for your application and clears the screen to start your application.
-
The Application class, additionally creates an instance of the Toplevel class that is ready to be consumed,
+
The Application class, additionally creates an instance of the Toplevel class that is ready to be consumed,
this instance is available in the Application.Top property, and can be used like this:
using Terminal.Gui;
@@ -158,12 +158,12 @@ class Demo {
}
Views
All visible elements on a Terminal.Gui application are implemented as
-Views. Views are self-contained
+Views. Views are self-contained
objects that take care of displaying themselves, can receive keyboard and mouse
input and participate in the focus mechanism.
Every view can contain an arbitrary number of children views. These are called
the Subviews. You can add a view to an existing view, by calling the
-Add method, for example, to add a couple of buttons to a UI, you can do this:
+Add method, for example, to add a couple of buttons to a UI, you can do this:
void SetupMyView (View myView)
{
var label = new Label ("Username: ") {
@@ -185,14 +185,14 @@ the Subviews. You can add a view to an existing view, by calling the
The container of a given view is called the SuperView and it is a property of every
View.
There are many views that you can use to spice up your application:
Terminal.Gui supports two different layout systems, absolute and computed \
-(controlled by the LayoutStyle
+(controlled by the LayoutStyle
property on the view.
The absolute system is used when you want the view to be positioned exactly in
one location and want to manually control where the view is. This is done
-by invoking your View constructor with an argument of type Rect. When you do this, to change the
+by invoking your View constructor with an argument of type Rect. When you do this, to change the
position of the View, you can change the Frame property on the View.
The computed layout system offers a few additional capabilities, like automatic
centering, expanding of dimensions and a handful of other features. To use
@@ -210,7 +210,7 @@ var label = new Label ("Hello") {
// Absolute position using the provided rectangle
var label2 = new Label (new Rect (1, 2, 20, 1), "World")
-
The computed layout system does not take integers, instead the X and Y properties are of type Pos and the Width and Height properties are of type Dim both which can be created implicitly from integer values.
+
The computed layout system does not take integers, instead the X and Y properties are of type Pos and the Width and Height properties are of type Dim both which can be created implicitly from integer values.
Among the many kinds of views, you typically will create a Toplevel view (or any of its subclasses,
-like Window or Dialog which is special kind of views
+
Among the many kinds of views, you typically will create a Toplevel view (or any of its subclasses,
+like Window or Dialog which is special kind of views
that can be executed modally - that is, the view can take over all input and returns
only when the user chooses to complete their work there.
The following sections cover the differences.
TopLevel Views
-
Toplevel views have no visible user interface elements and occupy an arbitrary portion of the screen.
+
Toplevel views have no visible user interface elements and occupy an arbitrary portion of the screen.
You would use a toplevel Modal view for example to launch an entire new experience in your application, one where you would have a new top-level menu for example. You
typically would add a Menu and a Window to your Toplevel, it would look like this:
using Terminal.Gui;
@@ -301,10 +301,10 @@ class Demo {
}
}
Window Views
-
Window views extend the Toplevel view by providing a frame and a title around the toplevel - and can be moved on the screen with the mouse (caveat: code is currently disabled)
+
Window views extend the Toplevel view by providing a frame and a title around the toplevel - and can be moved on the screen with the mouse (caveat: code is currently disabled)
From a user interface perspective, you might have more than one Window on the screen at a given time.
Dialogs
-
Dialog are Window objects that happen to be centered in the middle of the screen.
+
Dialog are Window objects that happen to be centered in the middle of the screen.
Dialogs are instances of a Window that are centered in the screen, and are intended
to be used modally - that is, they run, and they are expected to return a result
before resuming execution of your application.
@@ -379,7 +379,7 @@ to background views when a modal view is running.
Colors and Color Schemes
All views have been configured with a color scheme that will work both in color
terminals as well as the more limited black and white terminals.
-
The various styles are captured in the Colors class which defined color schemes for
+
The various styles are captured in the Colors class which defined color schemes for
the toplevel, the normal views, the menu bar, popup dialog boxes and error dialog boxes, that you can use like this:
Colors.Toplevel
@@ -391,7 +391,7 @@ the toplevel, the normal views, the menu bar, popup dialog boxes and error dialo
You can use them for example like this to set the colors for a new Window:
var w = new Window ("Hello");
w.ColorScheme = Colors.Error
-
The ColorScheme represents
four values, the color used for Normal text, the color used for normal text when
a view is focused an the colors for the hot-keys both in focused and unfocused modes.
By using ColorSchemes you ensure that your application will work correctbly both
diff --git a/docs/articles/tableview.html b/docs/articles/tableview.html
index ceb86a1c0..73caa8a96 100644
--- a/docs/articles/tableview.html
+++ b/docs/articles/tableview.html
@@ -8,7 +8,7 @@
Table View
-
+
@@ -74,7 +74,7 @@
This control supports viewing and editing tabular data. It provides a view of a System.DataTable.
System.DataTable is a core class of .net standard and can be created very easily
You can create a DataTable from a CSV file by creating a new instance and adding columns and rows as you read them. For a robust solution however you might want to look into a CSV parser library that deals with escaping, multi line rows etc.
var dt = new DataTable();
diff --git a/docs/articles/treeview.html b/docs/articles/treeview.html
index 400821a51..f22ceffbb 100644
--- a/docs/articles/treeview.html
+++ b/docs/articles/treeview.html
@@ -8,7 +8,7 @@
Tree View
-
+
@@ -73,7 +73,7 @@
Tree View
TreeView is a control for navigating hierarchical objects. It comes in two forms TreeView and TreeView<T>.
diff --git a/docs/index.json b/docs/index.json
index 8bd4fe26b..19de282bb 100644
--- a/docs/index.json
+++ b/docs/index.json
@@ -1,4 +1,1269 @@
{
+ "api/Terminal.Gui/Terminal.Gui.Application.html": {
+ "href": "api/Terminal.Gui/Terminal.Gui.Application.html",
+ "title": "Class Application",
+ "keywords": "Class Application A static, singleton class providing the main application driver for Terminal.Gui apps. Inheritance System.Object Application Inherited Members System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) System.Object.ToString() Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public static class Application Remarks Creates a instance of MainLoop to process input events, handle timers and other sources of data. It is accessible via the MainLoop property. You can hook up to the Iteration event to have your method invoked on each iteration of the MainLoop . When invoked sets the SynchronizationContext to one that is tied to the mainloop, allowing user code to use async/await. Examples // A simple Terminal.Gui app that creates a window with a frame and title with // 5 rows/columns of padding. Application.Init(); var win = new Window (\"Hello World - CTRL-Q to quit\") { X = 5, Y = 5, Width = Dim.Fill (5), Height = Dim.Fill (5) }; Application.Top.Add(win); Application.Run(); Fields Driver The current ConsoleDriver in use. Declaration public static ConsoleDriver Driver Field Value Type Description ConsoleDriver Iteration This event is raised on each iteration of the MainLoop Declaration public static Action Iteration Field Value Type Description System.Action Remarks See also System.Threading.Timeout Resized Invoked when the terminal was resized. The new size of the terminal is provided. Declaration public static Action Resized Field Value Type Description System.Action < Application.ResizedEventArgs > RootKeyEvent Called for new KeyPress events before any processing is performed or views evaluate. Use for global key handling and/or debugging. Return true to suppress the KeyPress event Declaration public static Func RootKeyEvent Field Value Type Description System.Func < KeyEvent , System.Boolean > RootMouseEvent Merely a debugging aid to see the raw mouse events Declaration public static Action RootMouseEvent Field Value Type Description System.Action < MouseEvent > UseSystemConsole If set, it forces the use of the System.Console-based driver. Declaration public static bool UseSystemConsole Field Value Type Description System.Boolean Properties AlternateBackwardKey Alternative key to navigate backwards through all views. Shift+Ctrl+Tab is always used. Declaration public static Key AlternateBackwardKey { get; set; } Property Value Type Description Key AlternateForwardKey Alternative key to navigate forwards through all views. Ctrl+Tab is always used. Declaration public static Key AlternateForwardKey { get; set; } Property Value Type Description Key Current The current Toplevel object. This is updated when Run(Func) enters and leaves to point to the current Toplevel . Declaration public static Toplevel Current { get; } Property Value Type Description Toplevel The current. ExitRunLoopAfterFirstIteration Set to true to cause the RunLoop method to exit after the first iterations. Set to false (the default) to cause the RunLoop to continue running until Application.RequestStop() is called. Declaration public static bool ExitRunLoopAfterFirstIteration { get; set; } Property Value Type Description System.Boolean HeightAsBuffer The current HeightAsBuffer used in the terminal. Declaration public static bool HeightAsBuffer { get; set; } Property Value Type Description System.Boolean IsMouseDisabled Disable or enable the mouse in this Application Declaration public static bool IsMouseDisabled { get; set; } Property Value Type Description System.Boolean MainLoop The MainLoop driver for the application Declaration public static MainLoop MainLoop { get; } Property Value Type Description MainLoop The main loop. MdiChildes Gets all the Mdi childes which represent all the not modal Toplevel from the MdiTop . Declaration public static List MdiChildes { get; } Property Value Type Description System.Collections.Generic.List < Toplevel > MdiTop The Toplevel object used for the application on startup which IsMdiContainer is true. Declaration public static Toplevel MdiTop { get; } Property Value Type Description Toplevel QuitKey Gets or sets the key to quit the application. Declaration public static Key QuitKey { get; set; } Property Value Type Description Key SupportedCultures Gets all supported cultures by the application without the invariant language. Declaration public static List SupportedCultures { get; } Property Value Type Description System.Collections.Generic.List < System.Globalization.CultureInfo > Top The Toplevel object used for the application on startup ( Top ) Declaration public static Toplevel Top { get; } Property Value Type Description Toplevel The top. WantContinuousButtonPressedView The current View object that wants continuous mouse button pressed events. Declaration public static View WantContinuousButtonPressedView { get; } Property Value Type Description View Methods Begin(Toplevel) Building block API: Prepares the provided Toplevel for execution. Declaration public static Application.RunState Begin(Toplevel toplevel) Parameters Type Name Description Toplevel toplevel Toplevel to prepare execution for. Returns Type Description Application.RunState The runstate handle that needs to be passed to the End(Application.RunState) method upon completion. Remarks This method prepares the provided toplevel for running with the focus, it adds this to the list of toplevels, sets up the mainloop to process the event, lays out the subviews, focuses the first element, and draws the toplevel in the screen. This is usually followed by executing the RunLoop(Application.RunState, Boolean) method, and then the End(Application.RunState) method upon termination which will undo these changes. DoEvents() Wakes up the mainloop that might be waiting on input, must be thread safe. Declaration public static void DoEvents() End(Application.RunState) Building block API: completes the execution of a Toplevel that was started with Begin(Toplevel) . Declaration public static void End(Application.RunState runState) Parameters Type Name Description Application.RunState runState The runstate returned by the Begin(Toplevel) method. EnsuresTopOnFront() Ensures that the superview of the most focused view is on front. Declaration public static void EnsuresTopOnFront() GrabMouse(View) Grabs the mouse, forcing all mouse events to be routed to the specified view until UngrabMouse is called. Declaration public static void GrabMouse(View view) Parameters Type Name Description View view View that will receive all mouse events until UngrabMouse is invoked. Init(ConsoleDriver, IMainLoopDriver) Initializes a new instance of Terminal.Gui Application. Declaration public static void Init(ConsoleDriver driver = null, IMainLoopDriver mainLoopDriver = null) Parameters Type Name Description ConsoleDriver driver IMainLoopDriver mainLoopDriver Remarks Call this method once per instance (or after Shutdown() has been called). Loads the right ConsoleDriver for the platform. Creates a Toplevel and assigns it to Top MakeCenteredRect(Size) Returns a rectangle that is centered in the screen for the provided size. Declaration public static Rect MakeCenteredRect(Size size) Parameters Type Name Description Size size Size for the rectangle. Returns Type Description Rect The centered rect. MoveNext() Move to the next Mdi child from the MdiTop . Declaration public static void MoveNext() MovePrevious() Move to the previous Mdi child from the MdiTop . Declaration public static void MovePrevious() Refresh() Triggers a refresh of the entire display. Declaration public static void Refresh() RequestStop(Toplevel) Stops running the most recent Toplevel or the top if provided. Declaration public static void RequestStop(Toplevel top = null) Parameters Type Name Description Toplevel top The toplevel to request stop. Remarks This will cause Run(Func) to return. Calling RequestStop(Toplevel) is equivalent to setting the Running property on the currently running Toplevel to false. Run(Func) Runs the application by calling Run(Toplevel, Func) with the value of Top Declaration public static void Run(Func errorHandler = null) Parameters Type Name Description System.Func < System.Exception , System.Boolean > errorHandler Run(Toplevel, Func) Runs the main loop on the given Toplevel container. Declaration public static void Run(Toplevel view, Func errorHandler = null) Parameters Type Name Description Toplevel view The Toplevel to run modally. System.Func < System.Exception , System.Boolean > errorHandler Handler for any unhandled exceptions (resumes when returns true, rethrows when null). Remarks This method is used to start processing events for the main application, but it is also used to run other modal View s such as Dialog boxes. To make a Run(Toplevel, Func) stop execution, call RequestStop(Toplevel) . Calling Run(Toplevel, Func) is equivalent to calling Begin(Toplevel) , followed by RunLoop(Application.RunState, Boolean) , and then calling End(Application.RunState) . Alternatively, to have a program control the main loop and process events manually, call Begin(Toplevel) to set things up manually and then repeatedly call RunLoop(Application.RunState, Boolean) with the wait parameter set to false. By doing this the RunLoop(Application.RunState, Boolean) method will only process any pending events, timers, idle handlers and then return control immediately. When errorHandler is null the exception is rethrown, when it returns true the application is resumed and when false method exits gracefully. Run(Func) Runs the application by calling Run(Toplevel, Func) with a new instance of the specified Toplevel -derived class Declaration public static void Run(Func errorHandler = null) where T : Toplevel, new() Parameters Type Name Description System.Func < System.Exception , System.Boolean > errorHandler Type Parameters Name Description T RunLoop(Application.RunState, Boolean) Building block API: Runs the main loop for the created dialog Declaration public static void RunLoop(Application.RunState state, bool wait = true) Parameters Type Name Description Application.RunState state The state returned by the Begin method. System.Boolean wait By default this is true which will execute the runloop waiting for events, if you pass false, you can use this method to run a single iteration of the events. Remarks Use the wait parameter to control whether this is a blocking or non-blocking call. RunMainLoopIteration(ref Application.RunState, Boolean, ref Boolean) Run one iteration of the MainLoop. Declaration public static void RunMainLoopIteration(ref Application.RunState state, bool wait, ref bool firstIteration) Parameters Type Name Description Application.RunState state The state returned by the Begin method. System.Boolean wait If will execute the runloop waiting for events. System.Boolean firstIteration If it's the first run loop iteration. Shutdown() Shutdown an application initialized with Init(ConsoleDriver, IMainLoopDriver) Declaration public static void Shutdown() UngrabMouse() Releases the mouse grab, so mouse events will be routed to the view on which the mouse is. Declaration public static void UngrabMouse() Events NotifyNewRunState Notify that a new Application.RunState token was created, used if ExitRunLoopAfterFirstIteration is true. Declaration public static event Action NotifyNewRunState Event Type Type Description System.Action < Application.RunState > NotifyStopRunState Notify that a existent Application.RunState token is stopping, used if ExitRunLoopAfterFirstIteration is true. Declaration public static event Action NotifyStopRunState Event Type Type Description System.Action < Toplevel >"
+ },
+ "api/Terminal.Gui/Terminal.Gui.Application.ResizedEventArgs.html": {
+ "href": "api/Terminal.Gui/Terminal.Gui.Application.ResizedEventArgs.html",
+ "title": "Class Application.ResizedEventArgs",
+ "keywords": "Class Application.ResizedEventArgs Event arguments for the Resized event. Inheritance System.Object System.EventArgs Application.ResizedEventArgs Inherited Members System.EventArgs.Empty System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) System.Object.ToString() Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class ResizedEventArgs : EventArgs Properties Cols The number of columns in the resized terminal. Declaration public int Cols { get; set; } Property Value Type Description System.Int32 Rows The number of rows in the resized terminal. Declaration public int Rows { get; set; } Property Value Type Description System.Int32"
+ },
+ "api/Terminal.Gui/Terminal.Gui.Application.RunState.html": {
+ "href": "api/Terminal.Gui/Terminal.Gui.Application.RunState.html",
+ "title": "Class Application.RunState",
+ "keywords": "Class Application.RunState Captures the execution state for the provided Toplevel view. Inheritance System.Object Application.RunState Implements System.IDisposable Inherited Members System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) System.Object.ToString() Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class RunState : IDisposable Constructors RunState(Toplevel) Initializes a new Application.RunState class. Declaration public RunState(Toplevel view) Parameters Type Name Description Toplevel view Properties Toplevel The Toplevel belong to this Application.RunState . Declaration public Toplevel Toplevel { get; } Property Value Type Description Toplevel Methods Dispose() Releases alTop = l resource used by the Application.RunState object. Declaration public void Dispose() Remarks Call Dispose() when you are finished using the Application.RunState . The Dispose() method leaves the Application.RunState in an unusable state. After calling Dispose() , you must release all references to the Application.RunState so the garbage collector can reclaim the memory that the Application.RunState was occupying. Dispose(Boolean) Dispose the specified disposing. Declaration protected virtual void Dispose(bool disposing) Parameters Type Name Description System.Boolean disposing If set to true disposing. Implements System.IDisposable"
+ },
+ "api/Terminal.Gui/Terminal.Gui.Attribute.html": {
+ "href": "api/Terminal.Gui/Terminal.Gui.Attribute.html",
+ "title": "Struct Attribute",
+ "keywords": "Struct Attribute Attributes are used as elements that contain both a foreground and a background or platform specific features Inherited Members System.ValueType.Equals(System.Object) System.ValueType.GetHashCode() System.ValueType.ToString() System.Object.Equals(System.Object, System.Object) System.Object.GetType() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public struct Attribute Remarks Attribute s are needed to map colors to terminal capabilities that might lack colors, on color scenarios, they encode both the foreground and the background color and are used in the ColorScheme class to define color schemes that can be used in your application. Constructors Attribute(Int32) Initializes a new instance of the Attribute struct with only the value passed to and trying to get the colors if defined. Declaration public Attribute(int value) Parameters Type Name Description System.Int32 value Value. Attribute(Int32, Color, Color) Initializes a new instance of the Attribute struct. Declaration public Attribute(int value, Color foreground, Color background) Parameters Type Name Description System.Int32 value Value. Color foreground Foreground Color background Background Attribute(Color) Initializes a new instance of the Attribute struct with the same colors for the foreground and background. Declaration public Attribute(Color color) Parameters Type Name Description Color color The color. Attribute(Color, Color) Initializes a new instance of the Attribute struct. Declaration public Attribute(Color foreground = Color.Black, Color background = Color.Black) Parameters Type Name Description Color foreground Foreground Color background Background Properties Background The background color. Declaration public readonly Color Background { get; } Property Value Type Description Color Foreground The foreground color. Declaration public readonly Color Foreground { get; } Property Value Type Description Color Value The color attribute value. Declaration public readonly int Value { get; } Property Value Type Description System.Int32 Methods Get() Gets the current Attribute from the driver. Declaration public static Attribute Get() Returns Type Description Attribute The current attribute. Make(Color, Color) Creates an Attribute from the specified foreground and background. Declaration public static Attribute Make(Color foreground, Color background) Parameters Type Name Description Color foreground Foreground color to use. Color background Background color to use. Returns Type Description Attribute The make. Operators Implicit(Int32 to Attribute) Implicitly convert an integer value into an Attribute Declaration public static implicit operator Attribute(int v) Parameters Type Name Description System.Int32 v value Returns Type Description Attribute An attribute with the specified integer value. Implicit(Attribute to Int32) Implicit conversion from an Attribute to the underlying Int32 representation Declaration public static implicit operator int (Attribute c) Parameters Type Name Description Attribute c The attribute to convert Returns Type Description System.Int32 The integer value stored in the attribute."
+ },
+ "api/Terminal.Gui/Terminal.Gui.Autocomplete.html": {
+ "href": "api/Terminal.Gui/Terminal.Gui.Autocomplete.html",
+ "title": "Class Autocomplete",
+ "keywords": "Class Autocomplete Renders an overlay on another view at a given point that allows selecting from a range of 'autocomplete' options. Inheritance System.Object Autocomplete TextFieldAutocomplete TextViewAutocomplete Implements IAutocomplete 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 Autocomplete : IAutocomplete Properties AllSuggestions The full set of all strings that can be suggested. Declaration public virtual List AllSuggestions { get; set; } Property Value Type Description System.Collections.Generic.List < System.String > CloseKey The key that the user can press to close the currently popped autocomplete menu Declaration public virtual Key CloseKey { get; set; } Property Value Type Description Key ColorScheme The colors to use to render the overlay. Accessing this property before the Application has been initialized will cause an error Declaration public virtual ColorScheme ColorScheme { get; set; } Property Value Type Description ColorScheme HostControl The host control to handle. Declaration public virtual View HostControl { get; set; } Property Value Type Description View MaxHeight The maximum number of visible rows in the autocomplete dropdown to render Declaration public virtual int MaxHeight { get; set; } Property Value Type Description System.Int32 MaxWidth The maximum width of the autocomplete dropdown Declaration public virtual int MaxWidth { get; set; } Property Value Type Description System.Int32 PopupInsideContainer Gets or sets If the popup is displayed inside or outside the host limits. Declaration public bool PopupInsideContainer { get; set; } Property Value Type Description System.Boolean Reopen The key that the user can press to reopen the currently popped autocomplete menu Declaration public virtual Key Reopen { get; set; } Property Value Type Description Key ScrollOffset When more suggestions are available than can be rendered the user can scroll down the dropdown list. This indicates how far down they have gone Declaration public virtual int ScrollOffset { get; set; } Property Value Type Description System.Int32 SelectedIdx The currently selected index into Suggestions that the user has highlighted Declaration public virtual int SelectedIdx { get; set; } Property Value Type Description System.Int32 SelectionKey The key that the user must press to accept the currently selected autocomplete suggestion Declaration public virtual Key SelectionKey { get; set; } Property Value Type Description Key Suggestions The strings that form the current list of suggestions to render based on what the user has typed so far. Declaration public virtual ReadOnlyCollection Suggestions { get; set; } Property Value Type Description System.Collections.ObjectModel.ReadOnlyCollection < System.String > Visible True if the autocomplete should be considered open and visible Declaration public virtual bool Visible { get; set; } Property Value Type Description System.Boolean Methods ClearSuggestions() Clears Suggestions Declaration public virtual void ClearSuggestions() Close() Closes the Autocomplete context menu if it is showing and ClearSuggestions() Declaration protected void Close() DeleteTextBackwards() Deletes the text backwards before insert the selected text in the HostControl . Declaration protected abstract void DeleteTextBackwards() EnsureSelectedIdxIsValid() Updates SelectedIdx to be a valid index within Suggestions Declaration public virtual void EnsureSelectedIdxIsValid() GenerateSuggestions() Populates Suggestions with all strings in AllSuggestions that match with the current cursor position/text in the HostControl Declaration public virtual void GenerateSuggestions() GetCurrentWord() Returns the currently selected word from the HostControl . When overriding this method views can make use of IdxToWord(List, Int32) Declaration protected abstract string GetCurrentWord() Returns Type Description System.String IdxToWord(List, Int32) Given a line of characters, returns the word which ends at idx or null. Also returns null if the idx is positioned in the middle of a word. Use this method to determine whether autocomplete should be shown when the cursor is at a given point in a line and to get the word from which suggestions should be generated. Declaration protected virtual string IdxToWord(List line, int idx) Parameters Type Name Description System.Collections.Generic.List < System.Rune > line System.Int32 idx Returns Type Description System.String InsertSelection(String) Called when the user confirms a selection at the current cursor location in the HostControl . The accepted string is the full autocomplete word to be inserted. Typically a host will have to remove some characters such that the accepted string completes the word instead of simply being appended. Declaration protected virtual bool InsertSelection(string accepted) Parameters Type Name Description System.String accepted Returns Type Description System.Boolean True if the insertion was possible otherwise false InsertText(String) Inser the selected text in the HostControl . Declaration protected abstract void InsertText(string accepted) Parameters Type Name Description System.String accepted IsWordChar(Rune) Return true if the given symbol should be considered part of a word and can be contained in matches. Base behavior is to use System.Char.IsLetterOrDigit(System.Char) Declaration public virtual bool IsWordChar(Rune rune) Parameters Type Name Description System.Rune rune Returns Type Description System.Boolean MouseEvent(MouseEvent, Boolean) Handle mouse events before HostControl e.g. to make mouse events like report/click apply to the autocomplete control instead of changing the cursor position in the underlying text view. Declaration public virtual bool MouseEvent(MouseEvent me, bool fromHost = false) Parameters Type Name Description MouseEvent me The mouse event. System.Boolean fromHost If was called from the popup or from the host. Returns Type Description System.Boolean true if the mouse can be handled false otherwise. MoveDown() Moves the selection in the Autocomplete context menu down one Declaration protected void MoveDown() MoveUp() Moves the selection in the Autocomplete context menu up one Declaration protected void MoveUp() ProcessKey(KeyEvent) Handle key events before HostControl e.g. to make key events like up/down apply to the autocomplete control instead of changing the cursor position in the underlying text view. Declaration public virtual bool ProcessKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb The key event. Returns Type Description System.Boolean true if the key can be handled false otherwise. RenderOverlay(Point) Renders the autocomplete dialog inside or outside the given HostControl at the given point. Declaration public virtual void RenderOverlay(Point renderAt) Parameters Type Name Description Point renderAt RenderSelectedIdxByMouse(MouseEvent) Render the current selection in the Autocomplete context menu by the mouse reporting. Declaration protected void RenderSelectedIdxByMouse(MouseEvent me) Parameters Type Name Description MouseEvent me ReopenSuggestions() Reopen the popup after it has been closed. Declaration protected bool ReopenSuggestions() Returns Type Description System.Boolean Select() Completes the autocomplete selection process. Called when user hits the SelectionKey . Declaration protected bool Select() Returns Type Description System.Boolean Implements IAutocomplete"
+ },
+ "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, 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.OnLoaded() 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.ForceValidatePosDim View.GetMinWidthHeight(Size) View.SetMinWidthHeight() View.TextFormatter View.SuperView View.UpdateTextFormatterText() View.ProcessResizeView() 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.PreserveTrailingSpaces View.TextAlignment View.VerticalTextAlignment View.TextDirection View.IsInitialized View.IsAdded View.Enabled View.Visible View.ToString() View.GetAutoSize() View.GetHotKeySpecifierLength(Boolean) View.GetTextFormatterBoundsSize() View.GetBoundsTextFormatterSize() 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",
+ "title": "Enum BorderStyle",
+ "keywords": "Enum BorderStyle Specifies the border style for a View and to be used by the Border class. Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public enum BorderStyle Fields Name Description Double The border is drawn with a double line limits. None No border is drawn. Rounded The border is drawn with a single line and rounded corners limits. Single The border is drawn with a single line limits."
+ },
+ "api/Terminal.Gui/Terminal.Gui.Button.html": {
+ "href": "api/Terminal.Gui/Terminal.Gui.Button.html",
+ "title": "Class Button",
+ "keywords": "Class Button Button is a View that provides an item that invokes an System.Action when activated by the user. Inheritance System.Object Responder View Button Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.CanFocusChanged View.EnabledChanged View.VisibleChanged View.HotKeyChanged 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.ForceValidatePosDim View.GetMinWidthHeight(Size) View.SetMinWidthHeight() View.TextFormatter View.SuperView View.ProcessResizeView() 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.Redraw(Rect) 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.Text View.AutoSize View.PreserveTrailingSpaces View.TextAlignment View.VerticalTextAlignment View.TextDirection View.IsInitialized View.IsAdded View.Enabled View.Visible View.Border View.ToString() View.GetAutoSize() View.GetHotKeySpecifierLength(Boolean) View.GetTextFormatterBoundsSize() View.GetBoundsTextFormatterSize() 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 HotKey Declaration public override Key HotKey { get; set; } Property Value Type Description Key Overrides View.HotKey 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 . 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) UpdateTextFormatterText() Declaration protected override void UpdateTextFormatterText() Overrides View.UpdateTextFormatterText() 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.ForceValidatePosDim View.GetMinWidthHeight(Size) View.SetMinWidthHeight() View.TextFormatter View.SuperView View.ProcessResizeView() 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.Redraw(Rect) 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.Text View.AutoSize View.PreserveTrailingSpaces View.TextAlignment View.VerticalTextAlignment View.TextDirection View.IsInitialized View.IsAdded View.Enabled View.Visible View.Border View.ToString() View.GetAutoSize() View.GetHotKeySpecifierLength(Boolean) View.GetTextFormatterBoundsSize() View.GetBoundsTextFormatterSize() 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 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) UpdateTextFormatterText() Declaration protected override void UpdateTextFormatterText() Overrides View.UpdateTextFormatterText() Events Toggled Toggled event, raised when the CheckBox is toggled. Declaration public event Action Toggled Event Type Type Description System.Action < System.Boolean > Remarks Client code can hook up to this event, it is raised when the CheckBox is activated either with the mouse or the keyboard. The passed bool contains the previous state. Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize"
+ },
+ "api/Terminal.Gui/Terminal.Gui.Clipboard.html": {
+ "href": "api/Terminal.Gui/Terminal.Gui.Clipboard.html",
+ "title": "Class Clipboard",
+ "keywords": "Class Clipboard Provides cut, copy, and paste support for the clipboard with OS interaction. Inheritance System.Object Clipboard Inherited Members System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) System.Object.ToString() Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public static class Clipboard Properties Contents Get or sets the operation system clipboard, otherwise the contents field. Declaration public static ustring Contents { get; set; } Property Value Type Description NStack.ustring IsSupported Returns true if the environmental dependencies are in place to interact with the OS clipboard. Declaration public static bool IsSupported { get; } Property Value Type Description System.Boolean Methods TryGetClipboardData(out String) Gets the operation system clipboard if possible. Declaration public static bool TryGetClipboardData(out string result) Parameters Type Name Description System.String result Clipboard contents read Returns Type Description System.Boolean true if it was possible to read the OS clipboard. TrySetClipboardData(String) Sets the operation system clipboard if possible. Declaration public static bool TrySetClipboardData(string text) Parameters Type Name Description System.String text Returns Type Description System.Boolean True if the clipboard content was set successfully."
+ },
+ "api/Terminal.Gui/Terminal.Gui.ClipboardBase.html": {
+ "href": "api/Terminal.Gui/Terminal.Gui.ClipboardBase.html",
+ "title": "Class ClipboardBase",
+ "keywords": "Class ClipboardBase Shared abstract class to enforce rules from the implementation of the IClipboard interface. Inheritance System.Object ClipboardBase Implements IClipboard Inherited Members System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) System.Object.ToString() Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public abstract class ClipboardBase : IClipboard Properties IsSupported Returns true if the environmental dependencies are in place to interact with the OS clipboard Declaration public abstract bool IsSupported { get; } Property Value Type Description System.Boolean Methods GetClipboardData() Get the operation system clipboard. Declaration public string GetClipboardData() Returns Type Description System.String Exceptions Type Condition System.NotSupportedException Thrown if it was not possible to read the clipboard contents GetClipboardDataImpl() Get the operation system clipboard. Declaration protected abstract string GetClipboardDataImpl() Returns Type Description System.String SetClipboardData(String) Sets the operation system clipboard. Declaration public void SetClipboardData(string text) Parameters Type Name Description System.String text Exceptions Type Condition System.NotSupportedException Thrown if it was not possible to set the clipboard contents SetClipboardDataImpl(String) Sets the operation system clipboard. Declaration protected abstract void SetClipboardDataImpl(string text) Parameters Type Name Description System.String text TryGetClipboardData(out String) Gets the operation system clipboard if possible. Declaration public bool TryGetClipboardData(out string result) Parameters Type Name Description System.String result Clipboard contents read Returns Type Description System.Boolean true if it was possible to read the OS clipboard. TrySetClipboardData(String) Sets the operation system clipboard if possible. Declaration public bool TrySetClipboardData(string text) Parameters Type Name Description System.String text Returns Type Description System.Boolean True if the clipboard content was set successfully Implements IClipboard"
+ },
+ "api/Terminal.Gui/Terminal.Gui.Color.html": {
+ "href": "api/Terminal.Gui/Terminal.Gui.Color.html",
+ "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.ForceValidatePosDim View.GetMinWidthHeight(Size) View.SetMinWidthHeight() View.TextFormatter View.SuperView View.UpdateTextFormatterText() View.ProcessResizeView() 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.PreserveTrailingSpaces View.TextAlignment View.VerticalTextAlignment View.TextDirection View.IsInitialized View.IsAdded View.Enabled View.Visible View.Border View.ToString() View.GetAutoSize() View.GetHotKeySpecifierLength(Boolean) View.GetTextFormatterBoundsSize() View.GetBoundsTextFormatterSize() 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",
+ "keywords": "Class Colors The default ColorScheme s for the application. Inheritance System.Object Colors Inherited Members System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) System.Object.ToString() Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public static class Colors Properties Base The base color scheme, for the default toplevel views. Declaration public static ColorScheme Base { get; set; } Property Value Type Description ColorScheme Remarks This API will be deprecated in the future. Use ColorSchemes instead (e.g. edit.ColorScheme = Colors.ColorSchemes[\"Base\"]; ColorSchemes Provides the defined ColorScheme s. Declaration public static Dictionary ColorSchemes { get; } Property Value Type Description System.Collections.Generic.Dictionary < System.String , ColorScheme > Dialog The dialog color scheme, for standard popup dialog boxes Declaration public static ColorScheme Dialog { get; set; } Property Value Type Description ColorScheme Remarks This API will be deprecated in the future. Use ColorSchemes instead (e.g. edit.ColorScheme = Colors.ColorSchemes[\"Dialog\"]; Error The color scheme for showing errors. Declaration public static ColorScheme Error { get; set; } Property Value Type Description ColorScheme Remarks This API will be deprecated in the future. Use ColorSchemes instead (e.g. edit.ColorScheme = Colors.ColorSchemes[\"Error\"]; Menu The menu bar color Declaration public static ColorScheme Menu { get; set; } Property Value Type Description ColorScheme Remarks This API will be deprecated in the future. Use ColorSchemes instead (e.g. edit.ColorScheme = Colors.ColorSchemes[\"Menu\"]; TopLevel The application toplevel color scheme, for the default toplevel views. Declaration public static ColorScheme TopLevel { get; set; } Property Value Type Description ColorScheme Remarks This API will be deprecated in the future. Use ColorSchemes instead (e.g. edit.ColorScheme = Colors.ColorSchemes[\"TopLevel\"];"
+ },
+ "api/Terminal.Gui/Terminal.Gui.ColorScheme.html": {
+ "href": "api/Terminal.Gui/Terminal.Gui.ColorScheme.html",
+ "title": "Class ColorScheme",
+ "keywords": "Class 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. Inheritance System.Object ColorScheme Implements System.IEquatable < ColorScheme > Inherited Members System.Object.Equals(System.Object, System.Object) 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 ColorScheme : IEquatable Properties Disabled The default color for text, when the view is disabled. Declaration public Attribute Disabled { get; set; } Property Value Type Description Attribute Focus The color for text when the view has the focus. Declaration public Attribute Focus { get; set; } Property Value Type Description Attribute HotFocus The color for the hotkey when the view is focused. Declaration public Attribute HotFocus { get; set; } Property Value Type Description Attribute HotNormal The color for the hotkey when a view is not focused Declaration public Attribute HotNormal { get; set; } Property Value Type Description Attribute Normal The default color for text, when the view is not focused. Declaration public Attribute Normal { get; set; } Property Value Type Description Attribute Methods Equals(Object) Compares two ColorScheme objects for equality. Declaration public override bool Equals(object obj) Parameters Type Name Description System.Object obj Returns Type Description System.Boolean true if the two objects are equal Overrides System.Object.Equals(System.Object) Equals(ColorScheme) Compares two ColorScheme objects for equality. Declaration public bool Equals(ColorScheme other) Parameters Type Name Description ColorScheme other Returns Type Description System.Boolean true if the two objects are equal GetHashCode() Returns a hashcode for this instance. Declaration public override int GetHashCode() Returns Type Description System.Int32 hashcode for this instance Overrides System.Object.GetHashCode() Operators Equality(ColorScheme, ColorScheme) Compares two ColorScheme objects for equality. Declaration public static bool operator ==(ColorScheme left, ColorScheme right) Parameters Type Name Description ColorScheme left ColorScheme right Returns Type Description System.Boolean true if the two objects are equivalent Inequality(ColorScheme, ColorScheme) Compares two ColorScheme objects for inequality. Declaration public static bool operator !=(ColorScheme left, ColorScheme right) Parameters Type Name Description ColorScheme left ColorScheme right Returns Type Description System.Boolean true if the two objects are not equivalent Implements System.IEquatable"
+ },
+ "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.ForceValidatePosDim View.GetMinWidthHeight(Size) View.SetMinWidthHeight() View.TextFormatter View.SuperView View.UpdateTextFormatterText() View.ProcessResizeView() 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.PreserveTrailingSpaces View.TextAlignment View.VerticalTextAlignment View.TextDirection View.IsInitialized View.IsAdded View.Enabled View.Visible View.Border View.ToString() View.GetAutoSize() View.GetHotKeySpecifierLength(Boolean) View.GetTextFormatterBoundsSize() View.GetBoundsTextFormatterSize() 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",
+ "title": "Enum Command",
+ "keywords": "Enum Command Actions which can be performed by the application or bound to keys in a View control. Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public enum Command Fields Name Description Accept Accepts the current state (e.g. selection, button press etc) BackTab Inserts a shift tab. BottomEnd Moves to bottom end. BottomEndExtend Extends the selection to the bottom end. Cancel Cancels any current temporary states on the control e.g. expanding a combo list Collapse Collapses a list or item (with subitems) CollapseAll Recursively collapses a list items of their children (if any) Copy Copies the current selection. Cut Cuts the current selection. CutToEndLine Deletes and copies to the clipboard the characters from the current position to the end of the line. CutToStartLine Deletes and copies to the clipboard the characters from the current position to the start of the line. DeleteAll Deletes all objects in the control. DeleteCharLeft Deletes the character on the left. DeleteCharRight Deletes the character on the right. DisableOverwrite Disables overwrite mode ( EnableOverwrite ) EnableOverwrite Enables overwrite mode such that newly typed text overwrites the text that is already there (typically associated with the Insert key). EndOfLine Moves the cursor to the end of line. EndOfLineExtend Extends the selection to the end of line. EndOfPage Moves the cursor to the bottom of page. Expand Expands a list or item (with subitems) ExpandAll Recursively Expands all child items and their child items (if any) KillWordBackwards Deletes the characters backwards. KillWordForwards Deletes the characters forwards. Left Moves the selection left one by the minimum increment supported by the view e.g. single character, cell, item etc. LeftExtend Extends the selection left one by the minimum increment supported by the view e.g. single character, cell, item etc. LeftHome Moves to the left begin. LeftHomeExtend Extends the selection to the left begin. LineDown Moves the caret down one line. LineDownExtend Extends the selection down one line. LineDownToLastBranch Moves the caret down to the last child node of the branch that holds the current selection LineUp Moves the caret up one line. LineUpExtend Extends the selection up one line. LineUpToFirstBranch Moves the caret up to the first child node of the branch that holds the current selection NewLine Inserts a new line. NextView Moves focus to the next view. NextViewOrTop Moves focus to the next view or toplevel (case of Mdi). OpenSelectedItem Open selected item. PageDown Move the page down. PageDownExtend Move the page down increase selection area to cover revealed objects/characters. PageLeft Moves to the left page. PageRight Moves to the right page. PageUp Move the page up. PageUpExtend Move the page up increase selection area to cover revealed objects/characters. Paste Pastes the current selection. PreviousView Moves focuss to the previous view. PreviousViewOrTop Moves focus to the next previous or toplevel (case of Mdi). QuitToplevel Quit a toplevel. Redo Redo changes. Refresh Refresh the application. Right Moves the selection right one by the minimum increment supported by the view e.g. single character, cell, item etc. RightEnd Moves to the right end. RightEndExtend Extends the selection to the right end. RightExtend Extends the selection right one by the minimum increment supported by the view e.g. single character, cell, item etc. ScrollDown Scrolls down one line (without changing the selection). ScrollLeft Scrolls one character to the left ScrollRight Scrolls one character to the right. ScrollUp Scrolls up one line (without changing the selection). SelectAll Selects all objects in the control. StartOfLine Moves the cursor to the start of line. StartOfLineExtend Extends the selection to the start of line. StartOfPage Moves the cursor to the top of page. Suspend Suspend a application (used on Linux). Tab Inserts a tab. ToggleChecked Toggle the checked state. ToggleExpandCollapse Toggles the Expanded or collapsed state of a a list or item (with subitems) ToggleExtend Toggles the extended selection. ToggleOverwrite Toggles overwrite mode such that newly typed text overwrites the text that is already there (typically associated with the Insert key). TopHome Moves to top begin. TopHomeExtend Extends the selection to the top begin. Undo Undo changes. UnixEmulation Unix emulation WordLeft Moves the caret to the start of the previous word. WordLeftExtend Extends the selection to the start of the previous word. WordRight Moves the caret to the start of the next word. WordRightExtend Extends the selection to the start of the next word."
+ },
+ "api/Terminal.Gui/Terminal.Gui.ConsoleDriver.DiagnosticFlags.html": {
+ "href": "api/Terminal.Gui/Terminal.Gui.ConsoleDriver.DiagnosticFlags.html",
+ "title": "Enum ConsoleDriver.DiagnosticFlags",
+ "keywords": "Enum ConsoleDriver.DiagnosticFlags Enables diagnostic functions Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax [Flags] public enum DiagnosticFlags : uint Fields Name Description FramePadding When Enabled, DrawWindowFrame(Rect, Int32, Int32, Int32, Int32, Boolean, Boolean, Border) will use 'L', 'R', 'T', and 'B' for padding instead of ' '. FrameRuler When enabled, DrawWindowFrame(Rect, Int32, Int32, Int32, Int32, Boolean, Boolean, Border) will draw a ruler in the frame for any side with a padding value greater than 0. Off All diagnostics off"
+ },
+ "api/Terminal.Gui/Terminal.Gui.ConsoleDriver.html": {
+ "href": "api/Terminal.Gui/Terminal.Gui.ConsoleDriver.html",
+ "title": "Class ConsoleDriver",
+ "keywords": "Class ConsoleDriver ConsoleDriver is an abstract class that defines the requirements for a console driver. There are currently three implementations: Terminal.Gui.CursesDriver (for Unix and Mac), Terminal.Gui.WindowsDriver , and Terminal.Gui.NetDriver that uses the .NET Console API. Inheritance System.Object ConsoleDriver FakeDriver Inherited Members System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) System.Object.ToString() Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public abstract class ConsoleDriver Fields 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 Contents The format is rows, columns and 3 values on the last column: Rune, Attribute and Dirty Flag Declaration public virtual int[,, ] Contents { 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() ResizeScreen() Resizes the clip area when the screen is resized. Declaration public abstract void ResizeScreen() 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 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() Disposes the all the context menu objects instances. 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",
+ "title": "Enum CursorVisibility",
+ "keywords": "Enum CursorVisibility Cursors Visibility that are displayed Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public enum CursorVisibility Fields Name Description Box Cursor caret is displayed as a blinking block ▉ BoxFix Cursor caret is displayed a block ▉ Default Cursor caret has default Invisible Cursor caret is hidden Underline Cursor caret is normally shown as a blinking underline bar _ UnderlineFix Cursor caret is normally shown as a underline bar _ Vertical Cursor caret is displayed a blinking vertical bar | VerticalFix Cursor caret is displayed a blinking vertical bar |"
+ },
+ "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.ForceValidatePosDim View.GetMinWidthHeight(Size) View.SetMinWidthHeight() View.TextFormatter View.SuperView View.UpdateTextFormatterText() View.ProcessResizeView() 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.PreserveTrailingSpaces View.TextAlignment View.VerticalTextAlignment View.TextDirection View.IsInitialized View.IsAdded View.Enabled View.Visible View.Border View.ToString() View.GetAutoSize() View.GetHotKeySpecifierLength(Boolean) View.GetTextFormatterBoundsSize() View.GetBoundsTextFormatterSize() 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",
+ "title": "Class DateTimeEventArgs",
+ "keywords": "Class DateTimeEventArgs Defines the event arguments for DateChanged and TimeChanged events. Inheritance System.Object System.EventArgs DateTimeEventArgs Inherited Members System.EventArgs.Empty System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) System.Object.ToString() Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class DateTimeEventArgs : EventArgs Type Parameters Name Description T Constructors DateTimeEventArgs(T, T, String) Initializes a new instance of DateTimeEventArgs Declaration public DateTimeEventArgs(T oldValue, T newValue, string format) Parameters Type Name Description T oldValue The old DateField or TimeField value. T newValue The new DateField or TimeField value. System.String format The DateField or TimeField format string. Properties Format The DateField or TimeField format. Declaration public string Format { get; } Property Value Type Description System.String NewValue The new DateField or TimeField value. Declaration public T NewValue { get; } Property Value Type Description T OldValue The old DateField or TimeField value. Declaration public T OldValue { get; } Property Value Type Description T"
+ },
+ "api/Terminal.Gui/Terminal.Gui.Dialog.ButtonAlignments.html": {
+ "href": "api/Terminal.Gui/Terminal.Gui.Dialog.ButtonAlignments.html",
+ "title": "Enum Dialog.ButtonAlignments",
+ "keywords": "Enum Dialog.ButtonAlignments Determines the horizontal alignment of the Dialog buttons. Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public enum ButtonAlignments Fields Name Description Center Center-aligns the buttons (the default). Justify Justifies the buttons Left Left-aligns the buttons Right Right-aligns the buttons"
+ },
+ "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 Wizard 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 Window.OnTitleChanging(ustring, ustring) Window.TitleChanging Window.OnTitleChanged(ustring, ustring) Window.TitleChanged 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.OnLoaded() 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.ForceValidatePosDim View.GetMinWidthHeight(Size) View.SetMinWidthHeight() View.TextFormatter View.SuperView View.UpdateTextFormatterText() View.ProcessResizeView() 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.PreserveTrailingSpaces View.VerticalTextAlignment View.TextDirection View.IsInitialized View.IsAdded View.Enabled View.Visible View.ToString() View.GetAutoSize() View.GetHotKeySpecifierLength(Boolean) View.GetTextFormatterBoundsSize() View.GetBoundsTextFormatterSize() 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. Properties ButtonAlignment Determines how the Dialog Button s are aligned along the bottom of the dialog. Declaration public Dialog.ButtonAlignments ButtonAlignment { get; set; } Property Value Type Description Dialog.ButtonAlignments 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",
+ "title": "Class Dim",
+ "keywords": "Class Dim Dim properties of a View to control the position. Inheritance System.Object Dim Inherited Members System.Object.Equals(System.Object, System.Object) 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 Dim Remarks Use the Dim objects on the Width or Height properties of a View to control the position. These can be used to set the absolute position, when merely assigning an integer value (via the implicit integer to Pos conversion), and they can be combined to produce more useful layouts, like: Pos.Center - 3, which would shift the position of the View 3 characters to the left after centering for example. Methods Equals(Object) Determines whether the specified object is equal to the current object. Declaration public override bool Equals(object other) Parameters Type Name Description System.Object other The object to compare with the current object. Returns Type Description System.Boolean true if the specified object is equal to the current object; otherwise, false . Overrides System.Object.Equals(System.Object) Fill(Int32) Initializes a new instance of the Dim class that fills the dimension, but leaves the specified number of colums for a margin. Declaration public static Dim Fill(int margin = 0) Parameters Type Name Description System.Int32 margin Margin to use. Returns Type Description Dim The Fill dimension. Function(Func) Creates a \"DimFunc\" from the specified function. Declaration public static Dim Function(Func function) Parameters Type Name Description System.Func < System.Int32 > function The function to be executed. Returns Type Description Dim The Dim returned from the function. GetHashCode() Serves as the default hash function. Declaration public override int GetHashCode() Returns Type Description System.Int32 A hash code for the current object. Overrides System.Object.GetHashCode() Height(View) Returns a Dim object tracks the Height of the specified View . Declaration public static Dim Height(View view) Parameters Type Name Description View view The view that will be tracked. Returns Type Description Dim The Dim of the other View . Percent(Single, Boolean) Creates a percentage Dim object Declaration public static Dim Percent(float n, bool r = false) Parameters Type Name Description System.Single n A value between 0 and 100 representing the percentage. System.Boolean r If true the Percent is computed based on the remaining space after the X/Y anchor positions. If false is computed based on the whole original space. Returns Type Description Dim The percent Dim object. Examples This initializes a TextField that is centered horizontally, is 50% of the way down, is 30% the height, and is 80% the width of the View it added to. var textView = new TextView () { X = Pos.Center (), Y = Pos.Percent (50), Width = Dim.Percent (80), Height = Dim.Percent (30), }; Sized(Int32) Creates an Absolute Dim from the specified integer value. Declaration public static Dim Sized(int n) Parameters Type Name Description System.Int32 n The value to convert to the Dim . Returns Type Description Dim The Absolute Dim . Width(View) Returns a Dim object tracks the Width of the specified View . Declaration public static Dim Width(View view) Parameters Type Name Description View view The view that will be tracked. Returns Type Description Dim The Dim of the other View . Operators Addition(Dim, Dim) Adds a Dim to a Dim , yielding a new Dim . Declaration public static Dim operator +(Dim left, Dim right) Parameters Type Name Description Dim left The first Dim to add. Dim right The second Dim to add. Returns Type Description Dim The Dim that is the sum of the values of left and right . Implicit(Int32 to Dim) Creates an Absolute Dim from the specified integer value. Declaration public static implicit operator Dim(int n) Parameters Type Name Description System.Int32 n The value to convert to the pos. Returns Type Description Dim The Absolute Dim . Subtraction(Dim, Dim) Subtracts a Dim from a Dim , yielding a new Dim . Declaration public static Dim operator -(Dim left, Dim right) Parameters Type Name Description Dim left The Dim to subtract from (the minuend). Dim right The Dim to subtract (the subtrahend). Returns Type Description Dim The Dim that is the left minus right ."
+ },
+ "api/Terminal.Gui/Terminal.Gui.DisplayModeLayout.html": {
+ "href": "api/Terminal.Gui/Terminal.Gui.DisplayModeLayout.html",
+ "title": "Enum DisplayModeLayout",
+ "keywords": "Enum DisplayModeLayout Used for choose the display mode of this RadioGroup Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public enum DisplayModeLayout Fields Name Description Horizontal Horizontal mode display. Vertical Vertical mode display. It's the default."
+ },
+ "api/Terminal.Gui/Terminal.Gui.FakeConsole.html": {
+ "href": "api/Terminal.Gui/Terminal.Gui.FakeConsole.html",
+ "title": "Class FakeConsole",
+ "keywords": "Class FakeConsole Inheritance System.Object FakeConsole Inherited Members System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) System.Object.ToString() Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public static class FakeConsole Fields HEIGHT Specifies the initial console height. Declaration public const int HEIGHT = 25 Field Value Type Description System.Int32 MockKeyPresses Declaration public static Stack MockKeyPresses Field Value Type Description System.Collections.Generic.Stack < System.ConsoleKeyInfo > WIDTH Specifies the initial console width. Declaration public const int WIDTH = 80 Field Value Type Description System.Int32 Properties BackgroundColor Declaration public static ConsoleColor BackgroundColor { get; set; } Property Value Type Description System.ConsoleColor BufferHeight Declaration public static int BufferHeight { get; set; } Property Value Type Description System.Int32 BufferWidth Declaration public static int BufferWidth { get; set; } Property Value Type Description System.Int32 CapsLock Declaration public static bool CapsLock { get; } Property Value Type Description System.Boolean CursorLeft Declaration public static int CursorLeft { get; set; } Property Value Type Description System.Int32 CursorSize Declaration public static int CursorSize { get; set; } Property Value Type Description System.Int32 CursorTop Declaration public static int CursorTop { get; set; } Property Value Type Description System.Int32 CursorVisible Declaration public static bool CursorVisible { get; set; } Property Value Type Description System.Boolean Error Declaration public static TextWriter Error { get; } Property Value Type Description System.IO.TextWriter ForegroundColor Declaration public static ConsoleColor ForegroundColor { get; set; } Property Value Type Description System.ConsoleColor In Declaration public static TextReader In { get; } Property Value Type Description System.IO.TextReader InputEncoding Declaration public static Encoding InputEncoding { get; set; } Property Value Type Description System.Text.Encoding IsErrorRedirected Declaration public static bool IsErrorRedirected { get; } Property Value Type Description System.Boolean IsInputRedirected Declaration public static bool IsInputRedirected { get; } Property Value Type Description System.Boolean IsOutputRedirected Declaration public static bool IsOutputRedirected { get; } Property Value Type Description System.Boolean KeyAvailable Declaration public static bool KeyAvailable { get; } Property Value Type Description System.Boolean LargestWindowHeight Declaration public static int LargestWindowHeight { get; } Property Value Type Description System.Int32 LargestWindowWidth Declaration public static int LargestWindowWidth { get; } Property Value Type Description System.Int32 NumberLock Declaration public static bool NumberLock { get; } Property Value Type Description System.Boolean Out Declaration public static TextWriter Out { get; } Property Value Type Description System.IO.TextWriter OutputEncoding Declaration public static Encoding OutputEncoding { get; set; } Property Value Type Description System.Text.Encoding Title Declaration public static string Title { get; set; } Property Value Type Description System.String TreatControlCAsInput Declaration public static bool TreatControlCAsInput { get; set; } Property Value Type Description System.Boolean WindowHeight Declaration public static int WindowHeight { get; set; } Property Value Type Description System.Int32 WindowLeft Declaration public static int WindowLeft { get; set; } Property Value Type Description System.Int32 WindowTop Declaration public static int WindowTop { get; set; } Property Value Type Description System.Int32 WindowWidth Declaration public static int WindowWidth { get; set; } Property Value Type Description System.Int32 Methods Beep() Declaration public static void Beep() Beep(Int32, Int32) Declaration public static void Beep(int frequency, int duration) Parameters Type Name Description System.Int32 frequency System.Int32 duration Clear() Declaration public static void Clear() MoveBufferArea(Int32, Int32, Int32, Int32, Int32, Int32) Declaration public static void MoveBufferArea(int sourceLeft, int sourceTop, int sourceWidth, int sourceHeight, int targetLeft, int targetTop) Parameters Type Name Description System.Int32 sourceLeft System.Int32 sourceTop System.Int32 sourceWidth System.Int32 sourceHeight System.Int32 targetLeft System.Int32 targetTop MoveBufferArea(Int32, Int32, Int32, Int32, Int32, Int32, Char, ConsoleColor, ConsoleColor) Declaration public static void MoveBufferArea(int sourceLeft, int sourceTop, int sourceWidth, int sourceHeight, int targetLeft, int targetTop, char sourceChar, ConsoleColor sourceForeColor, ConsoleColor sourceBackColor) Parameters Type Name Description System.Int32 sourceLeft System.Int32 sourceTop System.Int32 sourceWidth System.Int32 sourceHeight System.Int32 targetLeft System.Int32 targetTop System.Char sourceChar System.ConsoleColor sourceForeColor System.ConsoleColor sourceBackColor OpenStandardError() Declaration public static Stream OpenStandardError() Returns Type Description System.IO.Stream OpenStandardError(Int32) Declaration public static Stream OpenStandardError(int bufferSize) Parameters Type Name Description System.Int32 bufferSize Returns Type Description System.IO.Stream OpenStandardInput() Declaration public static Stream OpenStandardInput() Returns Type Description System.IO.Stream OpenStandardInput(Int32) Declaration public static Stream OpenStandardInput(int bufferSize) Parameters Type Name Description System.Int32 bufferSize Returns Type Description System.IO.Stream OpenStandardOutput() Declaration public static Stream OpenStandardOutput() Returns Type Description System.IO.Stream OpenStandardOutput(Int32) Declaration public static Stream OpenStandardOutput(int bufferSize) Parameters Type Name Description System.Int32 bufferSize Returns Type Description System.IO.Stream Read() Declaration public static int Read() Returns Type Description System.Int32 ReadKey() Declaration public static ConsoleKeyInfo ReadKey() Returns Type Description System.ConsoleKeyInfo ReadKey(Boolean) Declaration public static ConsoleKeyInfo ReadKey(bool intercept) Parameters Type Name Description System.Boolean intercept Returns Type Description System.ConsoleKeyInfo ReadLine() Declaration public static string ReadLine() Returns Type Description System.String ResetColor() Declaration public static void ResetColor() SetBufferSize(Int32, Int32) Declaration public static void SetBufferSize(int width, int height) Parameters Type Name Description System.Int32 width System.Int32 height SetCursorPosition(Int32, Int32) Declaration public static void SetCursorPosition(int left, int top) Parameters Type Name Description System.Int32 left System.Int32 top SetError(TextWriter) Declaration public static void SetError(TextWriter newError) Parameters Type Name Description System.IO.TextWriter newError SetIn(TextReader) Declaration public static void SetIn(TextReader newIn) Parameters Type Name Description System.IO.TextReader newIn SetOut(TextWriter) Declaration public static void SetOut(TextWriter newOut) Parameters Type Name Description System.IO.TextWriter newOut SetWindowPosition(Int32, Int32) Declaration public static void SetWindowPosition(int left, int top) Parameters Type Name Description System.Int32 left System.Int32 top SetWindowSize(Int32, Int32) Declaration public static void SetWindowSize(int width, int height) Parameters Type Name Description System.Int32 width System.Int32 height Write(Boolean) Declaration public static void Write(bool value) Parameters Type Name Description System.Boolean value Write(Char) Declaration public static void Write(char value) Parameters Type Name Description System.Char value Write(Char[]) Declaration public static void Write(char[] buffer) Parameters Type Name Description System.Char [] buffer Write(Char[], Int32, Int32) Declaration public static void Write(char[] buffer, int index, int count) Parameters Type Name Description System.Char [] buffer System.Int32 index System.Int32 count Write(Decimal) Declaration public static void Write(decimal value) Parameters Type Name Description System.Decimal value Write(Double) Declaration public static void Write(double value) Parameters Type Name Description System.Double value Write(Int32) Declaration public static void Write(int value) Parameters Type Name Description System.Int32 value Write(Int64) Declaration public static void Write(long value) Parameters Type Name Description System.Int64 value Write(Object) Declaration public static void Write(object value) Parameters Type Name Description System.Object value Write(Single) Declaration public static void Write(float value) Parameters Type Name Description System.Single value Write(String) Declaration public static void Write(string value) Parameters Type Name Description System.String value Write(String, Object) Declaration public static void Write(string format, object arg0) Parameters Type Name Description System.String format System.Object arg0 Write(String, Object, Object) Declaration public static void Write(string format, object arg0, object arg1) Parameters Type Name Description System.String format System.Object arg0 System.Object arg1 Write(String, Object, Object, Object) Declaration public static void Write(string format, object arg0, object arg1, object arg2) Parameters Type Name Description System.String format System.Object arg0 System.Object arg1 System.Object arg2 Write(String, Object, Object, Object, Object) Declaration public static void Write(string format, object arg0, object arg1, object arg2, object arg3) Parameters Type Name Description System.String format System.Object arg0 System.Object arg1 System.Object arg2 System.Object arg3 Write(String, Object[]) Declaration public static void Write(string format, params object[] arg) Parameters Type Name Description System.String format System.Object [] arg Write(UInt32) Declaration public static void Write(uint value) Parameters Type Name Description System.UInt32 value Write(UInt64) Declaration public static void Write(ulong value) Parameters Type Name Description System.UInt64 value WriteLine() Declaration public static void WriteLine() WriteLine(Boolean) Declaration public static void WriteLine(bool value) Parameters Type Name Description System.Boolean value WriteLine(Char) Declaration public static void WriteLine(char value) Parameters Type Name Description System.Char value WriteLine(Char[]) Declaration public static void WriteLine(char[] buffer) Parameters Type Name Description System.Char [] buffer WriteLine(Char[], Int32, Int32) Declaration public static void WriteLine(char[] buffer, int index, int count) Parameters Type Name Description System.Char [] buffer System.Int32 index System.Int32 count WriteLine(Decimal) Declaration public static void WriteLine(decimal value) Parameters Type Name Description System.Decimal value WriteLine(Double) Declaration public static void WriteLine(double value) Parameters Type Name Description System.Double value WriteLine(Int32) Declaration public static void WriteLine(int value) Parameters Type Name Description System.Int32 value WriteLine(Int64) Declaration public static void WriteLine(long value) Parameters Type Name Description System.Int64 value WriteLine(Object) Declaration public static void WriteLine(object value) Parameters Type Name Description System.Object value WriteLine(Single) Declaration public static void WriteLine(float value) Parameters Type Name Description System.Single value WriteLine(String) Declaration public static void WriteLine(string value) Parameters Type Name Description System.String value WriteLine(String, Object) Declaration public static void WriteLine(string format, object arg0) Parameters Type Name Description System.String format System.Object arg0 WriteLine(String, Object, Object) Declaration public static void WriteLine(string format, object arg0, object arg1) Parameters Type Name Description System.String format System.Object arg0 System.Object arg1 WriteLine(String, Object, Object, Object) Declaration public static void WriteLine(string format, object arg0, object arg1, object arg2) Parameters Type Name Description System.String format System.Object arg0 System.Object arg1 System.Object arg2 WriteLine(String, Object, Object, Object, Object) Declaration public static void WriteLine(string format, object arg0, object arg1, object arg2, object arg3) Parameters Type Name Description System.String format System.Object arg0 System.Object arg1 System.Object arg2 System.Object arg3 WriteLine(String, Object[]) Declaration public static void WriteLine(string format, params object[] arg) Parameters Type Name Description System.String format System.Object [] arg WriteLine(UInt32) Declaration public static void WriteLine(uint value) Parameters Type Name Description System.UInt32 value WriteLine(UInt64) Declaration public static void WriteLine(ulong value) Parameters Type Name Description System.UInt64 value"
+ },
+ "api/Terminal.Gui/Terminal.Gui.FakeDriver.html": {
+ "href": "api/Terminal.Gui/Terminal.Gui.FakeDriver.html",
+ "title": "Class FakeDriver",
+ "keywords": "Class FakeDriver Implements a mock ConsoleDriver for unit testing Inheritance System.Object ConsoleDriver FakeDriver Inherited Members ConsoleDriver.TerminalResized ConsoleDriver.MakePrintable(Rune) ConsoleDriver.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 Contents Assists with testing, the format is rows, columns and 3 values on the last column: Rune, Attribute and Dirty Flag Declaration public override int[,, ] Contents { get; } Property Value Type Description System.Int32 [,,] Overrides ConsoleDriver.Contents 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() ResizeScreen() Declaration public override void ResizeScreen() Overrides ConsoleDriver.ResizeScreen() 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",
+ "title": "Class FakeMainLoop",
+ "keywords": "Class 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. Inheritance System.Object FakeMainLoop Implements IMainLoopDriver 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 FakeMainLoop : IMainLoopDriver Remarks This implementation is used for FakeDriver. Constructors FakeMainLoop(Func) Initializes the class. Declaration public FakeMainLoop(Func consoleKeyReaderFn = null) Parameters Type Name Description System.Func < System.ConsoleKeyInfo > consoleKeyReaderFn The method to be called to get a key from the console. Remarks Passing a consoleKeyReaderfn is provided to support unit test scenarios. Fields KeyPressed Invoked when a Key is pressed. Declaration public Action KeyPressed Field Value Type Description System.Action < System.ConsoleKeyInfo > Explicit Interface Implementations IMainLoopDriver.EventsPending(Boolean) Declaration bool IMainLoopDriver.EventsPending(bool wait) Parameters Type Name Description System.Boolean wait Returns Type Description System.Boolean IMainLoopDriver.MainIteration() Declaration void IMainLoopDriver.MainIteration() IMainLoopDriver.Setup(MainLoop) Declaration void IMainLoopDriver.Setup(MainLoop mainLoop) Parameters Type Name Description MainLoop mainLoop IMainLoopDriver.Wakeup() Declaration void IMainLoopDriver.Wakeup() Implements IMainLoopDriver"
+ },
+ "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.ButtonAlignment Dialog.ProcessKey(KeyEvent) Window.Title Window.Border Window.Add(View) Window.Remove(View) Window.RemoveAll() Window.Redraw(Rect) Window.OnCanFocusChanged() Window.Text Window.TextAlignment Window.OnTitleChanging(ustring, ustring) Window.TitleChanging Window.OnTitleChanged(ustring, ustring) Window.TitleChanged 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.OnLoaded() 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.ForceValidatePosDim View.GetMinWidthHeight(Size) View.SetMinWidthHeight() View.TextFormatter View.SuperView View.UpdateTextFormatterText() View.ProcessResizeView() 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.PreserveTrailingSpaces View.VerticalTextAlignment View.TextDirection View.IsInitialized View.IsAdded View.Enabled View.Visible View.ToString() View.GetAutoSize() View.GetHotKeySpecifierLength(Boolean) View.GetTextFormatterBoundsSize() View.GetBoundsTextFormatterSize() 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 Wizard.WizardStep 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.ForceValidatePosDim View.GetMinWidthHeight(Size) View.SetMinWidthHeight() View.TextFormatter View.SuperView View.UpdateTextFormatterText() View.ProcessResizeView() 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.PreserveTrailingSpaces View.VerticalTextAlignment View.TextDirection View.IsInitialized View.IsAdded View.Enabled View.Visible View.ToString() View.GetAutoSize() View.GetHotKeySpecifierLength(Boolean) View.GetTextFormatterBoundsSize() View.GetBoundsTextFormatterSize() 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",
+ "title": "Class Axis",
+ "keywords": "Class Axis Renders a continuous line with grid line ticks and labels Inheritance System.Object Axis HorizontalAxis VerticalAxis 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.Graphs Assembly : Terminal.Gui.dll Syntax public abstract class Axis Constructors Axis(Orientation) Populates base properties and sets the read only Orientation Declaration protected Axis(Orientation orientation) Parameters Type Name Description Orientation orientation Fields LabelGetter Allows you to control what label text is rendered for a given Increment when ShowLabelsEvery is above 0 Declaration public LabelGetterDelegate LabelGetter Field Value Type Description LabelGetterDelegate Properties Increment Number of units of graph space between ticks on axis. 0 for no ticks Declaration public float Increment { get; set; } Property Value Type Description System.Single Minimum The minimum axis point to show. Defaults to null (no minimum) Declaration public float? Minimum { get; set; } Property Value Type Description System.Nullable < System.Single > Orientation Direction of the axis Declaration public Orientation Orientation { get; } Property Value Type Description Orientation ShowLabelsEvery The number of Increment before an label is added. 0 = never show labels Declaration public uint ShowLabelsEvery { get; set; } Property Value Type Description System.UInt32 Text Displayed below/to left of labels (see Orientation ). If text is not visible, check MarginBottom / MarginLeft Declaration public string Text { get; set; } Property Value Type Description System.String Visible True to render axis. Defaults to true Declaration public bool Visible { get; set; } Property Value Type Description System.Boolean Methods DrawAxisLabel(GraphView, Int32, String) Draws a custom label text at screenPosition units along the axis (X or Y depending on Orientation ) Declaration public abstract void DrawAxisLabel(GraphView graph, int screenPosition, string text) Parameters Type Name Description GraphView graph System.Int32 screenPosition System.String text DrawAxisLabels(GraphView) Draws labels and axis Increment ticks Declaration public abstract void DrawAxisLabels(GraphView graph) Parameters Type Name Description GraphView graph DrawAxisLine(GraphView) Draws the solid line of the axis Declaration public abstract void DrawAxisLine(GraphView graph) Parameters Type Name Description GraphView graph DrawAxisLine(GraphView, Int32, Int32) Draws a single cell of the solid line of the axis Declaration protected abstract void DrawAxisLine(GraphView graph, int x, int y) Parameters Type Name Description GraphView graph System.Int32 x System.Int32 y Reset() Resets all configurable properties of the axis to default values Declaration public virtual void Reset()"
+ },
+ "api/Terminal.Gui/Terminal.Gui.Graphs.AxisIncrementToRender.html": {
+ "href": "api/Terminal.Gui/Terminal.Gui.Graphs.AxisIncrementToRender.html",
+ "title": "Class AxisIncrementToRender",
+ "keywords": "Class AxisIncrementToRender A location on an axis of a GraphView that may or may not have a label associated with it Inheritance System.Object AxisIncrementToRender 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.Graphs Assembly : Terminal.Gui.dll Syntax public class AxisIncrementToRender Constructors AxisIncrementToRender(Orientation, Int32, Single) Describe a new section of an axis that requires an axis increment symbol and/or label Declaration public AxisIncrementToRender(Orientation orientation, int screen, float value) Parameters Type Name Description Orientation orientation System.Int32 screen System.Single value Properties Orientation Direction of the parent axis Declaration public Orientation Orientation { get; } Property Value Type Description Orientation ScreenLocation The screen location (X or Y depending on Orientation ) that the increment will be rendered at Declaration public int ScreenLocation { get; } Property Value Type Description System.Int32 Value The value at this position on the axis in graph space Declaration public float Value { get; } Property Value Type Description System.Single"
+ },
+ "api/Terminal.Gui/Terminal.Gui.Graphs.BarSeries.Bar.html": {
+ "href": "api/Terminal.Gui/Terminal.Gui.Graphs.BarSeries.Bar.html",
+ "title": "Class BarSeries.Bar",
+ "keywords": "Class BarSeries.Bar A single bar in a BarSeries Inheritance System.Object BarSeries.Bar 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.Graphs Assembly : Terminal.Gui.dll Syntax public class Bar Constructors Bar(String, GraphCellToRender, Single) Creates a new instance of a single bar rendered in the given fill that extends out value graph space units in the default Orientation Declaration public Bar(string text, GraphCellToRender fill, float value) Parameters Type Name Description System.String text GraphCellToRender fill System.Single value Properties Fill The color and character that will be rendered in the console when the bar extends over it Declaration public GraphCellToRender Fill { get; set; } Property Value Type Description GraphCellToRender Text Optional text that describes the bar. This will be rendered on the corresponding Axis unless DrawLabels is false Declaration public string Text { get; set; } Property Value Type Description System.String Value The value in graph space X/Y (depending on Orientation ) to which the bar extends. Declaration public float Value { get; } Property Value Type Description System.Single"
+ },
+ "api/Terminal.Gui/Terminal.Gui.Graphs.BarSeries.html": {
+ "href": "api/Terminal.Gui/Terminal.Gui.Graphs.BarSeries.html",
+ "title": "Class BarSeries",
+ "keywords": "Class BarSeries Series of bars positioned at regular intervals Inheritance System.Object BarSeries Implements ISeries 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.Graphs Assembly : Terminal.Gui.dll Syntax public class BarSeries : ISeries Properties BarEvery Determines the spacing of bars along the axis. Defaults to 1 i.e. every 1 unit of graph space a bar is rendered. Note that you should also consider CellSize when changing this. Declaration public float BarEvery { get; set; } Property Value Type Description System.Single Bars Ordered collection of graph bars to position along axis Declaration public List Bars { get; set; } Property Value Type Description System.Collections.Generic.List < BarSeries.Bar > DrawLabels True to draw Text along the axis under the bar. Defaults to true. Declaration public bool DrawLabels { get; set; } Property Value Type Description System.Boolean Offset The number of units of graph space along the axis before rendering the first bar (and subsequent bars - see BarEvery ). Defaults to 0 Declaration public float Offset { get; set; } Property Value Type Description System.Single Orientation Direction bars protrude from the corresponding axis. Defaults to vertical Declaration public Orientation Orientation { get; set; } Property Value Type Description Orientation OverrideBarColor Overrides the Fill with a fixed color Declaration public Attribute? OverrideBarColor { get; set; } Property Value Type Description System.Nullable < Attribute > Methods AdjustColor(GraphCellToRender) Applies any color overriding Declaration protected virtual GraphCellToRender AdjustColor(GraphCellToRender graphCellToRender) Parameters Type Name Description GraphCellToRender graphCellToRender Returns Type Description GraphCellToRender DrawBarLine(GraphView, Point, Point, BarSeries.Bar) Override to do custom drawing of the bar e.g. to apply varying color or changing the fill symbol mid bar. Declaration protected virtual void DrawBarLine(GraphView graph, Point start, Point end, BarSeries.Bar beingDrawn) Parameters Type Name Description GraphView graph Point start Screen position of the start of the bar Point end Screen position of the end of the bar BarSeries.Bar beingDrawn The Bar that occupies this space and is being drawn DrawSeries(GraphView, Rect, RectangleF) Draws bars that are currently in the drawBounds Declaration public virtual void DrawSeries(GraphView graph, Rect drawBounds, RectangleF graphBounds) Parameters Type Name Description GraphView graph Rect drawBounds Screen area of the graph excluding margins RectangleF graphBounds Graph space area that should be drawn into drawBounds Implements ISeries"
+ },
+ "api/Terminal.Gui/Terminal.Gui.Graphs.GraphCellToRender.html": {
+ "href": "api/Terminal.Gui/Terminal.Gui.Graphs.GraphCellToRender.html",
+ "title": "Class GraphCellToRender",
+ "keywords": "Class GraphCellToRender Describes how to render a single row/column of a GraphView based on the value(s) in ISeries at that location Inheritance System.Object GraphCellToRender 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.Graphs Assembly : Terminal.Gui.dll Syntax public class GraphCellToRender Constructors GraphCellToRender(Rune) Creates instance and sets Rune with default graph coloring Declaration public GraphCellToRender(Rune rune) Parameters Type Name Description System.Rune rune GraphCellToRender(Rune, Nullable) Creates instance and sets Rune and Color (or default if null) Declaration public GraphCellToRender(Rune rune, Attribute? color) Parameters Type Name Description System.Rune rune System.Nullable < Attribute > color GraphCellToRender(Rune, Attribute) Creates instance and sets Rune with custom graph coloring Declaration public GraphCellToRender(Rune rune, Attribute color) Parameters Type Name Description System.Rune rune Attribute color Properties Color Optional color to render the Rune with Declaration public Attribute? Color { get; set; } Property Value Type Description System.Nullable < Attribute > Rune The character to render in the console Declaration public Rune Rune { get; set; } Property Value Type Description System.Rune"
+ },
+ "api/Terminal.Gui/Terminal.Gui.Graphs.HorizontalAxis.html": {
+ "href": "api/Terminal.Gui/Terminal.Gui.Graphs.HorizontalAxis.html",
+ "title": "Class HorizontalAxis",
+ "keywords": "Class HorizontalAxis The horizontal (x axis) of a GraphView Inheritance System.Object Axis HorizontalAxis Inherited Members Axis.Orientation Axis.Increment Axis.ShowLabelsEvery Axis.Visible Axis.LabelGetter Axis.Text Axis.Minimum Axis.Reset() 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.Graphs Assembly : Terminal.Gui.dll Syntax public class HorizontalAxis : Axis Constructors HorizontalAxis() Creates a new instance of axis with an Orientation of Horizontal Declaration public HorizontalAxis() Methods DrawAxisLabel(GraphView, Int32, String) Draws the given text on the axis at x screenPosition . For the screen y position use GetAxisYPosition(GraphView) Declaration public override void DrawAxisLabel(GraphView graph, int screenPosition, string text) Parameters Type Name Description GraphView graph Graph being drawn onto System.Int32 screenPosition Number of screen columns along the axis to take before rendering System.String text Text to render under the axis tick Overrides Axis.DrawAxisLabel(GraphView, Int32, String) DrawAxisLabels(GraphView) Draws the horizontal x axis labels and Increment ticks Declaration public override void DrawAxisLabels(GraphView graph) Parameters Type Name Description GraphView graph Overrides Axis.DrawAxisLabels(GraphView) DrawAxisLine(GraphView) Draws the horizontal axis line Declaration public override void DrawAxisLine(GraphView graph) Parameters Type Name Description GraphView graph Overrides Axis.DrawAxisLine(GraphView) DrawAxisLine(GraphView, Int32, Int32) Draws a horizontal axis line at the given x , y screen coordinates Declaration protected override void DrawAxisLine(GraphView graph, int x, int y) Parameters Type Name Description GraphView graph System.Int32 x System.Int32 y Overrides Axis.DrawAxisLine(GraphView, Int32, Int32) GetAxisYPosition(GraphView) Returns the Y screen position of the origin (typically 0,0) of graph space. Return value is bounded by the screen i.e. the axis is always rendered even if the origin is offscreen. Declaration public int GetAxisYPosition(GraphView graph) Parameters Type Name Description GraphView graph Returns Type Description System.Int32"
+ },
+ "api/Terminal.Gui/Terminal.Gui.Graphs.html": {
+ "href": "api/Terminal.Gui/Terminal.Gui.Graphs.html",
+ "title": "Namespace Terminal.Gui.Graphs",
+ "keywords": "Namespace Terminal.Gui.Graphs Classes Axis Renders a continuous line with grid line ticks and labels AxisIncrementToRender A location on an axis of a GraphView that may or may not have a label associated with it BarSeries Series of bars positioned at regular intervals BarSeries.Bar A single bar in a BarSeries GraphCellToRender Describes how to render a single row/column of a GraphView based on the value(s) in ISeries at that location HorizontalAxis The horizontal (x axis) of a GraphView LegendAnnotation A box containing symbol definitions e.g. meanings for colors in a graph. The 'Key' to the graph MultiBarSeries Collection of BarSeries in which bars are clustered by category PathAnnotation Sequence of lines to connect points e.g. of a ScatterSeries PathAnnotation.LineF Describes two points in graph space and a line between them ScatterSeries Series composed of any number of discrete data points TextAnnotation Displays text at a given position (in screen space or graph space) VerticalAxis The vertical (i.e. Y axis) of a GraphView Interfaces IAnnotation Describes an overlay element that is rendered either before or after a series. Annotations can be positioned either in screen space (e.g. a legend) or in graph space (e.g. a line showing high point) Unlike ISeries , annotations are allowed to draw into graph margins ISeries Describes a series of data that can be rendered into a GraphView > Enums Orientation Direction of an element (horizontal or vertical) Delegates LabelGetterDelegate Delegate for custom formatting of axis labels. Determines what should be displayed at a given label"
+ },
+ "api/Terminal.Gui/Terminal.Gui.Graphs.IAnnotation.html": {
+ "href": "api/Terminal.Gui/Terminal.Gui.Graphs.IAnnotation.html",
+ "title": "Interface IAnnotation",
+ "keywords": "Interface IAnnotation Describes an overlay element that is rendered either before or after a series. Annotations can be positioned either in screen space (e.g. a legend) or in graph space (e.g. a line showing high point) Unlike ISeries , annotations are allowed to draw into graph margins Namespace : Terminal.Gui.Graphs Assembly : Terminal.Gui.dll Syntax public interface IAnnotation Properties BeforeSeries True if annotation should be drawn before ISeries . This allowes Series and later annotations to potentially draw over the top of this annotation. Declaration bool BeforeSeries { get; } Property Value Type Description System.Boolean Methods Render(GraphView) Called once after series have been rendered (or before if BeforeSeries is true). Use Driver to draw and Bounds to avoid drawing outside of graph Declaration void Render(GraphView graph) Parameters Type Name Description GraphView graph"
+ },
+ "api/Terminal.Gui/Terminal.Gui.Graphs.ISeries.html": {
+ "href": "api/Terminal.Gui/Terminal.Gui.Graphs.ISeries.html",
+ "title": "Interface ISeries",
+ "keywords": "Interface ISeries Describes a series of data that can be rendered into a GraphView > Namespace : Terminal.Gui.Graphs Assembly : Terminal.Gui.dll Syntax public interface ISeries Methods DrawSeries(GraphView, Rect, RectangleF) Draws the graphBounds section of a series into the graph view drawBounds Declaration void DrawSeries(GraphView graph, Rect drawBounds, RectangleF graphBounds) Parameters Type Name Description GraphView graph Graph series is to be drawn onto Rect drawBounds Visible area of the graph in Console Screen units (excluding margins) RectangleF graphBounds Visible area of the graph in Graph space units"
+ },
+ "api/Terminal.Gui/Terminal.Gui.Graphs.LabelGetterDelegate.html": {
+ "href": "api/Terminal.Gui/Terminal.Gui.Graphs.LabelGetterDelegate.html",
+ "title": "Delegate LabelGetterDelegate",
+ "keywords": "Delegate LabelGetterDelegate Delegate for custom formatting of axis labels. Determines what should be displayed at a given label Namespace : Terminal.Gui.Graphs Assembly : Terminal.Gui.dll Syntax public delegate string LabelGetterDelegate(AxisIncrementToRender toRender); Parameters Type Name Description AxisIncrementToRender toRender The axis increment to which the label is attached Returns Type Description System.String"
+ },
+ "api/Terminal.Gui/Terminal.Gui.Graphs.LegendAnnotation.html": {
+ "href": "api/Terminal.Gui/Terminal.Gui.Graphs.LegendAnnotation.html",
+ "title": "Class LegendAnnotation",
+ "keywords": "Class LegendAnnotation A box containing symbol definitions e.g. meanings for colors in a graph. The 'Key' to the graph Inheritance System.Object LegendAnnotation Implements IAnnotation 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.Graphs Assembly : Terminal.Gui.dll Syntax public class LegendAnnotation : IAnnotation Constructors LegendAnnotation(Rect) Creates a new empty legend at the given screen coordinates Declaration public LegendAnnotation(Rect legendBounds) Parameters Type Name Description Rect legendBounds Defines the area available for the legend to render in (within the graph). This is in screen units (i.e. not graph space) Properties BeforeSeries Returns false i.e. Lengends render after series Declaration public bool BeforeSeries { get; } Property Value Type Description System.Boolean Border True to draw a solid border around the legend. Defaults to true. This border will be within the Bounds and so reduces the width/height available for text by 2 Declaration public bool Border { get; set; } Property Value Type Description System.Boolean Bounds Defines the screen area available for the legend to render in Declaration public Rect Bounds { get; set; } Property Value Type Description Rect Methods AddEntry(GraphCellToRender, String) Adds an entry into the legend. Duplicate entries are permissable Declaration public void AddEntry(GraphCellToRender graphCellToRender, string text) Parameters Type Name Description GraphCellToRender graphCellToRender The symbol appearing on the graph that should appear in the legend System.String text Text to render on this line of the legend. Will be truncated if outside of Legend Bounds Render(GraphView) Draws the Legend and all entries into the area within Bounds Declaration public void Render(GraphView graph) Parameters Type Name Description GraphView graph Implements IAnnotation"
+ },
+ "api/Terminal.Gui/Terminal.Gui.Graphs.MultiBarSeries.html": {
+ "href": "api/Terminal.Gui/Terminal.Gui.Graphs.MultiBarSeries.html",
+ "title": "Class MultiBarSeries",
+ "keywords": "Class MultiBarSeries Collection of BarSeries in which bars are clustered by category Inheritance System.Object MultiBarSeries Implements ISeries 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.Graphs Assembly : Terminal.Gui.dll Syntax public class MultiBarSeries : ISeries Constructors MultiBarSeries(Int32, Single, Single, Attribute[]) Creates a new series of clustered bars. Declaration public MultiBarSeries(int numberOfBarsPerCategory, float barsEvery, float spacing, Attribute[] colors = null) Parameters Type Name Description System.Int32 numberOfBarsPerCategory Each category has this many bars System.Single barsEvery How far appart to put each category (in graph space) System.Single spacing How much spacing between bars in a category (should be less than barsEvery / numberOfBarsPerCategory ) Attribute [] colors Array of colors that define bar color in each category. Length must match numberOfBarsPerCategory Properties Spacing The number of units of graph space between bars. Should be less than BarEvery Declaration public float Spacing { get; } Property Value Type Description System.Single SubSeries Sub collections. Each series contains the bars for a different category. Thus SubSeries[0].Bars[0] is the first bar on the axis and SubSeries[1].Bars[0] is the second etc Declaration public IReadOnlyCollection SubSeries { get; } Property Value Type Description System.Collections.Generic.IReadOnlyCollection < BarSeries > Methods AddBars(String, Rune, Single[]) Adds a new cluster of bars Declaration public void AddBars(string label, Rune fill, params float[] values) Parameters Type Name Description System.String label System.Rune fill System.Single [] values Values for each bar in category, must match the number of bars per category DrawSeries(GraphView, Rect, RectangleF) Draws all SubSeries Declaration public void DrawSeries(GraphView graph, Rect drawBounds, RectangleF graphBounds) Parameters Type Name Description GraphView graph Rect drawBounds RectangleF graphBounds Implements ISeries"
+ },
+ "api/Terminal.Gui/Terminal.Gui.Graphs.Orientation.html": {
+ "href": "api/Terminal.Gui/Terminal.Gui.Graphs.Orientation.html",
+ "title": "Enum Orientation",
+ "keywords": "Enum Orientation Direction of an element (horizontal or vertical) Namespace : Terminal.Gui.Graphs Assembly : Terminal.Gui.dll Syntax public enum Orientation Fields Name Description Horizontal Left to right Vertical Bottom to top"
+ },
+ "api/Terminal.Gui/Terminal.Gui.Graphs.PathAnnotation.html": {
+ "href": "api/Terminal.Gui/Terminal.Gui.Graphs.PathAnnotation.html",
+ "title": "Class PathAnnotation",
+ "keywords": "Class PathAnnotation Sequence of lines to connect points e.g. of a ScatterSeries Inheritance System.Object PathAnnotation Implements IAnnotation 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.Graphs Assembly : Terminal.Gui.dll Syntax public class PathAnnotation : IAnnotation Properties BeforeSeries True to add line before plotting series. Defaults to false Declaration public bool BeforeSeries { get; set; } Property Value Type Description System.Boolean LineColor Color for the line that connects points Declaration public Attribute? LineColor { get; set; } Property Value Type Description System.Nullable < Attribute > LineRune The symbol that gets drawn along the line, defaults to '.' Declaration public Rune LineRune { get; set; } Property Value Type Description System.Rune Points Points that should be connected. Lines will be drawn between points in the order they appear in the list Declaration public List Points { get; set; } Property Value Type Description System.Collections.Generic.List < PointF > Methods Render(GraphView) Draws lines connecting each of the Points Declaration public void Render(GraphView graph) Parameters Type Name Description GraphView graph Implements IAnnotation"
+ },
+ "api/Terminal.Gui/Terminal.Gui.Graphs.PathAnnotation.LineF.html": {
+ "href": "api/Terminal.Gui/Terminal.Gui.Graphs.PathAnnotation.LineF.html",
+ "title": "Class PathAnnotation.LineF",
+ "keywords": "Class PathAnnotation.LineF Describes two points in graph space and a line between them Inheritance System.Object PathAnnotation.LineF 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.Graphs Assembly : Terminal.Gui.dll Syntax public class LineF Constructors LineF(PointF, PointF) Creates a new line between the points Declaration public LineF(PointF start, PointF end) Parameters Type Name Description PointF start PointF end Properties End The end point of the line Declaration public PointF End { get; } Property Value Type Description PointF Start The start of the line Declaration public PointF Start { get; } Property Value Type Description PointF"
+ },
+ "api/Terminal.Gui/Terminal.Gui.Graphs.ScatterSeries.html": {
+ "href": "api/Terminal.Gui/Terminal.Gui.Graphs.ScatterSeries.html",
+ "title": "Class ScatterSeries",
+ "keywords": "Class ScatterSeries Series composed of any number of discrete data points Inheritance System.Object ScatterSeries Implements ISeries 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.Graphs Assembly : Terminal.Gui.dll Syntax public class ScatterSeries : ISeries Properties Fill The color and character that will be rendered in the console when there are point(s) in the corresponding graph space. Defaults to uncolored 'x' Declaration public GraphCellToRender Fill { get; set; } Property Value Type Description GraphCellToRender Points Collection of each discrete point in the series Declaration public List Points { get; set; } Property Value Type Description System.Collections.Generic.List < PointF > Methods DrawSeries(GraphView, Rect, RectangleF) Draws all points directly onto the graph Declaration public void DrawSeries(GraphView graph, Rect drawBounds, RectangleF graphBounds) Parameters Type Name Description GraphView graph Rect drawBounds RectangleF graphBounds Implements ISeries"
+ },
+ "api/Terminal.Gui/Terminal.Gui.Graphs.TextAnnotation.html": {
+ "href": "api/Terminal.Gui/Terminal.Gui.Graphs.TextAnnotation.html",
+ "title": "Class TextAnnotation",
+ "keywords": "Class TextAnnotation Displays text at a given position (in screen space or graph space) Inheritance System.Object TextAnnotation Implements IAnnotation 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.Graphs Assembly : Terminal.Gui.dll Syntax public class TextAnnotation : IAnnotation Properties BeforeSeries True to add text before plotting series. Defaults to false Declaration public bool BeforeSeries { get; set; } Property Value Type Description System.Boolean GraphPosition The location in graph space to draw the Text . This annotation will only show if the point is in the current viewable area of the graph presented in the GraphView Declaration public PointF GraphPosition { get; set; } Property Value Type Description PointF ScreenPosition The location on screen to draw the Text regardless of scroll/zoom settings. This overrides GraphPosition if specified. Declaration public Point? ScreenPosition { get; set; } Property Value Type Description System.Nullable < Point > Text Text to display on the graph Declaration public string Text { get; set; } Property Value Type Description System.String Methods DrawText(GraphView, Int32, Int32) Draws the Text at the given coordinates with truncation to avoid spilling over of the graph Declaration protected void DrawText(GraphView graph, int x, int y) Parameters Type Name Description GraphView graph System.Int32 x Screen x position to start drawing string System.Int32 y Screen y position to start drawing string Render(GraphView) Draws the annotation Declaration public void Render(GraphView graph) Parameters Type Name Description GraphView graph Implements IAnnotation"
+ },
+ "api/Terminal.Gui/Terminal.Gui.Graphs.VerticalAxis.html": {
+ "href": "api/Terminal.Gui/Terminal.Gui.Graphs.VerticalAxis.html",
+ "title": "Class VerticalAxis",
+ "keywords": "Class VerticalAxis The vertical (i.e. Y axis) of a GraphView Inheritance System.Object Axis VerticalAxis Inherited Members Axis.Orientation Axis.Increment Axis.ShowLabelsEvery Axis.Visible Axis.LabelGetter Axis.Text Axis.Minimum Axis.Reset() 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.Graphs Assembly : Terminal.Gui.dll Syntax public class VerticalAxis : Axis Constructors VerticalAxis() Creates a new Vertical axis Declaration public VerticalAxis() Methods DrawAxisLabel(GraphView, Int32, String) Draws the given text on the axis at y screenPosition . For the screen x position use GetAxisXPosition(GraphView) Declaration public override void DrawAxisLabel(GraphView graph, int screenPosition, string text) Parameters Type Name Description GraphView graph Graph being drawn onto System.Int32 screenPosition Number of rows from the top of the screen (i.e. down the axis) before rendering System.String text Text to render to the left of the axis tick. Ensure to set MarginLeft or ScrollOffset sufficient that it is visible Overrides Axis.DrawAxisLabel(GraphView, Int32, String) DrawAxisLabels(GraphView) Draws axis Increment markers and labels Declaration public override void DrawAxisLabels(GraphView graph) Parameters Type Name Description GraphView graph Overrides Axis.DrawAxisLabels(GraphView) DrawAxisLine(GraphView) Draws the vertical axis line Declaration public override void DrawAxisLine(GraphView graph) Parameters Type Name Description GraphView graph Overrides Axis.DrawAxisLine(GraphView) DrawAxisLine(GraphView, Int32, Int32) Draws a vertical axis line at the given x , y screen coordinates Declaration protected override void DrawAxisLine(GraphView graph, int x, int y) Parameters Type Name Description GraphView graph System.Int32 x System.Int32 y Overrides Axis.DrawAxisLine(GraphView, Int32, Int32) GetAxisXPosition(GraphView) Returns the X screen position of the origin (typically 0,0) of graph space. Return value is bounded by the screen i.e. the axis is always rendered even if the origin is offscreen. Declaration public int GetAxisXPosition(GraphView graph) Parameters Type Name Description GraphView graph Returns Type Description System.Int32"
+ },
+ "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.ForceValidatePosDim View.GetMinWidthHeight(Size) View.SetMinWidthHeight() View.TextFormatter View.SuperView View.UpdateTextFormatterText() View.ProcessResizeView() 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.PreserveTrailingSpaces View.TextAlignment View.VerticalTextAlignment View.TextDirection View.IsInitialized View.IsAdded View.Enabled View.Visible View.Border View.ToString() View.GetAutoSize() View.GetHotKeySpecifierLength(Boolean) View.GetTextFormatterBoundsSize() View.GetBoundsTextFormatterSize() 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",
+ "title": "Class HexView.HexViewEventArgs",
+ "keywords": "Class HexView.HexViewEventArgs Defines the event arguments for PositionChanged event. Inheritance System.Object System.EventArgs HexView.HexViewEventArgs Inherited Members System.EventArgs.Empty System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) System.Object.ToString() Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class HexViewEventArgs : EventArgs Constructors HexViewEventArgs(Int64, Point, Int32) Initializes a new instance of HexView.HexViewEventArgs Declaration public HexViewEventArgs(long pos, Point cursor, int lineLength) Parameters Type Name Description System.Int64 pos The character position. Point cursor The cursor position. System.Int32 lineLength Line bytes length. Properties 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 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"
+ },
+ "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.ForceValidatePosDim View.GetMinWidthHeight(Size) View.SetMinWidthHeight() View.TextFormatter View.SuperView View.UpdateTextFormatterText() View.ProcessResizeView() 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.PreserveTrailingSpaces View.TextAlignment View.VerticalTextAlignment View.TextDirection View.IsInitialized View.IsAdded View.Enabled View.Visible View.Border View.ToString() View.GetAutoSize() View.GetHotKeySpecifierLength(Boolean) View.GetTextFormatterBoundsSize() View.GetBoundsTextFormatterSize() 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 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. MainLoop.Timeout Provides data for timers running manipulation. 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. Window.TitleEventArgs An System.EventArgs which allows passing a cancelable new Title value event. Wizard Provides navigation and a user interface (UI) to collect related data across multiple steps. Each step ( Wizard.WizardStep ) can host arbitrary View s, much like a Dialog . Each step also has a pane for help text. Along the bottom of the Wizard view are customizable buttons enabling the user to navigate forward and backward through the Wizard. Wizard.StepChangeEventArgs System.EventArgs for Wizard.WizardStep events. Wizard.WizardButtonEventArgs System.EventArgs for Wizard.WizardStep transition events. Wizard.WizardStep Represents a basic step that is displayed in a Wizard . The Wizard.WizardStep view is divided horizontally in two. On the left is the content view where View s can be added, On the right is the help for the step. Set HelpText to set the help text. If the help text is empty the help pane will not be shown. If there are no Views added to the WizardStep the HelpText (if not empty) will fill the wizard step. Wizard.WizardStep.TitleEventArgs An System.EventArgs which allows passing a cancelable new Title value event. 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 Dialog.ButtonAlignments Determines the horizontal alignment of the Dialog buttons. 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",
+ "title": "Interface IAutocomplete",
+ "keywords": "Interface IAutocomplete Renders an overlay on another view at a given point that allows selecting from a range of 'autocomplete' options. Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public interface IAutocomplete Properties AllSuggestions The full set of all strings that can be suggested. Declaration List AllSuggestions { get; set; } Property Value Type Description System.Collections.Generic.List < System.String > CloseKey The key that the user can press to close the currently popped autocomplete menu Declaration Key CloseKey { get; set; } Property Value Type Description Key ColorScheme The colors to use to render the overlay. Accessing this property before the Application has been initialized will cause an error Declaration ColorScheme ColorScheme { get; set; } Property Value Type Description ColorScheme HostControl The host control that will use autocomplete. Declaration View HostControl { get; set; } Property Value Type Description View MaxHeight The maximum number of visible rows in the autocomplete dropdown to render Declaration int MaxHeight { get; set; } Property Value Type Description System.Int32 MaxWidth The maximum width of the autocomplete dropdown Declaration int MaxWidth { get; set; } Property Value Type Description System.Int32 PopupInsideContainer Gets or sets where the popup will be displayed. Declaration bool PopupInsideContainer { get; set; } Property Value Type Description System.Boolean Reopen The key that the user can press to reopen the currently popped autocomplete menu Declaration Key Reopen { get; set; } Property Value Type Description Key SelectedIdx The currently selected index into Suggestions that the user has highlighted Declaration int SelectedIdx { get; set; } Property Value Type Description System.Int32 SelectionKey The key that the user must press to accept the currently selected autocomplete suggestion Declaration Key SelectionKey { get; set; } Property Value Type Description Key Suggestions The strings that form the current list of suggestions to render based on what the user has typed so far. Declaration ReadOnlyCollection Suggestions { get; set; } Property Value Type Description System.Collections.ObjectModel.ReadOnlyCollection < System.String > Visible True if the autocomplete should be considered open and visible Declaration bool Visible { get; set; } Property Value Type Description System.Boolean Methods ClearSuggestions() Clears Suggestions Declaration void ClearSuggestions() GenerateSuggestions() Populates Suggestions with all strings in AllSuggestions that match with the current cursor position/text in the HostControl . Declaration void GenerateSuggestions() MouseEvent(MouseEvent, Boolean) Handle mouse events before HostControl e.g. to make mouse events like report/click apply to the autocomplete control instead of changing the cursor position in the underlying text view. Declaration bool MouseEvent(MouseEvent me, bool fromHost = false) Parameters Type Name Description MouseEvent me The mouse event. System.Boolean fromHost If was called from the popup or from the host. Returns Type Description System.Boolean true if the mouse can be handled false otherwise. ProcessKey(KeyEvent) Handle key events before HostControl e.g. to make key events like up/down apply to the autocomplete control instead of changing the cursor position in the underlying text view. Declaration bool ProcessKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb The key event. Returns Type Description System.Boolean true if the key can be handled false otherwise. RenderOverlay(Point) Renders the autocomplete dialog inside the given HostControl at the given point. Declaration void RenderOverlay(Point renderAt) Parameters Type Name Description Point renderAt"
+ },
+ "api/Terminal.Gui/Terminal.Gui.IClipboard.html": {
+ "href": "api/Terminal.Gui/Terminal.Gui.IClipboard.html",
+ "title": "Interface IClipboard",
+ "keywords": "Interface IClipboard Definition to interact with the OS clipboard. Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public interface IClipboard Properties IsSupported Returns true if the environmental dependencies are in place to interact with the OS clipboard. Declaration bool IsSupported { get; } Property Value Type Description System.Boolean Methods GetClipboardData() Get the operation system clipboard. Declaration string GetClipboardData() Returns Type Description System.String Exceptions Type Condition System.NotSupportedException Thrown if it was not possible to read the clipboard contents. SetClipboardData(String) Sets the operation system clipboard. Declaration void SetClipboardData(string text) Parameters Type Name Description System.String text Exceptions Type Condition System.NotSupportedException Thrown if it was not possible to set the clipboard contents. TryGetClipboardData(out String) Gets the operation system clipboard if possible. Declaration bool TryGetClipboardData(out string result) Parameters Type Name Description System.String result Clipboard contents read Returns Type Description System.Boolean true if it was possible to read the OS clipboard. TrySetClipboardData(String) Sets the operation system clipboard if possible. Declaration bool TrySetClipboardData(string text) Parameters Type Name Description System.String text Returns Type Description System.Boolean True if the clipboard content was set successfully."
+ },
+ "api/Terminal.Gui/Terminal.Gui.IListDataSource.html": {
+ "href": "api/Terminal.Gui/Terminal.Gui.IListDataSource.html",
+ "title": "Interface IListDataSource",
+ "keywords": "Interface IListDataSource Implement IListDataSource to provide custom rendering for a ListView . Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public interface IListDataSource Properties Count Returns the number of elements to display Declaration int Count { get; } Property Value Type Description System.Int32 Length Returns the maximum length of elements to display Declaration int Length { get; } Property Value Type Description System.Int32 Methods IsMarked(Int32) Should return whether the specified item is currently marked. Declaration bool IsMarked(int item) Parameters Type Name Description System.Int32 item Item index. Returns Type Description System.Boolean true , if marked, false otherwise. Render(ListView, ConsoleDriver, Boolean, Int32, Int32, Int32, Int32, Int32) This method is invoked to render a specified item, the method should cover the entire provided width. Declaration void Render(ListView container, ConsoleDriver driver, bool selected, int item, int col, int line, int width, int start = 0) Parameters Type Name Description ListView container The list view to render. ConsoleDriver driver The console driver to render. System.Boolean selected Describes whether the item being rendered is currently selected by the user. System.Int32 item The index of the item to render, zero for the first item and so on. System.Int32 col The column where the rendering will start System.Int32 line The line where the rendering will be done. System.Int32 width The width that must be filled out. System.Int32 start The index of the string to be displayed. Remarks The default color will be set before this method is invoked, and will be based on whether the item is selected or not. SetMark(Int32, Boolean) Flags the item as marked. Declaration void SetMark(int item, bool value) Parameters Type Name Description System.Int32 item Item index. System.Boolean value If set to true value. ToList() Return the source as IList. Declaration IList ToList() Returns Type Description System.Collections.IList"
+ },
+ "api/Terminal.Gui/Terminal.Gui.IMainLoopDriver.html": {
+ "href": "api/Terminal.Gui/Terminal.Gui.IMainLoopDriver.html",
+ "title": "Interface IMainLoopDriver",
+ "keywords": "Interface IMainLoopDriver Public interface to create your own platform specific main loop driver. Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public interface IMainLoopDriver Methods EventsPending(Boolean) Must report whether there are any events pending, or even block waiting for events. Declaration bool EventsPending(bool wait) Parameters Type Name Description System.Boolean wait If set to true wait until an event is available, otherwise return immediately. Returns Type Description System.Boolean true , if there were pending events, false otherwise. MainIteration() The iteration function. Declaration void MainIteration() Setup(MainLoop) Initializes the main loop driver, gets the calling main loop for the initialization. Declaration void Setup(MainLoop mainLoop) Parameters Type Name Description MainLoop mainLoop Main loop. Wakeup() Wakes up the mainloop that might be waiting on input, must be thread safe. Declaration void Wakeup()"
+ },
+ "api/Terminal.Gui/Terminal.Gui.ITreeView.html": {
+ "href": "api/Terminal.Gui/Terminal.Gui.ITreeView.html",
+ "title": "Interface ITreeView",
+ "keywords": "Interface ITreeView Interface for all non generic members of TreeView See TreeView Deep Dive for more information . Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public interface ITreeView Properties Style Contains options for changing how the tree is rendered Declaration TreeStyle Style { get; set; } Property Value Type Description TreeStyle Methods ClearObjects() Removes all objects from the tree and clears selection Declaration void ClearObjects() SetNeedsDisplay() Sets a flag indicating this view needs to be redisplayed because its state has changed. Declaration void SetNeedsDisplay()"
+ },
+ "api/Terminal.Gui/Terminal.Gui.Key.html": {
+ "href": "api/Terminal.Gui/Terminal.Gui.Key.html",
+ "title": "Enum Key",
+ "keywords": "Enum Key The Key enumeration contains special encoding for some keys, but can also encode all the unicode values that can be passed. Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax [Flags] public enum Key : uint Remarks If the SpecialMask is set, then the value is that of the special mask, otherwise, the value is the one of the lower bits (as extracted by CharMask ) Numerics keys are the values between 48 and 57 corresponding to 0 to 9 Upper alpha keys are the values between 65 and 90 corresponding to A to Z Unicode runes are also stored here, the letter 'A\" for example is encoded as a value 65 (not surfaced in the enum). Fields Name Description a The key code for the user pressing A A The key code for the user pressing Shift-A AltMask When this value is set, the Key encodes the sequence Alt-KeyValue. And the actual value must be extracted by removing the AltMask. b The key code for the user pressing B B The key code for the user pressing Shift-B Backspace Backspace key. BackTab Shift-tab key (backwards tab key). c The key code for the user pressing C C The key code for the user pressing Shift-C CharMask Mask that indicates that this is a character value, values outside this range indicate special characters like Alt-key combinations or special keys on the keyboard like function keys, arrows keys and so on. CtrlMask When this value is set, the Key encodes the sequence Ctrl-KeyValue. And the actual value must be extracted by removing the CtrlMask. CursorDown Cursor down key. CursorLeft Cursor left key. CursorRight Cursor right key. CursorUp Cursor up key d The key code for the user pressing D D The key code for the user pressing Shift-D D0 Digit 0. D1 Digit 1. D2 Digit 2. D3 Digit 3. D4 Digit 4. D5 Digit 5. D6 Digit 6. D7 Digit 7. D8 Digit 8. D9 Digit 9. Delete The key code for the user pressing the delete key. DeleteChar Delete character key e The key code for the user pressing E E The key code for the user pressing Shift-E End End key Enter The key code for the user pressing the return key. Esc The key code for the user pressing the escape key f The key code for the user pressing F F The key code for the user pressing Shift-F F1 F1 key. F10 F10 key. F11 F11 key. F12 F12 key. F2 F2 key. F3 F3 key. F4 F4 key. F5 F5 key. F6 F6 key. F7 F7 key. F8 F8 key. F9 F9 key. g The key code for the user pressing G G The key code for the user pressing Shift-G h The key code for the user pressing H H The key code for the user pressing Shift-H Home Home key i The key code for the user pressing I I The key code for the user pressing Shift-I InsertChar Insert character key j The key code for the user pressing J J The key code for the user pressing Shift-J k The key code for the user pressing K K The key code for the user pressing Shift-K l The key code for the user pressing L L The key code for the user pressing Shift-L m The key code for the user pressing M M The key code for the user pressing Shift-M n The key code for the user pressing N N The key code for the user pressing Shift-N Null The key code representing null or empty o The key code for the user pressing O O The key code for the user pressing Shift-O p The key code for the user pressing P P The key code for the user pressing Shift-P PageDown Page Down key. PageUp Page Up key. q The key code for the user pressing Q Q The key code for the user pressing Shift-Q r The key code for the user pressing R R The key code for the user pressing Shift-R s The key code for the user pressing S S The key code for the user pressing Shift-S ShiftMask When this value is set, the Key encodes the sequence Shift-KeyValue. Space The key code for the user pressing the space bar SpecialMask If the SpecialMask is set, then the value is that of the special mask, otherwise, the value is the one of the lower bits (as extracted by CharMask ). t The key code for the user pressing T T The key code for the user pressing Shift-T Tab The key code for the user pressing the tab key (forwards tab key). u The key code for the user pressing U U The key code for the user pressing Shift-U Unknown A key with an unknown mapping was raised. v The key code for the user pressing V V The key code for the user pressing Shift-V w The key code for the user pressing W W The key code for the user pressing Shift-W x The key code for the user pressing X X The key code for the user pressing Shift-X y The key code for the user pressing Y Y The key code for the user pressing Shift-Y z The key code for the user pressing Z Z The key code for the user pressing Shift-Z"
+ },
+ "api/Terminal.Gui/Terminal.Gui.KeyEvent.html": {
+ "href": "api/Terminal.Gui/Terminal.Gui.KeyEvent.html",
+ "title": "Class KeyEvent",
+ "keywords": "Class KeyEvent Describes a keyboard event. Inheritance System.Object KeyEvent Inherited Members System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class KeyEvent Constructors KeyEvent() Constructs a new KeyEvent Declaration public KeyEvent() KeyEvent(Key, KeyModifiers) Constructs a new KeyEvent from the provided Key value - can be a rune cast into a Key value Declaration public KeyEvent(Key k, KeyModifiers km) Parameters Type Name Description Key k KeyModifiers km Fields Key Symb olid definition for the key. Declaration public Key Key Field Value Type Description Key Properties IsAlt Gets a value indicating whether the Alt key was pressed (real or synthesized) Declaration public bool IsAlt { get; } Property Value Type Description System.Boolean true if is alternate; otherwise, false . IsCapslock Gets a value indicating whether the Caps lock key was pressed (real or synthesized) Declaration public bool IsCapslock { get; } Property Value Type Description System.Boolean true if is alternate; otherwise, false . IsCtrl Determines whether the value is a control key (and NOT just the ctrl key) Declaration public bool IsCtrl { get; } Property Value Type Description System.Boolean true if is ctrl; otherwise, false . IsNumlock Gets a value indicating whether the Num lock key was pressed (real or synthesized) Declaration public bool IsNumlock { get; } Property Value Type Description System.Boolean true if is alternate; otherwise, false . IsScrolllock Gets a value indicating whether the Scroll lock key was pressed (real or synthesized) Declaration public bool IsScrolllock { get; } Property Value Type Description System.Boolean true if is alternate; otherwise, false . IsShift Gets a value indicating whether the Shift key was pressed. Declaration public bool IsShift { get; } Property Value Type Description System.Boolean true if is shift; otherwise, false . KeyValue The key value cast to an integer, you will typical use this for extracting the Unicode rune value out of a key, when none of the symbolic options are in use. Declaration public int KeyValue { get; } Property Value Type Description System.Int32 Methods ToString() Pretty prints the KeyEvent Declaration public override string ToString() Returns Type Description System.String Overrides System.Object.ToString()"
+ },
+ "api/Terminal.Gui/Terminal.Gui.KeyModifiers.html": {
+ "href": "api/Terminal.Gui/Terminal.Gui.KeyModifiers.html",
+ "title": "Class KeyModifiers",
+ "keywords": "Class KeyModifiers Identifies the state of the \"shift\"-keys within a event. Inheritance System.Object KeyModifiers 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 KeyModifiers Fields Alt Check if the Alt key was pressed or not. Declaration public bool Alt Field Value Type Description System.Boolean Capslock Check if the Caps lock key was pressed or not. Declaration public bool Capslock Field Value Type Description System.Boolean Ctrl Check if the Ctrl key was pressed or not. Declaration public bool Ctrl Field Value Type Description System.Boolean Numlock Check if the Num lock key was pressed or not. Declaration public bool Numlock Field Value Type Description System.Boolean Scrolllock Check if the Scroll lock key was pressed or not. Declaration public bool Scrolllock Field Value Type Description System.Boolean Shift Check if the Shift key was pressed or not. Declaration public bool Shift Field Value Type Description System.Boolean"
+ },
+ "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.ForceValidatePosDim View.GetMinWidthHeight(Size) View.SetMinWidthHeight() View.TextFormatter View.SuperView View.UpdateTextFormatterText() View.ProcessResizeView() 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.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.PreserveTrailingSpaces View.TextAlignment View.VerticalTextAlignment View.TextDirection View.IsInitialized View.IsAdded View.Enabled View.Visible View.Border View.ToString() View.GetAutoSize() View.GetHotKeySpecifierLength(Boolean) View.GetTextFormatterBoundsSize() View.GetBoundsTextFormatterSize() 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 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) 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) ProcessHotKey(KeyEvent) Declaration public override bool ProcessHotKey(KeyEvent ke) Parameters Type Name Description KeyEvent ke Returns Type Description System.Boolean Overrides View.ProcessHotKey(KeyEvent) Events Clicked Clicked System.Action , raised when the user clicks the primary mouse button within the Bounds of this View or if the user presses the action key while this view is focused. (TODO: IsDefault) Declaration public event Action Clicked Event Type Type Description System.Action Remarks Client code can hook up to this event, it is raised when the button is activated either with the mouse or the keyboard. Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize"
+ },
+ "api/Terminal.Gui/Terminal.Gui.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.ForceValidatePosDim View.GetMinWidthHeight(Size) View.SetMinWidthHeight() View.TextFormatter View.SuperView View.UpdateTextFormatterText() View.ProcessResizeView() 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.PreserveTrailingSpaces View.TextAlignment View.VerticalTextAlignment View.TextDirection View.IsInitialized View.IsAdded View.Enabled View.Visible View.Border View.ToString() View.GetAutoSize() View.GetHotKeySpecifierLength(Boolean) View.GetTextFormatterBoundsSize() View.GetBoundsTextFormatterSize() 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.ForceValidatePosDim View.GetMinWidthHeight(Size) View.SetMinWidthHeight() View.TextFormatter View.SuperView View.UpdateTextFormatterText() View.ProcessResizeView() 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.PreserveTrailingSpaces View.TextAlignment View.VerticalTextAlignment View.TextDirection View.IsInitialized View.IsAdded View.Enabled View.Visible View.Border View.ToString() View.GetAutoSize() View.GetHotKeySpecifierLength(Boolean) View.GetTextFormatterBoundsSize() View.GetBoundsTextFormatterSize() 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",
+ "title": "Class ListViewItemEventArgs",
+ "keywords": "Class ListViewItemEventArgs System.EventArgs for ListView events. Inheritance System.Object System.EventArgs ListViewItemEventArgs Inherited Members System.EventArgs.Empty System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) System.Object.ToString() Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class ListViewItemEventArgs : EventArgs Constructors ListViewItemEventArgs(Int32, Object) Initializes a new instance of ListViewItemEventArgs Declaration public ListViewItemEventArgs(int item, object value) Parameters Type Name Description System.Int32 item The index of the ListView item. System.Object value The ListView item Properties Item The index of the ListView item. Declaration public int Item { get; } Property Value Type Description System.Int32 Value The ListView item. Declaration public object Value { get; } Property Value Type Description System.Object"
+ },
+ "api/Terminal.Gui/Terminal.Gui.ListViewRowEventArgs.html": {
+ "href": "api/Terminal.Gui/Terminal.Gui.ListViewRowEventArgs.html",
+ "title": "Class ListViewRowEventArgs",
+ "keywords": "Class ListViewRowEventArgs System.EventArgs used by the RowRender event. Inheritance System.Object System.EventArgs ListViewRowEventArgs Inherited Members System.EventArgs.Empty System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) System.Object.ToString() Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class ListViewRowEventArgs : EventArgs Constructors ListViewRowEventArgs(Int32) Initializes with the current row. Declaration public ListViewRowEventArgs(int row) Parameters Type Name Description System.Int32 row Properties Row The current row being rendered. Declaration public int Row { get; } Property Value Type Description System.Int32 RowAttribute The Attribute used by current row or null to maintain the current attribute. Declaration public Attribute? RowAttribute { get; set; } Property Value Type Description System.Nullable < Attribute >"
+ },
+ "api/Terminal.Gui/Terminal.Gui.ListWrapper.html": {
+ "href": "api/Terminal.Gui/Terminal.Gui.ListWrapper.html",
+ "title": "Class ListWrapper",
+ "keywords": "Class ListWrapper Implements an IListDataSource that renders arbitrary System.Collections.IList instances for ListView . Inheritance System.Object ListWrapper Implements IListDataSource 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 ListWrapper : IListDataSource Remarks Implements support for rendering marked items. Constructors ListWrapper(IList) Initializes a new instance of ListWrapper given an System.Collections.IList Declaration public ListWrapper(IList source) Parameters Type Name Description System.Collections.IList source Properties Count Gets the number of items in the System.Collections.IList . Declaration public int Count { get; } Property Value Type Description System.Int32 Length Gets the maximum item length in the System.Collections.IList . Declaration public int Length { get; } Property Value Type Description System.Int32 Methods IsMarked(Int32) Returns true if the item is marked, false otherwise. Declaration public bool IsMarked(int item) Parameters Type Name Description System.Int32 item The item. Returns Type Description System.Boolean true If is marked. false otherwise. Render(ListView, ConsoleDriver, Boolean, Int32, Int32, Int32, Int32, Int32) Renders a ListView item to the appropriate type. Declaration public void Render(ListView container, ConsoleDriver driver, bool marked, int item, int col, int line, int width, int start = 0) Parameters Type Name Description ListView container The ListView. ConsoleDriver driver The driver used by the caller. System.Boolean marked Informs if it's marked or not. System.Int32 item The item. System.Int32 col The col where to move. System.Int32 line The line where to move. System.Int32 width The item width. System.Int32 start The index of the string to be displayed. SetMark(Int32, Boolean) Sets the item as marked or unmarked based on the value is true or false, respectively. Declaration public void SetMark(int item, bool value) Parameters Type Name Description System.Int32 item The item System.Boolean value Marks the item. Unmarked the item. The value. ToList() Returns the source as IList. Declaration public IList ToList() Returns Type Description System.Collections.IList Implements IListDataSource"
+ },
+ "api/Terminal.Gui/Terminal.Gui.MainLoop.html": {
+ "href": "api/Terminal.Gui/Terminal.Gui.MainLoop.html",
+ "title": "Class MainLoop",
+ "keywords": "Class MainLoop Simple main loop implementation that can be used to monitor file descriptor, run timers and idle handlers. Inheritance System.Object MainLoop Inherited Members System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) System.Object.ToString() Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class MainLoop Remarks Monitoring of file descriptors is only available on Unix, there does not seem to be a way of supporting this on Windows. Constructors MainLoop(IMainLoopDriver) Creates a new Mainloop. Declaration public MainLoop(IMainLoopDriver driver) Parameters Type Name Description IMainLoopDriver driver Should match the ConsoleDriver (one of the implementations UnixMainLoop, NetMainLoop or WindowsMainLoop). Properties Driver The current IMainLoopDriver in use. Declaration public IMainLoopDriver Driver { get; } Property Value Type Description IMainLoopDriver The driver. IdleHandlers Gets the list of all idle handlers. Declaration public List> IdleHandlers { get; } Property Value Type Description System.Collections.Generic.List < System.Func < System.Boolean >> Timeouts Gets the list of all timeouts sorted by the System.TimeSpan time ticks./>. A shorter limit time can be added at the end, but it will be called before an earlier addition that has a longer limit time. Declaration public SortedList Timeouts { get; } Property Value Type Description System.Collections.Generic.SortedList < System.Int64 , MainLoop.Timeout > Methods AddIdle(Func) Adds specified idle handler function to mainloop processing. The handler function will be called once per iteration of the main loop after other events have been handled. Declaration public Func AddIdle(Func idleHandler) Parameters Type Name Description System.Func < System.Boolean > idleHandler Token that can be used to remove the idle handler with RemoveIdle(Func) . Returns Type Description System.Func < System.Boolean > Remarks Remove an idle hander by calling RemoveIdle(Func) with the token this method returns. If the idleHandler returns false it will be removed and not called subsequently. AddTimeout(TimeSpan, Func) Adds a timeout to the mainloop. Declaration public object AddTimeout(TimeSpan time, Func callback) Parameters Type Name Description System.TimeSpan time System.Func < MainLoop , System.Boolean > callback Returns Type Description System.Object Remarks When time specified passes, the callback will be invoked. If the callback returns true, the timeout will be reset, repeating the invocation. If it returns false, the timeout will stop and be removed. The returned value is a token that can be used to stop the timeout by calling RemoveTimeout(Object) . EventsPending(Boolean) Determines whether there are pending events to be processed. Declaration public bool EventsPending(bool wait = false) Parameters Type Name Description System.Boolean wait Returns Type Description System.Boolean Remarks You can use this method if you want to probe if events are pending. Typically used if you need to flush the input queue while still running some of your own code in your main thread. Invoke(Action) Runs action on the thread that is processing events Declaration public void Invoke(Action action) Parameters Type Name Description System.Action action the action to be invoked on the main processing thread. MainIteration() Runs one iteration of timers and file watches Declaration public void MainIteration() Remarks You use this to process all pending events (timers, idle handlers and file watches). You can use it like this: while (main.EvensPending ()) MainIteration (); RemoveIdle(Func) Removes an idle handler added with AddIdle(Func) from processing. Declaration public bool RemoveIdle(Func token) Parameters Type Name Description System.Func < System.Boolean > token A token returned by AddIdle(Func) Returns Type Description System.Boolean RemoveTimeout(Object) Removes a previously scheduled timeout Declaration public bool RemoveTimeout(object token) Parameters Type Name Description System.Object token Returns Type Description System.Boolean Remarks The token parameter is the value returned by AddTimeout. Run() Runs the mainloop. Declaration public void Run() Stop() Stops the mainloop. Declaration public void Stop() Events TimeoutAdded Invoked when a new timeout is added to be used on the case if ExitRunLoopAfterFirstIteration is true, Declaration public event Action TimeoutAdded Event Type Type Description System.Action < System.Int64 >"
+ },
+ "api/Terminal.Gui/Terminal.Gui.MainLoop.Timeout.html": {
+ "href": "api/Terminal.Gui/Terminal.Gui.MainLoop.Timeout.html",
+ "title": "Class MainLoop.Timeout",
+ "keywords": "Class MainLoop.Timeout Provides data for timers running manipulation. Inheritance System.Object MainLoop.Timeout 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 Timeout Fields Callback The function that will be invoked. Declaration public Func Callback Field Value Type Description System.Func < MainLoop , System.Boolean > Span Time to wait before invoke the callback. Declaration public TimeSpan Span Field Value Type Description System.TimeSpan"
+ },
+ "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.ForceValidatePosDim View.GetMinWidthHeight(Size) View.SetMinWidthHeight() View.TextFormatter View.SuperView View.UpdateTextFormatterText() View.ProcessResizeView() 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.PreserveTrailingSpaces View.TextAlignment View.VerticalTextAlignment View.TextDirection View.IsInitialized View.IsAdded View.Enabled View.Visible View.Border View.ToString() View.GetAutoSize() View.GetHotKeySpecifierLength(Boolean) View.GetTextFormatterBoundsSize() View.GetBoundsTextFormatterSize() 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