Namespace Terminal.Gui
Classes
A static, singleton class providing the main application driver for Terminal.Gui apps.
Event arguments for the Resized event.
Captures the execution state for the provided Terminal.Gui.Application.RunState.Toplevel view.
Renders an overlay on another view at a given point that allows selecting
from a range of 'autocomplete' options.
Draws a border, background, or both around another element.
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 is a View that provides an item that invokes an System.Action when activated by the user.
The CheckBox View shows an on/off toggle that the user can set
Provides cut, copy, and paste support for the clipboard with OS interaction.
Shared abstract class to enforce rules from the implementation of the IClipboard interface.
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 Dialog View 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.
Dim properties of a View to control the position.
Implements a mock ConsoleDriver for unit testing
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 FrameView is a container frame that draws a frame around the contents. It is similar to
a GroupBox in Windows.
Control for rendering graphs (bar, scatter etc)
An hex viewer and editor View over a System.IO.Stream
Describes a keyboard event.
Identifies the state of the "shift"-keys within a event.
The Label View displays a string at a given position and supports multiple lines separated by newline characters.
Multi-line Labels support word wrap.
ListView View renders a scrollable list of data where each item can be activated to perform an action.
Simple main loop implementation that can be used to monitor
file descriptor, run timers and idle handlers.
The MenuBar provides a menu for Terminal.Gui applications.
A MenuItem has a title, an associated help text, and an action to execute on activation.
An System.EventArgs which allows passing a cancelable menu opening event or replacing with a new MenuBarItem.
MessageBox displays a modal message to the user, with a title, a message and a series of options that the user can choose from.
The OpenDialogprovides an interactive dialog box for users to select files or directories.
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 Progress Bar view that can indicate progress of an activity visually.
RadioGroup shows a group of radio labels, only one of those can be selected at a given time
Event arguments for the SelectedItemChagned event.
Responder base class implemented by objects that want to participate on keyboard and mouse input.
The SaveDialog provides an interactive dialog box for users to pick a file to
save.
ScrollBarViews are views that display a 1-character scrollbar, either horizontal or vertical
Scrollviews are views that present a window into a virtual space where subviews are added. Similar to the iOS UIScrollView.
Represents a helper to manipulate shortcut keys used on views.
Extension of System.Collections.Generic.Stack<T> helper to work with specific System.Collections.Generic.IEqualityComparer<T>
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.
Describes a selected region of the table
Control that hosts multiple sub views, presenting a single one at once
Describes render stylistic selections of a TabView
An System.EventArgs which allows passing a cancelable new text value event.
Single-line text entry View
Provides text formatting capabilities for console apps. Supports, hotkeys, horizontal alignment, multiple lines, and word-based line wrap.
Multi-line text editing View
Toplevel views can be modally executed.
System.EventArgs implementation for the Closing event.
Implements the System.Collections.Generic.IComparer<T> to sort the Toplevel from the MdiChildes if needed.
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.
Defines the event arguments for Terminal.Gui.View.SetFocus(Terminal.Gui.View)
Defines the event arguments for KeyEvent
Structs
Attributes are used as elements that contain both a foreground and a background or platform specific features
Represents an ordered pair of integer x- and y-coordinates that defines a point in a two-dimensional plane.
Represents an ordered pair of x and y coordinates that define a point in a two-dimensional plane.
Stores a set of four integers that represent the location and size of a rectangle
Stores the location and size of a rectangular region.
Stores an ordered pair of integers, which specify a Height and Width.
Represents the size of a rectangular region with an ordered pair of width and height.
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
Definition to interact with the OS clipboard.
Public interface to create your own platform specific main loop driver.
Enums
Specifies the border style for a View and to be used by the Border class.
Basic colors that can be used to set the foreground and background colors in console applications.
Enables diagnostic functions
Cursors Visibility that are displayed
Used for choose the display mode of this RadioGroup
The Key enumeration contains special encoding for some keys, but can also
encode all the unicode values that can be passed.
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.
Specifies how a MenuItem shows selection state.
Determine which System.IO type to open.
Specifies the format that a ProgressBar uses to indicate the visual presentation.
Specifies the style that a ProgressBar uses to indicate the progress of an operation.
Text alignment enumeration, controls how text is displayed.
Text direction enumeration, controls how text is displayed.
Vertical text alignment enumeration, controls how text is displayed.
Delegates
Delegate for providing color to TableView cells based on the value being rendered
Delegate for providing color for a whole row of a TableView